AWS::ElastiCache::UserGroup - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::ElastiCache::UserGroup

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

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::ElastiCache::UserGroup",
  "Properties" : {
      "Engine" : String,
      "Tags" : [ Tag, ... ],
      "UserGroupId" : String,
      "UserIds" : [ String, ... ]
    }
}

YAML

Type: AWS::ElastiCache::UserGroup
Properties: 
  Engine: String
  Tags: 
    - Tag
  UserGroupId: String
  UserIds: 
    - String

Properties

Engine

The current supported value is redis.

Required: Yes

Type: String

Pattern: [a-zA-Z]*

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: List of Tag

Update requires: No interruption

UserGroupId

The ID of the user group.

Required: Yes

Type: String

Update requires: Replacement

UserIds

The list of user IDs that belong to the user group. A user named default must be included.

Required: Yes

Type: List of String

Update requires: No interruption

Return values

Ref

When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the resource name.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAttintrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAttintrinsic function, see Fn::GetAtt.

Arn

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

Status

Indicates user group status. Can be "creating", "active", "modifying", "deleting".