Skip to content

Commit 49421a2

Browse files
jonathan-luoJonathan Luo
andauthored
fix(AlarmFactory): Fix wording for actionsSuppressorExtensionPeriod prop to use 'duration' instead of 'time in seconds' (#519)
### Description No code logic changes. Unfortunately missed changing `actionsSuppressorExtensionPeriod` prop description to use "duration" instead of "time in seconds". The "time in seconds" descriptor is used in [CloudFormation documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html), but since the prop type required by CDK `CompositeAlarm` is `Duration`, it's more accurate to use "duration" (and to be consistent with the [CDK Composite Alarm definition](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch.CompositeAlarm.html)). Note: This wording change was already done for `actionsSuppressorWaitPeriod`; only `actionsSuppressorExtensionPeriod` was missed. ### Testing - `yarn build` -- no code logic changes so no additional unit tests necessary. --- _By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license_ Co-authored-by: Jonathan Luo <[email protected]>
1 parent 736767e commit 49421a2

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

API.md

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/common/alarm/AlarmFactory.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -398,7 +398,7 @@ export interface AddCompositeAlarmProps {
398398
readonly actionsSuppressor?: IAlarm;
399399

400400
/**
401-
* The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the ALARM state.
401+
* The maximum duration that the composite alarm waits after suppressor alarm goes out of the ALARM state.
402402
* After this time, the composite alarm performs its actions.
403403
*
404404
* @default - 60 seconds

0 commit comments

Comments
 (0)