awssolutionsconstructsawslambdasqs

README

aws-lambda-sqs module

---

---

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:

import { LambdaToSqs, LambdaToSqsProps } from "@aws-solutions-constructs/aws-lambda-sqs";

new LambdaToSqs(this, 'LambdaToSqsPattern', {
    lambdaFunctionProps: {
        runtime: lambda.Runtime.NODEJS_14_X,
        handler: 'index.handler',
        code: lambda.Code.fromAsset(`${__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. Providing both this and lambdaFunctionProps will cause an error.
lambdaFunctionProps?	lambda.FunctionProps	Optional user-provided properties to override the default properties 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 properties to override the default properties for the SQS queue.
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.
existingVpc?	ec2.IVpc	An optional, existing VPC into which this pattern should be deployed. When deployed in a VPC, the Lambda function will use ENIs in the VPC to access network resources and an Interface Endpoint will be created in the VPC for Amazon SQS. If an existing VPC is provided, the deployVpc property cannot be true. This uses ec2.IVpc to allow clients to supply VPCs that exist outside the stack using the ec2.Vpc.fromLookup() method.
vpcProps?	ec2.VpcProps	Optional user-provided properties to override the default properties for the new VPC. enableDnsHostnames, enableDnsSupport, natGateways and subnetConfiguration are set by the pattern, so any values for those properties supplied here will be overrriden. If deployVpc is not true then this property will be ignored.
deployVpc?	boolean	Whether to create a new VPC based on vpcProps into which to deploy this pattern. Setting this to true will deploy the minimal, most private VPC to run the pattern: One isolated subnet in each Availability Zone used by the CDK program enableDnsHostnames and enableDnsSupport will both be set to true If this property is true then existingVpc cannot be specified. Defaults to false.
queueEnvironmentVariableName?	string	Optional Name for the SQS queue URL environment variable set for the Lambda function.

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.
vpc?	ec2.IVpc	Returns an interface on the VPC used by the pattern (if any). This may be a VPC created by the pattern or the VPC supplied to the pattern constructor.

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
• Set Environment Variables
  • SQS_QUEUE_URL
  • AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)

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 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.

Documentation

Overview

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

Index

• func LambdaToSqs_IsConstruct(x interface{}) *bool
• func NewLambdaToSqs_Override(l LambdaToSqs, scope constructs.Construct, id *string, props *LambdaToSqsProps)
• type LambdaToSqs
  • func NewLambdaToSqs(scope constructs.Construct, id *string, props *LambdaToSqsProps) LambdaToSqs
• type LambdaToSqsProps

Functions

func LambdaToSqs_IsConstruct

func LambdaToSqs_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewLambdaToSqs_Override

func NewLambdaToSqs_Override(l LambdaToSqs, scope constructs.Construct, id *string, props *LambdaToSqsProps)

Types

type LambdaToSqs

type LambdaToSqs interface {
	constructs.Construct
	DeadLetterQueue() *awssqs.DeadLetterQueue
	LambdaFunction() awslambda.Function
	Node() constructs.Node
	SqsQueue() awssqs.Queue
	Vpc() awsec2.IVpc
	ToString() *string
}

func NewLambdaToSqs

func NewLambdaToSqs(scope constructs.Construct, id *string, props *LambdaToSqsProps) LambdaToSqs

type LambdaToSqsProps

type LambdaToSqsProps struct {
	// Optional user provided properties for the dead letter queue.
	DeadLetterQueueProps *awssqs.QueueProps `json:"deadLetterQueueProps"`
	// Whether to deploy a secondary queue to be used as a dead letter queue.
	DeployDeadLetterQueue *bool `json:"deployDeadLetterQueue"`
	// Whether to deploy a new VPC.
	DeployVpc *bool `json:"deployVpc"`
	// Whether to grant additional permissions to the Lambda function enabling it to purge the SQS queue.
	EnableQueuePurging *bool `json:"enableQueuePurging"`
	// Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.
	ExistingLambdaObj awslambda.Function `json:"existingLambdaObj"`
	// Existing instance of SQS queue object, Providing both this and queueProps will cause an error.
	ExistingQueueObj awssqs.Queue `json:"existingQueueObj"`
	// An existing VPC for the construct to use (construct will NOT create a new VPC in this case).
	ExistingVpc awsec2.IVpc `json:"existingVpc"`
	// User provided props to override the default props for the Lambda function.
	LambdaFunctionProps *awslambda.FunctionProps `json:"lambdaFunctionProps"`
	// The number of times a message can be unsuccessfully dequeued before being moved to the dead-letter queue.
	MaxReceiveCount *float64 `json:"maxReceiveCount"`
	// Optional Name for the SQS queue URL environment variable set for the Lambda function.
	QueueEnvironmentVariableName *string `json:"queueEnvironmentVariableName"`
	// Optional user-provided props to override the default props for the SQS queue.
	QueueProps *awssqs.QueueProps `json:"queueProps"`
	// Properties to override default properties if deployVpc is true.
	VpcProps *awsec2.VpcProps `json:"vpcProps"`
}