Skip to content

WarmUpConfiguration

Used by
Source code in docs_src/capo_cloudwatch/types/warm_up_configuration.py 
14
15
16
17
18
19
20
21
22
class WarmUpConfiguration(TypedDict, closed=True):
    warm_up_period_duration_in_minutes: NotRequired[
        "capo_cloudwatch.types.warm_up_period_duration_in_minutes.WarmUpPeriodDurationInMinutes"
    ]
    """<p>The length of the warm-up period, in minutes. After you create or update the alarm, the alarm stays in <code>INSUFFICIENT_DATA</code> for this duration. During this time, the alarm does not perform alarm actions.</p> <p>You can change this value at any time, including after the warm-up period ends. If you change it after the warm-up period ends, the new value does not restart the warm-up period.</p>"""
    only_start_evaluating_after_warm_up_period_ends: NotRequired[
        "capo_cloudwatch.types.only_start_evaluating_after_warm_up_period_ends.OnlyStartEvaluatingAfterWarmUpPeriodEnds"
    ]
    """<p>Specifies whether the alarm waits for the full warm-up period before it starts to evaluate. The default is <code>false</code>. If <code>true</code>, the alarm waits the entire <code>WarmUpPeriodDurationInMinutes</code> before it starts to evaluate, even if metric data arrives earlier. If <code>false</code>, the alarm ends the warm-up period early. Evaluation begins as soon as the alarm has enough metric data to fill its evaluation window.</p>"""

only_start_evaluating_after_warm_up_period_ends instance-attribute 

only_start_evaluating_after_warm_up_period_ends: NotRequired[
    OnlyStartEvaluatingAfterWarmUpPeriodEnds
]

Specifies whether the alarm waits for the full warm-up period before it starts to evaluate. The default is false. If true, the alarm waits the entire WarmUpPeriodDurationInMinutes before it starts to evaluate, even if metric data arrives earlier. If false, the alarm ends the warm-up period early. Evaluation begins as soon as the alarm has enough metric data to fill its evaluation window.

warm_up_period_duration_in_minutes instance-attribute 

warm_up_period_duration_in_minutes: NotRequired[WarmUpPeriodDurationInMinutes]

The length of the warm-up period, in minutes. After you create or update the alarm, the alarm stays in INSUFFICIENT_DATA for this duration. During this time, the alarm does not perform alarm actions.

You can change this value at any time, including after the warm-up period ends. If you change it after the warm-up period ends, the new value does not restart the warm-up period.