AddonProps Struct
Properties for creating an Amazon EKS Add-On.
Example
ts
declare const cluster: eks.Cluster;
new eks.Addon(this, 'Addon', {
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: {
replicaCount: 2,
},
});
Properties
Name of the Add-On.
addonVersionstringaddon_versionstraddonVersionStringAddonVersionstringAddonVersion*string= the latest version.#Version of the Add-On.
notes
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'
The EKS cluster the Add-On is associated with.
configurationValues{ [key: string]: any }configuration_valuestyping.Mapping[str, Any]configurationValuesMap<String, Object>ConfigurationValuesIDictionary<string, object>ConfigurationValues*map[string]interface{}= Use default configuration.#The configuration values for the Add-on.
preserveOnDeletebooleanpreserve_on_deleteboolpreserveOnDeleteBooleanPreserveOnDeleteboolPreserveOnDelete*bool= true#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.
removalPolicyRemovalPolicyremoval_policyRemovalPolicyremovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicy= RemovalPolicy.DESTROY#The removal policy applied to the EKS add-on.
notes
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