/step-function-sync-workflow

Synchronous Express Workflows for AWS Step Functions via API Gateway

Primary LanguageTypeScript

Synchronous Express Workflows for AWS Step Functions

Blog Post.

Build Status

This project contains a Step Function Express workflow which will be called synchronously via an API endpoint defined in API Gateway.

This example is taken from the docs which detects the sentiment of the user that filled a feedback form and notifies via Email in case of a negative sentiment.

This deployment might incur some costs if not in the Free Tier so it's best to destroy after you've played with it.

Steps

  1. Run yarn (recommended) or npm install

  2. Rename .example.env to .env and replace the values with your configuration. The emails are mandatory and need to be verified in SES as you wouldn't be able to send emails.

  3. Run yarn cdk deploy --all to deploy the stack.

  4. Run yarn cdk destroy --all to delete all resources

The cdk.json file tells the CDK Toolkit how to execute your app.

Useful commands

  • yarn build compile typescript to js
  • yarn watch watch for changes and compile
  • yarn test perform the jest unit tests
  • yarn cdk deploy deploy this stack to your default AWS account/region
  • yarn cdk diff compare deployed stack with current state
  • yarn cdk synth emits the synthesized CloudFormation template