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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Changes the list of users that belong to the user group.

Synopsis

data ModifyUserGroup = ModifyUserGroup' {
- userIdsToAdd :: Maybe (NonEmpty Text)
- userIdsToRemove :: Maybe (NonEmpty Text)
- userGroupId :: Text
}
newModifyUserGroup :: Text -> ModifyUserGroup
modifyUserGroup_userIdsToAdd :: Lens' ModifyUserGroup (Maybe (NonEmpty Text))
modifyUserGroup_userIdsToRemove :: Lens' ModifyUserGroup (Maybe (NonEmpty Text))
modifyUserGroup_userGroupId :: Lens' ModifyUserGroup Text
data UserGroup = UserGroup' {
- arn :: Maybe Text
- engine :: Maybe Text
- minimumEngineVersion :: Maybe Text
- pendingChanges :: Maybe UserGroupPendingChanges
- replicationGroups :: Maybe [Text]
- status :: Maybe Text
- userGroupId :: Maybe Text
- userIds :: Maybe [Text]
}
newUserGroup :: UserGroup
userGroup_arn :: Lens' UserGroup (Maybe Text)
userGroup_engine :: Lens' UserGroup (Maybe Text)
userGroup_minimumEngineVersion :: Lens' UserGroup (Maybe Text)
userGroup_pendingChanges :: Lens' UserGroup (Maybe UserGroupPendingChanges)
userGroup_replicationGroups :: Lens' UserGroup (Maybe [Text])
userGroup_status :: Lens' UserGroup (Maybe Text)
userGroup_userGroupId :: Lens' UserGroup (Maybe Text)
userGroup_userIds :: Lens' UserGroup (Maybe [Text])

Creating a Request

data ModifyUserGroup Source #

See: newModifyUserGroup smart constructor.

Constructors

ModifyUserGroup'
Fields userIdsToAdd :: Maybe (NonEmpty Text) The list of user IDs to add to the user group. userIdsToRemove :: Maybe (NonEmpty Text) The list of user IDs to remove from the user group. userGroupId :: Text The ID of the user group.

Instances

Instances details

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

newModifyUserGroup Source #

Arguments

:: Text	`ModifyUserGroup`
-> ModifyUserGroup

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

ModifyUserGroup, modifyUserGroup_userIdsToAdd - The list of user IDs to add to the user group.

ModifyUserGroup, modifyUserGroup_userIdsToRemove - The list of user IDs to remove from the user group.

ModifyUserGroup, modifyUserGroup_userGroupId - The ID of the user group.

Request Lenses

modifyUserGroup_userIdsToAdd :: Lens' ModifyUserGroup (Maybe (NonEmpty Text)) Source #

The list of user IDs to add to the user group.

modifyUserGroup_userIdsToRemove :: Lens' ModifyUserGroup (Maybe (NonEmpty Text)) Source #

The list of user IDs to remove from the user group.

modifyUserGroup_userGroupId :: Lens' ModifyUserGroup Text Source #

The ID of the user group.

Destructuring the Response

data UserGroup Source #

See: newUserGroup smart constructor.

Constructors

UserGroup'

Fields

arn :: Maybe Text
The Amazon Resource Name (ARN) of the user group.
engine :: Maybe Text
The current supported value is Redis.
minimumEngineVersion :: Maybe Text
The minimum engine version required, which is Redis 6.0
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.
status :: Maybe Text
Indicates user group status. Can be "creating", "active", "modifying", "deleting".
userGroupId :: Maybe Text
The ID of the user group.
userIds :: Maybe [Text]
The list of user IDs that belong to the user group.

Instances

Instances details

FromXML UserGroup Source #
Instance details Defined in Amazonka.ElastiCache.Types.UserGroup Methods parseXML :: [Node] -> Either String UserGroup #
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 #
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 #
NFData UserGroup Source #
Instance details Defined in Amazonka.ElastiCache.Types.UserGroup Methods rnf :: UserGroup -> () #
Eq UserGroup Source #
Instance details Defined in Amazonka.ElastiCache.Types.UserGroup Methods (==) :: UserGroup -> UserGroup -> Bool # (/=) :: UserGroup -> UserGroup -> Bool #
Hashable UserGroup Source #
Instance details Defined in Amazonka.ElastiCache.Types.UserGroup Methods hashWithSalt :: Int -> UserGroup -> Int # hash :: UserGroup -> Int #
type Rep UserGroup Source #
Instance details Defined in Amazonka.ElastiCache.Types.UserGroup type Rep UserGroup = D1 ('MetaData "UserGroup" "Amazonka.ElastiCache.Types.UserGroup" "amazonka-elasticache-2.0-DTWyHgx8JwY7IlNovngF22" 'False) (C1 ('MetaCons "UserGroup'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "minimumEngineVersion") '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])) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "userGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "userIds") '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:arn:UserGroup', userGroup_arn - The Amazon Resource Name (ARN) of the user group.

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

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

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

$sel:status:UserGroup', userGroup_status - Indicates user group status. Can be "creating", "active", "modifying", "deleting".

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

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

Response Lenses

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

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

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

The current supported value is Redis.

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

The minimum engine version required, which is Redis 6.0

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.

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

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

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

The ID of the user group.

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

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