Amazon API Gateway HTTP API to AWS Step Functions Express Workflow

This pattern explains how to deploy a CDK application with a Amazon API Gateway HTTP API that invokes a Step Functions Express workflow.

When an HTTP POST request is made to the Amazon API Gateway endpoint, the Step Functions Express workflow is invoked and the results of the execution are returned in the HTTP response.

Learn more about this pattern at Serverless Land Patterns: https://serverlessland.com/patterns

Important: this application uses various AWS services and there are costs associated with these services after the Free Tier usage - please see the AWS Pricing page for details. You are responsible for any AWS costs incurred. No warranty is implied in this example.

Requirements

• Create an AWS account if you do not already have one and log in. The IAM user that you use must have sufficient permissions to make necessary AWS service calls and manage AWS resources.
• AWS CLI installed and configured
• Git Installed
• AWS CDK installed and configured

Deployment Instructions

1. Clone the project to your local working directory

   git clone https://github.com/aws-samples/serverless-patterns
   

2. Change the working directory to this pattern's directory

   cd serverless-patterns/apigw-http-api-step-functions-express-java
   

3. From the command line, configure AWS CDK:

   cdk bootstrap ACCOUNT-NUMBER/REGION # e.g.
   cdk bootstrap 1111111111/us-east-1
   cdk bootstrap --profile test 1111111111/us-east-1

4. From the command line, use AWS CDK to deploy the AWS resources for the pattern as specified in the lib/cdk-stack.ts file:

   cdk deploy

5. Note the outputs from the CDK deployment process. These contain the resource names and/or ARNs which are used for testing.

How it works

When an HTTP POST request is sent to the Amazon API Gateway endpoint a Step Function Express workflow is invoked synchronously. The output state of the Step Function is then returned in the HTTP response.

Testing

After deployment, use the AWS Management Console (explained below) to test this pattern by sending an HTTP POST request to the Amazon API Gateway endpoint (found in the CloudFormation console Stacks Outputs tab).

Cleanup

Run the given command to delete the resources that were created. It might take some time for the CloudFormation stack to get deleted.

cdk destroy

---

Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: MIT-0