serverless-step-functions

What is serverless-step-functions?

The serverless-step-functions npm package is a Serverless Framework plugin that allows you to define and deploy AWS Step Functions using the Serverless Framework. It simplifies the process of creating, managing, and deploying state machines, which are used to orchestrate complex workflows in AWS.

What are serverless-step-functions's main functionalities?

Define State Machines

This feature allows you to define state machines directly in your serverless.yml file. The code sample shows a simple state machine with a single Pass state that returns 'Hello, World!'.

{
  "service": "my-service",
  "frameworkVersion": "2",
  "plugins": ["serverless-step-functions"],
  "provider": {
    "name": "aws",
    "runtime": "nodejs14.x"
  },
  "stepFunctions": {
    "stateMachines": {
      "helloStateMachine": {
        "definition": {
          "Comment": "A Hello World example of the Amazon States Language using a Pass state",
          "StartAt": "HelloWorld",
          "States": {
            "HelloWorld": {
              "Type": "Pass",
              "Result": "Hello, World!",
              "End": true
            }
          }
        }
      }
    }
  }
}

Deploy State Machines

This feature allows you to deploy your state machines to AWS using the Serverless Framework. The code sample shows a script that can be added to your package.json to deploy your service and state machines.

{
  "scripts": {
    "deploy": "serverless deploy"
  }
}

Invoke State Machines

This feature allows you to invoke state machines from your Lambda functions. The code sample shows a Lambda function that can be triggered via an HTTP POST request to invoke a state machine.

{
  "functions": {
    "invokeStateMachine": {
      "handler": "handler.invokeStateMachine",
      "events": [
        {
          "http": {
            "path": "invoke",
            "method": "post"
          }
        }
      ]
    }
  }
}

Other packages similar to serverless-step-functions

aws-sdk

The aws-sdk package is the official AWS SDK for JavaScript. It provides a comprehensive set of tools for interacting with AWS services, including Step Functions. Unlike serverless-step-functions, which is a Serverless Framework plugin, aws-sdk is a general-purpose library that can be used in any Node.js application.

stepfunctions-local

The stepfunctions-local package allows you to run AWS Step Functions locally for development and testing purposes. It provides a local version of the Step Functions service, which can be useful for offline development. This package is more focused on local development, whereas serverless-step-functions is focused on deployment and management in AWS.

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

Usage

deploy

$ sls deploy stepf --state <stepfunctionname>

invoke

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

remove

$ sls remove stepf --state <stepfunctionname>