View a markdown version of this page

AWS::Cognito::UserPoolDomain FailoverType - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::Cognito::UserPoolDomain FailoverType

Specifies failover configuration for multi-region user pool domains. Contains settings for the secondary region and health check configuration.

This data type is a request parameter of API_CreateUserPoolDomain and API_UpdateUserPoolDomain, and a response parameter of API_DescribeUserPoolDomain.

Syntax

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

JSON

{
  "PrimaryRoute53HealthCheckId" : String,
  "SecondaryRegion" : String
}

Properties

PrimaryRoute53HealthCheckId

The ID of the Amazon Route53 healthcheck that controls routing. If the healthcheck is healthy, traffic will be routed to the primary replica, and if the healthcheck is unhealthy, traffic will be routed to the secondary region.

Required: Yes

Type: String

Maximum: 64

Update requires: No interruption

SecondaryRegion

The secondary Amazon Region to use for failover when the primary region becomes unavailable.

Required: Yes

Type: String

Minimum: 5

Maximum: 32

Update requires: No interruption