npm - @gradientedge/cdk-utils - Versions diffs - 4.4.1 → 4.4.5 - Mend

@gradientedge/cdk-utils 4.4.1 → 4.4.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (406) hide show

package/api-docs/CommonConstruct.html DELETED Viewed

@@ -1,1296 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="utf-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1">
-  <title>Gradient Edge CDK Utils CommonConstruct</title>
-  <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
-  <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
-  <script src="./build/entry.js"></script>
-  <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
-  <!--[if lt IE 9]>
-    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-  <![endif]-->
-  <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
-  <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
-  <link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
-  <link type="text/css" rel="stylesheet" href="styles/app.min.css">
-  <link type="text/css" rel="stylesheet" href="styles/iframe.css">
-  <link type="text/css" rel="stylesheet" href="">
-  <script async defer src="https://buttons.github.io/buttons.js"></script>
-</head>
-<body class="layout small-header">
-    <div id="stickyNavbarOverlay"></div>
-<div class="top-nav">
-    <div class="inner">
-        <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
-            <span aria-hidden="true"></span>
-            <span aria-hidden="true"></span>
-            <span aria-hidden="true"></span>
-        </a>
-        <div class="logo">
-                <a href="index.html">
-                    <h1 class="navbar-item">Gradient Edge CDK Utils Documentation</h1>
-                </a>
-        </div>
-        <div class="menu">
-            <div class="navigation">
-                <a
-                    href="index.html"
-                    class="link"
-                >
-                    API Documentation
-                </a>
-                <div class="dropdown is-hoverable is-right">
-                    <a class="dropdown-trigger link">
-                        Tutorials
-                        <i class="fas fa-chevron-down fa-xs"></i>
-                    </a>
-                    <div class="dropdown-menu">
-                        <div class="dropdown-content">
-                            <a class="dropdown-item" href="tutorial-Architecture.html">
-                                Architecture
-                            </a>
-                            <a class="dropdown-item" href="tutorial-Build.html">
-                                Build
-                            </a>
-                            <a class="dropdown-item" href="tutorial-CI-CD.html">
-                                CI-CD
-                            </a>
-                            <a class="dropdown-item" href="tutorial-Development.html">
-                                Development
-                            </a>
-                        </div>
-                    </div>
-                </div>
-                        <a
-                            class="link user-link "
-                            href="https://github.com/gradientedge/cdk-utils"
-                        >
-                            Github
-                        </a>
-            </div>
-        </div>
-    </div>
-</div>
-    <div id="main">
-        <div
-            class="sidebar "
-            id="sidebarNav"
-        >
-                <div class="search-wrapper">
-                    <input id="search" type="text" placeholder="Search docs..." class="input">
-                </div>
-            <nav>
-                    <h2><a href="index.html">Documentation</a></h2><div class="category"></div><div class="category"><h2>Application Integration</h2><h3>Classes</h3><ul><li><a href="EventManager.html">EventManager</a></li><li><a href="SnsManager.html">SnsManager</a></li></ul><h3>Interfaces</h3><ul><li><a href="EventBusProps.html">EventBusProps</a></li><li><a href="EventRuleProps.html">EventRuleProps</a></li><li><a href="RuleProps.html">RuleProps</a></li><li><a href="SubscriptionProps.html">SubscriptionProps</a></li></ul></div><div class="category"><h2>Compute</h2><h3>Classes</h3><ul><li><a href="LambdaManager.html">LambdaManager</a></li></ul><h3>Interfaces</h3><ul><li><a href="HealthCheck.html">HealthCheck</a></li><li><a href="LambdaEdgeProps.html">LambdaEdgeProps</a></li><li><a href="LambdaProps.html">LambdaProps</a></li></ul></div><div class="category"><h2>Constructs</h2><h3>Classes</h3><ul><li><a href="ApiDestinationEvent.html">ApiDestinationEvent</a></li><li><a href="ApiDestinedLambda.html">ApiDestinedLambda</a></li><li><a href="ApiDestinedRestApi.html">ApiDestinedRestApi</a></li><li><a href="ApiToEventBridgeTarget.html">ApiToEventBridgeTarget</a></li><li><a href="CommonConstruct.html">CommonConstruct</a></li><li><a href="GraphQLApiLambda.html">GraphQLApiLambda</a></li><li><a href="SiteWithEcsBackend.html">SiteWithEcsBackend</a></li><li><a href="StaticSite.html">StaticSite</a></li></ul><h3>Interfaces</h3><ul><li><a href="ApiDestinationEventType.html">ApiDestinationEventType</a></li><li><a href="ApiDestinedLambdaEnvironment.html">ApiDestinedLambdaEnvironment</a></li><li><a href="ApiDestinedLambdaType.html">ApiDestinedLambdaType</a></li><li><a href="ApiDestinedRestApiType.html">ApiDestinedRestApiType</a></li><li><a href="ApiToEventBridgeTargetEventProps.html">ApiToEventBridgeTargetEventProps</a></li><li><a href="ApiToEventBridgeTargetLambdaProps.html">ApiToEventBridgeTargetLambdaProps</a></li><li><a href="ApiToEventBridgeTargetProps.html">ApiToEventBridgeTargetProps</a></li><li><a href="CommonStackProps.html">CommonStackProps</a></li><li><a href="GraphQlApiLambdaEnvironment.html">GraphQlApiLambdaEnvironment</a></li><li><a href="GraphQlApiLambdaProps.html">GraphQlApiLambdaProps</a></li><li><a href="LambdaEnvironment.html">LambdaEnvironment</a></li><li><a href="SiteWithEcsBackendProps.html">SiteWithEcsBackendProps</a></li><li><a href="StaticSiteProps.html">StaticSiteProps</a></li></ul></div><div class="category"><h2>Containers</h2><h3>Classes</h3><ul><li><a href="EcrManager.html">EcrManager</a></li><li><a href="EcsManager.html">EcsManager</a></li><li><a href="EksManager.html">EksManager</a></li></ul><h3>Interfaces</h3><ul><li><a href="EcsClusterProps.html">EcsClusterProps</a></li><li><a href="EcsTaskProps.html">EcsTaskProps</a></li><li><a href="EksClusterProps.html">EksClusterProps</a></li></ul></div><div class="category"><h2>Developer Tools</h2><h3>Classes</h3><ul><li><a href="CodeBuildManager.html">CodeBuildManager</a></li></ul></div><div class="category"><h2>Management & Governance</h2><h3>Classes</h3><ul><li><a href="AppConfigManager.html">AppConfigManager</a></li><li><a href="CloudTrailManager.html">CloudTrailManager</a></li><li><a href="CloudWatchManager.html">CloudWatchManager</a></li><li><a href="LogManager.html">LogManager</a></li><li><a href="SsmManager.html">SsmManager</a></li><li><a href="SSMParameterReader.html">SSMParameterReader</a></li></ul><h3>Interfaces</h3><ul><li><a href="AlarmProps.html">AlarmProps</a></li><li><a href="AlarmStatusWidgetProps.html">AlarmStatusWidgetProps</a></li><li><a href="AppConfigProps.html">AppConfigProps</a></li><li><a href="CloudTrailProps.html">CloudTrailProps</a></li><li><a href="DashboardProps.html">DashboardProps</a></li><li><a href="GraphWidgetProps.html">GraphWidgetProps</a></li><li><a href="LogProps.html">LogProps</a></li><li><a href="LogQueryWidgetProps.html">LogQueryWidgetProps</a></li><li><a href="MetricFilterProps.html">MetricFilterProps</a></li><li><a href="MetricProps.html">MetricProps</a></li><li><a href="NumericWidgetProps.html">NumericWidgetProps</a></li><li><a href="SSMParameterReaderProps.html">SSMParameterReaderProps</a></li><li><a href="TextWidgetProps.html">TextWidgetProps</a></li></ul></div><div class="category"><h2>Networking & Content Delivery</h2><h3>Classes</h3><ul><li><a href="ApiManager.html">ApiManager</a></li><li><a href="CloudFrontManager.html">CloudFrontManager</a></li><li><a href="Route53Manager.html">Route53Manager</a></li><li><a href="VpcManager.html">VpcManager</a></li></ul><h3>Interfaces</h3><ul><li><a href="CloudfrontFunctionProps.html">CloudfrontFunctionProps</a></li><li><a href="CloudFrontProps.html">CloudFrontProps</a></li><li><a href="DistributionProps.html">DistributionProps</a></li><li><a href="Route53Props.html">Route53Props</a></li></ul></div><div class="category"><h2>Security, Identity & Compliance</h2><h3>Classes</h3><ul><li><a href="AcmManager.html">AcmManager</a></li><li><a href="IamManager.html">IamManager</a></li><li><a href="SecretsManager.html">SecretsManager</a></li><li><a href="WafManager.html">WafManager</a></li></ul><h3>Interfaces</h3><ul><li><a href="AcmProps.html">AcmProps</a></li><li><a href="WafIPSetProps.html">WafIPSetProps</a></li><li><a href="WafWebACLProps.html">WafWebACLProps</a></li></ul></div><div class="category"><h2>Stacks</h2><h3>Classes</h3><ul><li><a href="CommonStack.html">CommonStack</a></li></ul></div><div class="category"><h2>Storage</h2><h3>Classes</h3><ul><li><a href="DynamodbManager.html">DynamodbManager</a></li><li><a href="S3Manager.html">S3Manager</a></li></ul><h3>Interfaces</h3><ul><li><a href="S3BucketProps.html">S3BucketProps</a></li><li><a href="TableProps.html">TableProps</a></li></ul></div><div class="category"><h2>Utils</h2><h3>Global</h3><ul><li><a href="global.html#ArnsByRegion">ArnsByRegion</a></li><li><a href="global.html#CloudWatchWidgetType">CloudWatchWidgetType</a></li><li><a href="global.html#CommonVpcIdentifier">CommonVpcIdentifier</a></li><li><a href="global.html#createCfnOutput">createCfnOutput</a></li><li><a href="global.html#defaultResponseObject">defaultResponseObject</a></li><li><a href="global.html#isDevStage">isDevStage</a></li><li><a href="global.html#isPrdStage">isPrdStage</a></li><li><a href="global.html#isTestStage">isTestStage</a></li><li><a href="global.html#isUatStage">isUatStage</a></li><li><a href="global.html#redirectError">redirectError</a></li><li><a href="global.html#redirectSuccess">redirectSuccess</a></li></ul></div><div class="category"><h2>Utils
-LogLevel enumeration</h2><h3>Global</h3><ul><li><a href="global.html#LogLevel">LogLevel</a></li></ul></div>
-            </nav>
-        </div>
-        <div class="core" id="main-content-wrapper">
-            <div class="content">
-                <header class="page-title">
-                    <p>Class</p>
-                    <h1>CommonConstruct</h1>
-                </header>
-<section>
-<header>
-        <h2><span class="attribs"><span class="type-signature"></span></span>CommonConstruct<span class="signature">()</span><span class="type-signature"></span></h2>
-            <div class="class-description"><p>Common construct to use as a base for all higher level constructs.</p></div>
-</header>
-<article>
-    <div class="container-overview">
-            <div class='vertical-section'>
-                <div class="members">
-                    <div class="member">
-                        <div class=name>
-                            <span class="tag">Constructor</span>
-                        </div>
-    <h4 class="name" id="CommonConstruct">
-        <a class="href-link" href="#CommonConstruct">#</a>
-        <span class="code-name">
-                new CommonConstruct<span class="signature">()</span><span class="type-signature"></span>
-        </span>
-    </h4>
-    <div class="description">
-        <script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>
-    </div>
-<dl class="details">
-        <p class="tag-source">
-            <a href="common_construct.ts.html" class="button">View Source</a>
-            <span>
-                <a href="common_construct.ts.html">common/construct.ts</a>, <a href="common_construct.ts.html#line20">line 20</a>
-            </span>
-        </p>
-</dl>
-    <h5>Example</h5>
-        <pre class="prettyprint"><code>import { CommonConstruct } from '@gradientedge/cdk-utils';
-class CustomConstruct extends CommonConstruct {
-  constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
-    super(parent, id, props);
-    this.props = props;
-  };
-};</code></pre>
-                    </div>
-                </div>
-            </div>
-    </div>
-        <h3 class="subsection-title">Classes</h3>
-        <dl>
-            <dt><a href="CommonConstruct.html">CommonConstruct</a></dt>
-            <dd></dd>
-        </dl>
-        <div class='vertical-section'>
-            <h1>Members</h1>
-            <div class="members">
-                <div class="member">
-<h4 class="name" id="isDevelopmentStage">
-    <a class="href-link" href="#isDevelopmentStage">#</a>
-    <span class="code-name">
-        isDevelopmentStage
-    </span>
-</h4>
-<p class="summary"><p>Utility method to determine if the initialisation is in development (dev) stage
-This is determined by the stage property injected via cdk context</p></p>
-<div class="description">
-    <script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>
-</div>
-<dl class="details">
-        <p class="tag-source">
-            <a href="common_construct.ts.html" class="button">View Source</a>
-            <span>
-                <a href="common_construct.ts.html">common/construct.ts</a>, <a href="common_construct.ts.html#line94">line 94</a>
-            </span>
-        </p>
-</dl>
-</div>
-                <div class="member">
-<h4 class="name" id="isDevelopmentStage">
-    <a class="href-link" href="#isDevelopmentStage">#</a>
-    <span class="code-name">
-        isDevelopmentStage
-    </span>
-</h4>
-<p class="summary"><p>Utility method to determine if the initialisation is in development (dev) stage
-This is determined by the stage property injected via cdk context</p></p>
-<div class="description">
-    <script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>
-</div>
-<dl class="details">
-        <p class="tag-source">
-            <a href="common_construct.ts.html" class="button">View Source</a>
-            <span>
-                <a href="common_construct.ts.html">common/construct.ts</a>, <a href="common_construct.ts.html#line140">line 140</a>
-            </span>
-        </p>
-</dl>
-</div>
-                <div class="member">
-<h4 class="name" id="isProductionStage">
-    <a class="href-link" href="#isProductionStage">#</a>
-    <span class="code-name">
-        isProductionStage
-    </span>
-</h4>
-<p class="summary"><p>Utility method to determine if the initialisation is in production (prd) stage
-This is determined by the stage property injected via cdk context</p></p>
-<div class="description">
-    <script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>
-</div>
-<dl class="details">
-        <p class="tag-source">
-            <a href="common_construct.ts.html" class="button">View Source</a>
-            <span>
-                <a href="common_construct.ts.html">common/construct.ts</a>, <a href="common_construct.ts.html#line109">line 109</a>
-            </span>
-        </p>
-</dl>
-</div>
-                <div class="member">
-<h4 class="name" id="isProductionStage">
-    <a class="href-link" href="#isProductionStage">#</a>
-    <span class="code-name">
-        isProductionStage
-    </span>
-</h4>
-<p class="summary"><p>Utility method to determine if the initialisation is in production (prd) stage
-This is determined by the stage property injected via cdk context</p></p>
-<div class="description">
-    <script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>
-</div>
-<dl class="details">
-        <p class="tag-source">
-            <a href="common_construct.ts.html" class="button">View Source</a>
-            <span>
-                <a href="common_construct.ts.html">common/construct.ts</a>, <a href="common_construct.ts.html#line158">line 158</a>
-            </span>
-        </p>
-</dl>
-</div>
-                <div class="member">
-<h4 class="name" id="isTestStage">
-    <a class="href-link" href="#isTestStage">#</a>
-    <span class="code-name">
-        isTestStage
-    </span>
-</h4>
-<p class="summary"><p>Utility method to determine if the initialisation is in test (tst) stage
-This is determined by the stage property injected via cdk context</p></p>
-<div class="description">
-    <script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>
-</div>
-<dl class="details">
-        <p class="tag-source">
-            <a href="common_construct.ts.html" class="button">View Source</a>
-            <span>
-                <a href="common_construct.ts.html">common/construct.ts</a>, <a href="common_construct.ts.html#line99">line 99</a>
-            </span>
-        </p>
-</dl>
-</div>
-                <div class="member">
-<h4 class="name" id="isTestStage">
-    <a class="href-link" href="#isTestStage">#</a>
-    <span class="code-name">
-        isTestStage
-    </span>
-</h4>
-<p class="summary"><p>Utility method to determine if the initialisation is in test (tst) stage
-This is determined by the stage property injected via cdk context</p></p>
-<div class="description">
-    <script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>
-</div>
-<dl class="details">
-        <p class="tag-source">
-            <a href="common_construct.ts.html" class="button">View Source</a>
-            <span>
-                <a href="common_construct.ts.html">common/construct.ts</a>, <a href="common_construct.ts.html#line146">line 146</a>
-            </span>
-        </p>
-</dl>
-</div>
-                <div class="member">
-<h4 class="name" id="isUatStage">
-    <a class="href-link" href="#isUatStage">#</a>
-    <span class="code-name">
-        isUatStage
-    </span>
-</h4>
-<p class="summary"><p>Utility method to determine if the initialisation is in uat (uat) stage
-This is determined by the stage property injected via cdk context</p></p>
-<div class="description">
-    <script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>
-</div>
-<dl class="details">
-        <p class="tag-source">
-            <a href="common_construct.ts.html" class="button">View Source</a>
-            <span>
-                <a href="common_construct.ts.html">common/construct.ts</a>, <a href="common_construct.ts.html#line104">line 104</a>
-            </span>
-        </p>
-</dl>
-</div>
-                <div class="member">
-<h4 class="name" id="isUatStage">
-    <a class="href-link" href="#isUatStage">#</a>
-    <span class="code-name">
-        isUatStage
-    </span>
-</h4>
-<p class="summary"><p>Utility method to determine if the initialisation is in uat (uat) stage
-This is determined by the stage property injected via cdk context</p></p>
-<div class="description">
-    <script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>
-</div>
-<dl class="details">
-        <p class="tag-source">
-            <a href="common_construct.ts.html" class="button">View Source</a>
-            <span>
-                <a href="common_construct.ts.html">common/construct.ts</a>, <a href="common_construct.ts.html#line152">line 152</a>
-            </span>
-        </p>
-</dl>
-</div>
-            </div>
-        </div>
-        <div class='vertical-section'>
-            <h1>Methods</h1>
-            <div class="members">
-                <div class="member">
-    <h4 class="name" id="addCfnOutput">
-        <a class="href-link" href="#addCfnOutput">#</a>
-                <span class='tag'>protected</span>
-        <span class="code-name">
-                addCfnOutput<span class="signature">(id, value, description<span class="signature-attributes">nullable</span>, overrideId)</span><span class="type-signature"> &rarr; {cdk.CfnOutput}</span>
-        </span>
-    </h4>
-    <p class="summary"><p>Helper method to add CloudFormation outputs from the construct</p></p>
-    <div class="description">
-        <script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>
-    </div>
-    <h5>Parameters:</h5>
-<div class="table-container">
-    <table class="params table">
-        <thead>
-        <tr>
-            <th>Name</th>
-            <th>Type</th>
-            <th>Attributes</th>
-            <th class="last">Description</th>
-        </tr>
-        </thead>
-        <tbody>
-<tr class="deep-level-0">
-      <td class="name"><code>id</code></td>
-  <td class="type">
-<code class="param-type">string</code>
-  </td>
-      <td class="attributes">
-      </td>
-  <td class="description last"><p>scoped id of the resource</p></td>
-</tr>
-<tr class="deep-level-0">
-      <td class="name"><code>value</code></td>
-  <td class="type">
-<code class="param-type">string</code>
-  </td>
-      <td class="attributes">
-      </td>
-  <td class="description last"><p>the value of the exported output</p></td>
-</tr>
-<tr class="deep-level-0">
-      <td class="name"><code>description</code></td>
-  <td class="type">
-<code class="param-type">string</code>
-  </td>
-      <td class="attributes">
-          &lt;nullable><br>
-      </td>
-  <td class="description last"><p>optional description for the output</p></td>
-</tr>
-<tr class="deep-level-0">
-      <td class="name"><code>overrideId</code></td>
-  <td class="type">
-<code class="param-type">boolean</code>
-  </td>
-      <td class="attributes">
-      </td>
-  <td class="description last"><p>Flag which indicates whether to override the default logical id of the output</p></td>
-</tr>
-        </tbody>
-    </table>
-</div>
-<dl class="details">
-        <p class="tag-source">
-            <a href="common_construct.ts.html" class="button">View Source</a>
-            <span>
-                <a href="common_construct.ts.html">common/construct.ts</a>, <a href="common_construct.ts.html#line128">line 128</a>
-            </span>
-        </p>
-</dl>
-    <div class='columns method-parameter'>
-        <div class="column is-2"><label>Returns:</label></div>
-        <div class="column is-10">
-<div class="columns">
-    <div class='column is-5 has-text-left'>
-        <label>Type: </label>
-<code class="param-type">cdk.CfnOutput</code>
-    </div>
-</div>
-        </div>
-    </div>
-</div>
-                <div class="member">
-    <h4 class="name" id="determineFullyQualifiedDomain">
-        <a class="href-link" href="#determineFullyQualifiedDomain">#</a>
-                <span class='tag'>protected</span>
-        <span class="code-name">
-                determineFullyQualifiedDomain<span class="signature">()</span><span class="type-signature"></span>
-        </span>
-    </h4>
-    <p class="summary"><p>Determine the fully qualified domain name based on domainName &amp; subDomain</p></p>
-    <div class="description">
-        <script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>
-    </div>
-<dl class="details">
-        <p class="tag-source">
-            <a href="common_construct.ts.html" class="button">View Source</a>
-            <span>
-                <a href="common_construct.ts.html">common/construct.ts</a>, <a href="common_construct.ts.html#line134">line 134</a>
-            </span>
-        </p>
-</dl>
-</div>
-            </div>
-        </div>
-</article>
-</section>
-            </div>
-        </div>
-        <div id="side-nav" class="side-nav">
-        </div>
-    </div>
-<script src="scripts/app.min.js"></script>
-<script>PR.prettyPrint();</script>
-<script src="scripts/linenumber.js"> </script>
-<script src="scripts/search.js"> </script>
-</body>
-</html>