serverless-plugin-offline-kinesis-stream

Serverless framework offline plugin to support kinesis stream

This plugin pull from kinesis stream and trigger serverless function if any records detected.

Installation

Install package

1$ npm install --save serverless-plugin-offline-kinesis-stream

Usage

Add following config to serverless.yml file.

1plugins:
2  - serverless-plugin-offline-dynamodb-stream
3  - serverless-plugin-offline-kinesis-stream
4custom:
5  dynamodbStream:
6    host: {LOCAL_DYNAMODB_HOST}
7    port: {LOCAL_DYNAMODB_PORT}
8    streams:
9      - table: {TABLE_NAME}
10        functions:
11          - {FUNCTION_NAME}
12  kinesisStream:
13    host: {LOCAL_KINESIS_HOST}
14    port: {LOCAL_KINESIS_PORT}
15    intervalMillis: 5000
16    streams:
17      - streamName: {STREAM_NAME}
18        functions:
19          - {FUNCTION_NAME}

Ensure your local kinesis is up and running, or you coulde also consider using kinesalite before starting your serverless offline process.

1$ serverless offline start

Development

• Cloning the repo

1$ git clone https://github.com/orchestrated-io/serverless-plugin-offline-kinesis-stream.git

• Installing dependencies

1$ npm install

• Running scripts

Action	Usage
Linting code	npm run lint
Running unit tests	npm run jest
Running code coverage	npm run coverage
Running lint + tests	npm test

Author

Emmanuel Kong

License

MIT