Namespace, Primitive, Method

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

    0.8.1 • Public • Published

    aws-sqs-lambda module


    Stability: Experimental

    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
    Python Logo{: style="height:16px;width:16px"} Python aws_solutions_konstruk.aws_sns_lambda
    Typescript Logo{: 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

    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

    Architecture Diagram


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

    Keywords

    none

    Install

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

    DownloadsWeekly Downloads

    4

    Version

    0.8.1

    License

    Apache-2.0

    Unpacked Size

    228 kB

    Total Files

    17

    Last publish

    Collaborators

    • aws-solutions-konstruk-support