interface AsgCapacityProviderProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.ECS.AsgCapacityProviderProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsecs#AsgCapacityProviderProps |
 Java | software.amazon.awscdk.services.ecs.AsgCapacityProviderProps |
 Python | aws_cdk.aws_ecs.AsgCapacityProviderProps |
 TypeScript (source) | aws-cdk-lib » aws_ecs » AsgCapacityProviderProps |
The options for creating an Auto Scaling Group Capacity Provider.
Example
declare const vpc: ec2.Vpc;
const launchTemplate = new ec2.LaunchTemplate(this, 'ASG-LaunchTemplate', {
instanceType: new ec2.InstanceType('t3.medium'),
machineImage: ecs.EcsOptimizedImage.amazonLinux2(),
userData: ec2.UserData.forLinux(),
});
const autoScalingGroup = new autoscaling.AutoScalingGroup(this, 'ASG', {
vpc,
mixedInstancesPolicy: {
instancesDistribution: {
onDemandPercentageAboveBaseCapacity: 50,
},
launchTemplate: launchTemplate,
},
});
const cluster = new ecs.Cluster(this, 'Cluster', { vpc });
const capacityProvider = new ecs.AsgCapacityProvider(this, 'AsgCapacityProvider', {
autoScalingGroup,
machineImageType: ecs.MachineImageType.AMAZON_LINUX_2,
});
cluster.addAsgCapacityProvider(capacityProvider);
Properties
| Name | Type | Description |
|---|---|---|
| auto | IAuto | The autoscaling group to add as a Capacity Provider. |
| can | boolean | Specifies whether the containers can access the container instance role. |
| capacity | string | The name of the capacity provider. |
| enable | boolean | Managed instance draining facilitates graceful termination of Amazon ECS instances. |
| enable | boolean | When enabled the scale-in and scale-out actions of the cluster's Auto Scaling Group will be managed for you. |
| enable | boolean | When enabled the Auto Scaling Group will only terminate EC2 instances that no longer have running non-daemon tasks. |
| instance | number | The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group. |
| machine | Machine | What type of machine image this is. |
| maximum | number | Maximum scaling step size. |
| minimum | number | Minimum scaling step size. |
| spot | boolean | Specify whether to enable Automated Draining for Spot Instances running Amazon ECS Services. |
| target | number | Target capacity percent. |
| topic | IKey | 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 for more information. |
autoScalingGroup
Type:
IAuto
The autoscaling group to add as a Capacity Provider.
Warning: When passing an imported resource using AutoScalingGroup.fromAutoScalingGroupName along with enableManagedTerminationProtection: true,
the AsgCapacityProvider construct will not be able to enforce the option newInstancesProtectedFromScaleIn of the AutoScalingGroup.
In this case the constructor of AsgCapacityProvider will throw an exception.
canContainersAccessInstanceRole?
⚠️ Deprecated: See https://github.com/aws/aws-cdk/discussions/32609
Type:
boolean
(optional, default: true if)
Specifies whether the containers can access the container instance role.
capacityProviderName?
Type:
string
(optional, default: CloudFormation-generated name)
The name of the capacity provider.
If a name is specified,
it cannot start with aws, ecs, or fargate. If no name is specified,
a default name in the CFNStackName-CFNResourceName-RandomString format is used.
If the stack name starts with aws, ecs, or fargate, a unique resource name
is generated that starts with cp-.
enableManagedDraining?
Type:
boolean
(optional, default: true)
Managed instance draining facilitates graceful termination of Amazon ECS instances.
This allows your service workloads to stop safely and be rescheduled to non-terminating instances. Infrastructure maintenance and updates are preformed without disruptions to workloads. To use managed instance draining, set enableManagedDraining to true.
enableManagedScaling?
Type:
boolean
(optional, default: true)
When enabled the scale-in and scale-out actions of the cluster's Auto Scaling Group will be managed for you.
This means your cluster will automatically scale instances based on the load your tasks put on the cluster. For more information, see Using Managed Scaling in the ECS Developer Guide.
enableManagedTerminationProtection?
Type:
boolean
(optional, default: true)
When enabled the Auto Scaling Group will only terminate EC2 instances that no longer have running non-daemon tasks.
Scale-in protection will be automatically enabled on instances. When all non-daemon tasks are stopped on an instance, ECS initiates the scale-in process and turns off scale-in protection for the instance. The Auto Scaling Group can then terminate the instance. For more information see Managed termination protection in the ECS Developer Guide.
Managed scaling must also be enabled.
instanceWarmupPeriod?
Type:
number
(optional, default: 300)
The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group.
Must be between 0 and 10000.
machineImageType?
Type:
Machine
(optional, default: Automatically determined from machineImage, if available, otherwise MachineImageType.AMAZON_LINUX_2.)
What type of machine image this is.
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.
maximumScalingStepSize?
Type:
number
(optional, default: 1000)
Maximum scaling step size.
In most cases this should be left alone.
minimumScalingStepSize?
Type:
number
(optional, default: 1)
Minimum scaling step size.
In most cases this should be left alone.
spotInstanceDraining?
Type:
boolean
(optional, default: false)
Specify whether to enable Automated Draining for Spot Instances running Amazon ECS Services.
For more information, see Using Spot Instances.
targetCapacityPercent?
Type:
number
(optional, default: 100)
Target capacity percent.
In most cases this should be left alone.
topicEncryptionKey?
Type:
IKey
(optional, default: The SNS Topic will not be encrypted.)
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 for more information.