Merge pull request serverless-operations#3 from bucha09/master

fix: add description in readme.md
BetSEQNZR · Mar 12, 2020 · a8e1957 · a8e1957
2 parents c5264e4 + 6983a05
commit a8e1957
Showing 1 changed file with 28 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -42,6 +42,7 @@ This is the Serverless Framework plugin for AWS Step Functions.
          - [Specify Input or Inputpath](#specify-input-or-inputpath)
          - [Specifying a Description](#specifying-a-description)
          - [Specifying a Name](#specifying-a-name)
+         - [Specifying a RoleArn](#specifying-a-rolearn)
          - [Specifying a custom CloudWatch EventBus](#specifying-a-custom-cloudwatch-eventbus)
  - [Tags](#tags)
  - [Commands](#commands)
@@ -1001,6 +1002,33 @@ stepFunctions:
         ...
 ```
 
+#### Specifying a RoleArn
+
+You can also specify a CloudWatch Event RoleArn.
+The Amazon Resource Name (ARN) of the role that is used for target invocation.
+
+Required: No
+
+```yml
+stepFunctions:
+  stateMachines:
+    cloudwatchEvent:
+      events:
+        - cloudwatchEvent:
+            name: 'my-cloudwatch-event-name'
+            iamRole: 'arn:aws:iam::012345678910:role/Events-InvokeStepFunctions-Role'
+            event:
+              source:
+                - "aws.ec2"
+              detail-type:
+                - "EC2 Instance State-change Notification"
+              detail:
+                state:
+                  - pending
+      definition:
+        ...
+```
+
 #### Specifying a custom CloudWatch EventBus
 
 You can choose which CloudWatch Event bus to listen to: