libZSservicesZSamazonka-elasticacheZSamazonka-elasticache
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ElastiCache.CreateUser

Description

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

Synopsis

Creating a Request

data CreateUser Source #

See: newCreateUser smart constructor.

Constructors

CreateUser' 

Fields

Instances

Instances details
Eq CreateUser Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateUser

Read CreateUser Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateUser

Show CreateUser Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateUser

Generic CreateUser Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateUser

Associated Types

type Rep CreateUser :: Type -> Type #

NFData CreateUser Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateUser

Methods

rnf :: CreateUser -> () #

Hashable CreateUser Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateUser

AWSRequest CreateUser Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateUser

Associated Types

type AWSResponse CreateUser #

ToHeaders CreateUser Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateUser

Methods

toHeaders :: CreateUser -> [Header] #

ToPath CreateUser Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateUser

ToQuery CreateUser Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateUser

type Rep CreateUser Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateUser

type Rep CreateUser = D1 ('MetaData "CreateUser" "Amazonka.ElastiCache.CreateUser" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "CreateUser'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "passwords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: (S1 ('MetaSel ('Just "noPasswordRequired") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: 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)))))
type AWSResponse CreateUser Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateUser

newCreateUser Source #

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:passwords:CreateUser', createUser_passwords - Passwords used for this user. You can create up to two passwords for each user.

$sel:noPasswordRequired:CreateUser', createUser_noPasswordRequired - Indicates a password is not required for this 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.

$sel:userId:CreateUser', createUser_userId - The ID of the user.

$sel:userName:CreateUser', createUser_userName - The username of the user.

$sel:engine:CreateUser', createUser_engine - The current supported value is Redis.

$sel:accessString:CreateUser', createUser_accessString - Access permissions string used for this user.

Request Lenses

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

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

createUser_noPasswordRequired :: Lens' CreateUser (Maybe Bool) Source #

Indicates a password is not required for this user.

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

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_userName :: Lens' CreateUser Text Source #

The username of the user.

createUser_engine :: Lens' CreateUser Text Source #

The current supported value is Redis.

createUser_accessString :: Lens' CreateUser Text Source #

Access permissions string used for this user.

Destructuring the Response

data User Source #

See: newUser smart constructor.

Constructors

User' 

Fields

Instances

Instances details
Eq User Source # 
Instance details

Defined in Amazonka.ElastiCache.Types.User

Methods

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

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

Read User Source # 
Instance details

Defined in Amazonka.ElastiCache.Types.User

Show User Source # 
Instance details

Defined in Amazonka.ElastiCache.Types.User

Methods

showsPrec :: Int -> User -> ShowS #

show :: User -> String #

showList :: [User] -> ShowS #

Generic User Source # 
Instance details

Defined in Amazonka.ElastiCache.Types.User

Associated Types

type Rep User :: Type -> Type #

Methods

from :: User -> Rep User x #

to :: Rep User x -> User #

NFData User Source # 
Instance details

Defined in Amazonka.ElastiCache.Types.User

Methods

rnf :: User -> () #

Hashable User Source # 
Instance details

Defined in Amazonka.ElastiCache.Types.User

Methods

hashWithSalt :: Int -> User -> Int #

hash :: User -> Int #

FromXML User Source # 
Instance details

Defined in Amazonka.ElastiCache.Types.User

Methods

parseXML :: [Node] -> Either String User #

type Rep User Source # 
Instance details

Defined in Amazonka.ElastiCache.Types.User

newUser :: User Source #

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:status:User', user_status - Indicates the user status. Can be "active", "modifying" or "deleting".

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

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

$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:userName:User', user_userName - The username of the user.

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

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

Response Lenses

user_status :: Lens' User (Maybe Text) Source #

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

user_arn :: Lens' User (Maybe Text) Source #

The Amazon Resource Name (ARN) of the user.

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

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

user_authentication :: Lens' User (Maybe Authentication) Source #

Denotes whether the user requires a password to authenticate.

user_engine :: Lens' User (Maybe Text) Source #

The current supported value is Redis.

user_userName :: Lens' User (Maybe Text) Source #

The username of the user.

user_accessString :: Lens' User (Maybe Text) Source #

Access permissions string used for this user.

user_userId :: Lens' User (Maybe Text) Source #

The ID of the user.