Skip to main content

CDK constructs for defining an interaction between an Amazon SQS queue and an AWS Lambda function.

Project description

aws-sqs-lambda module


Stability: Experimental

This is a developer preview (public beta) module.

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.

API Reference:
Language Package
Python Logo{: style="height:16px;width:16px"} Python aws_solutions_konstruk.aws_sns_lambda
Typescript Logo{: style="height:16px;width:16px"} Typescript @aws-solutions-konstruk/aws-sns-lambda

This AWS Solutions Konstruk implements an Amazon SQS queue connected to an AWS Lambda function.

Here is a minimal deployable pattern definition:

const { SqsToLambda } = require('@aws-solutions-konstruk/aws-sqs-lambda');

new SqsToLambda(stack, 'SqsToLambdaPattern', {
    deployLambda: true,
    lambdaFunctionProps: {
        runtime: lambda.Runtime.NODEJS_10_X,
        handler: 'index.handler',
        code: lambda.Code.asset(`${__dirname}/lambda`)


new SqsToLambda(scope: Construct, id: string, props: SqsToLambdaProps);


Pattern Construct Props

Name Type Description
deployLambda boolean Whether to create a new Lambda function or use an existing Lambda function.
existingLambdaObj? lambda.Function An optional, existing Lambda function.
lambdaFunctionProps? lambda.FunctionProps Optional user-provided props to override the default props for the Lambda function.
queueProps? sqs.QueueProps Optional user-provided props to override the default props for the SQS queue.
encryptionKeyProps? kms.KeyProps Optional user-provided props to override the default props for the KMS encryption key.
deployDeadLetterQueue? boolean Whether to create a secondary queue to be used as a dead letter queue. Defaults to true.
maxReceiveCount? number The number of times a message can be unsuccesfully dequeued before being moved to the dead letter queue. Defaults to 15.

Pattern Properties

Name Type Description
lambdaFunction() lambda.Function Returns an instance of the Lambda function created by the pattern.
sqsQueue() sqs.Queue Returns an instance of the SQS queue created by the pattern.


Architecture Diagram

© Copyright 2020, Inc. or its affiliates. All Rights Reserved.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page