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.DeleteUser

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

For Redis engine version 6.0 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see Using Role Based Access Control (RBAC).

Synopsis

data DeleteUser = DeleteUser' {
- userId :: Text
}
newDeleteUser :: Text -> DeleteUser
deleteUser_userId :: Lens' DeleteUser 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 DeleteUser Source #

See: newDeleteUser smart constructor.

Constructors

DeleteUser'
Fields userId :: Text The ID of the user.

Instances

Instances details

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

newDeleteUser Source #

Arguments

:: Text	`DeleteUser`
-> DeleteUser

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

DeleteUser, deleteUser_userId - The ID of the user.

Request Lenses

deleteUser_userId :: Lens' DeleteUser 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.