com.amazonaws.services.cognitoidentityprovider.model

Class UsernameConfigurationType

java.lang.Object

com.amazonaws.services.cognitoidentityprovider.model.UsernameConfigurationType

All Implemented Interfaces:

Serializable

public class UsernameConfigurationType
extends Object
implements Serializable

The username configuration type.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UsernameConfigurationType()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Boolean	getCaseSensitive() Specifies whether username case sensitivity will be applied for all users in the user pool through Cognito APIs.
int	hashCode()
Boolean	isCaseSensitive() Specifies whether username case sensitivity will be applied for all users in the user pool through Cognito APIs.
void	setCaseSensitive(Boolean caseSensitive) Specifies whether username case sensitivity will be applied for all users in the user pool through Cognito APIs.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UsernameConfigurationType	withCaseSensitive(Boolean caseSensitive) Specifies whether username case sensitivity will be applied for all users in the user pool through Cognito APIs.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UsernameConfigurationType

public UsernameConfigurationType()

Method Detail

isCaseSensitive

public Boolean isCaseSensitive()

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.

Returns:

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.

getCaseSensitive

public Boolean getCaseSensitive()

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.

Returns:

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.

setCaseSensitive

public void setCaseSensitive(Boolean 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.

Parameters:

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.

withCaseSensitive

public UsernameConfigurationType withCaseSensitive(Boolean 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object