0.8.1 • Published 5 years ago
@aws-solutions-konstruk/aws-sqs-lambda v0.8.1
aws-sqs-lambda module
This is a developer preview (public beta) 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.
| API Reference: | http://docs.awssolutionsbuilder.com/aws-solutions-konstruk/latest/api/aws-sqs-lambda/ |
|---|
| Language | Package |
|---|---|
 {: style="height:16px;width:16px"} Python | aws_solutions_konstruk.aws_sns_lambda |
 {: style="height:16px;width:16px"} Typescript | @aws-solutions-konstruk/aws-sns-lambda |
This AWS Solutions Konstruk implements an Amazon SQS queue connected to an AWS Lambda function.
Here is a minimal deployable pattern definition:
const { SqsToLambda } = require('@aws-solutions-konstruk/aws-sqs-lambda');
new SqsToLambda(stack, 'SqsToLambdaPattern', {
deployLambda: true,
lambdaFunctionProps: {
runtime: lambda.Runtime.NODEJS_10_X,
handler: 'index.handler',
code: lambda.Code.asset(`${__dirname}/lambda`)
}
});Initializer
new SqsToLambda(scope: Construct, id: string, props: SqsToLambdaProps);Parameters
- scope
Construct - id
string - props
SqsToLambdaProps
Pattern Construct Props
| Name | Type | Description |
|---|---|---|
| deployLambda | boolean | Whether to create a new Lambda function or use an existing Lambda function. |
| existingLambdaObj? | lambda.Function | An optional, existing Lambda function. |
| lambdaFunctionProps? | lambda.FunctionProps | Optional user-provided props to override the default props for the Lambda function. |
| queueProps? | sqs.QueueProps | Optional user-provided props to override the default props for the SQS queue. |
| encryptionKeyProps? | kms.KeyProps | Optional user-provided props to override the default props for the KMS encryption key. |
| 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 unsuccesfully 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. |
Architecture
© Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.