interface ClusterProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.EKS.ClusterProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awseks#ClusterProps |
 Java | software.amazon.awscdk.services.eks.ClusterProps |
 Python | aws_cdk.aws_eks.ClusterProps |
 TypeScript (source) | aws-cdk-lib » aws_eks » ClusterProps |
Common configuration props for EKS clusters.
Example
new eks.Cluster(this, 'MyCluster', {
kubectlMemory: Size.gibibytes(4),
version: eks.KubernetesVersion.V1_31,
});
// or
declare const vpc: ec2.Vpc;
eks.Cluster.fromClusterAttributes(this, 'MyCluster', {
kubectlMemory: Size.gibibytes(4),
vpc,
clusterName: 'cluster-name',
});
Properties
| Name | Type | Description |
|---|---|---|
| version | Kubernetes | The Kubernetes version to run in the cluster. |
| alb | Alb | Install the AWS Load Balancer Controller onto the cluster. |
| authentication | Authentication | The desired authentication mode for the cluster. |
| awscli | ILayer | An AWS Lambda layer that contains the aws CLI. |
| bootstrap | boolean | Whether or not IAM principal of the cluster creator was set as a cluster admin access entry during cluster creation time. |
| cluster | { [string]: string } | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. |
| cluster | ISecurity | A security group to associate with the Cluster Handler's Lambdas. |
| cluster | Cluster[] | The cluster log types which you want to enable. |
| cluster | string | Name for the cluster. |
| core | Core | Controls the "eks.amazonaws.com/compute-type" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. |
| default | number | Number of instances to allocate as an initial capacity for this cluster. |
| default | Instance | The instance type to use for the default capacity. |
| default | Default | The default capacity type for the cluster. |
| endpoint | Endpoint | Configure access to the Kubernetes API server endpoint.. |
| ip | Ip | Specify which IP family is used to assign Kubernetes pod and service IP addresses. |
| kubectl | { [string]: string } | Environment variables for the kubectl execution. |
| kubectl | IRole | The IAM role to pass to the Kubectl Lambda Handler. |
| kubectl | ILayer | An AWS Lambda Layer which includes kubectl and Helm. |
| kubectl | Size | Amount of memory to allocate to the provider's lambda function. |
| masters | IRole | An IAM role that will be added to the system:masters Kubernetes RBAC group. |
| on | ILayer | An AWS Lambda Layer which includes the NPM dependency proxy-agent. |
| output | boolean | Determines whether a CloudFormation output with the name of the cluster will be synthesized. |
| output | boolean | Determines whether a CloudFormation output with the aws eks update-kubeconfig command will be synthesized. |
| output | boolean | Determines whether a CloudFormation output with the ARN of the "masters" IAM role will be synthesized (if mastersRole is specified). |
| place | boolean | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the vpcSubnets selection strategy. |
| 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. |
| secrets | IKey | KMS secret for envelope encryption for Kubernetes secrets. |
| security | ISecurity | Security Group to use for Control Plane ENIs. |
| service | 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. |
| vpc | Subnet[] | Where to place EKS Control Plane ENIs. |
version
Type:
Kubernetes
The Kubernetes version to run in the cluster.
albController?
Type:
Alb
(optional, default: The controller is not installed.)
Install the AWS Load Balancer Controller onto the cluster.
See also: https://kubernetes-sigs.github.io/aws-load-balancer-controller
authenticationMode?
Type:
Authentication
(optional, default: AuthenticationMode.CONFIG_MAP)
The desired authentication mode for the cluster.
awscliLayer?
Type:
ILayer
(optional, default: a default layer with the AWS CLI 1.x)
An AWS Lambda layer that contains the aws CLI.
The handler expects the layer to include the following executables:
/opt/awscli/aws
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.
clusterHandlerEnvironment?
Type:
{ [string]: string }
(optional, default: No environment variables.)
Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle.
clusterHandlerSecurityGroup?
Type:
ISecurity
(optional, default: No security group.)
A security group to associate with the Cluster Handler's Lambdas.
The Cluster Handler's Lambdas are responsible for calling AWS's EKS API.
Requires placeClusterHandlerInVpc to be set to true.
clusterLogging?
Type:
Cluster[]
(optional, default: none)
The cluster log types which you want to enable.
clusterName?
Type:
string
(optional, default: Automatically generated name)
Name for the cluster.
coreDnsComputeType?
Type:
Core
(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:
Instance
(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:
Default
(optional, default: NODEGROUP)
The default capacity type for the cluster.
endpointAccess?
Type:
Endpoint
(optional, default: EndpointAccess.PUBLIC_AND_PRIVATE)
Configure access to the Kubernetes API server endpoint..
See also: https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html
ipFamily?
Type:
Ip
(optional, default: IpFamily.IP_V4)
Specify which IP family is used to assign Kubernetes pod and service IP addresses.
kubectlEnvironment?
Type:
{ [string]: string }
(optional, default: No environment variables.)
Environment variables for the kubectl execution.
Only relevant for kubectl enabled clusters.
kubectlLambdaRole?
Type:
IRole
(optional, default: Default Lambda IAM Execution Role)
The IAM role to pass to the Kubectl Lambda Handler.
kubectlLayer?
Type:
ILayer
(optional, default: a default layer with Kubectl 1.20.)
An AWS Lambda Layer which includes kubectl and Helm.
This layer is used by the kubectl handler to apply manifests and install
helm charts. You must pick an appropriate releases of one of the
@aws-cdk/layer-kubectl-vXX packages, that works with the version of
Kubernetes you have chosen. If you don't supply this value kubectl
1.20 will be used, but that version is most likely too old.
The handler expects the layer to include the following executables:
/opt/helm/helm
/opt/kubectl/kubectl
kubectlMemory?
Type:
Size
(optional, default: Size.gibibytes(1))
Amount of memory to allocate to the provider's lambda function.
mastersRole?
Type:
IRole
(optional, default: no masters role.)
An IAM role that will be added to the system:masters Kubernetes RBAC group.
See also: https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings
onEventLayer?
Type:
ILayer
(optional, default: a layer bundled with this module.)
An AWS Lambda Layer which includes the NPM dependency proxy-agent.
This layer is used by the onEvent handler to route AWS SDK requests through a proxy.
By default, the provider will use the layer included in the "aws-lambda-layer-node-proxy-agent" SAR application which is available in all commercial regions.
To deploy the layer locally define it in your app as follows:
const layer = new lambda.LayerVersion(this, 'proxy-agent-layer', {
code: lambda.Code.fromAsset(`${__dirname}/layer.zip`),
compatibleRuntimes: [lambda.Runtime.NODEJS_LATEST],
});
outputClusterName?
Type:
boolean
(optional, default: false)
Determines whether a CloudFormation output with the name of the cluster will be synthesized.
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.
outputMastersRoleArn?
Type:
boolean
(optional, default: false)
Determines whether a CloudFormation output with the ARN of the "masters" IAM role will be synthesized (if mastersRole is specified).
placeClusterHandlerInVpc?
Type:
boolean
(optional, default: false)
If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the vpcSubnets selection strategy.
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:
IKey
(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:
ISecurity
(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:
Subnet[]
(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 }]