Class AddCapacityOptions
The properties for adding instance capacity to an AutoScalingGroup.
Inheritance
Namespace: Amazon.CDK.AWS.ECS
Assembly: Amazon.CDK.AWS.ECS.dll
Syntax (csharp)
public class AddCapacityOptions : Object, IAddCapacityOptions, IAddAutoScalingGroupCapacityOptions, ICommonAutoScalingGroupProps
Syntax (vb)
Public Class AddCapacityOptions
Inherits Object
Implements IAddCapacityOptions, IAddAutoScalingGroupCapacityOptions, ICommonAutoScalingGroupProps
Remarks
ExampleMetadata: infused
Examples
Vpc vpc;
// Create an ECS cluster
var cluster = new Cluster(this, "Cluster", new ClusterProps {
Vpc = vpc
});
// Add capacity to it
cluster.AddCapacity("DefaultAutoScalingGroupCapacity", new AddCapacityOptions {
InstanceType = new InstanceType("t2.xlarge"),
DesiredCapacity = 3
});
var taskDefinition = new Ec2TaskDefinition(this, "TaskDef");
taskDefinition.AddContainer("DefaultContainer", new ContainerDefinitionOptions {
Image = ContainerImage.FromRegistry("amazon/amazon-ecs-sample"),
MemoryLimitMiB = 512
});
// Instantiate an Amazon ECS Service
var ecsService = new Ec2Service(this, "Service", new Ec2ServiceProps {
Cluster = cluster,
TaskDefinition = taskDefinition
});
Synopsis
Constructors
AddCapacityOptions() |
Properties
AllowAllOutbound | Whether the instances can initiate connections to anywhere by default. |
AssociatePublicIpAddress | Whether instances in the Auto Scaling Group should have public IP addresses associated with them. |
AutoScalingGroupName | The name of the Auto Scaling group. |
BlockDevices | Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. |
CanContainersAccessInstanceRole | Specifies whether the containers can access the container instance role. |
Cooldown | Default scaling cooldown for this AutoScalingGroup. |
DesiredCapacity | Initial amount of instances in the fleet. |
GroupMetrics | Enable monitoring for group metrics, these metrics describe the group rather than any of its instances. |
HealthCheck | Configuration for health checks. |
IgnoreUnmodifiedSizeProperties | If the ASG has scheduled actions, don't reset unchanged group sizes. |
InstanceMonitoring | Controls whether instances in this group are launched with detailed or basic monitoring. |
InstanceType | The EC2 instance type to use when launching instances into the AutoScalingGroup. |
KeyName | Name of SSH keypair to grant access to instances. |
MachineImage | The ECS-optimized AMI variant to use. |
MachineImageType | What type of machine image this is. |
MaxCapacity | Maximum number of instances in the fleet. |
MaxInstanceLifetime | The maximum amount of time that an instance can be in service. |
MinCapacity | Minimum number of instances in the fleet. |
NewInstancesProtectedFromScaleIn | Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. |
Notifications | Configure autoscaling group to send notifications about fleet changes to an SNS topic(s). |
NotificationsTopic | (deprecated) SNS topic to send notifications about fleet changes. |
ReplacingUpdateMinSuccessfulInstancesPercent | (deprecated) Configuration for replacing updates. |
ResourceSignalCount | (deprecated) How many ResourceSignal calls CloudFormation expects before the resource is considered created. |
ResourceSignalTimeout | (deprecated) The length of time to wait for the resourceSignalCount. |
RollingUpdateConfiguration | (deprecated) Configuration for rolling updates. |
Signals | Configure waiting for signals during deployment. |
SpotInstanceDraining | Specify whether to enable Automated Draining for Spot Instances running Amazon ECS Services. |
SpotPrice | The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request. |
TaskDrainTime | (deprecated) The time period to wait before force terminating an instance that is draining. |
TerminationPolicies | A policy or a list of policies that are used to select the instances to terminate. |
TopicEncryptionKey | 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 | What to do when an AutoScalingGroup's instance configuration is changed. |
UpdateType | (deprecated) What to do when an AutoScalingGroup's instance configuration is changed. |
VpcSubnets | Where to place instances within the VPC. |
Constructors
AddCapacityOptions()
public AddCapacityOptions()
Properties
AllowAllOutbound
Whether the instances can initiate connections to anywhere by default.
public Nullable<bool> AllowAllOutbound { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true
AssociatePublicIpAddress
Whether instances in the Auto Scaling Group should have public IP addresses associated with them.
public Nullable<bool> AssociatePublicIpAddress { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: - Use subnet setting.
AutoScalingGroupName
The name of the Auto Scaling group.
public string AutoScalingGroupName { get; set; }
Property Value
System.String
Remarks
This name must be unique per Region per account.
Default: - Auto generated by CloudFormation
BlockDevices
Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes.
public IBlockDevice[] BlockDevices { get; set; }
Property Value
Remarks
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.
Default: - Uses the block device mapping of the AMI
See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html
CanContainersAccessInstanceRole
Specifies whether the containers can access the container instance role.
public Nullable<bool> CanContainersAccessInstanceRole { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Cooldown
Default scaling cooldown for this AutoScalingGroup.
public Duration Cooldown { get; set; }
Property Value
Remarks
Default: Duration.minutes(5)
DesiredCapacity
Initial amount of instances in the fleet.
public Nullable<double> DesiredCapacity { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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.
Default: minCapacity, and leave unchanged during deployment
GroupMetrics
Enable monitoring for group metrics, these metrics describe the group rather than any of its instances.
public GroupMetrics[] GroupMetrics { get; set; }
Property Value
Remarks
To report all group metrics use GroupMetrics.all()
Group metrics are reported in a granularity of 1 minute at no additional charge.
Default: - no group metrics will be reported
HealthCheck
Configuration for health checks.
public HealthCheck HealthCheck { get; set; }
Property Value
Remarks
Default: - HealthCheck.ec2 with no grace period
IgnoreUnmodifiedSizeProperties
If the ASG has scheduled actions, don't reset unchanged group sizes.
public Nullable<bool> IgnoreUnmodifiedSizeProperties { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
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.
Default: true
InstanceMonitoring
Controls whether instances in this group are launched with detailed or basic monitoring.
public Nullable<Monitoring> InstanceMonitoring { get; set; }
Property Value
System.Nullable<Monitoring>
Remarks
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.
Default: - Monitoring.DETAILED
InstanceType
The EC2 instance type to use when launching instances into the AutoScalingGroup.
public InstanceType InstanceType { get; set; }
Property Value
KeyName
Name of SSH keypair to grant access to instances.
public string KeyName { get; set; }
Property Value
System.String
Remarks
Default: - No SSH access will be possible.
MachineImage
The ECS-optimized AMI variant to use.
public IMachineImage MachineImage { get; set; }
Property Value
Remarks
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:
var machineImage = EcsOptimizedImage.AmazonLinux2(AmiHardwareType.STANDARD, new EcsOptimizedImageOptions {
CachedInContext = true
});
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
MachineImageType
What type of machine image this is.
public Nullable<MachineImageType> MachineImageType { get; set; }
Property Value
System.Nullable<MachineImageType>
Remarks
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.
Default: - Automatically determined from machineImage
, if available, otherwise MachineImageType.AMAZON_LINUX_2
.
MaxCapacity
Maximum number of instances in the fleet.
public Nullable<double> MaxCapacity { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: desiredCapacity
MaxInstanceLifetime
The maximum amount of time that an instance can be in service.
public Duration MaxInstanceLifetime { get; set; }
Property Value
Remarks
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.
Default: none
See: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html
MinCapacity
Minimum number of instances in the fleet.
public Nullable<double> MinCapacity { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: 1
NewInstancesProtectedFromScaleIn
Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
public Nullable<bool> NewInstancesProtectedFromScaleIn { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
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.
Default: false
Notifications
Configure autoscaling group to send notifications about fleet changes to an SNS topic(s).
public INotificationConfiguration[] Notifications { get; set; }
Property Value
Remarks
Default: - No fleet change notifications will be sent.
NotificationsTopic
(deprecated) SNS topic to send notifications about fleet changes.
public ITopic NotificationsTopic { get; set; }
Property Value
Remarks
Default: - No fleet change notifications will be sent.
Stability: Deprecated
ReplacingUpdateMinSuccessfulInstancesPercent
(deprecated) Configuration for replacing updates.
public Nullable<double> ReplacingUpdateMinSuccessfulInstancesPercent { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Only used if updateType == UpdateType.ReplacingUpdate. Specifies how many instances must signal success for the update to succeed.
Default: minSuccessfulInstancesPercent
Stability: Deprecated
ResourceSignalCount
(deprecated) How many ResourceSignal calls CloudFormation expects before the resource is considered created.
public Nullable<double> ResourceSignalCount { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: 1 if resourceSignalTimeout is set, 0 otherwise
Stability: Deprecated
ResourceSignalTimeout
(deprecated) The length of time to wait for the resourceSignalCount.
public Duration ResourceSignalTimeout { get; set; }
Property Value
Remarks
The maximum value is 43200 (12 hours).
Default: Duration.minutes(5) if resourceSignalCount is set, N/A otherwise
Stability: Deprecated
RollingUpdateConfiguration
(deprecated) Configuration for rolling updates.
public IRollingUpdateConfiguration RollingUpdateConfiguration { get; set; }
Property Value
Remarks
Only used if updateType == UpdateType.RollingUpdate.
Default: - RollingUpdateConfiguration with defaults.
Stability: Deprecated
Signals
Configure waiting for signals during deployment.
public Signals Signals { get; set; }
Property Value
Remarks
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:
Default: - Do not wait for signals
SpotInstanceDraining
Specify whether to enable Automated Draining for Spot Instances running Amazon ECS Services.
public Nullable<bool> SpotInstanceDraining { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
For more information, see Using Spot Instances.
Default: false
SpotPrice
The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request.
public string SpotPrice { get; set; }
Property Value
System.String
Remarks
Spot Instances are launched when the price you specify exceeds the current Spot market price.
Default: none
TaskDrainTime
(deprecated) The time period to wait before force terminating an instance that is draining.
public Duration TaskDrainTime { get; set; }
Property Value
Remarks
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.
Default: Duration.minutes(5)
Stability: Deprecated
TerminationPolicies
A policy or a list of policies that are used to select the instances to terminate.
public TerminationPolicy[] TerminationPolicies { get; set; }
Property Value
Remarks
The policies are executed in the order that you list them.
Default: - TerminationPolicy.DEFAULT
See: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html
TopicEncryptionKey
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.
public IKey TopicEncryptionKey { get; set; }
Property Value
Remarks
Default: The SNS Topic will not be encrypted.
UpdatePolicy
What to do when an AutoScalingGroup's instance configuration is changed.
public UpdatePolicy UpdatePolicy { get; set; }
Property Value
Remarks
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.
Default: - UpdatePolicy.rollingUpdate()
if using init
, UpdatePolicy.none()
otherwise
UpdateType
(deprecated) What to do when an AutoScalingGroup's instance configuration is changed.
public Nullable<UpdateType> UpdateType { get; set; }
Property Value
System.Nullable<UpdateType>
Remarks
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.
Default: UpdateType.None
Stability: Deprecated
VpcSubnets
Where to place instances within the VPC.
public ISubnetSelection VpcSubnets { get; set; }
Property Value
Remarks
Default: - All Private subnets.