docs(cloudwatch): description for cloudwatch alarm actions

aws · Jun 5, 2023 · 6780280 · 6780280
1 parent 164a6bc
commit 6780280
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/packages/aws-cdk-lib/aws-cloudwatch/lib/alarm-base.ts b/packages/aws-cdk-lib/aws-cloudwatch/lib/alarm-base.ts
@@ -57,7 +57,7 @@ export abstract class AlarmBase extends Resource implements IAlarm {
   /**
    * Trigger this action if the alarm fires
    *
-   * Typically the ARN of an SNS topic or ARN of an AutoScaling policy.
+   * Typically SnsAcion or AutoScalingAction.
    */
   public addAlarmAction(...actions: IAlarmAction[]) {
     if (this.alarmActionArns === undefined) {
@@ -70,7 +70,7 @@ export abstract class AlarmBase extends Resource implements IAlarm {
   /**
    * Trigger this action if there is insufficient data to evaluate the alarm
    *
-   * Typically the ARN of an SNS topic or ARN of an AutoScaling policy.
+   * Typically SnsAcion or AutoScalingAction.
    */
   public addInsufficientDataAction(...actions: IAlarmAction[]) {
     if (this.insufficientDataActionArns === undefined) {
@@ -83,7 +83,7 @@ export abstract class AlarmBase extends Resource implements IAlarm {
   /**
    * Trigger this action if the alarm returns from breaching state into ok state
    *
-   * Typically the ARN of an SNS topic or ARN of an AutoScaling policy.
+   * Typically SnsAcion or AutoScalingAction.
    */
   public addOkAction(...actions: IAlarmAction[]) {
     if (this.okActionArns === undefined) {

diff --git a/packages/aws-cdk-lib/aws-cloudwatch/lib/alarm.ts b/packages/aws-cdk-lib/aws-cloudwatch/lib/alarm.ts
@@ -250,7 +250,7 @@ export class Alarm extends AlarmBase {
   /**
    * Trigger this action if the alarm fires
    *
-   * Typically the ARN of an SNS topic or ARN of an AutoScaling policy.
+   * Typically SnsAcion or AutoScalingAction.
    */
   public addAlarmAction(...actions: IAlarmAction[]) {
     if (this.alarmActionArns === undefined) {