Class CfnUserPool.UsernameConfigurationProperty

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

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

public class CfnUserPool.UsernameConfigurationProperty : CfnUserPool.IUsernameConfigurationProperty

Inheritance

object

CfnUserPool.UsernameConfigurationProperty

Implements

CfnUserPool.IUsernameConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

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
             };

Remarks

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

ExampleMetadata: fixture=_generated

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

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:

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