AWS::Cognito::UserPool

Cognito UserPool

Definition of AWS::Cognito::UserPool Resource Type

Properties

30 configurable properties. Click a row to see details.

Filter:

Property	Type	Flags
`AccountRecoverySetting`	`AccountRecoverySetting`
`AdminCreateUserConfig`	`AdminCreateUserConfig`
`AliasAttributes`	`Array<string>`
`AutoVerifiedAttributes`	`Array<string>`
`DeletionProtection`	`string`
`DeviceConfiguration`	`DeviceConfiguration`
`EmailAuthenticationMessage`	`string`
`EmailAuthenticationSubject`	`string`
`EmailConfiguration`	`EmailConfiguration`
`EmailVerificationMessage`	`string`
`EmailVerificationSubject`	`string`
`EnabledMfas`	`Array<string>`	Write-only
`LambdaConfig`	`LambdaConfig`
`MfaConfiguration`	`string`
`Policies`	`Policies`
`Schema`	`Array<SchemaAttribute>`
`SmsAuthenticationMessage`	`string`
`SmsConfiguration`	`SmsConfiguration`
`SmsVerificationMessage`	`string`
`UserAttributeUpdateSettings`	`UserAttributeUpdateSettings`
`UsernameAttributes`	`Array<string>`
`UsernameConfiguration`	`UsernameConfiguration`
`UserPoolAddOns`	`UserPoolAddOns`
`UserPoolName`	`string`
`UserPoolTags`	`object`
`UserPoolTier`	`string`
`VerificationMessageTemplate`	`VerificationMessageTemplate`
`WebAuthnFactorConfiguration`	`string`
`WebAuthnRelyingPartyID`	`string`
`WebAuthnUserVerification`	`string`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`Arn`	`string`	-
`ProviderName`	`string`	-
`ProviderURL`	`string`	-
`UserPoolId`	`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::UserPool

Resources:
  MyResource:
    Type: AWS::Cognito::UserPool
    Properties:

Required IAM Permissions

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

create

cognito-idp:CreateUserPooliam:PassRolecognito-idp:SetUserPoolMfaConfigcognito-idp:DescribeUserPoolkms:CreateGrantiam:CreateServiceLinkedRolecognito-idp:TagResource

read

cognito-idp:DescribeUserPoolcognito-idp:GetUserPoolMfaConfig

update

cognito-idp:UpdateUserPoolcognito-idp:ListTagsForResourcecognito-idp:UntagResourcecognito-idp:TagResourcecognito-idp:SetUserPoolMfaConfigcognito-idp:AddCustomAttributescognito-idp:DescribeUserPoolcognito-idp:GetUserPoolMfaConfigiam:PassRole

delete

cognito-idp:DeleteUserPool

list

cognito-idp:ListUserPools

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

Properties34

Required0

TaggingSupported

Primary IDUserPoolId

Supported Operations

CreateReadUpdateDeleteList

Related Resources

External Links

AWS Documentation