Class: Aws::EKS::Types::OidcIdentityProviderConfigRequest

Inherits:

Struct

• Object
• Struct
• Aws::EKS::Types::OidcIdentityProviderConfigRequest

Includes:

Structure

Defined in:

lib/aws-sdk-eks/types.rb

Overview

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 OIDC identity provider] in the *Amazon EKS User Guide*.

[1]: docs.aws.amazon.com/eks/latest/userguide/authenticate-oidc-identity-provider.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_id ⇒ String

  This is also known as audience.

• #groups_claim ⇒ String

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

• #groups_prefix ⇒ String

  The prefix that is prepended to group claims to prevent clashes with existing names (such as ‘system:` groups).

• #identity_provider_config_name ⇒ String

  The name of the OIDC provider configuration.

• #issuer_url ⇒ String

  The URL of the OIDC identity provider that allows the API server to discover public signing keys for verifying tokens.

• #required_claims ⇒ Hash<String,String>

  The key value pairs that describe required claims in the identity token.

• #username_claim ⇒ String

  The JSON Web Token (JWT) claim to use as the username.

• #username_prefix ⇒ String

  The prefix that is prepended to username claims to prevent clashes with existing names.

Instance Attribute Details

#client_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-eks/types.rb', line 5058

class OidcIdentityProviderConfigRequest < Struct.new(
  :identity_provider_config_name,
  :issuer_url,
  :client_id,
  :username_claim,
  :username_prefix,
  :groups_claim,
  :groups_prefix,
  :required_claims)
  SENSITIVE = []
  include Aws::Structure
end

#groups_claim ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-eks/types.rb', line 5058

class OidcIdentityProviderConfigRequest < Struct.new(
  :identity_provider_config_name,
  :issuer_url,
  :client_id,
  :username_claim,
  :username_prefix,
  :groups_claim,
  :groups_prefix,
  :required_claims)
  SENSITIVE = []
  include Aws::Structure
end

#groups_prefix ⇒ String

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`.

Returns:

• (String)

# File 'lib/aws-sdk-eks/types.rb', line 5058

class OidcIdentityProviderConfigRequest < Struct.new(
  :identity_provider_config_name,
  :issuer_url,
  :client_id,
  :username_claim,
  :username_prefix,
  :groups_claim,
  :groups_prefix,
  :required_claims)
  SENSITIVE = []
  include Aws::Structure
end

#identity_provider_config_name ⇒ String

The name of the OIDC provider configuration.

Returns:

• (String)

# File 'lib/aws-sdk-eks/types.rb', line 5058

class OidcIdentityProviderConfigRequest < Struct.new(
  :identity_provider_config_name,
  :issuer_url,
  :client_id,
  :username_claim,
  :username_prefix,
  :groups_claim,
  :groups_prefix,
  :required_claims)
  SENSITIVE = []
  include Aws::Structure
end

#issuer_url ⇒ String

The URL of the OIDC 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. Based on the OIDC standard, path components are allowed but query parameters are not. Typically the URL consists of only a hostname, like ‘server.example.org` or `example.com`. This URL should point to the level below `.well-known/openid-configuration` and must be publicly accessible over the internet.

Returns:

• (String)

# File 'lib/aws-sdk-eks/types.rb', line 5058

class OidcIdentityProviderConfigRequest < Struct.new(
  :identity_provider_config_name,
  :issuer_url,
  :client_id,
  :username_claim,
  :username_prefix,
  :groups_claim,
  :groups_prefix,
  :required_claims)
  SENSITIVE = []
  include Aws::Structure
end

#required_claims ⇒ Hash<String,String>

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] in the *Amazon EKS User Guide*.

[1]: docs.aws.amazon.com/eks/latest/userguide/service-quotas.html

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-eks/types.rb', line 5058

class OidcIdentityProviderConfigRequest < Struct.new(
  :identity_provider_config_name,
  :issuer_url,
  :client_id,
  :username_claim,
  :username_prefix,
  :groups_claim,
  :groups_prefix,
  :required_claims)
  SENSITIVE = []
  include Aws::Structure
end

#username_claim ⇒ String

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 OIDC identity provider. Claims other than `email` are prefixed with the issuer URL to prevent naming clashes with other plug-ins.

Returns:

• (String)

# File 'lib/aws-sdk-eks/types.rb', line 5058

class OidcIdentityProviderConfigRequest < Struct.new(
  :identity_provider_config_name,
  :issuer_url,
  :client_id,
  :username_claim,
  :username_prefix,
  :groups_claim,
  :groups_prefix,
  :required_claims)
  SENSITIVE = []
  include Aws::Structure
end

#username_prefix ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-eks/types.rb', line 5058

class OidcIdentityProviderConfigRequest < Struct.new(
  :identity_provider_config_name,
  :issuer_url,
  :client_id,
  :username_claim,
  :username_prefix,
  :groups_claim,
  :groups_prefix,
  :required_claims)
  SENSITIVE = []
  include Aws::Structure
end