Package software.amazon.awscdk.services.eks

Class CfnIdentityProviderConfig

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.eks.CfnIdentityProviderConfig
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggable, IIdentityProviderConfigRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:05.585Z") @Stability(Stable) public class CfnIdentityProviderConfig extends CfnResource implements IInspectable, IIdentityProviderConfigRef, ITaggable
Associates an identity provider configuration to a cluster.

If you want to authenticate identities using an identity provider, you can create an identity provider configuration and associate it to your cluster. After configuring authentication to your cluster you can create Kubernetes Role and ClusterRole objects, assign permissions to them, and then bind them to the identities using Kubernetes RoleBinding and ClusterRoleBinding objects. For more information see Using RBAC Authorization in the Kubernetes documentation.

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.*;
 CfnIdentityProviderConfig cfnIdentityProviderConfig = CfnIdentityProviderConfig.Builder.create(this, "MyCfnIdentityProviderConfig")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnIdentityProviderConfig

      protected CfnIdentityProviderConfig(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnIdentityProviderConfig

      protected CfnIdentityProviderConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnIdentityProviderConfig

      @Stability(Stable) public CfnIdentityProviderConfig(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnIdentityProviderConfigProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrIdentityProviderConfigArn

      @Stability(Stable) @NotNull public String getAttrIdentityProviderConfigArn()
      The Amazon Resource Name (ARN) associated with the identity provider config.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getIdentityProviderConfigRef

      @Stability(Stable) @NotNull public IdentityProviderConfigReference getIdentityProviderConfigRef()
      A reference to a IdentityProviderConfig resource.
      Specified by:
      getIdentityProviderConfigRef in interface IIdentityProviderConfigRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getClusterName

      @Stability(Stable) @NotNull public String getClusterName()
      The name of your cluster.

    • setClusterName

      @Stability(Stable) public void setClusterName(@NotNull String value)
      The name of your cluster.

    • getType

      @Stability(Stable) @NotNull public String getType()
      The type of the identity provider configuration.

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      The type of the identity provider configuration.

    • getIdentityProviderConfigName

      @Stability(Stable) @Nullable public String getIdentityProviderConfigName()
      The name of the configuration.

    • setIdentityProviderConfigName

      @Stability(Stable) public void setIdentityProviderConfigName(@Nullable String value)
      The name of the configuration.

    • getOidc

      @Stability(Stable) @Nullable public Object getOidc()
      An object representing an OpenID Connect (OIDC) identity provider configuration.

      Returns union: either IResolvable or CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty

    • setOidc

      @Stability(Stable) public void setOidc(@Nullable IResolvable value)
      An object representing an OpenID Connect (OIDC) identity provider configuration.

    • setOidc

      @Stability(Stable) public void setOidc(@Nullable CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty value)
      An object representing an OpenID Connect (OIDC) identity provider configuration.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Metadata that assists with categorization and organization.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Metadata that assists with categorization and organization.