@simple-cdk-constructs/queue-with-dlq v3.0.0

@simple-cdk-constructs/queue-with-dlq

It's rare I've ever created an SQS Queue without a DLQ. This construct will create both the queue and DLQ.

The DLQ will be suffixed with -dlq.

Use Case

To create a resilient system using SQS it is recommended to have a DLQ so that you can catch and replay messages which fail to be consumed.

Installation

npm i @simple-cdk-constructs/queue-with-dlq

Usage

import { Stack, StackProps, Construct } from '@aws-cdk/core';
import { QueueWithDLQ } from '@simple-cdk-constructs/queue-with-dlq';

export class ExampleStack extends Stack {
  constructor(scope: Construct, id: string, props?: StackProps) {
    super(scope, id, props);

    new QueueWithDLQ(this, 'queue-with-dlq', {
      name: 'webhook-notifications-queue'
    });
  }
}

Additional Options

You can additionally configure the below options which will be applied to both the main queue props and DLQ props:

export interface QueueWithDLQProps {
  name: string;
  retentionPeriod?: Duration;
  visibilityTimeout?: Duration;
  receiveMessageWaitTime?: Duration;
  deliveryDelay?: Duration;
}