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

Class UsernameConfigurationType

java.lang.Object

software.amazon.awssdk.services.cognitoidentityprovider.model.UsernameConfigurationType

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<UsernameConfigurationType.Builder,UsernameConfigurationType>

@Generated("software.amazon.awssdk:codegen")
public final class UsernameConfigurationType
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<UsernameConfigurationType.Builder,UsernameConfigurationType>

The username configuration type.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UsernameConfigurationType.Builder

Method Summary

Modifier and Type	Method	Description
static UsernameConfigurationType.Builder	builder()
Boolean	caseSensitive()	Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs.
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 UsernameConfigurationType.Builder>	serializableBuilderClass()
UsernameConfigurationType.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

caseSensitive

public final Boolean caseSensitive()

Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs. For most use cases, set case sensitivity to False (case insensitive) as a best practice. When usernames and email addresses are case insensitive, users can sign in as the same user when they enter a different capitalization of their user name.

Valid values include:

True

Enables case sensitivity for all username input. When this option is set to True, users must sign in using the exact capitalization of their given username, such as “UserName”. This is the default value.

False

Enables case insensitivity for all username input. For example, when this option is set to False, users can sign in using username, USERNAME, or UserName. This option also enables both preferred_username and email alias to be case insensitive, in addition to the username attribute.

Returns:

Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs. For most use cases, set case sensitivity to False (case insensitive) as a best practice. When usernames and email addresses are case insensitive, users can sign in as the same user when they enter a different capitalization of their user name.

Valid values include:

True

Enables case sensitivity for all username input. When this option is set to True, users must sign in using the exact capitalization of their given username, such as “UserName”. This is the default value.

False

Enables case insensitivity for all username input. For example, when this option is set to False, users can sign in using username, USERNAME, or UserName. This option also enables both preferred_username and email alias to be case insensitive, in addition to the username attribute.

toBuilder

public UsernameConfigurationType.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UsernameConfigurationType.Builder,UsernameConfigurationType>

builder

public static UsernameConfigurationType.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo