Skip to content

Commit d932fb7

Browse files
authored
docs(cloudwatch): description for cloudwatch alarm actions (#25853)
As mentioned in [the issue](#22801), some of the details of the argument types for the CloudWatch Alarm and CompositeAlarm methods are wrong. Closes #22801 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent 1a82d85 commit d932fb7

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

packages/aws-cdk-lib/aws-cloudwatch/lib/alarm-base.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ export abstract class AlarmBase extends Resource implements IAlarm {
5757
/**
5858
* Trigger this action if the alarm fires
5959
*
60-
* Typically the ARN of an SNS topic or ARN of an AutoScaling policy.
60+
* Typically SnsAcion or AutoScalingAction.
6161
*/
6262
public addAlarmAction(...actions: IAlarmAction[]) {
6363
if (this.alarmActionArns === undefined) {
@@ -70,7 +70,7 @@ export abstract class AlarmBase extends Resource implements IAlarm {
7070
/**
7171
* Trigger this action if there is insufficient data to evaluate the alarm
7272
*
73-
* Typically the ARN of an SNS topic or ARN of an AutoScaling policy.
73+
* Typically SnsAcion or AutoScalingAction.
7474
*/
7575
public addInsufficientDataAction(...actions: IAlarmAction[]) {
7676
if (this.insufficientDataActionArns === undefined) {
@@ -83,7 +83,7 @@ export abstract class AlarmBase extends Resource implements IAlarm {
8383
/**
8484
* Trigger this action if the alarm returns from breaching state into ok state
8585
*
86-
* Typically the ARN of an SNS topic or ARN of an AutoScaling policy.
86+
* Typically SnsAcion or AutoScalingAction.
8787
*/
8888
public addOkAction(...actions: IAlarmAction[]) {
8989
if (this.okActionArns === undefined) {

packages/aws-cdk-lib/aws-cloudwatch/lib/alarm.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ export class Alarm extends AlarmBase {
250250
/**
251251
* Trigger this action if the alarm fires
252252
*
253-
* Typically the ARN of an SNS topic or ARN of an AutoScaling policy.
253+
* Typically SnsAcion or AutoScalingAction.
254254
*/
255255
public addAlarmAction(...actions: IAlarmAction[]) {
256256
if (this.alarmActionArns === undefined) {

0 commit comments

Comments
 (0)