« blib/lib/Paws/AmplifyBackend/CreateBackendAPIResponse.pm
↑ Summary
blib/lib/Paws/AmplifyBackend/CreateBackendAuthForgotPasswordConfig.pm »
| 1 | |||
| 2 | package Paws::AmplifyBackend::CreateBackendAuth; | ||
| 3 | use Moose; | ||
| 4 | has AppId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'appId', required => 1); | ||
| 5 | has BackendEnvironmentName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'backendEnvironmentName', required => 1); | ||
| 6 | has ResourceConfig => (is => 'ro', isa => 'Paws::AmplifyBackend::CreateBackendAuthResourceConfig', traits => ['NameInRequest'], request_name => 'resourceConfig', required => 1); | ||
| 7 | has ResourceName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'resourceName', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateBackendAuth'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/backend/{appId}/auth'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AmplifyBackend::CreateBackendAuthResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::AmplifyBackend::CreateBackendAuth - Arguments for method CreateBackendAuth on L<Paws::AmplifyBackend> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method CreateBackendAuth on the | ||
| 26 | L<AmplifyBackend|Paws::AmplifyBackend> service. Use the attributes of this class | ||
| 27 | as arguments to method CreateBackendAuth. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateBackendAuth. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $amplifybackend = Paws->service('AmplifyBackend'); | ||
| 34 | my $CreateBackendAuthResponse = $amplifybackend->CreateBackendAuth( | ||
| 35 | AppId => 'My__string', | ||
| 36 | BackendEnvironmentName => 'My__string', | ||
| 37 | ResourceConfig => { | ||
| 38 | AuthResources => 'USER_POOL_ONLY' | ||
| 39 | , # values: USER_POOL_ONLY, IDENTITY_POOL_AND_USER_POOL | ||
| 40 | Service => 'COGNITO', # values: COGNITO | ||
| 41 | UserPoolConfigs => { | ||
| 42 | RequiredSignUpAttributes => [ | ||
| 43 | 'ADDRESS', | ||
| 44 | ... # values: ADDRESS, BIRTHDATE, EMAIL, FAMILY_NAME, GENDER, GIVEN_NAME, LOCALE, MIDDLE_NAME, NAME, NICKNAME, PHONE_NUMBER, PICTURE, PREFERRED_USERNAME, PROFILE, UPDATED_AT, WEBSITE, ZONE_INFO | ||
| 45 | ], | ||
| 46 | SignInMethod => 'EMAIL' | ||
| 47 | , # values: EMAIL, EMAIL_AND_PHONE_NUMBER, PHONE_NUMBER, USERNAME | ||
| 48 | UserPoolName => 'My__string', | ||
| 49 | ForgotPassword => { | ||
| 50 | DeliveryMethod => 'EMAIL', # values: EMAIL, SMS | ||
| 51 | EmailSettings => { | ||
| 52 | EmailMessage => 'My__string', | ||
| 53 | EmailSubject => 'My__string', | ||
| 54 | }, # OPTIONAL | ||
| 55 | SmsSettings => { SmsMessage => 'My__string', }, # OPTIONAL | ||
| 56 | }, # OPTIONAL | ||
| 57 | Mfa => { | ||
| 58 | MFAMode => 'ON', # values: ON, OFF, OPTIONAL | ||
| 59 | Settings => { | ||
| 60 | MfaTypes => [ | ||
| 61 | 'SMS', ... # values: SMS, TOTP | ||
| 62 | ], # OPTIONAL | ||
| 63 | SmsMessage => 'My__string', | ||
| 64 | }, # OPTIONAL | ||
| 65 | }, # OPTIONAL | ||
| 66 | OAuth => { | ||
| 67 | OAuthGrantType => 'CODE', # values: CODE, IMPLICIT | ||
| 68 | OAuthScopes => [ | ||
| 69 | 'PHONE', | ||
| 70 | ... # values: PHONE, EMAIL, OPENID, PROFILE, AWS_COGNITO_SIGNIN_USER_ADMIN | ||
| 71 | ], | ||
| 72 | RedirectSignInURIs => [ 'My__string', ... ], | ||
| 73 | RedirectSignOutURIs => [ 'My__string', ... ], | ||
| 74 | DomainPrefix => 'My__string', | ||
| 75 | SocialProviderSettings => { | ||
| 76 | Facebook => { | ||
| 77 | ClientId => 'My__string', | ||
| 78 | ClientSecret => 'My__string', | ||
| 79 | }, # OPTIONAL | ||
| 80 | Google => { | ||
| 81 | ClientId => 'My__string', | ||
| 82 | ClientSecret => 'My__string', | ||
| 83 | }, # OPTIONAL | ||
| 84 | LoginWithAmazon => { | ||
| 85 | ClientId => 'My__string', | ||
| 86 | ClientSecret => 'My__string', | ||
| 87 | }, # OPTIONAL | ||
| 88 | }, # OPTIONAL | ||
| 89 | }, # OPTIONAL | ||
| 90 | PasswordPolicy => { | ||
| 91 | MinimumLength => 1, | ||
| 92 | AdditionalConstraints => [ | ||
| 93 | 'REQUIRE_DIGIT', | ||
| 94 | ... # values: REQUIRE_DIGIT, REQUIRE_LOWERCASE, REQUIRE_SYMBOL, REQUIRE_UPPERCASE | ||
| 95 | ], # OPTIONAL | ||
| 96 | }, # OPTIONAL | ||
| 97 | }, | ||
| 98 | IdentityPoolConfigs => { | ||
| 99 | IdentityPoolName => 'My__string', | ||
| 100 | UnauthenticatedLogin => 1, | ||
| 101 | |||
| 102 | }, # OPTIONAL | ||
| 103 | }, | ||
| 104 | ResourceName => 'My__string', | ||
| 105 | |||
| 106 | ); | ||
| 107 | |||
| 108 | # Results: | ||
| 109 | my $AppId = $CreateBackendAuthResponse->AppId; | ||
| 110 | my $BackendEnvironmentName = | ||
| 111 | $CreateBackendAuthResponse->BackendEnvironmentName; | ||
| 112 | my $Error = $CreateBackendAuthResponse->Error; | ||
| 113 | my $JobId = $CreateBackendAuthResponse->JobId; | ||
| 114 | my $Operation = $CreateBackendAuthResponse->Operation; | ||
| 115 | my $Status = $CreateBackendAuthResponse->Status; | ||
| 116 | |||
| 117 | # Returns a L<Paws::AmplifyBackend::CreateBackendAuthResponse> object. | ||
| 118 | |||
| 119 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 120 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/amplifybackend/CreateBackendAuth> | ||
| 121 | |||
| 122 | =head1 ATTRIBUTES | ||
| 123 | |||
| 124 | |||
| 125 | =head2 B<REQUIRED> AppId => Str | ||
| 126 | |||
| 127 | The app ID. | ||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | =head2 B<REQUIRED> BackendEnvironmentName => Str | ||
| 132 | |||
| 133 | The name of the backend environment. | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | =head2 B<REQUIRED> ResourceConfig => L<Paws::AmplifyBackend::CreateBackendAuthResourceConfig> | ||
| 138 | |||
| 139 | The resource configuration for this request object. | ||
| 140 | |||
| 141 | |||
| 142 | |||
| 143 | =head2 B<REQUIRED> ResourceName => Str | ||
| 144 | |||
| 145 | The name of this resource. | ||
| 146 | |||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | =head1 SEE ALSO | ||
| 151 | |||
| 152 | This class forms part of L<Paws>, documenting arguments for method CreateBackendAuth in L<Paws::AmplifyBackend> | ||
| 153 | |||
| 154 | =head1 BUGS and CONTRIBUTIONS | ||
| 155 | |||
| 156 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 157 | |||
| 158 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 159 | |||
| 160 | =cut | ||
| 161 |