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.

Sign up for GitHub

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

Jump to bottom

sns: Support for ArchivePolicy #29007

Closed
1 of 2 tasks
badmintoncryer opened this issue Feb 7, 2024 · 1 comment · Fixed by #29008
Closed
1 of 2 tasks

sns: Support for ArchivePolicy #29007

badmintoncryer opened this issue Feb 7, 2024 · 1 comment · Fixed by #29008
Labels
@aws-cdk/aws-sns Related to Amazon Simple Notification Service feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged.

Comments

@badmintoncryer
Copy link
Contributor

Describe the feature

Enable setting of ArchivePolicy in the L2 construct for SNS topics.

https://aws.amazon.com/jp/blogs/compute/archiving-and-replaying-messages-with-amazon-sns-fifo/

Use Case

To set the ArchivePolicy, it is necessary to configure it via L1.

https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-archivepolicy

Proposed Solution

ArchivePolicy has an only 'messageRetentionPeriod' parameter. Therefore, it would be sufficient to allow this parameter to be passed as an argument.

      new sns.Topic(stack, 'MyTopic', {
        fifo: true, // ArchivePolicy is valid only for fifo topics
        messageRetentionPeriodInDays: 10,
      });

Other Information

No response

Acknowledgements

  • I may be able to implement this feature request
  • This feature might incur a breaking change

CDK version used

2.123.0

Environment details (OS name and version, etc.)

irrelevant
@badmintoncryer badmintoncryer added feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Feb 7, 2024
@github-actions github-actions bot added the @aws-cdk/aws-sns Related to Amazon Simple Notification Service label Feb 7, 2024
@badmintoncryer badmintoncryer mentioned this issue Feb 7, 2024
Merged
1 task
@mergify mergify bot closed this as completed in #29008 Feb 8, 2024
mergify bot pushed a commit that referenced this issue Feb 8, 2024
@badmintoncryer
feat(sns): message archive policy (#29008)
9782f6b 
### Issue

Closes #29007.

### Reason for this change

[In October 2023, it became possible to set a message archive policy for FIFO topics](https://aws.amazon.com/jp/blogs/compute/archiving-and-replaying-messages-with-amazon-sns-fifo/). 

While this could be configured via CloudFormation (Cfn), it was not possible to do so from the L2 construct. 

### Description of changes

In this pull request, the "messageRetentionPeriodInDays" parameter has been added to the Topic class, enabling the configuration of the message archive policy.

```ts
    new Topic(this, 'MyTopic', {
      fifo: true, // only fifo topic
      messageRetentionPeriodInDays: 12, // added
    });
```

### Description of how you validated changes

I've added unit and integ tests.

### Checklist
- [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)

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

github-actions bot commented Feb 8, 2024

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

TheRealAmazonKendra pushed a commit that referenced this issue Feb 9, 2024
@badmintoncryer @TheRealAmazonKendra
feat(sns): message archive policy (#29008)
c759895 
### Issue

Closes #29007.

### Reason for this change

[In October 2023, it became possible to set a message archive policy for FIFO topics](https://aws.amazon.com/jp/blogs/compute/archiving-and-replaying-messages-with-amazon-sns-fifo/). 

While this could be configured via CloudFormation (Cfn), it was not possible to do so from the L2 construct. 

### Description of changes

In this pull request, the "messageRetentionPeriodInDays" parameter has been added to the Topic class, enabling the configuration of the message archive policy.

```ts
    new Topic(this, 'MyTopic', {
      fifo: true, // only fifo topic
      messageRetentionPeriodInDays: 12, // added
    });
```

### Description of how you validated changes

I've added unit and integ tests.

### Checklist
- [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
@github-actions github-actions bot mentioned this issue Mar 1, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
@aws-cdk/aws-sns Related to Amazon Simple Notification Service feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(sns): message archive policy badmintoncryer/aws-cdk
1 participant
@badmintoncryer