Package 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.89.0 (build 2f74b3e)",
           date="2023-10-26T00:56:07.715Z")
@Stability(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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

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

getClusterName

@Stability(Stable)
@NotNull
String getClusterName()

The cluster that the configuration is associated to.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-identityproviderconfig.html#cfn-eks-identityproviderconfig-clustername

getType

@Stability(Stable)
@NotNull
String getType()

The type of the identity provider configuration.

The only type available is oidc .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-identityproviderconfig.html#cfn-eks-identityproviderconfig-type

getIdentityProviderConfigName

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

The name of the configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-identityproviderconfig.html#cfn-eks-identityproviderconfig-identityproviderconfigname

getOidc

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-identityproviderconfig.html#cfn-eks-identityproviderconfig-oidc

getTags

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-identityproviderconfig.html#cfn-eks-identityproviderconfig-tags

builder

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

Returns:

a CfnIdentityProviderConfigProps.Builder of CfnIdentityProviderConfigProps