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::ElastiCache::User
<a name="aws-resource-elasticache-user"></a>

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)](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html).

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

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

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

```
{
  "Type" : "AWS::ElastiCache::User",
  "Properties" : {
      "[AccessString](#cfn-elasticache-user-accessstring)" : String,
      "[AuthenticationMode](#cfn-elasticache-user-authenticationmode)" : AuthenticationMode,
      "[Engine](#cfn-elasticache-user-engine)" : String,
      "[NoPasswordRequired](#cfn-elasticache-user-nopasswordrequired)" : Boolean,
      "[Passwords](#cfn-elasticache-user-passwords)" : [ String, ... ],
      "[Tags](#cfn-elasticache-user-tags)" : [ Tag, ... ],
      "[UserId](#cfn-elasticache-user-userid)" : String,
      "[UserName](#cfn-elasticache-user-username)" : String
    }
}
```

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

```
Type: AWS::ElastiCache::User
Properties:
  [AccessString](#cfn-elasticache-user-accessstring): 
    String
  [AuthenticationMode](#cfn-elasticache-user-authenticationmode): 
    AuthenticationMode
  [Engine](#cfn-elasticache-user-engine): String
  [NoPasswordRequired](#cfn-elasticache-user-nopasswordrequired): Boolean
  [Passwords](#cfn-elasticache-user-passwords): 
    - String
  [Tags](#cfn-elasticache-user-tags): 
    - Tag
  [UserId](#cfn-elasticache-user-userid): String
  [UserName](#cfn-elasticache-user-username): String
```

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

`AccessString`  <a name="cfn-elasticache-user-accessstring"></a>
Access permissions string used for this user.  
*Required*: No  
*Type*: String  
*Pattern*: `.*\S.*`  
*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-elasticache-user-authenticationmode"></a>
Specifies the authentication mode to use. Below is an example of the possible JSON values:  

```
{
 Passwords: ["*****", "******"] // If Type is password.
}
```
*Required*: No  
*Type*: [AuthenticationMode](aws-properties-elasticache-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)

`Engine`  <a name="cfn-elasticache-user-engine"></a>
The current supported values are valkey and redis.   
*Required*: Yes  
*Type*: String  
*Allowed values*: `redis | valkey`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NoPasswordRequired`  <a name="cfn-elasticache-user-nopasswordrequired"></a>
Indicates a password is not required for this user.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Passwords`  <a name="cfn-elasticache-user-passwords"></a>
Passwords used for this user. You can create up to two passwords for each user.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*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-elasticache-user-tags"></a>
The list of tags.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-elasticache-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)

`UserId`  <a name="cfn-elasticache-user-userid"></a>
The ID 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)

`UserName`  <a name="cfn-elasticache-user-username"></a>
The username of the user.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*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-elasticache-user-return-values"></a>

### Ref
<a name="aws-resource-elasticache-user-return-values-ref"></a>

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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html). 

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

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

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

`Arn`  <a name="Arn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the user.

`Status`  <a name="Status-fn::getatt"></a>
Indicates the user status. Can be "active", "modifying" or "deleting".