Addon

class aws_cdk.aws_eks.Addon(scope, id, *, addon_name, cluster, addon_version=None, configuration_values=None, preserve_on_delete=None)

Bases: Resource

Represents an Amazon EKS Add-On.

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
    }
)

Creates a new Amazon EKS Add-On.

Parameters:

scope (Construct) – The parent construct.
id (str) – The construct ID.
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.
configuration_values (Optional[Mapping[str, Any]]) – The configuration values for the Add-on. Default: - Use default configuration.
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

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:: policy (RemovalPolicy)
Return type:: None

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

PROPERTY_INJECTION_ID = 'aws-cdk-lib.aws-eks.Addon'

addon_arn: Arn of the addon.

addon_name: Name of the addon.

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node: The tree node.

stack: The stack in which this resource is defined.

Static Methods

classmethod from_addon_arn(scope, id, addon_arn)

Creates an IAddon from an existing addon ARN.

Parameters:

scope (Construct) –
- The parent construct.
id (str) –
- The ID of the construct.
addon_arn (str) –
- The ARN of the addon.

Return type:

IAddon

Returns:

An IAddon implementation.

classmethod from_addon_attributes(scope, id, *, addon_name, cluster_name)

Creates an IAddon instance from the given addon attributes.

Parameters:

scope (Construct) –
- The parent construct.
id (str) –
- The construct ID.
addon_name (str) – The name of the addon.
cluster_name (str) – The name of the Amazon EKS cluster the addon is associated with.

Return type:

IAddon

Returns:

An IAddon instance.

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:: construct (IConstruct)
Return type:: bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:: construct (IConstruct)
Return type:: bool