Categorygithub.com/christian-korneck/awssc-go-dist/awssolutionsconstructsawslambdasqslambda/v2
modulepackage
2.2.0
Repository: https://github.com/christian-korneck/awssc-go-dist.git
Documentation: pkg.go.dev

# README

aws-lambda-sqs-lambda module


Stability: Experimental

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/
LanguagePackage
Python Logo Pythonaws_solutions_constructs.aws_lambda_sqs_lambda
Typescript Logo Typescript@aws-solutions-constructs/aws-lambda-sqs-lambda
Java Logo Javasoftware.amazon.awsconstructs.services.lambdasqslambda

This AWS Solutions Construct implements (1) an AWS Lambda function that is configured to send messages to a queue; (2) an Amazon SQS queue; and (3) an AWS Lambda function configured to consume messages from the queue.

Here is a minimal deployable pattern definition in Typescript:

import { LambdaToSqsToLambda, LambdaToSqsToLambdaProps } from "@aws-solutions-constructs/aws-lambda-sqs-lambda";

new LambdaToSqsToLambda(this, 'LambdaToSqsToLambdaPattern', {
  producerLambdaFunctionProps: {
      runtime: lambda.Runtime.NODEJS_14_X,
      handler: 'index.handler',
      code: lambda.Code.fromAsset(`${__dirname}/lambda/producer-function`)
  },
  consumerLambdaFunctionProps: {
    runtime: lambda.Runtime.NODEJS_14_X,
    handler: 'index.handler',
    code: lambda.Code.fromAsset(`${__dirname}/lambda/consumer-function`)
  }
});

Initializer

new LambdaToSqsToLambda(scope: Construct, id: string, props: LambdaToSqsToLambdaProps);

Parameters

Pattern Construct Props

NameTypeDescription
existingProducerLambdaObj?lambda.FunctionAn optional, existing Lambda function to be used instead of the default function for sending messages to the queue. Providing both this and producerLambdaFunctionProps will cause an error.
producerLambdaFunctionProps?lambda.FunctionPropsOptional user-provided properties to override the default properties for the producer Lambda function.
existingQueueObj?sqs.QueueAn optional, existing SQS queue to be used instead of the default queue. Providing both this and queueProps will cause an error.
queueProps?sqs.QueuePropsOptional user-provided properties to override the default properties for the SQS queue. Providing both this and existingQueueObj will cause an error.
deployDeadLetterQueue?booleanWhether to create a secondary queue to be used as a dead letter queue. Defaults to true.
deadLetterQueueProps?sqs.QueuePropsOptional user-provided props to override the default props for the dead letter queue. Only used if the deployDeadLetterQueue property is set to true.
maxReceiveCount?numberThe number of times a message can be unsuccessfully dequeued before being moved to the dead letter queue. Defaults to 15.
existingConsumerLambdaObj?lambda.FunctionAn optional, existing Lambda function to be used instead of the default function for receiving/consuming messages from the queue. Providing both this and consumerLambdaFunctionProps will cause an error.
consumerLambdaFunctionProps?lambda.FunctionPropsOptional user-provided properties to override the default properties for the consumer Lambda function.
queueEnvironmentVariableName?stringOptional Name for the SQS queue URL environment variable set for the producer Lambda function.
sqsEventSourceProps?SqsEventSourcePropsOptional user provided properties for the queue event source.
existingVpc?ec2.IVpcAn 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.VpcPropsOptional 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?booleanWhether 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.

Pattern Properties

NameTypeDescription
producerLambdaFunctionlambda.FunctionReturns an instance of the producer Lambda function created by the pattern.
sqsQueuesqs.QueueReturns an instance of the SQS queue created by the pattern.
deadLetterQueue?sqs.Queue | undefinedReturns an instance of the dead letter queue created by the pattern, if one is deployed.
consumerLambdaFunctionlambda.FunctionReturns an instance of the consumer Lambda function created by the pattern.
vpc?ec2.IVpcReturns 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 this Construct (without any overridden properties) will adhere to the following defaults:

AWS Lambda Functions

  • Configure limited privilege access IAM role for Lambda functions.
  • Enable reusing connections with Keep-Alive for NodeJs Lambda functions.
  • Enable X-Ray Tracing
  • Set Environment Variables
    • AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)

Amazon SQS Queue

  • Deploy a dead letter queue for the primary queue.
  • Enable server-side encryption for the primary queue using an AWS Managed KMS Key.
  • Enforce encryption of data in transit

Architecture

Architecture Diagram


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

# Packages

Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.

# Functions

Checks if `x` is a construct.
No description provided by the author
No description provided by the author

# Structs

No description provided by the author

# Interfaces

No description provided by the author