AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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
domain 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.
Your prefix domain might take up to one minute to take effect. Your custom domain is online within five minutes, but it can take up to one hour to distribute your SSL certificate.
For more information about adding a custom domain to your user pool, see Configuring a user pool domain.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginCreateUserPoolDomain and EndCreateUserPoolDomain.
Namespace: Amazon.CognitoIdentityProvider
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
public virtual Task<CreateUserPoolDomainResponse> CreateUserPoolDomainAsync( CreateUserPoolDomainRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the CreateUserPoolDomain service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| ConcurrentModificationException | This exception is thrown if two or more modifications are happening concurrently. |
| FeatureUnavailableInTierException | This exception is thrown when a feature you attempted to configure isn't available in your current feature plan. |
| InternalErrorException | This exception is thrown when Amazon Cognito encounters an internal error. |
| InvalidParameterException | This exception is thrown when the Amazon Cognito service encounters an invalid parameter. |
| LimitExceededException | This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource. |
| NotAuthorizedException | This exception is thrown when a user isn't authorized. |
| ResourceNotFoundException | This exception is thrown when the Amazon Cognito service can't find the requested resource. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer