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: http://docs.awssolutionsbuilder.com/aws-solutions-konstruk/latest/api/aws-sqs-lambda/
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`)
    },
    deployDeadLetterQueue: true,
    maxReceiveCount: 15
});

Initializer

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

Parameters

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.
maxReceiveCount number The number of times a message can be unsuccesfully dequeued before being moved to the dead letter queue.

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

Architecture Diagram


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

Project details


Release history Release notifications

Download files

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

Files for aws-solutions-konstruk.aws-sqs-lambda, version 0.8.0
Filename, size File type Python version Upload date Hashes
Filename, size aws_solutions_konstruk.aws_sqs_lambda-0.8.0-py3-none-any.whl (121.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size aws-solutions-konstruk.aws-sqs-lambda-0.8.0.tar.gz (122.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page