public static interface CfnUserPool.UsernameConfigurationProperty
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.cognito.*; UsernameConfigurationProperty usernameConfigurationProperty = UsernameConfigurationProperty.builder() .caseSensitive(false) .build();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnUserPool.UsernameConfigurationProperty.Builder
A builder for
CfnUserPool.UsernameConfigurationProperty |
static class |
CfnUserPool.UsernameConfigurationProperty.Jsii$Proxy
An implementation for
CfnUserPool.UsernameConfigurationProperty |
Modifier and Type | Method and Description |
---|---|
static CfnUserPool.UsernameConfigurationProperty.Builder |
builder() |
default java.lang.Object |
getCaseSensitive()
Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs.
|
default java.lang.Object getCaseSensitive()
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.static CfnUserPool.UsernameConfigurationProperty.Builder builder()