Skip to content

Commit

Permalink
docs(cloudwatch): description for cloudwatch alarm actions (#25853)
Browse files Browse the repository at this point in the history
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*
  • Loading branch information
go-to-k authored Jun 14, 2023
1 parent 1a82d85 commit d932fb7
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions packages/aws-cdk-lib/aws-cloudwatch/lib/alarm-base.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand All @@ -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) {
Expand All @@ -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) {
Expand Down
2 changes: 1 addition & 1 deletion packages/aws-cdk-lib/aws-cloudwatch/lib/alarm.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down

0 comments on commit d932fb7

Please sign in to comment.