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