@gradientedge/cdk-utils 8.91.0 → 8.92.0

package/src/lib/construct/site-with-ecs-backend/main.ts

@@ -16,11 +16,7 @@ import { CommonConstruct } from '../../common'
 import { SiteWithEcsBackendProps } from './types'
 
 /**
- * @stability stable
- * @category cdk-utils.site-with-ecs-backend
- * @subcategory construct
  * @classdesc Provides a construct to create and deploy a site hosted with an clustered ECS/ELB backend
- *
  * @example
  * import { SiteWithEcsBackend, SiteWithEcsBackendProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -33,7 +29,6 @@ import { SiteWithEcsBackendProps } from './types'
  *     this.initResources()
  *   }
  * }
- * @mixin
  */
 export class SiteWithEcsBackend extends CommonConstruct {
   /* site properties */
@@ -77,7 +72,6 @@ export class SiteWithEcsBackend extends CommonConstruct {
 
   /**
    * @summary Initialise and provision resources
-   * @protected
    */
   protected initResources() {
     this.resolveHostedZone()
@@ -104,7 +98,6 @@ export class SiteWithEcsBackend extends CommonConstruct {
 
   /**
    * @summary Method to resolve a hosted zone based on domain attributes
-   * @protected
    */
   protected resolveHostedZone() {
     this.siteHostedZone = this.route53Manager.withHostedZoneFromFullyQualifiedDomainName(
@@ -116,7 +109,6 @@ export class SiteWithEcsBackend extends CommonConstruct {
 
   /**
    * @summary Method to resolve a certificate based on attributes
-   * @protected
    */
   protected resolveCertificate() {
     /* determine site certificate */
@@ -149,13 +141,11 @@ export class SiteWithEcsBackend extends CommonConstruct {
   /**
    * @summary Method to resolve secrets from SecretsManager
    * - To be implemented in the overriding method in the implementation class
-   * @protected
    */
   protected resolveSiteSecrets() {}
 
   /**
    * @summary Method to resolve site domain names
-   * @protected
    */
   protected resolveSiteDomainNames() {
     /* the internal domain name used by ELB */
@@ -175,15 +165,17 @@ export class SiteWithEcsBackend extends CommonConstruct {
 
   /**
    * Create VPC
-   * @protected
    */
   protected createVpc() {
-    this.siteVpc = this.vpcManager.createCommonVpc(this, this.props.siteVpc, this.props.siteVpc.vpcName)
+    if (this.props.useExistingVpc) {
+      this.siteVpc = this.vpcManager.retrieveCommonVpc(`${this.id}`, this, this.props.siteVpc.vpcName)
+    } else {
+      this.siteVpc = this.vpcManager.createCommonVpc(this, this.props.siteVpc, this.props.siteVpc.vpcName)
+    }
   }
 
   /**
    * @summary Method to create iam policy for ECS Task
-   * @protected
    */
   protected createEcsPolicy() {
     this.siteEcsPolicy = new iam.PolicyDocument({
@@ -193,7 +185,6 @@ export class SiteWithEcsBackend extends CommonConstruct {
 
   /**
    * @summary Method to create iam role for ECS Task
-   * @protected
    */
   protected createEcsRole() {
     this.siteEcsRole = this.iamManager.createRoleForEcsExecution(`${this.id}-ecs-role`, this, this.siteEcsPolicy)
@@ -201,19 +192,17 @@ export class SiteWithEcsBackend extends CommonConstruct {
 
   /**
    * @summary Method to create environment variables used by ECS task
-   * @protected
    */
   protected createEcsEnvironment() {
     this.siteEcsEnvironment = {
-      NODE_ENV: this.props.nodeEnv,
       LOG_LEVEL: this.props.logLevel,
+      NODE_ENV: this.props.nodeEnv,
       TZ: this.props.timezone,
     }
   }
 
   /**
    * Method to create an ECS cluster
-   * @protected
    */
   protected createEcsCluster() {
     this.siteEcsCluster = this.ecsManager.createEcsCluster(
@@ -226,7 +215,6 @@ export class SiteWithEcsBackend extends CommonConstruct {
 
   /**
    * Method to create log group used by ECS task
-   * @protected
    */
   protected createEcsLogGroup() {
     this.siteEcsLogGroup = this.logManager.createLogGroup(`${this.id}-ecs-log-group`, this, this.props.siteLog)
@@ -234,7 +222,6 @@ export class SiteWithEcsBackend extends CommonConstruct {
 
   /**
    * Method to create docker build arguments for ECS Image step
-   * @protected
    */
   protected createEcsBuildArgs() {
     this.siteEcsBuildArgs = {}
@@ -242,7 +229,6 @@ export class SiteWithEcsBackend extends CommonConstruct {
 
   /**
    * Method to create container image for ECS task
-   * @protected
    */
   protected createEcsContainerImage() {
     this.siteEcsContainerImage = ecs.ContainerImage.fromAsset(this.props.siteEcsContainerImagePath, {
@@ -252,57 +238,56 @@ export class SiteWithEcsBackend extends CommonConstruct {
 
   /**
    * Method to create Application Loadbalanced ECS Fargate Service
-   * @protected
    */
   protected createEcsService() {
     const fargateService = new ecsPatterns.ApplicationLoadBalancedFargateService(this, `${this.id}-ecs-service`, {
+      assignPublicIp: true,
+      certificate: this.siteRegionalCertificate,
       cluster: this.siteEcsCluster,
+      cpu: this.props.siteTask.cpu,
       desiredCount: this.props.siteTask.desiredCount,
+      domainName: this.siteInternalDomainName,
+      domainZone: this.siteHostedZone,
       enableECSManagedTags: true,
-      serviceName: `${this.id}-${this.props.stage}`,
-      cpu: this.props.siteTask.cpu,
+      healthCheckGracePeriod: cdk.Duration.seconds(60),
+      listenerPort: this.props.siteTask.listenerPort,
       loadBalancerName: this.props.siteTask.loadBalancerName
         ? `${this.props.siteTask.loadBalancerName}-${this.props.stage}`
         : `${this.id}-${this.props.stage}`,
-      certificate: this.siteRegionalCertificate,
-      domainName: this.siteInternalDomainName,
-      domainZone: this.siteHostedZone,
-      listenerPort: this.props.siteTask.listenerPort,
+      maxHealthyPercent: this.props.siteTask.maxHealthyPercent,
       memoryLimitMiB: this.props.siteTask.memoryLimitMiB,
-      healthCheckGracePeriod: cdk.Duration.seconds(60),
-      assignPublicIp: true,
       minHealthyPercent: this.props.siteTask.minHealthyPercent,
-      maxHealthyPercent: this.props.siteTask.maxHealthyPercent,
+      serviceName: `${this.id}-${this.props.stage}`,
       taskDefinition: this.props.siteTask.taskDefinition,
       taskImageOptions: {
+        containerPort: this.props.siteTask.taskImageOptions?.containerPort,
         enableLogging: true,
+        environment: this.siteEcsEnvironment,
+        executionRole: this.siteEcsRole,
+        image: this.siteEcsContainerImage,
         logDriver: ecs.LogDriver.awsLogs({
           logGroup: this.siteEcsLogGroup,
-          streamPrefix: `${this.id}-${this.props.stage}/ecs`,
-          multilinePattern: this.props.siteTask.logging?.multilinePattern,
           logRetention: this.props.siteTask.logging?.logRetention,
+          multilinePattern: this.props.siteTask.logging?.multilinePattern,
+          streamPrefix: `${this.id}-${this.props.stage}/ecs`,
         }),
-        image: this.siteEcsContainerImage,
-        executionRole: this.siteEcsRole,
-        taskRole: this.siteEcsRole,
-        containerPort: this.props.siteTask.taskImageOptions?.containerPort,
-        environment: this.siteEcsEnvironment,
         secrets: this.siteSecrets,
+        taskRole: this.siteEcsRole,
       },
     })
 
     if (this.props.siteHealthCheck) {
       fargateService.targetGroup.configureHealthCheck({
         enabled: this.props.siteHealthCheck.enabled ?? true,
+        healthyGrpcCodes: this.props.siteHealthCheck.healthyGrpcCodes,
+        healthyHttpCodes: this.props.siteHealthCheck.healthyHttpCodes,
+        healthyThresholdCount: this.props.siteHealthCheck.healthyThresholdCount,
+        interval: cdk.Duration.seconds(this.props.siteHealthCheck.intervalInSecs),
         path: this.props.siteHealthCheck.path ?? '/',
         port: this.props.siteHealthCheck.port,
-        interval: cdk.Duration.seconds(this.props.siteHealthCheck.intervalInSecs),
+        protocol: this.props.siteHealthCheck.protocol,
         timeout: cdk.Duration.seconds(this.props.siteHealthCheck.timeoutInSecs),
-        healthyThresholdCount: this.props.siteHealthCheck.healthyThresholdCount,
         unhealthyThresholdCount: this.props.siteHealthCheck.unhealthyThresholdCount,
-        healthyGrpcCodes: this.props.siteHealthCheck.healthyGrpcCodes,
-        healthyHttpCodes: this.props.siteHealthCheck.healthyHttpCodes,
-        protocol: this.props.siteHealthCheck.protocol,
       })
     }
 
@@ -316,8 +301,8 @@ export class SiteWithEcsBackend extends CommonConstruct {
 
     if (this.props.siteTask.siteScaling) {
       const scalableTaskCount = this.siteEcsService.autoScaleTaskCount({
-        minCapacity: this.props.siteTask.siteScaling.minCapacity,
         maxCapacity: this.props.siteTask.siteScaling.maxCapacity ?? 4,
+        minCapacity: this.props.siteTask.siteScaling.minCapacity,
       })
 
       if (this.props.siteTask.siteScaling.scaleOnCpuUtilization) {
@@ -365,14 +350,14 @@ export class SiteWithEcsBackend extends CommonConstruct {
 
       /* add the efs volume to ecs task definition */
       this.siteEcsTaskDefinition.addVolume({
-        name: `${this.id}-fs`,
         efsVolumeConfiguration: {
+          authorizationConfig: this.props.siteFileSystem.authorizationConfig,
           fileSystemId: this.siteFileSystem.fileSystemId,
           rootDirectory: this.props.siteFileSystem.rootDirectory,
           transitEncryption: this.props.siteFileSystem.transitEncryption,
           transitEncryptionPort: this.props.siteFileSystem.transitEncryptionPort,
-          authorizationConfig: this.props.siteFileSystem.authorizationConfig,
         },
+        name: `${this.id}-fs`,
       })
 
       if (this.props.siteTask.mountPoints && this.props.siteTask.mountPoints.length > 0) {
@@ -394,7 +379,6 @@ export class SiteWithEcsBackend extends CommonConstruct {
 
   /**
    * Method to create log bucket for site distribution
-   * @protected
    */
   protected createSiteLogBucket() {
     this.siteLogBucket = this.s3Manager.createS3Bucket(`${this.id}-site-logs`, this, this.props.siteLogBucket)
@@ -409,7 +393,6 @@ export class SiteWithEcsBackend extends CommonConstruct {
 
   /**
    * @summary Method to create a site cloudfront function
-   * @protected
    */
   protected createSiteCloudfrontFunction() {
     if (this.props.siteCloudfrontFunctionProps) {
@@ -423,14 +406,13 @@ export class SiteWithEcsBackend extends CommonConstruct {
 
   /**
    * @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,
+          function: this.siteCloudfrontFunction,
         },
       ]
     }
@@ -438,7 +420,6 @@ export class SiteWithEcsBackend extends CommonConstruct {
 
   /**
    * Method to create Site distribution
-   * @protected
    */
   protected createDistribution() {
     this.siteDistribution = this.cloudFrontManager.createDistributionWithHttpOrigin(
@@ -455,7 +436,6 @@ export class SiteWithEcsBackend extends CommonConstruct {
 
   /**
    * Method to create Route53 records for distribution
-   * @protected
    */
   protected createNetworkMappings() {
     this.route53Manager.createCloudFrontTargetARecord(
@@ -470,7 +450,6 @@ export class SiteWithEcsBackend extends CommonConstruct {
 
   /**
    * Method to invalidation the cloudfront distribution cache after a deployment
-   * @protected
    */
   protected invalidateDistributionCache() {
     if (this.props.siteCacheInvalidationDockerFilePath) {

package/src/lib/construct/site-with-ecs-backend/types.ts

@@ -14,29 +14,28 @@ import {
 import { VpcProps } from 'aws-cdk-lib/aws-ec2'
 
 /**
- * @category cdk-utils.site-with-ecs-backend
- * @subcategory Properties
  */
 export interface SiteWithEcsBackendProps extends CommonStackProps {
+  logLevel: string
+  nodeEnv: string
   siteCacheInvalidationDockerFilePath?: string
-  siteHealthCheck: HealthCheck
   siteCertificate: AcmProps
-  siteRegionalCertificate: AcmProps
+  siteCloudfrontFunctionProps?: CloudfrontFunctionProps
   siteCluster: EcsClusterProps
   siteDistribution: DistributionProps
-  siteCloudfrontFunctionProps?: CloudfrontFunctionProps
-  siteFunctionFilePath?: string
   siteEcsContainerImagePath: string
+  siteFileSystem?: EfsFileSystemProps
+  siteFileSystemAccessPoints?: EfsAccessPointOptions[]
+  siteFunctionFilePath?: string
+  siteHealthCheck: HealthCheck
   siteLog: LogProps
   siteLogBucket: S3BucketProps
   siteRecordName?: string
+  siteRegionalCertificate: AcmProps
   siteSubDomain: string
   siteTask: EcsApplicationLoadBalancedFargateServiceProps
   siteVpc: VpcProps
-  siteFileSystem?: EfsFileSystemProps
-  siteFileSystemAccessPoints?: EfsAccessPointOptions[]
-  useExistingHostedZone: boolean
-  nodeEnv: string
-  logLevel: string
   timezone: string
+  useExistingHostedZone: boolean
+  useExistingVpc: boolean
 }

package/src/lib/construct/static-asset-deployment/main.ts

@@ -5,11 +5,7 @@ import * as s3deploy from 'aws-cdk-lib/aws-s3-deployment'
 import { StaticAssetDeploymentProps } from './types'
 
 /**
- * @stability stable
- * @category cdk-utils.static-asset-deployment
- * @subcategory construct
  * @classdesc Provides a construct to create and deploy static assets into S3 bucket
- *
  * @example
  * import { StaticAssetDeployment, StaticAssetDeploymentProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -22,7 +18,6 @@ import { StaticAssetDeploymentProps } from './types'
  *     this.initResources()
  *   }
  * }
- * @mixin
  */
 export class StaticAssetDeployment extends CommonConstruct {
   /* construct properties */
@@ -40,7 +35,6 @@ export class StaticAssetDeployment extends CommonConstruct {
 
   /**
    * @summary Initialise and provision resources
-   * @protected
    */
   public initResources() {
     this.createAssetBucket()
@@ -49,7 +43,6 @@ export class StaticAssetDeployment extends CommonConstruct {
 
   /**
    * @summary Create the static asset bucket
-   * @protected
    */
   protected createAssetBucket() {
     this.staticAssetBucket = this.s3Manager.createS3Bucket(`${this.id}-sa-bucket`, this, this.props.staticAssetBucket)
@@ -57,7 +50,6 @@ export class StaticAssetDeployment extends CommonConstruct {
 
   /**
    * @summary Deploy the static assests into the static asset bucket
-   * @protected
    */
   protected deployStaticAssets() {
     new s3deploy.BucketDeployment(this, `${this.id}-static-deployment`, {

package/src/lib/construct/static-asset-deployment/types.ts

@@ -7,8 +7,8 @@ export interface AssetExport {
 }
 
 export interface StaticAssetDeploymentProps extends CommonStackProps {
+  staticAssetBucket: S3BucketProps
   staticAssetDeployment: BucketDeploymentProps
   staticAssetSources: any[]
-  staticAssetBucket: S3BucketProps
   staticAssetsForExport?: AssetExport[]
 }

package/src/lib/construct/static-site/main.ts

@@ -8,11 +8,7 @@ import { CommonConstruct } from '../../common'
 import { StaticSiteProps } from './types'
 
 /**
- * @stability stable
- * @category cdk-utils.static-site
- * @subcategory construct
  * @classdesc Provides a construct to create and deploy a s3 hosted static site
- *
  * @example
  * import { StaticSite, StaticSiteProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -25,7 +21,6 @@ import { StaticSiteProps } from './types'
  *     this.initResources()
  *   }
  * }
- * @mixin
  */
 export class StaticSite extends CommonConstruct {
   /* static site properties */
@@ -53,7 +48,6 @@ export class StaticSite extends CommonConstruct {
 
   /**
    * @summary Initialise and provision resources
-   * @protected
    */
   protected initResources() {
     this.resolveHostedZone()
@@ -72,7 +66,6 @@ export class StaticSite extends CommonConstruct {
 
   /**
    * @summary Method to resolve a hosted zone based on domain attributes
-   * @protected
    */
   protected resolveHostedZone() {
     this.siteHostedZone = this.route53Manager.withHostedZoneFromFullyQualifiedDomainName(
@@ -84,7 +77,6 @@ export class StaticSite extends CommonConstruct {
 
   /**
    * @summary Method to resolve a certificate based on attributes
-   * @protected
    */
   protected resolveCertificate() {
     if (
@@ -108,7 +100,6 @@ export class StaticSite extends CommonConstruct {
 
   /**
    * @summary Method to create a site log bucket
-   * @protected
    */
   protected createSiteLogBucket() {
     this.siteLogBucket = this.s3Manager.createS3Bucket(`${this.id}-site-logs`, this, this.props.siteLogBucket)
@@ -116,7 +107,6 @@ export class StaticSite extends CommonConstruct {
 
   /**
    * @summary Method to create a site bucket
-   * @protected
    */
   protected createSiteBucket() {
     this.siteBucket = this.s3Manager.createS3Bucket(`${this.id}-site`, this, this.props.siteBucket)
@@ -128,7 +118,6 @@ export class StaticSite extends CommonConstruct {
 
   /**
    * @summary Method to create a site cloudfront function
-   * @protected
    */
   protected createSiteCloudfrontFunction() {
     if (this.props.siteCloudfrontFunctionProps) {
@@ -142,14 +131,13 @@ export class StaticSite extends CommonConstruct {
 
   /**
    * @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,
+          function: this.siteCloudfrontFunction,
         },
       ]
     }
@@ -157,13 +145,11 @@ export class StaticSite extends CommonConstruct {
 
   /**
    * @summary Method to create a site origin access identity
-   * @protected
    */
   protected createSiteOriginAccessIdentity() {}
 
   /**
    * @summary Method to create a site cloudfront distribution
-   * @protected
    */
   protected createSiteDistribution() {
     if (!this.props.siteDistribution) throw 'SiteDistribution props undefined'
@@ -184,7 +170,6 @@ export class StaticSite extends CommonConstruct {
 
   /**
    * @summary Method to create route53 records for static site
-   * @protected
    */
   protected createSiteRouteAssets() {
     this.siteARecord = this.route53Manager.createCloudFrontTargetARecord(
@@ -199,7 +184,6 @@ export class StaticSite extends CommonConstruct {
 
   /**
    * @summary Method to deploy the static assets into s3 bucket for static site
-   * @protected
    */
   protected deploySite() {
     this.s3Manager.doBucketDeployment(
@@ -215,7 +199,6 @@ export class StaticSite extends CommonConstruct {
 
   /**
    * Method to invalidation the cloudfront distribution cache after a deployment
-   * @protected
    */
   protected invalidateDistributionCache() {
     if (this.props.siteCacheInvalidationDockerFilePath) {

package/src/lib/construct/static-site/types.ts

@@ -3,25 +3,23 @@ import { AcmProps, CloudfrontFunctionProps, DistributionProps, S3BucketProps } f
 import { ISource } from 'aws-cdk-lib/aws-s3-deployment'
 
 /**
- * @category cdk-utils.static-site
- * @subcategory Properties
  */
 export interface StaticSiteProps extends CommonStackProps {
+  logLevel: string
+  nodeEnv: string
+  siteAliases?: string[]
+  siteBucket: S3BucketProps
   siteCacheInvalidationDockerFilePath?: string
-  siteCreateAltARecord: boolean
   siteCertificate: AcmProps
-  siteBucket: S3BucketProps
-  siteLogBucket: S3BucketProps
-  siteDistribution?: DistributionProps
   siteCloudfrontFunctionProps?: CloudfrontFunctionProps
+  siteCreateAltARecord: boolean
+  siteDistribution?: DistributionProps
   siteFunctionFilePath?: string
-  siteSource: ISource
   siteHostedZoneDomainName?: string
+  siteLogBucket: S3BucketProps
   siteRecordName?: string
+  siteSource: ISource
   siteSubDomain?: string
-  siteAliases?: string[]
-  useExistingHostedZone: boolean
-  nodeEnv: string
-  logLevel: string
   timezone: string
+  useExistingHostedZone: boolean
 }