Skip to content

Commit 134946c

Browse files
docs: add blue-green deployment section
1 parent 1c03515 commit 134946c

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ This is the Serverless Framework plugin for AWS Step Functions.
1313
- [Depending on another logical id](#depending-on-another-logical-id)
1414
- [CloudWatch Alarms](#cloudwatch-alarms)
1515
- [CloudWatch Notifications](#cloudwatch-notifications)
16+
- [Blue-Green deployments](#blue-green-deployment)
1617
- [Current Gotcha](#current-gotcha)
1718
- [Events](#events)
1819
- [API Gateway](#api-gateway)
@@ -318,6 +319,21 @@ CloudFormation intrinsic functions such as `Ref` and `Fn::GetAtt` are supported.
318319

319320
When setting up a notification target against a FIFO SQS queue, the queue must enable the content-based deduplication option and you must configure the `messageGroupId`.
320321

322+
### Blue green deployment
323+
324+
To implement a [blue-green deployment with Step Functions](https://theburningmonk.com/2019/08/how-to-do-blue-green-deployment-for-step-functions/) you need to reference the exact versions of the functions.
325+
326+
To do this, you can specify `useExactVersion: true` in the state machine.
327+
328+
```yml
329+
stepFunctions:
330+
stateMachines:
331+
hellostepfunc1:
332+
useExactVersion: true
333+
definition:
334+
...
335+
```
336+
321337
## Current Gotcha
322338

323339
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)