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 configuration of a user pool for username case sensitivity.

See Also:

  • Method Details

    • 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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo