aws/aws-cdk

sns: Add details to `aws_cdk.aws_sns/Topic.html` documentation

Open

#35736 opened on Oct 14, 2025

View on GitHub
 (2 comments) (0 reactions) (0 assignees)TypeScript (10,710 stars) (3,530 forks)batch import
@aws-cdk/aws-snsdocumentationeffort/smallgood first issuep2

Description

Describe the issue

In comparison to the SQS queue documentation, the SNS topic documentation is lacking depth.

Particular examples:

I stumbled upon this when researching whether topic.grant_publish() grants correct permissions in case of SSE (server-side encrypted) SNS topics.

Similarly, method descriptions like grant_subscribe(), add_subscription() would benefit from more details -- what exactly these methods generate in the final CloudFormation template.

Links

https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_sns/Topic.html

Contributor guide

Tech stack
typescriptpythonaws
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
AWS CDK basicsPython SNS API understandingDocumentation style guidelines
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Review the existing SQS queue documentation (e.g., https://docs.aws.amazon.com/cdk/api/v2/python/aws cdk.aws sqs/Queue.html) for style reference. Examine the CDK source code for `grant publish`, `grant subscribe`, and `add subscription` methods in the SNS module to understand the exact IAM permissions and CloudFormation resources generated. Update the Python docs accordingly.