File Coverage

blib/lib/Paws/CognitoIdp/CreateGroup.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::CreateGroup;
3	1	1	393	use Moose;
	1		3
	1		5
4				has Description => (is => 'ro', isa => 'Str');
5				has GroupName => (is => 'ro', isa => 'Str', required => 1);
6				has Precedence => (is => 'ro', isa => 'Int');
7				has RoleArn => (is => 'ro', isa => 'Str');
8				has UserPoolId => (is => 'ro', isa => 'Str', required => 1);
9
10	1	1	5777	use MooseX::ClassAttribute;
	1		2
	1		7
11
12				class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateGroup');
13				class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CognitoIdp::CreateGroupResponse');
14				class_has _result_key => (isa => 'Str', is => 'ro');
15				1;
16
17				### main pod documentation begin ###
18
19				=head1 NAME
20
21				Paws::CognitoIdp::CreateGroup - Arguments for method CreateGroup on Paws::CognitoIdp
22
23				=head1 DESCRIPTION
24
25				This class represents the parameters used for calling the method CreateGroup on the
26				Amazon Cognito Identity Provider service. Use the attributes of this class
27				as arguments to method CreateGroup.
28
29				You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateGroup.
30
31				As an example:
32
33				$service_obj->CreateGroup(Att1 => $value1, Att2 => $value2, ...);
34
35				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.
36
37				=head1 ATTRIBUTES
38
39
40				=head2 Description => Str
41
42				A string containing the description of the group.
43
44
45
46				=head2 B<REQUIRED> GroupName => Str
47
48				The name of the group. Must be unique.
49
50
51
52				=head2 Precedence => Int
53
54				A nonnegative integer value that specifies the precedence of this group
55				relative to the other groups that a user can belong to in the user
56				pool. Zero is the highest precedence value. Groups with lower
57				C<Precedence> values take precedence over groups with higher or null
58				C<Precedence> values. If a user belongs to two or more groups, it is
59				the group with the lowest precedence value whose role ARN will be used
60				in the C<cognito:roles> and C<cognito:preferred_role> claims in the
61				user's tokens.
62
63				Two groups can have the same C<Precedence> value. If this happens,
64				neither group takes precedence over the other. If two groups with the
65				same C<Precedence> have the same role ARN, that role is used in the
66				C<cognito:preferred_role> claim in tokens for users in each group. If
67				the two groups have different role ARNs, the C<cognito:preferred_role>
68				claim is not set in users' tokens.
69
70				The default C<Precedence> value is null.
71
72
73
74				=head2 RoleArn => Str
75
76				The role ARN for the group.
77
78
79
80				=head2 B<REQUIRED> UserPoolId => Str
81
82				The user pool ID for the user pool.
83
84
85
86
87				=head1 SEE ALSO
88
89				This class forms part of L<Paws>, documenting arguments for method CreateGroup in L<Paws::CognitoIdp>
90
91				=head1 BUGS and CONTRIBUTIONS
92
93				The source code is located here: https://github.com/pplu/aws-sdk-perl
94
95				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
96
97				=cut
98