AddonProps

class aws_cdk.aws_eks_v2_alpha.AddonProps(*, addon_name, cluster, addon_version=None, configuration_values=None, preserve_on_delete=None)

Bases: object

(experimental) Properties for creating an Amazon EKS Add-On.

Parameters:

addon_name (str) – (experimental) Name of the Add-On.
cluster (ICluster) – (experimental) The EKS cluster the Add-On is associated with.
addon_version (Optional[str]) – (experimental) 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.
configuration_values (Optional[Mapping[str, Any]]) – (experimental) The configuration values for the Add-on. Default: - Use default configuration.
preserve_on_delete (Optional[bool]) – (experimental) 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

Stability:

experimental

ExampleMetadata:

infused

Example:

# cluster: eks.Cluster


eks.Addon(self, "Addon",
    cluster=cluster,
    addon_name="coredns",
    addon_version="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.
    preserve_on_delete=False,
    configuration_values={
        "replica_count": 2
    }
)

Attributes

addon_name

(experimental) Name of the Add-On.

Stability:: experimental

addon_version

(experimental) 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.
Stability:: experimental

cluster

(experimental) The EKS cluster the Add-On is associated with.

Stability:: experimental

configuration_values

(experimental) The configuration values for the Add-on.

Default:

Use default configuration.

Stability:

experimental

preserve_on_delete

(experimental) 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
Stability:: experimental