AWS::MemoryDB::User - AWS CloudFormation (original) (raw)

Specifies a MemoryDB user. For more information, see Authenticating users with Access Contol Lists (ACLs).

Syntax

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

JSON

{
  "Type" : "AWS::MemoryDB::User",
  "Properties" : {
      "AccessString" : String,
      "AuthenticationMode" : AuthenticationMode,
      "Tags" : [ Tag, ... ],
      "UserName" : String
    }
}

Properties

AccessString

Access permissions string used for this user.

Required: No

Type: String

Update requires: No interruption

AuthenticationMode

Denotes whether the user requires a password to authenticate.

Example:

mynewdbuser:
     Type: AWS::MemoryDB::User
     Properties: 
     AccessString: on ~* &* +@all
     AuthenticationMode: 
         Passwords: '1234567890123456'
         Type: password
     UserName: mynewdbuser
     
     AuthenticationMode:
     {
         "Passwords": ["1234567890123456"],
         "Type": "Password"
     }

Required: No

Type: AuthenticationMode

Update requires: No interruption

Tags

An array of key-value pairs to apply to this resource.

For more information, see Tag.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

UserName

The name of the user.

Required: Yes

Type: String

Pattern: [a-z][a-z0-9\\-]*

Update requires: Replacement

Return values

Fn::GetAtt

Arn

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the user, such as arn:aws:memorydb:us-east-1:123456789012:user/user1

Status

Indicates the user status.

Valid values: active | modifying |deleting

Did this page help you? - Yes

Thanks for letting us know we're doing a good job!

If you've got a moment, please tell us what we did right so we can do more of it.

Did this page help you? - No

Thanks for letting us know this page needs work. We're sorry we let you down.

If you've got a moment, please tell us how we can make the documentation better.