Skip to content
v2.273.0

AddAutoScalingGroupCapacityOptions Struct ​

The properties for adding an AutoScalingGroup.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ecs as ecs } from 'aws-cdk-lib';
import { aws_kms as kms } from 'aws-cdk-lib';

declare const key: kms.Key;
const addAutoScalingGroupCapacityOptions: ecs.AddAutoScalingGroupCapacityOptions = {
  machineImageType: ecs.MachineImageType.AMAZON_LINUX_2,
  spotInstanceDraining: false,
  topicEncryptionKey: key,
};

Properties ​

machineImageTypeMachineImageTypemachine_image_typeMachineImageTypemachineImageTypeMachineImageTypeMachineImageTypeMachineImageTypeMachineImageTypeMachineImageType= Automatically determined from `m…#
What type of machine image this is.
notes · default

Depending on the setting, different UserData will automatically be added to the AutoScalingGroup to configure it properly for use with ECS.

If you create an AutoScalingGroup yourself and are adding it via addAutoScalingGroup(), you must specify this value. If you are adding an autoScalingGroup via addCapacity, this value will be determined from the machineImage you pass.

Default: Automatically determined from machineImage, if available, otherwise MachineImageType.AMAZON_LINUX_2.

spotInstanceDrainingbooleanspot_instance_drainingboolspotInstanceDrainingBooleanSpotInstanceDrainingboolSpotInstanceDraining*bool= false#
Specify whether to enable Automated Draining for Spot Instances running Amazon ECS Services.

For more information, see Using Spot Instances.

topicEncryptionKeyIKeytopic_encryption_keyIKeytopicEncryptionKeyIKeyTopicEncryptionKeyIKeyTopicEncryptionKeyIKey= The SNS Topic will not be encryp…#
If `AddAutoScalingGroupCapacityOptions.taskDrainTime` is non-zero, then the ECS cluster creates an SNS Topic to as part of a system to drain instances of tasks when the instance is being shut down. If this property is provided, then this key will be used to encrypt the contents of that SNS Topic. See [SNS Data Encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-data-encryption.html) for more information.
default

Default: The SNS Topic will not be encrypted.