Package software.amazon.awscdk.services.cloudwatch

Interface CfnLogAlarm.WarmUpConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLogAlarm.WarmUpConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnLogAlarm

@Stability(Stable)
public static interface CfnLogAlarm.WarmUpConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudwatch.*;
 WarmUpConfigurationProperty warmUpConfigurationProperty = WarmUpConfigurationProperty.builder()
         .onlyStartEvaluatingAfterWarmUpPeriodEnds(false)
         .warmUpPeriodDurationInMinutes(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-logalarm-warmupconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnLogAlarm.WarmUpConfigurationProperty.Builder	A builder for CfnLogAlarm.WarmUpConfigurationProperty
static final class	CfnLogAlarm.WarmUpConfigurationProperty.Jsii$Proxy	An implementation for CfnLogAlarm.WarmUpConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnLogAlarm.WarmUpConfigurationProperty.Builder	builder()
default Object	getOnlyStartEvaluatingAfterWarmUpPeriodEnds()	Specifies whether the alarm waits for the full warm-up period before it starts evaluating.
default Number	getWarmUpPeriodDurationInMinutes()	The length of the warm-up period, in minutes.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getOnlyStartEvaluatingAfterWarmUpPeriodEnds

@Stability(Stable)
@Nullable
default Object getOnlyStartEvaluatingAfterWarmUpPeriodEnds()

Specifies whether the alarm waits for the full warm-up period before it starts evaluating.

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.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-logalarm-warmupconfiguration.html#cfn-cloudwatch-logalarm-warmupconfiguration-onlystartevaluatingafterwarmupperiodends

getWarmUpPeriodDurationInMinutes

@Stability(Stable)
@Nullable
default Number getWarmUpPeriodDurationInMinutes()

The length of the warm-up period, in minutes.

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-logalarm-warmupconfiguration.html#cfn-cloudwatch-logalarm-warmupconfiguration-warmupperioddurationinminutes

builder

@Stability(Stable)
static CfnLogAlarm.WarmUpConfigurationProperty.Builder builder()

Returns:

a CfnLogAlarm.WarmUpConfigurationProperty.Builder of CfnLogAlarm.WarmUpConfigurationProperty