Package software.amazon.awscdk.services.cognito

Class CfnUserPool.UsernameConfigurationProperty.Builder

java.lang.Object
software.amazon.awscdk.services.cognito.CfnUserPool.UsernameConfigurationProperty.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnUserPool.UsernameConfigurationProperty>
Enclosing interface:
CfnUserPool.UsernameConfigurationProperty
@Stability(Stable) public static final class CfnUserPool.UsernameConfigurationProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnUserPool.UsernameConfigurationProperty>
A builder for CfnUserPool.UsernameConfigurationProperty

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • caseSensitive

      @Stability(Stable) public CfnUserPool.UsernameConfigurationProperty.Builder caseSensitive(Boolean caseSensitive)
      Sets the value of CfnUserPool.UsernameConfigurationProperty.getCaseSensitive()
      Parameters:
      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:
      this

    • caseSensitive

      @Stability(Stable) public CfnUserPool.UsernameConfigurationProperty.Builder caseSensitive(IResolvable caseSensitive)
      Sets the value of CfnUserPool.UsernameConfigurationProperty.getCaseSensitive()
      Parameters:
      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:
      this

    • build

      @Stability(Stable) public CfnUserPool.UsernameConfigurationProperty build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnUserPool.UsernameConfigurationProperty>
      Returns:
      a new instance of CfnUserPool.UsernameConfigurationProperty
      Throws:
      NullPointerException - if any required attribute was not provided