ClusterOptions Struct
Options for EKS clusters.
Example
// 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 as eks } 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 albControllerVersion: eks.AlbControllerVersion;
declare const endpointAccess: eks.EndpointAccess;
declare const keyRef: interfaces_kms.IKeyRef;
declare const kubernetesVersion: eks.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 clusterOptions: eks.ClusterOptions = {
kubectlLayer: layerVersion,
version: kubernetesVersion,
// the properties below are optional
albController: {
version: albControllerVersion,
// the properties below are optional
additionalHelmChartValues: {
enableWaf: false,
enableWafv2: false,
},
overwriteServiceAccount: false,
policy: policy,
removalPolicy: cdk.RemovalPolicy.DESTROY,
repository: 'repository',
},
authenticationMode: eks.AuthenticationMode.CONFIG_MAP,
awscliLayer: layerVersion,
clusterHandlerEnvironment: {
clusterHandlerEnvironmentKey: 'clusterHandlerEnvironment',
},
clusterHandlerSecurityGroup: securityGroup,
clusterLogging: [eks.ClusterLoggingTypes.API],
clusterName: 'clusterName',
controlPlaneScalingTier: eks.ControlPlaneScalingTier.STANDARD,
coreDnsComputeType: eks.CoreDnsComputeType.EC2,
deletionProtection: false,
endpointAccess: endpointAccess,
ipFamily: eks.IpFamily.IP_V4,
kubectlEnvironment: {
kubectlEnvironmentKey: 'kubectlEnvironment',
},
kubectlMemory: size,
mastersRole: role,
onEventLayer: layerVersion,
outputClusterName: false,
outputConfigCommand: false,
outputMastersRoleArn: false,
placeClusterHandlerInVpc: false,
prune: false,
remoteNodeNetworks: [{
cidrs: ['cidrs'],
}],
remotePodNetworks: [{
cidrs: ['cidrs'],
}],
removalPolicy: cdk.RemovalPolicy.DESTROY,
role: role,
secretsEncryptionKey: keyRef,
securityGroup: securityGroup,
serviceIpv4Cidr: 'serviceIpv4Cidr',
vpc: vpc,
vpcSubnets: [{
availabilityZones: ['availabilityZones'],
onePerAz: false,
subnetFilters: [subnetFilter],
subnetGroupName: 'subnetGroupName',
subnets: [subnet],
subnetType: ec2.SubnetType.PRIVATE_ISOLATED,
}],
};
Properties
albControlleroptionalAlbControllerOptionsalb_controlleroptionalAlbControllerOptionsalbControlleroptionalAlbControllerOptionsAlbControlleroptionalAlbControllerOptionsAlbControlleroptionalAlbControllerOptions#Default: The controller is not installed.
authenticationModeoptionalAuthenticationModeauthentication_modeoptionalAuthenticationModeauthenticationModeoptionalAuthenticationModeAuthenticationModeoptionalAuthenticationModeAuthenticationModeoptionalAuthenticationMode= AuthenticationMode.CONFIG_MAP#awscliLayeroptionalILayerVersionawscli_layeroptionalILayerVersionawscliLayeroptionalILayerVersionAwscliLayeroptionalILayerVersionAwscliLayeroptionalILayerVersion#Default: a default layer with the AWS CLI 1.x
The handler expects the layer to include the following executables:
/opt/awscli/aws
clusterHandlerEnvironmentoptional{ [key: string]: string }cluster_handler_environmentoptionaltyping.Mapping[str, str]clusterHandlerEnvironmentoptionalMap<String, String>ClusterHandlerEnvironmentoptionalIDictionary<string, string>ClusterHandlerEnvironmentoptional*map[string]*string#Default: No environment variables.
clusterHandlerSecurityGroupoptionalISecurityGroupcluster_handler_security_groupoptionalISecurityGroupclusterHandlerSecurityGroupoptionalISecurityGroupClusterHandlerSecurityGroupoptionalISecurityGroupClusterHandlerSecurityGroupoptionalISecurityGroup#Default: No security group.
The Cluster Handler's Lambdas are responsible for calling AWS's EKS API.
Requires placeClusterHandlerInVpc to be set to true.
clusterLoggingoptionalClusterLoggingTypes[]cluster_loggingoptionaltyping.List[ClusterLoggingTypes]clusterLoggingoptionalList<ClusterLoggingTypes>ClusterLoggingoptionalClusterLoggingTypes[]ClusterLoggingoptional*[]ClusterLoggingTypes= none#clusterNameoptionalstringcluster_nameoptionalstrclusterNameoptionalStringClusterNameoptionalstringClusterNameoptional*string#Default: Automatically generated name
controlPlaneScalingTieroptionalControlPlaneScalingTiercontrol_plane_scaling_tieroptionalControlPlaneScalingTiercontrolPlaneScalingTieroptionalControlPlaneScalingTierControlPlaneScalingTieroptionalControlPlaneScalingTierControlPlaneScalingTieroptionalControlPlaneScalingTier#Default: Standard control plane (no provisioned tier)
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.
coreDnsComputeTypeoptionalCoreDnsComputeTypecore_dns_compute_typeoptionalCoreDnsComputeTypecoreDnsComputeTypeoptionalCoreDnsComputeTypeCoreDnsComputeTypeoptionalCoreDnsComputeTypeCoreDnsComputeTypeoptionalCoreDnsComputeType#Default: CoreDnsComputeType.EC2 (for FargateCluster the default is FARGATE)
deletionProtectionoptionalbooleandeletion_protectionoptionalbooldeletionProtectionoptionalBooleanDeletionProtectionoptionalboolDeletionProtectionoptional*bool#Default: deletion protection is disabled
When true, deletion protection is enabled and the cluster cannot be deleted until protection is disabled. When false, the cluster can be deleted normally. This setting only applies to clusters in an active state.
endpointAccessoptionalEndpointAccessendpoint_accessoptionalEndpointAccessendpointAccessoptionalEndpointAccessEndpointAccessoptionalEndpointAccessEndpointAccessoptionalEndpointAccess#Default: EndpointAccess.PUBLIC_AND_PRIVATE
ipFamilyoptionalIpFamilyip_familyoptionalIpFamilyipFamilyoptionalIpFamilyIpFamilyoptionalIpFamilyIpFamilyoptionalIpFamily= IpFamily.IP_V4#kubectlEnvironmentoptional{ [key: string]: string }kubectl_environmentoptionaltyping.Mapping[str, str]kubectlEnvironmentoptionalMap<String, String>KubectlEnvironmentoptionalIDictionary<string, string>KubectlEnvironmentoptional*map[string]*string#Default: No environment variables.
Only relevant for kubectl enabled clusters.
kubectlLayerILayerVersionkubectl_layerILayerVersionkubectlLayerILayerVersionKubectlLayerILayerVersionKubectlLayerILayerVersionrequired#notes
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.
The handler expects the layer to include the following executables:
/opt/helm/helm
/opt/kubectl/kubectl
kubectlMemoryoptionalSizekubectl_memoryoptionalSizekubectlMemoryoptionalSizeKubectlMemoryoptionalSizeKubectlMemoryoptionalSize= Size.gibibytes(1)#mastersRoleoptionalIRolemasters_roleoptionalIRolemastersRoleoptionalIRoleMastersRoleoptionalIRoleMastersRoleoptionalIRole#Default: no masters role.
onEventLayeroptionalILayerVersionon_event_layeroptionalILayerVersiononEventLayeroptionalILayerVersionOnEventLayeroptionalILayerVersionOnEventLayeroptionalILayerVersion#Default: a layer bundled with this module.
notes
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],
});
outputClusterNameoptionalbooleanoutput_cluster_nameoptionalbooloutputClusterNameoptionalBooleanOutputClusterNameoptionalboolOutputClusterNameoptional*bool= false#outputConfigCommandoptionalbooleanoutput_config_commandoptionalbooloutputConfigCommandoptionalBooleanOutputConfigCommandoptionalboolOutputConfigCommandoptional*bool= true#This command will include the cluster name and the ARN of the masters IAM role.
Note: If mastersRole is not specified, this property will be ignored and no config command will be emitted.
outputMastersRoleArnoptionalbooleanoutput_masters_role_arnoptionalbooloutputMastersRoleArnoptionalBooleanOutputMastersRoleArnoptionalboolOutputMastersRoleArnoptional*bool= false#placeClusterHandlerInVpcoptionalbooleanplace_cluster_handler_in_vpcoptionalboolplaceClusterHandlerInVpcoptionalBooleanPlaceClusterHandlerInVpcoptionalboolPlaceClusterHandlerInVpcoptional*bool= false#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.
remoteNodeNetworksoptionalRemoteNodeNetwork[]remote_node_networksoptionaltyping.List[RemoteNodeNetwork]remoteNodeNetworksoptionalList<RemoteNodeNetwork>RemoteNodeNetworksoptionalRemoteNodeNetwork[]RemoteNodeNetworksoptional*[]RemoteNodeNetwork= none#remotePodNetworksoptionalRemotePodNetwork[]remote_pod_networksoptionaltyping.List[RemotePodNetwork]remotePodNetworksoptionalList<RemotePodNetwork>RemotePodNetworksoptionalRemotePodNetwork[]RemotePodNetworksoptional*[]RemotePodNetwork= none#removalPolicyoptionalRemovalPolicyremoval_policyoptionalRemovalPolicyremovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicy#Default: Resources will be deleted.
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.
Default: A role is automatically created for you
secretsEncryptionKeyoptionalIKeyRefsecrets_encryption_keyoptionalIKeyRefsecretsEncryptionKeyoptionalIKeyRefSecretsEncryptionKeyoptionalIKeyRefSecretsEncryptionKeyoptionalIKeyRef#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.
securityGroupoptionalISecurityGroupsecurity_groupoptionalISecurityGroupsecurityGroupoptionalISecurityGroupSecurityGroupoptionalISecurityGroupSecurityGroupoptionalISecurityGroup#Default: A security group is automatically created
serviceIpv4Cidroptionalstringservice_ipv4_cidroptionalstrserviceIpv4CidroptionalStringServiceIpv4CidroptionalstringServiceIpv4Cidroptional*string#Default: Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks
versionKubernetesVersionversionKubernetesVersionversionKubernetesVersionVersionKubernetesVersionVersionKubernetesVersionrequired#Default: a VPC with default configuration will be created and can be accessed through cluster.vpc.
vpcSubnetsoptionalSubnetSelection[]vpc_subnetsoptionaltyping.List[SubnetSelection]vpcSubnetsoptionalList<SubnetSelection>VpcSubnetsoptionalSubnetSelection[]VpcSubnetsoptional*[]SubnetSelection#Default: All public and private subnets
For example, to only select private subnets, supply the following:
vpcSubnets: [{ subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS }]