Package software.amazon.awscdk.services.eks.legacy

Class CfnIdentityProviderConfig

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.eks.legacy.CfnIdentityProviderConfig
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:46.733Z") @Stability(Stable) public class CfnIdentityProviderConfig extends CfnResource implements IInspectable
A CloudFormation AWS::EKS::IdentityProviderConfig.

Associate 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 roles and clusterroles to assign permissions to the roles, and then bind the roles to the identities using Kubernetes rolebindings and clusterrolebindings . 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.legacy.*;
 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();

  • 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 Construct scope, @NotNull String id, @NotNull CfnIdentityProviderConfigProps props)
      Create a new AWS::EKS::IdentityProviderConfig.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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

    • getTags

      @Stability(Stable) @NotNull public TagManager 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.

    • getClusterName

      @Stability(Stable) @NotNull public String getClusterName()
      The cluster that the configuration is associated to.

    • setClusterName

      @Stability(Stable) public void setClusterName(@NotNull String value)
      The cluster that the configuration is associated to.

    • getType

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

      The only type available is oidc .

    • setType

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

      The only type available is oidc .

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

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