npm - @gradientedge/cdk-utils - Versions diffs - 4.4.2 → 4.4.6 - Mend

@gradientedge/cdk-utils 4.4.2 → 4.4.6

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 (449) hide show

package/api-docs/VpcManager.html DELETED Viewed

@@ -1,986 +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 VpcManager</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="styles.css">
-  <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 class="image" href="index.html">
-                    <img src="logo.png" alt="logo">
-                </a>
-                <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>cdk-utils.acm-manager</h2><h3>Classes / Construct</h3><ul><li><a href="AcmManager.html">AcmManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="AcmProps.html">AcmProps</a></li></ul></div><div class="category"><h2>cdk-utils.api-manager</h2><h3>Classes / Construct</h3><ul><li><a href="ApiManager.html">ApiManager</a></li></ul></div><div class="category"><h2>cdk-utils.api-to-eventbridge-target</h2><h3>Classes / member</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></ul><h3>Classes / construct</h3><ul><li><a href="ApiToEventBridgeTarget.html">ApiToEventBridgeTarget</a></li></ul><h3>Interfaces / Types</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></ul><h3>Interfaces / Properties</h3><ul><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="ApiToEventBridgeTargetRestApiProps.html">ApiToEventBridgeTargetRestApiProps</a></li></ul></div><div class="category"><h2>cdk-utils.app-config-manager</h2><h3>Classes / Construct</h3><ul><li><a href="AppConfigManager.html">AppConfigManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="AppConfigProps.html">AppConfigProps</a></li></ul><h3>Global</h3><ul><li><a href="global.html#ArnsByRegion">ArnsByRegion</a></li></ul></div><div class="category"><h2>cdk-utils.cloudfront-manager</h2><h3>Classes / Construct</h3><ul><li><a href="CloudFrontManager.html">CloudFrontManager</a></li></ul><h3>Interfaces / Properties</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></ul></div><div class="category"><h2>cdk-utils.cloudtrail-manager</h2><h3>Classes / Construct</h3><ul><li><a href="CloudTrailManager.html">CloudTrailManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="CloudTrailProps.html">CloudTrailProps</a></li></ul></div><div class="category"><h2>cdk-utils.cloudwatch-manager</h2><h3>Classes / Construct</h3><ul><li><a href="CloudWatchManager.html">CloudWatchManager</a></li><li><a href="LogManager.html">LogManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="AlarmProps.html">AlarmProps</a></li><li><a href="AlarmStatusWidgetProps.html">AlarmStatusWidgetProps</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="TextWidgetProps.html">TextWidgetProps</a></li></ul><h3>Global</h3><ul><li><a href="global.html#CloudWatchWidgetType">CloudWatchWidgetType</a></li></ul></div><div class="category"><h2>cdk-utils.codebuild-manager</h2><h3>Classes / Construct</h3><ul><li><a href="CodeBuildManager.html">CodeBuildManager</a></li></ul></div><div class="category"><h2>cdk-utils.common-construct</h2><h3>Classes / Construct</h3><ul><li><a href="CommonConstruct.html">CommonConstruct</a></li></ul></div><div class="category"><h2>cdk-utils.common-stack</h2><h3>Classes / Construct</h3><ul><li><a href="CommonStack.html">CommonStack</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="CommonStackProps.html">CommonStackProps</a></li></ul></div><div class="category"><h2>cdk-utils.dynamodb-manager</h2><h3>Classes / Construct</h3><ul><li><a href="DynamodbManager.html">DynamodbManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="TableProps.html">TableProps</a></li></ul></div><div class="category"><h2>cdk-utils.ecr-manager</h2><h3>Classes / Construct</h3><ul><li><a href="EcrManager.html">EcrManager</a></li></ul></div><div class="category"><h2>cdk-utils.ecs-manager</h2><h3>Classes / Construct</h3><ul><li><a href="EcsManager.html">EcsManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="EcsClusterProps.html">EcsClusterProps</a></li><li><a href="EcsTaskProps.html">EcsTaskProps</a></li></ul></div><div class="category"><h2>cdk-utils.eks-manager</h2><h3>Classes / Construct</h3><ul><li><a href="EksManager.html">EksManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="EksClusterProps.html">EksClusterProps</a></li></ul></div><div class="category"><h2>cdk-utils.event-manager</h2><h3>Classes / Construct</h3><ul><li><a href="EventManager.html">EventManager</a></li></ul><h3>Interfaces / Properties</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></ul></div><div class="category"><h2>cdk-utils.graphql-api-lambda</h2><h3>Classes / construct</h3><ul><li><a href="GraphQLApiLambda.html">GraphQLApiLambda</a></li></ul><h3>Interfaces / Types</h3><ul><li><a href="GraphQlApiLambdaEnvironment.html">GraphQlApiLambdaEnvironment</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="GraphQlApiLambdaProps.html">GraphQlApiLambdaProps</a></li></ul></div><div class="category"><h2>cdk-utils.iam-manager</h2><h3>Classes / Construct</h3><ul><li><a href="IamManager.html">IamManager</a></li></ul></div><div class="category"><h2>cdk-utils.lambda-manager</h2><h3>Classes / Construct</h3><ul><li><a href="LambdaManager.html">LambdaManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="LambdaEdgeProps.html">LambdaEdgeProps</a></li><li><a href="LambdaProps.html">LambdaProps</a></li></ul><h3>Interfaces / Types</h3><ul><li><a href="LambdaEnvironment.html">LambdaEnvironment</a></li></ul></div><div class="category"><h2>cdk-utils.route53-manager</h2><h3>Classes / Construct</h3><ul><li><a href="Route53Manager.html">Route53Manager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="Route53Props.html">Route53Props</a></li></ul></div><div class="category"><h2>cdk-utils.s3-manager</h2><h3>Classes / Construct</h3><ul><li><a href="S3Manager.html">S3Manager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="LifecycleRule.html">LifecycleRule</a></li><li><a href="S3BucketProps.html">S3BucketProps</a></li></ul></div><div class="category"><h2>cdk-utils.secrets-manager</h2><h3>Classes / Construct</h3><ul><li><a href="SecretsManager.html">SecretsManager</a></li></ul></div><div class="category"><h2>cdk-utils.site-with-ecs-backend</h2><h3>Classes / construct</h3><ul><li><a href="SiteWithEcsBackend.html">SiteWithEcsBackend</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="HealthCheck.html">HealthCheck</a></li><li><a href="SiteWithEcsBackendProps.html">SiteWithEcsBackendProps</a></li></ul></div><div class="category"><h2>cdk-utils.sns-manager</h2><h3>Classes / Construct</h3><ul><li><a href="SnsManager.html">SnsManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="SubscriptionProps.html">SubscriptionProps</a></li></ul></div><div class="category"><h2>cdk-utils.ssm-manager</h2><h3>Classes / Construct</h3><ul><li><a href="SsmManager.html">SsmManager</a></li><li><a href="SSMParameterReader.html">SSMParameterReader</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="SSMParameterReaderProps.html">SSMParameterReaderProps</a></li></ul></div><div class="category"><h2>cdk-utils.static-site</h2><h3>Classes / construct</h3><ul><li><a href="StaticSite.html">StaticSite</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="StaticSiteProps.html">StaticSiteProps</a></li></ul></div><div class="category"><h2>cdk-utils.utils</h2><h3>Global</h3><ul><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#LogLevel">LogLevel</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>cdk-utils.vpc-manager</h2><h3>Classes / Construct</h3><ul><li><a href="VpcManager.html">VpcManager</a></li></ul><h3>Global</h3><ul><li><a href="global.html#CommonVpcIdentifier">CommonVpcIdentifier</a></li></ul></div><div class="category"><h2>cdk-utils.waf-manager</h2><h3>Classes / Construct</h3><ul><li><a href="WafManager.html">WafManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="WafIPSetProps.html">WafIPSetProps</a></li><li><a href="WafWebACLProps.html">WafWebACLProps</a></li></ul></div>
-            </nav>
-        </div>
-        <div class="core" id="main-content-wrapper">
-            <div class="content">
-                <header class="page-title">
-                    <p>Class</p>
-                    <h1>VpcManager</h1>
-                </header>
-<section>
-<header>
-        <h2><span class="attribs"><span class="type-signature"></span></span>VpcManager<span class="signature">()</span><span class="type-signature"></span></h2>
-            <div class="class-description"><p>Provides operations on AWS VPC.</p>
-<ul>
-<li>A new instance of this class is injected into common.CommonConstruct constructor.</li>
-<li>If a custom construct extends common.CommonConstruct, an instance is available within the context.</li>
-</ul></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="VpcManager">
-        <a class="href-link" href="#VpcManager">#</a>
-        <span class="code-name">
-                new VpcManager<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">
-    <dt class="tag-see">See:</dt>
-    <dd class="tag-see">
-        <ul>
-            <li><p><a href="https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.@aws-cdk_aws-ec2.Vpc.html">CDK VPC Module</a></p></li>
-        </ul>
-    </dd>
-        <p class="tag-source">
-            <a href="manager_aws_vpc-manager.ts.html" class="button">View Source</a>
-            <span>
-                <a href="manager_aws_vpc-manager.ts.html">manager/aws/vpc-manager.ts</a>, <a href="manager_aws_vpc-manager.ts.html#line30">line 30</a>
-            </span>
-        </p>
-</dl>
-    <h5>Example</h5>
-        <pre class="prettyprint"><code>import * as common from '@gradientedge/cdk-utils'
-class CustomConstruct extends common.common.CommonConstruct {
-  constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
-    super(parent, id, props)
-    this.props = props
-    this.vpcManager.createVpc('MyVPC', this)
-  }
-}</code></pre>
-                    </div>
-                </div>
-            </div>
-    </div>
-        <div class='vertical-section'>
-            <h1>Methods</h1>
-            <div class="members">
-                <div class="member">
-    <h4 class="name" id="createCommonVpc">
-        <a class="href-link" href="#createCommonVpc">#</a>
-        <span class="code-name">
-                createCommonVpc<span class="signature">(scope, props, vpcIdentifier<span class="signature-attributes">nullable</span>)</span><span class="type-signature"></span>
-        </span>
-    </h4>
-    <p class="summary"><p>Method to create a common vpc</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>scope</code></td>
-  <td class="type">
-<code class="param-type">common.CommonConstruct</code>
-  </td>
-      <td class="attributes">
-      </td>
-  <td class="description last"><p>scope in which this resource is defined</p></td>
-</tr>
-<tr class="deep-level-0">
-      <td class="name"><code>props</code></td>
-  <td class="type">
-<code class="param-type">ec2.VpcProps</code>
-  </td>
-      <td class="attributes">
-      </td>
-  <td class="description last"></td>
-</tr>
-<tr class="deep-level-0">
-      <td class="name"><code>vpcIdentifier</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 identifier for VPC</p></td>
-</tr>
-        </tbody>
-    </table>
-</div>
-<dl class="details">
-        <p class="tag-source">
-            <a href="manager_aws_vpc-manager.ts.html" class="button">View Source</a>
-            <span>
-                <a href="manager_aws_vpc-manager.ts.html">manager/aws/vpc-manager.ts</a>, <a href="manager_aws_vpc-manager.ts.html#line97">line 97</a>
-            </span>
-        </p>
-</dl>
-</div>
-                <div class="member">
-    <h4 class="name" id="createVpc">
-        <a class="href-link" href="#createVpc">#</a>
-        <span class="code-name">
-                createVpc<span class="signature">(id, scope, props)</span><span class="type-signature"></span>
-        </span>
-    </h4>
-    <p class="summary"><p>Method to create a new vpc</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 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="description last"><p>scoped id of the resource</p></td>
-</tr>
-<tr class="deep-level-0">
-      <td class="name"><code>scope</code></td>
-  <td class="type">
-<code class="param-type">common.CommonConstruct</code>
-  </td>
-  <td class="description last"><p>scope in which this resource is defined</p></td>
-</tr>
-<tr class="deep-level-0">
-      <td class="name"><code>props</code></td>
-  <td class="type">
-<code class="param-type">ec2.VpcProps</code>
-  </td>
-  <td class="description last"></td>
-</tr>
-        </tbody>
-    </table>
-</div>
-<dl class="details">
-        <p class="tag-source">
-            <a href="manager_aws_vpc-manager.ts.html" class="button">View Source</a>
-            <span>
-                <a href="manager_aws_vpc-manager.ts.html">manager/aws/vpc-manager.ts</a>, <a href="manager_aws_vpc-manager.ts.html#line88">line 88</a>
-            </span>
-        </p>
-</dl>
-</div>
-                <div class="member">
-    <h4 class="name" id="retrieveCommonVpc">
-        <a class="href-link" href="#retrieveCommonVpc">#</a>
-        <span class="code-name">
-                retrieveCommonVpc<span class="signature">(id, scope, vpcIdentifier<span class="signature-attributes">nullable</span>)</span><span class="type-signature"></span>
-        </span>
-    </h4>
-    <p class="summary"><p>Method to retrieve a common vpc</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>scope</code></td>
-  <td class="type">
-<code class="param-type">common.CommonConstruct</code>
-  </td>
-      <td class="attributes">
-      </td>
-  <td class="description last"><p>scope in which this resource is defined</p></td>
-</tr>
-<tr class="deep-level-0">
-      <td class="name"><code>vpcIdentifier</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 identifier for VPC</p></td>
-</tr>
-        </tbody>
-    </table>
-</div>
-<dl class="details">
-        <p class="tag-source">
-            <a href="manager_aws_vpc-manager.ts.html" class="button">View Source</a>
-            <span>
-                <a href="manager_aws_vpc-manager.ts.html">manager/aws/vpc-manager.ts</a>, <a href="manager_aws_vpc-manager.ts.html#line106">line 106</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>