« blib/lib/Paws/AmplifyBackend/CreateBackendAuthResponse.pm
↑ Summary
blib/lib/Paws/AmplifyBackend/CreateBackendConfig.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::AmplifyBackend::CreateBackendAuthUserPoolConfig; | ||
| 3 | use Moose; | ||
| 4 | has ForgotPassword => (is => 'ro', isa => 'Paws::AmplifyBackend::CreateBackendAuthForgotPasswordConfig', request_name => 'forgotPassword', traits => ['NameInRequest']); | ||
| 5 | has Mfa => (is => 'ro', isa => 'Paws::AmplifyBackend::CreateBackendAuthMFAConfig', request_name => 'mfa', traits => ['NameInRequest']); | ||
| 6 | has OAuth => (is => 'ro', isa => 'Paws::AmplifyBackend::CreateBackendAuthOAuthConfig', request_name => 'oAuth', traits => ['NameInRequest']); | ||
| 7 | has PasswordPolicy => (is => 'ro', isa => 'Paws::AmplifyBackend::CreateBackendAuthPasswordPolicyConfig', request_name => 'passwordPolicy', traits => ['NameInRequest']); | ||
| 8 | has RequiredSignUpAttributes => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'requiredSignUpAttributes', traits => ['NameInRequest'], required => 1); | ||
| 9 | has SignInMethod => (is => 'ro', isa => 'Str', request_name => 'signInMethod', traits => ['NameInRequest'], required => 1); | ||
| 10 | has UserPoolName => (is => 'ro', isa => 'Str', request_name => 'userPoolName', traits => ['NameInRequest'], required => 1); | ||
| 11 | |||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::AmplifyBackend::CreateBackendAuthUserPoolConfig | ||
| 19 | |||
| 20 | =head1 USAGE | ||
| 21 | |||
| 22 | This class represents one of two things: | ||
| 23 | |||
| 24 | =head3 Arguments in a call to a service | ||
| 25 | |||
| 26 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 27 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 28 | |||
| 29 | As an example, if Att1 is expected to be a Paws::AmplifyBackend::CreateBackendAuthUserPoolConfig object: | ||
| 30 | |||
| 31 | $service_obj->Method(Att1 => { ForgotPassword => $value, ..., UserPoolName => $value }); | ||
| 32 | |||
| 33 | =head3 Results returned from an API call | ||
| 34 | |||
| 35 | Use accessors for each attribute. If Att1 is expected to be an Paws::AmplifyBackend::CreateBackendAuthUserPoolConfig object: | ||
| 36 | |||
| 37 | $result = $service_obj->Method(...); | ||
| 38 | $result->Att1->ForgotPassword | ||
| 39 | |||
| 40 | =head1 DESCRIPTION | ||
| 41 | |||
| 42 | Describes the Amazon Cognito user pool configuration for the auth | ||
| 43 | resource to be configured for your Amplify project. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 ForgotPassword => L<Paws::AmplifyBackend::CreateBackendAuthForgotPasswordConfig> | ||
| 49 | |||
| 50 | Describes the forgotten password policy for your Amazon Cognito user | ||
| 51 | pool, configured as a part of your Amplify project. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 Mfa => L<Paws::AmplifyBackend::CreateBackendAuthMFAConfig> | ||
| 55 | |||
| 56 | Describes whether multi-factor authentication policies should be | ||
| 57 | applied for your Amazon Cognito user pool configured as a part of your | ||
| 58 | Amplify project. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 OAuth => L<Paws::AmplifyBackend::CreateBackendAuthOAuthConfig> | ||
| 62 | |||
| 63 | Describes the OAuth policy and rules for your Amazon Cognito user pool, | ||
| 64 | configured as a part of your Amplify project. | ||
| 65 | |||
| 66 | |||
| 67 | =head2 PasswordPolicy => L<Paws::AmplifyBackend::CreateBackendAuthPasswordPolicyConfig> | ||
| 68 | |||
| 69 | Describes the password policy for your Amazon Cognito user pool, | ||
| 70 | configured as a part of your Amplify project. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 B<REQUIRED> RequiredSignUpAttributes => ArrayRef[Str|Undef] | ||
| 74 | |||
| 75 | The required attributes to sign up new users in the user pool. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 B<REQUIRED> SignInMethod => Str | ||
| 79 | |||
| 80 | Describes the sign-in methods that your Amplify app users use to log in | ||
| 81 | using the Amazon Cognito user pool, configured as a part of your | ||
| 82 | Amplify project. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 B<REQUIRED> UserPoolName => Str | ||
| 86 | |||
| 87 | The Amazon Cognito user pool name. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head1 SEE ALSO | ||
| 92 | |||
| 93 | This class forms part of L<Paws>, describing an object used in L<Paws::AmplifyBackend> | ||
| 94 | |||
| 95 | =head1 BUGS and CONTRIBUTIONS | ||
| 96 | |||
| 97 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 98 | |||
| 99 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 100 | |||
| 101 | =cut | ||
| 102 |