File Coverage

blib/lib/Paws/CognitoIdentity/CreateIdentityPool.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::CognitoIdentity::CreateIdentityPool;
3 1     1   545 use Moose;
  1         3  
  1         7  
4             has AllowUnauthenticatedIdentities => (is => 'ro', isa => 'Bool', required => 1);
5             has CognitoIdentityProviders => (is => 'ro', isa => 'ArrayRef[Paws::CognitoIdentity::CognitoIdentityProvider]');
6             has DeveloperProviderName => (is => 'ro', isa => 'Str');
7             has IdentityPoolName => (is => 'ro', isa => 'Str', required => 1);
8             has OpenIdConnectProviderARNs => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
9             has SamlProviderARNs => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
10             has SupportedLoginProviders => (is => 'ro', isa => 'Paws::CognitoIdentity::IdentityProviders');
11              
12 1     1   6296 use MooseX::ClassAttribute;
  1         3  
  1         9  
13              
14             class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateIdentityPool');
15             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CognitoIdentity::IdentityPool');
16             class_has _result_key => (isa => 'Str', is => 'ro');
17             1;
18              
19             ### main pod documentation begin ###
20              
21             =head1 NAME
22              
23             Paws::CognitoIdentity::CreateIdentityPool - Arguments for method CreateIdentityPool on Paws::CognitoIdentity
24              
25             =head1 DESCRIPTION
26              
27             This class represents the parameters used for calling the method CreateIdentityPool on the
28             Amazon Cognito Identity service. Use the attributes of this class
29             as arguments to method CreateIdentityPool.
30              
31             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateIdentityPool.
32              
33             As an example:
34              
35             $service_obj->CreateIdentityPool(Att1 => $value1, Att2 => $value2, ...);
36              
37             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.
38              
39             =head1 ATTRIBUTES
40              
41              
42             =head2 B<REQUIRED> AllowUnauthenticatedIdentities => Bool
43              
44             TRUE if the identity pool supports unauthenticated logins.
45              
46              
47              
48             =head2 CognitoIdentityProviders => ArrayRef[L<Paws::CognitoIdentity::CognitoIdentityProvider>]
49              
50             An array of Amazon Cognito Identity user pools and their client IDs.
51              
52              
53              
54             =head2 DeveloperProviderName => Str
55              
56             The "domain" by which Cognito will refer to your users. This name acts
57             as a placeholder that allows your backend and the Cognito service to
58             communicate about the developer provider. For the
59             C<DeveloperProviderName>, you can use letters as well as period (C<.>),
60             underscore (C<_>), and dash (C<->).
61              
62             Once you have set a developer provider name, you cannot change it.
63             Please take care in setting this parameter.
64              
65              
66              
67             =head2 B<REQUIRED> IdentityPoolName => Str
68              
69             A string that you provide.
70              
71              
72              
73             =head2 OpenIdConnectProviderARNs => ArrayRef[Str|Undef]
74              
75             A list of OpendID Connect provider ARNs.
76              
77              
78              
79             =head2 SamlProviderARNs => ArrayRef[Str|Undef]
80              
81             An array of Amazon Resource Names (ARNs) of the SAML provider for your
82             identity pool.
83              
84              
85              
86             =head2 SupportedLoginProviders => L<Paws::CognitoIdentity::IdentityProviders>
87              
88             Optional key:value pairs mapping provider names to provider app IDs.
89              
90              
91              
92              
93             =head1 SEE ALSO
94              
95             This class forms part of L<Paws>, documenting arguments for method CreateIdentityPool in L<Paws::CognitoIdentity>
96              
97             =head1 BUGS and CONTRIBUTIONS
98              
99             The source code is located here: https://github.com/pplu/aws-sdk-perl
100              
101             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
102              
103             =cut
104