Package software.amazon.awscdk.services.cognito

Interface CfnUserPool.UsernameConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPool.UsernameConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnUserPool

@Stability(Stable)
public static interface CfnUserPool.UsernameConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Case sensitivity of the username input for the selected sign-in option.

When case sensitivity is set to False (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, username , USERNAME , or UserName , or for email, email@example.com or EMaiL@eXamplE.Com . For most use cases, set case sensitivity to False (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.

This configuration is immutable after you set it. For more information, see UsernameConfigurationType .

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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-usernameconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserPool.UsernameConfigurationProperty.Builder	A builder for CfnUserPool.UsernameConfigurationProperty
static final class	CfnUserPool.UsernameConfigurationProperty.Jsii$Proxy	An implementation for CfnUserPool.UsernameConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnUserPool.UsernameConfigurationProperty.Builder	builder()
default Object	getCaseSensitive()	Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-usernameconfiguration.html#cfn-cognito-userpool-usernameconfiguration-casesensitive

builder

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

Returns:

a CfnUserPool.UsernameConfigurationProperty.Builder of CfnUserPool.UsernameConfigurationProperty