@gradientedge/cdk-utils 4.1.1 → 4.2.2

package/src/lib/construct/siteWithEcsBackend.ts

@@ -1,19 +1,19 @@
-import { Construct } from 'constructs'
-import { CommonConstruct } from '../common/commonConstruct'
-import { SiteWithEcsBackendProps } from '../types'
 import * as cdk from 'aws-cdk-lib'
-import * as iam from 'aws-cdk-lib/aws-iam'
-import * as ec2 from 'aws-cdk-lib/aws-ec2'
-import * as ecs from 'aws-cdk-lib/aws-ecs'
-import * as logs from 'aws-cdk-lib/aws-logs'
-import * as route53 from 'aws-cdk-lib/aws-route53'
 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 ec2 from 'aws-cdk-lib/aws-ec2'
+import * as ecs from 'aws-cdk-lib/aws-ecs'
 import * as ecsPatterns from 'aws-cdk-lib/aws-ecs-patterns'
 import * as elb from 'aws-cdk-lib/aws-elasticloadbalancingv2'
-import * as origins from 'aws-cdk-lib/aws-cloudfront-origins'
+import * as iam from 'aws-cdk-lib/aws-iam'
+import * as logs from 'aws-cdk-lib/aws-logs'
+import * as route53 from 'aws-cdk-lib/aws-route53'
 import * as s3 from 'aws-cdk-lib/aws-s3'
 import * as secretsmanager from 'aws-cdk-lib/aws-secretsmanager'
+import { Construct } from 'constructs'
+import { CommonConstruct } from '../common/commonConstruct'
+import { SiteWithEcsBackendProps } from '../types'
 
 /**
  * @stability stable
@@ -30,6 +30,7 @@ import * as secretsmanager from 'aws-cdk-lib/aws-secretsmanager'
  *     this.props = props
  *     this.id = id
  *     this.initResources()
+ *   }
  * }
  *
  * @mermaid
@@ -67,6 +68,8 @@ export class SiteWithEcsBackend extends CommonConstruct {
   siteInternalDomainName: string
   siteExternalDomainName: string
   siteDomainNames: string[]
+  siteCloudfrontFunction: cloudfront.Function
+  siteFunctionAssociations: cloudfront.FunctionAssociation[]
 
   /**
    * @summary Constructor to initialise the SiteWithEcsBackend Construct
@@ -101,6 +104,8 @@ export class SiteWithEcsBackend extends CommonConstruct {
     this.createEcsService()
     this.createSiteLogBucket()
     this.createSiteOrigin()
+    this.createSiteCloudfrontFunction()
+    this.resolveSiteFunctionAssociations()
     this.createDistribution()
     this.createNetworkMappings()
     this.invalidateDistributionCache()
@@ -315,6 +320,35 @@ export class SiteWithEcsBackend extends CommonConstruct {
     })
   }
 
+  /**
+   * @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,
+        },
+      ]
+    }
+  }
+
   /**
    * Method to create Site distribution
    * @protected
@@ -327,7 +361,8 @@ export class SiteWithEcsBackend extends CommonConstruct {
       this.siteOrigin,
       this.siteDomainNames,
       this.siteLogBucket,
-      this.siteCertificate
+      this.siteCertificate,
+      this.siteFunctionAssociations
     )
   }
 

package/src/lib/construct/staticSite.ts

@@ -1,11 +1,11 @@
-import { CommonConstruct } from '../common/commonConstruct'
-import { StaticSiteProps } from '../types'
-import * as route53 from 'aws-cdk-lib/aws-route53'
 import * as certificateManager from 'aws-cdk-lib/aws-certificatemanager'
-import * as s3 from 'aws-cdk-lib/aws-s3'
 import * as cloudfront from 'aws-cdk-lib/aws-cloudfront'
-import { Construct } from 'constructs'
 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/commonConstruct'
+import { StaticSiteProps } from '../types'
 
 /**
  * @stability stable
@@ -22,6 +22,7 @@ import * as origins from 'aws-cdk-lib/aws-cloudfront-origins'
  *     this.props = props
  *     this.id = id
  *     this.initResources()
+ *   }
  * }
  *
  * @mermaid
@@ -45,6 +46,8 @@ export class StaticSite extends CommonConstruct {
   siteDistribution: cloudfront.Distribution
   siteLogBucket: s3.IBucket
   siteOriginAccessIdentity: cloudfront.OriginAccessIdentity
+  siteCloudfrontFunction: cloudfront.Function
+  siteFunctionAssociations: cloudfront.FunctionAssociation[]
 
   /**
    * @summary Constructor to initialise the StaticSite Construct
@@ -69,6 +72,8 @@ export class StaticSite extends CommonConstruct {
     this.createSiteLogBucket()
     this.createSiteBucket()
     this.createSiteOrigin()
+    this.createSiteCloudfrontFunction()
+    this.resolveSiteFunctionAssociations()
     this.createSiteDistribution()
     this.createSiteRouteAssets()
     this.deploySite()
@@ -130,6 +135,35 @@ export class StaticSite extends CommonConstruct {
     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
@@ -146,7 +180,8 @@ export class StaticSite extends CommonConstruct {
       this.siteLogBucket,
       this.siteOriginAccessIdentity,
       this.siteCertificate,
-      this.props.siteAliases
+      this.props.siteAliases,
+      this.siteFunctionAssociations
     )
   }
 

package/src/lib/manager/{acmManager.ts → aws/acmManager.ts}

@@ -1,16 +1,16 @@
+import * as cdk from 'aws-cdk-lib'
 import * as acm from 'aws-cdk-lib/aws-certificatemanager'
 import * as route53 from 'aws-cdk-lib/aws-route53'
-import * as cdk from 'aws-cdk-lib'
-import { CommonConstruct } from '../common/commonConstruct'
-import { AcmProps } from '../types'
-import { createCfnOutput } from '../utils'
+import * as common from '../../common'
+import * as types from '../../types'
+import * as utils from '../../utils'
 
 /**
  * @stability stable
  * @category Security, Identity & Compliance
  * @summary Provides operations on AWS Certificates.
- * - A new instance of this class is injected into {@link CommonConstruct} constructor.
- * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
+ * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
+ * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.
  * @example
  * import { CommonConstruct } from '@gradientedge/cdk-utils'
  *
@@ -19,16 +19,17 @@ import { createCfnOutput } from '../utils'
  *     super(parent, id, props)
  *     this.props = props
  *     this.acmManager.createCertificate('MyCertificate', this)
+ *   }
  * }
  *
- * @see [CDK Certificate Module]{@link https://docs.aws.amazon.com/cdk/api/latest/docs/aws-certificatemanager-readme.html}
+ * @see [CDK Certificate Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_certificatemanager-readme.html}
  */
 export class AcmManager {
   /**
    * @summary Method to create/import a certificate
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {AcmProps} props certificate props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.AcmProps} props certificate props
    * @param {route53.HostedZone?} hostedZone optional hosted zone to perform DNS validation
    * @returns {acm.ICertificate}
    *
@@ -45,8 +46,8 @@ export class AcmManager {
    */
   public resolveCertificate(
     id: string,
-    scope: CommonConstruct,
-    props: AcmProps,
+    scope: common.CommonConstruct,
+    props: types.AcmProps,
     hostedZone?: route53.IHostedZone
   ): acm.ICertificate {
     if (!props) throw `Certificate props undefined`
@@ -69,7 +70,7 @@ export class AcmManager {
       })
     }
 
-    createCfnOutput(`${id}-certificateArn`, scope, certificate.certificateArn)
+    utils.createCfnOutput(`${id}-certificateArn`, scope, certificate.certificateArn)
 
     return certificate
   }

package/src/lib/manager/{apiManager.ts → aws/apiManager.ts}

@@ -1,45 +1,47 @@
-import { CommonConstruct } from '../common/commonConstruct'
 import * as apig from 'aws-cdk-lib/aws-apigateway'
-import * as lambda from 'aws-cdk-lib/aws-lambda'
 import * as acm from 'aws-cdk-lib/aws-certificatemanager'
-import { createCfnOutput } from '../utils'
+import * as lambda from 'aws-cdk-lib/aws-lambda'
+import * as common from '../../common'
+import * as utils from '../../utils'
 
 /**
  * @stability stable
  * @category Networking & Content Delivery
  * @summary Provides operations on AWS API Gateway.
- * - A new instance of this class is injected into {@link CommonConstruct} constructor.
- * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
+ * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
+ * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.
  * @example
- * import { CommonConstruct } from '@gradientedge/cdk-utils'
+ * import { common.CommonConstruct } from '@gradientedge/cdk-utils'
  *
- * class CustomConstruct extends CommonConstruct {
+ * class CustomConstruct extends common.CommonConstruct {
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
  *     const lambdaFunction = this.lambdaManager.createLambdaFunction('MyFunction', this, role, layers, code)
  *     this.apiManager.createLambdaRestApi('MyCertificate', this, props, lambdaFunction)
+ *   }
  * }
  *
- * @see [CDK API Gateway Module]{@link https://docs.aws.amazon.com/cdk/api/latest/docs/aws-apigateway-readme.html}
+ * @see [CDK API Gateway Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway-readme.html}
  */
 export class ApiManager {
   /**
    * @summary Method to create a Rest API with Lambda backend/target
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {AcmProps} props lambda rest api props
    * @param lambdaFunction
    */
   public createLambdaRestApi(
     id: string,
-    scope: CommonConstruct,
+    scope: common.CommonConstruct,
     props: apig.LambdaRestApiProps,
     lambdaFunction: lambda.Function
   ) {
     const api = new apig.LambdaRestApi(scope, `${id}`, {
       binaryMediaTypes: props.binaryMediaTypes,
       minimumCompressionSize: props.minimumCompressionSize,
+      defaultMethodOptions: props.defaultMethodOptions,
       deploy: props.deploy || true,
       deployOptions: {
         stageName: scope.props.stage,
@@ -74,8 +76,8 @@ export class ApiManager {
       proxy: props.proxy || true,
     })
 
-    createCfnOutput(`${id}-restApiId`, scope, api.restApiId)
-    createCfnOutput(`${id}-restApiName`, scope, api.restApiName)
+    utils.createCfnOutput(`${id}-restApiId`, scope, api.restApiId)
+    utils.createCfnOutput(`${id}-restApiName`, scope, api.restApiName)
 
     return api
   }
@@ -83,11 +85,11 @@ export class ApiManager {
   /**
    * @summary Method to create custom api domain
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param domainName the domain name to use
    * @param certificate the certificate used for custom api domain
    */
-  public createApiDomain(id: string, scope: CommonConstruct, domainName: string, certificate: acm.ICertificate) {
+  public createApiDomain(id: string, scope: common.CommonConstruct, domainName: string, certificate: acm.ICertificate) {
     const apiDomain = new apig.DomainName(scope, `${id}`, {
       domainName: domainName,
       certificate: certificate,
@@ -95,7 +97,7 @@ export class ApiManager {
       securityPolicy: apig.SecurityPolicy.TLS_1_2,
     })
 
-    createCfnOutput(`${id}-customDomainName`, scope, apiDomain.domainName)
+    utils.createCfnOutput(`${id}-customDomainName`, scope, apiDomain.domainName)
 
     return apiDomain
   }

package/src/lib/manager/{appConfigManager.ts → aws/appConfigManager.ts}

@@ -1,8 +1,8 @@
-import * as appconfig from 'aws-cdk-lib/aws-appconfig'
 import * as cdk from 'aws-cdk-lib'
-import { CommonConstruct } from '../common/commonConstruct'
-import { AppConfigProps } from '../types'
-import { createCfnOutput } from '../utils'
+import * as appconfig from 'aws-cdk-lib/aws-appconfig'
+import * as common from '../../common'
+import * as types from '../../types'
+import * as utils from '../../utils'
 
 /**
  * @stability stable
@@ -35,37 +35,42 @@ export const ArnsByRegion: { [key: string]: string } = {
 /**
  * @category Management & Governance
  * @summary Provides operations on AWS AppConfig.
- * - A new instance of this class is injected into {@link CommonConstruct} constructor.
- * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
+ * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
+ * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.
  * @example
  * import * as common from '@gradientedge/cdk-utils'
  *
- * class CustomConstruct extends common.CommonConstruct {
+ * class CustomConstruct extends common.common.CommonConstruct {
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
  *     this.appConfigManager.createApplication('MyApplication', this)
+ *   }
  * }
  *
- * @see [CDK AppConfig Module]{@link https://docs.aws.amazon.com/cdk/api/latest/docs/aws-appconfig-readme.html}
+ * @see [CDK AppConfig Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_appconfig-readme.html}
  */
 export class AppConfigManager {
   /**
    * Method to get static ARNs for AppConfig extensions
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    */
-  public getArnForAppConfigExtension(scope: CommonConstruct) {
+  public getArnForAppConfigExtension(scope: common.CommonConstruct) {
     return ArnsByRegion[scope.props.region]
   }
 
   /**
    * @summary Method to create an AppConfig Application
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {AppConfigProps} props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.AppConfigProps} props
    * @returns {appconfig.CfnApplication}
    */
-  public createApplication(id: string, scope: CommonConstruct, props: AppConfigProps): appconfig.CfnApplication {
+  public createApplication(
+    id: string,
+    scope: common.CommonConstruct,
+    props: types.AppConfigProps
+  ): appconfig.CfnApplication {
     if (!props) throw `AppConfig props undefined`
 
     const application = new appconfig.CfnApplication(scope, `${id}`, {
@@ -74,8 +79,8 @@ export class AppConfigManager {
       tags: props.application.tags,
     })
 
-    createCfnOutput(`${id}-ApplicationId`, scope, cdk.Fn.ref(application.logicalId))
-    createCfnOutput(`${id}-ApplicationName`, scope, application.name)
+    utils.createCfnOutput(`${id}-ApplicationId`, scope, cdk.Fn.ref(application.logicalId))
+    utils.createCfnOutput(`${id}-ApplicationName`, scope, application.name)
 
     return application
   }
@@ -83,16 +88,16 @@ export class AppConfigManager {
   /**
    * @summary Method to create an AppConfig Environment for a given application
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {string} applicationId id of the application
-   * @param {AppConfigProps} props
+   * @param {types.AppConfigProps} props
    * @returns {appconfig.CfnEnvironment}
    */
   public createEnvironment(
     id: string,
-    scope: CommonConstruct,
+    scope: common.CommonConstruct,
     applicationId: string,
-    props: AppConfigProps
+    props: types.AppConfigProps
   ): appconfig.CfnEnvironment {
     if (!props) throw `AppConfig props undefined`
 
@@ -104,8 +109,8 @@ export class AppConfigManager {
       tags: props.environment.tags,
     })
 
-    createCfnOutput(`${id}-configurationEnvironmentId`, scope, cdk.Fn.ref(environment.logicalId))
-    createCfnOutput(`${id}-configurationEnvironmentName`, scope, environment.name)
+    utils.createCfnOutput(`${id}-configurationEnvironmentId`, scope, cdk.Fn.ref(environment.logicalId))
+    utils.createCfnOutput(`${id}-configurationEnvironmentName`, scope, environment.name)
 
     return environment
   }
@@ -114,16 +119,16 @@ export class AppConfigManager {
    * @summary Method to create an AppConfig Configuration Profile for a given application
    * - <p>&#9888; The <b>locationUri</b> is defaulted to <i>hosted</i> if undefined</p>
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {string} applicationId id of the application
-   * @param {AppConfigProps} props
+   * @param {types.AppConfigProps} props
    * @returns {appconfig.CfnConfigurationProfile}
    */
   public createConfigurationProfile(
     id: string,
-    scope: CommonConstruct,
+    scope: common.CommonConstruct,
     applicationId: string,
-    props: AppConfigProps
+    props: types.AppConfigProps
   ): appconfig.CfnConfigurationProfile {
     if (!props) throw `AppConfig props undefined`
 
@@ -137,8 +142,8 @@ export class AppConfigManager {
       validators: props.configurationProfile.validators,
     })
 
-    createCfnOutput(`${id}-configurationProfileId`, scope, cdk.Fn.ref(profile.logicalId))
-    createCfnOutput(`${id}-configurationProfileName`, scope, profile.name)
+    utils.createCfnOutput(`${id}-configurationProfileId`, scope, cdk.Fn.ref(profile.logicalId))
+    utils.createCfnOutput(`${id}-configurationProfileName`, scope, profile.name)
 
     return profile
   }