Skip to content
v2.275.0

WarmUpConfigurationProperty Struct ​

The warm-up configuration for an alarm.

A warm-up period delays alarm evaluation after you create or update the alarm. This reduces alarm noise from missing data while a new resource or service starts up. During the warm-up period, the alarm stays in INSUFFICIENT_DATA and doesn't perform alarm actions.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudwatch as cloudwatch } from 'aws-cdk-lib';
const warmUpConfigurationProperty: cloudwatch.CfnLogAlarm.WarmUpConfigurationProperty = {
  onlyStartEvaluatingAfterWarmUpPeriodEnds: false,
  warmUpPeriodDurationInMinutes: 123,
};

Properties ​

onlyStartEvaluatingAfterWarmUpPeriodEndsoptionalboolean | IResolvableonly_start_evaluating_after_warm_up_period_endsoptionaltyping.Union[bool, IResolvable]onlyStartEvaluatingAfterWarmUpPeriodEndsoptionalBooleanOnlyStartEvaluatingAfterWarmUpPeriodEndsoptionalboolOnlyStartEvaluatingAfterWarmUpPeriodEndsoptionalinterface{}#
Specifies whether the alarm waits for the full warm-up period before it starts evaluating.
notes

If true, the alarm waits the entire WarmUpPeriodDurationInMinutes before it starts evaluating, even if metric data arrives earlier. If false, the alarm ends the warm-up period early and starts evaluating as soon as it has enough metric data to fill its evaluation window. This is the default behavior.

warmUpPeriodDurationInMinutesoptionalnumberwarm_up_period_duration_in_minutesoptionalint | floatwarmUpPeriodDurationInMinutesoptionalNumberWarmUpPeriodDurationInMinutesoptionaldoubleWarmUpPeriodDurationInMinutesoptional*float64#
The length of the warm-up period, in minutes.
notes

For this duration after you create or update the alarm, the alarm stays in INSUFFICIENT_DATA and doesn't perform alarm actions. Valid values range from 1 to 2,880 minutes (2 days). You can change this value while the alarm is still in its warm-up period. Changes have no effect after the warm-up period ends.