Container for the parameters to the UpdateUserPoolDomain operation.
A user pool domain hosts managed login, an authorization server and web server for
authentication in your application. This operation updates the branding version for
user pool domains between 1 for hosted UI (classic) and 2 for managed
login. It also updates the SSL certificate for user pool custom domains.
Changes to the domain branding version take up to one minute to take effect for a prefix domain and up to five minutes for a custom domain.
This operation doesn't change the name of your user pool domain. To change your domain,
delete it with DeleteUserPoolDomain and create a new domain with CreateUserPoolDomain.
You can pass the ARN of a new Certificate Manager certificate in this request. Typically, ACM certificates automatically renew and you user pool can continue to use the same ARN. But if you generate a new certificate for your custom domain name, replace the original configuration with the new ARN in this request.
ACM certificates for custom domains must be in the US East (N. Virginia) Amazon Web Services Region. After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.
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.UpdateUserPoolDomainRequest
Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
Syntax
public class UpdateUserPoolDomainRequest : AmazonCognitoIdentityProviderRequest IAmazonWebServiceRequest
The UpdateUserPoolDomainRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
UpdateUserPoolDomainRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
CustomDomainConfig | Amazon.CognitoIdentityProvider.Model.CustomDomainConfigType |
Gets and sets the property CustomDomainConfig.
The configuration for a custom domain that hosts managed login for your application.
In an 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 name of the domain that you want to update. For custom domains, this is the fully-qualified
domain name, for example |
|
|
ManagedLoginVersion | System.Int32 |
Gets and sets the property ManagedLoginVersion.
A version number that indicates the state of managed login for your domain. Version
|
|
|
UserPoolId | System.String |
Gets and sets the property UserPoolId. The ID of the user pool that is associated with the domain you're updating. |
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