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:
# 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, 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.125.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f48147ce2ed4b4f365180e9e1844d8488d31e2fa9b67453906c9a55f4cda279d |
|
MD5 | 5c6a7fd5b669c95c51453cf4e2b5d636 |
|
BLAKE2b-256 | 046ea2d270e7995ac1837b5afe5fe4972fd75aa4aaab0fdf9a843e0637390bd7 |
Close
Hashes for aws_solutions_constructs.aws_sqs_lambda-1.125.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dbb73415a8841a78022805cf5c29fc54c47cf2645e742af5cf31478bad830139 |
|
MD5 | df56ca8e88028fef8ed65ff501821951 |
|
BLAKE2b-256 | 645e8996679cfa67ba619885ed6799ff613dc1366a153b4e4462e76181a4430f |