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

Creates a new IAM user for your AWS account.

 For information about quotas for the number of IAM users you can create, see [IAM and AWS STS quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.

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

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

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

```
{
  "Type" : "AWS::IAM::User",
  "Properties" : {
      "[Groups](#cfn-iam-user-groups)" : [ String, ... ],
      "[LoginProfile](#cfn-iam-user-loginprofile)" : LoginProfile,
      "[ManagedPolicyArns](#cfn-iam-user-managedpolicyarns)" : [ String, ... ],
      "[Path](#cfn-iam-user-path)" : String,
      "[PermissionsBoundary](#cfn-iam-user-permissionsboundary)" : String,
      "[Policies](#cfn-iam-user-policies)" : [ Policy, ... ],
      "[Tags](#cfn-iam-user-tags)" : [ Tag, ... ],
      "[UserName](#cfn-iam-user-username)" : String
    }
}
```

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

```
Type: AWS::IAM::User
Properties:
  [Groups](#cfn-iam-user-groups): 
    - String
  [LoginProfile](#cfn-iam-user-loginprofile): 
    LoginProfile
  [ManagedPolicyArns](#cfn-iam-user-managedpolicyarns): 
    - String
  [Path](#cfn-iam-user-path): String
  [PermissionsBoundary](#cfn-iam-user-permissionsboundary): String
  [Policies](#cfn-iam-user-policies): 
    - Policy
  [Tags](#cfn-iam-user-tags): 
    - Tag
  [UserName](#cfn-iam-user-username): String
```

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

`Groups`  <a name="cfn-iam-user-groups"></a>
A list of group names to which you want to add the user.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LoginProfile`  <a name="cfn-iam-user-loginprofile"></a>
Creates a password for the specified IAM user. A password allows an IAM user to access AWS services through the AWS Management Console.  
You can use the AWS CLI, the AWS API, or the **Users** page in the IAM console to create a password for any IAM user. Use [ChangePassword](https://docs.aws.amazon.com/IAM/latest/APIReference/API_ChangePassword.html) to update your own existing password in the **My Security Credentials** page in the AWS Management Console.  
For more information about managing passwords, see [Managing passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in the *IAM User Guide*.  
*Required*: No  
*Type*: [LoginProfile](aws-properties-iam-user-loginprofile.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ManagedPolicyArns`  <a name="cfn-iam-user-managedpolicyarns"></a>
A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user.  
For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *AWS General Reference*.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Path`  <a name="cfn-iam-user-path"></a>
 The path for the user name. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.  
This parameter is optional. If it is not included, it defaults to a slash (/).  
This parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the \$1 (`\u0021`) through the DEL character (`\u007F`), including most punctuation characters, digits, and upper and lowercased letters.  
*Required*: No  
*Type*: String  
*Pattern*: `(\u002F)|(\u002F[\u0021-\u007E]+\u002F)`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PermissionsBoundary`  <a name="cfn-iam-user-permissionsboundary"></a>
The ARN of the managed policy that is used to set the permissions boundary for the user.  
A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.  
For more information about policy types, see [Policy types ](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types) in the *IAM User Guide*.  
*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)

`Policies`  <a name="cfn-iam-user-policies"></a>
Adds or updates an inline policy document that is embedded in the specified IAM user. To view AWS::IAM::User snippets, see [Declaring an IAM User Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-user).  
The name of each policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. 
For information about limits on the number of inline policies that you can embed in a user, see [Limitations on IAM Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *IAM User Guide*.  
*Required*: No  
*Type*: Array of [Policy](aws-properties-iam-user-policy.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-iam-user-tags"></a>
A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.  
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
*Required*: No  
*Type*: Array of [Tag](aws-properties-iam-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-iam-user-username"></a>
The name of the user to create. Do not include the path in this value.  
This parameter allows (per its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: \$1\$1=,.@-. The user name must be unique within the account. User names are not distinguished by case. For example, you cannot create users named both "John" and "john".  
If you don't specify a name, CloudFormation generates a unique physical ID and uses that ID for the user name.  
If you specify a name, you must specify the `CAPABILITY_NAMED_IAM` value to acknowledge your template's capabilities. For more information, see [Acknowledging IAM Resources in CloudFormation Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).  
Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using `Fn::Join` and `AWS::Region` to create a Region-specific name, as in the following example: `{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}`.
*Required*: No  
*Type*: String  
*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-iam-user-return-values"></a>

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

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `UserName`. For example: `mystack-myuser-1CCXAFG2H2U4D`.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-iam-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-iam-user-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
Returns the Amazon Resource Name (ARN) for the specified `AWS::IAM::User` resource. For example: `arn:aws:iam::123456789012:user/mystack-myuser-1CCXAFG2H2U4D`.

## See also
<a name="aws-resource-iam-user--seealso"></a>
+ To view `AWS::IAM::User` template example snippets, see [Declaring an IAM User Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-user). 
+ [CreateUser](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateUser.html) in the *AWS Identity and Access Management API Reference*



# AWS::IAM::User LoginProfile
<a name="aws-properties-iam-user-loginprofile"></a>

Creates a password for the specified user, giving the user the ability to access AWS services through the AWS Management Console. For more information about managing passwords, see [Managing Passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in the *IAM User Guide*.

## Syntax
<a name="aws-properties-iam-user-loginprofile-syntax"></a>

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

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

```
{
  "[Password](#cfn-iam-user-loginprofile-password)" : String,
  "[PasswordResetRequired](#cfn-iam-user-loginprofile-passwordresetrequired)" : Boolean
}
```

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

```
  [Password](#cfn-iam-user-loginprofile-password): String
  [PasswordResetRequired](#cfn-iam-user-loginprofile-passwordresetrequired): Boolean
```

## Properties
<a name="aws-properties-iam-user-loginprofile-properties"></a>

`Password`  <a name="cfn-iam-user-loginprofile-password"></a>
The user's password.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PasswordResetRequired`  <a name="cfn-iam-user-loginprofile-passwordresetrequired"></a>
Specifies whether the user is required to set a new password on next sign-in.  
*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)

## See also
<a name="aws-properties-iam-user-loginprofile--seealso"></a>
+ [LoginProfile](https://docs.aws.amazon.com/IAM/latest/APIReference/API_LoginProfile.html) in the *AWS Identity and Access Management API Reference*



# AWS::IAM::User Policy
<a name="aws-properties-iam-user-policy"></a>

Contains information about an attached policy.

An attached policy is a managed policy that has been attached to a user, group, or role.

For more information about managed policies, refer to [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*. 

## Syntax
<a name="aws-properties-iam-user-policy-syntax"></a>

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

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

```
{
  "[PolicyDocument](#cfn-iam-user-policy-policydocument)" : Json,
  "[PolicyName](#cfn-iam-user-policy-policyname)" : String
}
```

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

```
  [PolicyDocument](#cfn-iam-user-policy-policydocument): Json
  [PolicyName](#cfn-iam-user-policy-policyname): String
```

## Properties
<a name="aws-properties-iam-user-policy-properties"></a>

`PolicyDocument`  <a name="cfn-iam-user-policy-policydocument"></a>
The entire contents of the policy that defines permissions. For more information, see [Overview of JSON policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json).  
*Required*: Yes  
*Type*: Json  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PolicyName`  <a name="cfn-iam-user-policy-policyname"></a>
The friendly name (not ARN) identifying the policy.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[\w+=,.@-]+`  
*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)

## Examples
<a name="aws-properties-iam-user-policy--examples"></a>

### IAM User Policy
<a name="aws-properties-iam-user-policy--examples--IAM_User_Policy"></a>

This example shows how the policy document is declared.

#### JSON
<a name="aws-properties-iam-user-policy--examples--IAM_User_Policy--json"></a>

```
{
    "PolicyName": "root",
    "PolicyDocument": {
        "Version": "2012-10-17",		 	 	 
        "Statement": [
            {
                "Sid": "IamListAccess",
                "Effect": "Allow",
                "Action": [
                    "iam:ListRoles",
                    "iam:ListUsers"
                ],
                "Resource": "*"
            }
        ]
    }
}
```

#### YAML
<a name="aws-properties-iam-user-policy--examples--IAM_User_Policy--yaml"></a>

```
PolicyName: root
PolicyDocument:
   Version: 2012-10-17		 	 	 
   Statement:
      - Sid: IamListAccess
        Effect: Allow
        Action:
         - 'iam:ListRoles'
         - 'iam:ListUsers'
        Resource: '*'
```

## See also
<a name="aws-properties-iam-user-policy--seealso"></a>
+ [PolicyDetail](https://docs.aws.amazon.com/IAM/latest/APIReference/API_PolicyDetail.html) in the *AWS Identity and Access Management API Reference*



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

A structure that represents user-provided metadata that can be associated with an IAM resource. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.

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

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

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

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

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

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

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

`Key`  <a name="cfn-iam-user-tag-key"></a>
The key name that can be used to look up or retrieve the associated value. For example, `Department` or `Cost Center` are common choices.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[\p{L}\p{Z}\p{N}_.:/=+\-@]+`  
*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-iam-user-tag-value"></a>
The value associated with this tag. For example, tags with a key name of `Department` could have values such as `Human Resources`, `Accounting`, and `Support`. Tags with a key name of `Cost Center` might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[\p{L}\p{Z}\p{N}_.:/=+\-@]*`  
*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)