Skip to content
v2.278.0

AutoScalingGroupOptions Struct ​

Options for adding an AutoScalingGroup as capacity.

Example ​

ts
declare const cluster: eks.Cluster;
declare const asg: autoscaling.AutoScalingGroup;
cluster.connectAutoScalingGroupCapacity(asg, {});
python
# cluster: eks.Cluster
# asg: autoscaling.AutoScalingGroup

cluster.connect_auto_scaling_group_capacity(asg)
java
Cluster cluster;
AutoScalingGroup asg;

cluster.connectAutoScalingGroupCapacity(asg, AutoScalingGroupOptions.builder().build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
Cluster cluster;
AutoScalingGroup asg;

cluster.ConnectAutoScalingGroupCapacity(asg, new AutoScalingGroupOptions { });
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var cluster Cluster
var asg AutoScalingGroup

cluster.connectAutoScalingGroupCapacity(asg, &AutoScalingGroupOptions{
})

Properties ​

bootstrapEnabledoptionalbooleanbootstrap_enabledoptionalboolbootstrapEnabledoptionalBooleanBootstrapEnabledoptionalboolBootstrapEnabledoptional*bool = true #
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().

bootstrapOptionsoptionalBootstrapOptionsbootstrap_optionsoptionalBootstrapOptionsbootstrapOptionsoptionalBootstrapOptionsBootstrapOptionsoptionalBootstrapOptionsBootstrapOptionsoptionalBootstrapOptions #
Allows options for node bootstrapping through EC2 user data.

Default: default options

machineImageTypeoptionalMachineImageTypemachine_image_typeoptionalMachineImageTypemachineImageTypeoptionalMachineImageTypeMachineImageTypeoptionalMachineImageTypeMachineImageTypeoptionalMachineImageType = MachineImageType.AMAZON_LINUX_2 #
Allow options to specify different machine image type.
mapRoleoptionalbooleanmap_roleoptionalboolmapRoleoptionalBooleanMapRoleoptionalboolMapRoleoptional*bool #
Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC.

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

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

spotInterruptHandleroptionalbooleanspot_interrupt_handleroptionalboolspotInterruptHandleroptionalBooleanSpotInterruptHandleroptionalboolSpotInterruptHandleroptional*bool = true #
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.