@gradientedge/cdk-utils 4.1.2 → 4.2.3

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,12 +35,12 @@ 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
@@ -53,20 +53,24 @@ export const ArnsByRegion: { [key: string]: string } = {
 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}`, {
@@ -75,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
   }
@@ -84,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`
 
@@ -105,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
   }
@@ -115,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`
 
@@ -138,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
   }

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

@@ -1,26 +1,26 @@
+import * as cdk from 'aws-cdk-lib'
 import * as acm from 'aws-cdk-lib/aws-certificatemanager'
 import * as cloudfront from 'aws-cdk-lib/aws-cloudfront'
-import * as lambda from 'aws-cdk-lib/aws-lambda'
-import * as s3 from 'aws-cdk-lib/aws-s3'
-import { CommonConstruct } from '../common/commonConstruct'
-import { CloudFrontProps, DistributionProps, LambdaEdgeProps } from '../types'
-import { createCfnOutput } from '../utils'
-import * as cdk from 'aws-cdk-lib'
+import * as origins from 'aws-cdk-lib/aws-cloudfront-origins'
 import * as ec2 from 'aws-cdk-lib/aws-ec2'
 import * as efs from 'aws-cdk-lib/aws-efs'
-import * as origins from 'aws-cdk-lib/aws-cloudfront-origins'
+import * as lambda from 'aws-cdk-lib/aws-lambda'
+import * as s3 from 'aws-cdk-lib/aws-s3'
 import * as cr from 'aws-cdk-lib/custom-resources'
+import * as common from '../../common'
+import * as types from '../../types'
+import * as utils from '../../utils'
 
 /**
  * @stability stable
  * @category Networking & Content Delivery
  * @summary Provides operations on AWS CloudFront.
- * - 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
@@ -38,7 +38,7 @@ import * as cr from 'aws-cdk-lib/custom-resources'
  * @see [CDK CloudFront Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudfront-readme.html}
  */
 export class CloudFrontManager {
-  public createOriginAccessIdentity(id: string, scope: CommonConstruct, accessBucket?: s3.IBucket) {
+  public createOriginAccessIdentity(id: string, scope: common.CommonConstruct, accessBucket?: s3.IBucket) {
     const oai = new cloudfront.OriginAccessIdentity(scope, `${id}`, {
       comment: `${id} - ${scope.props.stage} stage`,
     })
@@ -52,8 +52,8 @@ export class CloudFrontManager {
    *
    * @summary Method to create a cloudfront distribution
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {CloudFrontProps} props distribution properties
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.CloudFrontProps} props distribution properties
    * @param {s3.IBucket?} siteBucket
    * @param {s3.IBucket?} logBucket
    * @param {cloudfront.OriginAccessIdentity?} oai
@@ -62,8 +62,8 @@ export class CloudFrontManager {
    */
   public createCloudFrontDistribution(
     id: string,
-    scope: CommonConstruct,
-    props: CloudFrontProps,
+    scope: common.CommonConstruct,
+    props: types.CloudFrontProps,
     siteBucket?: s3.IBucket,
     logBucket?: s3.IBucket,
     oai?: cloudfront.OriginAccessIdentity,
@@ -104,8 +104,8 @@ export class CloudFrontManager {
       webACLId: props.webACLId,
     })
 
-    createCfnOutput(`${id}-distributionId`, scope, distribution.distributionId)
-    createCfnOutput(`${id}-distributionDomainName`, scope, distribution.distributionDomainName)
+    utils.createCfnOutput(`${id}-distributionId`, scope, distribution.distributionId)
+    utils.createCfnOutput(`${id}-distributionDomainName`, scope, distribution.distributionDomainName)
 
     return distribution
   }
@@ -113,25 +113,27 @@ export class CloudFrontManager {
   /**
    * Method to create a CloudFront distribution with S3 Origin
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {CloudFrontProps} props distribution properties
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.DistributionProps} props distribution properties
    * @param {origins.S3Origin} origin
    * @param {s3.IBucket} siteBucket
    * @param {s3.IBucket?} logBucket
    * @param {cloudfront.OriginAccessIdentity?} oai
    * @param {acm.ICertificate?} certificate
    * @param {string[]?} aliases
+   * @param {cloudfront.FunctionAssociation?} defaultFunctionAssociations
    */
   public createDistributionWithS3Origin(
     id: string,
-    scope: CommonConstruct,
-    props: DistributionProps,
+    scope: common.CommonConstruct,
+    props: types.DistributionProps,
     origin: origins.S3Origin,
     siteBucket: s3.IBucket,
     logBucket?: s3.IBucket,
     oai?: cloudfront.OriginAccessIdentity,
     certificate?: acm.ICertificate,
-    aliases?: string[]
+    aliases?: string[],
+    defaultFunctionAssociations?: cloudfront.FunctionAssociation[]
   ) {
     const distribution = new cloudfront.Distribution(scope, `${id}`, {
       certificate: certificate,
@@ -140,6 +142,7 @@ export class CloudFrontManager {
         cachePolicy: props.defaultBehavior ? props.defaultBehavior.cachePolicy : undefined,
         origin: origin,
         originRequestPolicy: props.defaultBehavior ? props.defaultBehavior.originRequestPolicy : undefined,
+        functionAssociations: defaultFunctionAssociations ?? undefined,
       },
       additionalBehaviors: props.additionalBehaviors,
       defaultRootObject: props.defaultRootObject,
@@ -158,8 +161,8 @@ export class CloudFrontManager {
       webAclId: props.webAclId,
     })
 
-    createCfnOutput(`${id}-distributionId`, scope, distribution.distributionId)
-    createCfnOutput(`${id}-distributionDomainName`, scope, distribution.distributionDomainName)
+    utils.createCfnOutput(`${id}-distributionId`, scope, distribution.distributionId)
+    utils.createCfnOutput(`${id}-distributionDomainName`, scope, distribution.distributionDomainName)
 
     return distribution
   }
@@ -167,21 +170,23 @@ export class CloudFrontManager {
   /**
    * Method to create a CloudFront distribution with HTTP Origin
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {CloudFrontProps} props distribution properties
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.DistributionProps} props distribution properties
    * @param {origins.S3Origin} origin
    * @param {string[]} domainNames
    * @param {s3.IBucket?} logBucket
    * @param {acm.ICertificate?} certificate
+   * @param {cloudfront.FunctionAssociation?} defaultFunctionAssociations
    */
   public createDistributionWithHttpOrigin(
     id: string,
-    scope: CommonConstruct,
-    props: DistributionProps,
+    scope: common.CommonConstruct,
+    props: types.DistributionProps,
     origin: origins.HttpOrigin,
     domainNames: string[],
     logBucket?: s3.IBucket,
-    certificate?: acm.ICertificate
+    certificate?: acm.ICertificate,
+    defaultFunctionAssociations?: cloudfront.FunctionAssociation[]
   ) {
     const distribution = new cloudfront.Distribution(scope, `${id}`, {
       certificate: certificate,
@@ -190,6 +195,7 @@ export class CloudFrontManager {
         cachePolicy: props.defaultBehavior ? props.defaultBehavior.cachePolicy : undefined,
         origin: origin,
         originRequestPolicy: props.defaultBehavior ? props.defaultBehavior.originRequestPolicy : undefined,
+        functionAssociations: defaultFunctionAssociations ?? undefined,
       },
       additionalBehaviors: props.additionalBehaviors,
       defaultRootObject: props.defaultRootObject,
@@ -208,8 +214,8 @@ export class CloudFrontManager {
       webAclId: props.webAclId,
     })
 
-    createCfnOutput(`${id}-distributionId`, scope, distribution.distributionId)
-    createCfnOutput(`${id}-distributionDomainName`, scope, distribution.distributionDomainName)
+    utils.createCfnOutput(`${id}-distributionId`, scope, distribution.distributionId)
+    utils.createCfnOutput(`${id}-distributionDomainName`, scope, distribution.distributionDomainName)
 
     return distribution
   }
@@ -218,8 +224,8 @@ export class CloudFrontManager {
    * @summary Method to provision a Lambda@Edge function
    *
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {LambdaEdgeProps} props lambda@edge properties
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.LambdaEdgeProps} props lambda@edge properties
    * @param {lambda.ILayerVersion[]} layers
    * @param {lambda.AssetCode} code
    * @param {Map<string, string>} environment
@@ -230,8 +236,8 @@ export class CloudFrontManager {
    */
   public createEdgeFunction(
     id: string,
-    scope: CommonConstruct,
-    props: LambdaEdgeProps,
+    scope: common.CommonConstruct,
+    props: types.LambdaEdgeProps,
     layers: lambda.ILayerVersion[],
     code: lambda.AssetCode,
     environment?: any,
@@ -261,9 +267,9 @@ export class CloudFrontManager {
       vpc: vpc,
     })
 
-    createCfnOutput(`${id}-edgeArn`, scope, edgeFunction.edgeArn)
-    createCfnOutput(`${id}-edgeFunctionArn`, scope, edgeFunction.functionArn)
-    createCfnOutput(`${id}-edgeFunctionName`, scope, edgeFunction.functionName)
+    utils.createCfnOutput(`${id}-edgeArn`, scope, edgeFunction.edgeArn)
+    utils.createCfnOutput(`${id}-edgeFunctionArn`, scope, edgeFunction.functionArn)
+    utils.createCfnOutput(`${id}-edgeFunctionName`, scope, edgeFunction.functionName)
 
     return edgeFunction
   }
@@ -278,7 +284,7 @@ export class CloudFrontManager {
    */
   public invalidateCache(
     id: string,
-    scope: CommonConstruct,
+    scope: common.CommonConstruct,
     dockerFilePath: string,
     distributionId: string,
     paths?: string
@@ -301,4 +307,26 @@ export class CloudFrontManager {
       policy: cr.AwsCustomResourcePolicy.fromSdkCalls({ resources: cr.AwsCustomResourcePolicy.ANY_RESOURCE }),
     })
   }
+
+  /**
+   * @summary Method to provision a Cloudfront function
+   *
+   * @param {string} id scoped id of the resource
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.CloudfrontFunctionProps} props
+   */
+  public createCloudfrontFunction(id: string, scope: common.CommonConstruct, props: types.CloudfrontFunctionProps) {
+    const cloudfrontFunction = new cloudfront.Function(scope, `${id}`, {
+      code: cloudfront.FunctionCode.fromFile({
+        filePath: props.functionFilePath,
+      }),
+      comment: props.comment,
+      functionName: `${props.functionName}-${scope.props.stage}`,
+    })
+
+    utils.createCfnOutput(`${id}-functionArn`, scope, cloudfrontFunction.functionArn)
+    utils.createCfnOutput(`${id}-functionName`, scope, cloudfrontFunction.functionName)
+
+    return cloudfrontFunction
+  }
 }

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

@@ -1,20 +1,20 @@
 import * as cloudtrail from 'aws-cdk-lib/aws-cloudtrail'
 import * as logs from 'aws-cdk-lib/aws-logs'
 import * as s3 from 'aws-cdk-lib/aws-s3'
-import { CommonConstruct } from '../common/commonConstruct'
-import { CloudTrailProps } from '../types'
-import { createCfnOutput } from '../utils'
+import * as common from '../../common'
+import * as types from '../../types'
+import * as utils from '../../utils'
 
 /**
  * @stability stable
  * @category Management & Governance
  * @summary Provides operations on AWS CloudTrail.
- * - 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
@@ -35,8 +35,8 @@ export class CloudTrailManager {
   /**
    * @summary Method to create a cloud trail
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {CloudTrailProps} props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.CloudTrailProps} props
    * @param {logs.CfnLogGroup} logGroup
    * @param {s3.IBucket} dataBucket
    * @param {s3.IBucket} logBucket
@@ -44,8 +44,8 @@ export class CloudTrailManager {
    */
   public createCloudTrail(
     id: string,
-    scope: CommonConstruct,
-    props: CloudTrailProps,
+    scope: common.CommonConstruct,
+    props: types.CloudTrailProps,
     logGroup: logs.CfnLogGroup,
     dataBucket: s3.IBucket,
     logBucket: s3.IBucket,
@@ -84,8 +84,8 @@ export class CloudTrailManager {
     cloudTrail.addDependsOn(logGroup)
     cloudTrail.addDependsOn(role)
 
-    createCfnOutput(`${id}-trailName`, scope, cloudTrail.trailName)
-    createCfnOutput(`${id}-trailArn`, scope, cloudTrail.attrArn)
+    utils.createCfnOutput(`${id}-trailName`, scope, cloudTrail.trailName)
+    utils.createCfnOutput(`${id}-trailArn`, scope, cloudTrail.attrArn)
 
     return { cloudTrailRole: role, cloudTrail }
   }