UNPKG

@bowtie/sls

Version:

Serverless helpers & utilities

4,489 lines (1,038 loc) 51.9 kB
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <title>Global - Documentation</title> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css"> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger" /> <label for="nav-trigger" class="navicon-button x"> <div class="navicon"></div> </label> <label for="nav-trigger" class="overlay"></label> <nav> <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#actionFailureNotifySlack">actionFailureNotifySlack</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#bitbucketWebhook">bitbucketWebhook</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#buildChange">buildChange</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#buildChangeNotifyBitbucket">buildChangeNotifyBitbucket</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#buildChangeNotifyGithub">buildChangeNotifyGithub</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#buildChangeNotifySlack">buildChangeNotifySlack</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#decodeBody">decodeBody</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#deployBuild">deployBuild</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#deployEcr">deployEcr</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#deploymentNotifyAirbrake">deploymentNotifyAirbrake</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#deployments">deployments</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#deployS3">deployS3</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#describeStack">describeStack</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#findClusterName">findClusterName</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#findClusterStack">findClusterStack</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#findMigrationTask">findMigrationTask</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#getStatusColor">getStatusColor</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#githubWebhook">githubWebhook</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#init">init</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#initMigration">initMigration</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#parseBody">parseBody</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#parsePayload">parsePayload</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#prepareBuild">prepareBuild</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#runMigration">runMigration</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#slackCommand">slackCommand</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#slackResponse">slackResponse</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#stackChange">stackChange</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#startBuild">startBuild</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#trackBuild">trackBuild</a></span></li> </nav> <div id="main"> <h1 class="page-title">Global</h1> <section> <header> <h2> </h2> </header> <article> <div class="container-overview"> <dl class="details"> </dl> </div> <h3 class="subsection-title">Methods</h3> <div class="section-method"> <h4 class="name" id="actionFailureNotifySlack"><span class="type-signature"></span>actionFailureNotifySlack<span class="signature">(failure)</span><span class="type-signature"></span></h4> <div class="description"> <p>Notify slack of action failure</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="notifier.js.html">notifier.js</a>, <a href="notifier.js.html#line534">line 534</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>failure</code></td> <td class="type"> <span class="param-type"><code>Error</code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="bitbucketWebhook"><span class="type-signature"></span>bitbucketWebhook<span class="signature">(event)</span><span class="type-signature"></span></h4> <div class="description"> <p>Validate Bitbucket webhook source using User-Agent header</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="validator.js.html">validator.js</a>, <a href="validator.js.html#line9">line 9</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>event</code></td> <td class="type"> <span class="param-type"><code>object</code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="buildChange"><span class="type-signature"></span>buildChange<span class="signature">(event)</span><span class="type-signature"></span></h4> <div class="description"> <p>Update build details on change</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="notifier.js.html">notifier.js</a>, <a href="notifier.js.html#line159">line 159</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>event</code></td> <td class="type"> <span class="param-type"><code>object</code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="buildChange"><span class="type-signature"></span>buildChange<span class="signature">(event)</span><span class="type-signature"></span></h4> <div class="description"> <p>Parse an event from a change in a CodeBuild service build</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="parser.js.html">parser.js</a>, <a href="parser.js.html#line150">line 150</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>event</code></td> <td class="type"> <span class="param-type"><code>object</code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="buildChangeNotifyBitbucket"><span class="type-signature"></span>buildChangeNotifyBitbucket<span class="signature">(event)</span><span class="type-signature"></span></h4> <div class="description"> <p>Notify github of build change status</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="notifier.js.html">notifier.js</a>, <a href="notifier.js.html#line192">line 192</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>event</code></td> <td class="type"> <span class="param-type"><code>object</code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="buildChangeNotifyGithub"><span class="type-signature"></span>buildChangeNotifyGithub<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> <p>Notify github of build change status</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="notifier.js.html">notifier.js</a>, <a href="notifier.js.html#line275">line 275</a> </li></ul></dd> </dl> </div> <div class="section-method"> <h4 class="name" id="buildChangeNotifySlack"><span class="type-signature"></span>buildChangeNotifySlack<span class="signature">(event)</span><span class="type-signature"></span></h4> <div class="description"> <p>Notify slack of build change status</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="notifier.js.html">notifier.js</a>, <a href="notifier.js.html#line364">line 364</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>event</code></td> <td class="type"> <span class="param-type"><code>object</code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="decodeBody"><span class="type-signature"></span>decodeBody<span class="signature">(event)</span><span class="type-signature"></span></h4> <div class="description"> <p>Decode event.body using query-string.parse()</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="parser.js.html">parser.js</a>, <a href="parser.js.html#line10">line 10</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>event</code></td> <td class="type"> <span class="param-type"><code>object</code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="deployBuild"><span class="type-signature"></span>deployBuild<span class="signature">(event)</span><span class="type-signature"></span></h4> <div class="description"> <p>Deploy build (from parsed deployments)</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="deployer.js.html">deployer.js</a>, <a href="deployer.js.html#line174">line 174</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>event</code></td> <td class="type"> <span class="param-type"><code>object</code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="deployEcr"><span class="type-signature"></span>deployEcr<span class="signature">(event, deployment, done)</span><span class="type-signature"></span></h4> <div class="description"> <p>Deploy ECR</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="deployer.js.html">deployer.js</a>, <a href="deployer.js.html#line75">line 75</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>event</code></td> <td class="type"> <span class="param-type"><code>object</code></span> </td> <td class="description last"> </td> </tr> <tr> <td class="name"><code>deployment</code></td> <td class="type"> <span class="param-type"><code>object</code></span> </td> <td class="description last"> </td> </tr> <tr> <td class="name"><code>done</code></td> <td class="type"> <span class="param-type"><code>function</code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="deploymentNotifyAirbrake"><span class="type-signature"></span>deploymentNotifyAirbrake<span class="signature">(event)</span><span class="type-signature"></span></h4> <div class="description"> <p>Notify Airbrake of deployment</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="notifier.js.html">notifier.js</a>, <a href="notifier.js.html#line464">line 464</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>event</code></td> <td class="type"> <span class="param-type"><code>object</code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="deployments"><span class="type-signature"></span>deployments<span class="signature">(event)</span><span class="type-signature"></span></h4> <div class="description"> <p>Parse deployments from event build details</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="parser.js.html">parser.js</a>, <a href="parser.js.html#line288">line 288</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>event</code></td> <td class="type"> <span class="param-type"><code>object</code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="deployS3"><span class="type-signature"></span>deployS3<span class="signature">(event, deployment, done)</span><span class="type-signature"></span></h4> <div class="description"> <p>Deploy S3</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="deployer.js.html">deployer.js</a>, <a href="deployer.js.html#line60">line 60</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>event</code></td> <td class="type"> <span class="param-type"><code>object</code></span> </td> <td class="description last"> </td> </tr> <tr> <td class="name"><code>deployment</code></td> <td class="type"> <span class="param-type"><code>object</code></span> </td> <td class="description last"> </td> </tr> <tr> <td class="name"><code>done</code></td> <td class="type"> <span class="param-type"><code>function</code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="describeStack"><span class="type-signature"></span>describeStack<span class="signature">(stack)</span><span class="type-signature"></span></h4> <div class="description"> <p>Wrapper to describe CF stack as Promise</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="migrator.js.html">migrator.js</a>, <a href="migrator.js.html#line63">line 63</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>stack</code></td> <td class="type"> <span class="param-type"><code>string</code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="findClusterName"><span class="type-signature"></span>findClusterName<span class="signature">(stack)</span><span class="type-signature"></span></h4> <div class="description"> <p>Describe current service stack and find parent cluster name</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="migrator.js.html">migrator.js</a>, <a href="migrator.js.html#line133">line 133</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>stack</code></td> <td class="type"> <span class="param-type"><code>string</code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="findClusterStack"><span class="type-signature"></span>findClusterStack<span class="signature">(stack)</span><span class="type-signature"></span></h4> <div class="description"> <p>Describe current service stack and find parent cluster stack to determine actual ECS cluster name</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="migrator.js.html">migrator.js</a>, <a href="migrator.js.html#line98">line 98</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>stack</code></td> <td class="type"> <span class="param-type"><code>string</code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="findMigrationTask"><span class="type-signature"></span>findMigrationTask<span class="signature">(stack)</span><span class="type-signature"></span></h4> <div class="description"> <p>Search ECS task definitions for &quot;-db-migrate&quot; suffix</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="migrator.js.html">migrator.js</a>, <a href="migrator.js.html#line19">line 19</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>stack</code></td> <td class="type"> <span class="param-type"><code>string</code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="getStatusColor"><span class="type-signature"></span>getStatusColor<span class="signature">(status)</span><span class="type-signature"></span></h4> <div class="description"> <p>Map the status of a stack change to a basic Slack message color</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="notifier.js.html">notifier.js</a>, <a href="notifier.js.html#line25">line 25</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>status</code></td> <td class="type"> <span class="param-type"><code>string</code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="githubWebhook"><span class="type-signature"></span>githubWebhook<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> <p>Validate github webhooks</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="validator.js.html">validator.js</a>, <a href="validator.js.html#line38">line 38</a> </li></ul></dd> </dl> </div> <div class="section-method"> <h4 class="name" id="init"><span class="type-signature"></span>init<span class="signature">(event)</span><span class="type-signature"></span></h4> <div class="description"> <p>Initialize every action by beginning the promise chain</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="action.js.html">action.js</a>, <a href="action.js.html#line12">line 12</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>event</code></td> <td class="type"> <span class="param-type"><code>object</code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="initMigration"><span class="type-signature"></span>initMigration<span class="signature">(stack)</span><span class="type-signature"></span></h4> <div class="description"> <p>Initialize migration (fail gracefully)</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="migrator.js.html">migrator.js</a>, <a href="migrator.js.html#line215">line 215</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>stack</code></td> <td class="type"> <span class="param-type"><code>string</code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="parseBody"><span class="type-signature"></span>parseBody<span class="signature">(event)</span><span class="type-signature"></span></h4> <div class="description"> <p>Parse event.body using JSON.parse()</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="parser.js.html">parser.js</a>, <a href="parser.js.html#line37">line 37</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>event</code></td> <td class="type"> <span class="param-type"><code>object</code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="parsePayload"><span class="type-signature"></span>parsePayload<span class="signature">(event)</span><span class="type-signature"></span></h4> <div class="description"> <p>Parse decoded body payload</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="parser.js.html">parser.js</a>, <a href="parser.js.html#line66">line 66</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>event</code></td> <td class="type"> <span class="param-type"><code>object</code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="prepareBuild"><span class="type-signature"></span>prepareBuild<span class="signature">(event)</span><span class="type-signature"></span></h4> <div class="description"> <p>Prepare build from event body</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="builder.js.html">builder.js</a>, <a href="builder.js.html#line80">line 80</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>event</code></td> <td class="type"> <span class="param-type"><code>object</code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="runMigration"><span class="type-signature"></span>runMigration<span class="signature">(cluster, taskDefinition)</span><span class="type-signature"></span></h4> <div class="description"> <p>Trigger migration task from found cluster and task definition</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="migrator.js.html">migrator.js</a>, <a href="migrator.js.html#line166">line 166</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>cluster</code></td> <td class="type"> <span class="param-type"><code>string</code></span> </td> <td class="description last"> </td> </tr> <tr> <td class="name"><code>taskDefinition</code></td> <td class="type"> <span class="param-type"><code>string</code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="slackCommand"><span class="type-signature"></span>slackCommand<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> <p>Parse info from a Slack slash command event</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="parser.js.html">parser.js</a>, <a href="parser.js.html#line383">line 383</a> </li></ul></dd> </dl> </div> <div class="section-method"> <h4 class="name" id="slackCommand"><span class="type-signature"></span>slackCommand<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> <p>Validate Slack slash command events</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="validator.js.html">validator.js</a>, <a href="validator.js.html#line78">line 78</a> </li></ul></dd> </dl> </div> <div class="section-method"> <h4 class="name" id="slackResponse"><span class="type-signature"></span>slackResponse<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> <p>Parse info from a Slack response</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="parser.js.html">parser.js</a>, <a href="parser.js.html#line455">line 455</a> </li></ul></dd> </dl> </div> <div class="section-method"> <h4 class="name" id="slackResponse"><span class="type-signature"></span>slackResponse<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> <p>Validate Slack response events</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="validator.js.html">validator.js</a>, <a href="validator.js.html#line109">line 109</a> </li></ul></dd> </dl> </div> <div class="section-method"> <h4 class="name" id="stackChange"><span class="type-signature"></span>stackChange<span class="signature">(event)</span><span class="type-signature"></span></h4> <div class="description"> <p>Parse SNS Records into Slack messages</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="parser.js.html">parser.js</a>, <a href="parser.js.html#line91">line 91</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>event</code></td> <td class="type"> <span class="param-type"><code>object</code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="stackChange"><span class="type-signature"></span>stackChange<span class="signature">(event)</span><span class="type-signature"></span></h4> <div class="description"> <p>Handle a stack change event (as published from SNS topic)</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="notifier.js.html">notifier.js</a>, <a href="notifier.js.html#line49">line 49</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>event</code></td> <td class="type"> <span class="param-type"><code>object</code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="stackChange"><span class="type-signature"></span>stackChange<span class="signature">(event)</span><span class="type-signature"></span></h4> <div class="description"> <p>Handle a stack change event (as published from SNS topic)</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="migrator.js.html">migrator.js</a>, <a href="migrator.js.html#line250">line 250</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>event</code></td> <td class="type"> <span class="param-type"><code>object</code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="stackChange"><span class="type-signature"></span>stackChange<span class="signature">(event)</span><span class="type-signature"></span></h4> <div class="description"> <p>Handle a stack change event (as published from SNS topic)</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="deployer.js.html">deployer.js</a>, <a href="deployer.js.html#line15">line 15</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>event</code></td> <td class="type"> <span class="param-type"><code>object</code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="startBuild"><span class="type-signature"></span>startBuild<span class="signature">(event)</span><span class="type-signature"></span></h4> <div class="description"> <p>Start build using CodeBuild Project (if build has been prepared)</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="builder.js.html">builder.js</a>, <a href="builder.js.html#line259">line 259</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>event</code></td> <td class="type"> <span class="param-type"><code>object</code></span>