Package software.amazon.awssdk.services.cognitoidentityprovider.model

Interface CreateUserPoolDomainRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CognitoIdentityProviderRequest.Builder, CopyableBuilder<CreateUserPoolDomainRequest.Builder,CreateUserPoolDomainRequest>, SdkBuilder<CreateUserPoolDomainRequest.Builder,CreateUserPoolDomainRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateUserPoolDomainRequest

public static interface CreateUserPoolDomainRequest.Builder
extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<CreateUserPoolDomainRequest.Builder,CreateUserPoolDomainRequest>

Method Summary

Modifier and Type	Method	Description
default CreateUserPoolDomainRequest.Builder	customDomainConfig(Consumer<CustomDomainConfigType.Builder> customDomainConfig)	The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
CreateUserPoolDomainRequest.Builder	customDomainConfig(CustomDomainConfigType customDomainConfig)	The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
CreateUserPoolDomainRequest.Builder	domain(String domain)	The domain string.
CreateUserPoolDomainRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateUserPoolDomainRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateUserPoolDomainRequest.Builder	userPoolId(String userPoolId)	The user pool ID.

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

CreateUserPoolDomainRequest.Builder domain(String domain)

The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.

Parameters:

domain - The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.

Returns:

Returns a reference to this object so that method calls can be chained together.

userPoolId

CreateUserPoolDomainRequest.Builder userPoolId(String userPoolId)

The user pool ID.

Parameters:

userPoolId - The user pool ID.

Returns:

Returns a reference to this object so that method calls can be chained together.

customDomainConfig

CreateUserPoolDomainRequest.Builder customDomainConfig(CustomDomainConfigType customDomainConfig)

The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.

For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.

Parameters:

customDomainConfig - The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.

For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.

Returns:

Returns a reference to this object so that method calls can be chained together.

customDomainConfig

default CreateUserPoolDomainRequest.Builder customDomainConfig(Consumer<CustomDomainConfigType.Builder> customDomainConfig)

The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.

For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.

This is a convenience method that creates an instance of the CustomDomainConfigType.Builder avoiding the need to create one manually via CustomDomainConfigType.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customDomainConfig(CustomDomainConfigType).

Parameters:

customDomainConfig - a consumer that will call methods on CustomDomainConfigType.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• customDomainConfig(CustomDomainConfigType)

overrideConfiguration

CreateUserPoolDomainRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateUserPoolDomainRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.