CDK constructs for defining an interaction between an Amazon SQS queue and an AWS Lambda function.
Project description
aws-sqs-lambda module
---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:
import { SqsToLambda, SqsToLambdaProps } from "@aws-solutions-constructs/aws-sqs-lambda";
new SqsToLambda(this, 'SqsToLambdaPattern', {
lambdaFunctionProps: {
runtime: lambda.Runtime.NODEJS_14_X,
handler: 'index.handler',
code: lambda.Code.fromAsset(`${__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, providing both this and lambdaFunctionProps will cause an error. |
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. Providing both this and queueProps will cause an error. |
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. |
sqsEventSourceProps? | SqsEventSourceProps |
Optional user provided properties for the queue event source. |
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.
Project details
Release history Release notifications | RSS feed
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
Close
Hashes for aws-solutions-constructs.aws-sqs-lambda-1.142.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 62b93fcbeccc1073342ae92f1a1477085ad987f89c0971d3cd40d43ef12edd86 |
|
MD5 | 1686d005b066788ad1b95a1ac5cbce8b |
|
BLAKE2b-256 | e2bcbaa40f6ad0385e8bf08a55e8c8d58b65e984d2fc0d0d3ebe6582b5713038 |
Close
Hashes for aws_solutions_constructs.aws_sqs_lambda-1.142.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e15c96a008a47f43594328e42fe6bb7624522fc971422e0f706612bae78d2da0 |
|
MD5 | a273cf9b66cb9f87bed89b40b6d0423c |
|
BLAKE2b-256 | 47d6b58568eea26e0db0a66dcea0b12eb9f2a001b76c9d9ac4c09da0f8c77306 |