Amazonka.ElastiCache.CreateUser

For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see Using Role Based Access Control (RBAC).

Creating a Request

data CreateUser

See: newCreateUser smart constructor.

Constructors

CreateUser'

Fields

• authenticationMode :: Maybe AuthenticationMode

  Specifies how to authenticate the user.

• noPasswordRequired :: Maybe Bool

  Indicates a password is not required for this user.

• passwords :: Maybe (NonEmpty Text)

  Passwords used for this user. You can create up to two passwords for each user.

• tags :: Maybe [Tag]

  A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

• userId :: Text

  The ID of the user.

• userName :: Text

  The username of the user.

• engine :: Text

  The current supported value is Redis.

• accessString :: Text

  Access permissions string used for this user.

Instances

ToHeaders CreateUser

Defined in Amazonka.ElastiCache.CreateUser

Methods

toHeaders :: CreateUser -> [Header]

ToPath CreateUser

Defined in Amazonka.ElastiCache.CreateUser

Methods

toPath :: CreateUser -> ByteString

ToQuery CreateUser

Defined in Amazonka.ElastiCache.CreateUser

Methods

toQuery :: CreateUser -> QueryString

AWSRequest CreateUser

Defined in Amazonka.ElastiCache.CreateUser

Associated Types

type AWSResponse CreateUser

Methods

request :: (Service -> Service) -> CreateUser -> Request CreateUser

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateUser -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateUser)))

Generic CreateUser

Defined in Amazonka.ElastiCache.CreateUser

Associated Types

type Rep CreateUser :: Type -> Type

Methods

from :: CreateUser -> Rep CreateUser x

to :: Rep CreateUser x -> CreateUser

Read CreateUser

Defined in Amazonka.ElastiCache.CreateUser

Methods

readsPrec :: Int -> ReadS CreateUser

readList :: ReadS [CreateUser]

readPrec :: ReadPrec CreateUser

readListPrec :: ReadPrec [CreateUser]

Show CreateUser

Defined in Amazonka.ElastiCache.CreateUser

Methods

showsPrec :: Int -> CreateUser -> ShowS

show :: CreateUser -> String

showList :: [CreateUser] -> ShowS

NFData CreateUser

Defined in Amazonka.ElastiCache.CreateUser

Methods

rnf :: CreateUser -> ()

Eq CreateUser

Defined in Amazonka.ElastiCache.CreateUser

Methods

(==) :: CreateUser -> CreateUser -> Bool

(/=) :: CreateUser -> CreateUser -> Bool

Hashable CreateUser

Defined in Amazonka.ElastiCache.CreateUser

Methods

hashWithSalt :: Int -> CreateUser -> Int

hash :: CreateUser -> Int

type AWSResponse CreateUser

Defined in Amazonka.ElastiCache.CreateUser

type AWSResponse CreateUser = User

type Rep CreateUser

Defined in Amazonka.ElastiCache.CreateUser

type Rep CreateUser = D1 ('MetaData "CreateUser" "Amazonka.ElastiCache.CreateUser" "amazonka-elasticache-2.0-DTWyHgx8JwY7IlNovngF22" 'False) (C1 ('MetaCons "CreateUser'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "authenticationMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthenticationMode)) :*: S1 ('MetaSel ('Just "noPasswordRequired") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "passwords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :*: ((S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "accessString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateUser

Arguments

:: Text

CreateUser

-> Text

CreateUser

-> Text

CreateUser

-> Text

CreateUser

-> CreateUser

Create a value of CreateUser with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:authenticationMode:CreateUser', createUser_authenticationMode - Specifies how to authenticate the user.

$sel:noPasswordRequired:CreateUser', createUser_noPasswordRequired - Indicates a password is not required for this user.

CreateUser, createUser_passwords - Passwords used for this user. You can create up to two passwords for each user.

$sel:tags:CreateUser', createUser_tags - A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

CreateUser, createUser_userId - The ID of the user.

CreateUser, createUser_userName - The username of the user.

CreateUser, createUser_engine - The current supported value is Redis.

CreateUser, createUser_accessString - Access permissions string used for this user.

Request Lenses

createUser_authenticationMode :: Lens' CreateUser (Maybe AuthenticationMode)

Specifies how to authenticate the user.

createUser_noPasswordRequired :: Lens' CreateUser (Maybe Bool)

Indicates a password is not required for this user.

createUser_passwords :: Lens' CreateUser (Maybe (NonEmpty Text))

Passwords used for this user. You can create up to two passwords for each user.

createUser_tags :: Lens' CreateUser (Maybe [Tag])

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

createUser_userId :: Lens' CreateUser Text

The ID of the user.

createUser_userName :: Lens' CreateUser Text

The username of the user.

createUser_engine :: Lens' CreateUser Text

The current supported value is Redis.

createUser_accessString :: Lens' CreateUser Text

Access permissions string used for this user.

Destructuring the Response

data User

See: newUser smart constructor.

Constructors

User'

Fields

• arn :: Maybe Text

  The Amazon Resource Name (ARN) of the user.

• accessString :: Maybe Text

  Access permissions string used for this user.

• authentication :: Maybe Authentication

  Denotes whether the user requires a password to authenticate.

• engine :: Maybe Text

  The current supported value is Redis.

• minimumEngineVersion :: Maybe Text

  The minimum engine version required, which is Redis 6.0

• status :: Maybe Text

  Indicates the user status. Can be "active", "modifying" or "deleting".

• userGroupIds :: Maybe [Text]

  Returns a list of the user group IDs the user belongs to.

• userId :: Maybe Text

  The ID of the user.

• userName :: Maybe Text

  The username of the user.

Instances

FromXML User

Defined in Amazonka.ElastiCache.Types.User

Methods

parseXML :: [Node] -> Either String User

Generic User

Defined in Amazonka.ElastiCache.Types.User

Associated Types

type Rep User :: Type -> Type

Methods

from :: User -> Rep User x

to :: Rep User x -> User

Read User

Defined in Amazonka.ElastiCache.Types.User

Methods

readsPrec :: Int -> ReadS User

readList :: ReadS [User]

readPrec :: ReadPrec User

readListPrec :: ReadPrec [User]

Show User

Defined in Amazonka.ElastiCache.Types.User

Methods

showsPrec :: Int -> User -> ShowS

show :: User -> String

showList :: [User] -> ShowS

NFData User

Defined in Amazonka.ElastiCache.Types.User

Methods

rnf :: User -> ()

Eq User

Defined in Amazonka.ElastiCache.Types.User

Methods

(==) :: User -> User -> Bool

(/=) :: User -> User -> Bool

Hashable User

Defined in Amazonka.ElastiCache.Types.User

Methods

hashWithSalt :: Int -> User -> Int

hash :: User -> Int

type Rep User

Defined in Amazonka.ElastiCache.Types.User

type Rep User = D1 ('MetaData "User" "Amazonka.ElastiCache.Types.User" "amazonka-elasticache-2.0-DTWyHgx8JwY7IlNovngF22" 'False) (C1 ('MetaCons "User'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "accessString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "authentication") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Authentication)) :*: S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "minimumEngineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "userGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newUser :: User

Create a value of User with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arn:User', user_arn - The Amazon Resource Name (ARN) of the user.

$sel:accessString:User', user_accessString - Access permissions string used for this user.

$sel:authentication:User', user_authentication - Denotes whether the user requires a password to authenticate.

$sel:engine:User', user_engine - The current supported value is Redis.

$sel:minimumEngineVersion:User', user_minimumEngineVersion - The minimum engine version required, which is Redis 6.0

$sel:status:User', user_status - Indicates the user status. Can be "active", "modifying" or "deleting".

$sel:userGroupIds:User', user_userGroupIds - Returns a list of the user group IDs the user belongs to.

$sel:userId:User', user_userId - The ID of the user.

$sel:userName:User', user_userName - The username of the user.

Response Lenses

user_arn :: Lens' User (Maybe Text)

The Amazon Resource Name (ARN) of the user.

user_accessString :: Lens' User (Maybe Text)

Access permissions string used for this user.

user_authentication :: Lens' User (Maybe Authentication)

Denotes whether the user requires a password to authenticate.

user_engine :: Lens' User (Maybe Text)

The current supported value is Redis.

user_minimumEngineVersion :: Lens' User (Maybe Text)

The minimum engine version required, which is Redis 6.0

user_status :: Lens' User (Maybe Text)

Indicates the user status. Can be "active", "modifying" or "deleting".

user_userGroupIds :: Lens' User (Maybe [Text])

Returns a list of the user group IDs the user belongs to.

user_userId :: Lens' User (Maybe Text)

The ID of the user.

user_userName :: Lens' User (Maybe Text)

The username of the user.