| « PreviousNext » | |
   | Did this page help you? Yes | No | Tell us about it... |
AWS::IAM::User
The AWS::IAM::User type creates a user.
This type supports updates. For more information about updating stacks, see Updating AWS CloudFormation Stacks.
Syntax
{
"Type": "AWS::IAM::User",
"Properties": {
"Path": String,
"Groups": [ Group, ... ],
"LoginProfile": { "Password" : String },
"Policies": [ Embedded IAM Policies ]
}
} Properties
- Path
The path for the user name. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access Management.
Required: No
Type: String
Update requires: no interruption
- Groups
The names of groups to which you want to add the user.
Required: No
Type: List of Groups
Update requires: no interruption
- LoginProfile
Creates a login profile for the user so the user can access AWS services such as the AWS Management Console.
The LoginProfile type is an embedded property in the AWS::IAM::User type. The LoginProfile property contains a single field:
Password, which takes a string as its value. For example:"LoginProfile": { "Password": "myP@ssW0rd" }Required: No
Type: LoginProfile type
Update requires: no interruption
- Policies
Applies specified policies to the user. For information about policies, see Overview of Policies in [Using IAM].
Required: No
Type: List of AWS::IAM::Policy types
Update requires: no interruption
Return Values
Ref
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
Fn::GetAtt returns a value for a specified attribute of this type.
This section lists the available attributes and corresponding return values.
- Arn
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
