A user pool domain hosts managed login, an authorization server and web server for authentication in your application. This operation creates a new user pool prefix or custom domain and sets the managed login branding version. Set the branding version to 1
for hosted UI (classic) or 2
for managed login. When you choose a custom domain, you must provide an SSL certificate in the US East (N. Virginia) Amazon Web Services Region in your request.
See https://www.paws-r-sdk.com/docs/cognitoidentityprovider_create_user_pool_domain/ for full documentation.
cognitoidentityprovider_create_user_pool_domain(
Domain,
UserPoolId,
ManagedLoginVersion = NULL,
CustomDomainConfig = NULL
)
[required] The domain string. For custom domains, this is the fully-qualified
domain name, such as auth.example.com
. For prefix domains, this is the
prefix alone, such as myprefix
. A prefix value of myprefix
for a
user pool in the us-east-1 Region results in a domain of
myprefix.auth.us-east-1.amazoncognito.com
.
[required] The ID of the user pool where you want to add a domain.
The version of managed login branding that you want to apply to your
domain. A value of 1
indicates hosted UI (classic) and a version of
2
indicates managed login.
Managed login requires that your user pool be configured for any
feature plan
other than Lite
.
The configuration for a custom domain. Configures your domain with an
Certificate Manager certificate in the us-east-1
Region.
Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use a prefix domain instead.
For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.