software.amazon.awscdk.services.eks

Interface CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.Jsii$Proxy

Enclosing class:

CfnIdentityProviderConfig

@Stability(value=Stable)
public static interface CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty
extends software.amazon.jsii.JsiiSerializable

An object representing the configuration for an OpenID Connect (OIDC) identity provider.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.eks.*;
 OidcIdentityProviderConfigProperty oidcIdentityProviderConfigProperty = OidcIdentityProviderConfigProperty.builder()
         .clientId("clientId")
         .issuerUrl("issuerUrl")
         // the properties below are optional
         .groupsClaim("groupsClaim")
         .groupsPrefix("groupsPrefix")
         .requiredClaims(List.of(RequiredClaimProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .usernameClaim("usernameClaim")
         .usernamePrefix("usernamePrefix")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.Builder	builder()
String	getClientId() This is also known as *audience* .
default String	getGroupsClaim() The JSON web token (JWT) claim that the provider uses to return your groups.
default String	getGroupsPrefix() The prefix that is prepended to group claims to prevent clashes with existing names (such as `system:` groups).
String	getIssuerUrl() The URL of the OIDC identity provider that allows the API server to discover public signing keys for verifying tokens.
default Object	getRequiredClaims() The key-value pairs that describe required claims in the identity token.
default String	getUsernameClaim() The JSON Web token (JWT) claim that is used as the username.
default String	getUsernamePrefix() The prefix that is prepended to username claims to prevent clashes with existing names.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getClientId

@Stability(value=Stable)
 @NotNull
String getClientId()

This is also known as *audience* .

The ID of the client application that makes authentication requests to the OIDC identity provider.

getIssuerUrl

@Stability(value=Stable)
 @NotNull
String getIssuerUrl()

The URL of the OIDC identity provider that allows the API server to discover public signing keys for verifying tokens.

getGroupsClaim

@Stability(value=Stable)
 @Nullable
default String getGroupsClaim()

The JSON web token (JWT) claim that the provider uses to return your groups.

getGroupsPrefix

@Stability(value=Stable)
 @Nullable
default String getGroupsPrefix()

The prefix that is prepended to group claims to prevent clashes with existing names (such as `system:` groups).

For example, the value oidc: creates group names like oidc:engineering and oidc:infra . The prefix can't contain system:

getRequiredClaims

@Stability(value=Stable)
 @Nullable
default Object getRequiredClaims()

The key-value pairs that describe required claims in the identity token.

If set, each claim is verified to be present in the token with a matching value.

getUsernameClaim

@Stability(value=Stable)
 @Nullable
default String getUsernameClaim()

The JSON Web token (JWT) claim that is used as the username.

getUsernamePrefix

@Stability(value=Stable)
 @Nullable
default String getUsernamePrefix()

The prefix that is prepended to username claims to prevent clashes with existing names.

The prefix can't contain system:

builder

@Stability(value=Stable)
static CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.Builder builder()

Returns:

a CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.Builder of CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty