search

aws / aws-cdk

The AWS Cloud Development Kit is a framework for defining cloud infrastructure in code
https://aws.amazon.com/cdk
Apache License 2.0
11.68k stars 3.93k forks source link

docs(sns): remove an unused variable declaration in Archive Policy #29590

Closed jun1-t closed 7 months ago

jun1-t commented 7 months ago

Describe the issue

Archive Policy parameter in the aws_cdk_sns document has an unused variable declaration.

Currently the documentation says:

Example with an archive policy for SQS:

declare const role: iam.Role;
const topic = new sns.Topic(this, 'MyTopic', {
   fifo: true,
   messageRetentionPeriodInDays: 7,
});

I think the following is better.

Example with an archive policy:

const topic = new sns.Topic(this, 'MyTopic', {
   fifo: true,
   messageRetentionPeriodInDays: 7,
});

Removed "for SQS" and "declare const role: iam.Role;".

Links

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sns-readme.html#archive-policy

tim-finnigan commented 7 months ago

Thanks for reporting this issue and creating the PR!

github-actions[bot] commented 7 months ago

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see. If you need more assistance, please either tag a team member or open a new issue that references this one. If you wish to keep having a conversation with other community members under this issue feel free to do so.