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

AWS::Cognito::UserPoolUserToGroupAttachment

The AWS::Cognito::UserPoolUserToGroupAttachment resource attaches a user to an Amazon Cognito user pool user group.

Syntax

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

JSON

Copy
{ "Type" : "AWS::Cognito::UserPoolUserToGroupAttachment", "Properties" : { "GroupName" : String, "Username" : String, "UserPoolId" : String } }

YAML

Copy
Type: "AWS::Cognito::UserPoolUserToGroupAttachment" Properties: GroupName: String Username: String UserPoolId: String

Properties

GroupName

The name of the group.

Required: Yes

Type: String

Update requires: Replacement

Username

The user's user name.

Required: Yes

Type: String

Update requires: Replacement

UserPoolId

The ID of the user pool.

Required: Yes

Type: String

Update requires: Replacement

Return Value

Ref

When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns a generated ID, such as UserToGroupAttachment-YejJvzrEXAMPLE.

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