File Coverage

blib/lib/Paws/CognitoIdp/CreateUserPool.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::CognitoIdp::CreateUserPool;
3 1     1   360 use Moose;
  1         2  
  1         5  
4             has AdminCreateUserConfig => (is => 'ro', isa => 'Paws::CognitoIdp::AdminCreateUserConfigType');
5             has AliasAttributes => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
6             has AutoVerifiedAttributes => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
7             has DeviceConfiguration => (is => 'ro', isa => 'Paws::CognitoIdp::DeviceConfigurationType');
8             has EmailConfiguration => (is => 'ro', isa => 'Paws::CognitoIdp::EmailConfigurationType');
9             has EmailVerificationMessage => (is => 'ro', isa => 'Str');
10             has EmailVerificationSubject => (is => 'ro', isa => 'Str');
11             has LambdaConfig => (is => 'ro', isa => 'Paws::CognitoIdp::LambdaConfigType');
12             has MfaConfiguration => (is => 'ro', isa => 'Str');
13             has Policies => (is => 'ro', isa => 'Paws::CognitoIdp::UserPoolPolicyType');
14             has PoolName => (is => 'ro', isa => 'Str', required => 1);
15             has Schema => (is => 'ro', isa => 'ArrayRef[Paws::CognitoIdp::SchemaAttributeType]');
16             has SmsAuthenticationMessage => (is => 'ro', isa => 'Str');
17             has SmsConfiguration => (is => 'ro', isa => 'Paws::CognitoIdp::SmsConfigurationType');
18             has SmsVerificationMessage => (is => 'ro', isa => 'Str');
19             has UsernameAttributes => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
20             has UserPoolTags => (is => 'ro', isa => 'Paws::CognitoIdp::UserPoolTagsType');
21             has VerificationMessageTemplate => (is => 'ro', isa => 'Paws::CognitoIdp::VerificationMessageTemplateType');
22              
23 1     1   5461 use MooseX::ClassAttribute;
  1         2  
  1         9  
24              
25             class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateUserPool');
26             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CognitoIdp::CreateUserPoolResponse');
27             class_has _result_key => (isa => 'Str', is => 'ro');
28             1;
29              
30             ### main pod documentation begin ###
31              
32             =head1 NAME
33              
34             Paws::CognitoIdp::CreateUserPool - Arguments for method CreateUserPool on Paws::CognitoIdp
35              
36             =head1 DESCRIPTION
37              
38             This class represents the parameters used for calling the method CreateUserPool on the
39             Amazon Cognito Identity Provider service. Use the attributes of this class
40             as arguments to method CreateUserPool.
41              
42             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateUserPool.
43              
44             As an example:
45              
46             $service_obj->CreateUserPool(Att1 => $value1, Att2 => $value2, ...);
47              
48             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.
49              
50             =head1 ATTRIBUTES
51              
52              
53             =head2 AdminCreateUserConfig => L<Paws::CognitoIdp::AdminCreateUserConfigType>
54              
55             The configuration for C<AdminCreateUser> requests.
56              
57              
58              
59             =head2 AliasAttributes => ArrayRef[Str|Undef]
60              
61             Attributes supported as an alias for this user pool. Possible values:
62             B<phone_number>, B<email>, or B<preferred_username>.
63              
64              
65              
66             =head2 AutoVerifiedAttributes => ArrayRef[Str|Undef]
67              
68             The attributes to be auto-verified. Possible values: B<email>,
69             B<phone_number>.
70              
71              
72              
73             =head2 DeviceConfiguration => L<Paws::CognitoIdp::DeviceConfigurationType>
74              
75             The device configuration.
76              
77              
78              
79             =head2 EmailConfiguration => L<Paws::CognitoIdp::EmailConfigurationType>
80              
81             The email configuration.
82              
83              
84              
85             =head2 EmailVerificationMessage => Str
86              
87             A string representing the email verification message.
88              
89              
90              
91             =head2 EmailVerificationSubject => Str
92              
93             A string representing the email verification subject.
94              
95              
96              
97             =head2 LambdaConfig => L<Paws::CognitoIdp::LambdaConfigType>
98              
99             The Lambda trigger configuration information for the new user pool.
100              
101              
102              
103             =head2 MfaConfiguration => Str
104              
105             Specifies MFA configuration details.
106              
107             Valid values are: C<"OFF">, C<"ON">, C<"OPTIONAL">
108              
109             =head2 Policies => L<Paws::CognitoIdp::UserPoolPolicyType>
110              
111             The policies associated with the new user pool.
112              
113              
114              
115             =head2 B<REQUIRED> PoolName => Str
116              
117             A string used to name the user pool.
118              
119              
120              
121             =head2 Schema => ArrayRef[L<Paws::CognitoIdp::SchemaAttributeType>]
122              
123             An array of schema attributes for the new user pool. These attributes
124             can be standard or custom attributes.
125              
126              
127              
128             =head2 SmsAuthenticationMessage => Str
129              
130             A string representing the SMS authentication message.
131              
132              
133              
134             =head2 SmsConfiguration => L<Paws::CognitoIdp::SmsConfigurationType>
135              
136             The SMS configuration.
137              
138              
139              
140             =head2 SmsVerificationMessage => Str
141              
142             A string representing the SMS verification message.
143              
144              
145              
146             =head2 UsernameAttributes => ArrayRef[Str|Undef]
147              
148             Specifies whether email addresses or phone numbers can be specified as
149             usernames when a user signs up.
150              
151              
152              
153             =head2 UserPoolTags => L<Paws::CognitoIdp::UserPoolTagsType>
154              
155             The cost allocation tags for the user pool. For more information, see
156             Adding Cost Allocation Tags to Your User Pool
157              
158              
159              
160             =head2 VerificationMessageTemplate => L<Paws::CognitoIdp::VerificationMessageTemplateType>
161              
162             The template for the verification message that the user sees when the
163             app requests permission to access the user's information.
164              
165              
166              
167              
168             =head1 SEE ALSO
169              
170             This class forms part of L<Paws>, documenting arguments for method CreateUserPool in L<Paws::CognitoIdp>
171              
172             =head1 BUGS and CONTRIBUTIONS
173              
174             The source code is located here: https://github.com/pplu/aws-sdk-perl
175              
176             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
177              
178             =cut
179