[ aws . elasticache ]

modify-user-group

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  modify-user-group
--user-group-id <value>
[--user-ids-to-add <value>]
[--user-ids-to-remove <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

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

Examples

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.

Output

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.

(string)

PendingChanges -> (structure)

A list of updates being applied to the user groups.

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)

ARN -> (string)

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