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

AWS::IAM::UserToGroupAddition

The AWS::IAM::UserToGroupAddition type adds AWS Identity and Access Management (IAM) users to a 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


{
   "Type": "AWS::IAM::UserToGroupAddition",
   "Properties": {
      "GroupName": String,
      "Users": [ User1, ... ]
   }
}     

YAML

Type: "AWS::IAM::UserToGroupAddition"
Properties: 
  GroupName: String
  Users:
    - User1 

Properties

GroupName

The name of group to add users to.

Required: Yes

Type: String

Update requires: No interruption

Users

Required: Yes

Type: List of users

Update requires: No interruption

Return Value

When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the resource name. For example:

{ "Ref": "MyUserToGroupAddition" }

For the AWS::IAM::UserToGroupAddition with the logical ID "MyUserToGroupAddition", Ref will return the AWS resource name.

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

Template Examples

To view AWS::IAM::UserToGroupAddition snippets, see Adding Users to a Group.