AddonProps

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

Bases: object

Properties for creating an Amazon EKS Add-On.

Parameters:

addon_name (str) – Name of the Add-On.
cluster (ICluster) – The EKS cluster the Add-On is associated with.
addon_version (Optional[str]) – 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.
preserve_on_delete (Optional[bool]) – 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

ExampleMetadata:

infused

Example:

# cluster: eks.Cluster


eks.Addon(self, "Addon",
    cluster=cluster,
    addon_name="aws-guardduty-agent",
    addon_version="v1.6.1",
    # 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
)

Attributes

addon_name: Name of the Add-On.

addon_version

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.

cluster: The EKS cluster the Add-On is associated with.

preserve_on_delete

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