Package software.amazon.awscdk.services.eks

Interface AutoScalingGroupOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AutoScalingGroupOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.109.0 (build c221850)",
           date="2025-03-14T03:24:58.006Z")
@Stability(Stable)
public interface AutoScalingGroupOptions
extends software.amazon.jsii.JsiiSerializable

Options for adding an AutoScalingGroup as capacity.

Example:

 Cluster cluster;
 AutoScalingGroup asg;
 cluster.connectAutoScalingGroupCapacity(asg, AutoScalingGroupOptions.builder().build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static AutoScalingGroupOptions.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()	Allows options for node bootstrapping through EC2 user data.
default MachineImageType	getMachineImageType()	Allow options to specify different 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.jsii.JsiiSerializable

$jsii$toJson

Method Details

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

Allows options for node bootstrapping through EC2 user data.

Default: - default options

getMachineImageType

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

Allow options to specify different 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 configured on the auto-scaling group.

Default: true

builder

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

Returns:

a AutoScalingGroupOptions.Builder of AutoScalingGroupOptions