aws-lambda-sqs-lambda - AWS Solutions Constructs

aws-lambda-sqs-lambda

All classes are under active development and subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.

Language Package
Python
aws_solutions_constructs.aws_lambda_sqs_lambda
Typescript
@aws-solutions-constructs/aws-lambda-sqs-lambda
Java
software.amazon.awsconstructs.services.lambdasqslambda

This AWS Solutions Constructs pattern implements (1) an AWS Lambda function that is configured to send messages to a queue; (2) an Amazon SQS queue; and (3) an AWS Lambda function configured to consume messages from the queue.

Here is a minimal deployable pattern definition:

const { LambdaToSqsToLambda } = require('@aws-solutions-constructs/aws-lambda-sqs-lambda'); new LambdaToSqsToLambda(stack, 'LambdaToSqsToLambdaPattern', { producerLambdaFunctionProps: { runtime: lambda.Runtime.NODEJS_12_X, handler: 'index.handler', code: lambda.Code.asset(`${__dirname}/lambda/producer-function`) }, consumerLambdaFunctionProps: { runtime: lambda.Runtime.NODEJS_12_X, handler: 'index.handler', code: lambda.Code.asset(`${__dirname}/lambda/consumer-function`) } });

Initializer

new LambdaToSqsToLambda(scope: Construct, id: string, props: LambdaToSqsToLambdaProps);

Parameters

Pattern Construct Props

Name Type Description
existingProducerLambdaObj? lambda.Function An optional, existing Lambda function to be used instead of the default function for sending messages to the queue. If an existing function is provided, the producerLambdaFunctionProps property will be ignored.
producerLambdaFunctionProps? lambda.FunctionProps Optional user-provided properties to override the default properties for the producer Lambda function. Ignored if an existingProducerLambdaObj is provided.
existingQueueObj? sqs.Queue An optional, existing SQS queue to be used instead of the default queue. If an existing queue is provided, the queueProps property will be ignored.
queueProps? sqs.QueueProps Optional user-provided properties to override the default properties for the SQS queue. Ignored if an existingQueueObj is provided.
deployDeadLetterQueue? boolean Whether to create a secondary queue to be used as a dead letter queue. Defaults to true.
deadLetterQueueProps? sqs.QueueProps Optional user-provided props to override the default props for the dead letter queue. Only used if the deployDeadLetterQueue property is set to true.
maxReceiveCount? number The number of times a message can be unsuccessfully dequeued before being moved to the dead letter queue. Defaults to 15.
existingConsumerLambdaObj? lambda.Function An optional, existing Lambda function to be used instead of the default function for receiving/consuming messages from the queue. If an existing function is provided, the consumerLambdaFunctionProps property will be ignored.
consumerLambdaFunctionProps? lambda.FunctionProps Optional user-provided properties to override the default properties for the consumer Lambda function. Ignored if an existingConsumerLambdaObj is provided.

Pattern Properties

Name Type Description
consumerLambdaFunction lambda.Function Returns an instance of the consumer Lambda function created by the pattern.
deadLetterQueue? sqs.Queue Returns an instance of the dead letter queue created by the pattern, if one is deployed.
producerLambdaFunction lambda.Function Returns an instance of the producer Lambda function created by the pattern.
sqsQueue sqs.Queue Returns an instance of the SQS queue created by the pattern.

Default settings

Out-of-the-box implementation of this Construct (without any overridden properties) will adhere to the following defaults:

AWS Lambda Functions

  • Configure least privilege access IAM role for Lambda functions.

  • Enable reusing connections with Keep-Alive for NodeJs Lambda functions.

Amazon SQS Queue

  • Deploy a dead letter queue for the primary queue.

  • Enable server-side encryption for the primary queue using an AWS Managed KMS Key.

  • Enforce encryption of data in transit

Architecture