docs(sns): expand grant* JSDoc with granted actions#37991
Open
MukundaKatta wants to merge 1 commit into
Open
Conversation
List the IAM and KMS permissions granted by grantPublish and grantSubscribe so users can see what the helpers do without reading the source. Closes aws#35736
github-actions
Bot
added
beginning-contributor
aws-cdk-automation
previously requested changes
May 24, 2026
MukundaKatta
changed the title
aws-cdk-automation
dismissed
their stale review
✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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 # (if applicable)
Closes #35736.
Reason for this change
The SNS
TopicAPI reference is light on detail compared to SQS. In particular,grantPublishandgrantSubscribedo not list the IAM and KMS actions they grant, so users have to read the source to confirm whether SSE-encrypted topics are handled correctly.Description of changes
JSDoc-only update on
ITopicandTopicBaseinpackages/aws-cdk-lib/aws-sns/lib/topic-base.ts:grantPublish: lists the granted IAM action (sns:Publish) and the KMS actions (kms:Decrypt,kms:GenerateDataKey*) added when the topic is encrypted with a customer-managed KMS key. Adds a@seelink to the SNS server-side encryption docs.grantSubscribe: lists the granted IAM action (sns:Subscribe) and clarifies that this only grants permission to call theSubscribeAPI, not to receive messages on a particular delivery protocol. Notes that KMS permissions are not required for subscribing.Follows the same JSDoc style already used by
grantConsumeMessages/grantSendMessagesinpackages/aws-cdk-lib/aws-sqs/lib/queue-base.ts.Describe any new or updated permissions being added
None. This PR is documentation only and does not change any granted permissions or generated CloudFormation output.
Description of how you validated changes
packages/aws-cdk-lib/aws-sns/test/sns.test.ts:give publishing permissions to CfnTopicassertssns:Publish.give service principal permissions to publish to CfnTopic with encryption keyassertskms:Decryptandkms:GenerateDataKey*on the master key.give subscribing permissionsassertssns:Subscribe.Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license