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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-identityproviderconfig-oidcidentityproviderconfig.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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 Details

getClientId

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-identityproviderconfig-oidcidentityproviderconfig.html#cfn-eks-identityproviderconfig-oidcidentityproviderconfig-clientid

getIssuerUrl

@Stability(Stable)
@NotNull
String getIssuerUrl()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-identityproviderconfig-oidcidentityproviderconfig.html#cfn-eks-identityproviderconfig-oidcidentityproviderconfig-issuerurl

getGroupsClaim

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-identityproviderconfig-oidcidentityproviderconfig.html#cfn-eks-identityproviderconfig-oidcidentityproviderconfig-groupsclaim

getGroupsPrefix

@Stability(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:

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-identityproviderconfig-oidcidentityproviderconfig.html#cfn-eks-identityproviderconfig-oidcidentityproviderconfig-groupsprefix

getRequiredClaims

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-identityproviderconfig-oidcidentityproviderconfig.html#cfn-eks-identityproviderconfig-oidcidentityproviderconfig-requiredclaims

getUsernameClaim

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-identityproviderconfig-oidcidentityproviderconfig.html#cfn-eks-identityproviderconfig-oidcidentityproviderconfig-usernameclaim

getUsernamePrefix

@Stability(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:

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-identityproviderconfig-oidcidentityproviderconfig.html#cfn-eks-identityproviderconfig-oidcidentityproviderconfig-usernameprefix

builder

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

Returns:

a CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.Builder of CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty