Class CfnUserPool.UsernameConfigurationProperty
The UsernameConfiguration
property type specifies case sensitivity on the username input for the selected sign-in option.
Inheritance
System.Object
CfnUserPool.UsernameConfigurationProperty
Implements
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.AWS.Cognito.dll
Syntax (csharp)
public class UsernameConfigurationProperty : Object, CfnUserPool.IUsernameConfigurationProperty
Syntax (vb)
Public Class UsernameConfigurationProperty
Inherits Object
Implements CfnUserPool.IUsernameConfigurationProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Cognito;
var usernameConfigurationProperty = new UsernameConfigurationProperty {
CaseSensitive = false
};
Synopsis
Constructors
UsernameConfigurationProperty() |
Properties
CaseSensitive | Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs. |
Constructors
UsernameConfigurationProperty()
public UsernameConfigurationProperty()
Properties
CaseSensitive
Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs.
public object CaseSensitive { get; set; }
Property Value
System.Object
Remarks
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: