Class UsernameConfigurationType
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<UsernameConfigurationType.Builder,
UsernameConfigurationType>
The username configuration type.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Boolean
Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends UsernameConfigurationType.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
caseSensitive
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 usingusername
,USERNAME
, orUserName
. This option also enables bothpreferred_username
andemail
alias to be case insensitive, in addition to theusername
attribute.
- Returns:
- 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 usingusername
,USERNAME
, orUserName
. This option also enables bothpreferred_username
andemail
alias to be case insensitive, in addition to theusername
attribute.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<UsernameConfigurationType.Builder,
UsernameConfigurationType> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-