@mapbox/cloudfriend 7.1.0 → 7.2.0-0

package/lib/shortcuts/api.md

@@ -142,6 +142,7 @@ a Lambda permission.
 | --- | --- | --- | --- |
 | options | <code>Object</code> |  | Extends the options for [`Lambda`](#lambda) with the following additional attributes: |
 | options.EventPattern | <code>String</code> |  | See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern). |
+| [options.EventBusName] | <code>String</code> | <code>&#x27;default&#x27;</code> | See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname). |
 | [options.State] | <code>String</code> | <code>&#x27;ENABLED&#x27;</code> | See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state). |
 
 **Example**  
@@ -165,6 +166,38 @@ const lambda = new cf.shortcuts.EventLambda({
   }
 });
 
+module.exports = cf.merge(myTemplate, lambda);
+```
+**Example**  
+```js
+const cf = require('@mapbox/cloudfriend');
+
+const myTemplate = {
+  ...
+  Resources: {
+    MyEventBus: {
+      Type: 'AWS::Events::EventBus',
+      Properties: { ... }
+    }
+  }
+};
+
+const lambda = new cf.shortcuts.EventLambda({
+  LogicalName: 'MyLambda',
+  Code: {
+    S3Bucket: 'my-code-bucket',
+    S3Key: 'path/to/code.zip'
+  },
+  EventBusName: cf.ref('MyEventBus'),
+  EventPattern: {
+    'detail-type': ['AWS Console Sign In via CloudTrail'],
+    detail: {
+      eventSource: ['signin.amazonaws.com'],
+      eventName: ['ConsoleLogin']
+    }
+  }
+});
+
 module.exports = cf.merge(myTemplate, lambda);
 ```
 <a name="GlueDatabase"></a>
@@ -674,6 +707,7 @@ a Lambda permission.
 | --- | --- | --- | --- |
 | options | <code>Object</code> |  | Extends the options for [`Lambda`](#lambda) with the following additional attributes: |
 | options.ScheduleExpression | <code>String</code> |  | See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression). |
+| [options.EventBusName] | <code>String</code> | <code>&#x27;default&#x27;</code> | See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname). |
 | [options.State] | <code>String</code> | <code>&#x27;ENABLED&#x27;</code> | See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state). |
 
 **Example**  
@@ -691,6 +725,32 @@ const lambda = new cf.shortcuts.ScheduledLambda({
   ScheduleExpression: 'cron(45 * * * ? *)',
 });
 
+module.exports = cf.merge(myTemplate, lambda);
+```
+**Example**  
+```js
+const cf = require('@mapbox/cloudfriend');
+
+const myTemplate = {
+  ...
+  Resources: {
+    MyEventBus: {
+      Type: 'AWS::Events::EventBus',
+      Properties: { ... }
+    }
+  }
+};
+
+const lambda = new cf.shortcuts.ScheduledLambda({
+  LogicalName: 'MyLambda',
+  Code: {
+    S3Bucket: 'my-code-bucket',
+    S3Key: 'path/to/code.zip'
+  },
+  EventBusName: cf.ref('MyEventBus'),
+  ScheduleExpression: 'cron(45 * * * ? *)',
+});
+
 module.exports = cf.merge(myTemplate, lambda);
 ```
 <a name="ServiceRole"></a>

package/lib/shortcuts/event-lambda.js

@@ -10,6 +10,7 @@ const Lambda = require('./lambda');
  * @param {Object} options - Extends the options for [`Lambda`](#lambda)
  * with the following additional attributes:
  * @param {String} options.EventPattern - See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern).
+ * @param {String} [options.EventBusName='default'] - See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname).
  * @param {String} [options.State='ENABLED'] - See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state).
  *
  * @example
@@ -33,6 +34,37 @@ const Lambda = require('./lambda');
  * });
  *
  * module.exports = cf.merge(myTemplate, lambda);
+ *
+ * @example
+ * const cf = require('@mapbox/cloudfriend');
+ *
+ * const myTemplate = {
+ *   ...
+ *   Resources: {
+ *     MyEventBus: {
+ *       Type: 'AWS::Events::EventBus',
+ *       Properties: { ... }
+ *     }
+ *   }
+ * };
+ *
+ * const lambda = new cf.shortcuts.EventLambda({
+ *   LogicalName: 'MyLambda',
+ *   Code: {
+ *     S3Bucket: 'my-code-bucket',
+ *     S3Key: 'path/to/code.zip'
+ *   },
+ *   EventBusName: cf.ref('MyEventBus'),
+ *   EventPattern: {
+ *     'detail-type': ['AWS Console Sign In via CloudTrail'],
+ *     detail: {
+ *       eventSource: ['signin.amazonaws.com'],
+ *       eventName: ['ConsoleLogin']
+ *     }
+ *   }
+ * });
+ *
+ * module.exports = cf.merge(myTemplate, lambda);
  */
 class EventLambda extends Lambda {
   constructor(options) {
@@ -41,6 +73,7 @@ class EventLambda extends Lambda {
 
     const {
       EventPattern,
+      EventBusName,
       State = 'ENABLED'
     } = options;
 
@@ -72,6 +105,10 @@ class EventLambda extends Lambda {
       }
     };
 
+    if (EventBusName) {
+      this.Resources[`${this.LogicalName}Trigger`].Properties.EventBusName = EventBusName;
+    }
+
     this.Resources[`${this.LogicalName}Permission`] = {
       Type: 'AWS::Lambda::Permission',
       Condition: this.Condition,

package/lib/shortcuts/scheduled-lambda.js

@@ -9,6 +9,7 @@ const Lambda = require('./lambda');
  *
  * @param {Object} options - Extends the options for [`Lambda`](#lambda) with the following additional attributes:
  * @param {String} options.ScheduleExpression - See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression).
+ * @param {String} [options.EventBusName='default'] - See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname).
  * @param {String} [options.State='ENABLED'] - See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state).
  *
  * @example
@@ -26,6 +27,32 @@ const Lambda = require('./lambda');
  * });
  *
  * module.exports = cf.merge(myTemplate, lambda);
+ *
+ * @example
+ * const cf = require('@mapbox/cloudfriend');
+ *
+ * const myTemplate = {
+ *   ...
+ *   Resources: {
+ *     MyEventBus: {
+ *       Type: 'AWS::Events::EventBus',
+ *       Properties: { ... }
+ *     }
+ *   }
+ * };
+ *
+ * const lambda = new cf.shortcuts.ScheduledLambda({
+ *   LogicalName: 'MyLambda',
+ *   Code: {
+ *     S3Bucket: 'my-code-bucket',
+ *     S3Key: 'path/to/code.zip'
+ *   },
+ *   EventBusName: cf.ref('MyEventBus'),
+ *   ScheduleExpression: 'cron(45 * * * ? *)',
+ * });
+ *
+ * module.exports = cf.merge(myTemplate, lambda);
+ *
  */
 class ScheduledLambda extends Lambda {
   constructor(options) {
@@ -33,6 +60,7 @@ class ScheduledLambda extends Lambda {
     super(options);
 
     const {
+      EventBusName,
       ScheduleExpression,
       State = 'ENABLED'
     } = options;
@@ -65,6 +93,10 @@ class ScheduledLambda extends Lambda {
       }
     };
 
+    if (EventBusName) {
+      this.Resources[`${this.LogicalName}Schedule`].Properties.EventBusName = EventBusName;
+    }
+
     this.Resources[`${this.LogicalName}Permission`] = {
       Type: 'AWS::Lambda::Permission',
       Condition: this.Condition,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mapbox/cloudfriend",
-  "version": "7.1.0",
+  "version": "7.2.0-0",
   "description": "Helper functions for assembling CloudFormation templates in JavaScript",
   "main": "index.js",
   "engines": {
@@ -8,6 +8,8 @@
   },
   "scripts": {
     "pretest": "eslint index.js test lib bin cloudformation && npm run shortcuts-api-doc",
+    "lint": "eslint index.js test lib bin cloudformation",
+    "lint:fix": "npm run lint -- --fix",
     "test": "nyc tape test/*.test.js | tap-spec",
     "coverage": "nyc --reporter html tape test/*.test.js && opener coverage/index.html",
     "build-ci-template": "bin/build-template.js cloudformation/ci.template.js > cloudformation/ci.template.json",

package/test/fixtures/shortcuts/event-lambda-custom-eventbus.json

@@ -0,0 +1,200 @@
+{
+  "AWSTemplateFormatVersion": "2010-09-09",
+  "Metadata": {},
+  "Parameters": {},
+  "Rules": {},
+  "Mappings": {},
+  "Conditions": {},
+  "Resources": {
+    "MyLambdaLogs": {
+      "Type": "AWS::Logs::LogGroup",
+      "Properties": {
+        "LogGroupName": {
+          "Fn::Sub": [
+            "/aws/lambda/${name}",
+            {
+              "name": {
+                "Fn::Sub": "${AWS::StackName}-MyLambda"
+              }
+            }
+          ]
+        },
+        "RetentionInDays": 14
+      }
+    },
+    "MyLambda": {
+      "Type": "AWS::Lambda::Function",
+      "Properties": {
+        "Code": {
+          "S3Bucket": "my-code-bucket",
+          "S3Key": "path/to/code.zip"
+        },
+        "Description": {
+          "Fn::Sub": "MyLambda in the ${AWS::StackName} stack"
+        },
+        "FunctionName": {
+          "Fn::Sub": "${AWS::StackName}-MyLambda"
+        },
+        "Handler": "index.handler",
+        "MemorySize": 128,
+        "Runtime": "nodejs18.x",
+        "Timeout": 300,
+        "Role": {
+          "Fn::GetAtt": [
+            "MyLambdaRole",
+            "Arn"
+          ]
+        }
+      }
+    },
+    "MyLambdaErrorAlarm": {
+      "Type": "AWS::CloudWatch::Alarm",
+      "Properties": {
+        "AlarmName": {
+          "Fn::Sub": "${AWS::StackName}-MyLambda-Errors-${AWS::Region}"
+        },
+        "AlarmDescription": {
+          "Fn::Sub": [
+            "Error alarm for ${name} lambda function in ${AWS::StackName} stack",
+            {
+              "name": {
+                "Fn::Sub": "${AWS::StackName}-MyLambda"
+              }
+            }
+          ]
+        },
+        "AlarmActions": [],
+        "Period": 60,
+        "EvaluationPeriods": 5,
+        "DatapointsToAlarm": 1,
+        "Statistic": "Sum",
+        "Threshold": 0,
+        "ComparisonOperator": "GreaterThanThreshold",
+        "TreatMissingData": "notBreaching",
+        "Namespace": "AWS/Lambda",
+        "Dimensions": [
+          {
+            "Name": "FunctionName",
+            "Value": {
+              "Ref": "MyLambda"
+            }
+          }
+        ],
+        "MetricName": "Errors"
+      }
+    },
+    "MyLambdaLogPolicy": {
+      "Type": "AWS::IAM::Policy",
+      "DependsOn": "MyLambdaRole",
+      "Properties": {
+        "PolicyName": "lambda-log-access",
+        "Roles": [
+          {
+            "Ref": "MyLambdaRole"
+          }
+        ],
+        "PolicyDocument": {
+          "Version": "2012-10-17",
+          "Statement": [
+            {
+              "Effect": "Allow",
+              "Action": "logs:*",
+              "Resource": {
+                "Fn::GetAtt": [
+                  "MyLambdaLogs",
+                  "Arn"
+                ]
+              }
+            }
+          ]
+        }
+      }
+    },
+    "MyLambdaRole": {
+      "Type": "AWS::IAM::Role",
+      "Properties": {
+        "AssumeRolePolicyDocument": {
+          "Statement": [
+            {
+              "Effect": "Allow",
+              "Action": "sts:AssumeRole",
+              "Principal": {
+                "Service": {
+                  "Fn::Sub": "lambda.amazonaws.com"
+                }
+              }
+            }
+          ]
+        }
+      }
+    },
+    "MyLambdaTrigger": {
+      "Type": "AWS::Events::Rule",
+      "Properties": {
+        "Name": {
+          "Fn::Sub": "${AWS::StackName}-MyLambda"
+        },
+        "Description": {
+          "Fn::Sub": [
+            "Event trigger for ${function} in ${AWS::StackName} stack",
+            {
+              "function": {
+                "Fn::Sub": "${AWS::StackName}-MyLambda"
+              }
+            }
+          ]
+        },
+        "State": "DISABLED",
+        "EventPattern": {
+          "source": [
+            "aws.ec2"
+          ],
+          "detail-type": [
+            "EC2 Instance State-change Notification"
+          ],
+          "detail": {
+            "state": [
+              "running"
+            ]
+          }
+        },
+        "Targets": [
+          {
+            "Id": {
+              "Fn::Sub": "${AWS::StackName}-MyLambda"
+            },
+            "Arn": {
+              "Fn::GetAtt": [
+                "MyLambda",
+                "Arn"
+              ]
+            }
+          }
+        ],
+        "EventBusName": "my-cool-eventbus"
+      }
+    },
+    "MyLambdaPermission": {
+      "Type": "AWS::Lambda::Permission",
+      "Properties": {
+        "Action": "lambda:InvokeFunction",
+        "FunctionName": {
+          "Fn::GetAtt": [
+            "MyLambda",
+            "Arn"
+          ]
+        },
+        "Principal": {
+          "Fn::Sub": "events.${AWS::URLSuffix}"
+        },
+        "SourceArn": {
+          "Fn::GetAtt": [
+            "MyLambdaTrigger",
+            "Arn"
+          ]
+        }
+      }
+    }
+  },
+  "Outputs": {}
+}

package/test/fixtures/shortcuts/hookshot-github-secret-ref.json

@@ -28,7 +28,7 @@
       "Type": "AWS::ApiGateway::Stage",
       "Properties": {
         "DeploymentId": {
-          "Ref": "PassDeploymentdf0c9696"
+          "Ref": "PassDeployment41d722f6"
         },
         "StageName": "hookshot",
         "RestApiId": {
@@ -47,7 +47,7 @@
         ]
       }
     },
-    "PassDeploymentdf0c9696": {
+    "PassDeployment41d722f6": {
       "Type": "AWS::ApiGateway::Deployment",
       "DependsOn": "PassMethod",
       "Properties": {

package/test/fixtures/shortcuts/hookshot-github-secret-string.json

@@ -24,7 +24,7 @@
       "Type": "AWS::ApiGateway::Stage",
       "Properties": {
         "DeploymentId": {
-          "Ref": "PassDeploymentdf0c9696"
+          "Ref": "PassDeployment41d722f6"
         },
         "StageName": "hookshot",
         "RestApiId": {
@@ -43,7 +43,7 @@
         ]
       }
     },
-    "PassDeploymentdf0c9696": {
+    "PassDeployment41d722f6": {
       "Type": "AWS::ApiGateway::Deployment",
       "DependsOn": "PassMethod",
       "Properties": {

package/test/fixtures/shortcuts/hookshot-github.json

@@ -24,7 +24,7 @@
       "Type": "AWS::ApiGateway::Stage",
       "Properties": {
         "DeploymentId": {
-          "Ref": "PassDeploymentdf0c9696"
+          "Ref": "PassDeployment41d722f6"
         },
         "StageName": "hookshot",
         "RestApiId": {
@@ -43,7 +43,7 @@
         ]
       }
     },
-    "PassDeploymentdf0c9696": {
+    "PassDeployment41d722f6": {
       "Type": "AWS::ApiGateway::Deployment",
       "DependsOn": "PassMethod",
       "Properties": {

package/test/fixtures/shortcuts/hookshot-passthrough-access-log-format.json

@@ -24,7 +24,7 @@
       "Type": "AWS::ApiGateway::Stage",
       "Properties": {
         "DeploymentId": {
-          "Ref": "PassDeploymentdf0c9696"
+          "Ref": "PassDeployment41d722f6"
         },
         "StageName": "hookshot",
         "RestApiId": {
@@ -52,7 +52,7 @@
         }
       }
     },
-    "PassDeploymentdf0c9696": {
+    "PassDeployment41d722f6": {
       "Type": "AWS::ApiGateway::Deployment",
       "DependsOn": "PassMethod",
       "Properties": {

package/test/fixtures/shortcuts/hookshot-passthrough-alarms.json

@@ -24,7 +24,7 @@
       "Type": "AWS::ApiGateway::Stage",
       "Properties": {
         "DeploymentId": {
-          "Ref": "PassDeploymentdf0c9696"
+          "Ref": "PassDeployment41d722f6"
         },
         "StageName": "hookshot",
         "RestApiId": {
@@ -43,7 +43,7 @@
         ]
       }
     },
-    "PassDeploymentdf0c9696": {
+    "PassDeployment41d722f6": {
       "Type": "AWS::ApiGateway::Deployment",
       "DependsOn": "PassMethod",
       "Properties": {

package/test/fixtures/shortcuts/hookshot-passthrough-enhanced-logging.json

@@ -24,7 +24,7 @@
       "Type": "AWS::ApiGateway::Stage",
       "Properties": {
         "DeploymentId": {
-          "Ref": "PassDeploymentdf0c9696"
+          "Ref": "PassDeployment41d722f6"
         },
         "StageName": "hookshot",
         "RestApiId": {
@@ -43,7 +43,7 @@
         ]
       }
     },
-    "PassDeploymentdf0c9696": {
+    "PassDeployment41d722f6": {
       "Type": "AWS::ApiGateway::Deployment",
       "DependsOn": "PassMethod",
       "Properties": {

package/test/fixtures/shortcuts/hookshot-passthrough-full-blown-logging.json

@@ -24,7 +24,7 @@
       "Type": "AWS::ApiGateway::Stage",
       "Properties": {
         "DeploymentId": {
-          "Ref": "PassDeploymentdf0c9696"
+          "Ref": "PassDeployment41d722f6"
         },
         "StageName": "hookshot",
         "RestApiId": {
@@ -43,7 +43,7 @@
         ]
       }
     },
-    "PassDeploymentdf0c9696": {
+    "PassDeployment41d722f6": {
       "Type": "AWS::ApiGateway::Deployment",
       "DependsOn": "PassMethod",
       "Properties": {

package/test/fixtures/shortcuts/hookshot-passthrough-logging.json

@@ -24,7 +24,7 @@
       "Type": "AWS::ApiGateway::Stage",
       "Properties": {
         "DeploymentId": {
-          "Ref": "PassDeploymentdf0c9696"
+          "Ref": "PassDeployment41d722f6"
         },
         "StageName": "hookshot",
         "RestApiId": {
@@ -43,7 +43,7 @@
         ]
       }
     },
-    "PassDeploymentdf0c9696": {
+    "PassDeployment41d722f6": {
       "Type": "AWS::ApiGateway::Deployment",
       "DependsOn": "PassMethod",
       "Properties": {

package/test/fixtures/shortcuts/hookshot-passthrough.json

@@ -24,7 +24,7 @@
       "Type": "AWS::ApiGateway::Stage",
       "Properties": {
         "DeploymentId": {
-          "Ref": "PassDeploymentdf0c9696"
+          "Ref": "PassDeployment41d722f6"
         },
         "StageName": "hookshot",
         "RestApiId": {
@@ -43,7 +43,7 @@
         ]
       }
     },
-    "PassDeploymentdf0c9696": {
+    "PassDeployment41d722f6": {
       "Type": "AWS::ApiGateway::Deployment",
       "DependsOn": "PassMethod",
       "Properties": {