View a markdown version of this page

AWS::CloudWatch::Alarm AlarmPromQLCriteria - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::CloudWatch::Alarm AlarmPromQLCriteria

Contains the configuration that determines how a PromQL alarm evaluates its contributors, including the query to run and the durations that define when contributors transition between states.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "PendingPeriod" : Integer,
  "Query" : String,
  "RecoveryPeriod" : Integer
}

YAML

  PendingPeriod: Integer
  Query: String
  RecoveryPeriod: Integer

Properties

PendingPeriod

The duration, in seconds, that a contributor must be continuously breaching before it transitions to the ALARM state.

Required: No

Type: Integer

Minimum: 0

Maximum: 86400

Update requires: No interruption

Query

The PromQL query that the alarm evaluates. The query must return a result of vector type. Each entry in the vector result represents an alarm contributor.

Required: No

Type: String

Minimum: 1

Maximum: 10000

Update requires: No interruption

RecoveryPeriod

The duration, in seconds, that a contributor must continuously not be breaching before it transitions back to the OK state.

Required: No

Type: Integer

Minimum: 0

Maximum: 86400

Update requires: No interruption