ClusterCommonOptions Struct
Options for configuring an EKS cluster.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
import { aws_eks_v2 as eks_v2 } from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_lambda as lambda } from 'aws-cdk-lib';
import { aws_kms as interfaces_kms } from 'aws-cdk-lib/interfaces';
declare const additionalHelmChartValues: any;
declare const albControllerVersion: eks_v2.AlbControllerVersion;
declare const controlPlaneScalingTier: eks_v2.ControlPlaneScalingTier;
declare const endpointAccess: eks_v2.EndpointAccess;
declare const keyRef: interfaces_kms.IKeyRef;
declare const kubernetesVersion: eks_v2.KubernetesVersion;
declare const layerVersion: lambda.LayerVersion;
declare const policy: any;
declare const role: iam.Role;
declare const securityGroup: ec2.SecurityGroup;
declare const size: cdk.Size;
declare const subnet: ec2.Subnet;
declare const subnetFilter: ec2.SubnetFilter;
declare const vpc: ec2.Vpc;
const clusterCommonOptions: eks_v2.ClusterCommonOptions = {
version: kubernetesVersion,
// the properties below are optional
albController: {
version: albControllerVersion,
// the properties below are optional
additionalHelmChartValues: {
additionalHelmChartValuesKey: additionalHelmChartValues,
},
overwriteServiceAccount: false,
policy: policy,
removalPolicy: cdk.RemovalPolicy.DESTROY,
repository: 'repository',
},
clusterLogging: [eks_v2.ClusterLoggingTypes.API],
clusterName: 'clusterName',
controlPlaneScalingTier: controlPlaneScalingTier,
coreDnsComputeType: eks_v2.CoreDnsComputeType.EC2,
endpointAccess: endpointAccess,
ipFamily: eks_v2.IpFamily.IP_V4,
kubectlProviderOptions: {
kubectlLayer: layerVersion,
// the properties below are optional
awscliLayer: layerVersion,
environment: {
environmentKey: 'environment',
},
memory: size,
privateSubnets: [subnet],
removalPolicy: cdk.RemovalPolicy.DESTROY,
role: role,
securityGroup: securityGroup,
securityGroups: [securityGroup],
},
mastersRole: role,
prune: false,
remoteNodeNetworks: [{
cidrs: ['cidrs'],
}],
remotePodNetworks: [{
cidrs: ['cidrs'],
}],
removalPolicy: cdk.RemovalPolicy.DESTROY,
role: role,
secretsEncryptionKey: keyRef,
securityGroup: securityGroup,
serviceIpv4Cidr: 'serviceIpv4Cidr',
tags: {
tagsKey: 'tags',
},
vpc: vpc,
vpcSubnets: [{
availabilityZones: ['availabilityZones'],
onePerAz: false,
subnetFilters: [subnetFilter],
subnetGroupName: 'subnetGroupName',
subnets: [subnet],
subnetType: ec2.SubnetType.PRIVATE_ISOLATED,
}],
};
Properties
albControllerAlbControllerOptionsalb_controllerAlbControllerOptionsalbControllerAlbControllerOptionsAlbControllerAlbControllerOptionsAlbControllerAlbControllerOptions= The controller is not installed.#Install the AWS Load Balancer Controller onto the cluster.
clusterLoggingClusterLoggingTypes[]cluster_loggingtyping.List[ClusterLoggingTypes]clusterLoggingList<ClusterLoggingTypes>ClusterLoggingClusterLoggingTypes[]ClusterLogging*[]ClusterLoggingTypes= none#The cluster log types which you want to enable.
clusterNamestringcluster_namestrclusterNameStringClusterNamestringClusterName*string= Automatically generated name#Name for the cluster.
controlPlaneScalingTierControlPlaneScalingTiercontrol_plane_scaling_tierControlPlaneScalingTiercontrolPlaneScalingTierControlPlaneScalingTierControlPlaneScalingTierControlPlaneScalingTierControlPlaneScalingTierControlPlaneScalingTier= Standard control plane (no provi…#The scaling tier for the cluster's provisioned control plane.
Provisioned Control Plane allows you to select a scaling tier to ensure high and predictable performance for demanding workloads such as AI training/inference, high-performance computing, or large-scale data processing.
default
Default: Standard control plane (no provisioned tier)
coreDnsComputeTypeCoreDnsComputeTypecore_dns_compute_typeCoreDnsComputeTypecoreDnsComputeTypeCoreDnsComputeTypeCoreDnsComputeTypeCoreDnsComputeTypeCoreDnsComputeTypeCoreDnsComputeType= CoreDnsComputeType.EC2 (for `Far…#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
Default: CoreDnsComputeType.EC2 (for FargateCluster the default is FARGATE)
endpointAccessEndpointAccessendpoint_accessEndpointAccessendpointAccessEndpointAccessEndpointAccessEndpointAccessEndpointAccessEndpointAccess= EndpointAccess.PUBLIC_AND_PRIVAT…#Configure access to the Kubernetes API server endpoint..
default
Default: EndpointAccess.PUBLIC_AND_PRIVATE
Specify which IP family is used to assign Kubernetes pod and service IP addresses.
kubectlProviderOptionsKubectlProviderOptionskubectl_provider_optionsKubectlProviderOptionskubectlProviderOptionsKubectlProviderOptionsKubectlProviderOptionsKubectlProviderOptionsKubectlProviderOptionsKubectlProviderOptions= kubectl provider will not be cre…#Options for creating the kubectl provider - a lambda function that executes `kubectl` and `helm` against the cluster.
If defined, kubectlLayer is a required property.
default
Default: kubectl provider will not be created
mastersRoleIRolemasters_roleIRolemastersRoleIRoleMastersRoleIRoleMastersRoleIRole= no masters role.#An IAM role that will be added to the `system:masters` Kubernetes RBAC group.
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.
remoteNodeNetworksRemoteNodeNetwork[]remote_node_networkstyping.List[RemoteNodeNetwork]remoteNodeNetworksList<RemoteNodeNetwork>RemoteNodeNetworksRemoteNodeNetwork[]RemoteNodeNetworks*[]RemoteNodeNetwork= none#IPv4 CIDR blocks defining the expected address range of hybrid nodes that will join the cluster.
remotePodNetworksRemotePodNetwork[]remote_pod_networkstyping.List[RemotePodNetwork]remotePodNetworksList<RemotePodNetwork>RemotePodNetworksRemotePodNetwork[]RemotePodNetworks*[]RemotePodNetwork= none#IPv4 CIDR blocks for Pods running Kubernetes webhooks on hybrid nodes.
removalPolicyRemovalPolicyremoval_policyRemovalPolicyremovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicy= Resources will be deleted.#The removal policy applied to all CloudFormation resources created by this construct when they are no longer managed by CloudFormation.
notes
This can happen in one of three situations:
- The resource is removed from the template, so CloudFormation stops managing it;
- A change to the resource is made that requires it to be replaced, so CloudFormation stops managing it;
- The stack is deleted, so CloudFormation stops managing all resources in it.
This affects the EKS cluster itself, associated IAM roles, node groups, security groups, VPC and any other CloudFormation resources managed by this construct.
Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
default
Default: A role is automatically created for you
secretsEncryptionKeyIKeyRefsecrets_encryption_keyIKeyRefsecretsEncryptionKeyIKeyRefSecretsEncryptionKeyIKeyRefSecretsEncryptionKeyIKeyRef= By default, Kubernetes stores al…#KMS secret for envelope encryption for Kubernetes secrets.
default
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.
securityGroupISecurityGroupsecurity_groupISecurityGroupsecurityGroupISecurityGroupSecurityGroupISecurityGroupSecurityGroupISecurityGroup= A security group is automaticall…#Security Group to use for Control Plane ENIs.
default
Default: A security group is automatically created
serviceIpv4Cidrstringservice_ipv4_cidrstrserviceIpv4CidrStringServiceIpv4CidrstringServiceIpv4Cidr*string= Kubernetes assigns addresses fro…#The CIDR block to assign Kubernetes service IP addresses from.
default
Default: Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks
tags{ [key: string]: string }tagstyping.Mapping[str, str]tagsMap<String, String>TagsIDictionary<string, string>Tags*map[string]*string= none#The tags assigned to the EKS cluster.
versionKubernetesVersionversionKubernetesVersionversionKubernetesVersionVersionKubernetesVersionVersionKubernetesVersionrequired#The Kubernetes version to run in the cluster.
The VPC in which to create the Cluster.
default
Default: a VPC with default configuration will be created and can be accessed through cluster.vpc.
vpcSubnetsSubnetSelection[]vpc_subnetstyping.List[SubnetSelection]vpcSubnetsList<SubnetSelection>VpcSubnetsSubnetSelection[]VpcSubnets*[]SubnetSelection= 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 }]