Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

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 ]



For Redis engine version 6.0 onwards: Creates a Redis user group. For more information, see Using Role Based Access Control (RBAC)

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--user-group-id <value>
--engine <value>
[--user-ids <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--user-group-id (string)

The ID of the user group.

--engine (string)

The current supported value is Redis.

--user-ids (list)

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



"string" "string" ...

--tags (list)

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.


A tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.

Key -> (string)

The key for the tag. May not be null.

Value -> (string)

The tag's value. May be null.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

    "Key": "string",
    "Value": "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.

See 'aws help' for descriptions of global parameters.


To create a user group

The following create-user-group example creates a new user group.

aws elasticache create-user-group \
    --user-group-id myusergroup \
    --engine redis \
    --user-ids default


    "UserGroupId": "myusergroup",
    "Status": "creating",
    "Engine": "redis",
    "UserIds": [
    "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.

UserIds -> (list)

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


MinimumEngineVersion -> (string)

The minimum engine version required, which is Redis 6.0

PendingChanges -> (structure)

A list of updates being applied to the user group.

UserIdsToRemove -> (list)

The list of user IDs to remove.


UserIdsToAdd -> (list)

The list of user IDs to add.


ReplicationGroups -> (list)

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


ARN -> (string)

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