This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::MemoryDB::User
<a name="aws-resource-memorydb-user"></a>

Specifies a MemoryDB user. For more information, see [Authenticating users with Access Contol Lists (ACLs)](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.acls.html).

## Syntax
<a name="aws-resource-memorydb-user-syntax"></a>

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

### JSON
<a name="aws-resource-memorydb-user-syntax.json"></a>

```
{
  "Type" : "AWS::MemoryDB::User",
  "Properties" : {
      "[AccessString](#cfn-memorydb-user-accessstring)" : String,
      "[AuthenticationMode](#cfn-memorydb-user-authenticationmode)" : AuthenticationMode,
      "[Tags](#cfn-memorydb-user-tags)" : [ Tag, ... ],
      "[UserName](#cfn-memorydb-user-username)" : String
    }
}
```

### YAML
<a name="aws-resource-memorydb-user-syntax.yaml"></a>

```
Type: AWS::MemoryDB::User
Properties:
  [AccessString](#cfn-memorydb-user-accessstring): 
    String
  [AuthenticationMode](#cfn-memorydb-user-authenticationmode): 
    AuthenticationMode
  [Tags](#cfn-memorydb-user-tags): 
    - Tag
  [UserName](#cfn-memorydb-user-username): String
```

## Properties
<a name="aws-resource-memorydb-user-properties"></a>

`AccessString`  <a name="cfn-memorydb-user-accessstring"></a>
Access permissions string used for this user.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AuthenticationMode`  <a name="cfn-memorydb-user-authenticationmode"></a>
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](aws-properties-memorydb-user-authenticationmode.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-memorydb-user-tags"></a>
An array of key-value pairs to apply to this resource.  
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).  
*Required*: No  
*Type*: Array of [Tag](aws-properties-memorydb-user-tag.md)  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UserName`  <a name="cfn-memorydb-user-username"></a>
The name of the user.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[a-z][a-z0-9\\-]*`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-memorydb-user-return-values"></a>

### Fn::GetAtt
<a name="aws-resource-memorydb-user-return-values-fn--getatt"></a>

#### 
<a name="aws-resource-memorydb-user-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
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`  <a name="Status-fn::getatt"></a>
Indicates the user status.  
*Valid values*: `active` \$1 `modifying` \$1 `deleting`

# AWS::MemoryDB::User AuthenticationMode
<a name="aws-properties-memorydb-user-authenticationmode"></a>

Denotes the user's authentication properties, such as whether it requires a password to authenticate. Used in output responses.

## Syntax
<a name="aws-properties-memorydb-user-authenticationmode-syntax"></a>

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

### JSON
<a name="aws-properties-memorydb-user-authenticationmode-syntax.json"></a>

```
{
  "[Passwords](#cfn-memorydb-user-authenticationmode-passwords)" : [ String, ... ],
  "[Type](#cfn-memorydb-user-authenticationmode-type)" : String
}
```

### YAML
<a name="aws-properties-memorydb-user-authenticationmode-syntax.yaml"></a>

```
  [Passwords](#cfn-memorydb-user-authenticationmode-passwords): 
    - String
  [Type](#cfn-memorydb-user-authenticationmode-type): String
```

## Properties
<a name="aws-properties-memorydb-user-authenticationmode-properties"></a>

`Passwords`  <a name="cfn-memorydb-user-authenticationmode-passwords"></a>
The password(s) used for authentication  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `2`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-memorydb-user-authenticationmode-type"></a>
Indicates whether the user requires a password to authenticate. All newly-created users require a password.  
*Required*: No  
*Type*: String  
*Allowed values*: `password | iam`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::MemoryDB::User Tag
<a name="aws-properties-memorydb-user-tag"></a>

A tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see [Tagging your MemoryDB resources](https://docs.aws.amazon.com/MemoryDB/latest/devguide/tagging-resources.html)

## Syntax
<a name="aws-properties-memorydb-user-tag-syntax"></a>

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

### JSON
<a name="aws-properties-memorydb-user-tag-syntax.json"></a>

```
{
  "[Key](#cfn-memorydb-user-tag-key)" : String,
  "[Value](#cfn-memorydb-user-tag-value)" : String
}
```

### YAML
<a name="aws-properties-memorydb-user-tag-syntax.yaml"></a>

```
  [Key](#cfn-memorydb-user-tag-key): String
  [Value](#cfn-memorydb-user-tag-value): String
```

## Properties
<a name="aws-properties-memorydb-user-tag-properties"></a>

`Key`  <a name="cfn-memorydb-user-tag-key"></a>
The key for the tag. May not be null.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(?!aws:)[a-zA-Z0-9 _\.\/=+:\-@]*$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-memorydb-user-tag-value"></a>
The tag's value. May be null.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9 _\.\/=+:\-@]*$`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)