A container for information about the user pool domain associated with the hosted UI and OAuth endpoints.
This data type is a response parameter of DescribeUserPoolDomain.
Contents
- AWSAccountId
-
The AWS account that you created the user pool in.
Type: String
Length Constraints: Maximum length of 12.
Pattern:
[0-9]+Required: No
- CloudFrontDistribution
-
The Amazon CloudFront endpoint that hosts your custom domain.
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 asauth.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
- ManagedLoginVersion
-
The version of managed login branding that you want to apply to your domain. A value of
1indicates hosted UI (classic) branding and a version of2indicates managed login branding.Managed login requires that your user pool be configured for any feature plan other than
Lite.Type: Integer
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 | FAILEDRequired: No
- UserPoolId
-
The ID of the user pool that the domain is attached to.
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:
