aws/aws-cdk

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

Open

#35,736 opened on Oct 14, 2025

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

Repository metrics

Stars
 (10,710 stars)
PR merge metrics
 (Avg merge 10d 18h) (87 merged PRs in 30d)

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

Research direction
Examine the CDK source code for aws sns Topic class and improve docstrings for methods like grant publish, grant subscribe, and add subscription, following the detailed style of the SQS Queue grant consume messages documentation.
Tech stack
typescript
Domain
cloud
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
AWS CDKAWS SNSPython (for API reference)
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85