interface AddCapacityOptions
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.ECS.AddCapacityOptions |
Java | software.amazon.awscdk.services.ecs.AddCapacityOptions |
Python | aws_cdk.aws_ecs.AddCapacityOptions |
TypeScript (source) | @aws-cdk/aws-ecs » AddCapacityOptions |
The properties for adding instance capacity to an AutoScalingGroup.
Example
declare const vpc: ec2.Vpc;
// Create an ECS cluster
const cluster = new ecs.Cluster(this, 'Cluster', {
vpc,
});
// Add capacity to it
cluster.addCapacity('DefaultAutoScalingGroupCapacity', {
instanceType: new ec2.InstanceType("t2.xlarge"),
desiredCapacity: 3,
});
const taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');
taskDefinition.addContainer('DefaultContainer', {
image: ecs.ContainerImage.fromRegistry("amazon/amazon-ecs-sample"),
memoryLimitMiB: 512,
});
// Instantiate an Amazon ECS Service
const ecsService = new ecs.Ec2Service(this, 'Service', {
cluster,
taskDefinition,
});
Properties
Name | Type | Description |
---|---|---|
instance | Instance | The EC2 instance type to use when launching instances into the AutoScalingGroup. |
allow | boolean | Whether the instances can initiate connections to anywhere by default. |
associate | boolean | Whether instances in the Auto Scaling Group should have public IP addresses associated with them. |
auto | string | The name of the Auto Scaling group. |
block | Block [] | Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. |
can | boolean | Specifies whether the containers can access the container instance role. |
cooldown? | Duration | Default scaling cooldown for this AutoScalingGroup. |
desired | number | Initial amount of instances in the fleet. |
group | Group [] | Enable monitoring for group metrics, these metrics describe the group rather than any of its instances. |
health | Health | Configuration for health checks. |
ignore | boolean | If the ASG has scheduled actions, don't reset unchanged group sizes. |
instance | Monitoring | Controls whether instances in this group are launched with detailed or basic monitoring. |
key | string | Name of SSH keypair to grant access to instances. |
machine | IMachine | The ECS-optimized AMI variant to use. |
machine | Machine | What type of machine image this is. |
max | number | Maximum number of instances in the fleet. |
max | Duration | The maximum amount of time that an instance can be in service. |
min | number | Minimum number of instances in the fleet. |
new | boolean | Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. |
notifications? | Notification [] | Configure autoscaling group to send notifications about fleet changes to an SNS topic(s). |
notifications | ITopic | SNS topic to send notifications about fleet changes. |
replacing | number | Configuration for replacing updates. |
resource | number | How many ResourceSignal calls CloudFormation expects before the resource is considered created. |
resource | Duration | The length of time to wait for the resourceSignalCount. |
rolling | Rolling | Configuration for rolling updates. |
signals? | Signals | Configure waiting for signals during deployment. |
spot | boolean | Specify whether to enable Automated Draining for Spot Instances running Amazon ECS Services. |
spot | string | The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request. |
task | Duration | The time period to wait before force terminating an instance that is draining. |
termination | Termination [] | A policy or a list of policies that are used to select the instances to terminate. |
topic | IKey | If {@link 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. |
update | Update | What to do when an AutoScalingGroup's instance configuration is changed. |
update | Update | What to do when an AutoScalingGroup's instance configuration is changed. |
vpc | Subnet | Where to place instances within the VPC. |
instanceType
Type:
Instance
The EC2 instance type to use when launching instances into the AutoScalingGroup.
allowAllOutbound?
Type:
boolean
(optional, default: true)
Whether the instances can initiate connections to anywhere by default.
associatePublicIpAddress?
Type:
boolean
(optional, default: Use subnet setting.)
Whether instances in the Auto Scaling Group should have public IP addresses associated with them.
autoScalingGroupName?
Type:
string
(optional, default: Auto generated by CloudFormation)
The name of the Auto Scaling group.
This name must be unique per Region per account.
blockDevices?
Type:
Block
[]
(optional, default: Uses the block device mapping of the AMI)
Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes.
Each instance that is launched has an associated root device volume, either an Amazon EBS volume or an instance store volume. You can use block device mappings to specify additional EBS volumes or instance store volumes to attach to an instance when it is launched.
See also: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html
canContainersAccessInstanceRole?
Type:
boolean
(optional, default: false)
Specifies whether the containers can access the container instance role.
cooldown?
Type:
Duration
(optional, default: Duration.minutes(5))
Default scaling cooldown for this AutoScalingGroup.
desiredCapacity?
Type:
number
(optional, default: minCapacity, and leave unchanged during deployment)
Initial amount of instances in the fleet.
If this is set to a number, every deployment will reset the amount of instances to this number. It is recommended to leave this value blank.
groupMetrics?
Type:
Group
[]
(optional, default: no group metrics will be reported)
Enable monitoring for group metrics, these metrics describe the group rather than any of its instances.
To report all group metrics use GroupMetrics.all()
Group metrics are reported in a granularity of 1 minute at no additional charge.
healthCheck?
Type:
Health
(optional, default: HealthCheck.ec2 with no grace period)
Configuration for health checks.
ignoreUnmodifiedSizeProperties?
Type:
boolean
(optional, default: true)
If the ASG has scheduled actions, don't reset unchanged group sizes.
Only used if the ASG has scheduled actions (which may scale your ASG up or down regardless of cdk deployments). If true, the size of the group will only be reset if it has been changed in the CDK app. If false, the sizes will always be changed back to what they were in the CDK app on deployment.
instanceMonitoring?
Type:
Monitoring
(optional, default: Monitoring.DETAILED)
Controls whether instances in this group are launched with detailed or basic monitoring.
When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes.
keyName?
Type:
string
(optional, default: No SSH access will be possible.)
Name of SSH keypair to grant access to instances.
machineImage?
Type:
IMachine
(optional, default: Automatically updated, ECS-optimized Amazon Linux 2)
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:
const machineImage = ecs.EcsOptimizedImage.amazonLinux2(ecs.AmiHardwareType.STANDARD, {
cachedInContext: true,
});
For more information, see Amazon ECS-optimized AMIs.
You must define either machineImage
or machineImageType
, not both.
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.
maxCapacity?
Type:
number
(optional, default: desiredCapacity)
Maximum number of instances in the fleet.
maxInstanceLifetime?
Type:
Duration
(optional, default: none)
The maximum amount of time that an instance can be in service.
The maximum duration applies to all current and future instances in the group. As an instance approaches its maximum duration, it is terminated and replaced, and cannot be used again.
You must specify a value of at least 604,800 seconds (7 days). To clear a previously set value, leave this property undefined.
See also: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html
minCapacity?
Type:
number
(optional, default: 1)
Minimum number of instances in the fleet.
newInstancesProtectedFromScaleIn?
Type:
boolean
(optional, default: false)
Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
By default, Auto Scaling can terminate an instance at any time after launch when scaling in an Auto Scaling Group, subject to the group's termination policy. However, you may wish to protect newly-launched instances from being scaled in if they are going to run critical applications that should not be prematurely terminated.
This flag must be enabled if the Auto Scaling Group will be associated with an ECS Capacity Provider with managed termination protection.
notifications?
Type:
Notification
[]
(optional, default: No fleet change notifications will be sent.)
Configure autoscaling group to send notifications about fleet changes to an SNS topic(s).
notificationsTopic?
⚠️ Deprecated: use notifications
Type:
ITopic
(optional, default: No fleet change notifications will be sent.)
SNS topic to send notifications about fleet changes.
replacingUpdateMinSuccessfulInstancesPercent?
⚠️ Deprecated: Use signals
instead
Type:
number
(optional, default: minSuccessfulInstancesPercent)
Configuration for replacing updates.
Only used if updateType == UpdateType.ReplacingUpdate. Specifies how many instances must signal success for the update to succeed.
resourceSignalCount?
⚠️ Deprecated: Use signals
instead.
Type:
number
(optional, default: 1 if resourceSignalTimeout is set, 0 otherwise)
How many ResourceSignal calls CloudFormation expects before the resource is considered created.
resourceSignalTimeout?
⚠️ Deprecated: Use signals
instead.
Type:
Duration
(optional, default: Duration.minutes(5) if resourceSignalCount is set, N/A otherwise)
The length of time to wait for the resourceSignalCount.
The maximum value is 43200 (12 hours).
rollingUpdateConfiguration?
⚠️ Deprecated: Use updatePolicy
instead
Type:
Rolling
(optional, default: RollingUpdateConfiguration with defaults.)
Configuration for rolling updates.
Only used if updateType == UpdateType.RollingUpdate.
signals?
Type:
Signals
(optional, default: Do not wait for signals)
Configure waiting for signals during deployment.
Use this to pause the CloudFormation deployment to wait for the instances
in the AutoScalingGroup to report successful startup during
creation and updates. The UserData script needs to invoke cfn-signal
with a success or failure code after it is done setting up the instance.
Without waiting for signals, the CloudFormation deployment will proceed as soon as the AutoScalingGroup has been created or updated but before the instances in the group have been started.
For example, to have instances wait for an Elastic Load Balancing health check before they signal success, add a health-check verification by using the cfn-init helper script. For an example, see the verify_instance_health command in the Auto Scaling rolling updates sample template:
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.
spotPrice?
Type:
string
(optional, default: none)
The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request.
Spot Instances are launched when the price you specify exceeds the current Spot market price.
taskDrainTime?
⚠️ Deprecated: The lifecycle draining hook is not configured if using the EC2 Capacity Provider. Enable managed termination protection instead.
Type:
Duration
(optional, default: Duration.minutes(5))
The time period to wait before force terminating an instance that is draining.
This creates a Lambda function that is used by a lifecycle hook for the AutoScalingGroup that will delay instance termination until all ECS tasks have drained from the instance. Set to 0 to disable task draining.
Set to 0 to disable task draining.
terminationPolicies?
Type:
Termination
[]
(optional, default: TerminationPolicy.DEFAULT
)
A policy or a list of policies that are used to select the instances to terminate.
The policies are executed in the order that you list them.
See also: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html
topicEncryptionKey?
Type:
IKey
(optional, default: The SNS Topic will not be encrypted.)
If {@link 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.
updatePolicy?
Type:
Update
(optional, default: UpdatePolicy.rollingUpdate()
if using init
, UpdatePolicy.none()
otherwise)
What to do when an AutoScalingGroup's instance configuration is changed.
This is applied when any of the settings on the ASG are changed that affect how the instances should be created (VPC, instance type, startup scripts, etc.). It indicates how the existing instances should be replaced with new instances matching the new config. By default, nothing is done and only new instances are launched with the new config.
updateType?
⚠️ Deprecated: Use updatePolicy
instead
Type:
Update
(optional, default: UpdateType.None)
What to do when an AutoScalingGroup's instance configuration is changed.
This is applied when any of the settings on the ASG are changed that affect how the instances should be created (VPC, instance type, startup scripts, etc.). It indicates how the existing instances should be replaced with new instances matching the new config. By default, nothing is done and only new instances are launched with the new config.
vpcSubnets?
Type:
Subnet
(optional, default: All Private subnets.)
Where to place instances within the VPC.