class Cluster (construct) 🔹

Language	Type name
.NET	`Amazon.CDK.AWS.Eks.V2.Alpha.Cluster`
Go	`github.com/aws/aws-cdk-go/awscdkeksv2alpha/v2#Cluster`
Java	`software.amazon.awscdk.services.eks.v2.alpha.Cluster`
Python	`aws_cdk.aws_eks_v2_alpha.Cluster`
TypeScript (source)	`@aws-cdk/aws-eks-v2-alpha` » `Cluster`

Implements IConstruct, IDependable, IResource, IEnvironmentAware, ICluster, IConnectable

A Cluster represents a managed Kubernetes Service (EKS).

This is a fully managed cluster of API Servers (control-plane) The user is still required to create the worker nodes.

Example

const cluster = new eks.Cluster(this, 'ManagedNodeCluster', {
  version: eks.KubernetesVersion.V1_34,
  defaultCapacityType: eks.DefaultCapacityType.NODEGROUP,
});

// Add a Fargate Profile for specific workloads (e.g., default namespace)
cluster.addFargateProfile('FargateProfile', {
  selectors: [
    { namespace: 'default' }, // Run pods in 'default' on Fargate
],
});

Initializer

new Cluster(scope: Construct, id: string, props: ClusterProps)

Parameters

scope Construct — a Construct, most likely a cdk.Stack created.
id string — the id of the Construct to create.
props ClusterProps — properties in the IClusterProps interface.

Initiates an EKS Cluster with the supplied arguments.

Construct Props

Name	Type	Description
version🔹	`KubernetesVersion`	The Kubernetes version to run in the cluster.
albController?🔹	`AlbControllerOptions`	Install the AWS Load Balancer Controller onto the cluster.
bootstrapClusterCreatorAdminPermissions?🔹	`boolean`	Whether or not IAM principal of the cluster creator was set as a cluster admin access entry during cluster creation time.
clusterLogging?🔹	`ClusterLoggingTypes[]`	The cluster log types which you want to enable.
clusterName?🔹	`string`	Name for the cluster.
compute?🔹	`ComputeConfig`	Configuration for compute settings in Auto Mode.
coreDnsComputeType?🔹	`CoreDnsComputeType`	Controls the "eks.amazonaws.com/compute-type" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS.
defaultCapacity?🔹	`number`	Number of instances to allocate as an initial capacity for this cluster.
defaultCapacityInstance?🔹	`InstanceType`	The instance type to use for the default capacity.
defaultCapacityType?🔹	`DefaultCapacityType`	The default capacity type for the cluster.
endpointAccess?🔹	`EndpointAccess`	Configure access to the Kubernetes API server endpoint..
ipFamily?🔹	`IpFamily`	Specify which IP family is used to assign Kubernetes pod and service IP addresses.
kubectlProviderOptions?🔹	`KubectlProviderOptions`	Options for creating the kubectl provider - a lambda function that executes `kubectl` and `helm` against the cluster.
mastersRole?🔹	`IRole`	An IAM role that will be added to the `system:masters` Kubernetes RBAC group.
outputConfigCommand?🔹	`boolean`	Determines whether a CloudFormation output with the `aws eks update-kubeconfig` command will be synthesized.
prune?🔹	`boolean`	Indicates whether Kubernetes resources added through `addManifest()` can be automatically pruned.
role?🔹	`IRole`	Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
secretsEncryptionKey?🔹	`IKeyRef`	KMS secret for envelope encryption for Kubernetes secrets.
securityGroup?🔹	`ISecurityGroup`	Security Group to use for Control Plane ENIs.
serviceIpv4Cidr?🔹	`string`	The CIDR block to assign Kubernetes service IP addresses from.
tags?🔹	`{ [string]: string }`	The tags assigned to the EKS cluster.
vpc?🔹	`IVpc`	The VPC in which to create the Cluster.
vpcSubnets?🔹	`SubnetSelection[]`	Where to place EKS Control Plane ENIs.

version🔹

Type: KubernetesVersion

The Kubernetes version to run in the cluster.

albController?🔹

Type: AlbControllerOptions (optional, default: The controller is not installed.)

Install the AWS Load Balancer Controller onto the cluster.

bootstrapClusterCreatorAdminPermissions?🔹

Type: boolean (optional, default: true)

Whether or not IAM principal of the cluster creator was set as a cluster admin access entry during cluster creation time.

Changing this value after the cluster has been created will result in the cluster being replaced.

clusterLogging?🔹

Type: ClusterLoggingTypes[] (optional, default: none)

The cluster log types which you want to enable.

clusterName?🔹

Type: string (optional, default: Automatically generated name)

Name for the cluster.

compute?🔹

Type: ComputeConfig (optional, default: Auto Mode compute disabled)

Configuration for compute settings in Auto Mode.

When enabled, EKS will automatically manage compute resources.

coreDnsComputeType?🔹

Type: CoreDnsComputeType (optional, default: CoreDnsComputeType.EC2 (for FargateCluster the default is FARGATE))

Controls the "eks.amazonaws.com/compute-type" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS.

defaultCapacity?🔹

Type: number (optional, default: 2)

Number of instances to allocate as an initial capacity for this cluster.

Instance type can be configured through defaultCapacityInstanceType, which defaults to m5.large.

Use cluster.addAutoScalingGroupCapacity to add additional customized capacity. Set this to 0 is you wish to avoid the initial capacity allocation.

defaultCapacityInstance?🔹

Type: InstanceType (optional, default: m5.large)

The instance type to use for the default capacity.

This will only be taken into account if defaultCapacity is > 0.

defaultCapacityType?🔹

Type: DefaultCapacityType (optional, default: AUTOMODE)

The default capacity type for the cluster.

endpointAccess?🔹

Type: EndpointAccess (optional, default: EndpointAccess.PUBLIC_AND_PRIVATE)

Configure access to the Kubernetes API server endpoint..

ipFamily?🔹

Type: IpFamily (optional, default: IpFamily.IP_V4)

Specify which IP family is used to assign Kubernetes pod and service IP addresses.

kubectlProviderOptions?🔹

Type: KubectlProviderOptions (optional)

Options for creating the kubectl provider - a lambda function that executes kubectl and helm against the cluster.

If defined, kubectlLayer is a required property.

If not defined, kubectl provider will not be created by default.

mastersRole?🔹

Type: IRole (optional, default: no masters role.)

An IAM role that will be added to the system:masters Kubernetes RBAC group.

outputConfigCommand?🔹

Type: boolean (optional, default: true)

Determines whether a CloudFormation output with the aws eks update-kubeconfig command will be synthesized.

This command will include the cluster name and, if applicable, the ARN of the masters IAM role.

prune?🔹

Type: boolean (optional, default: true)

Indicates whether Kubernetes resources added through addManifest() can be automatically pruned.

When this is enabled (default), prune labels will be allocated and injected to each resource. These labels will then be used when issuing the kubectl apply operation with the --prune switch.

role?🔹

Type: IRole (optional, default: A role is automatically created for you)

Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

secretsEncryptionKey?🔹

Type: IKeyRef (optional, default: By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys.)

KMS secret for envelope encryption for Kubernetes secrets.

securityGroup?🔹

Type: ISecurityGroup (optional, default: A security group is automatically created)

Security Group to use for Control Plane ENIs.

serviceIpv4Cidr?🔹

Type: string (optional, default: Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks)

The CIDR block to assign Kubernetes service IP addresses from.

tags?🔹

Type: { [string]: string } (optional, default: none)

The tags assigned to the EKS cluster.

vpc?🔹

Type: IVpc (optional, default: a VPC with default configuration will be created and can be accessed through cluster.vpc.)

The VPC in which to create the Cluster.

vpcSubnets?🔹

Type: SubnetSelection[] (optional, default: All public and private subnets)

Where to place EKS Control Plane ENIs.

For example, to only select private subnets, supply the following:

vpcSubnets: [{ subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS }]

Properties

Name	Type	Description
clusterArn🔹	`string`	The AWS generated ARN for the Cluster resource.
clusterCertificateAuthorityData🔹	`string`	The certificate-authority-data for your cluster.
clusterEncryptionConfigKeyArn🔹	`string`	Amazon Resource Name (ARN) or alias of the customer master key (CMK).
clusterEndpoint🔹	`string`	The endpoint URL for the Cluster.
clusterName🔹	`string`	The Name of the created EKS Cluster.
clusterOpenIdConnectIssuerUrl🔹	`string`	If this cluster is kubectl-enabled, returns the OpenID Connect issuer url.
clusterSecurityGroup🔹	`ISecurityGroup`	The cluster security group that was created by Amazon EKS for the cluster.
clusterSecurityGroupId🔹	`string`	The id of the cluster security group that was created by Amazon EKS for the cluster.
connections🔹	`Connections`	Manages connection rules (Security Group Rules) for the cluster.
env🔹	`ResourceEnvironment`	The environment this resource belongs to.
node🔹	`Node`	The tree node.
openIdConnectProvider🔹	`IOpenIdConnectProvider`	An `OpenIdConnectProvider` resource associated with this cluster, and which can be used to link this cluster to AWS IAM.
prune🔹	`boolean`	Determines if Kubernetes resources can be pruned automatically.
role🔹	`IRole`	IAM role assumed by the EKS Control Plane.
stack🔹	`Stack`	The stack in which this resource is defined.
vpc🔹	`IVpc`	The VPC in which this Cluster was created.
albController?🔹	`AlbController`	The ALB Controller construct defined for this cluster.
defaultCapacity?🔹	`AutoScalingGroup`	The auto scaling group that hosts the default capacity for this cluster.
defaultNodegroup?🔹	`Nodegroup`	The node group that hosts the default capacity for this cluster.
eksPodIdentityAgent?🔹	`IAddon`	Retrieves the EKS Pod Identity Agent addon for the EKS cluster.
ipFamily?🔹	`IpFamily`	Specify which IP family is used to assign Kubernetes pod and service IP addresses.
kubectlProvider?🔹	`IKubectlProvider`
static PROPERTY_INJECTION_ID🔹	`string`	Uniquely identifies this class.

clusterArn🔹

Type: string

The AWS generated ARN for the Cluster resource.

For example, arn:aws:eks:us-west-2:666666666666:cluster/prod

clusterCertificateAuthorityData🔹

Type: string

The certificate-authority-data for your cluster.

clusterEncryptionConfigKeyArn🔹

Type: string

Amazon Resource Name (ARN) or alias of the customer master key (CMK).

clusterEndpoint🔹

Type: string

The endpoint URL for the Cluster.

This is the URL inside the kubeconfig file to use with kubectl

For example, https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com

clusterName🔹

Type: string

The Name of the created EKS Cluster.

clusterOpenIdConnectIssuerUrl🔹

Type: string

If this cluster is kubectl-enabled, returns the OpenID Connect issuer url.

If this cluster is not kubectl-enabled (i.e. uses the stock CfnCluster), this is undefined.

clusterSecurityGroup🔹

Type: ISecurityGroup

The cluster security group that was created by Amazon EKS for the cluster.

clusterSecurityGroupId🔹

Type: string

The id of the cluster security group that was created by Amazon EKS for the cluster.

connections🔹

Type: Connections

Manages connection rules (Security Group Rules) for the cluster.

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

node🔹

Type: Node

The tree node.

openIdConnectProvider🔹

Type: IOpenIdConnectProvider

An OpenIdConnectProvider resource associated with this cluster, and which can be used to link this cluster to AWS IAM.

A provider will only be defined if this property is accessed (lazy initialization).

prune🔹

Type: boolean

Determines if Kubernetes resources can be pruned automatically.

role🔹

Type: IRole

IAM role assumed by the EKS Control Plane.

stack🔹

Type: Stack

The stack in which this resource is defined.

vpc🔹

Type: IVpc

The VPC in which this Cluster was created.

albController?🔹

Type: AlbController (optional)

The ALB Controller construct defined for this cluster.

Will be undefined if albController wasn't configured.

defaultCapacity?🔹

Type: AutoScalingGroup (optional)

The auto scaling group that hosts the default capacity for this cluster.

This will be undefined if the defaultCapacityType is not EC2 or defaultCapacityType is EC2 but default capacity is set to 0.

defaultNodegroup?🔹

Type: Nodegroup (optional)

The node group that hosts the default capacity for this cluster.

This will be undefined if the defaultCapacityType is EC2 or defaultCapacityType is NODEGROUP but default capacity is set to 0.

eksPodIdentityAgent?🔹

Type: IAddon (optional)

Retrieves the EKS Pod Identity Agent addon for the EKS cluster.

The EKS Pod Identity Agent is responsible for managing the temporary credentials used by pods in the cluster to access AWS resources. It runs as a DaemonSet on each node and provides the necessary credentials to the pods based on their associated service account.

ipFamily?🔹

Type: IpFamily (optional, default: IpFamily.IP_V4)

Specify which IP family is used to assign Kubernetes pod and service IP addresses.

kubectlProvider?🔹

Type: IKubectlProvider (optional)

static PROPERTY_INJECTION_ID🔹

Type: string

Uniquely identifies this class.

Methods

Name	Description
addAutoScalingGroupCapacity(id, options)🔹	Add nodes to this EKS cluster.
addCdk8sChart(id, chart, options?)🔹	Defines a CDK8s chart in this cluster.
addFargateProfile(id, options)🔹	Adds a Fargate profile to this cluster.
addHelmChart(id, options)🔹	Defines a Helm chart in this cluster.
addManifest(id, ...manifest)🔹	Defines a Kubernetes resource in this cluster.
addNodegroupCapacity(id, options?)🔹	Add managed nodegroup to this Amazon EKS cluster.
addServiceAccount(id, options?)🔹	Creates a new service account with corresponding IAM Role (IRSA).
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
connectAutoScalingGroupCapacity(autoScalingGroup, options)🔹	Connect capacity in the form of an existing AutoScalingGroup to the EKS cluster.
getIngressLoadBalancerAddress(ingressName, options?)🔹	Fetch the load balancer address of an ingress backed by a load balancer.
getServiceLoadBalancerAddress(serviceName, options?)🔹	Fetch the load balancer address of a service of type 'LoadBalancer'.
grantAccess(id, principal, accessPolicies)🔹	Grants the specified IAM principal access to the EKS cluster based on the provided access policies.
grantClusterAdmin(id, principal)🔹	Grants the specified IAM principal cluster admin access to the EKS cluster.
toString()🔹	Returns a string representation of this construct.
static fromClusterAttributes(scope, id, attrs)🔹	Import an existing cluster.

addAutoScalingGroupCapacity(id, options)🔹

public addAutoScalingGroupCapacity(id: string, options: AutoScalingGroupCapacityOptions): AutoScalingGroup

Parameters

id string
options AutoScalingGroupCapacityOptions

Returns

AutoScalingGroup

Add nodes to this EKS cluster.

The nodes will automatically be configured with the right VPC and AMI for the instance type and Kubernetes version.

Note that if you specify updateType: RollingUpdate or updateType: ReplacingUpdate, your nodes might be replaced at deploy time without notice in case the recommended AMI for your machine image type has been updated by AWS. The default behavior for updateType is None, which means only new instances will be launched using the new AMI.

addCdk8sChart(id, chart, options?)🔹

public addCdk8sChart(id: string, chart: Construct, options?: KubernetesManifestOptions): KubernetesManifest

Parameters

id string — logical id of this chart.
chart Construct — the cdk8s chart.
options KubernetesManifestOptions

Returns

KubernetesManifest

Defines a CDK8s chart in this cluster.

addFargateProfile(id, options)🔹

public addFargateProfile(id: string, options: FargateProfileOptions): FargateProfile

Parameters

id string — the id of this profile.
options FargateProfileOptions — profile options.

Returns

FargateProfile

Adds a Fargate profile to this cluster.

addHelmChart(id, options)🔹

public addHelmChart(id: string, options: HelmChartOptions): HelmChart

Parameters

id string — logical id of this chart.
options HelmChartOptions — options of this chart.

Returns

HelmChart

Defines a Helm chart in this cluster.

addManifest(id, ...manifest)🔹

public addManifest(id: string, ...manifest: { [string]: any }[]): KubernetesManifest

Parameters

id string — logical id of this manifest.
manifest { [string]: any } — a list of Kubernetes resource specifications.

Returns

KubernetesManifest

Defines a Kubernetes resource in this cluster.

The manifest will be applied/deleted using kubectl as needed.

addNodegroupCapacity(id, options?)🔹

public addNodegroupCapacity(id: string, options?: NodegroupOptions): Nodegroup

Parameters

id string — The ID of the nodegroup.
options NodegroupOptions — options for creating a new nodegroup.

Returns

Nodegroup

Add managed nodegroup to this Amazon EKS cluster.

This method will create a new managed nodegroup and add into the capacity.

addServiceAccount(id, options?)🔹

public addServiceAccount(id: string, options?: ServiceAccountOptions): ServiceAccount

Parameters

id string
options ServiceAccountOptions

Returns

ServiceAccount

Creates a new service account with corresponding IAM Role (IRSA).

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

policy RemovalPolicy

Apply the given removal policy to this resource.

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

connectAutoScalingGroupCapacity(autoScalingGroup, options)🔹

public connectAutoScalingGroupCapacity(autoScalingGroup: AutoScalingGroup, options: AutoScalingGroupOptions): void

Parameters

autoScalingGroup AutoScalingGroup — [disable-awslint:ref-via-interface].
options AutoScalingGroupOptions — options for adding auto scaling groups, like customizing the bootstrap script.

Connect capacity in the form of an existing AutoScalingGroup to the EKS cluster.

The AutoScalingGroup must be running an EKS-optimized AMI containing the /etc/eks/bootstrap.sh script. This method will configure Security Groups, add the right policies to the instance role, apply the right tags, and add the required user data to the instance's launch configuration.

Prefer to use addAutoScalingGroupCapacity if possible.

getIngressLoadBalancerAddress(ingressName, options?)🔹

public getIngressLoadBalancerAddress(ingressName: string, options?: IngressLoadBalancerAddressOptions): string

Parameters

ingressName string — The name of the ingress.
options IngressLoadBalancerAddressOptions — Additional operation options.

Returns

string

Fetch the load balancer address of an ingress backed by a load balancer.

getServiceLoadBalancerAddress(serviceName, options?)🔹

public getServiceLoadBalancerAddress(serviceName: string, options?: ServiceLoadBalancerAddressOptions): string

Parameters

serviceName string — The name of the service.
options ServiceLoadBalancerAddressOptions — Additional operation options.

Returns

string

Fetch the load balancer address of a service of type 'LoadBalancer'.

grantAccess(id, principal, accessPolicies)🔹

public grantAccess(id: string, principal: string, accessPolicies: IAccessPolicy[]): void

Parameters

id string — - The ID of the AccessEntry construct to be created.
principal string — - The IAM principal (role or user) to be granted access to the EKS cluster.
accessPolicies IAccessPolicy[] — - An array of IAccessPolicy objects that define the access permissions to be granted to the IAM principal.

Grants the specified IAM principal access to the EKS cluster based on the provided access policies.

This method creates an AccessEntry construct that grants the specified IAM principal the access permissions defined by the provided IAccessPolicy array. This allows the IAM principal to perform the actions permitted by the access policies within the EKS cluster.

grantClusterAdmin(id, principal)🔹

public grantClusterAdmin(id: string, principal: string): AccessEntry

Parameters

id string — - The ID of the AccessEntry construct to be created.
principal string — - The IAM principal (role or user) to be granted access to the EKS cluster.

Returns

AccessEntry

Grants the specified IAM principal cluster admin access to the EKS cluster.

This method creates an AccessEntry construct that grants the specified IAM principal the cluster admin access permissions. This allows the IAM principal to perform the actions permitted by the cluster admin acces.

toString()🔹

public toString(): string

Returns

string

Returns a string representation of this construct.

static fromClusterAttributes(scope, id, attrs)🔹

public static fromClusterAttributes(scope: Construct, id: string, attrs: ClusterAttributes): ICluster

Parameters

scope Construct — the construct scope, in most cases 'this'.
id string — the id or name to import as.
attrs ClusterAttributes — the cluster properties to use for importing information.

Returns

ICluster

Import an existing cluster.