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.
String	domain()	The domain string.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	managedLoginVersion()	The version of managed login branding that you want to apply to your domain.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateUserPoolDomainRequest.Builder>	serializableBuilderClass()
CreateUserPoolDomainRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userPoolId()	The ID of the user pool where you want to add a domain.

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 prefix domains, this is the prefix alone, such as myprefix. A prefix value of myprefix for a user pool in the us-east-1 Region results in a domain of myprefix.auth.us-east-1.amazoncognito.com.

Returns:

The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For prefix domains, this is the prefix alone, such as myprefix. A prefix value of myprefix for a user pool in the us-east-1 Region results in a domain of myprefix.auth.us-east-1.amazoncognito.com.

userPoolId

public final String userPoolId()

The ID of the user pool where you want to add a domain.

Returns:

The ID of the user pool where you want to add a domain.

managedLoginVersion

public final Integer managedLoginVersion()

The version of managed login branding that you want to apply to your domain. A value of 1 indicates hosted UI (classic) and a version of 2 indicates managed login.

Managed login requires that your user pool be configured for any feature plan other than Lite.

Returns:

The version of managed login branding that you want to apply to your domain. A value of 1 indicates hosted UI (classic) and a version of 2 indicates managed login.

Managed login requires that your user pool be configured for any feature plan other than Lite.

customDomainConfig

public final CustomDomainConfigType customDomainConfig()

The configuration for a custom domain. Configures your domain with an Certificate Manager certificate in the us-east-1 Region.

Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use a prefix 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. Configures your domain with an Certificate Manager certificate in the us-east-1 Region.

Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use a prefix 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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo