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

Jump to bottom

aws_cloudwatch.CompositeAlarm: Wrong details on argument type in add_*_action(*actions) methods #22801

Closed
yairst opened this issue Nov 6, 2022 · 2 comments · Fixed by #25853
Closed

aws_cloudwatch.CompositeAlarm: Wrong details on argument type in add_*_action(*actions) methods #22801

yairst opened this issue Nov 6, 2022 · 2 comments · Fixed by #25853
Labels
@aws-cdk/aws-cloudwatch Related to Amazon CloudWatch bug This issue is a bug. documentation This is a problem with documentation. effort/small Small work item – less than a day of effort good first issue Related to contributions. See CONTRIBUTING.md p1

Comments

@yairst
Copy link

yairst commented Nov 6, 2022

Describe the issue

In all 3 methods for adding action to CompositeAlarm the details on the type of the *actions argument are "Typically the ARN of an SNS topic or ARN of an AutoScaling policy". However, the required argument type should be IAlarmAction, as documented in the Parameters section. Hence, a suggested correction could be "Typically SnsAcion or AutoScalingAction".

Links

CompositeAlarm
add_alarm_action(*actions)
add_insufficient_data_action(*actions)
add_ok_action(*actions)
@yairst yairst added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Nov 6, 2022
@github-actions github-actions bot added the @aws-cdk/aws-cloudwatch Related to Amazon CloudWatch label Nov 6, 2022
@indrora indrora added p1 effort/small Small work item – less than a day of effort and removed needs-triage This issue or PR still needs to be triaged. labels Nov 17, 2022
@indrora
Copy link
Contributor

indrora commented Nov 17, 2022

That's correct, these should be clearly defined.

@peterwoodworth peterwoodworth added bug This issue is a bug. good first issue Related to contributions. See CONTRIBUTING.md labels May 2, 2023
@go-to-k go-to-k mentioned this issue Jun 5, 2023
Merged
@mergify mergify bot closed this as completed in #25853 Jun 14, 2023
mergify bot pushed a commit that referenced this issue Jun 14, 2023
@go-to-k
docs(cloudwatch): description for cloudwatch alarm actions (#25853)
d932fb7 
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*
@github-actions
Copy link

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
@aws-cdk/aws-cloudwatch Related to Amazon CloudWatch bug This issue is a bug. documentation This is a problem with documentation. effort/small Small work item – less than a day of effort good first issue Related to contributions. See CONTRIBUTING.md p1
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(cloudwatch): description for cloudwatch alarm actions go-to-k/aws-cdk
4 participants
@indrora @yairst @peterwoodworth @madeline-k