aws/aws-cdk
sns: Add details to `aws_cdk.aws_sns/Topic.html` documentation
オープン
#35,736 opened on 2025/10/14
@aws-cdk/aws-snsdocumentationeffort/smallgood first issuep2
Repository metrics
- Stars
- (10,710 個のスター)
- PR merge metrics
- (PR metrics pending)
説明
Describe the issue
In comparison to the SQS queue documentation, the SNS topic documentation is lacking depth.
Particular examples:
- https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_sns/Topic.html#aws_cdk.aws_sns.Topic.grant_publish -- bad documentation (no explanations of what permissions exactly are granted)
- https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_sqs/Queue.html#aws_cdk.aws_sqs.Queue.grant_consume_messages -- good documentation (this is for SQS queues, just for comparison)
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