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

AWS::IAM::Group

The AWS::IAM::Group resource creates an AWS Identity and Access Management (IAM) group.

This type supports updates. For more information about updating stacks, see AWS CloudFormation Stacks Updates.

Syntax

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

JSON

Copy
{ "Type": "AWS::IAM::Group", "Properties": { "GroupName": String, "ManagedPolicyArns": [ String, ... ], "Path": String, "Policies": [ Policies, ... ] } }

YAML

Copy
Type: "AWS::IAM::Group" Properties: GroupName: String ManagedPolicyArns: [ String, ... ] Path: String Policies: - Policies

Properties

GroupName

A name for the IAM group. For valid values, see the GroupName parameter for the CreateGroup 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 group name.

Important

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.

Warning

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

ManagedPolicyArns

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

Required: No

Type: List of String values

Update requires: No interruption

Path

The path to the group. For more information about paths, see IAM Identifiers in the IAM User Guide.

Required: No

Type: String

Update requires: No interruption

Policies

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

Required: No

Type: List of IAM Policies

Update requires: No interruption

Return Values

Ref

Specifying this resource ID to the intrinsic Ref function will return the GroupName. For example: mystack-mygroup-1DZETITOWEKVO.

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

Fn::GetAtt

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

Arn

Returns the Amazon Resource Name (ARN) for the AWS::IAM::Group resource. For example: arn:aws:iam::123456789012:group/mystack-mygroup-1DZETITOWEKVO.

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

Template Examples

To view AWS::IAM::Group snippets, see Declaring an IAM Group Resource