Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(cloudwatch): description for cloudwatch alarm actions #25853

Merged
merged 6 commits into from
Jun 14, 2023
Merged

docs(cloudwatch): description for cloudwatch alarm actions #25853

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5391990
docs(cloudwatch): description for cloudwatch alarm actions
go-to-k Jun 5, 2023
115e1d9
Merge branch 'aws:main' into docs/fix-cloudwatch-alarm-action-docstrings
go-to-k Jun 5, 2023
e399141
Merge branch 'main' into docs/fix-cloudwatch-alarm-action-docstrings
mergify[bot] Jun 6, 2023
c3d8554
Merge branch 'main' into docs/fix-cloudwatch-alarm-action-docstrings
corymhall Jun 12, 2023
ae8736d
Merge branch 'main' into docs/fix-cloudwatch-alarm-action-docstrings
corymhall Jun 13, 2023
adb3a60
Merge branch 'main' into docs/fix-cloudwatch-alarm-action-docstrings
mergify[bot] Jun 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
docs(cloudwatch): description for cloudwatch alarm actions
  • Loading branch information
@go-to-k
go-to-k committed Jun 5, 2023
commit 539199007438a8db07415914d50be8fc07bb44aa
6 changes: 3 additions & 3 deletions packages/aws-cdk-lib/aws-cloudwatch/lib/alarm-base.ts
View file
Open in desktop
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
View file
Open in desktop
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