Package software.amazon.awscdk.services.ecs

Interface CfnCapacityProvider.ManagedScalingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCapacityProvider.ManagedScalingProperty.Jsii$Proxy

Enclosing class:

CfnCapacityProvider

@Stability(Stable)
public static interface CfnCapacityProvider.ManagedScalingProperty
extends software.amazon.jsii.JsiiSerializable

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

When managed scaling is turned on, Amazon ECS manages the scale-in and scale-out actions of the Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS managed CloudWatch metric with the specified targetCapacity value as the target value for the metric. For more information, see Using managed scaling in the Amazon Elastic Container Service Developer Guide .

If managed scaling is off, the user must manage the scaling of the Auto Scaling group.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ecs.*;
 ManagedScalingProperty managedScalingProperty = ManagedScalingProperty.builder()
         .instanceWarmupPeriod(123)
         .maximumScalingStepSize(123)
         .minimumScalingStepSize(123)
         .status("status")
         .targetCapacity(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedscaling.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCapacityProvider.ManagedScalingProperty.Builder	A builder for CfnCapacityProvider.ManagedScalingProperty
static final class	CfnCapacityProvider.ManagedScalingProperty.Jsii$Proxy	An implementation for CfnCapacityProvider.ManagedScalingProperty

Method Summary

Modifier and Type	Method	Description
static CfnCapacityProvider.ManagedScalingProperty.Builder	builder()
default Number	getInstanceWarmupPeriod()	The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group.
default Number	getMaximumScalingStepSize()	The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time.
default Number	getMinimumScalingStepSize()	The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time.
default String	getStatus()	Determines whether to use managed scaling for the capacity provider.
default Number	getTargetCapacity()	The target capacity utilization as a percentage for the capacity provider.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInstanceWarmupPeriod

@Stability(Stable)
@Nullable
default Number getInstanceWarmupPeriod()

The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group.

If this parameter is omitted, the default value of 300 seconds is used.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedscaling.html#cfn-ecs-capacityprovider-managedscaling-instancewarmupperiod

getMaximumScalingStepSize

@Stability(Stable)
@Nullable
default Number getMaximumScalingStepSize()

The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time.

If this parameter is omitted, the default value of 10000 is used.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedscaling.html#cfn-ecs-capacityprovider-managedscaling-maximumscalingstepsize

getMinimumScalingStepSize

@Stability(Stable)
@Nullable
default Number getMinimumScalingStepSize()

The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time.

The scale in process is not affected by this parameter If this parameter is omitted, the default value of 1 is used.

When additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size.

If you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value and will ignore both the maximum scaling step size as well as the capacity demand.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedscaling.html#cfn-ecs-capacityprovider-managedscaling-minimumscalingstepsize

getStatus

@Stability(Stable)
@Nullable
default String getStatus()

Determines whether to use managed scaling for the capacity provider.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedscaling.html#cfn-ecs-capacityprovider-managedscaling-status

getTargetCapacity

@Stability(Stable)
@Nullable
default Number getTargetCapacity()

The target capacity utilization as a percentage for the capacity provider.

The specified value must be greater than 0 and less than or equal to 100 . For example, if you want the capacity provider to maintain 10% spare capacity, then that means the utilization is 90%, so use a targetCapacity of 90 . The default value of 100 percent results in the Amazon EC2 instances in your Auto Scaling group being completely used.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedscaling.html#cfn-ecs-capacityprovider-managedscaling-targetcapacity

builder

@Stability(Stable)
static CfnCapacityProvider.ManagedScalingProperty.Builder builder()

Returns:

a CfnCapacityProvider.ManagedScalingProperty.Builder of CfnCapacityProvider.ManagedScalingProperty