interface OpenIdConnectProviderProps

Language	Type name
.NET	Amazon.CDK.AWS.EKS.OpenIdConnectProviderProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awseks#OpenIdConnectProviderProps
Java	software.amazon.awscdk.services.eks.OpenIdConnectProviderProps
Python	aws_cdk.aws_eks.OpenIdConnectProviderProps
TypeScript (source)	aws-cdk-lib » aws_eks » OpenIdConnectProviderProps

Initialization properties for OpenIdConnectProvider.

Example

import * as cdk from 'aws-cdk-lib';
// Step 1: Add retain policy to existing provider
const existingProvider = new eks.OpenIdConnectProvider(this, 'Provider', {
  url: 'https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLE',
  removalPolicy: cdk.RemovalPolicy.RETAIN, // Add this line
});

Properties

Name	Type	Description
url	string	The URL of the identity provider.
removalPolicy?	RemovalPolicy	The removal policy to apply to the OpenID Connect Provider.

---

url

Type: string

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

---

removalPolicy?

Type: RemovalPolicy (optional, default: RemovalPolicy.DESTROY)

The removal policy to apply to the OpenID Connect Provider.