AWS Fundamentals Logo
AWS Fundamentals
AWS::Cognito::UserPoolDomain

Cognito UserPoolDomain

Resource Type definition for AWS::Cognito::UserPoolDomain

Properties

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

Filter:
PropertyTypeFlags
Domain
string
RequiredCreate-only
UserPoolId
string
RequiredCreate-only
CustomDomainConfig
CustomDomainConfigType
ManagedLoginVersion
integer
Write-only
Routing
RoutingType

Return Values

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

AttributeTypeDescription
CloudFrontDistributionstring-

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

Resources:
  MyResource:
    Type: AWS::Cognito::UserPoolDomain
    Properties:
      UserPoolId: "my-userpoolid"
      Domain: "value"

Required IAM Permissions

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

create

cognito-idp:CreateUserPoolDomaincognito-idp:DescribeUserPoolDomaincloudfront:updateDistributionkms:CreateGrantkms:Decryptkms:DescribeKeykms:Encryptkms:GenerateDataKeyWithoutPlaintextkms:ReEncryptFromkms:ReEncryptTo

read

cognito-idp:DescribeUserPoolDomainkms:CreateGrantkms:Decryptkms:DescribeKeykms:Encryptkms:GenerateDataKeyWithoutPlaintextkms:ReEncryptFromkms:ReEncryptTo

update

cognito-idp:UpdateUserPoolDomaincognito-idp:DescribeUserPoolDomaincloudfront:updateDistributionkms:CreateGrantkms:Decryptkms:DescribeKeykms:Encryptkms:GenerateDataKeyWithoutPlaintextkms:ReEncryptFromkms:ReEncryptTo

delete

cognito-idp:DeleteUserPoolDomaincognito-idp:DescribeUserPoolDomainkms:CreateGrantkms:Decryptkms:DescribeKeykms:Encryptkms:GenerateDataKeyWithoutPlaintextkms:ReEncryptFromkms:ReEncryptTo

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
Properties6
Required2
TaggingNot supported
Primary IDUserPoolId

Supported Operations

CreateReadUpdateDelete

Immutable After Creation

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

UserPoolIdDomain

Related Resources

External Links