AWS CloudFormation
User Guide (API Version 2010-05-15)


The AWS::IAM::User type creates a user.


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


{ "Type": "AWS::IAM::User", "Properties": { "Groups": [ String, ... ], "LoginProfile": LoginProfile Type, "ManagedPolicyArns": [ String, ... ], "Path": String, "Policies": [ Policies, ... ], "UserName": String } }


Type: AWS::IAM::User Properties: Groups: - String LoginProfile: LoginProfile Type ManagedPolicyArns: - String Path: String Policies: - Policies UserName: String



A name of a group to which you want to add the user.

Required: No

Type: List of String values

Update requires: No interruption


Creates a login profile so that the user can access the AWS Management Console.

Required: No

Type: IAM User LoginProfile

Update requires: No interruption


One or more managed policy ARNs to attach to this user.

Required: No

Type: List of String values

Update requires: No interruption


The path for the user name. For more information about paths, see IAM Identifiers in the IAM User Guide.

Required: No

Type: String

Update requires: No interruption


The policies to associate with this user. For information about policies, see Overview of IAM Policies in the IAM User Guide.


If you specify multiple polices, specify unique values for the policy name. If you don't, updates to the IAM user will fail.

Required: No

Type: List of IAM Policies

Update requires: No interruption


A name for the IAM user. For valid values, see the UserName parameter for the CreateUser action in the IAM API Reference. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the user name.


If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new 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 AWS CloudFormation Templates.


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

Return Values


Specifying this resource ID to the intrinsic Ref function will return the UserName. For example: mystack-myuser-1CCXAFG2H2U4D.

For more information about using the Ref function, see Ref.


Fn::GetAtt returns a value for a specified attribute of this type. The following are the available attributes and sample return values.


Returns the Amazon Resource Name (ARN) for the specified AWS::IAM::User resource. For example: arn:aws:iam::123456789012:user/mystack-myuser-1CCXAFG2H2U4D.

For more information about using Fn::GetAtt, see Fn::GetAtt.

Template Examples

To view AWS::IAM::User snippets, see: Declaring an IAM User Resource.