software.amazon.awscdk.services.ecs

Interface AddCapacityOptions

All Superinterfaces:

AddAutoScalingGroupCapacityOptions, CommonAutoScalingGroupProps

All Known Implementing Classes:

AddCapacityOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:37:00.039Z")
public interface AddCapacityOptions
extends AddAutoScalingGroupCapacityOptions, CommonAutoScalingGroupProps

The properties for adding instance capacity to an AutoScalingGroup.

Example:

 Vpc vpc;
 // Create an ECS cluster
 Cluster cluster = Cluster.Builder.create(this, "Cluster")
         .vpc(vpc)
         .build();
 // Add capacity to it
 cluster.addCapacity("DefaultAutoScalingGroupCapacity", AddCapacityOptions.builder()
         .instanceType(new InstanceType("t2.xlarge"))
         .desiredCapacity(3)
         .build());
 Ec2TaskDefinition taskDefinition = new Ec2TaskDefinition(this, "TaskDef");
 taskDefinition.addContainer("DefaultContainer", ContainerDefinitionOptions.builder()
         .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
         .memoryLimitMiB(512)
         .build());
 // Instantiate an Amazon ECS Service
 Ec2Service ecsService = Ec2Service.Builder.create(this, "Service")
         .cluster(cluster)
         .taskDefinition(taskDefinition)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static AddCapacityOptions.Builder	builder()
InstanceType	getInstanceType() The EC2 instance type to use when launching instances into the AutoScalingGroup.
default IMachineImage	getMachineImage() The ECS-optimized AMI variant to use.

Methods inherited from interface software.amazon.awscdk.services.ecs.AddAutoScalingGroupCapacityOptions

getCanContainersAccessInstanceRole, getMachineImageType, getSpotInstanceDraining, getTaskDrainTime, getTopicEncryptionKey

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

The EC2 instance type to use when launching instances into the AutoScalingGroup.

getMachineImage

default IMachineImage getMachineImage()

The ECS-optimized AMI variant to use.

The default is to use an ECS-optimized AMI of Amazon Linux 2 which is automatically updated to the latest version on every deployment. This will replace the instances in the AutoScalingGroup. Make sure you have not disabled task draining, to avoid downtime when the AMI updates.

To use an image that does not update on every deployment, pass:

 EcsOptimizedImage machineImage = EcsOptimizedImage.amazonLinux2(AmiHardwareType.STANDARD, EcsOptimizedImageOptions.builder()
         .cachedInContext(true)
         .build());
 

For more information, see Amazon ECS-optimized AMIs.

You must define either machineImage or machineImageType, not both.

Default: - Automatically updated, ECS-optimized Amazon Linux 2

builder

static AddCapacityOptions.Builder builder()

Specified by:

builder in interface AddAutoScalingGroupCapacityOptions

Specified by:

builder in interface CommonAutoScalingGroupProps

Returns:

a AddCapacityOptions.Builder of AddCapacityOptions