Package Exports

serverless-step-functions

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

Readme

Serverless Step Functions

Serverless plugin for AWS Step Functions.

Install

Run npm install in your Serverless project.

$ npm install --save serverless-step-functions

Add the plugin to your serverless.yml file

plugins:
  - serverless-step-functions

Setup

Write definitions yaml using Amazon States Language in a stepFunctions statement in serverless.yml. Resource statements refer to functions statements. Therefore, you do not need to write a function arn directly.

functions:
  hellofunc:
    handler: handler.hello

stepFunctions:
  hellostepfunc:
    Comment: "A Hello World example of the Amazon States Language using an AWS Lambda Function"
    StartAt: HelloWorld
    States: 
      HelloWorld: 
        Type: Task
        Resource: hellofunc
        End: true

Command

deploy

--state or -t The name of the step function in your service that you want to deploy. Required.
--stage or -s The stage in your service you want to deploy your step function.
--region or -r The region in your stage that you want to deploy your step function.

$ sls deploy stepf --state <stepfunctionname>

invoke

--state or -t The name of the step function in your service that you want to invoke. Required.
--stage or -s The stage in your service you want to invoke your step function.
--region or -r The region in your stage that you want to invoke your step function.
--data or -d String data to be passed as an event to your step function.
--path or -p The path to a json file with input data to be passed to the invoked step function.

$ sls invoke stepf --state <stepfunctionname> --data '{"foo":"bar"}'

remove

--state or -t The name of the step function in your service that you want to remove. Required.
--stage or -s The stage in your service you want to invoke your step remove.
--region or -r The region in your stage that you want to invoke your step remove.

$ sls remove stepf --state <stepfunctionname>