Skip to content

Commit 352e5c8

Browse files
docs: added info about express workflows
1 parent daa052f commit 352e5c8

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ This is the Serverless Framework plugin for AWS Step Functions.
1515
- [CloudWatch Notifications](#cloudwatch-notifications)
1616
- [Blue-Green deployments](#blue-green-deployment)
1717
- [Pre-deployment validation](#pre-deployment-validation)
18+
- [Express Workflow](#express-workflow)
1819
- [Current Gotcha](#current-gotcha)
1920
- [Events](#events)
2021
- [API Gateway](#api-gateway)
@@ -348,6 +349,24 @@ stepFunctions:
348349
validate: true
349350
```
350351

352+
### Express Workflow
353+
354+
At re:invent 2019, AWS [introduced Express Workflows](https://aws.amazon.com/about-aws/whats-new/2019/12/introducing-aws-step-functions-express-workflows/) as a cheaper, more scalable alternative (but with a cut-down set of features). See [this page](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-standard-vs-express.html) for differences between standard and express workflows.
355+
356+
To declare an express workflow, specify `type` as `EXPRESS` and you can specify the logging configuration (only applicable for express workflows).
357+
358+
```yaml
359+
stepFunctions:
360+
stateMachines:
361+
hellostepfunc1:
362+
type: EXPRESS
363+
loggingConfig:
364+
level: ERROR
365+
includeExecutionData: true
366+
destinations:
367+
- Fn::GetAtt: [MyLogGroup, Arn]
368+
```
369+
351370
## Current Gotcha
352371

353372
Please keep this gotcha in mind if you want to reference the `name` from the `resources` section. To generate Logical ID for CloudFormation, the plugin transforms the specified name in serverless.yml based on the following scheme.

0 commit comments

Comments
 (0)