NAME

Paws::EKS::OidcIdentityProviderConfigRequest

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::EKS::OidcIdentityProviderConfigRequest object:

  $service_obj->Method(Att1 => { ClientId => $value, ..., UsernamePrefix => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::EKS::OidcIdentityProviderConfigRequest object:

  $result = $service_obj->Method(...);
  $result->Att1->ClientId

DESCRIPTION

An object representing an OpenID Connect (OIDC) configuration. Before associating an OIDC identity provider to your cluster, review the considerations in Authenticating users for your cluster from an OpenID Connect identity provider (https://docs.aws.amazon.com/eks/latest/userguide/authenticate-oidc-identity-provider.html) in the Amazon EKS User Guide.

ATTRIBUTES

REQUIRED ClientId => Str

This is also known as audience. The ID for the client application that makes authentication requests to the OpenID identity provider.

GroupsClaim => Str

The JWT claim that the provider uses to return your groups.

GroupsPrefix => Str

The prefix that is prepended to group claims to prevent clashes with existing names (such as "system:" groups). For example, the value" oidc:" will create group names like "oidc:engineering" and "oidc:infra".

REQUIRED IdentityProviderConfigName => Str

The name of the OIDC provider configuration.

REQUIRED IssuerUrl => Str

The URL of the OpenID identity provider that allows the API server to discover public signing keys for verifying tokens. The URL must begin with "https://" and should correspond to the "iss" claim in the provider's OIDC ID tokens. Per the OIDC standard, path components are allowed but query parameters are not. Typically the URL consists of only a hostname, like "https://server.example.org" or "https://example.com". This URL should point to the level below ".well-known/openid-configuration" and must be publicly accessible over the internet.

RequiredClaims => Paws::EKS::RequiredClaimsMap

The key value pairs that describe required claims in the identity token. If set, each claim is verified to be present in the token with a matching value. For the maximum number of claims that you can require, see Amazon EKS service quotas (https://docs.aws.amazon.com/eks/latest/userguide/service-quotas.html) in the Amazon EKS User Guide.

UsernameClaim => Str

The JSON Web Token (JWT) claim to use as the username. The default is "sub", which is expected to be a unique identifier of the end user. You can choose other claims, such as "email" or "name", depending on the OpenID identity provider. Claims other than "email" are prefixed with the issuer URL to prevent naming clashes with other plug-ins.

UsernamePrefix => Str

The prefix that is prepended to username claims to prevent clashes with existing names. If you do not provide this field, and "username" is a value other than "email", the prefix defaults to "issuerurl#". You can use the value "-" to disable all prefixing.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>