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

Class CreateUserPoolDomainRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.CreateUserPoolDomainRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateUserPoolDomainRequest.Builder,CreateUserPoolDomainRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateUserPoolDomainRequest
extends CognitoIdentityProviderRequest
implements ToCopyableBuilder<CreateUserPoolDomainRequest.Builder,CreateUserPoolDomainRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateUserPoolDomainRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateUserPoolDomainRequest.Builder	builder()
CustomDomainConfigType	customDomainConfig()	The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
String	domain()	The domain string.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateUserPoolDomainRequest.Builder>	serializableBuilderClass()
CreateUserPoolDomainRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userPoolId()	The user pool ID.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

domain

public final 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.

Returns:

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.

userPoolId

public final String userPoolId()

The user pool ID.

Returns:

The user pool ID.

customDomainConfig

public final 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.

Returns:

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.

toBuilder

public CreateUserPoolDomainRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateUserPoolDomainRequest.Builder,CreateUserPoolDomainRequest>

Specified by:

toBuilder in class CognitoIdentityProviderRequest

builder

public static CreateUserPoolDomainRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateUserPoolDomainRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo