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 the sign-up and sign-in pages for your application.customDomainConfig
(CustomDomainConfigType customDomainConfig) The configuration for a custom domain that hosts the sign-up and sign-in pages for your application.The domain name for the custom domain that hosts the sign-up and sign-in pages for your application.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 custom domain whose certificate 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, sdkFields
-
Method Details
-
domain
The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. One example might be
auth.example.com
.This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.
- Parameters:
domain
- The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. One example might beauth.example.com
.This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.
- 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 custom domain whose certificate you're updating.
- Parameters:
userPoolId
- The ID of the user pool that is associated with the custom domain whose certificate you're updating.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
customDomainConfig
The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM.
- Parameters:
customDomainConfig
- The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM.- 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 the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM.
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.
-