File Coverage

blib/lib/Paws/CognitoIdp/AdminCreateUserConfigType.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::CognitoIdp::AdminCreateUserConfigType;
2 1     1   452 use Moose;
  1         3  
  1         8  
3             has AllowAdminCreateUserOnly => (is => 'ro', isa => 'Bool');
4             has InviteMessageTemplate => (is => 'ro', isa => 'Paws::CognitoIdp::MessageTemplateType');
5             has UnusedAccountValidityDays => (is => 'ro', isa => 'Int');
6             1;
7              
8             ### main pod documentation begin ###
9              
10             =head1 NAME
11              
12             Paws::CognitoIdp::AdminCreateUserConfigType
13              
14             =head1 USAGE
15              
16             This class represents one of two things:
17              
18             =head3 Arguments in a call to a service
19              
20             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
21             Each attribute should be used as a named argument in the calls that expect this type of object.
22              
23             As an example, if Att1 is expected to be a Paws::CognitoIdp::AdminCreateUserConfigType object:
24              
25             $service_obj->Method(Att1 => { AllowAdminCreateUserOnly => $value, ..., UnusedAccountValidityDays => $value });
26              
27             =head3 Results returned from an API call
28              
29             Use accessors for each attribute. If Att1 is expected to be an Paws::CognitoIdp::AdminCreateUserConfigType object:
30              
31             $result = $service_obj->Method(...);
32             $result->Att1->AllowAdminCreateUserOnly
33              
34             =head1 DESCRIPTION
35              
36             The type of configuration for creating a new user profile.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 AllowAdminCreateUserOnly => Bool
42              
43             Set to C<True> if only the administrator is allowed to create user
44             profiles. Set to C<False> if users can sign themselves up via an app.
45              
46              
47             =head2 InviteMessageTemplate => L<Paws::CognitoIdp::MessageTemplateType>
48              
49             The message template to be used for the welcome message to new users.
50              
51              
52             =head2 UnusedAccountValidityDays => Int
53              
54             The user account expiration limit, in days, after which the account is
55             no longer usable. To reset the account after that time limit, you must
56             call C<AdminCreateUser> again, specifying C<"RESEND"> for the
57             C<MessageAction> parameter. The default value for this parameter is 7.
58              
59              
60              
61             =head1 SEE ALSO
62              
63             This class forms part of L<Paws>, describing an object used in L<Paws::CognitoIdp>
64              
65             =head1 BUGS and CONTRIBUTIONS
66              
67             The source code is located here: https://github.com/pplu/aws-sdk-perl
68              
69             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
70              
71             =cut
72