Skip to content

OidcIdentityProviderConfig

Source code in docs_src/capo_eks/types/oidc_identity_provider_config.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class OidcIdentityProviderConfig(TypedDict, closed=True):
    identity_provider_config_name: NotRequired["capo_eks.types.string.String"]
    """<p>The name of the configuration.</p>"""
    identity_provider_config_arn: NotRequired["capo_eks.types.string.String"]
    """<p>The ARN of the configuration.</p>"""
    cluster_name: NotRequired["capo_eks.types.string.String"]
    """<p>The name of your cluster.</p>"""
    issuer_url: NotRequired["capo_eks.types.string.String"]
    """<p>The URL of the OIDC identity provider that allows the API server to discover public signing keys for verifying tokens.</p>"""
    client_id: NotRequired["capo_eks.types.string.String"]
    """<p>This is also known as <i>audience</i>. The ID of the client application that makes authentication requests to the OIDC identity provider.</p>"""
    username_claim: NotRequired["capo_eks.types.string.String"]
    """<p>The JSON Web token (JWT) claim that is used as the username.</p>"""
    username_prefix: NotRequired["capo_eks.types.string.String"]
    """<p>The prefix that is prepended to username claims to prevent clashes with existing names. The prefix can't contain <code>system:</code> </p>"""
    groups_claim: NotRequired["capo_eks.types.string.String"]
    """<p>The JSON web token (JWT) claim that the provider uses to return your groups.</p>"""
    groups_prefix: NotRequired["capo_eks.types.string.String"]
    """<p>The prefix that is prepended to group claims to prevent clashes with existing names (such as <code>system:</code> groups). For example, the value<code> oidc:</code> creates group names like <code>oidc:engineering</code> and <code>oidc:infra</code>. The prefix can't contain <code>system:</code> </p>"""
    required_claims: NotRequired["capo_eks.types.required_claims_map.requiredClaimsMap"]
    """<p>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.</p>"""
    tags: NotRequired["capo_eks.types.tag_map.TagMap"]
    """<p>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.</p>"""
    status: NotRequired["capo_eks.types.config_status.configStatus"]
    """<p>The status of the OIDC identity provider.</p>"""

client_id instance-attribute 

client_id: NotRequired[String]

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

cluster_name instance-attribute 

cluster_name: NotRequired[String]

The name of your cluster.

groups_claim instance-attribute 

groups_claim: NotRequired[String]

The JSON web token (JWT) claim that the provider uses to return your groups.

groups_prefix instance-attribute 

groups_prefix: NotRequired[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:

identity_provider_config_arn instance-attribute 

identity_provider_config_arn: NotRequired[String]

The ARN of the configuration.

identity_provider_config_name instance-attribute 

identity_provider_config_name: NotRequired[String]

The name of the configuration.

issuer_url instance-attribute 

issuer_url: NotRequired[String]

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

required_claims instance-attribute 

required_claims: NotRequired[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.

status instance-attribute 

status: NotRequired[configStatus]

The status of the OIDC identity provider.

tags instance-attribute 

tags: NotRequired[TagMap]

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.

username_claim instance-attribute 

username_claim: NotRequired[String]

The JSON Web token (JWT) claim that is used as the username.

username_prefix instance-attribute 

username_prefix: NotRequired[String]

The prefix that is prepended to username claims to prevent clashes with existing names. The prefix can't contain system: