com.amazonaws.services.cognitoidp.model

Class UsernameConfigurationType

java.lang.Object

com.amazonaws.services.cognitoidp.model.UsernameConfigurationType

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UsernameConfigurationType
extends Object
implements Serializable, Cloneable, StructuredPojo

The username configuration type.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
UsernameConfigurationType()

Method Summary

Modifier and Type	Method and Description
UsernameConfigurationType	clone()
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	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
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.
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

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UsernameConfigurationType

public UsernameConfigurationType()

Method Detail

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.

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.

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.

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:

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

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.

toString

public String 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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UsernameConfigurationType clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.