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(sns): create subscriptions in consumer scope #3065

Merged
merged 13 commits into from
Jun 27, 2019

Conversation

eladb
Copy link
Contributor

@eladb eladb commented Jun 25, 2019

Since in most cases the consumer needs to reference the topic to
permit it to send them messages (e.g. invoke a lambda function or send
messages to the queue), it makes much more send to create the SNS subscription
resource on the consumer's scope/stack instead of the topic's.

This change adds an optional scope field to TopicSubscriptionConfig which
is respected by topic.addSubscription. If scope is not defined, the topic's
scope will be used. We also changed subscriberId to be optional, since in the
case where scope is specified, the natural ID for the subscription construct
would be the topic's unique ID, which is now the default. A runtime error will
be emitted if both scope and subscriberId are not provided.

Fixes #3064


Please read the contribution guidelines and follow the pull-request checklist.

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

Since in most cases the consumer needs to reference the topic to
permit it to send them messages (e.g. invoke a lambda function or send
messages to the queue), it makes much more send to create the SNS subscription
resource on the consumer's scope/stack instead of the topic's.

This change adds an optional `scope` field to `TopicSubscriptionConfig` which
is respected by `topic.addSubscription`. If `scope` is not defined, the topic's
scope will be used. We also changed `subscriberId` to be optional, since in the
case where `scope` is specified, the natural ID for the subscription construct
would be the topic's unique ID, which is now the default. A runtime error will 
be emitted if both `scope` and `subscriberId` are not provided.

Fixes #3064
@eladb eladb requested a review from a team as a code owner June 25, 2019 20:30
@ghost ghost requested a review from shivlaks June 25, 2019 20:30
@eladb eladb requested a review from rix0rrr June 25, 2019 20:30
@eladb eladb requested a review from SoManyHs as a code owner June 26, 2019 13:45
@mergify
Copy link
Contributor

mergify bot commented Sep 23, 2019

Thanks so much for taking the time to contribute to the AWS CDK ❤️

We will shortly assign someone to review this pull request and help get it
merged. In the meantime, please take a minute to make sure you follow this
checklist
:

  • PR title type(scope): text
    • type: fix, feat, refactor go into CHANGELOG, chore is hidden
    • scope: name of module without aws- or cdk- prefix or postfix (e.g. s3 instead of aws-s3-deployment)
    • text: use all lower-case, do not end with a period, do not include issue refs
  • PR Description
    • Rationale: describe rationale of change and approach taken
    • Issues: indicate issues fixed via: fixes #xxx or closes #xxx
    • Breaking?: last paragraph: BREAKING CHANGE: <describe what changed + link for details>
  • Testing
    • Unit test added. Prefer to add a new test rather than modify existing tests
    • CLI or init templates change? Re-run/add CLI integration tests
  • Documentation
    • README: update module README to describe new features
    • API docs: public APIs must be documented. Copy from official AWS docs when possible
    • Design: for significant features, follow design process

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.

sns: topic.addSubscription should create the subscription on the consumer's stack to avoid cycles
3 participants