Skip to content
v2.274.0

PromQLAlarmProps Struct ​

Properties for creating a PromQL Alarm.

Example ​

ts
new cloudwatch.PromQLAlarm(this, 'HighLatencyAlarm', {
  alarmDescription: 'P99 latency exceeds 500ms for 5 minutes',
  query: 'histogram_quantile(0.99, rate(http_request_duration_seconds_bucket[5m])) > 0.5',
  evaluationInterval: Duration.seconds(60),
  pendingPeriod: Duration.seconds(300),
  recoveryPeriod: Duration.seconds(600),
});

Properties ​

actionsEnabledoptionalbooleanactions_enabledoptionalboolactionsEnabledoptionalBooleanActionsEnabledoptionalboolActionsEnabledoptional*bool= true#
Whether the actions for this alarm are enabled.
alarmDescriptionoptionalstringalarm_descriptionoptionalstralarmDescriptionoptionalStringAlarmDescriptionoptionalstringAlarmDescriptionoptional*string#
Description for the alarm.

Default: No description

alarmNameoptionalstringalarm_nameoptionalstralarmNameoptionalStringAlarmNameoptionalstringAlarmNameoptional*string#
Name of the alarm.

Default: Automatically generated name

evaluationIntervalDurationevaluation_intervalDurationevaluationIntervalDurationEvaluationIntervalDurationEvaluationIntervalDurationrequired#
The frequency at which the alarm is evaluated.

Must be between 10 seconds and 3600 seconds.

pendingPeriodoptionalDurationpending_periodoptionalDurationpendingPeriodoptionalDurationPendingPeriodoptionalDurationPendingPeriodoptionalDuration#
The duration that a contributor must continuously breach before the contributor transitions to ALARM state.

Default: No pending period

querystringquerystrqueryStringQuerystringQuery*stringrequired#
The PromQL query that the alarm evaluates.
recoveryPeriodoptionalDurationrecovery_periodoptionalDurationrecoveryPeriodoptionalDurationRecoveryPeriodoptionalDurationRecoveryPeriodoptionalDuration#
The duration that a contributor must continuously not be breaching before it transitions back to the OK state.

Default: No recovery period