software.amazon.awscdk.services.eks

Interface AutoScalingGroupCapacityOptions

All Superinterfaces:

CommonAutoScalingGroupProps

All Known Implementing Classes:

AutoScalingGroupCapacityOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:26.674Z")
public interface AutoScalingGroupCapacityOptions
extends 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 and Description
static class	AutoScalingGroupCapacityOptions.Builder A builder for AutoScalingGroupCapacityOptions
static class	AutoScalingGroupCapacityOptions.Jsii$Proxy An implementation for AutoScalingGroupCapacityOptions

Method Summary

Modifier and Type	Method and Description
static AutoScalingGroupCapacityOptions.Builder	builder()
default java.lang.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 java.lang.Boolean	getMapRole() Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC.
default java.lang.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, getBlockDevices, getCooldown, getDesiredCapacity, getGroupMetrics, getHealthCheck, getIgnoreUnmodifiedSizeProperties, getInstanceMonitoring, getKeyName, getMaxCapacity, getMaxInstanceLifetime, getMinCapacity, getNewInstancesProtectedFromScaleIn, getNotifications, getNotificationsTopic, getReplacingUpdateMinSuccessfulInstancesPercent, getResourceSignalCount, getResourceSignalTimeout, getRollingUpdateConfiguration, getSignals, getSpotPrice, getTerminationPolicies, getUpdatePolicy, getUpdateType, getVpcSubnets

Method Detail

getInstanceType

InstanceType getInstanceType()

Instance type of the instances to start.

getBootstrapEnabled

default java.lang.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

default BootstrapOptions getBootstrapOptions()

EKS node bootstrapping options.

Default: - none

getMachineImageType

default MachineImageType getMachineImageType()

Machine image type.

Default: MachineImageType.AMAZON_LINUX_2

getMapRole

default java.lang.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

default java.lang.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

static AutoScalingGroupCapacityOptions.Builder builder()

Specified by:

builder in interface CommonAutoScalingGroupProps

Returns:

a AutoScalingGroupCapacityOptions.Builder of AutoScalingGroupCapacityOptions