Skip to content

Commit 18aba0f

Browse files
author
Chris Sullivan
committed
Adding readme
1 parent e92203b commit 18aba0f

File tree

2 files changed

+24
-1
lines changed

2 files changed

+24
-1
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,3 +154,26 @@ plugins:
154154
- serverless-step-functions
155155
```
156156
157+
### Adding a custom name for a stateMachine
158+
In case you need to interpolate a specific stage or service layer variable as the
159+
stateMachines name you can add a `Name` property to your yaml.
160+
161+
```yml
162+
service: messager
163+
164+
functions:
165+
sendMessage:
166+
handler: handler.sendMessage
167+
168+
stepFunctions:
169+
stateMachines:
170+
sendMessageFunc:
171+
Name: sendMessageFunc-${self:custom.service}-${opt:stage}
172+
definition:
173+
<your definition>
174+
175+
plugins:
176+
- serverless-step-functions
177+
```
178+
179+
Please note, that during normalization some characters will be changed to adhere to CloudFormation templates.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "serverless-step-functions",
3-
"version": "1.0.2",
3+
"version": "1.0.3",
44
"description": "The module is AWS Step Functions plugin for Serverless Framework",
55
"main": "lib/index.js",
66
"scripts": {

0 commit comments

Comments
 (0)