AWS::ElastiCache::User - 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::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 Amazon 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:

{
 Type: <iam | no-password-required | password>
 Passwords: ["*****", "******"] // If Type is password.
}

Required: No

Type: AuthenticationMode

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

Tags

Property description not available.

Required: No

Type: List of Tag

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::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.

Status

Indicates the user status. Can be "active", "modifying" or "deleting".