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(value=Stable)
public static interface CfnCapacityProvider.ManagedScalingProperty
extends software.amazon.jsii.JsiiSerializable

The `ManagedScaling` property specifies the settings for the Auto Scaling group capacity provider.

When managed scaling is enabled, 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 disabled, 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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and 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 container instances that Amazon ECS scales in or scales out at one time.
default Number	getMinimumScalingStepSize() The minimum number of container instances that Amazon ECS scales in or scales out at one time.
default String	getStatus() Determines whether to use managed scaling for the capacity provider.
default Number	getTargetCapacity() The target capacity value for the capacity provider.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getInstanceWarmupPeriod

@Stability(value=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.

getMaximumScalingStepSize

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

The maximum number of container instances that Amazon ECS scales in or scales out at one time.

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

getMinimumScalingStepSize

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

The minimum number of container instances that Amazon ECS scales in or scales out at one time.

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

getStatus

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

Determines whether to use managed scaling for the capacity provider.

getTargetCapacity

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

The target capacity value for the capacity provider.

The specified value must be greater than 0 and less than or equal to 100 . A value of 100 results in the Amazon EC2 instances in your Auto Scaling group being completely used.

builder

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

Returns:

a CfnCapacityProvider.ManagedScalingProperty.Builder of CfnCapacityProvider.ManagedScalingProperty