1.204.0

interface AutoScalingGroupProviderProperty

LanguageType name
.NETAmazon.CDK.AWS.ECS.CfnCapacityProvider.AutoScalingGroupProviderProperty
Javasoftware.amazon.awscdk.services.ecs.CfnCapacityProvider.AutoScalingGroupProviderProperty
Pythonaws_cdk.aws_ecs.CfnCapacityProvider.AutoScalingGroupProviderProperty
TypeScript @aws-cdk/aws-ecs » CfnCapacityProvider » AutoScalingGroupProviderProperty

The details of the Auto Scaling group for the capacity provider.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as ecs from '@aws-cdk/aws-ecs';
const autoScalingGroupProviderProperty: ecs.CfnCapacityProvider.AutoScalingGroupProviderProperty = {
  autoScalingGroupArn: 'autoScalingGroupArn',

  // the properties below are optional
  managedScaling: {
    instanceWarmupPeriod: 123,
    maximumScalingStepSize: 123,
    minimumScalingStepSize: 123,
    status: 'status',
    targetCapacity: 123,
  },
  managedTerminationProtection: 'managedTerminationProtection',
};

Properties

NameTypeDescription
autoScalingGroupArnstringThe Amazon Resource Name (ARN) that identifies the Auto Scaling group.
managedScaling?IResolvable | ManagedScalingPropertyThe managed scaling settings for the Auto Scaling group capacity provider.
managedTerminationProtection?stringThe managed termination protection setting to use for the Auto Scaling group capacity provider.

autoScalingGroupArn

Type: string

The Amazon Resource Name (ARN) that identifies the Auto Scaling group.

managedScaling?

Type: IResolvable | ManagedScalingProperty (optional)

The managed scaling settings for the Auto Scaling group capacity provider.

managedTerminationProtection?

Type: string (optional)

The managed termination protection setting to use for the Auto Scaling group capacity provider.

This determines whether the Auto Scaling group has managed termination protection. The default is off.

When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work.

When managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions on as well. For more information, see Instance Protection in the AWS Auto Scaling User Guide .

When managed termination protection is off, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.

← PreviousNext →