Interface CfnUserPool.UsernameConfigurationProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnUserPool.UsernameConfigurationProperty extends
The UsernameConfiguration property type specifies case sensitivity on the username input for the selected sign-in option.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 UsernameConfigurationProperty usernameConfigurationProperty = UsernameConfigurationProperty.builder()
  • Method Details

    • getCaseSensitive

      @Stability(Stable) @Nullable default Object getCaseSensitive()
      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.
    • builder

      @Stability(Stable) static CfnUserPool.UsernameConfigurationProperty.Builder builder()
      a CfnUserPool.UsernameConfigurationProperty.Builder of CfnUserPool.UsernameConfigurationProperty