Skip to content
v2.277.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),
});
python
cloudwatch.PromQLAlarm(self, "HighLatencyAlarm",
    alarm_description="P99 latency exceeds 500ms for 5 minutes",
    query="histogram_quantile(0.99, rate(http_request_duration_seconds_bucket[5m])) > 0.5",
    evaluation_interval=Duration.seconds(60),
    pending_period=Duration.seconds(300),
    recovery_period=Duration.seconds(600)
)
java
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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
new PromQLAlarm(this, "HighLatencyAlarm", new PromQLAlarmProps {
    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)
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
cloudwatch.NewPromQLAlarm(this, jsii.String("HighLatencyAlarm"), &PromQLAlarmProps{
	AlarmDescription: jsii.String("P99 latency exceeds 500ms for 5 minutes"),
	Query: jsii.String("histogram_quantile(0.99, rate(http_request_duration_seconds_bucket[5m])) > 0.5"),
	EvaluationInterval: awscdk.Duration_Seconds(jsii.Number(60)),
	PendingPeriod: awscdk.Duration_*Seconds(jsii.Number(300)),
	RecoveryPeriod: awscdk.Duration_*Seconds(jsii.Number(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