/ - Amazon Cognito Identity Provider

Creates a new domain for a user pool.

curl --location --request POST '/' \ --header 'X-Amz-Target;' \ --header 'Content-Type: application/json' \ --data-raw '{ "Domain": "string", "UserPoolId": "string", "CustomDomainConfig": { "CertificateArn": "string" } }'

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

Domain

string

required

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.

>= 1 characters<= 63 characters

Match pattern:

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

UserPoolId

string

required

The user pool ID.

>= 1 characters<= 55 characters

Match pattern:

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

CustomDomainConfig

object

optional

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

Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.

For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.

CertificateArn

string

required

The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.

>= 20 characters<= 2048 characters

Match pattern:

arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

Examples

Responses

🟢200Success

application/json

Body

CloudFrontDomain

string

optional

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

>= 1 characters<= 63 characters

Match pattern:

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

🟠480InvalidParameterException

🟠481NotAuthorizedException

🟠482ResourceNotFoundException

🟠483LimitExceededException

🟠484InternalErrorException