ElastiCache / Client / create_user_group

create_user_group

ElastiCache.Client.create_user_group(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.create_user_group(
    UserGroupId='string',
    Engine='string',
    UserIds=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

• UserGroupId (string) –

  [REQUIRED]

  The ID of the user group.

• Engine (string) –

  [REQUIRED]

  The current supported value is Redis user.

• UserIds (list) –

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

  • (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. Available for Valkey and Redis OSS only.

  • (dict) –

    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.

Return type:

dict

Returns:

Response Syntax

{
    'UserGroupId': 'string',
    'Status': 'string',
    'Engine': 'string',
    'UserIds': [
        'string',
    ],
    'MinimumEngineVersion': 'string',
    'PendingChanges': {
        'UserIdsToRemove': [
            'string',
        ],
        'UserIdsToAdd': [
            'string',
        ]
    },
    'ReplicationGroups': [
        'string',
    ],
    'ServerlessCaches': [
        'string',
    ],
    'ARN': 'string'
}

Response Structure

• (dict) –

  • 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 (dict) –

    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 Valkey, Redis OSS and Serverless Memcached only.

    • (string) –

  • ARN (string) –

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

Exceptions

• ElastiCache.Client.exceptions.UserNotFoundFault

• ElastiCache.Client.exceptions.DuplicateUserNameFault

• ElastiCache.Client.exceptions.UserGroupAlreadyExistsFault

• ElastiCache.Client.exceptions.ServiceLinkedRoleNotFoundFault

• ElastiCache.Client.exceptions.DefaultUserRequired

• ElastiCache.Client.exceptions.UserGroupQuotaExceededFault

• ElastiCache.Client.exceptions.InvalidParameterValueException

• ElastiCache.Client.exceptions.TagQuotaPerResourceExceeded