serverless-offline-sqs-external

• Fork on serverless-offline-sqs to support new version of serverless-offline and localstack in docker

This Serverless-offline plugin emulates AWS λ and SQS queue on your local machine. To do so, it listens SQS queue and invokes your handlers.

Features:

• Serverless Webpack support.
• SQS configurations: batchsize.

Installation

First, add serverless-offline-sqs-external to your project:

1npm install serverless-offline-sqs-external

Then inside your project's serverless.yml file, add following entry to the plugins section before serverless-offline (and after serverless-webpack if presents): serverless-offline-sqs-external.

1plugins:
2  - serverless-webpack
3  - serverless-offline-sqs-external
4  - serverless-offline

How it works?

This plugin listens to sqs event and invoke offline function to process event.

Configure

Functions

The configuration of function of the plugin follows the serverless documentation.

1functions:
2  mySQSHandler:
3    handler: handler.compute
4    events:
5      - sqs: arn:aws:sqs:region:XXXXXX:MyFirstQueue
6      - sqs:
7          arn: arn:aws:sqs:region:XXXXXX:MySecondQueue
8      - sqs:
9          queueName: MyThirdQueue
10          arn:
11            Fn::GetAtt:
12              - MyThirdQueue
13              - Arn
14      - sqs:
15          arn:
16            Fn::GetAtt:
17              - MyFourthQueue
18              - Arn
19      - sqs:
20          arn:
21            Fn::GetAtt:
22              - MyFifthQueue
23              - Arn
24resources:
25  Resources:
26    MyFourthQueue:
27      Type: AWS::SQS::Queue
28      Properties:
29        QueueName: MyFourthQueue
30
31    MyFifthQueue: # Support for Fifo queue creation starts from 3.1 only
32      Type: AWS::SQS::Queue
33      Properties:
34        QueueName: MyFifthQueue.fifo
35        FifoQueue: true
36        ContentBasedDeduplication: true

SQS

The configuration of aws.SQS's client of the plugin is done by defining a custom: serverless-offline-sqs-external object in your serverless.yml with your specific configuration.

You could use ElasticMQ with the following configuration:

1custom:
2  serverless-offline-sqs-external:
3    autoCreate: true                 # create queue if not exists
4    apiVersion: '2012-11-05'
5    host: localhost
6    port: 9324
7    https: false # default false
8    region: eu-west-1
9    accessKeyId: root
10    secretAccessKey: root
11    skipCacheInvalidation: false

1custom:
2  serverless-offline-sqs-external:
3    autoCreate: true                 # create queue if not exists
4    apiVersion: '2012-11-05'
5    endpoint: 'http://localhost:9324'
6    region: eu-west-1
7    accessKeyId: root
8    secretAccessKey: root
9    skipCacheInvalidation: false