aws-solutions-constructs.aws-sqs-lambda 1.93.0

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

aws-sqs-lambda 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.

---

Reference Documentation:	https://docs.aws.amazon.com/solutions/latest/constructs/

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

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

Here is a minimal deployable pattern definition in Typescipr:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
from aws_solutions_constructs.aws_sqs_lambda import SqsToLambda, SqsToLambdaProps

SqsToLambda(self, "SqsToLambdaPattern",
    lambda_function_props=FunctionProps(
        runtime=lambda_.Runtime.NODEJS_10_X,
        handler="index.handler",
        code=lambda_.Code.from_asset(f"{__dirname}/lambda")
    )
)

Initializer

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

Parameters

• scope Construct
• id string
• props SqsToLambdaProps

Pattern Construct Props

Name	Type	Description
existingLambdaObj?	lambda.Function	Existing instance of Lambda Function object, if this is set then the lambdaFunctionProps is ignored.
lambdaFunctionProps?	lambda.FunctionProps	User provided props to override the default props for the Lambda function.
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 props to override the default props for the SQS queue.
deadLetterQueueProps?	sqs.QueueProps	Optional user-provided props to override the default props for the dead letter SQS queue.
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 unsuccessfully 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.
deadLetterQueue?	sqs.Queue	Returns an instance of the dead-letter SQS queue created by the pattern.

Default settings

Out of the box implementation of the Construct without any override will set the following defaults:

Amazon SQS Queue

• Deploy SQS dead-letter queue for the source SQS Queue
• Enable server-side encryption for source SQS Queue using AWS Managed KMS Key
• Enforce encryption of data in transit

AWS Lambda Function

• Configure limited privilege access IAM role for Lambda function

• Enable reusing connections with Keep-Alive for NodeJs Lambda function

• Enable X-Ray Tracing

• Set Environment Variables

  • AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)

Architecture

---

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