WarmUpConfiguration Class | AWS SDK for .NET Version 4

The configuration settings that define the warm-up behavior for an alarm. Use these settings to delay alarm evaluation after you create or update the alarm, which reduces alarm noise while a new resource or service starts publishing data.

During the warm-up period, the alarm stays in INSUFFICIENT_DATA and does not perform alarm actions.

In this article ▶

Inheritance Hierarchy

System.Object
Amazon.CloudWatch.Model.WarmUpConfiguration

Namespace: Amazon.CloudWatch.Model
Assembly: AWSSDK.CloudWatch.dll
Version: 3.x.y.z

Syntax

public class WarmUpConfiguration

The WarmUpConfiguration type exposes the following members

Constructors

	Name	Description
	WarmUpConfiguration()

Properties

Name Type Description

	Name	Type	Description
	OnlyStartEvaluatingAfterWarmUpPeriodEnds	System.Nullable<System.Boolean>	Gets and sets the property 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.
	WarmUpPeriodDurationInMinutes	System.Nullable<System.Int32>	Gets and sets the property 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.

OnlyStartEvaluatingAfterWarmUpPeriodEnds

System.Nullable<System.Boolean>

Gets and sets the property 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.

WarmUpPeriodDurationInMinutes

System.Nullable<System.Int32>

Gets and sets the property 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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer