Package software.amazon.awscdk.services.eks_v2

Class HelmChart

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.services.eks_v2.HelmChart
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.126.0 (build 206d44b)", date="2026-02-23T18:58:18.919Z") @Stability(Stable) public class HelmChart extends software.constructs.Construct
Represents a helm chart within the Kubernetes system.

Applies/deletes the resources using kubectl in sync with the resource.

Example: 

 Cluster cluster;
 // option 1: use a construct
 // option 1: use a construct
 HelmChart.Builder.create(this, "MyOCIChart")
         .cluster(cluster)
         .chart("some-chart")
         .repository("oci://${ACCOUNT_ID}.dkr.ecr.${ACCOUNT_REGION}.amazonaws.com/${REPO_NAME}")
         .namespace("oci")
         .version("0.0.1")
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    HelmChart.Builder
    A fluent builder for HelmChart.

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.constructs.IConstruct

    software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    RESOURCE_TYPE
    The CloudFormation resource type.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    HelmChart(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    HelmChart(software.amazon.jsii.JsiiObjectRef objRef)
     
     
    HelmChart(software.constructs.Construct scope, String id, HelmChartProps props)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Boolean
    getAtomic()
    Whether or not Helm should treat this operation as atomic.
    String
    getChart()
    The name of the chart.
    Asset
    getChartAsset()
    The chart in the form of an asset.
    String
    getRepository()
    The repository which contains the chart.
    String
    getVersion()
    The chart version to install.

    Methods inherited from class software.constructs.Construct

    getNode, isConstruct, toString, with

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Field Details

    • RESOURCE_TYPE

      @Stability(Stable) public static final String RESOURCE_TYPE
      The CloudFormation resource type.

  • Constructor Details

    • HelmChart

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

    • HelmChart

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

    • HelmChart

      @Stability(Stable) public HelmChart(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull HelmChartProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • getAtomic

      @Stability(Stable) @Nullable public Boolean getAtomic()
      Whether or not Helm should treat this operation as atomic.

    • getChart

      @Stability(Stable) @Nullable public String getChart()
      The name of the chart.

    • getChartAsset

      @Stability(Stable) @Nullable public Asset getChartAsset()
      The chart in the form of an asset.

    • getRepository

      @Stability(Stable) @Nullable public String getRepository()
      The repository which contains the chart.

    • getVersion

      @Stability(Stable) @Nullable public String getVersion()
      The chart version to install.