| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::EKS::OidcIdentityProviderConfig; | ||
| 3 | use Moose; | ||
| 4 | has ClientId => (is => 'ro', isa => 'Str', request_name => 'clientId', traits => ['NameInRequest']); | ||
| 5 | has ClusterName => (is => 'ro', isa => 'Str', request_name => 'clusterName', traits => ['NameInRequest']); | ||
| 6 | has GroupsClaim => (is => 'ro', isa => 'Str', request_name => 'groupsClaim', traits => ['NameInRequest']); | ||
| 7 | has GroupsPrefix => (is => 'ro', isa => 'Str', request_name => 'groupsPrefix', traits => ['NameInRequest']); | ||
| 8 | has IdentityProviderConfigArn => (is => 'ro', isa => 'Str', request_name => 'identityProviderConfigArn', traits => ['NameInRequest']); | ||
| 9 | has IdentityProviderConfigName => (is => 'ro', isa => 'Str', request_name => 'identityProviderConfigName', traits => ['NameInRequest']); | ||
| 10 | has IssuerUrl => (is => 'ro', isa => 'Str', request_name => 'issuerUrl', traits => ['NameInRequest']); | ||
| 11 | has RequiredClaims => (is => 'ro', isa => 'Paws::EKS::RequiredClaimsMap', request_name => 'requiredClaims', traits => ['NameInRequest']); | ||
| 12 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']); | ||
| 13 | has Tags => (is => 'ro', isa => 'Paws::EKS::TagMap', request_name => 'tags', traits => ['NameInRequest']); | ||
| 14 | has UsernameClaim => (is => 'ro', isa => 'Str', request_name => 'usernameClaim', traits => ['NameInRequest']); | ||
| 15 | has UsernamePrefix => (is => 'ro', isa => 'Str', request_name => 'usernamePrefix', traits => ['NameInRequest']); | ||
| 16 | |||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::EKS::OidcIdentityProviderConfig | ||
| 24 | |||
| 25 | =head1 USAGE | ||
| 26 | |||
| 27 | This class represents one of two things: | ||
| 28 | |||
| 29 | =head3 Arguments in a call to a service | ||
| 30 | |||
| 31 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 32 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 33 | |||
| 34 | As an example, if Att1 is expected to be a Paws::EKS::OidcIdentityProviderConfig object: | ||
| 35 | |||
| 36 | $service_obj->Method(Att1 => { ClientId => $value, ..., UsernamePrefix => $value }); | ||
| 37 | |||
| 38 | =head3 Results returned from an API call | ||
| 39 | |||
| 40 | Use accessors for each attribute. If Att1 is expected to be an Paws::EKS::OidcIdentityProviderConfig object: | ||
| 41 | |||
| 42 | $result = $service_obj->Method(...); | ||
| 43 | $result->Att1->ClientId | ||
| 44 | |||
| 45 | =head1 DESCRIPTION | ||
| 46 | |||
| 47 | An object that represents the configuration for an OpenID Connect | ||
| 48 | (OIDC) identity provider. | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 ClientId => Str | ||
| 54 | |||
| 55 | This is also known as I<audience>. The ID of the client application | ||
| 56 | that makes authentication requests to the OIDC identity provider. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 ClusterName => Str | ||
| 60 | |||
| 61 | The cluster that the configuration is associated to. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 GroupsClaim => Str | ||
| 65 | |||
| 66 | The JSON web token (JWT) claim that the provider uses to return your | ||
| 67 | groups. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 GroupsPrefix => Str | ||
| 71 | |||
| 72 | The prefix that is prepended to group claims to prevent clashes with | ||
| 73 | existing names (such as C<system:> groups). For example, the valueC< | ||
| 74 | oidc:> creates group names like C<oidc:engineering> and C<oidc:infra>. | ||
| 75 | The prefix can't contain C<system:> | ||
| 76 | |||
| 77 | |||
| 78 | =head2 IdentityProviderConfigArn => Str | ||
| 79 | |||
| 80 | The ARN of the configuration. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 IdentityProviderConfigName => Str | ||
| 84 | |||
| 85 | The name of the configuration. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 IssuerUrl => Str | ||
| 89 | |||
| 90 | The URL of the OIDC identity provider that allows the API server to | ||
| 91 | discover public signing keys for verifying tokens. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 RequiredClaims => L<Paws::EKS::RequiredClaimsMap> | ||
| 95 | |||
| 96 | The key-value pairs that describe required claims in the identity | ||
| 97 | token. If set, each claim is verified to be present in the token with a | ||
| 98 | matching value. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 Status => Str | ||
| 102 | |||
| 103 | The status of the OIDC identity provider. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 Tags => L<Paws::EKS::TagMap> | ||
| 107 | |||
| 108 | The metadata to apply to the provider configuration to assist with | ||
| 109 | categorization and organization. Each tag consists of a key and an | ||
| 110 | optional value, both of which you defined. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 UsernameClaim => Str | ||
| 114 | |||
| 115 | The JSON Web token (JWT) claim that is used as the username. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 UsernamePrefix => Str | ||
| 119 | |||
| 120 | The prefix that is prepended to username claims to prevent clashes with | ||
| 121 | existing names. The prefix can't contain C<system:> | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head1 SEE ALSO | ||
| 126 | |||
| 127 | This class forms part of L<Paws>, describing an object used in L<Paws::EKS> | ||
| 128 | |||
| 129 | =head1 BUGS and CONTRIBUTIONS | ||
| 130 | |||
| 131 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 132 | |||
| 133 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 134 | |||
| 135 | =cut | ||
| 136 |