Table Of Contents

Feedback

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 ]

delete-user-group

Description

For Redis engine version 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see Using Role Based Access Control (RBAC) .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  delete-user-group
--user-group-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--user-group-id (string)

The ID of the user group.

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

Examples

To delete a user group

The following delete-user-group example deletes a user group.

aws elasticache delete-user-group \
    --user-group-id myusergroup

Output:

{
    "UserGroupId": "myusergroup",
    "Status": "deleting",
    "Engine": "redis",
    "UserIds": [
        "default"
    ],
    "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)

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.

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