serverless-plugin-offline-kinesis-stream
v1.0.3
Published
Serverless framework offline plugin to support aws kinesis stream
Downloads
91
Readme
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
$ npm install --save serverless-plugin-offline-kinesis-stream
Usage
Add following config to serverless.yml file.
plugins:
- serverless-plugin-offline-dynamodb-stream
- serverless-plugin-offline-kinesis-stream
custom:
dynamodbStream:
host: {LOCAL_DYNAMODB_HOST}
port: {LOCAL_DYNAMODB_PORT}
streams:
- table: {TABLE_NAME}
functions:
- {FUNCTION_NAME}
kinesisStream:
host: {LOCAL_KINESIS_HOST}
port: {LOCAL_KINESIS_PORT}
intervalMillis: 5000
streams:
- streamName: {STREAM_NAME}
functions:
- {FUNCTION_NAME}
Ensure your local kinesis is up and running, or you coulde also consider using kinesalite before starting your serverless offline process.
$ serverless offline start
Development
- Cloning the repo
$ git clone https://github.com/orchestrated-io/serverless-plugin-offline-kinesis-stream.git
- Installing dependencies
$ 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
|