File Coverage

blib/lib/Paws/CognitoIdentity/RoleMapping.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::CognitoIdentity::RoleMapping;
2 1     1   491 use Moose;
  1         4  
  1         8  
3             has AmbiguousRoleResolution => (is => 'ro', isa => 'Str');
4             has RulesConfiguration => (is => 'ro', isa => 'Paws::CognitoIdentity::RulesConfigurationType');
5             has Type => (is => 'ro', isa => 'Str', required => 1);
6             1;
7              
8             ### main pod documentation begin ###
9              
10             =head1 NAME
11              
12             Paws::CognitoIdentity::RoleMapping
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::CognitoIdentity::RoleMapping object:
24              
25             $service_obj->Method(Att1 => { AmbiguousRoleResolution => $value, ..., Type => $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::CognitoIdentity::RoleMapping object:
30              
31             $result = $service_obj->Method(...);
32             $result->Att1->AmbiguousRoleResolution
33              
34             =head1 DESCRIPTION
35              
36             A role mapping.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 AmbiguousRoleResolution => Str
42              
43             If you specify Token or Rules as the C<Type>,
44             C<AmbiguousRoleResolution> is required.
45              
46             Specifies the action to be taken if either no rules match the claim
47             value for the C<Rules> type, or there is no C<cognito:preferred_role>
48             claim and there are multiple C<cognito:roles> matches for the C<Token>
49             type.
50              
51              
52             =head2 RulesConfiguration => L<Paws::CognitoIdentity::RulesConfigurationType>
53              
54             The rules to be used for mapping users to roles.
55              
56             If you specify Rules as the role mapping type, C<RulesConfiguration> is
57             required.
58              
59              
60             =head2 B<REQUIRED> Type => Str
61              
62             The role mapping type. Token will use C<cognito:roles> and
63             C<cognito:preferred_role> claims from the Cognito identity provider
64             token to map groups to roles. Rules will attempt to match claims from
65             the token to map to a role.
66              
67              
68              
69             =head1 SEE ALSO
70              
71             This class forms part of L<Paws>, describing an object used in L<Paws::CognitoIdentity>
72              
73             =head1 BUGS and CONTRIBUTIONS
74              
75             The source code is located here: https://github.com/pplu/aws-sdk-perl
76              
77             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
78              
79             =cut
80