feat(sqs): support for permission settings for dead letter source queues #28745

badmintoncryer · 2024-01-17T18:32:21Z

This PR allows for the configuration of constraints on source queues that can designate this queue as their dead letter queue.

declare const sourceQueue: sqs.IQueue;

// Only the sourceQueue can specify this queue as the dead-letter queue.
const queue1 = new sqs.Queue(this, 'Queue1', {
  redriveAllowPolicy: {
    sourceQueues: [sourceQueue],
  }
});

// No source queues can specify this queue as the dead-letter queue.
const queue2 = new sqs.Queue(this, 'Queue2', {
  redriveAllowPolicy: {
    redrivePermission: sqs.RedrivePermission.DENY_ALL,
  }
});

Closes #19766.

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

lpizzinidev

Thanks 👍
I left some notes for minor adjustments.

packages/aws-cdk-lib/aws-sqs/lib/queue.ts

packages/aws-cdk-lib/aws-sqs/README.md

packages/aws-cdk-lib/aws-sqs/lib/queue.ts

packages/aws-cdk-lib/aws-sqs/test/sqs.test.ts

packages/aws-cdk-lib/aws-sqs/lib/queue.ts

Co-authored-by: Luca Pizzini <[email protected]>

badmintoncryer · 2024-01-18T22:30:54Z

@lpizzinidev Thank you for your review! I addressed your comments.

lpizzinidev

Thanks for clarifying 👍
The implementation of the deadLetterQueue property is pretty old and I think we should stick to the CloudFormation definition when possible for new props to avoid confusion.

badmintoncryer · 2024-01-20T18:33:33Z

Thank you for the confirmation. And I understand the policy on naming as well.

GavinZZ · 2024-01-26T21:42:42Z

packages/aws-cdk-lib/aws-sqs/lib/queue.ts

    const redrivePolicy = props.deadLetterQueue
      ? {
        deadLetterTargetArn: props.deadLetterQueue.queue.queueArn,
        maxReceiveCount: props.deadLetterQueue.maxReceiveCount,
      }
      : undefined;

+    const redriveAllowPolicy = props.redriveAllowPolicy ? {


I understood this logic from reading the docs trings above, but in general this ternary condition is quite confusing for people who look at this piece of code for the first time. Would be nice to have a comment here explaining it (i.e. when sourcePolicy is provided, default to use allow all permission ...).

Fairly minor change, and I'm happy to approve this PR.

badmintoncryer · 2024-01-27T17:30:40Z

@GavinZZ I've updated comments. Please confirm it again.

GavinZZ · 2024-01-28T00:41:17Z

Thank you for the contribution! Happy to approve once the CI passes.

badmintoncryer · 2024-01-28T06:51:29Z

@GavinZZ Do you know why the CI has failed?? https://github.com/aws/aws-cdk/actions/runs/7680150613/job/20931832477?pr=28745

This problem seems to have occurred in other PRs as well.

Run ./tools/@aws-cdk/prlint
  env:
    GITHUB_TOKEN: ***
    PR_NUMBER: 
    PR_SHA: 
    REPO_ROOT: /home/runner/work/aws-cdk/aws-cdk
⌛  Fetching PR number [2](https://github.com/aws/aws-cdk/actions/runs/7680150613/job/20931832477?pr=28745#step:4:2)87[4](https://github.com/aws/aws-cdk/actions/runs/7680150613/job/20931832477?pr=28745#step:4:4)[5](https://github.com/aws/aws-cdk/actions/runs/7680150613/job/20931832477?pr=28745#step:4:5)
Error: Bad credentials

badmintoncryer · 2024-01-29T17:16:37Z

@GavinZZ
The above problem seems to be resolved. However, the CodeBuild job status remains 'pending' even though it has finished successfully. How can I resolve it ?

GavinZZ · 2024-01-29T19:24:04Z

We're actively working on a fix on this issue. Sorry for the inconvenience.

GavinZZ · 2024-01-29T21:47:53Z

@mergify update

mergify · 2024-01-29T21:47:57Z

update

✅ Branch has been successfully updated

GavinZZ

LGTM, thanks for contributing!

mergify · 2024-01-29T22:15:19Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

mergify · 2024-01-29T22:18:07Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

aws-cdk-automation · 2024-01-29T22:56:30Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
Commit ID: af747d4
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify · 2024-01-29T22:56:49Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

…ues (aws#28745) This PR allows for the configuration of constraints on source queues that can designate this queue as their dead letter queue. ```ts declare const sourceQueue: sqs.IQueue; // Only the sourceQueue can specify this queue as the dead-letter queue. const queue1 = new sqs.Queue(this, 'Queue1', { redriveAllowPolicy: { sourceQueues: [sourceQueue], } }); // No source queues can specify this queue as the dead-letter queue. const queue2 = new sqs.Queue(this, 'Queue2', { redriveAllowPolicy: { redrivePermission: sqs.RedrivePermission.DENY_ALL, } }); ``` Closes aws#19766. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

…ues (#28745) This PR allows for the configuration of constraints on source queues that can designate this queue as their dead letter queue. ```ts declare const sourceQueue: sqs.IQueue; // Only the sourceQueue can specify this queue as the dead-letter queue. const queue1 = new sqs.Queue(this, 'Queue1', { redriveAllowPolicy: { sourceQueues: [sourceQueue], } }); // No source queues can specify this queue as the dead-letter queue. const queue2 = new sqs.Queue(this, 'Queue2', { redriveAllowPolicy: { redrivePermission: sqs.RedrivePermission.DENY_ALL, } }); ``` Closes #19766. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

badmintoncryer added 4 commits January 18, 2024 01:03

feat: define props

d99ed93

test: unit test

2225590

test: integ test

60dd292

docs: readme

24c2558

github-actions bot added the admired-contributor [Pilot] contributed between 13-24 PRs to the CDK label Jan 17, 2024

aws-cdk-automation requested a review from a team January 17, 2024 18:32

github-actions bot added effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2 labels Jan 17, 2024

badmintoncryer added 3 commits January 18, 2024 03:56

docs: comment

e9acc14

Merge branch 'main' into 19766-redriveAllowPolicy

430a207

fix: readme

8740d14

badmintoncryer changed the title ~~feat(sqs): support for permission settings for DLQ source queues~~ feat(sqs): support for permission settings for dead letter source queues Jan 17, 2024

refactor: name

b6092d1

aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jan 18, 2024

lpizzinidev suggested changes Jan 18, 2024

View reviewed changes

aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jan 18, 2024

badmintoncryer and others added 11 commits January 19, 2024 05:20

Update packages/aws-cdk-lib/aws-sqs/lib/queue.ts

d6f7138

Co-authored-by: Luca Pizzini <[email protected]>

Update packages/aws-cdk-lib/aws-sqs/lib/queue.ts

d5c76a4

Co-authored-by: Luca Pizzini <[email protected]>

Update packages/aws-cdk-lib/aws-sqs/lib/queue.ts

d494221

Co-authored-by: Luca Pizzini <[email protected]>

Update packages/aws-cdk-lib/aws-sqs/README.md

56a4b61

Co-authored-by: Luca Pizzini <[email protected]>

refactor: unit test

9224bb9

refactor: update variable name

7fd20db

Merge branch 'main' into 19766-redriveAllowPolicy

e659038

fix: unit test

a7cb745

fix: integ test

4376b09

fix: format

e98b598

Merge branch 'main' into 19766-redriveAllowPolicy

4e0b0bb

lpizzinidev approved these changes Jan 20, 2024

View reviewed changes

aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jan 20, 2024

GavinZZ reviewed Jan 26, 2024

View reviewed changes

badmintoncryer added 2 commits January 28, 2024 01:57

Merge branch 'main' into 19766-redriveAllowPolicy

57a0955

chore: update comment

98db16e

chore: update README

bb7f797

Merge branch 'main' into 19766-redriveAllowPolicy

40f5d49

GavinZZ approved these changes Jan 29, 2024

View reviewed changes

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jan 29, 2024

Merge branch 'main' into 19766-redriveAllowPolicy

af747d4

mergify bot merged commit 9e21803 into aws:main Jan 29, 2024
9 checks passed

github-actions bot mentioned this pull request Feb 1, 2024

Monthly PR metrics report - Jan 2024 #28952

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(sqs): support for permission settings for dead letter source queues #28745

feat(sqs): support for permission settings for dead letter source queues #28745

badmintoncryer commented Jan 17, 2024 •

edited

Loading

lpizzinidev left a comment

badmintoncryer commented Jan 18, 2024 •

edited

Loading

lpizzinidev left a comment

badmintoncryer commented Jan 20, 2024

GavinZZ Jan 26, 2024 •

edited

Loading

badmintoncryer commented Jan 27, 2024

GavinZZ commented Jan 28, 2024

badmintoncryer commented Jan 28, 2024

badmintoncryer commented Jan 29, 2024

GavinZZ commented Jan 29, 2024

GavinZZ commented Jan 29, 2024

mergify bot commented Jan 29, 2024

GavinZZ left a comment

mergify bot commented Jan 29, 2024

mergify bot commented Jan 29, 2024

aws-cdk-automation commented Jan 29, 2024

mergify bot commented Jan 29, 2024

feat(sqs): support for permission settings for dead letter source queues #28745

feat(sqs): support for permission settings for dead letter source queues #28745

Conversation

badmintoncryer commented Jan 17, 2024 • edited Loading

lpizzinidev left a comment

Choose a reason for hiding this comment

badmintoncryer commented Jan 18, 2024 • edited Loading

lpizzinidev left a comment

Choose a reason for hiding this comment

badmintoncryer commented Jan 20, 2024

GavinZZ Jan 26, 2024 • edited Loading

Choose a reason for hiding this comment

badmintoncryer commented Jan 27, 2024

GavinZZ commented Jan 28, 2024

badmintoncryer commented Jan 28, 2024

badmintoncryer commented Jan 29, 2024

GavinZZ commented Jan 29, 2024

GavinZZ commented Jan 29, 2024

mergify bot commented Jan 29, 2024

✅ Branch has been successfully updated

GavinZZ left a comment

Choose a reason for hiding this comment

mergify bot commented Jan 29, 2024

mergify bot commented Jan 29, 2024

aws-cdk-automation commented Jan 29, 2024

AWS CodeBuild CI Report

mergify bot commented Jan 29, 2024

badmintoncryer commented Jan 17, 2024 •

edited

Loading

badmintoncryer commented Jan 18, 2024 •

edited

Loading

GavinZZ Jan 26, 2024 •

edited

Loading