AWS::Cognito::UserPool UsernameConfiguration - AWS CloudFormation

AWS::Cognito::UserPool UsernameConfiguration

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

Syntax

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

JSON

{ "CaseSensitive" : Boolean }

YAML

CaseSensitive: Boolean

Properties

CaseSensitive

Specifies whether username case sensitivity will be applied for all users in the user pool through Cognito APIs.

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. For example, “UserName”. This is the default value.

  • False : Enables case insensitivity for all username input. For example, when this option is set to False, users will be able to sign in using either "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