software.amazon.awscdk.services.ecs

Class AsgCapacityProvider

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.services.ecs.AsgCapacityProvider

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.569Z")
 @Stability(value=Stable)
public class AsgCapacityProvider
extends software.constructs.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:

 // Example automatically generated from non-compiling source. May contain errors.
 LaunchTemplate launchTemplate = LaunchTemplate.Builder.create(this, "ASG-LaunchTemplate")
         .instanceType(new InstanceType("t3.medium"))
         .machineImage(EcsOptimizedImage.amazonLinux2())
         .userData(UserData.forLinux())
         .build();
 AutoScalingGroup autoScalingGroup = AutoScalingGroup.Builder.create(this, "ASG")
         .vpc(vpc)
         .mixedInstancesPolicy(MixedInstancesPolicy.builder()
                 .instancesDistribution(InstancesDistribution.builder()
                         .onDemandPercentageAboveBaseCapacity(50)
                         .build())
                 .launchTemplate(launchTemplate)
                 .build())
         .build();
 Cluster cluster = Cluster.Builder.create(this, "Cluster").vpc(vpc).build();
 AsgCapacityProvider capacityProvider = AsgCapacityProvider.Builder.create(this, "AsgCapacityProvider")
         .autoScalingGroup(autoScalingGroup)
         .machineImageType(MachineImageType.AMAZON_LINUX_2)
         .build();
 cluster.addAsgCapacityProvider(capacityProvider);
 

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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

AsgCapacityProvider

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

AsgCapacityProvider

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

AsgCapacityProvider

@Stability(value=Stable)
public AsgCapacityProvider(@NotNull
                                                    software.constructs.Construct scope,
                                                    @NotNull
                                                    String id,
                                                    @NotNull
                                                    AsgCapacityProviderProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

getAutoScalingGroup

@Stability(value=Stable)
 @NotNull
public AutoScalingGroup getAutoScalingGroup()

Auto Scaling Group.

getCapacityProviderName

@Stability(value=Stable)
 @NotNull
public String getCapacityProviderName()

Capacity provider name.

Default: Chosen by CloudFormation

getMachineImageType

@Stability(value=Stable)
 @NotNull
public MachineImageType getMachineImageType()

Auto Scaling Group machineImageType.

getCanContainersAccessInstanceRole

@Stability(value=Stable)
 @Nullable
public Boolean getCanContainersAccessInstanceRole()

Specifies whether the containers can access the container instance role.

Default: false

getEnableManagedTerminationProtection

@Stability(value=Stable)
 @Nullable
public Boolean getEnableManagedTerminationProtection()

Whether managed termination protection is enabled.