Class: Aws::EKS::Types::OidcIdentityProviderConfig
- Inherits:
-
Struct
- Object
- Struct
- Aws::EKS::Types::OidcIdentityProviderConfig
- Defined in:
- gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb
Overview
An object representing the configuration for an OpenID Connect (OIDC) identity provider.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#client_id ⇒ String
This is also known as audience.
-
#cluster_name ⇒ String
The name of your cluster.
-
#groups_claim ⇒ String
The JSON web token (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_arn ⇒ String
The ARN of the configuration.
-
#identity_provider_config_name ⇒ String
The name of the 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.
-
#status ⇒ String
The status of the OIDC identity provider.
-
#tags ⇒ Hash<String,String>
Metadata that assists with categorization and organization.
-
#username_claim ⇒ String
The JSON Web token (JWT) claim that is used 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 of the client application that makes authentication requests to the OIDC identity provider.
4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 4805 class OidcIdentityProviderConfig < Struct.new( :identity_provider_config_name, :identity_provider_config_arn, :cluster_name, :issuer_url, :client_id, :username_claim, :username_prefix, :groups_claim, :groups_prefix, :required_claims, :tags, :status) SENSITIVE = [] include Aws::Structure end |
#cluster_name ⇒ String
The name of your cluster.
4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 4805 class OidcIdentityProviderConfig < Struct.new( :identity_provider_config_name, :identity_provider_config_arn, :cluster_name, :issuer_url, :client_id, :username_claim, :username_prefix, :groups_claim, :groups_prefix, :required_claims, :tags, :status) SENSITIVE = [] include Aws::Structure end |
#groups_claim ⇒ String
The JSON web token (JWT) claim that the provider uses to return your groups.
4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 4805 class OidcIdentityProviderConfig < Struct.new( :identity_provider_config_name, :identity_provider_config_arn, :cluster_name, :issuer_url, :client_id, :username_claim, :username_prefix, :groups_claim, :groups_prefix, :required_claims, :tags, :status) 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:
creates group names like oidc:engineering
and oidc:infra
.
The prefix can't contain system:
4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 4805 class OidcIdentityProviderConfig < Struct.new( :identity_provider_config_name, :identity_provider_config_arn, :cluster_name, :issuer_url, :client_id, :username_claim, :username_prefix, :groups_claim, :groups_prefix, :required_claims, :tags, :status) SENSITIVE = [] include Aws::Structure end |
#identity_provider_config_arn ⇒ String
The ARN of the configuration.
4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 4805 class OidcIdentityProviderConfig < Struct.new( :identity_provider_config_name, :identity_provider_config_arn, :cluster_name, :issuer_url, :client_id, :username_claim, :username_prefix, :groups_claim, :groups_prefix, :required_claims, :tags, :status) SENSITIVE = [] include Aws::Structure end |
#identity_provider_config_name ⇒ String
The name of the configuration.
4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 4805 class OidcIdentityProviderConfig < Struct.new( :identity_provider_config_name, :identity_provider_config_arn, :cluster_name, :issuer_url, :client_id, :username_claim, :username_prefix, :groups_claim, :groups_prefix, :required_claims, :tags, :status) 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.
4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 4805 class OidcIdentityProviderConfig < Struct.new( :identity_provider_config_name, :identity_provider_config_arn, :cluster_name, :issuer_url, :client_id, :username_claim, :username_prefix, :groups_claim, :groups_prefix, :required_claims, :tags, :status) 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.
4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 4805 class OidcIdentityProviderConfig < Struct.new( :identity_provider_config_name, :identity_provider_config_arn, :cluster_name, :issuer_url, :client_id, :username_claim, :username_prefix, :groups_claim, :groups_prefix, :required_claims, :tags, :status) SENSITIVE = [] include Aws::Structure end |
#status ⇒ String
The status of the OIDC identity provider.
4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 4805 class OidcIdentityProviderConfig < Struct.new( :identity_provider_config_name, :identity_provider_config_arn, :cluster_name, :issuer_url, :client_id, :username_claim, :username_prefix, :groups_claim, :groups_prefix, :required_claims, :tags, :status) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Hash<String,String>
Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.
4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 4805 class OidcIdentityProviderConfig < Struct.new( :identity_provider_config_name, :identity_provider_config_arn, :cluster_name, :issuer_url, :client_id, :username_claim, :username_prefix, :groups_claim, :groups_prefix, :required_claims, :tags, :status) SENSITIVE = [] include Aws::Structure end |
#username_claim ⇒ String
The JSON Web token (JWT) claim that is used as the username.
4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 4805 class OidcIdentityProviderConfig < Struct.new( :identity_provider_config_name, :identity_provider_config_arn, :cluster_name, :issuer_url, :client_id, :username_claim, :username_prefix, :groups_claim, :groups_prefix, :required_claims, :tags, :status) SENSITIVE = [] include Aws::Structure end |
#username_prefix ⇒ String
The prefix that is prepended to username claims to prevent clashes
with existing names. The prefix can't contain system:
4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 4805 class OidcIdentityProviderConfig < Struct.new( :identity_provider_config_name, :identity_provider_config_arn, :cluster_name, :issuer_url, :client_id, :username_claim, :username_prefix, :groups_claim, :groups_prefix, :required_claims, :tags, :status) SENSITIVE = [] include Aws::Structure end |