Merge pull request #270 from PhileasSystems/master

feat: support EventBusName for custom Cloudwatch event bus

Author: theburningmonk

README.md

@@ -40,6 +40,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 custom CloudWatch EventBus](#specifying-a-custom-cloudwatch-eventbus)
  - [Tags](#tags)
  - [Commands](#commands)
      - [deploy](#deploy)
@@ -933,6 +934,29 @@ stepFunctions:
         ...
 ```
 
+#### Specifying a custom CloudWatch EventBus
+
+You can choose which CloudWatch Event bus to listen to:
+
+```yml
+stepFunctions:
+  stateMachines:
+    cloudwatchEvent:
+      events:
+        - cloudwatchEvent:
+            eventBusName: 'my-custom-event-bus'
+            event:
+              source:
+                - "my.custom.source"
+              detail-type:
+                - "My Event Type"
+              detail:
+                state:
+                  - pending
+      definition:
+        ...
+```
+
 ## Tags
 
 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.
@@ -1359,4 +1383,4 @@ stepFunctions:
 
 plugins:
   - serverless-step-functions
-```
+```

lib/deploy/events/cloudWatchEvent/compileCloudWatchEventEvents.js

@@ -19,6 +19,7 @@ module.exports = {
             let InputPath;
             let Description;
             let Name;
+            let EventBusName;
 
             if (typeof event.cloudwatchEvent === 'object') {
               if (!event.cloudwatchEvent.event) {
@@ -39,6 +40,7 @@ module.exports = {
               InputPath = event.cloudwatchEvent.inputPath;
               Description = event.cloudwatchEvent.description;
               Name = event.cloudwatchEvent.name;
+              EventBusName = event.cloudwatchEvent.eventBusName;
 
               if (Input && InputPath) {
                 const errorMessage = [
@@ -78,6 +80,7 @@ module.exports = {
               {
                 "Type": "AWS::Events::Rule",
                 "Properties": {
+                  ${EventBusName ? `"EventBusName": "${EventBusName}",` : ''}
                   "EventPattern": ${EventPattern.replace(/\\n|\\r/g, '')},
                   "State": "${State}",
                   ${Description ? `"Description": "${Description}",` : ''}

lib/deploy/events/cloudWatchEvent/compileCloudWatchEventEvents.test.js

@@ -262,6 +262,36 @@ describe('awsCompileCloudWatchEventEvents', () => {
         .Properties.Name).to.equal('test-event-name');
     });
 
+    it('should respect eventBusName variable', () => {
+      serverlessStepFunctions.serverless.service.stepFunctions = {
+        stateMachines: {
+          first: {
+            events: [
+              {
+                cloudwatchEvent: {
+                  event: {
+                    source: ['aws.ec2'],
+                    'detail-type': ['EC2 Instance State-change Notification'],
+                    detail: { state: ['pending'] },
+                  },
+                  enabled: false,
+                  input: '{"key":"value"}',
+                  name: 'test-event-name',
+                  eventBusName: 'custom-event-bus',
+                },
+              },
+            ],
+          },
+        },
+      };
+
+      serverlessStepFunctions.compileCloudWatchEventEvents();
+
+      expect(serverlessStepFunctions.serverless.service
+        .provider.compiledCloudFormationTemplate.Resources.FirstEventsRuleCloudWatchEvent1
+        .Properties.EventBusName).to.equal('custom-event-bus');
+    });
+
     it('should respect input variable as an object', () => {
       serverlessStepFunctions.serverless.service.stepFunctions = {
         stateMachines: {