DomainDescriptionType - Amazon Cognito User Pools
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).

DomainDescriptionType

A container for information about a domain.

Contents

AWSAccountId

The Amazon ID for the user pool owner.

Type: String

Length Constraints: Maximum length of 12.

Pattern: [0-9]+

Required: No

CloudFrontDistribution

The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 131072.

Required: No

CustomDomainConfig

The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

Type: CustomDomainConfigType object

Required: No

Domain

The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$

Required: No

S3Bucket

The Amazon S3 bucket where the static files for this domain are stored.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 1024.

Pattern: ^[0-9A-Za-z\.\-_]*(?<!\.)$

Required: No

Status

The domain status.

Type: String

Valid Values: CREATING | DELETING | UPDATING | ACTIVE | FAILED

Required: No

UserPoolId

The user pool ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 55.

Pattern: [\w-]+_[0-9a-zA-Z]+

Required: No

Version

The app version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 20.

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: