TrackCustomMetricProps

class aws_cdk.aws_ecs.TrackCustomMetricProps(*, disable_scale_in=None, policy_name=None, scale_in_cooldown=None, scale_out_cooldown=None, metric, target_value)

Bases: aws_cdk.aws_applicationautoscaling.BaseTargetTrackingProps

__init__(*, disable_scale_in=None, policy_name=None, scale_in_cooldown=None, scale_out_cooldown=None, metric, target_value)

The properties for enabling target tracking scaling based on a custom CloudWatch metric.

Parameters
  • disable_scale_in (Optional[bool]) – Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won’t remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. Default: false

  • policy_name (Optional[str]) – A name for the scaling policy. Default: - Automatically generated name.

  • scale_in_cooldown (Optional[Duration]) – Period after a scale in activity completes before another scale in activity can start. Default: - No scale in cooldown.

  • scale_out_cooldown (Optional[Duration]) – Period after a scale out activity completes before another scale out activity can start. Default: - No scale out cooldown.

  • metric (IMetric) – The custom CloudWatch metric to track. The metric must represent utilization; that is, you will always get the following behavior: - metric > targetValue => scale out - metric < targetValue => scale in

  • target_value (Union[int, float]) – The target value for the custom CloudWatch metric.

Attributes

disable_scale_in

Indicates whether scale in by the target tracking policy is disabled.

If the value is true, scale in is disabled and the target tracking policy won’t remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource.

default :default: false

Return type

Optional[bool]

metric

The custom CloudWatch metric to track.

The metric must represent utilization; that is, you will always get the following behavior:

  • metric > targetValue => scale out

  • metric < targetValue => scale in

Return type

IMetric

policy_name

A name for the scaling policy.

default :default: - Automatically generated name.

Return type

Optional[str]

scale_in_cooldown

Period after a scale in activity completes before another scale in activity can start.

default :default: - No scale in cooldown.

Return type

Optional[Duration]

scale_out_cooldown

Period after a scale out activity completes before another scale out activity can start.

default :default: - No scale out cooldown.

Return type

Optional[Duration]

target_value

The target value for the custom CloudWatch metric.

Return type

Union[int, float]