deployDlq

Exports an async function that creates a dead letter queue (DLQ)

Source:

(require("deployDlq"))(region, dlqName) → {String}

Source:

Exports deployDlq

Parameters:
Name Type Description
region String

A constant destructured from the CLI user's answers in deploy.js. Like "us-east-2".
dlqName String

Constant initialized in deploy.js, looks like beekeeper-${PROFILE_NAME}-dlq
Returns:

Returns the ARN that refers to the DLQ created by this module.

Type
String

Methods

(async, inner) createDLQ(sqs, dlqName) → {String}

Source:

Creates the DLQ.

Parameters:
Name Type Description
sqs SQSClient

looks like new SQSClient({ region });
dlqName String

Constant initialized in deploy.js, looks like beekeeper-${PROFILE_NAME}-dlq
Returns:

A URL referring to the created DLQ

Type
String

(async, inner) getArn(sqs, dlqUrl) → {String}

Source:

Once the DLQ is created, this function can now get ARN of it.

Parameters:
Name Type Description
sqs SQSClient

looks like new SQSClient({ region });
dlqUrl String

URL that was returned from createDLQ()
Returns:

An Amazon Resource Name that refers to the DLQ

Type
String