AWS::Cognito::UserPool UsernameConfiguration - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Cognito::UserPool UsernameConfiguration

The UsernameConfiguration property type specifies case sensitivity on the username input for the selected sign-in option.


To declare this entity in your Amazon CloudFormation template, use the following syntax:


{ "CaseSensitive" : Boolean }


CaseSensitive: Boolean



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:


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.


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.

Required: No

Type: Boolean

Update requires: No interruption