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 (BETA)

Serverless plugin for AWS Step Functions.

This plugin requires Serverless v1.4.0 or later.

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 or activities statements. Therefore, you do not need to write a function arn or activity arn directly. Of course, you can also specify arn directly.

functions:
  hellofunc:
    handler: handler.hello

stepFunctions:
  stateMachines:
    hellostepfunc1:
      Comment: "A Hello World example of the Amazon States Language using an AWS Lambda Function"
      StartAt: HelloWorld1
      States: 
        HelloWorld1:
          Type: Task
          Resource: hellofunc
          End: true
    hellostepfunc2:
      StartAt: HelloWorld2
      States: 
        HelloWorld2: 
          Type: Task
          Resource: myTask
          End: true
  activities:
    - myTask
    - yourTask

Command

deploy

All StateMachines and Activities deploy

$ sls deploy stepf

options

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

All StateMachines deploy

$ sls deploy stepf statemachines

options

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

Single StateMachine deploy

$ sls deploy stepf statemachines --name <stepfunctionname>

options

• --name or -n The name of the step function in your service that you want to deploy.
• --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.

All Activities deploy

$ sls deploy stepf activities

options

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

Single Activity deploy

$ sls deploy stepf activities --name <activityname>

options

• --name or -n The name of the step function in your service that you want to deploy.
• --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.

invoke

options

• --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

All StateMachines and Activities remove

$ sls remove stepf

options

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

All StateMachines remove

$ sls remove stepf statemachines

options

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

Single StateMachine remove

$ sls remove stepf --state <stepfunctionname>

options

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

All Activities remove

$ sls remove stepf activities

options

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

Single Activity remove

$ sls remove stepf activities --name <activityname>

options

• --name or -n The name of the step function in your service that you want to deploy.
• --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.

Sample statemachines setting in serverless.yml

Waite State

functions:
  hellofunc:
    handler: handler.hello

stepFunctions:
  stateMachines:
    yourWateMachine:
      Comment: "An example of the Amazon States Language using wait states"
      StartAt: FirstState
      States:
        FirstState:
          Type: Task
          Resource: hellofunc
          Next: wait_using_seconds
        wait_using_seconds:
          Type: Wait
          Seconds: 10
          Next: wait_using_timestamp
        wait_using_timestamp:
          Type: Wait
          Timestamp: '2015-09-04T01:59:00Z'
          Next: wait_using_timestamp_path
        wait_using_timestamp_path:
          Type: Wait
          TimestampPath: "$.expirydate"
          Next: wait_using_seconds_path
        wait_using_seconds_path:
          Type: Wait
          SecondsPath: "$.expiryseconds"
          Next: FinalState
        FinalState:
          Type: Task
          Resource: hellofunc
          End: true

Retry Failture

functions:
  hellofunc:
    handler: handler.hello

stepFunctions:
  stateMachines:
    yourRetryMachine:
      Comment: "A Retry example of the Amazon States Language using an AWS Lambda Function"
      StartAt: HelloWorld
      States:
        HelloWorld:
          Type: Task
          Resource: hellofunc
          Retry:
          - ErrorEquals:
            - HandledError
            IntervalSeconds: 1
            MaxAttempts: 2
            BackoffRate: 2
          - ErrorEquals:
            - States.TaskFailed
            IntervalSeconds: 30
            MaxAttempts: 2
            BackoffRate: 2
          - ErrorEquals:
            - States.ALL
            IntervalSeconds: 5
            MaxAttempts: 5
            BackoffRate: 2
          End: true

Parallel

stepFunctions:
  stateMachines:
    yourParallelMachine:
      Comment: "An example of the Amazon States Language using a parallel state to execute two branches at the same time."
      StartAt: Parallel
      States:
        Parallel:
          Type: Parallel
          Next: Final State
          Branches:
          - StartAt: Wait 20s
            States:
              Wait 20s:
                Type: Wait
                Seconds: 20
                End: true
          - StartAt: Pass
            States:
              Pass:
                Type: Pass
                Next: Wait 10s
              Wait 10s:
                Type: Wait
                Seconds: 10
                End: true
        Final State:
          Type: Pass
          End: true
      

Catch Failture

functions:
  hellofunc:
    handler: handler.hello
stepFunctions:
  stateMachines:
    yourCatchMachine:
      Comment: "A Catch example of the Amazon States Language using an AWS Lambda Function"
      StartAt: HelloWorld
      States:
        HelloWorld:
          Type: Task
          Resource: hellofunc
          Catch:
          - ErrorEquals:
            - HandledError
            Next: CustomErrorFallback
          - ErrorEquals:
            - States.TaskFailed
            Next: ReservedTypeFallback
          - ErrorEquals:
            - States.ALL
            Next: CatchAllFallback
          End: true
        CustomErrorFallback:
          Type: Pass
          Result: "This is a fallback from a custom lambda function exception"
          End: true
        ReservedTypeFallback:
          Type: Pass
          Result: "This is a fallback from a reserved error code"
          End: true
        CatchAllFallback:
          Type: Pass
          Result: "This is a fallback from a reserved error code"
          End: true

Choice

functions:
  hellofunc1:
    handler: handler.hello1
  hellofunc2:
    handler: handler.hello2
  hellofunc3:
    handler: handler.hello3
  hellofunc4:
    handler: handler.hello4
stepFunctions:
  stateMachines:
    yourChoiceMachine:
      Comment: "An example of the Amazon States Language using a choice state."
      StartAt: FirstState
      States:
        FirstState:
          Type: Task
          Resource: hellofunc1
          Next: ChoiceState
        ChoiceState:
          Type: Choice
          Choices:
          - Variable: "$.foo"
            NumericEquals: 1
            Next: FirstMatchState
          - Variable: "$.foo"
            NumericEquals: 2
            Next: SecondMatchState
          Default: DefaultState
        FirstMatchState:
          Type: Task
          Resource: hellofunc2
          Next: NextState
        SecondMatchState:
          Type: Task
          Resource: hellofunc3
          Next: NextState
        DefaultState:
          Type: Fail
          Cause: "No Matches!"
        NextState:
          Type: Task
          Resource: hellofunc4
          End: true