Interface UpdateUserPoolDomainRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CognitoIdentityProviderRequest.Builder
,CopyableBuilder<UpdateUserPoolDomainRequest.Builder,
,UpdateUserPoolDomainRequest> SdkBuilder<UpdateUserPoolDomainRequest.Builder,
,UpdateUserPoolDomainRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
UpdateUserPoolDomainRequest
-
Method Summary
Modifier and TypeMethodDescriptioncustomDomainConfig
(Consumer<CustomDomainConfigType.Builder> customDomainConfig) The configuration for a custom domain that hosts managed login for your application.customDomainConfig
(CustomDomainConfigType customDomainConfig) The configuration for a custom domain that hosts managed login for your application.The name of the domain that you want to update.managedLoginVersion
(Integer managedLoginVersion) A version number that indicates the state of managed login for your domain.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.userPoolId
(String userPoolId) The ID of the user pool that is associated with the domain you're updating.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
domain
The name of the domain that you want to update. For custom domains, this is the fully-qualified domain name, for example
auth.example.com
. For prefix domains, this is the prefix alone, such asmyprefix
.- Parameters:
domain
- The name of the domain that you want to update. For custom domains, this is the fully-qualified domain name, for exampleauth.example.com
. For prefix domains, this is the prefix alone, such asmyprefix
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userPoolId
The ID of the user pool that is associated with the domain you're updating.
- Parameters:
userPoolId
- The ID of the user pool that is associated with the domain you're updating.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
managedLoginVersion
A version number that indicates the state of managed login for your domain. Version
1
is hosted UI (classic). Version2
is the newer managed login with the branding designer. For more information, see Managed login.- Parameters:
managedLoginVersion
- A version number that indicates the state of managed login for your domain. Version1
is hosted UI (classic). Version2
is the newer managed login with the branding designer. For more information, see Managed login.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
customDomainConfig
The configuration for a custom domain that hosts managed login for your application. In an
UpdateUserPoolDomain
request, this parameter specifies an SSL certificate for the managed login hosted webserver. The certificate must be an ACM ARN inus-east-1
.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.
- Parameters:
customDomainConfig
- The configuration for a custom domain that hosts managed login for your application. In anUpdateUserPoolDomain
request, this parameter specifies an SSL certificate for the managed login hosted webserver. The certificate must be an ACM ARN inus-east-1
.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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
customDomainConfig
default UpdateUserPoolDomainRequest.Builder customDomainConfig(Consumer<CustomDomainConfigType.Builder> customDomainConfig) The configuration for a custom domain that hosts managed login for your application. In an
UpdateUserPoolDomain
request, this parameter specifies an SSL certificate for the managed login hosted webserver. The certificate must be an ACM ARN inus-east-1
.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.
This is a convenience method that creates an instance of theCustomDomainConfigType.Builder
avoiding the need to create one manually viaCustomDomainConfigType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocustomDomainConfig(CustomDomainConfigType)
.- Parameters:
customDomainConfig
- a consumer that will call methods onCustomDomainConfigType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
UpdateUserPoolDomainRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpdateUserPoolDomainRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-