AddCapacityOptions¶
-
class
aws_cdk.aws_ecs.
AddCapacityOptions
(*, can_containers_access_instance_role=None, machine_image_type=None, spot_instance_draining=None, task_drain_time=None, topic_encryption_key=None, allow_all_outbound=None, associate_public_ip_address=None, auto_scaling_group_name=None, block_devices=None, cooldown=None, desired_capacity=None, group_metrics=None, health_check=None, ignore_unmodified_size_properties=None, instance_monitoring=None, key_name=None, max_capacity=None, max_instance_lifetime=None, min_capacity=None, notifications=None, notifications_topic=None, replacing_update_min_successful_instances_percent=None, resource_signal_count=None, resource_signal_timeout=None, rolling_update_configuration=None, signals=None, spot_price=None, update_policy=None, update_type=None, vpc_subnets=None, instance_type, machine_image=None)¶ Bases:
aws_cdk.aws_ecs.AddAutoScalingGroupCapacityOptions
,aws_cdk.aws_autoscaling.CommonAutoScalingGroupProps
The properties for adding instance capacity to an AutoScalingGroup.
- Parameters
can_containers_access_instance_role (
Optional
[bool
]) – Specifies whether the containers can access the container instance role. Default: falsemachine_image_type (
Optional
[MachineImageType
]) – Specify the machine image type. Default: MachineImageType.AMAZON_LINUX_2spot_instance_draining (
Optional
[bool
]) – Specify whether to enable Automated Draining for Spot Instances running Amazon ECS Services. For more information, see Using Spot Instances. Default: falsetask_drain_time (
Optional
[Duration
]) – 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. Default: Duration.minutes(5)topic_encryption_key (
Optional
[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. Default: The SNS Topic will not be encrypted.allow_all_outbound (
Optional
[bool
]) – Whether the instances can initiate connections to anywhere by default. Default: trueassociate_public_ip_address (
Optional
[bool
]) – Whether instances in the Auto Scaling Group should have public IP addresses associated with them. Default: - Use subnet setting.auto_scaling_group_name (
Optional
[str
]) – The name of the Auto Scaling group. This name must be unique per Region per account. Default: - Auto generated by CloudFormationblock_devices (
Optional
[List
[BlockDevice
]]) – 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. Default: - Uses the block device mapping of the AMIcooldown (
Optional
[Duration
]) – Default scaling cooldown for this AutoScalingGroup. Default: Duration.minutes(5)desired_capacity (
Union
[int
,float
,None
]) – 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. Default: minCapacity, and leave unchanged during deploymentgroup_metrics (
Optional
[List
[GroupMetrics
]]) – Enable monitoring for group metrics, these metrics describe the group rather than any of its instances. To report all group metrics useGroupMetrics.all()
Group metrics are reported in a granularity of 1 minute at no additional charge. Default: - no group metrics will be reportedhealth_check (
Optional
[HealthCheck
]) – Configuration for health checks. Default: - HealthCheck.ec2 with no grace periodignore_unmodified_size_properties (
Optional
[bool
]) – 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. Default: trueinstance_monitoring (
Optional
[Monitoring
]) – 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. Default: - Monitoring.DETAILEDkey_name (
Optional
[str
]) – Name of SSH keypair to grant access to instances. Default: - No SSH access will be possible.max_capacity (
Union
[int
,float
,None
]) – Maximum number of instances in the fleet. Default: desiredCapacitymax_instance_lifetime (
Optional
[Duration
]) – 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. Default: nonemin_capacity (
Union
[int
,float
,None
]) – Minimum number of instances in the fleet. Default: 1notifications (
Optional
[List
[NotificationConfiguration
]]) – Configure autoscaling group to send notifications about fleet changes to an SNS topic(s). Default: - No fleet change notifications will be sent.notifications_topic (
Optional
[ITopic
]) – (deprecated) SNS topic to send notifications about fleet changes. Default: - No fleet change notifications will be sent.replacing_update_min_successful_instances_percent (
Union
[int
,float
,None
]) – (deprecated) Configuration for replacing updates. Only used if updateType == UpdateType.ReplacingUpdate. Specifies how many instances must signal success for the update to succeed. Default: minSuccessfulInstancesPercentresource_signal_count (
Union
[int
,float
,None
]) – (deprecated) How many ResourceSignal calls CloudFormation expects before the resource is considered created. Default: 1 if resourceSignalTimeout is set, 0 otherwiseresource_signal_timeout (
Optional
[Duration
]) – (deprecated) The length of time to wait for the resourceSignalCount. The maximum value is 43200 (12 hours). Default: Duration.minutes(5) if resourceSignalCount is set, N/A otherwiserolling_update_configuration (
Optional
[RollingUpdateConfiguration
]) – (deprecated) Configuration for rolling updates. Only used if updateType == UpdateType.RollingUpdate. Default: - RollingUpdateConfiguration with defaults.signals (
Optional
[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 invokecfn-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: https://github.com/awslabs/aws-cloudformation-templates/blob/master/aws/services/AutoScaling/AutoScalingRollingUpdates.yaml Default: - Do not wait for signalsspot_price (
Optional
[str
]) – 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. Default: noneupdate_policy (
Optional
[UpdatePolicy
]) – 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. Default: -UpdatePolicy.rollingUpdate()
if usinginit
,UpdatePolicy.none()
otherwiseupdate_type (
Optional
[UpdateType
]) – (deprecated) 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. Default: UpdateType.Nonevpc_subnets (
Optional
[SubnetSelection
]) – Where to place instances within the VPC. Default: - All Private subnets.instance_type (
InstanceType
) – The EC2 instance type to use when launching instances into the AutoScalingGroup.machine_image (
Optional
[IMachineImage
]) – The ECS-optimized AMI variant to use. For more information, see Amazon ECS-optimized AMIs. You must define eithermachineImage
ormachineImageType
, not both. Default: - Amazon Linux 2
Attributes
-
allow_all_outbound
¶ Whether the instances can initiate connections to anywhere by default.
- Default
true
- Return type
Optional
[bool
]
-
associate_public_ip_address
¶ Whether instances in the Auto Scaling Group should have public IP addresses associated with them.
- Default
Use subnet setting.
- Return type
Optional
[bool
]
-
auto_scaling_group_name
¶ The name of the Auto Scaling group.
This name must be unique per Region per account.
- Default
Auto generated by CloudFormation
- Return type
Optional
[str
]
-
block_devices
¶ 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.
- Default
Uses the block device mapping of the AMI
- See
https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html
- Return type
Optional
[List
[BlockDevice
]]
-
can_containers_access_instance_role
¶ Specifies whether the containers can access the container instance role.
- Default
false
- Return type
Optional
[bool
]
-
cooldown
¶ Default scaling cooldown for this AutoScalingGroup.
- Default
Duration.minutes(5)
- Return type
Optional
[Duration
]
-
desired_capacity
¶ 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.
- Default
minCapacity, and leave unchanged during deployment
- See
- Return type
Union
[int
,float
,None
]
-
group_metrics
¶ 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.- Default
no group metrics will be reported
- Return type
Optional
[List
[GroupMetrics
]]
-
health_check
¶ Configuration for health checks.
- Default
HealthCheck.ec2 with no grace period
- Return type
Optional
[HealthCheck
]
-
ignore_unmodified_size_properties
¶ 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.
- Default
true
- Return type
Optional
[bool
]
-
instance_monitoring
¶ 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.
- Default
Monitoring.DETAILED
- See
- Return type
Optional
[Monitoring
]
-
instance_type
¶ The EC2 instance type to use when launching instances into the AutoScalingGroup.
- Return type
-
key_name
¶ Name of SSH keypair to grant access to instances.
- Default
No SSH access will be possible.
- Return type
Optional
[str
]
-
machine_image
¶ The ECS-optimized AMI variant to use.
For more information, see Amazon ECS-optimized AMIs. You must define either
machineImage
ormachineImageType
, not both.- Default
Amazon Linux 2
- Return type
Optional
[IMachineImage
]
-
machine_image_type
¶ Specify the machine image type.
- Default
MachineImageType.AMAZON_LINUX_2
- Return type
Optional
[MachineImageType
]
-
max_capacity
¶ Maximum number of instances in the fleet.
- Default
desiredCapacity
- Return type
Union
[int
,float
,None
]
-
max_instance_lifetime
¶ 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.
- Default
none
- See
https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html
- Return type
Optional
[Duration
]
-
min_capacity
¶ Minimum number of instances in the fleet.
- Default
1
- Return type
Union
[int
,float
,None
]
-
notifications
¶ Configure autoscaling group to send notifications about fleet changes to an SNS topic(s).
- Default
No fleet change notifications will be sent.
- See
- Return type
Optional
[List
[NotificationConfiguration
]]
-
notifications_topic
¶ (deprecated) SNS topic to send notifications about fleet changes.
- Default
No fleet change notifications will be sent.
- Deprecated
use
notifications
- Stability
deprecated
- Return type
Optional
[ITopic
]
-
replacing_update_min_successful_instances_percent
¶ (deprecated) Configuration for replacing updates.
Only used if updateType == UpdateType.ReplacingUpdate. Specifies how many instances must signal success for the update to succeed.
- Default
minSuccessfulInstancesPercent
- Deprecated
Use
signals
instead- Stability
deprecated
- Return type
Union
[int
,float
,None
]
-
resource_signal_count
¶ (deprecated) How many ResourceSignal calls CloudFormation expects before the resource is considered created.
- Default
1 if resourceSignalTimeout is set, 0 otherwise
- Deprecated
Use
signals
instead.- Stability
deprecated
- Return type
Union
[int
,float
,None
]
-
resource_signal_timeout
¶ (deprecated) The length of time to wait for the resourceSignalCount.
The maximum value is 43200 (12 hours).
- Default
Duration.minutes(5) if resourceSignalCount is set, N/A otherwise
- Deprecated
Use
signals
instead.- Stability
deprecated
- Return type
Optional
[Duration
]
-
rolling_update_configuration
¶ (deprecated) Configuration for rolling updates.
Only used if updateType == UpdateType.RollingUpdate.
- Default
RollingUpdateConfiguration with defaults.
- Deprecated
Use
updatePolicy
instead- Stability
deprecated
- Return type
Optional
[RollingUpdateConfiguration
]
-
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:
- Default
Do not wait for signals
- Return type
Optional
[Signals
]
-
spot_instance_draining
¶ Specify whether to enable Automated Draining for Spot Instances running Amazon ECS Services.
For more information, see Using Spot Instances.
- Default
false
- Return type
Optional
[bool
]
-
spot_price
¶ 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.
- Default
none
- Return type
Optional
[str
]
-
task_drain_time
¶ 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.
- Default
Duration.minutes(5)
- Return type
Optional
[Duration
]
-
topic_encryption_key
¶ //docs.aws.amazon.com/sns/latest/dg/sns-data-encryption.html>`_ for more information.
- Default
The SNS Topic will not be encrypted.
- Type
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 <https
- Return type
Optional
[IKey
]
-
update_policy
¶ 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.
- Default
UpdatePolicy.rollingUpdate()
if usinginit
,UpdatePolicy.none()
otherwise
- Return type
Optional
[UpdatePolicy
]
-
update_type
¶ (deprecated) 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.
- Default
UpdateType.None
- Deprecated
Use
updatePolicy
instead- Stability
deprecated
- Return type
Optional
[UpdateType
]
-
vpc_subnets
¶ Where to place instances within the VPC.
- Default
All Private subnets.
- Return type
Optional
[SubnetSelection
]