Package software.amazon.awscdk.services.cloudwatch

Class PromQLAlarm

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.cloudwatch.AlarmBase

software.amazon.awscdk.services.cloudwatch.PromQLAlarm

All Implemented Interfaces:

IAlarmRef, IEnvironmentAware, IResource, IAlarm, IAlarmRule, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.129.0 (build eaca441)",
           date="2026-05-13T16:55:05.343Z")
@Stability(Stable)
public class PromQLAlarm
extends AlarmBase

A CloudWatch Alarm based on a PromQL query expression.

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();
 

See Also:

• https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/alarm-promql.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PromQLAlarm.Builder	A fluent builder for PromQLAlarm.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cloudwatch.IAlarm

IAlarm.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PromQLAlarm(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	PromQLAlarm(software.amazon.jsii.JsiiObjectRef objRef)
	PromQLAlarm(software.constructs.Construct scope, String id, PromQLAlarmProps props)

Method Summary

Modifier and Type	Method	Description
static IAlarm	fromPromQLAlarmArn(software.constructs.Construct scope, String id, String alarmArn)	Import an existing CloudWatch alarm provided an ARN.
static IAlarm	fromPromQLAlarmName(software.constructs.Construct scope, String id, String alarmName)	Import an existing CloudWatch alarm provided a Name.
String	getAlarmArn()	ARN of this alarm.
String	getAlarmName()	Name of this alarm.

Methods inherited from class software.amazon.awscdk.services.cloudwatch.AlarmBase

addAlarmAction, addInsufficientDataAction, addOkAction, getAlarmActionArns, getAlarmRef, getInsufficientDataActionArns, getOkActionArns, renderAlarmRule, setAlarmActionArns, setInsufficientDataActionArns, setOkActionArns

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource, with

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode, with

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

PromQLAlarm

protected PromQLAlarm(software.amazon.jsii.JsiiObjectRef objRef)

PromQLAlarm

protected PromQLAlarm(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

PromQLAlarm

@Stability(Stable)
public PromQLAlarm(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 PromQLAlarmProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromPromQLAlarmArn

@Stability(Stable)
@NotNull
public static IAlarm fromPromQLAlarmArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String alarmArn)

Import an existing CloudWatch alarm provided an ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

alarmArn - This parameter is required.

fromPromQLAlarmName

@Stability(Stable)
@NotNull
public static IAlarm fromPromQLAlarmName(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String alarmName)

Import an existing CloudWatch alarm provided a Name.

Parameters:

scope - This parameter is required.

id - This parameter is required.

alarmName - This parameter is required.

getAlarmArn

@Stability(Stable)
@NotNull
public String getAlarmArn()

ARN of this alarm.

Specified by:

getAlarmArn in interface IAlarm

Specified by:

getAlarmArn in class AlarmBase

getAlarmName

@Stability(Stable)
@NotNull
public String getAlarmName()

Name of this alarm.

Specified by:

getAlarmName in interface IAlarm

Specified by:

getAlarmName in class AlarmBase