# PromQLAlarm

A CloudWatch Alarm based on a PromQL query expression.

Extends: Construct › Resource › AlarmBase › PromQLAlarm
Implements: IResource, IAlarm, IAlarmRule, IEnvironmentAware, IAlarmRef, IConstruct, IDependable

- CloudFormation: [`AWS::CloudWatch::Alarm`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-cloudwatch-alarm.html)
- L1 type: [`CfnAlarm`](/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch.CfnAlarm.html)
- Source: [`aws-cloudwatch/lib/promql-alarm.ts`](https://github.com/aws/aws-cdk/blob/v2.277.0/packages/aws-cdk-lib/aws-cloudwatch/lib/promql-alarm.ts#L69)
- Type last changed: v2.254.0 · 13 May 2026

## 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),
});
```

## Initializer

```ts
new PromQLAlarm(scope: Construct, id: string, props: PromQLAlarmProps)
```

## Construct Props

- `actionsEnabled`: boolean = true — Whether the actions for this alarm are enabled.

- `alarmDescription`: string — Description for the alarm.

  **Default:** No description

- `alarmName`: string — Name of the alarm.

  **Default:** Automatically generated name

- `evaluationInterval`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) (required) — The frequency at which the alarm is evaluated.

  Must be between 10 seconds and 3600 seconds.

- `pendingPeriod`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) — The duration that a contributor must continuously breach before the contributor transitions to ALARM state.

  **Default:** No pending period

- `query`: string (required) — The PromQL query that the alarm evaluates.

- `recoveryPeriod`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) — The duration that a contributor must continuously not be breaching before it transitions back to the OK state.

  **Default:** No recovery period

## Properties

- `alarmArn`: string — ARN of this alarm.

- `alarmName`: string — Name of this alarm.

- `alarmRef`: [AlarmReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference.html) — A reference to a Alarm resource.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) — The environment this resource belongs to.

  For resources that are created and managed in a Stack (those created by
  creating new class instances like `new Role()`, `new Bucket()`, etc.), this
  is always the same as the environment of the stack they belong to.

  For referenced resources (those obtained from referencing methods like
  `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
  different than the stack they were imported into.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `PROPERTY_INJECTION_ID`: string (static) — Uniquely identifies this class.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this resource is defined.

## Methods

- `addAlarmAction(...actions: IAlarmAction[]): void` — Trigger this action if the alarm fires.

  Typically SnsAction or AutoScalingAction.

- `addAlarmMuteRule(id: string, options: AlarmMuteRuleOptions): AlarmMuteRule` — Add an alarm mute rule.

- `addInsufficientDataAction(...actions: IAlarmAction[]): void` — Trigger this action if there is insufficient data to evaluate the alarm.

  Typically SnsAction or AutoScalingAction.

- `addOkAction(...actions: IAlarmAction[]): void` — Trigger this action if the alarm returns from breaching state into ok state.

  Typically SnsAction or AutoScalingAction.

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — Apply the given removal policy to this resource.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).

- `fromPromQLAlarmArn(scope: Construct, id: string, alarmArn: string): IAlarm` (static) — Import an existing CloudWatch alarm provided an ARN.

- `fromPromQLAlarmName(scope: Construct, id: string, alarmName: string): IAlarm` (static) — Import an existing CloudWatch alarm provided a Name.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `renderAlarmRule(): string` — AlarmRule indicating ALARM state for Alarm.

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.