NAME
Paws::CognitoIdp::UsernameConfigurationType
USAGE
This class represents one of two things:
Arguments in a call to a service
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.
As an example, if Att1 is expected to be a Paws::CognitoIdp::UsernameConfigurationType object:
$service_obj->Method(Att1 => { CaseSensitive => $value, ..., CaseSensitive => $value });
Results returned from an API call
Use accessors for each attribute. If Att1 is expected to be an Paws::CognitoIdp::UsernameConfigurationType object:
$result = $service_obj->Method(...);
$result->Att1->CaseSensitive
DESCRIPTION
The username configuration type.
ATTRIBUTES
REQUIRED CaseSensitive => Bool
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 toTrue
, 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 toFalse
, users will be able to sign in using either "username" or "Username". This option also enables bothpreferred_username
andemail
alias to be case insensitive, in addition to theusername
attribute.
SEE ALSO
This class forms part of Paws, describing an object used in Paws::CognitoIdp
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues