Package software.amazon.awscdk.services.eks

Class OpenIdConnectProvider.Builder

java.lang.Object

software.amazon.awscdk.services.eks.OpenIdConnectProvider.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<OpenIdConnectProvider>

Enclosing class:

OpenIdConnectProvider

@Stability(Stable)
public static final class OpenIdConnectProvider.Builder
extends Object
implements software.amazon.jsii.Builder<OpenIdConnectProvider>

A fluent builder for OpenIdConnectProvider.

Method Summary

Modifier and Type	Method	Description
OpenIdConnectProvider	build()
static OpenIdConnectProvider.Builder	create(software.constructs.Construct scope, String id)
OpenIdConnectProvider.Builder	removalPolicy(RemovalPolicy removalPolicy)	The removal policy to apply to the OpenID Connect Provider.
OpenIdConnectProvider.Builder	url(String url)	The URL of the identity provider.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static OpenIdConnectProvider.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - The definition scope. This parameter is required.

id - Construct ID. This parameter is required.

Returns:

a new instance of OpenIdConnectProvider.Builder.

url

@Stability(Stable)
public OpenIdConnectProvider.Builder url(String url)

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

Parameters:

url - The URL of the identity provider. This parameter is required.

Returns:

this

removalPolicy

@Stability(Stable)
public OpenIdConnectProvider.Builder removalPolicy(RemovalPolicy removalPolicy)

The removal policy to apply to the OpenID Connect Provider.

Default: - RemovalPolicy.DESTROY

Parameters:

removalPolicy - The removal policy to apply to the OpenID Connect Provider. This parameter is required.

Returns:

this

build

@Stability(Stable)
public OpenIdConnectProvider build()

Specified by:

build in interface software.amazon.jsii.Builder<OpenIdConnectProvider>

Returns:

a newly built instance of OpenIdConnectProvider.