Skip to content

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

@yairst

Description

@yairst

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)

Metadata

Metadata

Assignees

No one assigned

    Labels

    @aws-cdk/aws-cloudwatchRelated to Amazon CloudWatchbugThis issue is a bug.documentationThis is a problem with documentation.effort/smallSmall work item – less than a day of effortgood first issueRelated to contributions. See CONTRIBUTING.mdp1

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions