-
Notifications
You must be signed in to change notification settings - Fork 4.5k
sns: Add details to aws_cdk.aws_sns/Topic.html documentation #35736
Copy link
Copy link
Open
Labels
@aws-cdk/aws-snsRelated to Amazon Simple Notification ServiceRelated to Amazon Simple Notification ServicedocumentationThis is a problem with documentation.This is a problem with documentation.effort/smallSmall work item – less than a day of effortSmall work item – less than a day of effortgood first issueRelated to contributions. See CONTRIBUTING.mdRelated to contributions. See CONTRIBUTING.mdp2
Description
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
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
@aws-cdk/aws-snsRelated to Amazon Simple Notification ServiceRelated to Amazon Simple Notification ServicedocumentationThis is a problem with documentation.This is a problem with documentation.effort/smallSmall work item – less than a day of effortSmall work item – less than a day of effortgood first issueRelated to contributions. See CONTRIBUTING.mdRelated to contributions. See CONTRIBUTING.mdp2