Package software.amazon.awscdk.services.eks

Interface ClusterProps

All Superinterfaces:

ClusterOptions, CommonClusterOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:16.783Z")
@Stability(Stable)
public interface ClusterProps
extends software.amazon.jsii.JsiiSerializable, ClusterOptions

Common configuration props for EKS clusters.

Example:

 // or
 Vpc vpc;
 Cluster.Builder.create(this, "MyCluster")
         .kubectlMemory(Size.gibibytes(4))
         .version(KubernetesVersion.V1_29)
         .build();
 Cluster.fromClusterAttributes(this, "MyCluster", ClusterAttributes.builder()
         .kubectlMemory(Size.gibibytes(4))
         .vpc(vpc)
         .clusterName("cluster-name")
         .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 Number	getDefaultCapacity()	Number of instances to allocate as an initial capacity for this cluster.
default InstanceType	getDefaultCapacityInstance()	The instance type to use for the default capacity.
default DefaultCapacityType	getDefaultCapacityType()	The default capacity type for the cluster.
default IRole	getKubectlLambdaRole()	The IAM role to pass to the Kubectl Lambda Handler.
default Map<String,String>	getTags()	The tags assigned to the EKS cluster.

Methods inherited from interface software.amazon.awscdk.services.eks.ClusterOptions

getAlbController, getAwscliLayer, getClusterHandlerEnvironment, getClusterHandlerSecurityGroup, getClusterLogging, getCoreDnsComputeType, getEndpointAccess, getIpFamily, getKubectlEnvironment, getKubectlLayer, getKubectlMemory, getMastersRole, getOnEventLayer, getOutputMastersRoleArn, getPlaceClusterHandlerInVpc, getPrune, getSecretsEncryptionKey, getServiceIpv4Cidr

Methods inherited from interface software.amazon.awscdk.services.eks.CommonClusterOptions

getClusterName, getOutputClusterName, getOutputConfigCommand, getRole, getSecurityGroup, getVersion, getVpc, getVpcSubnets

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDefaultCapacity

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

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(Stable)
@Nullable
default InstanceType getDefaultCapacityInstance()

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(Stable)
@Nullable
default DefaultCapacityType getDefaultCapacityType()

The default capacity type for the cluster.

Default: NODEGROUP

getKubectlLambdaRole

@Stability(Stable)
@Nullable
default IRole getKubectlLambdaRole()

The IAM role to pass to the Kubectl Lambda Handler.

Default: - Default Lambda IAM Execution Role

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

The tags assigned to the EKS cluster.

Default: - none

builder

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

Returns:

a ClusterProps.Builder of ClusterProps