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

@gradientedge/cdk-utils 4.3.1 → 4.4.2

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

package/api-docs/construct_graphql-api-lambda_main.ts.html ADDED Viewed

@@ -0,0 +1,408 @@
+<!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/graphql-api-lambda/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="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>Source</p>
+                    <h1>construct/graphql-api-lambda/main.ts</h1>
+                </header>
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>import * as apig from 'aws-cdk-lib/aws-apigateway'
+import * as acm from 'aws-cdk-lib/aws-certificatemanager'
+import * as iam from 'aws-cdk-lib/aws-iam'
+import * as lambda from 'aws-cdk-lib/aws-lambda'
+import * as route53 from 'aws-cdk-lib/aws-route53'
+import * as secretsmanager from 'aws-cdk-lib/aws-secretsmanager'
+import { Construct } from 'constructs'
+import { CommonConstruct } from '../../common'
+import { GraphQlApiLambdaEnvironment, GraphQlApiLambdaProps } from '../../types'
+/**
+ * @stability stable
+ * @category cdk-utils.graphql-api-lambda
+ * @subcategory construct
+ * @classdesc Provides a construct to create and deploy a Graphql API as Lambda
+ *
+ * &lt;b>Architecture&lt;/b> ![Architecture](./GraphQLApiLambda.jpg)
+ *
+ * @example
+ * import { GraphQLApiLambda, GraphQlApiLambdaProps } '@gradientedge/cdk-utils'
+ * import { Construct } from 'constructs'
+ *
+ * class CustomConstruct extends GraphQLApiLambda {
+ *   constructor(parent: Construct, id: string, props: GraphQlApiLambdaProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.id = id
+ *     this.initResources()
+ *   }
+ * }
+ */
+export class GraphQLApiLambda extends CommonConstruct {
+  /* graphql restApi props */
+  props: GraphQlApiLambdaProps
+  id: string
+  /* graphql restApi resources */
+  applicationSecrets: secretsmanager.ISecret[]
+  graphQLApiLambdaPolicy: iam.PolicyDocument
+  graphQLApiLambdaRole: iam.Role
+  graphQLApiLambdaEnvironment: GraphQlApiLambdaEnvironment
+  graphQLApiLambdaLayers: lambda.LayerVersion[] = []
+  graphQLApiLambdaFunction: lambda.Function
+  graphQLApi: apig.RestApi
+  graphQLApiHostedZone: route53.IHostedZone
+  graphQLApiCertificate: acm.ICertificate
+  graphQLApiDomain: apig.DomainName
+  graphQLApiBasePathMappings: apig.BasePathMapping[] = []
+  constructor(parent: Construct, id: string, props: GraphQlApiLambdaProps) {
+    super(parent, id, props)
+    this.props = props
+    this.id = id
+  }
+  /**
+   * @summary Initialise and provision resources
+   * @protected
+   */
+  protected initResources() {
+    this.resolveSecrets()
+    this.resolveHostedZone()
+    this.resolveCertificate()
+    this.createLambdaPolicy()
+    this.createLambdaRole()
+    this.createLambdaEnvironment()
+    this.createLambdaLayers()
+    this.createLambdaFunction()
+    this.createRestApi()
+    this.createApiDomain()
+    this.createApiBasePathMapping()
+    this.createApiRouteAssets()
+  }
+  /**
+   * @summary Method to resolve secrets from SecretsManager
+   * - To be implemented in the overriding method in the implementation class
+   * @protected
+   */
+  protected resolveSecrets() {
+    this.applicationSecrets = []
+  }
+  /**
+   * @summary Method to resolve a hosted zone based on domain attributes
+   * @protected
+   */
+  protected resolveHostedZone() {
+    this.graphQLApiHostedZone = 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.graphQLApiCertificate.useExistingCertificate &amp;&amp;
+      this.props.graphQLApiCertificate.certificateSsmName &amp;&amp;
+      this.props.graphQLApiCertificate.certificateRegion
+    ) {
+      this.props.graphQLApiCertificate.certificateArn = this.ssMManager.readStringParameterFromRegion(
+        `${this.id}-certificate-param`,
+        this,
+        this.props.graphQLApiCertificate.certificateSsmName,
+        this.props.graphQLApiCertificate.certificateRegion
+      )
+    }
+    this.graphQLApiCertificate = this.acmManager.resolveCertificate(
+      `${this.id}-certificate`,
+      this,
+      this.props.graphQLApiCertificate
+    )
+  }
+  /**
+   * @summary Method to create iam policy for GraphQL Lambda function
+   * @protected
+   */
+  protected createLambdaPolicy() {
+    this.graphQLApiLambdaPolicy = new iam.PolicyDocument({
+      statements: [this.iamManager.statementForReadSecrets(this)],
+    })
+  }
+  /**
+   * @summary Method to create iam role for GraphQL Lambda function
+   * @protected
+   */
+  protected createLambdaRole() {
+    this.graphQLApiLambdaRole = this.iamManager.createRoleForLambda(
+      `${this.id}-lambda-role`,
+      this,
+      this.graphQLApiLambdaPolicy
+    )
+  }
+  /**
+   * @summary Method to create environment variables for GraphQL Lambda function
+   * @protected
+   */
+  protected createLambdaEnvironment() {
+    this.graphQLApiLambdaEnvironment = {
+      NODE_ENV: this.props.nodeEnv,
+      LOG_LEVEL: this.props.logLevel,
+      TZ: this.props.timezone,
+    }
+  }
+  /**
+   * @summary Method to create layers for GraphQL Lambda function
+   * @protected
+   */
+  protected createLambdaLayers() {
+    const layers: lambda.LayerVersion[] = []
+    if (!this.props.graphqlApiLambdaLayerSources) return
+    this.props.graphqlApiLambdaLayerSources.forEach((source: lambda.AssetCode, index: number) => {
+      layers.push(this.lambdaManager.createLambdaLayer(`${this.id}-layer-${index}`, this, source))
+    })
+    this.graphQLApiLambdaLayers = layers
+  }
+  /**
+   * @summary Method to create lambda function for GraphQL
+   * @protected
+   */
+  protected createLambdaFunction() {
+    this.graphQLApiLambdaFunction = this.lambdaManager.createLambdaFunction(
+      `${this.id}-graphql-server`,
+      this,
+      this.props.graphqlApi,
+      this.graphQLApiLambdaRole,
+      this.graphQLApiLambdaLayers,
+      this.props.graphQLApiSource,
+      this.props.graphQLApiHandler || 'index.handler',
+      this.graphQLApiLambdaEnvironment
+    )
+  }
+  /**
+   * @summary Method to create rest restApi for GraphQL
+   * @protected
+   */
+  protected createRestApi() {
+    this.graphQLApi = this.apiManager.createLambdaRestApi(
+      `${this.id}-lambda-rest-api`,
+      this,
+      this.props.graphqlRestApi,
+      this.graphQLApiLambdaFunction
+    )
+  }
+  /**
+   * @summary Method to create custom restApi domain for GraphQL API
+   * @protected
+   */
+  protected createApiDomain() {
+    this.graphQLApiDomain = this.apiManager.createApiDomain(
+      `${this.id}-api-domain`,
+      this,
+      this.isProductionStage()
+        ? `${this.props.apiSubDomain}.${this.fullyQualifiedDomainName}`
+        : `${this.props.apiSubDomain}-${this.props.stage}.${this.fullyQualifiedDomainName}`,
+      this.graphQLApiCertificate
+    )
+  }
+  /**
+   * @summary Method to create base path mappings for GraphQL API
+   * @protected
+   */
+  protected createApiBasePathMapping() {
+    const apiRootPaths = this.props.apiRootPaths
+    if (apiRootPaths &amp;&amp; apiRootPaths.length > 0) {
+      apiRootPaths.forEach((apiRootPath: string) => {
+        this.graphQLApiBasePathMappings.push(
+          new apig.BasePathMapping(this, `${this.id}-base-bath-mapping-${apiRootPath}`, {
+            basePath: apiRootPath,
+            domainName: this.graphQLApiDomain,
+            restApi: this.graphQLApi,
+            stage: this.graphQLApi.deploymentStage,
+          })
+        )
+      })
+    }
+  }
+  /**
+   * @summary Method to create route53 records for GraphQL API
+   * @protected
+   */
+  protected createApiRouteAssets() {
+    this.route53Manager.createApiGatewayARecord(
+      `${this.id}-custom-domain-a-record`,
+      this,
+      this.props.apiSubDomain,
+      this.graphQLApiDomain,
+      this.graphQLApiHostedZone
+    )
+  }
+}
+</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>