Package software.amazon.awscdk.services.cloudwatch

Interface PromQLAlarmProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

PromQLAlarmProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.129.0 (build eaca441)",
           date="2026-05-13T16:55:05.344Z")
@Stability(Stable)
public interface PromQLAlarmProps
extends software.amazon.jsii.JsiiSerializable

Properties for creating a PromQL Alarm.

Example:

 PromQLAlarm.Builder.create(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))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	PromQLAlarmProps.Builder	A builder for PromQLAlarmProps
static final class	PromQLAlarmProps.Jsii$Proxy	An implementation for PromQLAlarmProps

Method Summary

Modifier and Type	Method	Description
static PromQLAlarmProps.Builder	builder()
default Boolean	getActionsEnabled()	Whether the actions for this alarm are enabled.
default String	getAlarmDescription()	Description for the alarm.
default String	getAlarmName()	Name of the alarm.
Duration	getEvaluationInterval()	The frequency at which the alarm is evaluated.
default Duration	getPendingPeriod()	The duration that a contributor must continuously breach before the contributor transitions to ALARM state.
String	getQuery()	The PromQL query that the alarm evaluates.
default Duration	getRecoveryPeriod()	The duration that a contributor must continuously not be breaching before it transitions back to the OK state.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEvaluationInterval

@Stability(Stable)
@NotNull
Duration getEvaluationInterval()

The frequency at which the alarm is evaluated.

Must be between 10 seconds and 3600 seconds.

getQuery

@Stability(Stable)
@NotNull
String getQuery()

The PromQL query that the alarm evaluates.

getActionsEnabled

@Stability(Stable)
@Nullable
default Boolean getActionsEnabled()

Whether the actions for this alarm are enabled.

Default: true

getAlarmDescription

@Stability(Stable)
@Nullable
default String getAlarmDescription()

Description for the alarm.

Default: - No description

getAlarmName

@Stability(Stable)
@Nullable
default String getAlarmName()

Name of the alarm.

Default: - Automatically generated name

getPendingPeriod

@Stability(Stable)
@Nullable
default Duration getPendingPeriod()

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

Default: - No pending period

getRecoveryPeriod

@Stability(Stable)
@Nullable
default Duration getRecoveryPeriod()

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

Default: - No recovery period

builder

@Stability(Stable)
static PromQLAlarmProps.Builder builder()

Returns:

a PromQLAlarmProps.Builder of PromQLAlarmProps