software.amazon.awscdk.services.ecs

Class AsgCapacityProvider

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.services.ecs.AsgCapacityProvider

All Implemented Interfaces:

IConstruct, IDependable

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-06-22T23:28:01.252Z")
public class AsgCapacityProvider
extends Construct

An Auto Scaling Group Capacity Provider.

This allows an ECS cluster to target a specific EC2 Auto Scaling Group for the placement of tasks. Optionally (and recommended), ECS can manage the number of instances in the ASG to fit the tasks, and can ensure that instances are not prematurely terminated while there are still tasks running on them.

Example:

 Vpc vpc;
 Cluster cluster = Cluster.Builder.create(this, "Cluster")
         .vpc(vpc)
         .build();
 AutoScalingGroup autoScalingGroup = AutoScalingGroup.Builder.create(this, "ASG")
         .vpc(vpc)
         .instanceType(new InstanceType("t2.micro"))
         .machineImage(EcsOptimizedImage.amazonLinux2())
         .minCapacity(0)
         .maxCapacity(100)
         .build();
 AsgCapacityProvider capacityProvider = AsgCapacityProvider.Builder.create(this, "AsgCapacityProvider")
         .autoScalingGroup(autoScalingGroup)
         .build();
 cluster.addAsgCapacityProvider(capacityProvider);
 Ec2TaskDefinition taskDefinition = new Ec2TaskDefinition(this, "TaskDef");
 taskDefinition.addContainer("web", ContainerDefinitionOptions.builder()
         .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
         .memoryReservationMiB(256)
         .build());
 Ec2Service.Builder.create(this, "EC2Service")
         .cluster(cluster)
         .taskDefinition(taskDefinition)
         .capacityProviderStrategies(List.of(CapacityProviderStrategy.builder()
                 .capacityProvider(capacityProvider.getCapacityProviderName())
                 .weight(1)
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AsgCapacityProvider.Builder A fluent builder for AsgCapacityProvider.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default, IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AsgCapacityProvider(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	AsgCapacityProvider(software.amazon.jsii.JsiiObjectRef objRef)
	AsgCapacityProvider(software.constructs.Construct scope, java.lang.String id, AsgCapacityProviderProps props)

Method Summary

Modifier and Type	Method and Description
AutoScalingGroup	getAutoScalingGroup() Auto Scaling Group.
java.lang.Boolean	getCanContainersAccessInstanceRole() Specifies whether the containers can access the container instance role.
java.lang.String	getCapacityProviderName() Capacity provider name.
java.lang.Boolean	getEnableManagedTerminationProtection() Whether managed termination protection is enabled.
MachineImageType	getMachineImageType() Auto Scaling Group machineImageType.

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AsgCapacityProvider

protected AsgCapacityProvider(software.amazon.jsii.JsiiObjectRef objRef)

AsgCapacityProvider

protected AsgCapacityProvider(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

AsgCapacityProvider

public AsgCapacityProvider(software.constructs.Construct scope,
                           java.lang.String id,
                           AsgCapacityProviderProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

getAutoScalingGroup

public AutoScalingGroup getAutoScalingGroup()

Auto Scaling Group.

getCapacityProviderName

public java.lang.String getCapacityProviderName()

Capacity provider name.

Default: Chosen by CloudFormation

getMachineImageType

public MachineImageType getMachineImageType()

Auto Scaling Group machineImageType.

getCanContainersAccessInstanceRole

public java.lang.Boolean getCanContainersAccessInstanceRole()

Specifies whether the containers can access the container instance role.

Default: false

getEnableManagedTerminationProtection

public java.lang.Boolean getEnableManagedTerminationProtection()

Whether managed termination protection is enabled.