For Valkey 7.2 and onwards, or Redis OSS 6.0 and onwards: Creates a user group. For more information, see Using Role Based Access Control (RBAC)
Syntax
To declare this entity in your AWS 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 values are valkey and redis.
Required: Yes
Type: String
Allowed values:
redis | valkeyUpdate requires: No interruption
-
The list of tags.
Required: No
Type: Array of Tag
Maximum:
50Update requires: No interruption
UserGroupId-
The ID of the user group.
Required: Yes
Type: String
Pattern:
[a-z][a-z0-9\\-]*Update requires: Replacement
UserIds-
The list of user IDs that belong to the user group. A user named
defaultmust be included.Required: Yes
Type: Array of String
Minimum:
1Update 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::GetAtt intrinsic 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::GetAtt intrinsic 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".
