Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
jun1-t opened this issue Mar 23, 2024 · 2 comments · Fixed by #29591
Closed

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

jun1-t opened this issue Mar 23, 2024 · 2 comments · Fixed by #29591
Labels
@aws-cdk/aws-sns Related to Amazon Simple Notification Service bug This issue is a bug. documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p2

Comments

@jun1-t
Copy link
Contributor

jun1-t commented Mar 23, 2024

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

@jun1-t jun1-t added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Mar 23, 2024
@github-actions github-actions bot added the @aws-cdk/aws-sns Related to Amazon Simple Notification Service label Mar 23, 2024
@jun1-t jun1-t changed the title docs(sns): Typo in Archive Policy docs(sns): remove an unused variable declaration in Archive Policy Mar 23, 2024
@tim-finnigan tim-finnigan self-assigned this Mar 25, 2024
@tim-finnigan
Copy link

Thanks for reporting this issue and creating the PR!

@tim-finnigan tim-finnigan added bug This issue is a bug. p2 and removed needs-triage This issue or PR still needs to be triaged. labels Mar 25, 2024
@tim-finnigan tim-finnigan removed their assignment Mar 25, 2024
@tim-finnigan tim-finnigan added the effort/small Small work item – less than a day of effort label Mar 25, 2024
@mergify mergify bot closed this as completed in #29591 Mar 27, 2024
mergify bot pushed a commit that referenced this issue Mar 27, 2024
…29591)

Closes #29590

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Copy link

⚠️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.

@aws aws locked as resolved and limited conversation to collaborators Jul 25, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
@aws-cdk/aws-sns Related to Amazon Simple Notification Service bug This issue is a bug. documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p2
Projects
None yet
2 participants