@agiledigital/serverless-sns-sqs-lambda

Serverless Sns Sqs Lambda

This is a Serverless Framework plugin for AWS lambda Functions. Currently, it is possible to subscribe directly to an SNS topic. However, if you want to provide retry capability and error handling, you need to write a whole lot of boilerplate to add a Queue and a Dead Letter Queue between the Lambda and the SNS topic. This plugin allows you to define an sns subscriber with a batchSize and a maxRetryCount as simply as subscribing directly to the sns topic.

Table of Contents

• Install
• Setup

Install

Run npm install in your Serverless project.

$ npm install --save-dev @agiledigital/serverless-sns-sqs-lambda

Add the plugin to your serverless.yml file

plugins:
  - "@agiledigital/serverless-sns-sqs-lambda"

Setup

Provide the lambda function with the snsSqs event, the plugin will add the AWS SNS topic and subscription, SQS queue and dead letter queue, and the role need for the lambda.

functions:
  processEvent:
    handler: handler.handler
    events:
      - snsSqs:
          name: TestEvent # Required - choose a name prefix for the event queue
          topicArn: !Ref Topic # Required - SNS topic to subscribe to
          batchSize: 2 # Optional - default value is 10
          maxRetryCount: 2 # Optional - default value is 5
          kmsMasterKeyId: alias/aws/sqs # optional - default is none (no encryption)
          kmsDataKeyReusePeriodSeconds: 600 # optional - AWS default is 300 seconds
          rawMessageDelivery: true # Optional - default value is true
          filterPolicy: # Optional - filter messages that are handled
            pets:
              - dog
              - cat

resources:
  Resources:
    Topic:
      Type: AWS::SNS::Topic
      Properties:
        TopicName: TestTopic

plugins:
  - "@agiledigital/serverless-sns-sqs-lambda"