CDK constructs for defining an interaction between an AWS Lambda function and an Amazon SQS queue.
Project description
aws-lambda-sqs 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_lambda_sqs |
Typescript | @aws-solutions-constructs/aws-lambda-sqs |
Java | software.amazon.awsconstructs.services.lambdasqs |
This AWS Solutions Construct implements an AWS Lambda function connected to an Amazon SQS queue.
Here is a minimal deployable pattern definition in Typescript:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
from aws_solutions_constructs.aws_lambda_sqs import LambdaToSqs, LambdaToSqsProps
LambdaToSqs(self, "LambdaToSqsPattern",
lambda_function_props=FunctionProps(
runtime=lambda_.Runtime.NODEJS_12_X,
handler="index.handler",
code=lambda_.Code.from_asset(f"{__dirname}/lambda")
)
)
Initializer
new LambdaToSqs(scope: Construct, id: string, props: LambdaToSqsProps);
Parameters
- scope
Construct
- id
string
- props
LambdaToSqsProps
Pattern Construct Props
Name | Type | Description |
---|---|---|
existingLambdaObj? | lambda.Function |
An optional, existing Lambda function to be used instead of the default function. If an existing function is provided, the lambdaFunctionProps property will be ignored. |
lambdaFunctionProps? | lambda.FunctionProps |
Optional user-provided properties to override the default properties for the Lambda function. Ignored if an existingLambdaObj is provided. |
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 properties to override the default properties for the SQS queue. Ignored if an existingQueueObj is provided. |
enableQueuePurging? | boolean |
Whether to grant additional permissions to the Lambda function enabling it to purge the SQS queue. Defaults to false . |
deployDeadLetterQueue? | boolean |
Whether to create a secondary queue to be used as a dead letter queue. Defaults to true . |
deadLetterQueueProps? | sqs.QueueProps |
Optional user-provided props to override the default props for the dead letter queue. Only used if the deployDeadLetterQueue property is set 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 queue created by the pattern, if one is deployed. |
Default settings
Out of the box implementation of the Construct without any override will set the following defaults:
AWS Lambda Function
- Configure limited privilege access IAM role for Lambda function.
- Enable reusing connections with Keep-Alive for NodeJs Lambda function.
- Allow the function to send messages only to the queue (purging can be enabled using the
enableQueuePurge
property). - Enable X-Ray Tracing
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
Architecture
© Copyright 2020 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
Hashes for aws-solutions-constructs.aws-lambda-sqs-1.71.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9470d0d7e2cb2066dd45d6d1179f31d0ac70727e9806ce791cb87d87f68d0662 |
|
MD5 | 52ced0f89188b4e19dc211552eb3e945 |
|
BLAKE2b-256 | 614604c38c088d6c481e8c93665a5e1e354cfcb69568c36bf666ba46a426a9ff |
Hashes for aws_solutions_constructs.aws_lambda_sqs-1.71.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 68a198e849ce053052a2cb33cd1e50a533e9d81be50c794d0b03b77454de79fb |
|
MD5 | 2ada9001d445b340ce3dc11345f221ec |
|
BLAKE2b-256 | 8c827a5adf7b0bd1cc3d8ad56552f22e2caf86e9dfb0a350910deb743daf4391 |