ClusterProps Struct
Properties for configuring a standard EKS cluster (non-Fargate).
Example
const cluster = new eks.Cluster(this, 'ManagedNodeCluster', {
version: eks.KubernetesVersion.V1_37,
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
],
});
cluster = eks.Cluster(self, "ManagedNodeCluster",
version=eks.KubernetesVersion.V1_37,
default_capacity_type=eks.DefaultCapacityType.NODEGROUP
)
# Add a Fargate Profile for specific workloads (e.g., default namespace)
cluster.add_fargate_profile("FargateProfile",
selectors=[eks.Selector(namespace="default")
]
)
Cluster cluster = Cluster.Builder.create(this, "ManagedNodeCluster")
.version(KubernetesVersion.V1_37)
.defaultCapacityType(DefaultCapacityType.NODEGROUP)
.build();
// Add a Fargate Profile for specific workloads (e.g., default namespace)
cluster.addFargateProfile("FargateProfile", FargateProfileOptions.builder()
.selectors(List.of(Selector.builder().namespace("default").build()))
.build());
// Install: dotnet add package Amazon.CDK.Lib
var cluster = new Cluster(this, "ManagedNodeCluster", new ClusterProps {
Version = KubernetesVersion.V1_37,
DefaultCapacityType = DefaultCapacityType.NODEGROUP
});
// Add a Fargate Profile for specific workloads (e.g., default namespace)
cluster.AddFargateProfile("FargateProfile", new FargateProfileOptions {
Selectors = new [] { new Selector { Namespace = "default" } }
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
cluster := eks.NewCluster(this, jsii.String("ManagedNodeCluster"), &ClusterProps{
Version: eks.KubernetesVersion_V1_37(),
DefaultCapacityType: eks.DefaultCapacityType_NODEGROUP,
})
// Add a Fargate Profile for specific workloads (e.g., default namespace)
cluster.AddFargateProfile(jsii.String("FargateProfile"), &FargateProfileOptions{
Selectors: []Selector{
&Selector{
Namespace: jsii.String("default"),
},
},
})
Properties
albControlleroptionalAlbControllerOptionsalb_controlleroptionalAlbControllerOptionsalbControlleroptionalAlbControllerOptionsAlbControlleroptionalAlbControllerOptionsAlbControlleroptionalAlbControllerOptions#Default: The controller is not installed.
bootstrapClusterCreatorAdminPermissionsoptionalbooleanbootstrap_cluster_creator_admin_permissionsoptionalboolbootstrapClusterCreatorAdminPermissionsoptionalBooleanBootstrapClusterCreatorAdminPermissionsoptionalboolBootstrapClusterCreatorAdminPermissionsoptional*bool= true#Changing this value after the cluster has been created will result in the cluster being replaced.
bootstrapSelfManagedAddonsoptionalbooleanbootstrap_self_managed_addonsoptionalboolbootstrapSelfManagedAddonsoptionalBooleanBootstrapSelfManagedAddonsoptionalboolBootstrapSelfManagedAddonsoptional*bool#Default: true if the mode is not EKS Auto Mode
notes
The default networking addons include vpc-cni, coredns, and kube-proxy. Use this option when you plan to install third-party alternative add-ons or self-manage the default networking add-ons.
Changing this value after the cluster has been created will result in the cluster being replaced.
clusterLoggingoptionalClusterLoggingTypes[]cluster_loggingoptionaltyping.List[ClusterLoggingTypes]clusterLoggingoptionalList<ClusterLoggingTypes>ClusterLoggingoptionalClusterLoggingTypes[]ClusterLoggingoptional*[]ClusterLoggingTypes= none#clusterNameoptionalstringcluster_nameoptionalstrclusterNameoptionalStringClusterNameoptionalstringClusterNameoptional*string#Default: Automatically generated name
computeoptionalComputeConfigcomputeoptionalComputeConfigcomputeoptionalComputeConfigComputeoptionalComputeConfigComputeoptionalComputeConfig#Default: Auto Mode compute disabled
When enabled, EKS will automatically manage compute resources.
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)
defaultCapacityoptionalnumberdefault_capacityoptionalint | floatdefaultCapacityoptionalNumberDefaultCapacityoptionaldoubleDefaultCapacityoptional*float64= 2#notes
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.
defaultCapacityInstanceoptionalInstanceTypedefault_capacity_instanceoptionalInstanceTypedefaultCapacityInstanceoptionalInstanceTypeDefaultCapacityInstanceoptionalInstanceTypeDefaultCapacityInstanceoptionalInstanceType= m5.large#This will only be taken into account if defaultCapacity is > 0.
defaultCapacityTypeoptionalDefaultCapacityTypedefault_capacity_typeoptionalDefaultCapacityTypedefaultCapacityTypeoptionalDefaultCapacityTypeDefaultCapacityTypeoptionalDefaultCapacityTypeDefaultCapacityTypeoptionalDefaultCapacityType= AUTOMODE#endpointAccessoptionalEndpointAccessendpoint_accessoptionalEndpointAccessendpointAccessoptionalEndpointAccessEndpointAccessoptionalEndpointAccessEndpointAccessoptionalEndpointAccess#Default: EndpointAccess.PUBLIC_AND_PRIVATE
ipFamilyoptionalIpFamilyip_familyoptionalIpFamilyipFamilyoptionalIpFamilyIpFamilyoptionalIpFamilyIpFamilyoptionalIpFamily= IpFamily.IP_V4#kubectlProviderOptionsoptionalKubectlProviderOptionskubectl_provider_optionsoptionalKubectlProviderOptionskubectlProviderOptionsoptionalKubectlProviderOptionsKubectlProviderOptionsoptionalKubectlProviderOptionsKubectlProviderOptionsoptionalKubectlProviderOptions#Default: kubectl provider will not be created
If defined, kubectlLayer is a required property.
mastersRoleoptionalIRolemasters_roleoptionalIRolemastersRoleoptionalIRoleMastersRoleoptionalIRoleMastersRoleoptionalIRole#Default: no masters role.
outputConfigCommandoptionalbooleanoutput_config_commandoptionalbooloutputConfigCommandoptionalBooleanOutputConfigCommandoptionalboolOutputConfigCommandoptional*bool= true#This command will include the cluster name and, if applicable, the ARN of the masters IAM role.
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
tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string= none#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 }]