Repository navigation
Conversation
…d addSubscription docstrings The existing docstrings didn't mention which IAM actions are granted, making it hard for users to understand what permissions are being set up. This adds specific action names (sns:Publish, sns:Subscribe, kms:Decrypt, etc.) and a brief description of what addSubscription creates. Closes aws#35736
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
🚫 Left the queue2 h 41 min in the queue, with no time running CI. So far
Reason The pull request can't be updated
Hint You should update or rebase your pull request manually. If you do, this pull request will automatically be requeued once the queue conditions match again. Tick the box to put this pull request back in the merge queue (same as
Times in UTC · dashboard · how the merge queue works |
|
Queued — the merge queue status continues in this comment ↓. |
🚫 Left the queue2 h 41 min in the queue, with no time running CI. So far
Reason The pull request can't be updated
Hint You should update or rebase your pull request manually. If you do, this pull request will automatically be requeued once the queue conditions match again. Tick the box to put this pull request back in the merge queue (same as
Times in UTC · dashboard · how the merge queue works |
Pull request has been modified.
|
Automated review A maintainer will still review this — treat the notes below as a starting point. 📌 Commit This PR enriches the JSDoc on three SNS topic methods — 🔴 0 blocking · 🟡 0 recommended · ⚪ 0 optional Generated automatically. React 👍 or 👎 to tell us whether this review helped, so we can improve these reviews. |
Issue
Closes #35736
Reason for this change
The existing docstrings on
grantPublish(),grantSubscribe(), andaddSubscription()were too brief — they didn't mention which IAM actions are actually granted or what resources are created. Users had to dig into the source or look up the CloudFormation docs to figure out what these methods do under the hood.Description of changes
Enhanced JSDoc on both the
ITopicinterface and theTopicBaseimplementation:grantPublish(): Now documents that it grantssns:Publish, and when the topic uses a customer-managed KMS key, also grantskms:Decryptandkms:GenerateDataKey*.grantSubscribe(): Now documents that it grantssns:Subscribe.addSubscription(): Now mentions it creates anAWS::SNS::Subscriptionresource and that the endpoint/protocol come from theITopicSubscriptionimplementation.Description of how you validated changes
All existing SNS tests pass (143 tests, 5 suites). This is a docs-only change with no behavior changes.
Checklist