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 CreateUserPoolDomain and UpdateUserPoolDomain, and a response parameter of DescribeUserPoolDomain.
Contents
- PrimaryRoute53HealthCheckId
-
The ID of the AWS 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.
Type: String
Length Constraints: Maximum length of 64.
Required: Yes
- SecondaryRegion
-
The secondary AWS Region to use for failover when the primary region becomes unavailable.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 32.
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: