sns: Add details to `aws_cdk.aws_sns/Topic.html` documentation · aws/aws-cdk#35736

(2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (10.710 Stars) (3.530 Forks)batch import

@aws-cdk/aws-snsdocumentationeffort/smallgood first issuep2

Beschreibung

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

Contributor Guide

Tech Stack: typescriptpythonaws
Domain: documentation
Issue Type: documentation
Schwierigkeit: 3
Geschätzte Zeit: 1-2 days
Aktivitätsstatus: fresh
Klarheit: clear
Voraussetzungen: AWS CDK basicsPython SNS API understandingDocumentation style guidelines
Einsteigerfreundlichkeit: 70
Research-Richtung: 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.