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.ModifyUserGroup
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' {}
- 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 ModifyUserGroup Source #
See: newModifyUserGroup
smart constructor.
Constructors
ModifyUserGroup' | |
Fields
|
Instances
Arguments
:: Text | |
-> 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:
$sel:userIdsToAdd:ModifyUserGroup'
, modifyUserGroup_userIdsToAdd
- The list of user IDs to add to the user group.
$sel:userIdsToRemove:ModifyUserGroup'
, modifyUserGroup_userIdsToRemove
- The list of user IDs to remove from the user group.
$sel:userGroupId: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
See: newUserGroup
smart constructor.
Constructors
UserGroup' | |
Fields
|
Instances
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_pendingChanges :: Lens' UserGroup (Maybe UserGroupPendingChanges) Source #
A list of updates being applied to the user group.