Package software.amazon.awscdk.services.eks

Class HelmChart.Builder

java.lang.Object
software.amazon.awscdk.services.eks.HelmChart.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<HelmChart>
Enclosing class:
HelmChart
@Stability(Stable) public static final class HelmChart.Builder extends Object implements software.amazon.jsii.Builder<HelmChart>
A fluent builder for HelmChart.

  • Method Details

    • create

      @Stability(Stable) public static HelmChart.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of HelmChart.Builder.

    • chart

      @Stability(Stable) public HelmChart.Builder chart(String chart)
      The name of the chart.

      Either this or chartAsset must be specified.

      Default: - No chart name. Implies `chartAsset` is used.

      Parameters:
      chart - The name of the chart. This parameter is required.
      Returns:
      this

    • chartAsset

      @Stability(Stable) public HelmChart.Builder chartAsset(Asset chartAsset)
      The chart in the form of an asset.

      Either this or chart must be specified.

      Default: - No chart asset. Implies `chart` is used.

      Parameters:
      chartAsset - The chart in the form of an asset. This parameter is required.
      Returns:
      this

    • createNamespace

      @Stability(Stable) public HelmChart.Builder createNamespace(Boolean createNamespace)
      create namespace if not exist.

      Default: true

      Parameters:
      createNamespace - create namespace if not exist. This parameter is required.
      Returns:
      this

    • namespace

      @Stability(Stable) public HelmChart.Builder namespace(String namespace)
      The Kubernetes namespace scope of the requests.

      Default: default

      Parameters:
      namespace - The Kubernetes namespace scope of the requests. This parameter is required.
      Returns:
      this

    • release

      @Stability(Stable) public HelmChart.Builder release(String release)
      The name of the release.

      Default: - If no release name is given, it will use the last 53 characters of the node's unique id.

      Parameters:
      release - The name of the release. This parameter is required.
      Returns:
      this

    • repository

      @Stability(Stable) public HelmChart.Builder repository(String repository)
      The repository which contains the chart.

      For example: https://kubernetes-charts.storage.googleapis.com/

      Default: - No repository will be used, which means that the chart needs to be an absolute URL.

      Parameters:
      repository - The repository which contains the chart. This parameter is required.
      Returns:
      this

    • timeout

      @Stability(Stable) public HelmChart.Builder timeout(Duration timeout)
      Amount of time to wait for any individual Kubernetes operation.

      Maximum 15 minutes.

      Default: Duration.minutes(5)

      Parameters:
      timeout - Amount of time to wait for any individual Kubernetes operation. This parameter is required.
      Returns:
      this

    • values

      @Stability(Stable) public HelmChart.Builder values(Map<String,? extends Object> values)
      The values to be used by the chart.

      Default: - No values are provided to the chart.

      Parameters:
      values - The values to be used by the chart. This parameter is required.
      Returns:
      this

    • version

      @Stability(Stable) public HelmChart.Builder version(String version)
      The chart version to install.

      Default: - If this is not specified, the latest version is installed

      Parameters:
      version - The chart version to install. This parameter is required.
      Returns:
      this

    • wait

      @Stability(Stable) public HelmChart.Builder wait(Boolean wait)
      Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful.

      Default: - Helm will not wait before marking release as successful

      Parameters:
      wait - Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. This parameter is required.
      Returns:
      this

    • cluster

      @Stability(Stable) public HelmChart.Builder cluster(ICluster cluster)
      The EKS cluster to apply this configuration to.

      [disable-awslint:ref-via-interface]

      Parameters:
      cluster - The EKS cluster to apply this configuration to. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public HelmChart build()
      Specified by:
      build in interface software.amazon.jsii.Builder<HelmChart>
      Returns:
      a newly built instance of HelmChart.