Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ElastiCache.ModifyUser

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Changes user password(s) and/or access string.

Synopsis

data ModifyUser = ModifyUser' {
- accessString :: Maybe Text
- appendAccessString :: Maybe Text
- authenticationMode :: Maybe AuthenticationMode
- noPasswordRequired :: Maybe Bool
- passwords :: Maybe (NonEmpty Text)
- userId :: Text
}
newModifyUser :: Text -> ModifyUser
modifyUser_accessString :: Lens' ModifyUser (Maybe Text)
modifyUser_appendAccessString :: Lens' ModifyUser (Maybe Text)
modifyUser_authenticationMode :: Lens' ModifyUser (Maybe AuthenticationMode)
modifyUser_noPasswordRequired :: Lens' ModifyUser (Maybe Bool)
modifyUser_passwords :: Lens' ModifyUser (Maybe (NonEmpty Text))
modifyUser_userId :: Lens' ModifyUser Text
data User = User' {
- arn :: Maybe Text
- accessString :: Maybe Text
- authentication :: Maybe Authentication
- engine :: Maybe Text
- minimumEngineVersion :: Maybe Text
- status :: Maybe Text
- userGroupIds :: Maybe [Text]
- userId :: Maybe Text
- userName :: Maybe Text
}
newUser :: User
user_arn :: Lens' User (Maybe Text)
user_accessString :: Lens' User (Maybe Text)
user_authentication :: Lens' User (Maybe Authentication)
user_engine :: Lens' User (Maybe Text)
user_minimumEngineVersion :: Lens' User (Maybe Text)
user_status :: Lens' User (Maybe Text)
user_userGroupIds :: Lens' User (Maybe [Text])
user_userId :: Lens' User (Maybe Text)
user_userName :: Lens' User (Maybe Text)

Creating a Request

data ModifyUser Source #

See: newModifyUser smart constructor.

Constructors

ModifyUser'

Fields

accessString :: Maybe Text
Access permissions string used for this user.
appendAccessString :: Maybe Text
Adds additional user permissions to the access string.
authenticationMode :: Maybe AuthenticationMode
Specifies how to authenticate the user.
noPasswordRequired :: Maybe Bool
Indicates no password is required for the user.
passwords :: Maybe (NonEmpty Text)
The passwords belonging to the user. You are allowed up to two.
userId :: Text
The ID of the user.

Instances

Instances details

ToHeaders ModifyUser Source #
Instance details Defined in Amazonka.ElastiCache.ModifyUser Methods toHeaders :: ModifyUser -> [Header] #
ToPath ModifyUser Source #
Instance details Defined in Amazonka.ElastiCache.ModifyUser Methods toPath :: ModifyUser -> ByteString #
ToQuery ModifyUser Source #
Instance details Defined in Amazonka.ElastiCache.ModifyUser Methods toQuery :: ModifyUser -> QueryString #
AWSRequest ModifyUser Source #
Instance details Defined in Amazonka.ElastiCache.ModifyUser Associated Types type AWSResponse ModifyUser # Methods request :: (Service -> Service) -> ModifyUser -> Request ModifyUser # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ModifyUser -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyUser))) #
Generic ModifyUser Source #
Instance details Defined in Amazonka.ElastiCache.ModifyUser Associated Types type Rep ModifyUser :: Type -> Type # Methods from :: ModifyUser -> Rep ModifyUser x # to :: Rep ModifyUser x -> ModifyUser #
Read ModifyUser Source #
Instance details Defined in Amazonka.ElastiCache.ModifyUser Methods readsPrec :: Int -> ReadS ModifyUser # readList :: ReadS [ModifyUser] # readPrec :: ReadPrec ModifyUser # readListPrec :: ReadPrec [ModifyUser] #
Show ModifyUser Source #
Instance details Defined in Amazonka.ElastiCache.ModifyUser Methods showsPrec :: Int -> ModifyUser -> ShowS # show :: ModifyUser -> String # showList :: [ModifyUser] -> ShowS #
NFData ModifyUser Source #
Instance details Defined in Amazonka.ElastiCache.ModifyUser Methods rnf :: ModifyUser -> () #
Eq ModifyUser Source #
Instance details Defined in Amazonka.ElastiCache.ModifyUser Methods (==) :: ModifyUser -> ModifyUser -> Bool # (/=) :: ModifyUser -> ModifyUser -> Bool #
Hashable ModifyUser Source #
Instance details Defined in Amazonka.ElastiCache.ModifyUser Methods hashWithSalt :: Int -> ModifyUser -> Int # hash :: ModifyUser -> Int #
type AWSResponse ModifyUser Source #
Instance details Defined in Amazonka.ElastiCache.ModifyUser type AWSResponse ModifyUser = User
type Rep ModifyUser Source #
Instance details Defined in Amazonka.ElastiCache.ModifyUser type Rep ModifyUser = D1 ('MetaData "ModifyUser" "Amazonka.ElastiCache.ModifyUser" "amazonka-elasticache-2.0-DTWyHgx8JwY7IlNovngF22" 'False) (C1 ('MetaCons "ModifyUser'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "appendAccessString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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 "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newModifyUser Source #

Arguments

:: Text	`ModifyUser`
-> ModifyUser

Create a value of ModifyUser 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:

ModifyUser, modifyUser_accessString - Access permissions string used for this user.

$sel:appendAccessString:ModifyUser', modifyUser_appendAccessString - Adds additional user permissions to the access string.

$sel:authenticationMode:ModifyUser', modifyUser_authenticationMode - Specifies how to authenticate the user.

$sel:noPasswordRequired:ModifyUser', modifyUser_noPasswordRequired - Indicates no password is required for the user.

ModifyUser, modifyUser_passwords - The passwords belonging to the user. You are allowed up to two.

ModifyUser, modifyUser_userId - The ID of the user.

Request Lenses

modifyUser_accessString :: Lens' ModifyUser (Maybe Text) Source #

Access permissions string used for this user.

modifyUser_appendAccessString :: Lens' ModifyUser (Maybe Text) Source #

Adds additional user permissions to the access string.

modifyUser_authenticationMode :: Lens' ModifyUser (Maybe AuthenticationMode) Source #

Specifies how to authenticate the user.

modifyUser_noPasswordRequired :: Lens' ModifyUser (Maybe Bool) Source #

Indicates no password is required for the user.

modifyUser_passwords :: Lens' ModifyUser (Maybe (NonEmpty Text)) Source #

The passwords belonging to the user. You are allowed up to two.

modifyUser_userId :: Lens' ModifyUser Text Source #

The ID of the user.

Destructuring the Response

data User Source #

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

Instances details

FromXML User Source #
Instance details Defined in Amazonka.ElastiCache.Types.User Methods parseXML :: [Node] -> Either String User #
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 #
Read User Source #
Instance details Defined in Amazonka.ElastiCache.Types.User Methods readsPrec :: Int -> ReadS User # readList :: ReadS [User] # readPrec :: ReadPrec User # readListPrec :: ReadPrec [User] #
Show User Source #
Instance details Defined in Amazonka.ElastiCache.Types.User Methods showsPrec :: Int -> User -> ShowS # show :: User -> String # showList :: [User] -> ShowS #
NFData User Source #
Instance details Defined in Amazonka.ElastiCache.Types.User Methods rnf :: User -> () #
Eq User Source #
Instance details Defined in Amazonka.ElastiCache.Types.User Methods (==) :: User -> User -> Bool # (/=) :: User -> User -> Bool #
Hashable User Source #
Instance details Defined in Amazonka.ElastiCache.Types.User Methods hashWithSalt :: Int -> User -> Int # hash :: User -> Int #
type Rep User Source #
Instance details 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 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: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) Source #

The Amazon Resource Name (ARN) of the user.

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

Access permissions string used for this user.

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_minimumEngineVersion :: Lens' User (Maybe Text) Source #

The minimum engine version required, which is Redis 6.0

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

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

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

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

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

The ID of the user.

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

The username of the user.