Package software.amazon.awscdk.services.eks

Interface AutoScalingGroupCapacityOptions

All Superinterfaces:

CommonAutoScalingGroupProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AutoScalingGroupCapacityOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-10-14T12:28:10.533Z")
@Stability(Stable)
public interface AutoScalingGroupCapacityOptions
extends software.amazon.jsii.JsiiSerializable, CommonAutoScalingGroupProps

Options for adding worker nodes.

Example:

 Cluster cluster;
 cluster.addAutoScalingGroupCapacity("BottlerocketNodes", AutoScalingGroupCapacityOptions.builder()
         .instanceType(new InstanceType("t3.small"))
         .minCapacity(2)
         .machineImageType(MachineImageType.BOTTLEROCKET)
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static AutoScalingGroupCapacityOptions.Builder	builder()
default Boolean	getBootstrapEnabled()	Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke /etc/eks/bootstrap.sh) and associate it with the EKS cluster.
default BootstrapOptions	getBootstrapOptions()	EKS node bootstrapping options.
InstanceType	getInstanceType()	Instance type of the instances to start.
default MachineImageType	getMachineImageType()	Machine image type.
default Boolean	getMapRole()	Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC.
default Boolean	getSpotInterruptHandler()	Installs the AWS spot instance interrupt handler on the cluster if it's not already added.

Methods inherited from interface software.amazon.awscdk.services.autoscaling.CommonAutoScalingGroupProps

getAllowAllOutbound, getAssociatePublicIpAddress, getAutoScalingGroupName, getAzCapacityDistributionStrategy, getBlockDevices, getCapacityRebalance, getCooldown, getDefaultInstanceWarmup, getDesiredCapacity, getGroupMetrics, getHealthCheck, getHealthChecks, getIgnoreUnmodifiedSizeProperties, getInstanceMonitoring, getKeyName, getKeyPair, getMaxCapacity, getMaxInstanceLifetime, getMinCapacity, getNewInstancesProtectedFromScaleIn, getNotifications, getSignals, getSpotPrice, getSsmSessionPermissions, getTerminationPolicies, getTerminationPolicyCustomLambdaFunctionArn, getUpdatePolicy, getVpcSubnets

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInstanceType

@Stability(Stable)
@NotNull
InstanceType getInstanceType()

Instance type of the instances to start.

getBootstrapEnabled

@Stability(Stable)
@Nullable
default Boolean getBootstrapEnabled()

Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke /etc/eks/bootstrap.sh) and associate it with the EKS cluster.

If you wish to provide a custom user data script, set this to false and manually invoke autoscalingGroup.addUserData().

Default: true

getBootstrapOptions

@Stability(Stable)
@Nullable
default BootstrapOptions getBootstrapOptions()

EKS node bootstrapping options.

Default: - none

getMachineImageType

@Stability(Stable)
@Nullable
default MachineImageType getMachineImageType()

Machine image type.

Default: MachineImageType.AMAZON_LINUX_2

getMapRole

@Stability(Stable)
@Nullable
default Boolean getMapRole()

Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC.

This cannot be explicitly set to true if the cluster has kubectl disabled.

Default: - true if the cluster has kubectl enabled (which is the default).

getSpotInterruptHandler

@Stability(Stable)
@Nullable
default Boolean getSpotInterruptHandler()

Installs the AWS spot instance interrupt handler on the cluster if it's not already added.

Only relevant if spotPrice is used.

Default: true

builder

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

Returns:

a AutoScalingGroupCapacityOptions.Builder of AutoScalingGroupCapacityOptions