1.204.0

interface CfnAddonProps

LanguageType name
.NETAmazon.CDK.AWS.EKS.CfnAddonProps
Javasoftware.amazon.awscdk.services.eks.CfnAddonProps
Pythonaws_cdk.aws_eks.CfnAddonProps
TypeScript @aws-cdk/aws-eks » CfnAddonProps

Properties for defining a CfnAddon.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as eks from '@aws-cdk/aws-eks';
const cfnAddonProps: eks.CfnAddonProps = {
  addonName: 'addonName',
  clusterName: 'clusterName',

  // the properties below are optional
  addonVersion: 'addonVersion',
  configurationValues: 'configurationValues',
  preserveOnDelete: false,
  resolveConflicts: 'resolveConflicts',
  serviceAccountRoleArn: 'serviceAccountRoleArn',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
addonNamestringThe name of the add-on.
clusterNamestringThe name of the cluster.
addonVersion?stringThe version of the add-on.
configurationValues?stringThe configuration values that you provided.
preserveOnDelete?boolean | IResolvableSpecifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.
resolveConflicts?stringHow to resolve field value conflicts for an Amazon EKS add-on.
serviceAccountRoleArn?stringThe Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account.
tags?CfnTag[]The metadata that you apply to the add-on to assist with categorization and organization.

addonName

Type: string

The name of the add-on.

clusterName

Type: string

The name of the cluster.

addonVersion?

Type: string (optional)

The version of the add-on.

configurationValues?

Type: string (optional)

The configuration values that you provided.

preserveOnDelete?

Type: boolean | IResolvable (optional)

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.

resolveConflicts?

Type: string (optional)

How to resolve field value conflicts for an Amazon EKS add-on.

Conflicts are handled based on the value you choose:

  • None – If the self-managed version of the add-on is installed on your cluster, Amazon EKS doesn't change the value. Creation of the add-on might fail.
  • Overwrite – If the self-managed version of the add-on is installed on your cluster and the Amazon EKS default value is different than the existing value, Amazon EKS changes the value to the Amazon EKS default value.
  • Preserve – Not supported. You can set this value when updating an add-on though. For more information, see UpdateAddon .

If you don't currently have the self-managed version of the add-on installed on your cluster, the Amazon EKS add-on is installed. Amazon EKS sets all values to default values, regardless of the option that you specify.

serviceAccountRoleArn?

Type: string (optional)

The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account.

The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide .

To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see Enabling IAM roles for service accounts on your cluster in the Amazon EKS User Guide .

tags?

Type: CfnTag[] (optional)

The metadata that you apply to the add-on to assist with categorization and organization.

Each tag consists of a key and an optional value, both of which you define. Add-on tags do not propagate to any other resources associated with the cluster.

← PreviousNext →