Package software.amazon.awscdk.services.eks

Interface AddonProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AddonProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.126.0 (build 206d44b)",
           date="2026-02-09T14:39:10.643Z")
@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("coredns")
         .addonVersion("v1.11.4-eksbuild.2")
         // whether to preserve the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.
         .preserveOnDelete(false)
         .configurationValues(Map.of(
                 "replicaCount", 2))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AddonProps.Builder	A builder for AddonProps
static final class	AddonProps.Jsii$Proxy	An implementation for AddonProps

Method Summary

Modifier and Type	Method	Description
static AddonProps.Builder	builder()
String	getAddonName()	Name of the Add-On.
default String	getAddonVersion()	Version of the Add-On.
ICluster	getCluster()	The EKS cluster the Add-On is associated with.
default Map<String,Object>	getConfigurationValues()	The configuration values for the Add-on.
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.
default RemovalPolicy	getRemovalPolicy()	The removal policy applied to the EKS add-on.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

getConfigurationValues

@Stability(Stable)
@Nullable
default Map<String,Object> getConfigurationValues()

The configuration values for the Add-on.

Default: - Use default configuration.

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

getRemovalPolicy

@Stability(Stable)
@Nullable
default RemovalPolicy getRemovalPolicy()

The removal policy applied to the EKS add-on.

The removal policy controls what happens to the resource if it stops being managed by CloudFormation. This can happen in one of three situations:

• The resource is removed from the template, so CloudFormation stops managing it
• A change to the resource is made that requires it to be replaced, so CloudFormation stops managing it
• The stack is deleted, so CloudFormation stops managing all resources in it

Default: RemovalPolicy.DESTROY

builder

@Stability(Stable)
static AddonProps.Builder builder()

Returns:

a AddonProps.Builder of AddonProps