-
Notifications
You must be signed in to change notification settings - Fork 17
/
awscognito_CfnUserPool_UsernameConfigurationProperty.go
26 lines (23 loc) · 1.53 KB
/
awscognito_CfnUserPool_UsernameConfigurationProperty.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
package awscognito
// The `UsernameConfiguration` property type specifies case sensitivity on the username input for the selected sign-in option.
//
// Example:
// // The code below shows an example of how to instantiate this type.
// // The values are placeholders you should change.
// import "github.com/aws/aws-cdk-go/awscdk"
//
// usernameConfigurationProperty := &usernameConfigurationProperty{
// caseSensitive: jsii.Boolean(false),
// }
//
type CfnUserPool_UsernameConfigurationProperty struct {
// 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.
CaseSensitive interface{} `field:"optional" json:"caseSensitive" yaml:"caseSensitive"`
}