« blib/lib/Paws/CognitoIdp/UserType.pm
↑ Summary
blib/lib/Paws/CognitoIdp/VerificationMessageTemplateType.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CognitoIdp::UsernameConfigurationType; | ||
| 3 | use Moose; | ||
| 4 | has CaseSensitive => (is => 'ro', isa => 'Bool', required => 1); | ||
| 5 | |||
| 6 | 1; | ||
| 7 | |||
| 8 | ### main pod documentation begin ### | ||
| 9 | |||
| 10 | =head1 NAME | ||
| 11 | |||
| 12 | Paws::CognitoIdp::UsernameConfigurationType | ||
| 13 | |||
| 14 | =head1 USAGE | ||
| 15 | |||
| 16 | This class represents one of two things: | ||
| 17 | |||
| 18 | =head3 Arguments in a call to a service | ||
| 19 | |||
| 20 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 21 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 22 | |||
| 23 | As an example, if Att1 is expected to be a Paws::CognitoIdp::UsernameConfigurationType object: | ||
| 24 | |||
| 25 | $service_obj->Method(Att1 => { CaseSensitive => $value, ..., CaseSensitive => $value }); | ||
| 26 | |||
| 27 | =head3 Results returned from an API call | ||
| 28 | |||
| 29 | Use accessors for each attribute. If Att1 is expected to be an Paws::CognitoIdp::UsernameConfigurationType object: | ||
| 30 | |||
| 31 | $result = $service_obj->Method(...); | ||
| 32 | $result->Att1->CaseSensitive | ||
| 33 | |||
| 34 | =head1 DESCRIPTION | ||
| 35 | |||
| 36 | The username configuration type. | ||
| 37 | |||
| 38 | =head1 ATTRIBUTES | ||
| 39 | |||
| 40 | |||
| 41 | =head2 B<REQUIRED> CaseSensitive => Bool | ||
| 42 | |||
| 43 | Specifies whether username case sensitivity will be applied for all | ||
| 44 | users in the user pool through Cognito APIs. | ||
| 45 | |||
| 46 | Valid values include: | ||
| 47 | |||
| 48 | =over | ||
| 49 | |||
| 50 | =item * | ||
| 51 | |||
| 52 | B<C<True> >: Enables case sensitivity for all username input. When this | ||
| 53 | option is set to C<True>, users must sign in using the exact | ||
| 54 | capitalization of their given username. For example, | ||
| 55 | E<ldquo>UserNameE<rdquo>. This is the default value. | ||
| 56 | |||
| 57 | =item * | ||
| 58 | |||
| 59 | B<C<False> >: Enables case insensitivity for all username input. For | ||
| 60 | example, when this option is set to C<False>, users will be able to | ||
| 61 | sign in using either "username" or "Username". This option also enables | ||
| 62 | both C<preferred_username> and C<email> alias to be case insensitive, | ||
| 63 | in addition to the C<username> attribute. | ||
| 64 | |||
| 65 | =back | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head1 SEE ALSO | ||
| 71 | |||
| 72 | This class forms part of L<Paws>, describing an object used in L<Paws::CognitoIdp> | ||
| 73 | |||
| 74 | =head1 BUGS and CONTRIBUTIONS | ||
| 75 | |||
| 76 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 77 | |||
| 78 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 79 | |||
| 80 | =cut | ||
| 81 |