You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- [Customizing request body mapping templates](#customizing-request-body-mapping-templates)
28
+
- [Send request to an API](#send-request-to-an-api)
29
+
- [Setting API keys for your Rest API](#setting-api-keys-for-your-rest-api)
30
+
-[Schedule](#schedule)
31
+
-[Enabling / Disabling](#enabling--disabling)
32
+
7
33
## Install
8
34
9
35
Run `npm install` in your Serverless project.
@@ -140,7 +166,7 @@ plugins:
140
166
141
167
You can then `Ref: SendMessageStateMachine` in various parts of CloudFormation or serverless.yml
142
168
143
-
#### Depending on another logical id
169
+
### Depending on another logical id
144
170
145
171
If your state machine depends on another resource defined in your `serverless.yml` then you can add a `dependsOn` field to the state machine `definition`. This would add the `DependsOn`clause to the generated CloudFormation template.
146
172
@@ -158,7 +184,7 @@ stepFunctions:
158
184
- myStream
159
185
```
160
186
161
-
#### CloudWatch Alarms
187
+
### CloudWatch Alarms
162
188
163
189
It's common practice to want to monitor the health of your state machines and be alerted when something goes wrong. You can either:
164
190
@@ -226,7 +252,7 @@ alarms:
226
252
treatMissingData: ignore # default
227
253
```
228
254
229
-
#### CloudWatch Notifications
255
+
### CloudWatch Notifications
230
256
231
257
You can monitor the execution state of your state machines [via CloudWatch Events](https://aws.amazon.com/about-aws/whats-new/2019/05/aws-step-functions-adds-support-for-workflow-execution-events/). It allows you to be alerted when the status of your state machine changes to `ABORTED`, `FAILED`, `RUNNING`, `SUCCEEDED` or `TIMED_OUT`.
232
258
@@ -266,7 +292,7 @@ CloudFormation intrinsic functions such as `Ref` and `Fn::GetAtt` are supported.
266
292
267
293
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`.
268
294
269
-
#### Current Gotcha
295
+
## Current Gotcha
270
296
271
297
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.
272
298
@@ -493,7 +519,7 @@ stepFunctions:
493
519
definition:
494
520
```
495
521
496
-
### Share Authorizer
522
+
#### Shared Authorizer
497
523
498
524
Auto-created Authorizer is convenient for conventional setup. However, when you need to define your custom Authorizer, or use COGNITO_USER_POOLS authorizer with shared API Gateway, it is painful because of AWS limitation. Sharing Authorizer is a better way to do.
499
525
@@ -636,7 +662,7 @@ stepFunctions:
636
662
definition:
637
663
```
638
664
639
-
## Enabling / Disabling
665
+
#### Enabling / Disabling
640
666
641
667
**Note:** `schedule` events are enabled by default.
642
668
@@ -662,7 +688,7 @@ stepFunctions:
662
688
inputPath: '$.stageVariables'
663
689
```
664
690
665
-
## Specify Name and Description
691
+
#### Specify Name and Description
666
692
667
693
Name and Description can be specified for a schedule event. These are not required properties.
668
694
@@ -674,7 +700,7 @@ events:
674
700
rate: rate(2 hours)
675
701
```
676
702
677
-
## Scheduled Events IAM Role
703
+
#### Scheduled Events IAM Role
678
704
679
705
By default, the plugin will create a new IAM role that allows AWS Events to start your state machine. Note that this role is different than the role assumed by the state machine. You can specify your own role instead (it must allow `events.amazonaws.com` to assume it, and it must be able to run `states:StartExecution` on your state machine):
680
706
@@ -687,7 +713,7 @@ events:
687
713
688
714
### CloudWatch Event
689
715
690
-
## Simple event definition
716
+
#### Simple event definition
691
717
692
718
This will enable your Statemachine to be called by an EC2 event rule.
693
719
Please check the page of [Event Types for CloudWatch Events](http://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html).
@@ -710,7 +736,7 @@ stepFunctions:
710
736
...
711
737
```
712
738
713
-
## Enabling / Disabling
739
+
#### Enabling / Disabling
714
740
715
741
**Note:** `cloudwatchEvent` events are enabled by default.
716
742
@@ -735,7 +761,7 @@ stepFunctions:
735
761
...
736
762
```
737
763
738
-
## Specify Input or Inputpath
764
+
#### Specify Input or Inputpath
739
765
740
766
You can specify input values to the Lambda function.
741
767
@@ -772,7 +798,7 @@ stepFunctions:
772
798
...
773
799
```
774
800
775
-
## Specifying a Description
801
+
#### Specifying a Description
776
802
777
803
You can also specify a CloudWatch Event description.
778
804
@@ -795,7 +821,7 @@ stepFunctions:
795
821
...
796
822
```
797
823
798
-
## Specifying a Name
824
+
#### Specifying a Name
799
825
800
826
You can also specify a CloudWatch Event name. Keep in mind that the name must begin with a letter; contain only ASCII letters, digits, and hyphens; and not end with a hyphen or contain two consecutive hyphens. More infomation [here](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
801
827
@@ -818,7 +844,7 @@ stepFunctions:
818
844
...
819
845
```
820
846
821
-
## Tags
847
+
### Tags
822
848
823
849
You can specify tags on each state machine. Additionally any global tags (specified under `provider` section in your `serverless.yml`) would be merged in as well.
0 commit comments