Package software.amazon.awscdk.services.eks

Interface OpenIdConnectProviderProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

OidcProviderNativeProps

All Known Implementing Classes:

OidcProviderNativeProps.Jsii$Proxy, OpenIdConnectProviderProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.126.0 (build 206d44b)",
           date="2026-02-09T14:39:10.788Z")
@Stability(Stable)
public interface OpenIdConnectProviderProps
extends software.amazon.jsii.JsiiSerializable

Initialization properties for OpenIdConnectProvider.

Example:

 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	OpenIdConnectProviderProps.Builder	A builder for OpenIdConnectProviderProps
static final class	OpenIdConnectProviderProps.Jsii$Proxy	An implementation for OpenIdConnectProviderProps

Method Summary

Modifier and Type	Method	Description
static OpenIdConnectProviderProps.Builder	builder()
default RemovalPolicy	getRemovalPolicy()	The removal policy to apply to the OpenID Connect Provider.
String	getUrl()	The URL of the identity provider.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getUrl

@Stability(Stable)
@NotNull
String getUrl()

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

getRemovalPolicy

@Stability(Stable)
@Nullable
default RemovalPolicy getRemovalPolicy()

The removal policy to apply to the OpenID Connect Provider.

Default: - RemovalPolicy.DESTROY

builder

@Stability(Stable)
static OpenIdConnectProviderProps.Builder builder()

Returns:

a OpenIdConnectProviderProps.Builder of OpenIdConnectProviderProps