JSPM – serverless-dynamodb-stream-arn-plugin@0.0.7

Package Exports

serverless-dynamodb-stream-arn-plugin
serverless-dynamodb-stream-arn-plugin/index.js

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-dynamodb-stream-arn-plugin) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

serverless-dynamodb-stream-arn-plugin

Fetches and then adds existing DynamoDB Table streams to serverless.yml file using table name for serverless framework

This plugin calls AWS Describe Streams on you behalf and adds the stream to serverless config file.

How to use

Add to your serverless config plugins object


plugins: 
  - other plugins
  - serverless-dynamodb-stream-arn-plugin

Call the function on your stream arn key like below

arn: ${fetchStreamARN(<tableName>)}

Code Example:

functions:
  sourceLambda:
    handler: ./src/functions/dynamodbOperation
    events:
      - stream:
          arn: ${fetchStreamARN(<tableName>)} // This is all the change you need to do
          startingPosition: LATEST
          enabled: true // Any other parameters can be added as provided by serverless

The plugin will automatically be called on command serverless deploy

Note:

Depending on your Iam Role, you might also be required to add this in your serverless config

        - Effect: Allow
          Action:
            - "dynamodb:ListStreams"
          Resource: '*'

Resource property can be more specific for example arn:aws:dynamodb:${self:provider.region}:*:table/*/stream/*

Passing region where the table exists is important,
1. The plugin automatically takes the value of region from serverless -> provider -> region
2. Can also be passed as region --region <my region> in command line
3. Add region by passing it as the second parameter to the fetchStreamArn Function arn: ${fetchStreamARN(<tableName>, <region>)}