API Reference

Constructs

CommonHelmCharts

Initializers

import { CommonHelmCharts } from '@smallcase/cdk-eks-cluster-module'

new CommonHelmCharts(scope: Construct, id: string, props: CommonHelmChartsProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`props`	`CommonHelmChartsProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: CommonHelmChartsProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.

`toString`

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { CommonHelmCharts } from '@smallcase/cdk-eks-cluster-module'

CommonHelmCharts.isConstruct(x: any)

Checks if x is a construct.

`x`^Required

Type: any

Any object.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

CoreDnsAddon

Initializers

import { CoreDnsAddon } from '@smallcase/cdk-eks-cluster-module'

new CoreDnsAddon(scope: Construct, id: string, props: CoreAddonProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`props`	`CoreAddonProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: CoreAddonProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`overrideLogicalId`	Overrides the auto-generated logical ID with a specific ID.
`addDeletionOverride`	Syntactic sugar for `addOverride(path, undefined)`.
`addDependency`	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
`addDependsOn`	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
`addMetadata`	Add a value to the CloudFormation Resource Metadata.
`addOverride`	Adds an override to the synthesized CloudFormation resource.
`addPropertyDeletionOverride`	Adds an override that deletes the value of a property from the resource definition.
`addPropertyOverride`	Adds an override to a resource property.
`applyRemovalPolicy`	Sets the deletion policy of the resource based on the removal policy specified.
`getAtt`	Returns a token for an runtime attribute of this resource.
`getMetadata`	Retrieve a value value from the CloudFormation Resource Metadata.
`obtainDependencies`	Retrieves an array of resources this resource depends on.
`obtainResourceDependencies`	Get a shallow copy of dependencies between this resource and other resources in the same stack.
`removeDependency`	Indicates that this resource no longer depends on another resource.
`replaceDependency`	Replaces one dependency with another.
`inspect`	Examines the CloudFormation resource and discloses attributes.

`toString`

public toString(): string

Returns a string representation of this construct.

`overrideLogicalId`

public overrideLogicalId(newLogicalId: string): void

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

`newLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`addDeletionOverride`

public addDeletionOverride(path: string): void

Syntactic sugar for addOverride(path, undefined).

`path`^Required

Type: string

The path of the value to delete.

`addDependency`

public addDependency(target: CfnResource): void

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.

`target`^Required

Type: aws-cdk-lib.CfnResource

`addDependsOn`

public addDependsOn(target: CfnResource): void

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

`target`^Required

Type: aws-cdk-lib.CfnResource

`addMetadata`

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

Add a value to the CloudFormation Resource Metadata.

[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.](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.)

`key`^Required

Type: string

`value`^Required

Type: any

`addOverride`

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

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.

`path`^Required

Type: string

The path of the property, you can use dot notation to override values in complex types.

Any intermediate keys will be created as needed.

`value`^Required

Type: any

The value.

Could be primitive or complex.

`addPropertyDeletionOverride`

public addPropertyDeletionOverride(propertyPath: string): void

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

`propertyPath`^Required

Type: string

The path to the property.

`addPropertyOverride`

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

Adds an override to a resource property.

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

`propertyPath`^Required

Type: string

The path of the property.

`value`^Required

Type: any

The value.

`applyRemovalPolicy`

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

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

`policy`^Optional

Type: aws-cdk-lib.RemovalPolicy

`options`^Optional

Type: aws-cdk-lib.RemovalPolicyOptions

`getAtt`

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): 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.

`attributeName`^Required

Type: string

The name of the attribute.

`typeHint`^Optional

Type: aws-cdk-lib.ResolutionTypeHint

`getMetadata`

public getMetadata(key: string): any

Retrieve a value value from the CloudFormation Resource Metadata.

[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.](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.)

`key`^Required

Type: string

`obtainDependencies`

public obtainDependencies(): Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

`obtainResourceDependencies`

public obtainResourceDependencies(): CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

`removeDependency`

public removeDependency(target: CfnResource): void

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

`target`^Required

Type: aws-cdk-lib.CfnResource

`replaceDependency`

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Replaces one dependency with another.

`target`^Required

Type: aws-cdk-lib.CfnResource

The dependency to replace.

`newTarget`^Required

Type: aws-cdk-lib.CfnResource

The new dependency to add.

`inspect`

public inspect(inspector: TreeInspector): void

Examines the CloudFormation resource and discloses attributes.

`inspector`^Required

Type: aws-cdk-lib.TreeInspector

tree inspector to collect and process attributes.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isCfnElement`	Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
`isCfnResource`	Check whether the given object is a CfnResource.

`isConstruct`

import { CoreDnsAddon } from '@smallcase/cdk-eks-cluster-module'

CoreDnsAddon.isConstruct(x: any)

Checks if x is a construct.

`x`^Required

Type: any

Any object.

`isCfnElement`

import { CoreDnsAddon } from '@smallcase/cdk-eks-cluster-module'

CoreDnsAddon.isCfnElement(x: any)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

`x`^Required

Type: any

`isCfnResource`

import { CoreDnsAddon } from '@smallcase/cdk-eks-cluster-module'

CoreDnsAddon.isCfnResource(x: any)

Check whether the given object is a CfnResource.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`creationStack`	`string[]`	No description.
`logicalId`	`string`	The logical ID for this CloudFormation stack element.
`stack`	`aws-cdk-lib.Stack`	The stack in which this element is defined.
`ref`	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
`cfnOptions`	`aws-cdk-lib.ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
`cfnResourceType`	`string`	AWS resource type.
`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` .
`tags`	`aws-cdk-lib.TagManager`	Tag Manager which manages the tags for this resource.
`addonName`	`string`	The name of the add-on.
`clusterName`	`string`	The name of your cluster.
`addonVersion`	`string`	The version of the add-on.
`configurationValues`	`string`	The configuration values that you provided.
`podIdentityAssociations`	`aws-cdk-lib.IResolvable \| aws-cdk-lib.IResolvable \| aws-cdk-lib.aws_eks.CfnAddon.PodIdentityAssociationProperty[]`	An array of Pod Identity Assocations owned by the Addon.
`preserveOnDelete`	`boolean \| aws-cdk-lib.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.
`tagsRaw`	`aws-cdk-lib.CfnTag[]`	The metadata that you apply to the add-on to assist with categorization and organization.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

`logicalId`^Required

public readonly logicalId: string;

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

`stack`^Required

public readonly stack: Stack;

Type: aws-cdk-lib.Stack

The stack in which this element is defined.

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

`ref`^Required

public readonly ref: string;

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

`cfnOptions`^Required

public readonly cfnOptions: ICfnResourceOptions;

Type: aws-cdk-lib.ICfnResourceOptions

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

`cfnResourceType`^Required

public readonly cfnResourceType: string;

Type: string

AWS resource type.

`attrArn`^Required

public readonly attrArn: string;

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 .

`tags`^Required

public readonly tags: TagManager;

Type: aws-cdk-lib.TagManager

Tag Manager which manages the tags for this resource.

`addonName`^Required

public readonly addonName: string;

Type: string

The name of the add-on.

`clusterName`^Required

public readonly clusterName: string;

Type: string

The name of your cluster.

`addonVersion`^Optional

public readonly addonVersion: string;

Type: string

The version of the add-on.

`configurationValues`^Optional

public readonly configurationValues: string;

Type: string

The configuration values that you provided.

`podIdentityAssociations`^Optional

public readonly podIdentityAssociations: IResolvable | IResolvable | PodIdentityAssociationProperty[];

Type: aws-cdk-lib.IResolvable | aws-cdk-lib.IResolvable | aws-cdk-lib.aws_eks.CfnAddon.PodIdentityAssociationProperty[]

An array of Pod Identity Assocations owned by the Addon.

`preserveOnDelete`^Optional

public readonly preserveOnDelete: boolean | IResolvable;

Type: boolean | aws-cdk-lib.IResolvable

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

`resolveConflicts`^Optional

public readonly resolveConflicts: string;

Type: string

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

`serviceAccountRoleArn`^Optional

public readonly serviceAccountRoleArn: string;

Type: string

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

`tagsRaw`^Optional

public readonly tagsRaw: CfnTag[];

Type: aws-cdk-lib.CfnTag[]

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

Constants

Name	Type	Description
`CFN_RESOURCE_TYPE_NAME`	`string`	The CloudFormation resource type name for this resource class.

`CFN_RESOURCE_TYPE_NAME`^Required

public readonly CFN_RESOURCE_TYPE_NAME: string;

Type: string

The CloudFormation resource type name for this resource class.

EKSCluster

Initializers

import { EKSCluster } from '@smallcase/cdk-eks-cluster-module'

new EKSCluster(scope: Construct, id: string, props: EKSClusterProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`props`	`EKSClusterProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: EKSClusterProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`addServiceAccountWithIamRole`	No description.

`toString`

public toString(): string

Returns a string representation of this construct.

`addServiceAccountWithIamRole`

public addServiceAccountWithIamRole(serviceAccountName: string, serviceAccountNamespace: string, policy: any): void

`serviceAccountName`^Required

Type: string

`serviceAccountNamespace`^Required

Type: string

`policy`^Required

Type: any

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { EKSCluster } from '@smallcase/cdk-eks-cluster-module'

EKSCluster.isConstruct(x: any)

Checks if x is a construct.

`x`^Required

Type: any

Any object.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`additionalFargateProfile`	`aws-cdk-lib.aws_eks.FargateProfile[]`	No description.
`additionalNodegroups`	`aws-cdk-lib.aws_eks.Nodegroup[]`	No description.
`cluster`	`aws-cdk-lib.aws_eks.Cluster`	No description.
`fargateProfiles`	`FargateProfile[]`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`additionalFargateProfile`^Required

public readonly additionalFargateProfile: FargateProfile[];

Type: aws-cdk-lib.aws_eks.FargateProfile[]

`additionalNodegroups`^Required

public readonly additionalNodegroups: Nodegroup[];

Type: aws-cdk-lib.aws_eks.Nodegroup[]

`cluster`^Required

public readonly cluster: Cluster;

Type: aws-cdk-lib.aws_eks.Cluster

`fargateProfiles`^Required

public readonly fargateProfiles: FargateProfile[];

Type: FargateProfile[]

KubeProxyAddon

Initializers

import { KubeProxyAddon } from '@smallcase/cdk-eks-cluster-module'

new KubeProxyAddon(scope: Construct, id: string, props: CoreAddonProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`props`	`CoreAddonProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: CoreAddonProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`overrideLogicalId`	Overrides the auto-generated logical ID with a specific ID.
`addDeletionOverride`	Syntactic sugar for `addOverride(path, undefined)`.
`addDependency`	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
`addDependsOn`	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
`addMetadata`	Add a value to the CloudFormation Resource Metadata.
`addOverride`	Adds an override to the synthesized CloudFormation resource.
`addPropertyDeletionOverride`	Adds an override that deletes the value of a property from the resource definition.
`addPropertyOverride`	Adds an override to a resource property.
`applyRemovalPolicy`	Sets the deletion policy of the resource based on the removal policy specified.
`getAtt`	Returns a token for an runtime attribute of this resource.
`getMetadata`	Retrieve a value value from the CloudFormation Resource Metadata.
`obtainDependencies`	Retrieves an array of resources this resource depends on.
`obtainResourceDependencies`	Get a shallow copy of dependencies between this resource and other resources in the same stack.
`removeDependency`	Indicates that this resource no longer depends on another resource.
`replaceDependency`	Replaces one dependency with another.
`inspect`	Examines the CloudFormation resource and discloses attributes.

`toString`

public toString(): string

Returns a string representation of this construct.

`overrideLogicalId`

public overrideLogicalId(newLogicalId: string): void

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

`newLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`addDeletionOverride`

public addDeletionOverride(path: string): void

Syntactic sugar for addOverride(path, undefined).

`path`^Required

Type: string

The path of the value to delete.

`addDependency`

public addDependency(target: CfnResource): void

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.

`target`^Required

Type: aws-cdk-lib.CfnResource

`addDependsOn`

public addDependsOn(target: CfnResource): void

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

`target`^Required

Type: aws-cdk-lib.CfnResource

`addMetadata`

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

Add a value to the CloudFormation Resource Metadata.

[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.](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.)

`key`^Required

Type: string

`value`^Required

Type: any

`addOverride`

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

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.

`path`^Required

Type: string

The path of the property, you can use dot notation to override values in complex types.

Any intermediate keys will be created as needed.

`value`^Required

Type: any

The value.

Could be primitive or complex.

`addPropertyDeletionOverride`

public addPropertyDeletionOverride(propertyPath: string): void

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

`propertyPath`^Required

Type: string

The path to the property.

`addPropertyOverride`

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

Adds an override to a resource property.

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

`propertyPath`^Required

Type: string

The path of the property.

`value`^Required

Type: any

The value.

`applyRemovalPolicy`

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

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

`policy`^Optional

Type: aws-cdk-lib.RemovalPolicy

`options`^Optional

Type: aws-cdk-lib.RemovalPolicyOptions

`getAtt`

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): 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.

`attributeName`^Required

Type: string

The name of the attribute.

`typeHint`^Optional

Type: aws-cdk-lib.ResolutionTypeHint

`getMetadata`

public getMetadata(key: string): any

Retrieve a value value from the CloudFormation Resource Metadata.

[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.](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.)

`key`^Required

Type: string

`obtainDependencies`

public obtainDependencies(): Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

`obtainResourceDependencies`

public obtainResourceDependencies(): CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

`removeDependency`

public removeDependency(target: CfnResource): void

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

`target`^Required

Type: aws-cdk-lib.CfnResource

`replaceDependency`

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Replaces one dependency with another.

`target`^Required

Type: aws-cdk-lib.CfnResource

The dependency to replace.

`newTarget`^Required

Type: aws-cdk-lib.CfnResource

The new dependency to add.

`inspect`

public inspect(inspector: TreeInspector): void

Examines the CloudFormation resource and discloses attributes.

`inspector`^Required

Type: aws-cdk-lib.TreeInspector

tree inspector to collect and process attributes.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isCfnElement`	Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
`isCfnResource`	Check whether the given object is a CfnResource.

`isConstruct`

import { KubeProxyAddon } from '@smallcase/cdk-eks-cluster-module'

KubeProxyAddon.isConstruct(x: any)

Checks if x is a construct.

`x`^Required

Type: any

Any object.

`isCfnElement`

import { KubeProxyAddon } from '@smallcase/cdk-eks-cluster-module'

KubeProxyAddon.isCfnElement(x: any)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

`x`^Required

Type: any

`isCfnResource`

import { KubeProxyAddon } from '@smallcase/cdk-eks-cluster-module'

KubeProxyAddon.isCfnResource(x: any)

Check whether the given object is a CfnResource.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`creationStack`	`string[]`	No description.
`logicalId`	`string`	The logical ID for this CloudFormation stack element.
`stack`	`aws-cdk-lib.Stack`	The stack in which this element is defined.
`ref`	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
`cfnOptions`	`aws-cdk-lib.ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
`cfnResourceType`	`string`	AWS resource type.
`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` .
`tags`	`aws-cdk-lib.TagManager`	Tag Manager which manages the tags for this resource.
`addonName`	`string`	The name of the add-on.
`clusterName`	`string`	The name of your cluster.
`addonVersion`	`string`	The version of the add-on.
`configurationValues`	`string`	The configuration values that you provided.
`podIdentityAssociations`	`aws-cdk-lib.IResolvable \| aws-cdk-lib.IResolvable \| aws-cdk-lib.aws_eks.CfnAddon.PodIdentityAssociationProperty[]`	An array of Pod Identity Assocations owned by the Addon.
`preserveOnDelete`	`boolean \| aws-cdk-lib.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.
`tagsRaw`	`aws-cdk-lib.CfnTag[]`	The metadata that you apply to the add-on to assist with categorization and organization.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

`logicalId`^Required

public readonly logicalId: string;

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

`stack`^Required

public readonly stack: Stack;

Type: aws-cdk-lib.Stack

The stack in which this element is defined.

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

`ref`^Required

public readonly ref: string;

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

`cfnOptions`^Required

public readonly cfnOptions: ICfnResourceOptions;

Type: aws-cdk-lib.ICfnResourceOptions

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

`cfnResourceType`^Required

public readonly cfnResourceType: string;

Type: string

AWS resource type.

`attrArn`^Required

public readonly attrArn: string;

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 .

`tags`^Required

public readonly tags: TagManager;

Type: aws-cdk-lib.TagManager

Tag Manager which manages the tags for this resource.

`addonName`^Required

public readonly addonName: string;

Type: string

The name of the add-on.

`clusterName`^Required

public readonly clusterName: string;

Type: string

The name of your cluster.

`addonVersion`^Optional

public readonly addonVersion: string;

Type: string

The version of the add-on.

`configurationValues`^Optional

public readonly configurationValues: string;

Type: string

The configuration values that you provided.

`podIdentityAssociations`^Optional

public readonly podIdentityAssociations: IResolvable | IResolvable | PodIdentityAssociationProperty[];

Type: aws-cdk-lib.IResolvable | aws-cdk-lib.IResolvable | aws-cdk-lib.aws_eks.CfnAddon.PodIdentityAssociationProperty[]

An array of Pod Identity Assocations owned by the Addon.

`preserveOnDelete`^Optional

public readonly preserveOnDelete: boolean | IResolvable;

Type: boolean | aws-cdk-lib.IResolvable

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

`resolveConflicts`^Optional

public readonly resolveConflicts: string;

Type: string

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

`serviceAccountRoleArn`^Optional

public readonly serviceAccountRoleArn: string;

Type: string

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

`tagsRaw`^Optional

public readonly tagsRaw: CfnTag[];

Type: aws-cdk-lib.CfnTag[]

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

Constants

Name	Type	Description
`CFN_RESOURCE_TYPE_NAME`	`string`	The CloudFormation resource type name for this resource class.

`CFN_RESOURCE_TYPE_NAME`^Required

public readonly CFN_RESOURCE_TYPE_NAME: string;

Type: string

The CloudFormation resource type name for this resource class.

VpcEniAddon

Initializers

import { VpcEniAddon } from '@smallcase/cdk-eks-cluster-module'

new VpcEniAddon(scope: Construct, id: string, props: VpcCniAddonProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`props`	`VpcCniAddonProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: VpcCniAddonProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`overrideLogicalId`	Overrides the auto-generated logical ID with a specific ID.
`addDeletionOverride`	Syntactic sugar for `addOverride(path, undefined)`.
`addDependency`	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
`addDependsOn`	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
`addMetadata`	Add a value to the CloudFormation Resource Metadata.
`addOverride`	Adds an override to the synthesized CloudFormation resource.
`addPropertyDeletionOverride`	Adds an override that deletes the value of a property from the resource definition.
`addPropertyOverride`	Adds an override to a resource property.
`applyRemovalPolicy`	Sets the deletion policy of the resource based on the removal policy specified.
`getAtt`	Returns a token for an runtime attribute of this resource.
`getMetadata`	Retrieve a value value from the CloudFormation Resource Metadata.
`obtainDependencies`	Retrieves an array of resources this resource depends on.
`obtainResourceDependencies`	Get a shallow copy of dependencies between this resource and other resources in the same stack.
`removeDependency`	Indicates that this resource no longer depends on another resource.
`replaceDependency`	Replaces one dependency with another.
`inspect`	Examines the CloudFormation resource and discloses attributes.

`toString`

public toString(): string

Returns a string representation of this construct.

`overrideLogicalId`

public overrideLogicalId(newLogicalId: string): void

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

`newLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`addDeletionOverride`

public addDeletionOverride(path: string): void

Syntactic sugar for addOverride(path, undefined).

`path`^Required

Type: string

The path of the value to delete.

`addDependency`

public addDependency(target: CfnResource): void

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.

`target`^Required

Type: aws-cdk-lib.CfnResource

`addDependsOn`

public addDependsOn(target: CfnResource): void

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

`target`^Required

Type: aws-cdk-lib.CfnResource

`addMetadata`

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

Add a value to the CloudFormation Resource Metadata.

[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.](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.)

`key`^Required

Type: string

`value`^Required

Type: any

`addOverride`

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

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.

`path`^Required

Type: string

The path of the property, you can use dot notation to override values in complex types.

Any intermediate keys will be created as needed.

`value`^Required

Type: any

The value.

Could be primitive or complex.

`addPropertyDeletionOverride`

public addPropertyDeletionOverride(propertyPath: string): void

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

`propertyPath`^Required

Type: string

The path to the property.

`addPropertyOverride`

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

Adds an override to a resource property.

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

`propertyPath`^Required

Type: string

The path of the property.

`value`^Required

Type: any

The value.

`applyRemovalPolicy`

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

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

`policy`^Optional

Type: aws-cdk-lib.RemovalPolicy

`options`^Optional

Type: aws-cdk-lib.RemovalPolicyOptions

`getAtt`

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): 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.

`attributeName`^Required

Type: string

The name of the attribute.

`typeHint`^Optional

Type: aws-cdk-lib.ResolutionTypeHint

`getMetadata`

public getMetadata(key: string): any

Retrieve a value value from the CloudFormation Resource Metadata.

[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.](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.)

`key`^Required

Type: string

`obtainDependencies`

public obtainDependencies(): Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

`obtainResourceDependencies`

public obtainResourceDependencies(): CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

`removeDependency`

public removeDependency(target: CfnResource): void

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

`target`^Required

Type: aws-cdk-lib.CfnResource

`replaceDependency`

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Replaces one dependency with another.

`target`^Required

Type: aws-cdk-lib.CfnResource

The dependency to replace.

`newTarget`^Required

Type: aws-cdk-lib.CfnResource

The new dependency to add.

`inspect`

public inspect(inspector: TreeInspector): void

Examines the CloudFormation resource and discloses attributes.

`inspector`^Required

Type: aws-cdk-lib.TreeInspector

tree inspector to collect and process attributes.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isCfnElement`	Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
`isCfnResource`	Check whether the given object is a CfnResource.

`isConstruct`

import { VpcEniAddon } from '@smallcase/cdk-eks-cluster-module'

VpcEniAddon.isConstruct(x: any)

Checks if x is a construct.

`x`^Required

Type: any

Any object.

`isCfnElement`

import { VpcEniAddon } from '@smallcase/cdk-eks-cluster-module'

VpcEniAddon.isCfnElement(x: any)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

`x`^Required

Type: any

`isCfnResource`

import { VpcEniAddon } from '@smallcase/cdk-eks-cluster-module'

VpcEniAddon.isCfnResource(x: any)

Check whether the given object is a CfnResource.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`creationStack`	`string[]`	No description.
`logicalId`	`string`	The logical ID for this CloudFormation stack element.
`stack`	`aws-cdk-lib.Stack`	The stack in which this element is defined.
`ref`	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
`cfnOptions`	`aws-cdk-lib.ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
`cfnResourceType`	`string`	AWS resource type.
`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` .
`tags`	`aws-cdk-lib.TagManager`	Tag Manager which manages the tags for this resource.
`addonName`	`string`	The name of the add-on.
`clusterName`	`string`	The name of your cluster.
`addonVersion`	`string`	The version of the add-on.
`configurationValues`	`string`	The configuration values that you provided.
`podIdentityAssociations`	`aws-cdk-lib.IResolvable \| aws-cdk-lib.IResolvable \| aws-cdk-lib.aws_eks.CfnAddon.PodIdentityAssociationProperty[]`	An array of Pod Identity Assocations owned by the Addon.
`preserveOnDelete`	`boolean \| aws-cdk-lib.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.
`tagsRaw`	`aws-cdk-lib.CfnTag[]`	The metadata that you apply to the add-on to assist with categorization and organization.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

`logicalId`^Required

public readonly logicalId: string;

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

`stack`^Required

public readonly stack: Stack;

Type: aws-cdk-lib.Stack

The stack in which this element is defined.

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

`ref`^Required

public readonly ref: string;

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

`cfnOptions`^Required

public readonly cfnOptions: ICfnResourceOptions;

Type: aws-cdk-lib.ICfnResourceOptions

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

`cfnResourceType`^Required

public readonly cfnResourceType: string;

Type: string

AWS resource type.

`attrArn`^Required

public readonly attrArn: string;

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 .

`tags`^Required

public readonly tags: TagManager;

Type: aws-cdk-lib.TagManager

Tag Manager which manages the tags for this resource.

`addonName`^Required

public readonly addonName: string;

Type: string

The name of the add-on.

`clusterName`^Required

public readonly clusterName: string;

Type: string

The name of your cluster.

`addonVersion`^Optional

public readonly addonVersion: string;

Type: string

The version of the add-on.

`configurationValues`^Optional

public readonly configurationValues: string;

Type: string

The configuration values that you provided.

`podIdentityAssociations`^Optional

public readonly podIdentityAssociations: IResolvable | IResolvable | PodIdentityAssociationProperty[];

Type: aws-cdk-lib.IResolvable | aws-cdk-lib.IResolvable | aws-cdk-lib.aws_eks.CfnAddon.PodIdentityAssociationProperty[]

An array of Pod Identity Assocations owned by the Addon.

`preserveOnDelete`^Optional

public readonly preserveOnDelete: boolean | IResolvable;

Type: boolean | aws-cdk-lib.IResolvable

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

`resolveConflicts`^Optional

public readonly resolveConflicts: string;

Type: string

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

`serviceAccountRoleArn`^Optional

public readonly serviceAccountRoleArn: string;

Type: string

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

`tagsRaw`^Optional

public readonly tagsRaw: CfnTag[];

Type: aws-cdk-lib.CfnTag[]

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

Constants

Name	Type	Description
`CFN_RESOURCE_TYPE_NAME`	`string`	The CloudFormation resource type name for this resource class.

`CFN_RESOURCE_TYPE_NAME`^Required

public readonly CFN_RESOURCE_TYPE_NAME: string;

Type: string

The CloudFormation resource type name for this resource class.

Structs

AddonProps

Initializer

import { AddonProps } from '@smallcase/cdk-eks-cluster-module'

const addonProps: AddonProps = { ... }

Properties

Name	Type	Description
`configurationValues`	`string`	No description.
`vpnCniAddonVersion`	`VpcCniAddonVersion`	No description.

`configurationValues`^Optional

public readonly configurationValues: string;

Type: string

`vpnCniAddonVersion`^Optional

public readonly vpnCniAddonVersion: VpcCniAddonVersion;

Type: VpcCniAddonVersion

ArgoCD

Initializer

import { ArgoCD } from '@smallcase/cdk-eks-cluster-module'

const argoCD: ArgoCD = { ... }

Properties

Name	Type	Description
`assumeRoleArn`	`string`	No description.
`clusterRoleName`	`string`	No description.

`assumeRoleArn`^Required

public readonly assumeRoleArn: string;

Type: string

`clusterRoleName`^Required

public readonly clusterRoleName: string;

Type: string

ClusterConfig

Initializer

import { ClusterConfig } from '@smallcase/cdk-eks-cluster-module'

const clusterConfig: ClusterConfig = { ... }

Properties

Name	Type	Description
`clusterName`	`string`	No description.
`clusterVersion`	`aws-cdk-lib.aws_eks.KubernetesVersion`	No description.
`defaultCapacity`	`number`	No description.
`nodeGroups`	`NodeGroupConfig[]`	No description.
`subnets`	`InternalMap`	No description.
`tags`	`InternalMap`	No description.
`teamMembers`	`string[]`	No description.
`addAutoscalerIam`	`boolean`	No description.
`albControllerVersion`	`aws-cdk-lib.aws_eks.AlbControllerVersion`	No description.
`argoCD`	`ArgoCD`	No description.
`commonComponents`	`{[ key: string ]: ICommonComponentsProps}`	No description.
`debugLogs`	`boolean`	No description.
`defaultCommonComponents`	`DefaultCommonComponents`	No description.
`deprecateClusterAutoScaler`	`boolean`	No description.
`fargateProfiles`	`FargateProfile[]`	No description.
`kubectlLayer`	`aws-cdk-lib.aws_lambda.ILayerVersion`	No description.
`namespaces`	`{[ key: string ]: NamespaceSpec}`	No description.
`publicAllowAccess`	`string[]`	No description.
`skipExternalDNS`	`boolean`	No description.
`teamExistingRolePermission`	`{[ key: string ]: string}`	No description.

`clusterName`^Required

public readonly clusterName: string;

Type: string

`clusterVersion`^Required

public readonly clusterVersion: KubernetesVersion;

Type: aws-cdk-lib.aws_eks.KubernetesVersion

`defaultCapacity`^Required

public readonly defaultCapacity: number;

Type: number

`nodeGroups`^Required

public readonly nodeGroups: NodeGroupConfig[];

Type: NodeGroupConfig[]

`subnets`^Required

public readonly subnets: InternalMap;

Type: InternalMap

`tags`^Required

public readonly tags: InternalMap;

Type: InternalMap

`teamMembers`^Required

public readonly teamMembers: string[];

Type: string[]

`addAutoscalerIam`^Optional

public readonly addAutoscalerIam: boolean;

Type: boolean

`albControllerVersion`^Optional

public readonly albControllerVersion: AlbControllerVersion;

Type: aws-cdk-lib.aws_eks.AlbControllerVersion

`argoCD`^Optional

public readonly argoCD: ArgoCD;

Type: ArgoCD

`commonComponents`^Optional

public readonly commonComponents: {[ key: string ]: ICommonComponentsProps};

Type: {[ key: string ]: ICommonComponentsProps}

`debugLogs`^Optional

public readonly debugLogs: boolean;

Type: boolean

`defaultCommonComponents`^Optional

public readonly defaultCommonComponents: DefaultCommonComponents;

Type: DefaultCommonComponents

`deprecateClusterAutoScaler`^Optional

public readonly deprecateClusterAutoScaler: boolean;

Type: boolean

`fargateProfiles`^Optional

public readonly fargateProfiles: FargateProfile[];

Type: FargateProfile[]

`kubectlLayer`^Optional

public readonly kubectlLayer: ILayerVersion;

Type: aws-cdk-lib.aws_lambda.ILayerVersion

`namespaces`^Optional

public readonly namespaces: {[ key: string ]: NamespaceSpec};

Type: {[ key: string ]: NamespaceSpec}

`publicAllowAccess`^Optional

public readonly publicAllowAccess: string[];

Type: string[]

`skipExternalDNS`^Optional

public readonly skipExternalDNS: boolean;

Type: boolean

`teamExistingRolePermission`^Optional

public readonly teamExistingRolePermission: {[ key: string ]: string};

Type: {[ key: string ]: string}

CommonHelmChartsProps

Initializer

import { CommonHelmChartsProps } from '@smallcase/cdk-eks-cluster-module'

const commonHelmChartsProps: CommonHelmChartsProps = { ... }

Properties

Name	Type	Description
`cluster`	`aws-cdk-lib.aws_eks.ICluster`	No description.
`helmProps`	`StandardHelmProps`	No description.
`dependentNamespaces`	`aws-cdk-lib.aws_eks.KubernetesManifest[]`	No description.
`iamPolicyPath`	`string[]`	No description.
`logCharts`	`boolean`	No description.
`serviceAccounts`	`string[]`	No description.

`cluster`^Required

public readonly cluster: ICluster;

Type: aws-cdk-lib.aws_eks.ICluster

`helmProps`^Required

public readonly helmProps: StandardHelmProps;

Type: StandardHelmProps

`dependentNamespaces`^Optional

public readonly dependentNamespaces: KubernetesManifest[];

Type: aws-cdk-lib.aws_eks.KubernetesManifest[]

`iamPolicyPath`^Optional

public readonly iamPolicyPath: string[];

Type: string[]

`logCharts`^Optional

public readonly logCharts: boolean;

Type: boolean

`serviceAccounts`^Optional

public readonly serviceAccounts: string[];

Type: string[]

CoreAddonProps

Initializer

import { CoreAddonProps } from '@smallcase/cdk-eks-cluster-module'

const coreAddonProps: CoreAddonProps = { ... }

Properties

Name	Type	Description
`cluster`	`aws-cdk-lib.aws_eks.Cluster`	No description.
`addonVersion`	`string`	No description.
`configurationValues`	`string`	No description.
`namespace`	`string`	No description.
`resolveConflicts`	`boolean`	No description.

`cluster`^Required

public readonly cluster: Cluster;

Type: aws-cdk-lib.aws_eks.Cluster

`addonVersion`^Optional

public readonly addonVersion: string;

Type: string

`configurationValues`^Optional

public readonly configurationValues: string;

Type: string

`namespace`^Optional

public readonly namespace: string;

Type: string

`resolveConflicts`^Optional

public readonly resolveConflicts: boolean;

Type: boolean

CoreAddonValuesProps

Initializer

import { CoreAddonValuesProps } from '@smallcase/cdk-eks-cluster-module'

const coreAddonValuesProps: CoreAddonValuesProps = { ... }

Properties

Name	Type	Description
`addonVersion`	`string`	No description.
`configurationValues`	`string`	No description.

`addonVersion`^Optional

public readonly addonVersion: string;

Type: string

`configurationValues`^Optional

public readonly configurationValues: string;

Type: string

DefaultCommonComponents

Initializer

import { DefaultCommonComponents } from '@smallcase/cdk-eks-cluster-module'

const defaultCommonComponents: DefaultCommonComponents = { ... }

Properties

Name	Type	Description
`awsEbsCsiDriver`	`DefaultCommonComponentsProps`	No description.
`awsEfsCsiDriver`	`DefaultCommonComponentsProps`	No description.
`clusterAutoscaler`	`DefaultCommonComponentsProps`	No description.
`externalDns`	`DefaultCommonComponentsProps`	No description.

`awsEbsCsiDriver`^Optional

public readonly awsEbsCsiDriver: DefaultCommonComponentsProps;

Type: DefaultCommonComponentsProps

`awsEfsCsiDriver`^Optional

public readonly awsEfsCsiDriver: DefaultCommonComponentsProps;

Type: DefaultCommonComponentsProps

`clusterAutoscaler`^Optional

public readonly clusterAutoscaler: DefaultCommonComponentsProps;

Type: DefaultCommonComponentsProps

`externalDns`^Optional

public readonly externalDns: DefaultCommonComponentsProps;

Type: DefaultCommonComponentsProps

DefaultCommonComponentsProps

Initializer

import { DefaultCommonComponentsProps } from '@smallcase/cdk-eks-cluster-module'

const defaultCommonComponentsProps: DefaultCommonComponentsProps = { ... }

Properties

Name	Type	Description
`namespace`	`string`	No description.

`namespace`^Optional

public readonly namespace: string;

Type: string

EKSClusterProps

Initializer

import { EKSClusterProps } from '@smallcase/cdk-eks-cluster-module'

const eKSClusterProps: EKSClusterProps = { ... }

Properties

Name	Type	Description
`availabilityZones`	`string[]`	No description.
`clusterConfig`	`ClusterConfig`	No description.
`kmsKey`	`aws-cdk-lib.aws_kms.Key`	No description.
`region`	`string`	No description.
`workerSecurityGroup`	`aws-cdk-lib.aws_ec2.SecurityGroup`	No description.
`addonProps`	`AddonProps`	No description.
`clusterVPC`	`aws-cdk-lib.aws_ec2.IVpc`	No description.
`coreDnsAddonProps`	`CoreAddonValuesProps`	No description.
`kubeProxyAddonProps`	`CoreAddonValuesProps`	No description.

`availabilityZones`^Required

public readonly availabilityZones: string[];

Type: string[]

`clusterConfig`^Required

public readonly clusterConfig: ClusterConfig;

Type: ClusterConfig

`kmsKey`^Required

public readonly kmsKey: Key;

Type: aws-cdk-lib.aws_kms.Key

`region`^Required

public readonly region: string;

Type: string

`workerSecurityGroup`^Required

public readonly workerSecurityGroup: SecurityGroup;

Type: aws-cdk-lib.aws_ec2.SecurityGroup

`addonProps`^Optional

public readonly addonProps: AddonProps;

Type: AddonProps

`clusterVPC`^Optional

public readonly clusterVPC: IVpc;

Type: aws-cdk-lib.aws_ec2.IVpc

`coreDnsAddonProps`^Optional

public readonly coreDnsAddonProps: CoreAddonValuesProps;

Type: CoreAddonValuesProps

`kubeProxyAddonProps`^Optional

public readonly kubeProxyAddonProps: CoreAddonValuesProps;

Type: CoreAddonValuesProps

FargateProfile

Initializer

import { FargateProfile } from '@smallcase/cdk-eks-cluster-module'

const fargateProfile: FargateProfile = { ... }

Properties

Name	Type	Description
`namespaces`	`string[]`	No description.
`profileName`	`string`	No description.
`labels`	`InternalMap`	No description.
`podExecutionRole`	`aws-cdk-lib.aws_iam.Role`	No description.
`subnetSelection`	`aws-cdk-lib.aws_ec2.SubnetSelection`	No description.

`namespaces`^Required

public readonly namespaces: string[];

Type: string[]

`profileName`^Required

public readonly profileName: string;

Type: string

`labels`^Optional

public readonly labels: InternalMap;

Type: InternalMap

`podExecutionRole`^Optional

public readonly podExecutionRole: Role;

Type: aws-cdk-lib.aws_iam.Role

`subnetSelection`^Optional

public readonly subnetSelection: SubnetSelection;

Type: aws-cdk-lib.aws_ec2.SubnetSelection

InternalMap

Initializer

import { InternalMap } from '@smallcase/cdk-eks-cluster-module'

const internalMap: InternalMap = { ... }

NamespaceSpec

Initializer

import { NamespaceSpec } from '@smallcase/cdk-eks-cluster-module'

const namespaceSpec: NamespaceSpec = { ... }

Properties

Name	Type	Description
`annotations`	`InternalMap`	No description.
`labels`	`InternalMap`	No description.

`annotations`^Optional

public readonly annotations: InternalMap;

Type: InternalMap

`labels`^Optional

public readonly labels: InternalMap;

Type: InternalMap

NodeGroupConfig

Initializer

import { NodeGroupConfig } from '@smallcase/cdk-eks-cluster-module'

const nodeGroupConfig: NodeGroupConfig = { ... }

Properties

Name	Type	Description
`instanceTypes`	`aws-cdk-lib.aws_ec2.InstanceType[]`	No description.
`labels`	`InternalMap`	No description.
`maxSize`	`number`	No description.
`minSize`	`number`	No description.
`name`	`string`	No description.
`subnetGroupName`	`string`	No description.
`taints`	`InternalMap`	No description.
`capacityType`	`aws-cdk-lib.aws_eks.CapacityType`	No description.
`desiredSize`	`number`	No description.
`diskSize`	`number`	No description.
`launchTemplateSpec`	`aws-cdk-lib.aws_eks.LaunchTemplateSpec`	No description.
`nodeAMIVersion`	`string`	No description.
`sshKeyName`	`string`	No description.
`subnetAz`	`string[]`	No description.
`tags`	`InternalMap`	No description.

`instanceTypes`^Required

public readonly instanceTypes: InstanceType[];

Type: aws-cdk-lib.aws_ec2.InstanceType[]

`labels`^Required

public readonly labels: InternalMap;

Type: InternalMap

`maxSize`^Required

public readonly maxSize: number;

Type: number

`minSize`^Required

public readonly minSize: number;

Type: number

`name`^Required

public readonly name: string;

Type: string

`subnetGroupName`^Required

public readonly subnetGroupName: string;

Type: string

`taints`^Required

public readonly taints: InternalMap;

Type: InternalMap

`capacityType`^Optional

public readonly capacityType: CapacityType;

Type: aws-cdk-lib.aws_eks.CapacityType

`desiredSize`^Optional

public readonly desiredSize: number;

Type: number

`diskSize`^Optional

public readonly diskSize: number;

Type: number

`launchTemplateSpec`^Optional

public readonly launchTemplateSpec: LaunchTemplateSpec;

Type: aws-cdk-lib.aws_eks.LaunchTemplateSpec

`nodeAMIVersion`^Optional

public readonly nodeAMIVersion: string;

Type: string

`sshKeyName`^Optional

public readonly sshKeyName: string;

Type: string

`subnetAz`^Optional

public readonly subnetAz: string[];

Type: string[]

`tags`^Optional

public readonly tags: InternalMap;

Type: InternalMap

StandardHelmProps

Initializer

import { StandardHelmProps } from '@smallcase/cdk-eks-cluster-module'

const standardHelmProps: StandardHelmProps = { ... }

Properties

Name	Type	Description
`chartName`	`string`	No description.
`chartReleaseName`	`string`	No description.
`chartVersion`	`string`	No description.
`createNamespace`	`boolean`	No description.
`helmRepository`	`string`	No description.
`helmValues`	`{[ key: string ]: any}`	No description.
`localHelmChart`	`string`	No description.
`namespace`	`string`	No description.

`chartName`^Required

public readonly chartName: string;

Type: string

`chartReleaseName`^Optional

public readonly chartReleaseName: string;

Type: string

`chartVersion`^Optional

public readonly chartVersion: string;

Type: string

`createNamespace`^Optional

public readonly createNamespace: boolean;

Type: boolean

`helmRepository`^Optional

public readonly helmRepository: string;

Type: string

`helmValues`^Optional

public readonly helmValues: {[ key: string ]: any};

Type: {[ key: string ]: any}

`localHelmChart`^Optional

public readonly localHelmChart: string;

Type: string

`namespace`^Optional

public readonly namespace: string;

Type: string

VpcCniAddonProps

Initializer

import { VpcCniAddonProps } from '@smallcase/cdk-eks-cluster-module'

const vpcCniAddonProps: VpcCniAddonProps = { ... }

Properties

Name	Type	Description
`cluster`	`aws-cdk-lib.aws_eks.Cluster`	No description.
`addonVersion`	`VpcCniAddonVersion`	No description.
`configurationValues`	`string`	No description.
`namespace`	`string`	No description.
`resolveConflicts`	`boolean`	No description.

`cluster`^Required

public readonly cluster: Cluster;

Type: aws-cdk-lib.aws_eks.Cluster

`addonVersion`^Optional

public readonly addonVersion: VpcCniAddonVersion;

Type: VpcCniAddonVersion

`configurationValues`^Optional

public readonly configurationValues: string;

Type: string

`namespace`^Optional

public readonly namespace: string;

Type: string

`resolveConflicts`^Optional

public readonly resolveConflicts: boolean;

Type: boolean

Classes

VpcCniAddonVersion

Initializers

import { VpcCniAddonVersion } from '@smallcase/cdk-eks-cluster-module'

new VpcCniAddonVersion(version: string)

Name	Type	Description
`version`	`string`	No description.

`version`^Required

Type: string

Static Functions

Name	Description
`of`	Custom add-on version.

`of`

import { VpcCniAddonVersion } from '@smallcase/cdk-eks-cluster-module'

VpcCniAddonVersion.of(version: string)

Custom add-on version.

`version`^Required

Type: string

custom add-on version.

Properties

Name	Type	Description
`version`	`string`	No description.

`version`^Required

public readonly version: string;

Type: string

Constants

Name	Type	Description
`V1_10_1`	`VpcCniAddonVersion`	vpc-cni version 1.10.1.
`V1_10_2`	`VpcCniAddonVersion`	vpc-cni version 1.10.2.
`V1_10_3`	`VpcCniAddonVersion`	vpc-cni version 1.10.3.
`V1_11_0`	`VpcCniAddonVersion`	vpc-cni version 1.11.0.
`V1_11_2`	`VpcCniAddonVersion`	vpc-cni version 1.11.2.
`V1_11_3`	`VpcCniAddonVersion`	vpc-cni version 1.11.3.
`V1_11_4`	`VpcCniAddonVersion`	vpc-cni version 1.11.4.
`V1_12_0`	`VpcCniAddonVersion`	vpc-cni version 1.12.0.
`V1_12_1`	`VpcCniAddonVersion`	vpc-cni version 1.12.1.
`V1_12_2`	`VpcCniAddonVersion`	vpc-cni version 1.12.2.
`V1_12_5`	`VpcCniAddonVersion`	vpc-cni version 1.12.5.
`V1_12_5_2`	`VpcCniAddonVersion`	vpc-cni version 1.12.5.2.
`V1_17_1_1`	`VpcCniAddonVersion`	vpc-cni version 1.17.1.1.
`V1_6_3`	`VpcCniAddonVersion`	vpc-cni version 1.6.3.
`V1_7_10`	`VpcCniAddonVersion`	vpc-cni version 1.7.10.
`V1_7_5`	`VpcCniAddonVersion`	vpc-cni version 1.7.5.
`V1_7_6`	`VpcCniAddonVersion`	vpc-cni version 1.7.6.
`V1_7_9`	`VpcCniAddonVersion`	vpc-cni version 1.7.9.
`V1_8_0`	`VpcCniAddonVersion`	vpc-cni version 1.8.0.
`V1_9_0`	`VpcCniAddonVersion`	vpc-cni version 1.9.0.
`V1_9_1`	`VpcCniAddonVersion`	vpc-cni version 1.9.1.
`V1_9_3`	`VpcCniAddonVersion`	vpc-cni version 1.9.3.

`V1_10_1`^Required

public readonly V1_10_1: VpcCniAddonVersion;

Type: VpcCniAddonVersion

vpc-cni version 1.10.1.

`V1_10_2`^Required

public readonly V1_10_2: VpcCniAddonVersion;

Type: VpcCniAddonVersion

vpc-cni version 1.10.2.

`V1_10_3`^Required

public readonly V1_10_3: VpcCniAddonVersion;

Type: VpcCniAddonVersion

vpc-cni version 1.10.3.

`V1_11_0`^Required

public readonly V1_11_0: VpcCniAddonVersion;

Type: VpcCniAddonVersion

vpc-cni version 1.11.0.

`V1_11_2`^Required

public readonly V1_11_2: VpcCniAddonVersion;

Type: VpcCniAddonVersion

vpc-cni version 1.11.2.

`V1_11_3`^Required

public readonly V1_11_3: VpcCniAddonVersion;

Type: VpcCniAddonVersion

vpc-cni version 1.11.3.

`V1_11_4`^Required

public readonly V1_11_4: VpcCniAddonVersion;

Type: VpcCniAddonVersion

vpc-cni version 1.11.4.

`V1_12_0`^Required

public readonly V1_12_0: VpcCniAddonVersion;

Type: VpcCniAddonVersion

vpc-cni version 1.12.0.

`V1_12_1`^Required

public readonly V1_12_1: VpcCniAddonVersion;

Type: VpcCniAddonVersion

vpc-cni version 1.12.1.

`V1_12_2`^Required

public readonly V1_12_2: VpcCniAddonVersion;

Type: VpcCniAddonVersion

vpc-cni version 1.12.2.

`V1_12_5`^Required

public readonly V1_12_5: VpcCniAddonVersion;

Type: VpcCniAddonVersion

vpc-cni version 1.12.5.

`V1_12_5_2`^Required

public readonly V1_12_5_2: VpcCniAddonVersion;

Type: VpcCniAddonVersion

vpc-cni version 1.12.5.2.

`V1_17_1_1`^Required

public readonly V1_17_1_1: VpcCniAddonVersion;

Type: VpcCniAddonVersion

vpc-cni version 1.17.1.1.

`V1_6_3`^Required

public readonly V1_6_3: VpcCniAddonVersion;

Type: VpcCniAddonVersion

vpc-cni version 1.6.3.

`V1_7_10`^Required

public readonly V1_7_10: VpcCniAddonVersion;

Type: VpcCniAddonVersion

vpc-cni version 1.7.10.

`V1_7_5`^Required

public readonly V1_7_5: VpcCniAddonVersion;

Type: VpcCniAddonVersion

vpc-cni version 1.7.5.

`V1_7_6`^Required

public readonly V1_7_6: VpcCniAddonVersion;

Type: VpcCniAddonVersion

vpc-cni version 1.7.6.

`V1_7_9`^Required

public readonly V1_7_9: VpcCniAddonVersion;

Type: VpcCniAddonVersion

vpc-cni version 1.7.9.

`V1_8_0`^Required

public readonly V1_8_0: VpcCniAddonVersion;

Type: VpcCniAddonVersion

vpc-cni version 1.8.0.

`V1_9_0`^Required

public readonly V1_9_0: VpcCniAddonVersion;

Type: VpcCniAddonVersion

vpc-cni version 1.9.0.

`V1_9_1`^Required

public readonly V1_9_1: VpcCniAddonVersion;

Type: VpcCniAddonVersion

vpc-cni version 1.9.1.

`V1_9_3`^Required

public readonly V1_9_3: VpcCniAddonVersion;

Type: VpcCniAddonVersion

vpc-cni version 1.9.3.

Protocols

ICommonComponentsProps

Implemented By: ICommonComponentsProps

Properties

Name	Type	Description
`helm`	`StandardHelmProps`	No description.
`iamPolicyPath`	`string[]`	No description.
`serviceAccounts`	`string[]`	No description.

`helm`^Required

public readonly helm: StandardHelmProps;

Type: StandardHelmProps

`iamPolicyPath`^Optional

public readonly iamPolicyPath: string[];

Type: string[]

`serviceAccounts`^Optional

public readonly serviceAccounts: string[];

Type: string[]

Files

API.md

Latest commit

History

API.md

File metadata and controls

API Reference

Constructs

CommonHelmCharts

Initializers

scopeRequired

idRequired

propsRequired

Methods

toString

Static Functions

isConstruct

xRequired

Properties

nodeRequired

CoreDnsAddon

Initializers

scopeRequired

idRequired

propsRequired

Methods

toString

overrideLogicalId

newLogicalIdRequired

addDeletionOverride

pathRequired

addDependency

targetRequired

addDependsOn

targetRequired

addMetadata

keyRequired

valueRequired

addOverride

pathRequired

valueRequired

addPropertyDeletionOverride

propertyPathRequired

addPropertyOverride

propertyPathRequired

valueRequired

applyRemovalPolicy

policyOptional

optionsOptional

getAtt

attributeNameRequired

typeHintOptional

getMetadata

keyRequired

obtainDependencies

obtainResourceDependencies

removeDependency

targetRequired

replaceDependency

targetRequired

newTargetRequired

inspect

inspectorRequired

Static Functions

isConstruct

xRequired

isCfnElement

xRequired

isCfnResource

xRequired

Properties

nodeRequired

creationStackRequired

logicalIdRequired

stackRequired

refRequired

cfnOptionsRequired

cfnResourceTypeRequired

attrArnRequired

tagsRequired

`scope`^Required

`id`^Required

`props`^Required

`toString`

`isConstruct`

`x`^Required

`node`^Required

`scope`^Required

`id`^Required

`props`^Required

`toString`

`overrideLogicalId`

`newLogicalId`^Required

`addDeletionOverride`

`path`^Required

`addDependency`

`target`^Required

`addDependsOn`

`target`^Required

`addMetadata`

`key`^Required

`value`^Required

`addOverride`

`path`^Required

`value`^Required

`addPropertyDeletionOverride`

`propertyPath`^Required

`addPropertyOverride`

`propertyPath`^Required

`value`^Required

`applyRemovalPolicy`

`policy`^Optional

`options`^Optional

`getAtt`

`attributeName`^Required

`typeHint`^Optional

`getMetadata`

`key`^Required

`obtainDependencies`

`obtainResourceDependencies`

`removeDependency`

`target`^Required

`replaceDependency`

`target`^Required

`newTarget`^Required

`inspect`

`inspector`^Required

`isConstruct`

`x`^Required

`isCfnElement`

`x`^Required

`isCfnResource`

`x`^Required

`node`^Required

`creationStack`^Required

`logicalId`^Required

`stack`^Required

`ref`^Required

`cfnOptions`^Required

`cfnResourceType`^Required

`attrArn`^Required

`tags`^Required

`addonName`^Required

`clusterName`^Required

`addonVersion`^Optional

`configurationValues`^Optional

`podIdentityAssociations`^Optional

`preserveOnDelete`^Optional

`resolveConflicts`^Optional

`serviceAccountRoleArn`^Optional

`tagsRaw`^Optional

`CFN_RESOURCE_TYPE_NAME`^Required

`scope`^Required

`id`^Required

`props`^Required

`toString`

`addServiceAccountWithIamRole`

`serviceAccountName`^Required

`serviceAccountNamespace`^Required

`policy`^Required