feat(cloudwatch): add PromQL Alarm L2 construct by caoxy98 · Pull Request #37793 · aws/aws-cdk

caoxy98 · 2026-05-07T15:23:03Z

Reason for this change

Add a new PromQLAlarm L2 construct to the aws-cdk-lib/aws-cloudwatch module that enables users to create CloudWatch alarms based on PromQL instant queries. PromQL alarms monitor metrics ingested through the CloudWatch OTLP endpoint and use duration-based state transitions (pending/recovery periods) instead of the evaluation-period/threshold model used by standard CloudWatch alarms.

Description of changes

Add PromQLAlarm L2 construct extending AlarmBase with typed props for query, pendingPeriod, recoveryPeriod, and evaluationInterval
Add input validation matching coral model constraints
Add unit tests covering creation, actions, imports, and validation
Export PromQLAlarm from aws-cloudwatch module index

Describe any new or updated permissions being added

N/A

Description of how you validated changes

Unit tests + Integ tests

Checklist

My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

github-actions · 2026-05-07T15:25:00Z

⚠️ This pull request description does not follow the correct template structure.

PRs without a linked issue will receive lower priority for review and merging. Please update the description to follow the PR template and include a line like Closes #123 in the Issue section. If no existing issue matches your change, create one first.

aws-cdk-automation

(This review is outdated)

github-actions · 2026-05-07T15:25:58Z

⚠️ Experimental Feature: This security report is currently in experimental phase. Results may include false positives and the rules are being actively refined.
This security report is NOT a review blocker. Please try merge from main to avoid findings unrelated to the PR.
To suppress a specific rule, see Suppressing Rules.

	Tests	Passed ✅	Skipped	Failed
Security Guardian Results	48 ran	48 passed

Test	Result
No test annotations available

View Security Guardian Results

github-actions · 2026-05-07T15:26:02Z

⚠️ Experimental Feature: This security report is currently in experimental phase. Results may include false positives and the rules are being actively refined.
This security report is NOT a review blocker. Please try merge from main to avoid findings unrelated to the PR.
To suppress a specific rule, see Suppressing Rules.

	Tests	Passed ✅	Skipped	Failed
Security Guardian Results with resolved templates	48 ran	48 passed

Test	Result
No test annotations available

View Security Guardian Results with resolved templates

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

kumsmrit

Thank you for your contribution; I have reviewed and added some comments.

kumsmrit · 2026-05-08T14:00:19Z

+import type { IAlarm, IAlarmAction } from '../lib';
+import { PromQLAlarm } from '../lib/promql-alarm';
+
+describe('PromQLAlarm', () => {


The construct validates evaluationInterval, pendingPeriod, recoveryPeriod, and query length, but there are no tests verifying these validations throw.
Can we add tests for each of the validation paths?

kumsmrit · 2026-05-08T14:08:14Z

+## PromQL Alarms
+
+PromQL alarms allow you to create CloudWatch alarms using PromQL query expressions. This is useful when working with Prometheus-compatible metrics in CloudWatch.
+


Can we add detail as how is it different from standard CloudWatch alarms?

kumsmrit · 2026-05-08T14:17:49Z

+  /**
+   * Import an existing CloudWatch alarm provided an ARN.
+   */
+  public static fromAlarmArn(scope: Construct, id: string, alarmArn: string): IAlarm {


Suggested change

public static fromAlarmArn(scope: Construct, id: string, alarmArn: string): IAlarm {

public static fromPromQLAlarmArn(scope: Construct, id: string, alarmArn: string): IAlarm {

kumsmrit · 2026-05-08T14:18:19Z

+  /**
+   * Import an existing CloudWatch alarm provided a Name.
+   */
+  public static fromAlarmName(scope: Construct, id: string, alarmName: string): IAlarm {


Suggested change

public static fromAlarmName(scope: Construct, id: string, alarmName: string): IAlarm {

public static fromPromQLAlarmName(scope: Construct, id: string, alarmName: string): IAlarm {

kumsmrit · 2026-05-08T14:36:54Z

+
+/**
+ * A CloudWatch Alarm based on a PromQL query expression.
+ *


nit:

Suggested change

*

* @see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/alarm-promql.html

kumsmrit · 2026-05-08T15:15:52Z

+      alarmDescription: props.alarmDescription,
+      alarmName: this.physicalName,
+      actionsEnabled: props.actionsEnabled,
+      alarmActions: Lazy.list({ produce: () => this.alarmActionArns }),


AlarmBase._alarmActionArns is now an IArrayBox<string> which already implements IResolvable directly, so this can be passed to the L1 without an additional Lazy.list(...) wrapper. Use Token.asList(...) instead.

kumsmrit · 2026-05-08T15:16:28Z

+      alarmName: this.physicalName,
+      actionsEnabled: props.actionsEnabled,
+      alarmActions: Lazy.list({ produce: () => this.alarmActionArns }),
+      insufficientDataActions: Lazy.list({ produce: () => this.insufficientDataActionArns }),


Please use Token.asList(...) instead of Lazy.list(...). Applicable at other places as well.

kumsmrit · 2026-05-08T15:20:05Z

+
+new IntegTest(app, 'PromQLAlarmIntegTest', {
+  testCases: [stack],
+});


Consider adding assertions to verify if the alarm is created correctly after deployment; That would help validate that the deployed alarm contains the expected EvaluationCriteria.PromQLCriteria.

As discussed, since the parameters are newly added and the sdk version is not updated to have them yet. We'll add the validation once the sdk version is updated later

Pull request has been modified.

Add PromQLAlarm construct to aws-cloudwatch module enabling customers to define PromQL-based alarms in their CDK applications.

mergify · 2026-05-12T16:15:14Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

mergify · 2026-05-12T16:15:26Z

mergify · 2026-05-12T17:24:11Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

mergify · 2026-05-12T17:24:21Z

mergify · 2026-05-12T18:45:32Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

github-actions · 2026-05-12T18:47:28Z

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

caoxy98 temporarily deployed to automation May 7, 2026 15:23 — with GitHub Actions Inactive

caoxy98 had a problem deploying to automation May 7, 2026 15:23 — with GitHub Actions Failure

caoxy98 temporarily deployed to automation May 7, 2026 15:23 — with GitHub Actions Inactive

github-actions Bot added beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK p2 labels May 7, 2026

aws-cdk-automation previously requested changes May 7, 2026

View reviewed changes

caoxy98 changed the title ~~Promql alarm l2 construct~~ feat: Promql alarm l2 construct May 7, 2026

caoxy98 changed the title ~~feat: Promql alarm l2 construct~~ feat(cloudwatch): add PromQL Alarm L2 construct May 7, 2026

caoxy98 temporarily deployed to automation May 7, 2026 15:54 — with GitHub Actions Inactive

caoxy98 temporarily deployed to automation May 7, 2026 15:55 — with GitHub Actions Inactive

caoxy98 temporarily deployed to automation May 7, 2026 16:25 — with GitHub Actions Inactive

caoxy98 temporarily deployed to automation May 8, 2026 09:19 — with GitHub Actions Inactive

aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label May 8, 2026

aws-cdk-automation temporarily deployed to automation May 8, 2026 09:50 — with GitHub Actions Inactive

izerbini99 approved these changes May 8, 2026

View reviewed changes

aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label May 8, 2026

aws-cdk-automation temporarily deployed to automation May 8, 2026 12:59 — with GitHub Actions Inactive

kumsmrit previously requested changes May 8, 2026

View reviewed changes

kumsmrit self-assigned this May 8, 2026

caoxy98 temporarily deployed to automation May 8, 2026 16:10 — with GitHub Actions Inactive

caoxy98 temporarily deployed to automation May 11, 2026 12:32 — with GitHub Actions Inactive

caoxy98 added 7 commits May 12, 2026 16:18

feat(cloudwatch): add PromQL Alarm L2 construct

095bdbc

Add PromQLAlarm construct to aws-cloudwatch module enabling customers to define PromQL-based alarms in their CDK applications.

Change import order

2cb02c4

Edit README

074af8a

Edit README

dd116ec

Address comments

c9dc9c7

Edit tests

331001f

Fix README

4a9a9d0

caoxy98 force-pushed the promql-alarm-l2-construct branch from 2ef5635 to 4a9a9d0 Compare May 12, 2026 15:18

caoxy98 temporarily deployed to automation May 12, 2026 15:18 — with GitHub Actions Inactive

caoxy98 temporarily deployed to deployment-integ-test May 12, 2026 15:19 — with GitHub Actions Inactive

kumsmrit approved these changes May 12, 2026

View reviewed changes

Merge branch 'main' into promql-alarm-l2-construct

72771a9

mergify Bot had a problem deploying to deployment-integ-test May 12, 2026 16:25 Failure

mergify Bot temporarily deployed to automation May 12, 2026 16:25 Inactive

mergify Bot temporarily deployed to automation May 12, 2026 16:26 Inactive

kumsmrit removed the pr/needs-integration-tests-deployment Requires the PR to deploy the integration test snapshots. label May 12, 2026

kumsmrit temporarily deployed to automation May 12, 2026 17:21 — with GitHub Actions Inactive

mergify Bot temporarily deployed to deployment-integ-test May 12, 2026 17:21 Inactive

Merge branch 'main' into promql-alarm-l2-construct

6f9349d

mergify Bot temporarily deployed to automation May 12, 2026 18:12 Inactive

mergify Bot merged commit 13a4924 into aws:main May 12, 2026
24 of 25 checks passed

github-actions Bot locked as resolved and limited conversation to collaborators May 12, 2026

		## PromQL Alarms

		PromQL alarms allow you to create CloudWatch alarms using PromQL query expressions. This is useful when working with Prometheus-compatible metrics in CloudWatch.

	public static fromAlarmArn(scope: Construct, id: string, alarmArn: string): IAlarm {
	public static fromPromQLAlarmArn(scope: Construct, id: string, alarmArn: string): IAlarm {

	public static fromAlarmName(scope: Construct, id: string, alarmName: string): IAlarm {
	public static fromPromQLAlarmName(scope: Construct, id: string, alarmName: string): IAlarm {

	*
	* @see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/alarm-promql.html

Conversation

caoxy98 commented May 7, 2026

Reason for this change

Description of changes

Describe any new or updated permissions being added

Description of how you validated changes

Checklist

Uh oh!

github-actions Bot commented May 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aws-cdk-automation left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented May 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented May 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kumsmrit left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mergify Bot commented May 12, 2026

Uh oh!

mergify Bot commented May 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge Queue Status

Reason

Hint

Uh oh!

mergify Bot commented May 12, 2026

Uh oh!

mergify Bot commented May 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge Queue Status

Uh oh!

mergify Bot commented May 12, 2026

Uh oh!

Uh oh!

github-actions Bot commented May 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

github-actions Bot commented May 7, 2026 •

edited

Loading

aws-cdk-automation left a comment •

edited

Loading

github-actions Bot commented May 7, 2026 •

edited

Loading

github-actions Bot commented May 7, 2026 •

edited

Loading

mergify Bot commented May 12, 2026 •

edited

Loading

mergify Bot commented May 12, 2026 •

edited

Loading