@aws-solutions-constructs/aws-sqs-lambda
TypeScript icon, indicating that this package has built-in type declarations

2.63.0 • Public • Published

aws-sqs-lambda module


Stability: Stable


Reference Documentation: https://docs.aws.amazon.com/solutions/latest/constructs/
Language Package
Python Logo Python aws_solutions_constructs.aws_sqs_lambda
Typescript Logo Typescript @aws-solutions-constructs/aws-sqs-lambda
Java Logo Java software.amazon.awsconstructs.services.sqslambda

Overview

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

Here is a minimal deployable pattern definition:

Typescript

import { Construct } from 'constructs';
import { Stack, StackProps } from 'aws-cdk-lib';
import { SqsToLambda, SqsToLambdaProps } from "@aws-solutions-constructs/aws-sqs-lambda";
import * as lambda from 'aws-cdk-lib/aws-lambda';

new SqsToLambda(this, 'SqsToLambdaPattern', {
  lambdaFunctionProps: {
    runtime: lambda.Runtime.NODEJS_16_X,
    handler: 'index.handler',
    code: lambda.Code.fromAsset(`lambda`)
  }
});

Python

from aws_solutions_constructs.aws_sqs_lambda import SqsToLambda
from aws_cdk import (
    aws_lambda as _lambda,
    Stack
)
from constructs import Construct


SqsToLambda(self, 'SqsToLambdaPattern',
            lambda_function_props=_lambda.FunctionProps(
                code=_lambda.Code.from_asset('lambda'),
                runtime=_lambda.Runtime.PYTHON_3_9,
                handler='index.handler'
            )
            )

Java

import software.constructs.Construct;

import software.amazon.awscdk.Stack;
import software.amazon.awscdk.StackProps;
import software.amazon.awscdk.services.lambda.*;
import software.amazon.awscdk.services.lambda.Runtime;
import software.amazon.awsconstructs.services.sqslambda.*;

new SqsToLambda(this, "SnsToSqsPattern", new SqsToLambdaProps.Builder()
        .lambdaFunctionProps(new FunctionProps.Builder()
                .runtime(Runtime.NODEJS_16_X)
                .code(Code.fromAsset("lambda"))
                .handler("index.handler")
                .build())
        .build());

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.
enableEncryptionWithCustomerManagedKey? boolean If no key is provided, this flag determines whether the queue is encrypted with a new CMK or an AWS managed key. This flag is ignored if any of the following are defined: queueProps.encryptionMasterKey, encryptionKey or encryptionKeyProps.
encryptionKey? kms.Key An optional, imported encryption key to encrypt the SQS Queue with.
encryptionKeyProps? kms.KeyProps Optional user provided properties to override the default properties for the KMS encryption key used to encrypt the SQS queue with.

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

Architecture Diagram


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

Package Sidebar

Install

npm i @aws-solutions-constructs/aws-sqs-lambda

Weekly Downloads

4,890

Version

2.63.0

License

Apache-2.0

Unpacked Size

434 kB

Total Files

44

Last publish

Collaborators

  • aws-solutions-constructs-team