AWS::ElastiCache::User
For Redis engine version 6.0 onwards: Creates a Redis 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
, "Engine" :String
, "NoPasswordRequired" :Boolean
, "Passwords" :[ String, ... ]
, "UserId" :String
, "UserName" :String
} }
YAML
Type: AWS::ElastiCache::User Properties: AccessString:
String
Engine:String
NoPasswordRequired:Boolean
Passwords:- String
UserId:String
UserName:String
Properties
AccessString
-
Access permissions string used for this user.
Required: No
Type: String
Pattern:
.*\S.*
Update requires: No interruption
Engine
-
The current supported value is redis.
Required: Yes
Type: String
Pattern:
[a-zA-Z]*
Update requires: Replacement
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: List of String
Update requires: No interruption
UserId
-
The ID of the user.
Required: Yes
Type: String
Minimum:
1
Pattern:
[a-zA-Z][a-zA-Z0-9\-]*
Update requires: Replacement
UserName
-
The username of the user.
Required: Yes
Type: String
Minimum:
1
Update 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.