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.

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

fix(cloudwatch): move SNS Alarm Action to aws-cloudwatch-actions #2688

Merged
merged 9 commits into from Jun 5, 2019

Conversation

rix0rrr
Copy link
Contributor

@rix0rrr rix0rrr commented May 30, 2019

In accordance with new guidelines, we're centralizing cross-service
integrations into their own package. In this case, centralizing
CloudWatch Alarm Actions into @aws-cdk/aws-cloudwatch-actions.

Not moving AutoScaling classes because doing so would introduce circular
dependencies.

BREAKING CHANGE: using an SNS topic as CloudWatch Alarm Actxion now
requires an integration object from the @aws-cdk/aws-cloudwatch-actions
package.


Pull Request Checklist

  • Testing
    • Unit test added (prefer not to modify an existing test, otherwise, it's probably a breaking change)
    • CLI change?: coordinate update of integration tests with team
    • cdk-init template change?: coordinated update of integration tests with team
  • Docs
    • jsdocs: All public APIs documented
    • README: README and/or documentation topic updated
    • Design: For significant features, design document added to design folder
  • Title and Description
    • Change type: title prefixed with fix, feat and module name in parens, which will appear in changelog
    • Title: use lower-case and doesn't end with a period
    • Breaking?: last paragraph: "BREAKING CHANGE: <describe what changed + link for details>"
    • Issues: Indicate issues fixed via: "Fixes #xxx" or "Closes #xxx"
  • Sensitive Modules (requires 2 PR approvers)
    • IAM Policy Document (in @aws-cdk/aws-iam)
    • EC2 Security Groups and ACLs (in @aws-cdk/aws-ec2)
    • Grant APIs (only if not based on official documentation with a reference)

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

In accordance with new guidelines, we're centralizing cross-service
integrations into their own package. In this case, centralizing
CloudWatch Alarm Actions into `@aws-cdk/aws-cloudwatch-actions`.

Not moving AutoScaling classes because doing so would introduce circular
dependencies.

BREAKING CHANGE: using an SNS topic as CloudWatch Alarm Actxion now
requires an integration object from the `@aws-cdk/aws-cloudwatch-actions`
package.
@rix0rrr rix0rrr requested a review from a team as a code owner May 30, 2019 15:42
* Interface for objects that can be the targets of CloudWatch alarm actions
*/
export interface IAlarmAction {
bind(scope: Construct, alarm: IAlarm): AlarmActionProperties;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The name of the return type is not super consistent across integrations, ha? Should we standardize?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be Properties. I didn't want to call it Props because it's not a "Props" object as such, but I may have failed to rename in one PR somewhere.

Another potential candidate is Attributes.

Your preference?

@eladb eladb changed the title fix(cloudwatch): Move SNS Alarm Action to aws-cloudwatch-actions. fix(cloudwatch): Move SNS Alarm Action to aws-cloudwatch-actions May 30, 2019
@rix0rrr rix0rrr self-assigned this Jun 4, 2019
@eladb
Copy link
Contributor

eladb commented Jun 4, 2019

I think it would make sense to use a different suffix to distinguish between those and initialization props, which have a very specific role in our framework. How about “Settings” or “Config”?

@eladb
Copy link
Contributor

eladb commented Jun 4, 2019

I am also okay with Attributes.

[sorry just saw your previous comment asking for my preference]

@eladb eladb changed the title fix(cloudwatch): Move SNS Alarm Action to aws-cloudwatch-actions fix(cloudwatch): move SNS Alarm Action to aws-cloudwatch-actions Jun 4, 2019
Copy link
Contributor

@eladb eladb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change suffix

@eladb
Copy link
Contributor

eladb commented Jun 4, 2019

Actually, we already use Attributes for the fromXxxAttributes, so "Config" I guess?

@rix0rrr
Copy link
Contributor Author

rix0rrr commented Jun 4, 2019

Gosh darnit.

Just spent 1.5hrs renaming everything to "Props" :(

@rix0rrr rix0rrr requested a review from eladb June 5, 2019 09:57
@NGL321 NGL321 added the contribution/core This is a PR that came from AWS. label Sep 27, 2019
This was referenced Dec 12, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants