Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ElastiCache.DeleteUserGroup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

For Redis engine version 6.x onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see Using Role Based Access Control (RBAC).

Synopsis

data DeleteUserGroup = DeleteUserGroup' {
- userGroupId :: Text
}
newDeleteUserGroup :: Text -> DeleteUserGroup
deleteUserGroup_userGroupId :: Lens' DeleteUserGroup Text
data UserGroup = UserGroup' {
- status :: Maybe Text
- userIds :: Maybe [Text]
- arn :: Maybe Text
- userGroupId :: Maybe Text
- engine :: Maybe Text
- pendingChanges :: Maybe UserGroupPendingChanges
- replicationGroups :: Maybe [Text]
}
newUserGroup :: UserGroup
userGroup_status :: Lens' UserGroup (Maybe Text)
userGroup_userIds :: Lens' UserGroup (Maybe [Text])
userGroup_arn :: Lens' UserGroup (Maybe Text)
userGroup_userGroupId :: Lens' UserGroup (Maybe Text)
userGroup_engine :: Lens' UserGroup (Maybe Text)
userGroup_pendingChanges :: Lens' UserGroup (Maybe UserGroupPendingChanges)
userGroup_replicationGroups :: Lens' UserGroup (Maybe [Text])

Creating a Request

data DeleteUserGroup Source #

See: newDeleteUserGroup smart constructor.

Constructors

DeleteUserGroup'
Fields userGroupId :: Text The ID of the user group.

Instances

Instances details

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

newDeleteUserGroup Source #

Arguments

:: Text	`$sel:userGroupId:DeleteUserGroup'`
-> DeleteUserGroup

Create a value of DeleteUserGroup 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:userGroupId:DeleteUserGroup', deleteUserGroup_userGroupId - The ID of the user group.

Request Lenses

deleteUserGroup_userGroupId :: Lens' DeleteUserGroup Text Source #

The ID of the user group.

Destructuring the Response

data UserGroup Source #

See: newUserGroup smart constructor.

Constructors

UserGroup'

Fields

status :: Maybe Text
Indicates user group status. Can be "creating", "active", "modifying", "deleting".
userIds :: Maybe [Text]
The list of user IDs that belong to the user group.
arn :: Maybe Text
The Amazon Resource Name (ARN) of the user group.
userGroupId :: Maybe Text
The ID of the user group.
engine :: Maybe Text
The current supported value is Redis.
pendingChanges :: Maybe UserGroupPendingChanges
A list of updates being applied to the user group.
replicationGroups :: Maybe [Text]
A list of replication groups that the user group can access.

Instances

Instances details

Eq UserGroup Source #
Instance details Defined in Amazonka.ElastiCache.Types.UserGroup Methods (==) :: UserGroup -> UserGroup -> Bool # (/=) :: UserGroup -> UserGroup -> Bool #
Read UserGroup Source #
Instance details Defined in Amazonka.ElastiCache.Types.UserGroup Methods readsPrec :: Int -> ReadS UserGroup # readList :: ReadS [UserGroup] # readPrec :: ReadPrec UserGroup # readListPrec :: ReadPrec [UserGroup] #
Show UserGroup Source #
Instance details Defined in Amazonka.ElastiCache.Types.UserGroup Methods showsPrec :: Int -> UserGroup -> ShowS # show :: UserGroup -> String # showList :: [UserGroup] -> ShowS #
Generic UserGroup Source #
Instance details Defined in Amazonka.ElastiCache.Types.UserGroup Associated Types type Rep UserGroup :: Type -> Type # Methods from :: UserGroup -> Rep UserGroup x # to :: Rep UserGroup x -> UserGroup #
NFData UserGroup Source #
Instance details Defined in Amazonka.ElastiCache.Types.UserGroup Methods rnf :: UserGroup -> () #
Hashable UserGroup Source #
Instance details Defined in Amazonka.ElastiCache.Types.UserGroup Methods hashWithSalt :: Int -> UserGroup -> Int # hash :: UserGroup -> Int #
FromXML UserGroup Source #
Instance details Defined in Amazonka.ElastiCache.Types.UserGroup Methods parseXML :: [Node] -> Either String UserGroup #
type Rep UserGroup Source #
Instance details Defined in Amazonka.ElastiCache.Types.UserGroup type Rep UserGroup = D1 ('MetaData "UserGroup" "Amazonka.ElastiCache.Types.UserGroup" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "UserGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "userIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "userGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "pendingChanges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserGroupPendingChanges)) :: S1 ('MetaSel ('Just "replicationGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newUserGroup :: UserGroup Source #

Create a value of UserGroup 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:UserGroup', userGroup_status - Indicates user group status. Can be "creating", "active", "modifying", "deleting".

$sel:userIds:UserGroup', userGroup_userIds - The list of user IDs that belong to the user group.

$sel:arn:UserGroup', userGroup_arn - The Amazon Resource Name (ARN) of the user group.

$sel:userGroupId:UserGroup', userGroup_userGroupId - The ID of the user group.

$sel:engine:UserGroup', userGroup_engine - The current supported value is Redis.

$sel:pendingChanges:UserGroup', userGroup_pendingChanges - A list of updates being applied to the user group.

$sel:replicationGroups:UserGroup', userGroup_replicationGroups - A list of replication groups that the user group can access.

Response Lenses

userGroup_status :: Lens' UserGroup (Maybe Text) Source #

Indicates user group status. Can be "creating", "active", "modifying", "deleting".

userGroup_userIds :: Lens' UserGroup (Maybe [Text]) Source #

The list of user IDs that belong to the user group.

userGroup_arn :: Lens' UserGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) of the user group.

userGroup_userGroupId :: Lens' UserGroup (Maybe Text) Source #

The ID of the user group.

userGroup_engine :: Lens' UserGroup (Maybe Text) Source #

The current supported value is Redis.

userGroup_pendingChanges :: Lens' UserGroup (Maybe UserGroupPendingChanges) Source #

A list of updates being applied to the user group.

userGroup_replicationGroups :: Lens' UserGroup (Maybe [Text]) Source #

A list of replication groups that the user group can access.