AWS CloudFormation
User Guide (Version )

AWS::IAM::UserToGroupAddition

Adds the specified user to the specified group.

Syntax

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

JSON

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

YAML

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

Properties

GroupName

The name of the group to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Required: Yes

Type: String

Minimum: 1

Maximum: 128

Pattern: [\w+=,.@-]+

Update requires: No interruption

Users

A list of the names of the users that you want to add to the group.

Required: Yes

Type: List of String

Update requires: No interruption

Return Values

Ref

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 resource with the logical ID MyUserToGroupAddition, Ref will return the AWS resource name.

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

See Also