blib/lib/Paws/CognitoIdp/UserPoolType.pm untested

filter: Statementstmt 0.0% 0 / 34 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 35 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::CognitoIdp::UserPoolType;
3 use Moose;
4 has AccountRecoverySetting => (is => 'ro', isa => 'Paws::CognitoIdp::AccountRecoverySettingType');
5 has AdminCreateUserConfig => (is => 'ro', isa => 'Paws::CognitoIdp::AdminCreateUserConfigType');
6 has AliasAttributes => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
7 has Arn => (is => 'ro', isa => 'Str');
8 has AutoVerifiedAttributes => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
9 has CreationDate => (is => 'ro', isa => 'Str');
10 has CustomDomain => (is => 'ro', isa => 'Str');
11 has DeviceConfiguration => (is => 'ro', isa => 'Paws::CognitoIdp::DeviceConfigurationType');
12 has Domain => (is => 'ro', isa => 'Str');
13 has EmailConfiguration => (is => 'ro', isa => 'Paws::CognitoIdp::EmailConfigurationType');
14 has EmailConfigurationFailure => (is => 'ro', isa => 'Str');
15 has EmailVerificationMessage => (is => 'ro', isa => 'Str');
16 has EmailVerificationSubject => (is => 'ro', isa => 'Str');
17 has EstimatedNumberOfUsers => (is => 'ro', isa => 'Int');
18 has Id => (is => 'ro', isa => 'Str');
19 has LambdaConfig => (is => 'ro', isa => 'Paws::CognitoIdp::LambdaConfigType');
20 has LastModifiedDate => (is => 'ro', isa => 'Str');
21 has MfaConfiguration => (is => 'ro', isa => 'Str');
22 has Name => (is => 'ro', isa => 'Str');
23 has Policies => (is => 'ro', isa => 'Paws::CognitoIdp::UserPoolPolicyType');
24 has SchemaAttributes => (is => 'ro', isa => 'ArrayRef[Paws::CognitoIdp::SchemaAttributeType]');
25 has SmsAuthenticationMessage => (is => 'ro', isa => 'Str');
26 has SmsConfiguration => (is => 'ro', isa => 'Paws::CognitoIdp::SmsConfigurationType');
27 has SmsConfigurationFailure => (is => 'ro', isa => 'Str');
28 has SmsVerificationMessage => (is => 'ro', isa => 'Str');
29 has Status => (is => 'ro', isa => 'Str');
30 has UsernameAttributes => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
31 has UsernameConfiguration => (is => 'ro', isa => 'Paws::CognitoIdp::UsernameConfigurationType');
32 has UserPoolAddOns => (is => 'ro', isa => 'Paws::CognitoIdp::UserPoolAddOnsType');
33 has UserPoolTags => (is => 'ro', isa => 'Paws::CognitoIdp::UserPoolTagsType');
34 has VerificationMessageTemplate => (is => 'ro', isa => 'Paws::CognitoIdp::VerificationMessageTemplateType');
35  
36 1;
37  
38 ### main pod documentation begin ###
39  
40 =head1 NAME
41  
42 Paws::CognitoIdp::UserPoolType
43  
44 =head1 USAGE
45  
46 This class represents one of two things:
47  
48 =head3 Arguments in a call to a service
49  
50 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
51 Each attribute should be used as a named argument in the calls that expect this type of object.
52  
53 As an example, if Att1 is expected to be a Paws::CognitoIdp::UserPoolType object:
54  
55 $service_obj->Method(Att1 => { AccountRecoverySetting => $value, ..., VerificationMessageTemplate => $value });
56  
57 =head3 Results returned from an API call
58  
59 Use accessors for each attribute. If Att1 is expected to be an Paws::CognitoIdp::UserPoolType object:
60  
61 $result = $service_obj->Method(...);
62 $result->Att1->AccountRecoverySetting
63  
64 =head1 DESCRIPTION
65  
66 A container for information about the user pool.
67  
68 =head1 ATTRIBUTES
69  
70  
71 =head2 AccountRecoverySetting => L<Paws::CognitoIdp::AccountRecoverySettingType>
72  
73 Use this setting to define which verified available method a user can
74 use to recover their password when they call C<ForgotPassword>. It
75 allows you to define a preferred method when a user has more than one
76 method available. With this setting, SMS does not qualify for a valid
77 password recovery mechanism if the user also has SMS MFA enabled. In
78 the absence of this setting, Cognito uses the legacy behavior to
79 determine the recovery method where SMS is preferred over email.
80  
81  
82 =head2 AdminCreateUserConfig => L<Paws::CognitoIdp::AdminCreateUserConfigType>
83  
84 The configuration for C<AdminCreateUser> requests.
85  
86  
87 =head2 AliasAttributes => ArrayRef[Str|Undef]
88  
89 Specifies the attributes that are aliased in a user pool.
90  
91  
92 =head2 Arn => Str
93  
94 The Amazon Resource Name (ARN) for the user pool.
95  
96  
97 =head2 AutoVerifiedAttributes => ArrayRef[Str|Undef]
98  
99 Specifies the attributes that are auto-verified in a user pool.
100  
101  
102 =head2 CreationDate => Str
103  
104 The date the user pool was created.
105  
106  
107 =head2 CustomDomain => Str
108  
109 A custom domain name that you provide to Amazon Cognito. This parameter
110 applies only if you use a custom domain to host the sign-up and sign-in
111 pages for your application. For example: C<auth.example.com>.
112  
113 For more information about adding a custom domain to your user pool,
114 see Using Your Own Domain for the Hosted UI
115 (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html).
116  
117  
118 =head2 DeviceConfiguration => L<Paws::CognitoIdp::DeviceConfigurationType>
119  
120 The device configuration.
121  
122  
123 =head2 Domain => Str
124  
125 Holds the domain prefix if the user pool has a domain associated with
126 it.
127  
128  
129 =head2 EmailConfiguration => L<Paws::CognitoIdp::EmailConfigurationType>
130  
131 The email configuration.
132  
133  
134 =head2 EmailConfigurationFailure => Str
135  
136 The reason why the email configuration cannot send the messages to your
137 users.
138  
139  
140 =head2 EmailVerificationMessage => Str
141  
142 The contents of the email verification message.
143  
144  
145 =head2 EmailVerificationSubject => Str
146  
147 The subject of the email verification message.
148  
149  
150 =head2 EstimatedNumberOfUsers => Int
151  
152 A number estimating the size of the user pool.
153  
154  
155 =head2 Id => Str
156  
157 The ID of the user pool.
158  
159  
160 =head2 LambdaConfig => L<Paws::CognitoIdp::LambdaConfigType>
161  
162 The AWS Lambda triggers associated with the user pool.
163  
164  
165 =head2 LastModifiedDate => Str
166  
167 The date the user pool was last modified.
168  
169  
170 =head2 MfaConfiguration => Str
171  
172 Can be one of the following values:
173  
174 =over
175  
176 =item *
177  
178 C<OFF> - MFA tokens are not required and cannot be specified during
179 user registration.
180  
181 =item *
182  
183 C<ON> - MFA tokens are required for all user registrations. You can
184 only specify required when you are initially creating a user pool.
185  
186 =item *
187  
188 C<OPTIONAL> - Users have the option when registering to create an MFA
189 token.
190  
191 =back
192  
193  
194  
195 =head2 Name => Str
196  
197 The name of the user pool.
198  
199  
200 =head2 Policies => L<Paws::CognitoIdp::UserPoolPolicyType>
201  
202 The policies associated with the user pool.
203  
204  
205 =head2 SchemaAttributes => ArrayRef[L<Paws::CognitoIdp::SchemaAttributeType>]
206  
207 A container with the schema attributes of a user pool.
208  
209  
210 =head2 SmsAuthenticationMessage => Str
211  
212 The contents of the SMS authentication message.
213  
214  
215 =head2 SmsConfiguration => L<Paws::CognitoIdp::SmsConfigurationType>
216  
217 The SMS configuration.
218  
219  
220 =head2 SmsConfigurationFailure => Str
221  
222 The reason why the SMS configuration cannot send the messages to your
223 users.
224  
225 This message might include comma-separated values to describe why your
226 SMS configuration can't send messages to user pool end users.
227  
228 =over
229  
230 =item *
231  
232 InvalidSmsRoleAccessPolicyException - The IAM role which Cognito uses
233 to send SMS messages is not properly configured. For more information,
234 see SmsConfigurationType
235 (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SmsConfigurationType.html).
236  
237 =item *
238  
239 SNSSandbox - The AWS account is in SNS Sandbox and messages
240 wonE<rsquo>t reach unverified end users. This parameter wonE<rsquo>t
241 get populated with SNSSandbox if the IAM user creating the user pool
242 doesnE<rsquo>t have SNS permissions. To learn how to move your AWS
243 account out of the sandbox, see Moving out of the SMS sandbox
244 (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox-moving-to-production.html).
245  
246 =back
247  
248  
249  
250 =head2 SmsVerificationMessage => Str
251  
252 The contents of the SMS verification message.
253  
254  
255 =head2 Status => Str
256  
257 The status of a user pool.
258  
259  
260 =head2 UsernameAttributes => ArrayRef[Str|Undef]
261  
262 Specifies whether email addresses or phone numbers can be specified as
263 usernames when a user signs up.
264  
265  
266 =head2 UsernameConfiguration => L<Paws::CognitoIdp::UsernameConfigurationType>
267  
268 You can choose to enable case sensitivity on the username input for the
269 selected sign-in option. For example, when this is set to C<False>,
270 users will be able to sign in using either "username" or "Username".
271 This configuration is immutable once it has been set. For more
272 information, see UsernameConfigurationType
273 (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html).
274  
275  
276 =head2 UserPoolAddOns => L<Paws::CognitoIdp::UserPoolAddOnsType>
277  
278 The user pool add-ons.
279  
280  
281 =head2 UserPoolTags => L<Paws::CognitoIdp::UserPoolTagsType>
282  
283 The tags that are assigned to the user pool. A tag is a label that you
284 can apply to user pools to categorize and manage them in different
285 ways, such as by purpose, owner, environment, or other criteria.
286  
287  
288 =head2 VerificationMessageTemplate => L<Paws::CognitoIdp::VerificationMessageTemplateType>
289  
290 The template for verification messages.
291  
292  
293  
294 =head1 SEE ALSO
295  
296 This class forms part of L<Paws>, describing an object used in L<Paws::CognitoIdp>
297  
298 =head1 BUGS and CONTRIBUTIONS
299  
300 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
301  
302 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
303  
304 =cut
305