Interface AddonProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
AddonProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-10-31T19:12:57.754Z") @Stability(Stable) public interface AddonProps extends software.amazon.jsii.JsiiSerializable
Properties for creating an Amazon EKS Add-On.

Example:

 Cluster cluster;
 Addon.Builder.create(this, "Addon")
         .cluster(cluster)
         .addonName("aws-guardduty-agent")
         .addonVersion("v1.6.1")
         // whether to preserve the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.
         .preserveOnDelete(false)
         .build();
 
  • Method Details

    • getAddonName

      @Stability(Stable) @NotNull String getAddonName()
      Name of the Add-On.
    • getCluster

      @Stability(Stable) @NotNull ICluster getCluster()
      The EKS cluster the Add-On is associated with.
    • getAddonVersion

      @Stability(Stable) @Nullable default String getAddonVersion()
      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.

    • getPreserveOnDelete

      @Stability(Stable) @Nullable default Boolean getPreserveOnDelete()
      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

    • builder

      @Stability(Stable) static AddonProps.Builder builder()
      Returns:
      a AddonProps.Builder of AddonProps