Package software.amazon.awscdk.services.eks.v2.alpha

Interface ClusterProps

All Superinterfaces:

ClusterCommonOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:49.676Z")
@Stability(Experimental)
public interface ClusterProps
extends software.amazon.jsii.JsiiSerializable, ClusterCommonOptions

(experimental) Properties for configuring a standard EKS cluster (non-Fargate).

Example:

 Cluster cluster = Cluster.Builder.create(this, "ManagedNodeCluster")
         .version(KubernetesVersion.V1_34)
         .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());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ClusterProps.Builder	A builder for ClusterProps
static final class	ClusterProps.Jsii$Proxy	An implementation for ClusterProps

Method Summary

Modifier and Type	Method	Description
static ClusterProps.Builder	builder()
default Boolean	getBootstrapClusterCreatorAdminPermissions()	(experimental) Whether or not IAM principal of the cluster creator was set as a cluster admin access entry during cluster creation time.
default ComputeConfig	getCompute()	(experimental) Configuration for compute settings in Auto Mode.
default Number	getDefaultCapacity()	(experimental) Number of instances to allocate as an initial capacity for this cluster.
default InstanceType	getDefaultCapacityInstance()	(experimental) The instance type to use for the default capacity.
default DefaultCapacityType	getDefaultCapacityType()	(experimental) The default capacity type for the cluster.
default Boolean	getOutputConfigCommand()	(experimental) Determines whether a CloudFormation output with the aws eks update-kubeconfig command will be synthesized.

Methods inherited from interface software.amazon.awscdk.services.eks.v2.alpha.ClusterCommonOptions

getAlbController, getClusterLogging, getClusterName, getCoreDnsComputeType, getEndpointAccess, getIpFamily, getKubectlProviderOptions, getMastersRole, getPrune, getRole, getSecretsEncryptionKey, getSecurityGroup, getServiceIpv4Cidr, getTags, getVersion, getVpc, getVpcSubnets

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBootstrapClusterCreatorAdminPermissions

@Stability(Experimental)
@Nullable
default Boolean getBootstrapClusterCreatorAdminPermissions()

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

Default: true

getCompute

@Stability(Experimental)
@Nullable
default ComputeConfig getCompute()

(experimental) Configuration for compute settings in Auto Mode.

When enabled, EKS will automatically manage compute resources.

Default: - Auto Mode compute disabled

getDefaultCapacity

@Stability(Experimental)
@Nullable
default Number getDefaultCapacity()

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

Default: 2

getDefaultCapacityInstance

@Stability(Experimental)
@Nullable
default InstanceType getDefaultCapacityInstance()

(experimental) The instance type to use for the default capacity.

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

Default: m5.large

getDefaultCapacityType

@Stability(Experimental)
@Nullable
default DefaultCapacityType getDefaultCapacityType()

(experimental) The default capacity type for the cluster.

Default: AUTOMODE

getOutputConfigCommand

@Stability(Experimental)
@Nullable
default Boolean getOutputConfigCommand()

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

Default: true

builder

@Stability(Experimental)
static ClusterProps.Builder builder()

Returns:

a ClusterProps.Builder of ClusterProps