Package software.amazon.awscdk.services.eks

Class CfnAddon

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.CfnAddon
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggable, IAddonRef, 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.550Z") @Stability(Stable) public class CfnAddon extends CfnResource implements IInspectable, IAddonRef, ITaggable
Creates an Amazon EKS add-on.

Amazon EKS add-ons help to automate the provisioning and lifecycle management of common operational software for Amazon EKS clusters. For more information, see Amazon EKS add-ons in the Amazon EKS User Guide .

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.*;
 CfnAddon cfnAddon = CfnAddon.Builder.create(this, "MyCfnAddon")
         .addonName("addonName")
         .clusterName("clusterName")
         // the properties below are optional
         .addonVersion("addonVersion")
         .configurationValues("configurationValues")
         .namespaceConfig(NamespaceConfigProperty.builder()
                 .namespace("namespace")
                 .build())
         .podIdentityAssociations(List.of(PodIdentityAssociationProperty.builder()
                 .roleArn("roleArn")
                 .serviceAccount("serviceAccount")
                 .build()))
         .preserveOnDelete(false)
         .resolveConflicts("resolveConflicts")
         .serviceAccountRoleArn("serviceAccountRoleArn")
         .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

    • CfnAddon

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

    • CfnAddon

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

    • CfnAddon

      @Stability(Stable) public CfnAddon(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAddonProps 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.

    • getAddonRef

      @Stability(Stable) @NotNull public AddonReference getAddonRef()
      A reference to a Addon resource.
      Specified by:
      getAddonRef in interface IAddonRef

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the add-on, such as arn:aws:eks:us-west-2:111122223333:addon/1-19/vpc-cni/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx .

    • getCfnProperties

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

    • getTags

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

    • getAddonName

      @Stability(Stable) @NotNull public String getAddonName()
      The name of the add-on.

    • setAddonName

      @Stability(Stable) public void setAddonName(@NotNull String value)
      The name of the add-on.

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

    • getAddonVersion

      @Stability(Stable) @Nullable public String getAddonVersion()
      The version of the add-on.

    • setAddonVersion

      @Stability(Stable) public void setAddonVersion(@Nullable String value)
      The version of the add-on.

    • getConfigurationValues

      @Stability(Stable) @Nullable public String getConfigurationValues()
      The configuration values that you provided.

    • setConfigurationValues

      @Stability(Stable) public void setConfigurationValues(@Nullable String value)
      The configuration values that you provided.

    • getNamespaceConfig

      @Stability(Stable) @Nullable public Object getNamespaceConfig()
      The namespace configuration for the addon.

      Returns union: either IResolvable or CfnAddon.NamespaceConfigProperty

    • setNamespaceConfig

      @Stability(Stable) public void setNamespaceConfig(@Nullable IResolvable value)
      The namespace configuration for the addon.

    • setNamespaceConfig

      @Stability(Stable) public void setNamespaceConfig(@Nullable CfnAddon.NamespaceConfigProperty value)
      The namespace configuration for the addon.

    • getPodIdentityAssociations

      @Stability(Stable) @Nullable public Object getPodIdentityAssociations()
      An array of EKS Pod Identity associations owned by the add-on.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnAddon.PodIdentityAssociationProperty>

    • setPodIdentityAssociations

      @Stability(Stable) public void setPodIdentityAssociations(@Nullable IResolvable value)
      An array of EKS Pod Identity associations owned by the add-on.

    • setPodIdentityAssociations

      @Stability(Stable) public void setPodIdentityAssociations(@Nullable List<Object> value)
      An array of EKS Pod Identity associations owned by the add-on.

    • getPreserveOnDelete

      @Stability(Stable) @Nullable public Object getPreserveOnDelete()
      Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.

      Returns union: either Boolean or IResolvable

    • setPreserveOnDelete

      @Stability(Stable) public void setPreserveOnDelete(@Nullable Boolean value)
      Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.

    • setPreserveOnDelete

      @Stability(Stable) public void setPreserveOnDelete(@Nullable IResolvable value)
      Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.

    • getResolveConflicts

      @Stability(Stable) @Nullable public String getResolveConflicts()
      How to resolve field value conflicts for an Amazon EKS add-on.

    • setResolveConflicts

      @Stability(Stable) public void setResolveConflicts(@Nullable String value)
      How to resolve field value conflicts for an Amazon EKS add-on.

    • getServiceAccountRoleArn

      @Stability(Stable) @Nullable public String getServiceAccountRoleArn()
      The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account.

    • setServiceAccountRoleArn

      @Stability(Stable) public void setServiceAccountRoleArn(@Nullable String value)
      The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The metadata that you apply to the add-on to assist with categorization and organization.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The metadata that you apply to the add-on to assist with categorization and organization.