Skip to content

ExecutePolicyType

Source code in docs_src/capo_auto_scaling/types/execute_policy_type.py
class ExecutePolicyType(TypedDict, closed=True):
    auto_scaling_group_name: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ]
    """<p>The name of the Auto Scaling group.</p>"""
    policy_name: NotRequired["capo_auto_scaling.types.resource_name.ResourceName"]
    """<p>The name or ARN of the policy.</p>"""
    honor_cooldown: NotRequired["capo_auto_scaling.types.honor_cooldown.HonorCooldown"]
    """<p>Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.</p> <p>Valid only if the policy type is <code>SimpleScaling</code>. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scaling-cooldowns.html">Scaling cooldowns for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"""
    metric_value: NotRequired["capo_auto_scaling.types.metric_scale.MetricScale"]
    """<p>The metric value to compare to <code>BreachThreshold</code>. This enables you to execute a policy of type <code>StepScaling</code> and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59.</p> <p>If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error.</p> <p>Required if the policy type is <code>StepScaling</code> and not supported otherwise.</p>"""
    breach_threshold: NotRequired["capo_auto_scaling.types.metric_scale.MetricScale"]
    """<p>The breach threshold for the alarm.</p> <p>Required if the policy type is <code>StepScaling</code> and not supported otherwise.</p>"""

auto_scaling_group_name instance-attribute

auto_scaling_group_name: NotRequired[XmlStringMaxLen255]

The name of the Auto Scaling group.

breach_threshold instance-attribute

breach_threshold: NotRequired[MetricScale]

The breach threshold for the alarm.

Required if the policy type is StepScaling and not supported otherwise.

honor_cooldown instance-attribute

honor_cooldown: NotRequired[HonorCooldown]

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.

Valid only if the policy type is SimpleScaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

metric_value instance-attribute

metric_value: NotRequired[MetricScale]

The metric value to compare to BreachThreshold. This enables you to execute a policy of type StepScaling and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59.

If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error.

Required if the policy type is StepScaling and not supported otherwise.

policy_name instance-attribute

policy_name: NotRequired[ResourceName]

The name or ARN of the policy.