docs(sns): add detailed permissions documentation to Topic methods#35744
Closed
docs(sns): add detailed permissions documentation to Topic methods#35744
Conversation
Enhanced JSDoc comments for grantPublish(), grantSubscribe(), and addSubscription() methods to explicitly document the IAM and KMS permissions granted, similar to the level of detail in SQS Queue documentation. - grantPublish() now documents sns:Publish permission and KMS permissions (kms:Decrypt, kms:GenerateDataKey*) for encrypted topics - grantSubscribe() now documents sns:Subscribe permission - addSubscription() now describes the CloudFormation resources created Fixes aws#35736
github-actions
bot
added
effort/small
aws-cdk-automation
previously requested changes
Oct 15, 2025
ritoban23
changed the title
aws-cdk-automation
dismissed
their stale review
✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.
Collaborator
|
This PR has been in the MERGE CONFLICTS state for 3 weeks, and looks abandoned. Note that PRs with failing linting check or builds are not reviewed, please ensure your build is passing To prevent automatic closure:
This PR will automatically close in 14 days if no action is taken. |
Collaborator
|
This PR has been deemed to be abandoned, and will be automatically closed. Please create a new PR for these changes if you think this decision has been made in error. |
aws-cdk-automation
added
the
closed-for-staleness
Contributor
|
Comments on closed issues and PRs are hard for our team to see. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issue #35736
Closes #35736.
Reason for this change
SNS Topic documentation lacked detail compared to SQS Queue docs. Methods like
grantPublish()andgrantSubscribe()didn't specify which permissions were granted.Description of changes
Enhanced JSDoc comments in
packages/aws-cdk-lib/aws-sns/lib/topic-base.tsto match SQS documentation style:grantPublish(): Documentssns:Publishpermission and KMS permissions (kms:Decrypt,kms:GenerateDataKey*) for encrypted topicsgrantSubscribe(): Documentssns:SubscribepermissionaddSubscription(): Explains CloudFormationAWS::SNS::Subscriptionresource creationDescribe any new or updated permissions being added
No new permissions added - only documenting existing ones.
Description of how you validated changes
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license