File Coverage

blib/lib/Paws/CognitoIdp/GroupType.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::GroupType;
2 1     1   328 use Moose;
  1         2  
  1         6  
3             has CreationDate => (is => 'ro', isa => 'Str');
4             has Description => (is => 'ro', isa => 'Str');
5             has GroupName => (is => 'ro', isa => 'Str');
6             has LastModifiedDate => (is => 'ro', isa => 'Str');
7             has Precedence => (is => 'ro', isa => 'Int');
8             has RoleArn => (is => 'ro', isa => 'Str');
9             has UserPoolId => (is => 'ro', isa => 'Str');
10             1;
11              
12             ### main pod documentation begin ###
13              
14             =head1 NAME
15              
16             Paws::CognitoIdp::GroupType
17              
18             =head1 USAGE
19              
20             This class represents one of two things:
21              
22             =head3 Arguments in a call to a service
23              
24             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
25             Each attribute should be used as a named argument in the calls that expect this type of object.
26              
27             As an example, if Att1 is expected to be a Paws::CognitoIdp::GroupType object:
28              
29             $service_obj->Method(Att1 => { CreationDate => $value, ..., UserPoolId => $value });
30              
31             =head3 Results returned from an API call
32              
33             Use accessors for each attribute. If Att1 is expected to be an Paws::CognitoIdp::GroupType object:
34              
35             $result = $service_obj->Method(...);
36             $result->Att1->CreationDate
37              
38             =head1 DESCRIPTION
39              
40             The group type.
41              
42             =head1 ATTRIBUTES
43              
44              
45             =head2 CreationDate => Str
46              
47             The date the group was created.
48              
49              
50             =head2 Description => Str
51              
52             A string containing the description of the group.
53              
54              
55             =head2 GroupName => Str
56              
57             The name of the group.
58              
59              
60             =head2 LastModifiedDate => Str
61              
62             The date the group was last modified.
63              
64              
65             =head2 Precedence => Int
66              
67             A nonnegative integer value that specifies the precedence of this group
68             relative to the other groups that a user can belong to in the user
69             pool. If a user belongs to two or more groups, it is the group with the
70             highest precedence whose role ARN will be used in the C<cognito:roles>
71             and C<cognito:preferred_role> claims in the user's tokens. Groups with
72             higher C<Precedence> values take precedence over groups with lower
73             C<Precedence> values or with null C<Precedence> values.
74              
75             Two groups can have the same C<Precedence> value. If this happens,
76             neither group takes precedence over the other. If two groups with the
77             same C<Precedence> have the same role ARN, that role is used in the
78             C<cognito:preferred_role> claim in tokens for users in each group. If
79             the two groups have different role ARNs, the C<cognito:preferred_role>
80             claim is not set in users' tokens.
81              
82             The default C<Precedence> value is null.
83              
84              
85             =head2 RoleArn => Str
86              
87             The role ARN for the group.
88              
89              
90             =head2 UserPoolId => Str
91              
92             The user pool ID for the user pool.
93              
94              
95              
96             =head1 SEE ALSO
97              
98             This class forms part of L<Paws>, describing an object used in L<Paws::CognitoIdp>
99              
100             =head1 BUGS and CONTRIBUTIONS
101              
102             The source code is located here: https://github.com/pplu/aws-sdk-perl
103              
104             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
105              
106             =cut
107