Package Exports

serverless-offline-kinesis

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (serverless-offline-kinesis) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

serverless-offline-kinesis

This Serverless-offline-kinesis plugin emulates AWS λ and Kinesis streams on your local machine. To do so, it listens Kinesis stream and invokes your handlers.

Features:

Serverless Webpack support.
Kinesis configurations: batchsize and startingPosition.

Installation

First, add serverless-offline-kinesis to your project:

npm install serverless-offline-kinesis

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-kinesis.

plugins:
  - serverless-webpack
  - serverless-offline-kinesis
  - serverless-offline

See example

Configure

Functions

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

functions:
  myKinesisHandler:
    handler: handler.compute
    events:
      - stream:
          enabled: true
          type: kinesis
          arn: arn:aws:kinesis:eu-west-1:XXXXXX:stream/polls
          batchSize: 10
          startingPosition: TRIM_HORIZON

Kinesis

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

You could use mhart's Kinesalite with the following configuration:

custom:
  serverless-offline-kinesis:
    apiVersion: '2013-12-02'
    endpoint: http://0.0.0.0:4567
    region: eu-west-1
    accessKeyId: root
    secretAccessKey: root
    skipCacheInvalidation: false
    readInterval: 500