cdklabs / cdk-monitoring-constructs

Easy-to-use CDK constructs for monitoring your AWS infrastructure
https://constructs.dev/packages/cdk-monitoring-constructs
Apache License 2.0
443 stars 55 forks source link

fix(AlarmFactory): Fix wording for actionsSuppressorExtensionPeriod prop to use 'duration' instead of 'time in seconds' #519

Closed jonathan-luo closed 1 month ago

jonathan-luo commented 1 month ago

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, 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).

Note: This wording change was already done for actionsSuppressorWaitPeriod; only actionsSuppressorExtensionPeriod was missed.

Testing


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

jonathan-luo commented 1 month ago

Initial build failed since updated API.md was not included in commit. Have fixed that now.