blib/lib/Paws/EKS/OidcIdentityProviderConfigRequest.pm untested

filter: Statementstmt 0.0% 0 / 19 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 20 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::EKS::OidcIdentityProviderConfigRequest;
3 use Moose;
4 has ClientId => (is => 'ro', isa => 'Str', request_name => 'clientId', traits => ['NameInRequest'], required => 1);
5 has GroupsClaim => (is => 'ro', isa => 'Str', request_name => 'groupsClaim', traits => ['NameInRequest']);
6 has GroupsPrefix => (is => 'ro', isa => 'Str', request_name => 'groupsPrefix', traits => ['NameInRequest']);
7 has IdentityProviderConfigName => (is => 'ro', isa => 'Str', request_name => 'identityProviderConfigName', traits => ['NameInRequest'], required => 1);
8 has IssuerUrl => (is => 'ro', isa => 'Str', request_name => 'issuerUrl', traits => ['NameInRequest'], required => 1);
9 has RequiredClaims => (is => 'ro', isa => 'Paws::EKS::RequiredClaimsMap', request_name => 'requiredClaims', traits => ['NameInRequest']);
10 has UsernameClaim => (is => 'ro', isa => 'Str', request_name => 'usernameClaim', traits => ['NameInRequest']);
11 has UsernamePrefix => (is => 'ro', isa => 'Str', request_name => 'usernamePrefix', traits => ['NameInRequest']);
12  
13 1;
14  
15 ### main pod documentation begin ###
16  
17 =head1 NAME
18  
19 Paws::EKS::OidcIdentityProviderConfigRequest
20  
21 =head1 USAGE
22  
23 This class represents one of two things:
24  
25 =head3 Arguments in a call to a service
26  
27 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
28 Each attribute should be used as a named argument in the calls that expect this type of object.
29  
30 As an example, if Att1 is expected to be a Paws::EKS::OidcIdentityProviderConfigRequest object:
31  
32 $service_obj->Method(Att1 => { ClientId => $value, ..., UsernamePrefix => $value });
33  
34 =head3 Results returned from an API call
35  
36 Use accessors for each attribute. If Att1 is expected to be an Paws::EKS::OidcIdentityProviderConfigRequest object:
37  
38 $result = $service_obj->Method(...);
39 $result->Att1->ClientId
40  
41 =head1 DESCRIPTION
42  
43 An object representing an OpenID Connect (OIDC) configuration. Before
44 associating an OIDC identity provider to your cluster, review the
45 considerations in Authenticating users for your cluster from an OpenID
46 Connect identity provider
47 (https://docs.aws.amazon.com/eks/latest/userguide/authenticate-oidc-identity-provider.html)
48 in the I<Amazon EKS User Guide>.
49  
50 =head1 ATTRIBUTES
51  
52  
53 =head2 B<REQUIRED> ClientId => Str
54  
55 This is also known as I<audience>. The ID for the client application
56 that makes authentication requests to the OpenID identity provider.
57  
58  
59 =head2 GroupsClaim => Str
60  
61 The JWT claim that the provider uses to return your groups.
62  
63  
64 =head2 GroupsPrefix => Str
65  
66 The prefix that is prepended to group claims to prevent clashes with
67 existing names (such as C<system:> groups). For example, the valueC<
68 oidc:> will create group names like C<oidc:engineering> and
69 C<oidc:infra>.
70  
71  
72 =head2 B<REQUIRED> IdentityProviderConfigName => Str
73  
74 The name of the OIDC provider configuration.
75  
76  
77 =head2 B<REQUIRED> IssuerUrl => Str
78  
79 The URL of the OpenID identity provider that allows the API server to
80 discover public signing keys for verifying tokens. The URL must begin
81 with C<https://> and should correspond to the C<iss> claim in the
82 provider's OIDC ID tokens. Per the OIDC standard, path components are
83 allowed but query parameters are not. Typically the URL consists of
84 only a hostname, like C<https://server.example.org> or
85 C<https://example.com>. This URL should point to the level below
86 C<.well-known/openid-configuration> and must be publicly accessible
87 over the internet.
88  
89  
90 =head2 RequiredClaims => L<Paws::EKS::RequiredClaimsMap>
91  
92 The key value pairs that describe required claims in the identity
93 token. If set, each claim is verified to be present in the token with a
94 matching value. For the maximum number of claims that you can require,
95 see Amazon EKS service quotas
96 (https://docs.aws.amazon.com/eks/latest/userguide/service-quotas.html)
97 in the I<Amazon EKS User Guide>.
98  
99  
100 =head2 UsernameClaim => Str
101  
102 The JSON Web Token (JWT) claim to use as the username. The default is
103 C<sub>, which is expected to be a unique identifier of the end user.
104 You can choose other claims, such as C<email> or C<name>, depending on
105 the OpenID identity provider. Claims other than C<email> are prefixed
106 with the issuer URL to prevent naming clashes with other plug-ins.
107  
108  
109 =head2 UsernamePrefix => Str
110  
111 The prefix that is prepended to username claims to prevent clashes with
112 existing names. If you do not provide this field, and C<username> is a
113 value other than C<email>, the prefix defaults to C<issuerurl#>. You
114 can use the value C<-> to disable all prefixing.
115  
116  
117  
118 =head1 SEE ALSO
119  
120 This class forms part of L<Paws>, describing an object used in L<Paws::EKS>
121  
122 =head1 BUGS and CONTRIBUTIONS
123  
124 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
125  
126 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
127  
128 =cut
129