interface AddonProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.EKS.AddonProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awseks#AddonProps |
 Java | software.amazon.awscdk.services.eks.AddonProps |
 Python | aws_cdk.aws_eks.AddonProps |
 TypeScript (source) | aws-cdk-lib » aws_eks » AddonProps |
Properties for creating an Amazon EKS Add-On.
Example
declare const cluster: eks.Cluster;
new eks.Addon(this, 'Addon', {
cluster,
addonName: 'aws-guardduty-agent',
addonVersion: 'v1.6.1',
// whether to preserve the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.
preserveOnDelete: false,
});
Properties
| Name | Type | Description |
|---|---|---|
| addon | string | Name of the Add-On. |
| cluster | ICluster | The EKS cluster the Add-On is associated with. |
| addon | string | Version of the Add-On. |
| preserve | boolean | Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on. |
addonName
Type:
string
Name of the Add-On.
cluster
Type:
ICluster
The EKS cluster the Add-On is associated with.
addonVersion?
Type:
string
(optional, default: the latest version.)
Version of the Add-On.
You can check all available versions with describe-addon-versons.
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'
preserveOnDelete?
Type:
boolean
(optional, default: 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.