Menu
Amazon Cognito Identity Provider
API Reference (API Version 2016-04-18)

DomainDescriptionType

A container for information about a domain.

Contents

AWSAccountId

The AWS account ID for the user pool owner.

Type: String

Required: No

CloudFrontDistribution

The ARN of the CloudFront distribution.

Type: String

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.

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 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 AWS SDKs, see the following:

On this page: