public static final class CfnUserPool.UsernameConfigurationProperty.Builder
extends java.lang.Object
CfnUserPool.UsernameConfigurationProperty
Constructor and Description |
---|
Builder() |
Modifier and Type | Method and Description |
---|---|
CfnUserPool.UsernameConfigurationProperty |
build()
Builds the configured instance.
|
CfnUserPool.UsernameConfigurationProperty.Builder |
caseSensitive(java.lang.Boolean caseSensitive)
Sets the value of
CfnUserPool.UsernameConfigurationProperty.getCaseSensitive() |
CfnUserPool.UsernameConfigurationProperty.Builder |
caseSensitive(IResolvable caseSensitive)
Sets the value of
CfnUserPool.UsernameConfigurationProperty.getCaseSensitive() |
public CfnUserPool.UsernameConfigurationProperty.Builder caseSensitive(java.lang.Boolean caseSensitive)
CfnUserPool.UsernameConfigurationProperty.getCaseSensitive()
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
, users must sign in using the exact capitalization of their given username, such as “UserName”. This is the default value.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.this
public CfnUserPool.UsernameConfigurationProperty.Builder caseSensitive(IResolvable caseSensitive)
CfnUserPool.UsernameConfigurationProperty.getCaseSensitive()
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
, users must sign in using the exact capitalization of their given username, such as “UserName”. This is the default value.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.this
public CfnUserPool.UsernameConfigurationProperty build()
CfnUserPool.UsernameConfigurationProperty
java.lang.NullPointerException
- if any required attribute was not provided