interface AlarmPromQLCriteriaProperty

Language	Type name
.NET	`Amazon.CDK.AWS.CloudWatch.CfnAlarm.AlarmPromQLCriteriaProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscloudwatch#CfnAlarm_AlarmPromQLCriteriaProperty`
Java	`software.amazon.awscdk.services.cloudwatch.CfnAlarm.AlarmPromQLCriteriaProperty`
Python	`aws_cdk.aws_cloudwatch.CfnAlarm.AlarmPromQLCriteriaProperty`
TypeScript	`aws-cdk-lib` » `aws_cloudwatch` » `CfnAlarm` » `AlarmPromQLCriteriaProperty`

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.

Example

// 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 alarmPromQLCriteriaProperty: cloudwatch.CfnAlarm.AlarmPromQLCriteriaProperty = {
  pendingPeriod: 123,
  query: 'query',
  recoveryPeriod: 123,
};

Properties

Name	Type	Description
pendingPeriod?	`number`	The duration, in seconds, that a contributor must be continuously breaching before it transitions to the `ALARM` state.
query?	`string`	The PromQL query that the alarm evaluates.
recoveryPeriod?	`number`	The duration, in seconds, that a contributor must continuously not be breaching before it transitions back to the `OK` state.

pendingPeriod?

Type: number (optional)

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

query?

Type: string (optional)

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.

recoveryPeriod?