AWS::Cognito::UserPoolUserToGroupAttachmentCognito UserPoolUserToGroupAttachment
Resource Type definition for AWS::Cognito::UserPoolUserToGroupAttachment
Properties
3 configurable properties. 3 required. Click a row to see details.
Filter:
| Property | Type | Flags |
|---|---|---|
GroupName | string | RequiredCreate-only |
Username | string | RequiredCreate-only |
UserPoolId | string | RequiredCreate-only |
Sample CloudFormation Template
A minimal template with required properties and common optional ones.
template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Cognito::UserPoolUserToGroupAttachment
Resources:
MyResource:
Type: AWS::Cognito::UserPoolUserToGroupAttachment
Properties:
UserPoolId: "my-userpoolid"
Username: "my-username"
GroupName: "my-groupname"Required IAM Permissions
Permissions CloudFormation needs in your IAM role to manage this resource.
create
cognito-idp:AdminAddUserToGroupcognito-idp:AdminListGroupsForUserdelete
cognito-idp:AdminRemoveUserFromGroupcognito-idp:AdminListGroupsForUserread
cognito-idp:AdminListGroupsForUserGet the Cognito Cheat Sheet
Everything you need to know about Cognito on one page. HD quality, print-friendly.
Download Free InfographicQuick Facts
ServiceCognito
Properties3
Required3
TaggingNot supported
Primary ID
UserPoolIdSupported Operations
CreateDeleteRead
Immutable After Creation
These properties cannot be changed after the resource is created. Updating them triggers a replacement.
UserPoolIdGroupNameUsername