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/construct_static-site_main.ts.html DELETED Viewed

@@ -1,370 +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 construct/static-site/main.ts</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>Source</p>
-                    <h1>construct/static-site/main.ts</h1>
-                </header>
-    <section>
-        <article>
-            <pre class="prettyprint source linenums"><code>import * as certificateManager from 'aws-cdk-lib/aws-certificatemanager'
-import * as cloudfront from 'aws-cdk-lib/aws-cloudfront'
-import * as origins from 'aws-cdk-lib/aws-cloudfront-origins'
-import * as route53 from 'aws-cdk-lib/aws-route53'
-import * as s3 from 'aws-cdk-lib/aws-s3'
-import { Construct } from 'constructs'
-import { CommonConstruct } from '../../common'
-import { StaticSiteProps } from '../../types'
-/**
- * @stability stable
- * @category Constructs
- * @classdesc Provides a construct to create and deploy a s3 hosted static site
- *
- * @example
- * import { StaticSite, StaticSiteProps } '@gradientedge/cdk-utils'
- * import { Construct } from 'constructs'
- *
- * class CustomConstruct extends StaticSite {
- *   constructor(parent: Construct, id: string, props: StaticSiteProps) {
- *     super(parent, id, props)
- *     this.props = props
- *     this.id = id
- *     this.initResources()
- *   }
- * }
- */
-export class StaticSite extends CommonConstruct {
-  /* static site properties */
-  props: StaticSiteProps
-  id: string
-  /* static site resources */
-  siteHostedZone: route53.IHostedZone
-  siteCertificate: certificateManager.ICertificate
-  siteARecord: route53.ARecord
-  siteARecordAlt: route53.ARecord
-  siteBucket: s3.IBucket
-  siteOrigin: origins.S3Origin
-  siteDistribution: cloudfront.Distribution
-  siteLogBucket: s3.IBucket
-  siteOriginAccessIdentity: cloudfront.OriginAccessIdentity
-  siteCloudfrontFunction: cloudfront.Function
-  siteFunctionAssociations: cloudfront.FunctionAssociation[]
-  constructor(parent: Construct, id: string, props: StaticSiteProps) {
-    super(parent, id, props)
-    this.props = props
-    this.id = id
-  }
-  /**
-   * @summary Initialise and provision resources
-   * @protected
-   */
-  protected initResources() {
-    this.resolveHostedZone()
-    this.resolveCertificate()
-    this.createSiteLogBucket()
-    this.createSiteBucket()
-    this.createSiteOrigin()
-    this.createSiteCloudfrontFunction()
-    this.resolveSiteFunctionAssociations()
-    this.createSiteDistribution()
-    this.createSiteRouteAssets()
-    this.deploySite()
-  }
-  /**
-   * @summary Method to resolve a hosted zone based on domain attributes
-   * @protected
-   */
-  protected resolveHostedZone() {
-    this.siteHostedZone = this.route53Manager.withHostedZoneFromFullyQualifiedDomainName(
-      `${this.id}-hosted-zone`,
-      this,
-      this.props.useExistingHostedZone
-    )
-  }
-  /**
-   * @summary Method to resolve a certificate based on attributes
-   * @protected
-   */
-  protected resolveCertificate() {
-    if (
-      this.props.siteCertificate.useExistingCertificate &amp;&amp;
-      this.props.siteCertificate.certificateSsmName &amp;&amp;
-      this.props.siteCertificate.certificateRegion
-    ) {
-      this.props.siteCertificate.certificateArn = this.ssMManager.readStringParameterFromRegion(
-        `${this.id}-certificate-param`,
-        this,
-        this.props.siteCertificate.certificateSsmName,
-        this.props.siteCertificate.certificateRegion
-      )
-    }
-    this.siteCertificate = this.acmManager.resolveCertificate(
-      `${this.id}-certificate`,
-      this,
-      this.props.siteCertificate
-    )
-  }
-  /**
-   * @summary Method to create a site log bucket
-   * @protected
-   */
-  protected createSiteLogBucket() {
-    this.siteLogBucket = this.s3Manager.createS3Bucket(`${this.id}-site-logs`, this, this.props.siteLogBucket)
-  }
-  /**
-   * @summary Method to create a site bucket
-   * @protected
-   */
-  protected createSiteBucket() {
-    this.siteBucket = this.s3Manager.createS3Bucket(`${this.id}-site`, this, this.props.siteBucket)
-  }
-  protected createSiteOrigin() {
-    this.siteOrigin = new origins.S3Origin(this.siteBucket)
-  }
-  /**
-   * @summary Method to create a site cloudfront function
-   * @protected
-   */
-  protected createSiteCloudfrontFunction() {
-    if (this.props.siteCloudfrontFunctionProps) {
-      this.siteCloudfrontFunction = this.cloudFrontManager.createCloudfrontFunction(
-        `${this.id}-function`,
-        this,
-        this.props.siteCloudfrontFunctionProps
-      )
-    }
-  }
-  /**
-   * @summary Method to create a site cloudfront function associations
-   * @protected
-   */
-  protected resolveSiteFunctionAssociations() {
-    if (this.props.siteCloudfrontFunctionProps) {
-      this.siteFunctionAssociations = [
-        {
-          function: this.siteCloudfrontFunction,
-          eventType: cloudfront.FunctionEventType.VIEWER_REQUEST,
-        },
-      ]
-    }
-  }
-  /**
-   * @summary Method to create a site cloudfront distribution
-   * @protected
-   */
-  protected createSiteDistribution() {
-    if (!this.props.siteDistribution) throw 'SiteDistribution props undefined'
-    this.siteDistribution = this.cloudFrontManager.createDistributionWithS3Origin(
-      `${this.id}-distribution`,
-      this,
-      this.props.siteDistribution,
-      this.siteOrigin,
-      this.siteBucket,
-      this.siteLogBucket,
-      this.siteOriginAccessIdentity,
-      this.siteCertificate,
-      this.props.siteAliases,
-      this.siteFunctionAssociations
-    )
-  }
-  /**
-   * @summary Method to create route53 records for static site
-   * @protected
-   */
-  protected createSiteRouteAssets() {
-    this.siteARecord = this.route53Manager.createCloudFrontTargetARecord(
-      `${this.id}-domain-a-record`,
-      this,
-      this.siteDistribution,
-      this.siteHostedZone,
-      this.props.siteRecordName
-    )
-    if (!this.isProductionStage() &amp;&amp; this.props.siteCreateAltARecord) {
-      this.siteARecordAlt = this.route53Manager.createCloudFrontTargetARecordV2(
-        `${this.id}-domain-a-record-alt`,
-        this,
-        this.siteDistribution,
-        this.siteHostedZone,
-        this.props.siteRecordName
-      )
-    }
-  }
-  /**
-   * @summary Method to deploy the static assets into s3 bucket for static site
-   * @protected
-   */
-  protected deploySite() {
-    this.s3Manager.doBucketDeployment(
-      `${this.id}-deployment`,
-      this,
-      this.siteBucket,
-      this.siteDistribution,
-      [this.props.siteSource],
-      '',
-      true
-    )
-  }
-}
-</code></pre>
-        </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>