software.amazon.awscdk.services.eks

Class CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.Builder

java.lang.Object

software.amazon.awscdk.services.eks.CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty>

Enclosing interface:

CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty

@Stability(value=Stable)
public static final class CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty>

A builder for CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty	build() Builds the configured instance.
CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.Builder	clientId(String clientId) Sets the value of CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.getClientId()
CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.Builder	groupsClaim(String groupsClaim) Sets the value of CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.getGroupsClaim()
CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.Builder	groupsPrefix(String groupsPrefix) Sets the value of CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.getGroupsPrefix()
CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.Builder	issuerUrl(String issuerUrl) Sets the value of CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.getIssuerUrl()
CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.Builder	requiredClaims(IResolvable requiredClaims) Sets the value of CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.getRequiredClaims()
CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.Builder	requiredClaims(List<? extends Object> requiredClaims) Sets the value of CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.getRequiredClaims()
CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.Builder	usernameClaim(String usernameClaim) Sets the value of CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.getUsernameClaim()
CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.Builder	usernamePrefix(String usernamePrefix) Sets the value of CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.getUsernamePrefix()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

clientId

@Stability(value=Stable)
public CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.Builder clientId(String clientId)

Sets the value of CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.getClientId()

Parameters:

clientId - This is also known as *audience* . This parameter is required. The ID of the client application that makes authentication requests to the OIDC identity provider.

Returns:

this

issuerUrl

@Stability(value=Stable)
public CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.Builder issuerUrl(String issuerUrl)

Sets the value of CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.getIssuerUrl()

Parameters:

issuerUrl - The URL of the OIDC identity provider that allows the API server to discover public signing keys for verifying tokens. This parameter is required.

Returns:

this

groupsClaim

@Stability(value=Stable)
public CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.Builder groupsClaim(String groupsClaim)

Sets the value of CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.getGroupsClaim()

Parameters:

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

Returns:

this

groupsPrefix

@Stability(value=Stable)
public CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.Builder groupsPrefix(String groupsPrefix)

Sets the value of CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.getGroupsPrefix()

Parameters:

groupsPrefix - 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:

Returns:

this

requiredClaims

@Stability(value=Stable)
public CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.Builder requiredClaims(IResolvable requiredClaims)

Sets the value of CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.getRequiredClaims()

Parameters:

requiredClaims - 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.

Returns:

this

requiredClaims

@Stability(value=Stable)
public CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.Builder requiredClaims(List<? extends Object> requiredClaims)

Sets the value of CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.getRequiredClaims()

Parameters:

requiredClaims - 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.

Returns:

this

usernameClaim

@Stability(value=Stable)
public CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.Builder usernameClaim(String usernameClaim)

Sets the value of CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.getUsernameClaim()

Parameters:

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

Returns:

this

usernamePrefix

@Stability(value=Stable)
public CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.Builder usernamePrefix(String usernamePrefix)

Sets the value of CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty.getUsernamePrefix()

Parameters:

usernamePrefix - The prefix that is prepended to username claims to prevent clashes with existing names. The prefix can't contain system:

Returns:

this

build

@Stability(value=Stable)
public CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty>

Returns:

a new instance of CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty

Throws:

NullPointerException - if any required attribute was not provided