For Valkey 7.2 and onwards, or Redis OSS engine version 6.0 and onwards: Creates user. 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::User",
"Properties" : {
"AccessString" : String,
"AuthenticationMode" : AuthenticationMode,
"Engine" : String,
"NoPasswordRequired" : Boolean,
"Passwords" : [ String, ... ],
"Tags" : [ Tag, ... ],
"UserId" : String,
"UserName" : String
}
}
YAML
Type: AWS::ElastiCache::User
Properties:
AccessString:
String
AuthenticationMode:
AuthenticationMode
Engine: String
NoPasswordRequired: Boolean
Passwords:
- String
Tags:
- Tag
UserId: String
UserName: String
Properties
AccessString-
Access permissions string used for this user.
Required: No
Type: String
Pattern:
.*\S.*Update requires: No interruption
AuthenticationMode-
Specifies the authentication mode to use. Below is an example of the possible JSON values:
{ Passwords: ["*****", "******"] // If Type is password. }Required: No
Type: AuthenticationMode
Update requires: No interruption
Engine-
The current supported values are valkey and redis.
Required: Yes
Type: String
Allowed values:
redis | valkeyUpdate requires: No interruption
NoPasswordRequired-
Indicates a password is not required for this user.
Required: No
Type: Boolean
Update requires: No interruption
Passwords-
Passwords used for this user. You can create up to two passwords for each user.
Required: No
Type: Array of String
Minimum:
1Update requires: No interruption
-
The list of tags.
Required: No
Type: Array of Tag
Maximum:
50Update requires: No interruption
UserId-
The ID of the user.
Required: Yes
Type: String
Pattern:
[a-z][a-z0-9\\-]*Update requires: Replacement
UserName-
The username of the user.
Required: Yes
Type: String
Minimum:
1Update requires: Replacement
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.
Status-
Indicates the user status. Can be "active", "modifying" or "deleting".
