Skip to content

Commit f39e73c

Browse files
author
nizar-lahlali
committed
docs(cdk): add JSDoc to dlqAlarm matching errorAlarm precedent
Follows the pattern established in task-orchestrator.ts for public alarm properties.
1 parent 35ba414 commit f39e73c

2 files changed

Lines changed: 2 additions & 0 deletions

File tree

cdk/src/constructs/approval-metrics-publisher-consumer.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ export interface ApprovalMetricsPublisherConsumerProps {
8585
export class ApprovalMetricsPublisherConsumer extends Construct {
8686
public readonly fn: lambda.NodejsFunction;
8787
public readonly dlq: sqs.Queue;
88+
/** CloudWatch alarm that fires when the DLQ has at least one poison-pill record. */
8889
public readonly dlqAlarm: cloudwatch.IAlarm;
8990

9091
constructor(scope: Construct, id: string, props: ApprovalMetricsPublisherConsumerProps) {

cdk/src/constructs/fanout-consumer.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,7 @@ export interface FanOutConsumerProps {
107107
export class FanOutConsumer extends Construct {
108108
public readonly fn: lambda.NodejsFunction;
109109
public readonly dlq: sqs.Queue;
110+
/** CloudWatch alarm that fires when the DLQ has at least one poison-pill record. */
110111
public readonly dlqAlarm: cloudwatch.IAlarm;
111112

112113
constructor(scope: Construct, id: string, props: FanOutConsumerProps) {

0 commit comments

Comments
 (0)