software.amazon.awscdk.services.eks

Interface CfnIdentityProviderConfigProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIdentityProviderConfigProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.915Z")
 @Stability(value=Stable)
public interface CfnIdentityProviderConfigProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnIdentityProviderConfig`.

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.*;
 CfnIdentityProviderConfigProps cfnIdentityProviderConfigProps = CfnIdentityProviderConfigProps.builder()
         .clusterName("clusterName")
         .type("type")
         // the properties below are optional
         .identityProviderConfigName("identityProviderConfigName")
         .oidc(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())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnIdentityProviderConfigProps.Builder	builder()
String	getClusterName() The cluster that the configuration is associated to.
default String	getIdentityProviderConfigName() The name of the configuration.
default Object	getOidc() An object that represents an OpenID Connect (OIDC) identity provider configuration.
default List<CfnTag>	getTags() The metadata to apply to the provider configuration to assist with categorization and organization.
String	getType() The type of the identity provider configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getClusterName

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

The cluster that the configuration is associated to.

getType

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

The type of the identity provider configuration.

The only type available is oidc .

getIdentityProviderConfigName

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

The name of the configuration.

getOidc

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

An object that represents an OpenID Connect (OIDC) identity provider configuration.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

The metadata to apply to the provider configuration to assist with categorization and organization.

Each tag consists of a key and an optional value. You define both.

builder

@Stability(value=Stable)
static CfnIdentityProviderConfigProps.Builder builder()

Returns:

a CfnIdentityProviderConfigProps.Builder of CfnIdentityProviderConfigProps