Container for the parameters to the CreateUserPoolDomain operation.
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
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
Amazon.CognitoIdentityProvider.Model.CreateUserPoolDomainRequest
Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
Syntax
public class CreateUserPoolDomainRequest : AmazonCognitoIdentityProviderRequest IAmazonWebServiceRequest
The CreateUserPoolDomainRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
CreateUserPoolDomainRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
CustomDomainConfig | Amazon.CognitoIdentityProvider.Model.CustomDomainConfigType |
Gets and sets the property CustomDomainConfig.
The configuration for a custom domain. Configures your domain with an Certificate
Manager certificate in the Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can omit this parameter and use a prefix domain instead. When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain. |
|
|
Domain | System.String |
Gets and sets the property Domain.
The domain string. For custom domains, this is the fully-qualified domain name, such
as |
|
|
ManagedLoginVersion | System.Int32 |
Gets and sets the property ManagedLoginVersion.
The version of managed login branding that you want to apply to your domain. A value
of
Managed login requires that your user pool be configured for any feature
plan other than |
|
|
UserPoolId | System.String |
Gets and sets the property UserPoolId. The ID of the user pool where you want to add a domain. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5