AsgCapacityProviderProps
- class aws_cdk.aws_ecs.AsgCapacityProviderProps(*, can_containers_access_instance_role=None, machine_image_type=None, spot_instance_draining=None, topic_encryption_key=None, auto_scaling_group, capacity_provider_name=None, enable_managed_draining=None, enable_managed_scaling=None, enable_managed_termination_protection=None, instance_warmup_period=None, maximum_scaling_step_size=None, minimum_scaling_step_size=None, target_capacity_percent=None)
Bases:
AddAutoScalingGroupCapacityOptions
The options for creating an Auto Scaling Group Capacity Provider.
- Parameters:
can_containers_access_instance_role (
Optional
[bool
]) – Specifies whether the containers can access the container instance role. Default: falsemachine_image_type (
Optional
[MachineImageType
]) – What type of machine image this is. Depending on the setting, different UserData will automatically be added to theAutoScalingGroup
to configure it properly for use with ECS. If you create anAutoScalingGroup
yourself and are adding it viaaddAutoScalingGroup()
, you must specify this value. If you are adding anautoScalingGroup
viaaddCapacity
, this value will be determined from themachineImage
you pass. Default: - Automatically determined frommachineImage
, if available, otherwiseMachineImageType.AMAZON_LINUX_2
.spot_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: falsetopic_encryption_key (
Optional
[IKey
]) – IfAddAutoScalingGroupCapacityOptions.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.auto_scaling_group (
IAutoScalingGroup
) – The autoscaling group to add as a Capacity Provider. Warning: When passing an imported resource usingAutoScalingGroup.fromAutoScalingGroupName
along withenableManagedTerminationProtection: true
, theAsgCapacityProvider
construct will not be able to enforce the optionnewInstancesProtectedFromScaleIn
of theAutoScalingGroup
. In this case the constructor ofAsgCapacityProvider
will throw an exception.capacity_provider_name (
Optional
[str
]) – The name of the capacity provider. If a name is specified, it cannot start withaws
,ecs
, orfargate
. If no name is specified, a default name in the CFNStackName-CFNResourceName-RandomString format is used. If the stack name starts withaws
,ecs
, orfargate
, a unique resource name is generated that starts withcp-
. Default: CloudFormation-generated nameenable_managed_draining (
Optional
[bool
]) – 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. Default: trueenable_managed_scaling (
Optional
[bool
]) – 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. Default: trueenable_managed_termination_protection (
Optional
[bool
]) – 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. Default: trueinstance_warmup_period (
Union
[int
,float
,None
]) – 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. Default: 300maximum_scaling_step_size (
Union
[int
,float
,None
]) – Maximum scaling step size. In most cases this should be left alone. Default: 1000minimum_scaling_step_size (
Union
[int
,float
,None
]) – Minimum scaling step size. In most cases this should be left alone. Default: 1target_capacity_percent (
Union
[int
,float
,None
]) – Target capacity percent. In most cases this should be left alone. Default: 100
- ExampleMetadata:
infused
Example:
# vpc: ec2.Vpc launch_template = ec2.LaunchTemplate(self, "ASG-LaunchTemplate", instance_type=ec2.InstanceType("t3.medium"), machine_image=ecs.EcsOptimizedImage.amazon_linux2(), user_data=ec2.UserData.for_linux() ) auto_scaling_group = autoscaling.AutoScalingGroup(self, "ASG", vpc=vpc, mixed_instances_policy=autoscaling.MixedInstancesPolicy( instances_distribution=autoscaling.InstancesDistribution( on_demand_percentage_above_base_capacity=50 ), launch_template=launch_template ) ) cluster = ecs.Cluster(self, "Cluster", vpc=vpc) capacity_provider = ecs.AsgCapacityProvider(self, "AsgCapacityProvider", auto_scaling_group=auto_scaling_group, machine_image_type=ecs.MachineImageType.AMAZON_LINUX_2 ) cluster.add_asg_capacity_provider(capacity_provider)
Attributes
- auto_scaling_group
The autoscaling group to add as a Capacity Provider.
Warning: When passing an imported resource using
AutoScalingGroup.fromAutoScalingGroupName
along withenableManagedTerminationProtection: true
, theAsgCapacityProvider
construct will not be able to enforce the optionnewInstancesProtectedFromScaleIn
of theAutoScalingGroup
. In this case the constructor ofAsgCapacityProvider
will throw an exception.
- can_containers_access_instance_role
Specifies whether the containers can access the container instance role.
- Default:
false
- capacity_provider_name
The name of the capacity provider.
If a name is specified, it cannot start with
aws
,ecs
, orfargate
. If no name is specified, a default name in the CFNStackName-CFNResourceName-RandomString format is used. If the stack name starts withaws
,ecs
, orfargate
, a unique resource name is generated that starts withcp-
.- Default:
CloudFormation-generated name
- enable_managed_draining
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.
- Default:
true
- enable_managed_scaling
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.
- Default:
true
- enable_managed_termination_protection
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.
- Default:
true
- instance_warmup_period
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.
- Default:
300
- machine_image_type
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 viaaddAutoScalingGroup()
, you must specify this value. If you are adding anautoScalingGroup
viaaddCapacity
, this value will be determined from themachineImage
you pass.- Default:
Automatically determined from
machineImage
, if available, otherwiseMachineImageType.AMAZON_LINUX_2
.
- maximum_scaling_step_size
Maximum scaling step size.
In most cases this should be left alone.
- Default:
1000
- minimum_scaling_step_size
Minimum scaling step size.
In most cases this should be left alone.
- Default:
1
- 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
- target_capacity_percent
Target capacity percent.
In most cases this should be left alone.
- Default:
100
- 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
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