AWS Fundamentals Logo
AWS Fundamentals
AWS::Cognito::UserPoolGroup

Cognito UserPoolGroup

Resource Type definition for AWS::Cognito::UserPoolGroup

Properties

5 configurable properties. 1 required. Click a row to see details.

Filter:
PropertyTypeFlags
UserPoolId
string
RequiredCreate-only
Description
string
GroupName
string
Create-only
Precedence
integer
RoleArn
string

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::UserPoolGroup

Resources:
  MyResource:
    Type: AWS::Cognito::UserPoolGroup
    Properties:
      UserPoolId: "my-userpoolid"
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

cognito-idp:CreateGroupiam:PassRoleiam:PutRolePolicycognito-idp:GetGroup

read

cognito-idp:GetGroup

update

cognito-idp:UpdateGroupiam:PassRoleiam:PutRolePolicy

delete

cognito-idp:DeleteGroupcognito-idp:GetGroupiam:PutRolePolicy

list

cognito-idp:ListGroups

Get the Cognito Cheat Sheet

Everything you need to know about Cognito on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceCognito
Properties5
Required1
TaggingNot supported
Primary IDUserPoolId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

UserPoolIdGroupName

Related Resources

External Links