OpenIdConnectProviderProps

class aws_cdk.aws_eks_v2_alpha.OpenIdConnectProviderProps(*, url, removal_policy=None)

Bases: object

(experimental) Initialization properties for OpenIdConnectProvider.

Parameters:

  • url (str) – (experimental) The URL of the identity provider. The URL must begin with https:// and should correspond to the iss claim in the provider’s OpenID Connect 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. You can find your OIDC Issuer URL by: aws eks describe-cluster –name %cluster_name% –query “cluster.identity.oidc.issuer” –output text

  • removal_policy (Optional[RemovalPolicy]) – (experimental) The removal policy to apply to the OpenID Connect Provider. Default: - RemovalPolicy.DESTROY

Stability:

experimental

ExampleMetadata:

infused

Example:

import aws_cdk as cdk

# Step 1: Add retain policy to existing provider
existing_provider = eks.OpenIdConnectProvider(self, "Provider",
    url="https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLE",
    removal_policy=cdk.RemovalPolicy.RETAIN
)

Attributes

removal_policy

(experimental) The removal policy to apply to the OpenID Connect Provider.

Default:

  • RemovalPolicy.DESTROY

Stability:

experimental

url

(experimental) The URL of the identity provider.

The URL must begin with https:// and should correspond to the iss claim in the provider’s OpenID Connect 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.

You can find your OIDC Issuer URL by: aws eks describe-cluster –name %cluster_name% –query “cluster.identity.oidc.issuer” –output text

Stability:

experimental