Class: Aws::CloudWatch::Types::WarmUpConfiguration

Inherits:

Struct

Object
Struct
Aws::CloudWatch::Types::WarmUpConfiguration

show all

Defined in:: gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb

Overview

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.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#only_start_evaluating_after_warm_up_period_ends ⇒ Boolean
Specifies whether the alarm waits for the full warm-up period before it starts to evaluate.
#warm_up_period_duration_in_minutes ⇒ Integer
The length of the warm-up period, in minutes.

Instance Attribute Details

#only_start_evaluating_after_warm_up_period_ends ⇒ `Boolean`

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.

Returns:

(Boolean)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 6226

class WarmUpConfiguration < Struct.new(
  :warm_up_period_duration_in_minutes,
  :only_start_evaluating_after_warm_up_period_ends)
  SENSITIVE = []
  include Aws::Structure
end

#warm_up_period_duration_in_minutes ⇒ `Integer`

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.