Skip to content
v2.277.0

OpenIdConnectProviderProps Struct ​

Initialization properties for OpenIdConnectProvider.

Example ​

ts
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
});
python
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
)
java
import software.amazon.awscdk.*;

// Step 1: Add retain policy to existing provider
OpenIdConnectProvider existingProvider = OpenIdConnectProvider.Builder.create(this, "Provider")
        .url("https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLE")
        .removalPolicy(RemovalPolicy.RETAIN)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK;

// Step 1: Add retain policy to existing provider
var existingProvider = new OpenIdConnectProvider(this, "Provider", new OpenIdConnectProviderProps {
    Url = "https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLE",
    RemovalPolicy = RemovalPolicy.RETAIN
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import cdk "github.com/aws/aws-cdk-go/awscdk"

// Step 1: Add retain policy to existing provider
existingProvider := eks.NewOpenIdConnectProvider(this, jsii.String("Provider"), &OpenIdConnectProviderProps{
	Url: jsii.String("https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLE"),
	RemovalPolicy: cdk.RemovalPolicy_RETAIN,
})

Properties ​

removalPolicyoptionalRemovalPolicyremoval_policyoptionalRemovalPolicyremovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicy= RemovalPolicy.DESTROY#
The removal policy to apply to the OpenID Connect Provider.
urlstringurlstrurlStringUrlstringUrl*stringrequired#
The URL of the identity provider.
notes

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