Skip to content

TargetTrackingScalingPolicyConfiguration

Source code in docs_src/capo_application_auto_scaling/types/target_tracking_scaling_policy_configuration.py
class TargetTrackingScalingPolicyConfiguration(TypedDict, closed=True):
    target_value: "capo_application_auto_scaling.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. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out. </p> <note> <p>If the scaling policy specifies the <code>ALBRequestCountPerTarget</code> predefined metric, specify the target utilization as the optimal average request count per target during any one-minute interval.</p> </note>"""
    predefined_metric_specification: NotRequired[
        "capo_application_auto_scaling.types.predefined_metric_specification.PredefinedMetricSpecification"
    ]
    """<p>A predefined metric. You can specify either a predefined metric or a customized metric.</p>"""
    customized_metric_specification: NotRequired[
        "capo_application_auto_scaling.types.customized_metric_specification.CustomizedMetricSpecification"
    ]
    """<p>A customized metric. You can specify either a predefined metric or a customized metric.</p>"""
    scale_out_cooldown: NotRequired[
        "capo_application_auto_scaling.types.cooldown.Cooldown"
    ]
    """<p>The amount of time, in seconds, to wait for a previous scale-out activity to take effect. For more information and for default values, see <a href="https://docs.aws.amazon.com/autoscaling/application/userguide/target-tracking-scaling-policy-overview.html#target-tracking-cooldown">Define cooldown periods</a> in the <i>Application Auto Scaling User Guide</i>.</p>"""
    scale_in_cooldown: NotRequired[
        "capo_application_auto_scaling.types.cooldown.Cooldown"
    ]
    """<p>The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. For more information and for default values, see <a href="https://docs.aws.amazon.com/autoscaling/application/userguide/target-tracking-scaling-policy-overview.html#target-tracking-cooldown">Define cooldown periods</a> in the <i>Application Auto Scaling User Guide</i>.</p>"""
    disable_scale_in: NotRequired[
        "capo_application_auto_scaling.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 won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is <code>false</code>.</p>"""

customized_metric_specification instance-attribute

customized_metric_specification: NotRequired[CustomizedMetricSpecification]

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 won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false.

predefined_metric_specification instance-attribute

predefined_metric_specification: NotRequired[PredefinedMetricSpecification]

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. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.

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. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.

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. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.

If the scaling policy specifies the ALBRequestCountPerTarget predefined metric, specify the target utilization as the optimal average request count per target during any one-minute interval.