Class Addon.Builder

java.lang.Object
software.amazon.awscdk.services.eks.Addon.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<Addon>
Enclosing class:
Addon

@Stability(Stable) public static final class Addon.Builder extends Object implements software.amazon.jsii.Builder<Addon>
A fluent builder for Addon.
  • Method Details

    • create

      @Stability(Stable) public static Addon.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - The parent construct. This parameter is required.
      id - The construct ID. This parameter is required.
      Returns:
      a new instance of Addon.Builder.
    • addonName

      @Stability(Stable) public Addon.Builder addonName(String addonName)
      Name of the Add-On.

      Parameters:
      addonName - Name of the Add-On. This parameter is required.
      Returns:
      this
    • cluster

      @Stability(Stable) public Addon.Builder cluster(ICluster cluster)
      The EKS cluster the Add-On is associated with.

      Parameters:
      cluster - The EKS cluster the Add-On is associated with. This parameter is required.
      Returns:
      this
    • addonVersion

      @Stability(Stable) public Addon.Builder addonVersion(String addonVersion)
      Version of the Add-On.

      You can check all available versions with describe-addon-versons. For example, this lists all available versions for the eks-pod-identity-agent addon: $ aws eks describe-addon-versions --addon-name eks-pod-identity-agent \ --query 'addons[].addonVersions[].addonVersion'

      Default: the latest version.

      Parameters:
      addonVersion - Version of the Add-On. This parameter is required.
      Returns:
      this
    • preserveOnDelete

      @Stability(Stable) public Addon.Builder preserveOnDelete(Boolean preserveOnDelete)
      Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.

      If an IAM account is associated with the add-on, it isn't removed.

      Default: true

      Parameters:
      preserveOnDelete - Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on. This parameter is required.
      Returns:
      this
    • build

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