[ aws . elasticache ]
For Redis engine version 6.x 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) .
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
delete-user
--user-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--user-id
(string)
The ID of the user.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml
.
--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
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To delete a user
The following delete-user
example deletes a user.
aws elasticache delete-user \
--user-id user2
Output:
{
"UserId": "user1",
"UserName": "myUser",
"Status": "deleting",
"Engine": "redis",
"AccessString": "on ~* +@all",
"UserGroupIds": [
"myusergroup"
],
"Authentication": {
"Type": "password",
"PasswordCount": 1
},
"ARN": "arn:aws:elasticache:us-west-2:xxxxxxxxxx52:user:user1"
}
For more information, see Authenticating Users with Role-Based Access Control (RBAC) in the Elasticache User Guide.
UserId -> (string)
The ID of the user.
UserName -> (string)
The username of the user.
Status -> (string)
Indicates the user status. Can be “active”, “modifying” or “deleting”.
Engine -> (string)
The current supported value is Redis.
AccessString -> (string)
Access permissions string used for this user.
UserGroupIds -> (list)
Returns a list of the user group IDs the user belongs to.
(string)
Authentication -> (structure)
Denotes whether the user requires a password to authenticate.
Type -> (string)
Indicates whether the user requires a password to authenticate.
PasswordCount -> (integer)
The number of passwords belonging to the user. The maximum is two.
ARN -> (string)
The Amazon Resource Name (ARN) of the user.