Skip to content

TargetTrackingConfiguration

Source code in docs_src/capo_auto_scaling_plans/types/target_tracking_configuration.py
class TargetTrackingConfiguration(TypedDict, closed=True):
    predefined_scaling_metric_specification: NotRequired[
        "capo_auto_scaling_plans.types.predefined_scaling_metric_specification.PredefinedScalingMetricSpecification"
    ]
    """<p>A predefined metric. You can specify either a predefined metric or a customized metric.</p>"""
    customized_scaling_metric_specification: NotRequired[
        "capo_auto_scaling_plans.types.customized_scaling_metric_specification.CustomizedScalingMetricSpecification"
    ]
    """<p>A customized metric. You can specify either a predefined metric or a customized metric. </p>"""
    target_value: "capo_auto_scaling_plans.types.metric_scale.MetricScale"
    """<p>The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360.</p>"""
    disable_scale_in: NotRequired[
        "capo_auto_scaling_plans.types.disable_scale_in.DisableScaleIn"
    ]
    """<p>Indicates whether scale in by the target tracking scaling policy is disabled. If the value is <code>true</code>, scale in is disabled and the target tracking scaling policy doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource. </p> <p>The default value is <code>false</code>.</p>"""
    scale_out_cooldown: NotRequired["capo_auto_scaling_plans.types.cooldown.Cooldown"]
    """<p>The amount of time, in seconds, to wait for a previous scale-out activity to take effect. This property is not used if the scalable resource is an Auto Scaling group.</p> <p>With the <i>scale-out cooldown period</i>, the intention is to continuously (but not excessively) scale out. After Auto Scaling successfully scales out using a target tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends.</p>"""
    scale_in_cooldown: NotRequired["capo_auto_scaling_plans.types.cooldown.Cooldown"]
    """<p>The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. This property is not used if the scalable resource is an Auto Scaling group.</p> <p>With the <i>scale-in cooldown period</i>, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the scale-in cooldown period, Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.</p>"""
    estimated_instance_warmup: NotRequired[
        "capo_auto_scaling_plans.types.cooldown.Cooldown"
    ]
    """<p>The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.</p>"""

customized_scaling_metric_specification instance-attribute

customized_scaling_metric_specification: NotRequired[
    CustomizedScalingMetricSpecification
]

A customized metric. You can specify either a predefined metric or a customized metric.

disable_scale_in instance-attribute

disable_scale_in: NotRequired[DisableScaleIn]

Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource.

The default value is false.

estimated_instance_warmup instance-attribute

estimated_instance_warmup: NotRequired[Cooldown]

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.

predefined_scaling_metric_specification instance-attribute

predefined_scaling_metric_specification: NotRequired[
    PredefinedScalingMetricSpecification
]

A predefined metric. You can specify either a predefined metric or a customized metric.

scale_in_cooldown instance-attribute

scale_in_cooldown: NotRequired[Cooldown]

The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. This property is not used if the scalable resource is an Auto Scaling group.

With the scale-in cooldown period, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the scale-in cooldown period, Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.

scale_out_cooldown instance-attribute

scale_out_cooldown: NotRequired[Cooldown]

The amount of time, in seconds, to wait for a previous scale-out activity to take effect. This property is not used if the scalable resource is an Auto Scaling group.

With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Auto Scaling successfully scales out using a target tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends.

target_value instance-attribute

target_value: MetricScale

The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360.