class CfnAddon (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.EKS.CfnAddon`
Java	`software.amazon.awscdk.services.eks.CfnAddon`
Python	`aws_cdk.aws_eks.CfnAddon`
TypeScript	`@aws-cdk/aws-eks` » `CfnAddon`

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::EKS::Addon.

Creates an Amazon EKS add-on.

Amazon EKS add-ons help to automate the provisioning and lifecycle management of common operational software for Amazon EKS clusters. For more information, see Amazon EKS add-ons in the Amazon EKS User Guide .

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 cfnAddon = new eks.CfnAddon(this, 'MyCfnAddon', {
  addonName: 'addonName',
  clusterName: 'clusterName',

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

Initializer

new CfnAddon(scope: Construct, id: string, props: CfnAddonProps)

Parameters

scope Construct — - scope in which this resource is defined.
id string — - scoped id of the resource.
props CfnAddonProps — - resource properties.

Create a new AWS::EKS::Addon.

Construct Props

Name	Type	Description
addonName	`string`	The name of the add-on.
clusterName	`string`	The name of the cluster.
addonVersion?	`string`	The version of the add-on.
configurationValues?	`string`	The configuration values that you provided.
preserveOnDelete?	`boolean \|` `IResolvable`	Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.
resolveConflicts?	`string`	How to resolve field value conflicts for an Amazon EKS add-on.
serviceAccountRoleArn?	`string`	The 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.

Properties

Name	Type	Description
addonName	`string`	The name of the add-on.
attrArn	`string`	The ARN of the add-on, such as `arn:aws:eks:us-west-2:111122223333:addon/1-19/vpc-cni/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` .
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
clusterName	`string`	The name of the cluster.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`ConstructNode`	The construct tree node associated with this construct.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	The metadata that you apply to the add-on to assist with categorization and organization.
addonVersion?	`string`	The version of the add-on.
configurationValues?	`string`	The configuration values that you provided.
preserveOnDelete?	`boolean \|` `IResolvable`	Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.
resolveConflicts?	`string`	How to resolve field value conflicts for an Amazon EKS add-on.
serviceAccountRoleArn?	`string`	The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

addonName

Type: string

The name of the add-on.

attrArn

Type: string

The ARN of the add-on, such as arn:aws:eks:us-west-2:111122223333:addon/1-19/vpc-cni/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx .

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

clusterName

Type: string

The name of the cluster.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: ConstructNode

The construct tree node associated with this construct.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

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 .

serviceAccountRoleArn?

Type: string (optional)

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

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 .

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

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

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

attributeName string — The name of the attribute.

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }