Serverless-offline-elasticmq NPM

serverless-offline-elasticmq

David GitHub code size in bytes GitHub repo size npm npm npm npm NPM npm GitHub last commit npm collaborators

Serverless Framework Plugin to download and run an elasticMQ server to use with AWS SQS plugins

Installation

To install with npm, run this in your service directory:

npm install --save-dev serverless-offline-elasticmq

Then add this to your serverless.yml

plugins:
  - serverless-offline-elasticmq

Important: To run ElasticMQ on your computer, you must have the Java Runtime Environment (JRE) version 6.x or newer. The application doesn't run on earlier JRE versions.

How it works

The plugin downloads the official ElasticMQ standalone jar on Your Computer and allows the serverless app to launch it.

Configuration

To configure ElasticMQ Offline, add a elasticmq section like this to your serverless.yml:

custom:
  elasticmq:
    # Set the version of ElasticMq you want to use (optional)
    version: 1.5.4
    # If you only want to use elasticmq Offline in some stages, declare them here
    stages:
      - dev
    start:
      port: 9432 # The port number that elasticmq uses to communicate with your application. If you don't specify this option, the default port is 9432. If port 8000 is unavailable, this command throws an exception. You can use the port option to specify a different port number
      noStart: false # Does not start elasticmq. This option is useful if you already have a running instance of elasticmq locally