AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . elasticache ]
Changes the list of users that belong to the user group.
See also: AWS API Documentation
modify-user-group
--user-group-id <value>
[--user-ids-to-add <value>]
[--user-ids-to-remove <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--user-group-id
(string)
The ID of the user group.
--user-ids-to-add
(list)
The list of user IDs to add to the user group.
(string)
Syntax:
"string" "string" ...
--user-ids-to-remove
(list)
The list of user IDs to remove from the user group.
(string)
Syntax:
"string" "string" ...
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To modify a user group
The following modify-user-group
example adds a user to the user group.
aws elasticache modify-user-group \
--user-group-id myusergroup \
--user-ids-to-add user1
Output:
{
"UserGroupId": "myusergroup",
"Status": "modifying",
"Engine": "redis",
"UserIds": [
"default"
],
"PendingChanges": {
"UserIdsToAdd": [
"user1"
]
},
"ReplicationGroups": [],
"ARN": "arn:aws:elasticache:us-west-2:xxxxxxxxxx52:usergroup:myusergroup"
}
For more information, see Authenticating Users with Role-Based Access Control (RBAC) in the Elasticache User Guide.
UserGroupId -> (string)
The ID of the user group.
Status -> (string)
Indicates user group status. Can be "creating", "active", "modifying", "deleting".
Engine -> (string)
The current supported value is Redis user.
UserIds -> (list)
The list of user IDs that belong to the user group.
(string)
MinimumEngineVersion -> (string)
The minimum engine version required, which is Redis OSS 6.0
PendingChanges -> (structure)
A list of updates being applied to the user group.
UserIdsToRemove -> (list)
The list of user IDs to remove.
(string)
UserIdsToAdd -> (list)
The list of user IDs to add.
(string)
ReplicationGroups -> (list)
A list of replication groups that the user group can access.
(string)
ServerlessCaches -> (list)
Indicates which serverless caches the specified user group is associated with. Available for Redis OSS and Serverless Memcached only.
(string)
ARN -> (string)
The Amazon Resource Name (ARN) of the user group.