Serverless plugin for the Eventuate AWS Gateway
JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
test
.gitignore
README.md
package.json

README.md

Eventuate AWS Gateway Serverless plugin

This is the Serverless plugin for Eventuate AWS Gateway.

System requirements:

  • Node.js v4 or later

Projects that use this plugin

Usage

Put eventuate-aws-gateway-serverless-plugin into plugins section in the serverless.yml

plugins:
  - eventuate-aws-gateway-serverless-plugin

Add Eventuate AWS Gateway configuration for a lambda function. For example:

functions:
  testEventHandler:
    handler: handler.eventHandler
    events:
      - eventuate:
          subscriberId: eventuateGatewayPlugin
          space: test
          entitiesAndEventTypes:
            net.chrisrichardson.eventstore.TestEntity:
              - net.chrisrichardson.eventstore.TestEntityCreated

Required environment variables

EVENTUATE_API_KEY_ID
EVENTUATE_API_KEY_SECRET

serverless.yml custom options

eventuateGatewayUrl
eventuateGatewayJwtToken
eventuateGatewayDebug

Commands

View Eventuate AWS Gateway configuration

sls eventuate-gateway info --gatewayId <gateway ID> --space [space name]

Enable Eventuate AWS Gateway

sls eventuate-gateway enable  --gatewayId <gateway ID> --space [space name]

Disable Eventuate AWS Gateway

sls eventuate-gateway disable  --gatewayId <gateway ID> --space [space name]

Delete Eventuate AWS Gateway

sls eventuate-gateway delete  --gatewayId <gateway ID> --space [space name]

The parameter space is set by default to "default", so can be omitted.

See command usage

sls eventuate-gateway --help
sls eventuate-gateway <command> --help