Class AddonProps

Properties for creating an Amazon EKS Add-On.

Inheritance

object

AddonProps

Implements

IAddonProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.EKSv2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class AddonProps : IAddonProps

Syntax (vb)

Public Class AddonProps Implements IAddonProps

Remarks

ExampleMetadata: infused

Examples

Cluster cluster;


            new Addon(this, "Addon", new AddonProps {
                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 = new Dictionary<string, object> {
                    { "replicaCount", 2 }
                }
            });

Synopsis

Constructors

AddonProps()

Properties for creating an Amazon EKS Add-On.

Properties

AddonName	Name of the Add-On.
AddonVersion	Version of the Add-On.
Cluster	The EKS cluster the Add-On is associated with.
ConfigurationValues	The configuration values for the Add-on.
PreserveOnDelete	Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.
RemovalPolicy	The removal policy applied to the EKS add-on.

Constructors

AddonProps()

Properties for creating an Amazon EKS Add-On.

public AddonProps()

Remarks

ExampleMetadata: infused

Examples

Cluster cluster;


            new Addon(this, "Addon", new AddonProps {
                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 = new Dictionary<string, object> {
                    { "replicaCount", 2 }
                }
            });

Properties

AddonName

Name of the Add-On.

public string AddonName { get; set; }

Property Value

string

Remarks

ExampleMetadata: infused

AddonVersion

Version of the Add-On.

public string? AddonVersion { get; set; }

Property Value

string

Remarks

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.

public ICluster Cluster { get; set; }

Property Value

ICluster

Remarks

ExampleMetadata: infused

ConfigurationValues

The configuration values for the Add-on.

public IDictionary<string, object>? ConfigurationValues { get; set; }

Property Value

IDictionary<string, object>

Remarks

Default: - Use default configuration.

PreserveOnDelete

Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.

public bool? PreserveOnDelete { get; set; }

Property Value

bool?

Remarks

If an IAM account is associated with the add-on, it isn't removed.

Default: true

RemovalPolicy

The removal policy applied to the EKS add-on.

public RemovalPolicy? RemovalPolicy { get; set; }

Property Value

RemovalPolicy?

Remarks

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

Default: RemovalPolicy.DESTROY

Implements

IAddonProps