@gradientedge/cdk-utils 8.90.0 → 8.92.0

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

@@ -32,11 +32,7 @@ const ecsPatterns = __importStar(require("aws-cdk-lib/aws-ecs-patterns"));
 const iam = __importStar(require("aws-cdk-lib/aws-iam"));
 const common_1 = require("../../common");
 /**
- * @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'
@@ -49,7 +45,6 @@ const common_1 = require("../../common");
  *     this.initResources()
  *   }
  * }
- * @mixin
  */
 class SiteWithEcsBackend extends common_1.CommonConstruct {
     /* site properties */
@@ -89,7 +84,6 @@ class SiteWithEcsBackend extends common_1.CommonConstruct {
     }
     /**
      * @summary Initialise and provision resources
-     * @protected
      */
     initResources() {
         this.resolveHostedZone();
@@ -115,14 +109,12 @@ class SiteWithEcsBackend extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to resolve a hosted zone based on domain attributes
-     * @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
      */
     resolveCertificate() {
         /* determine site certificate */
@@ -137,12 +129,10 @@ class SiteWithEcsBackend extends common_1.CommonConstruct {
     /**
      * @summary Method to resolve secrets from SecretsManager
      * - To be implemented in the overriding method in the implementation class
-     * @protected
      */
     resolveSiteSecrets() { }
     /**
      * @summary Method to resolve site domain names
-     * @protected
      */
     resolveSiteDomainNames() {
         /* the internal domain name used by ELB */
@@ -159,14 +149,17 @@ class SiteWithEcsBackend extends common_1.CommonConstruct {
     }
     /**
      * Create VPC
-     * @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
      */
     createEcsPolicy() {
         this.siteEcsPolicy = new iam.PolicyDocument({
@@ -175,46 +168,40 @@ class SiteWithEcsBackend extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create iam role for ECS Task
-     * @protected
      */
     createEcsRole() {
         this.siteEcsRole = this.iamManager.createRoleForEcsExecution(`${this.id}-ecs-role`, this, this.siteEcsPolicy);
     }
     /**
      * @summary Method to create environment variables used by ECS task
-     * @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
      */
     createEcsCluster() {
         this.siteEcsCluster = this.ecsManager.createEcsCluster(`${this.id}-cluster`, this, this.props.siteCluster, this.siteVpc);
     }
     /**
      * Method to create log group used by ECS task
-     * @protected
      */
     createEcsLogGroup() {
         this.siteEcsLogGroup = this.logManager.createLogGroup(`${this.id}-ecs-log-group`, this, this.props.siteLog);
     }
     /**
      * Method to create docker build arguments for ECS Image step
-     * @protected
      */
     createEcsBuildArgs() {
         this.siteEcsBuildArgs = {};
     }
     /**
      * Method to create container image for ECS task
-     * @protected
      */
     createEcsContainerImage() {
         this.siteEcsContainerImage = ecs.ContainerImage.fromAsset(this.props.siteEcsContainerImagePath, {
@@ -223,56 +210,55 @@ class SiteWithEcsBackend extends common_1.CommonConstruct {
     }
     /**
      * Method to create Application Loadbalanced ECS Fargate Service
-     * @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,
             });
         }
         this.siteEcsService = fargateService.service;
@@ -283,8 +269,8 @@ class SiteWithEcsBackend extends common_1.CommonConstruct {
         fargateService.loadBalancer.logAccessLogs(this.siteLogBucket, 'alb');
         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) {
                 scalableTaskCount.scaleOnCpuUtilization(`${this.id}-cpu-scaling`, {
@@ -316,14 +302,14 @@ class SiteWithEcsBackend extends common_1.CommonConstruct {
             this.siteEcsRole.addToPolicy(new iam.PolicyStatement(this.iamManager.statementForWriteEfs([this.siteFileSystem.fileSystemArn])));
             /* 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) {
                 this.props.siteTask.mountPoints.forEach(mountPoint => this.siteEcsTaskDefinition.defaultContainer?.addMountPoints({
@@ -340,7 +326,6 @@ class SiteWithEcsBackend extends common_1.CommonConstruct {
     }
     /**
      * Method to create log bucket for site distribution
-     * @protected
      */
     createSiteLogBucket() {
         this.siteLogBucket = this.s3Manager.createS3Bucket(`${this.id}-site-logs`, this, this.props.siteLogBucket);
@@ -353,7 +338,6 @@ class SiteWithEcsBackend extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create a site cloudfront function
-     * @protected
      */
     createSiteCloudfrontFunction() {
         if (this.props.siteCloudfrontFunctionProps) {
@@ -362,35 +346,31 @@ class SiteWithEcsBackend extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create a site cloudfront function associations
-     * @protected
      */
     resolveSiteFunctionAssociations() {
         if (this.props.siteCloudfrontFunctionProps) {
             this.siteFunctionAssociations = [
                 {
-                    function: this.siteCloudfrontFunction,
                     eventType: cloudfront.FunctionEventType.VIEWER_REQUEST,
+                    function: this.siteCloudfrontFunction,
                 },
             ];
         }
     }
     /**
      * Method to create Site distribution
-     * @protected
      */
     createDistribution() {
         this.siteDistribution = this.cloudFrontManager.createDistributionWithHttpOrigin(`${this.id}-distribution`, this, this.props.siteDistribution, this.siteOrigin, this.siteDomainNames, this.siteLogBucket, this.siteCertificate, this.siteFunctionAssociations);
     }
     /**
      * Method to create Route53 records for distribution
-     * @protected
      */
     createNetworkMappings() {
         this.route53Manager.createCloudFrontTargetARecord(`${this.id}-a-record`, this, this.siteDistribution, this.siteHostedZone, this.props.siteRecordName, this.props.skipStageForARecords);
     }
     /**
      * Method to invalidation the cloudfront distribution cache after a deployment
-     * @protected
      */
     invalidateDistributionCache() {
         if (this.props.siteCacheInvalidationDockerFilePath) {

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

@@ -2,29 +2,28 @@ import { CommonStackProps } from '../../common';
 import { AcmProps, CloudfrontFunctionProps, DistributionProps, EcsApplicationLoadBalancedFargateServiceProps, EcsClusterProps, EfsAccessPointOptions, EfsFileSystemProps, HealthCheck, LogProps, S3BucketProps } from '../../services';
 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/dist/src/lib/construct/static-asset-deployment/main.d.ts

@@ -3,11 +3,7 @@ import { Construct } from 'constructs';
 import * as s3 from 'aws-cdk-lib/aws-s3';
 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'
@@ -20,7 +16,6 @@ import { StaticAssetDeploymentProps } from './types';
  *     this.initResources()
  *   }
  * }
- * @mixin
  */
 export declare class StaticAssetDeployment extends CommonConstruct {
     props: StaticAssetDeploymentProps;
@@ -29,17 +24,14 @@ export declare class StaticAssetDeployment extends CommonConstruct {
     constructor(parent: Construct, id: string, props: StaticAssetDeploymentProps);
     /**
      * @summary Initialise and provision resources
-     * @protected
      */
     initResources(): void;
     /**
      * @summary Create the static asset bucket
-     * @protected
      */
     protected createAssetBucket(): void;
     /**
      * @summary Deploy the static assests into the static asset bucket
-     * @protected
      */
     protected deployStaticAssets(): void;
 }

package/dist/src/lib/construct/static-asset-deployment/main.js

@@ -27,11 +27,7 @@ exports.StaticAssetDeployment = void 0;
 const common_1 = require("../../common");
 const s3deploy = __importStar(require("aws-cdk-lib/aws-s3-deployment"));
 /**
- * @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'
@@ -44,7 +40,6 @@ const s3deploy = __importStar(require("aws-cdk-lib/aws-s3-deployment"));
  *     this.initResources()
  *   }
  * }
- * @mixin
  */
 class StaticAssetDeployment extends common_1.CommonConstruct {
     /* construct properties */
@@ -59,7 +54,6 @@ class StaticAssetDeployment extends common_1.CommonConstruct {
     }
     /**
      * @summary Initialise and provision resources
-     * @protected
      */
     initResources() {
         this.createAssetBucket();
@@ -67,14 +61,12 @@ class StaticAssetDeployment extends common_1.CommonConstruct {
     }
     /**
      * @summary Create the static asset bucket
-     * @protected
      */
     createAssetBucket() {
         this.staticAssetBucket = this.s3Manager.createS3Bucket(`${this.id}-sa-bucket`, this, this.props.staticAssetBucket);
     }
     /**
      * @summary Deploy the static assests into the static asset bucket
-     * @protected
      */
     deployStaticAssets() {
         new s3deploy.BucketDeployment(this, `${this.id}-static-deployment`, {

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

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

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

@@ -7,11 +7,7 @@ import { Construct } from 'constructs';
 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'
@@ -24,7 +20,6 @@ import { StaticSiteProps } from './types';
  *     this.initResources()
  *   }
  * }
- * @mixin
  */
 export declare class StaticSite extends CommonConstruct {
     props: StaticSiteProps;
@@ -42,63 +37,51 @@ export declare class StaticSite extends CommonConstruct {
     constructor(parent: Construct, id: string, props: StaticSiteProps);
     /**
      * @summary Initialise and provision resources
-     * @protected
      */
     protected initResources(): void;
     /**
      * @summary Method to resolve a hosted zone based on domain attributes
-     * @protected
      */
     protected resolveHostedZone(): void;
     /**
      * @summary Method to resolve a certificate based on attributes
-     * @protected
      */
     protected resolveCertificate(): void;
     /**
      * @summary Method to create a site log bucket
-     * @protected
      */
     protected createSiteLogBucket(): void;
     /**
      * @summary Method to create a site bucket
-     * @protected
      */
     protected createSiteBucket(): void;
     protected createSiteOrigin(): void;
     /**
      * @summary Method to create a site cloudfront function
-     * @protected
      */
     protected createSiteCloudfrontFunction(): void;
     /**
      * @summary Method to create a site cloudfront function associations
-     * @protected
      */
     protected resolveSiteFunctionAssociations(): void;
     /**
      * @summary Method to create a site origin access identity
-     * @protected
      */
     protected createSiteOriginAccessIdentity(): void;
     /**
      * @summary Method to create a site cloudfront distribution
-     * @protected
      */
     protected createSiteDistribution(): void;
     /**
      * @summary Method to create route53 records for static site
-     * @protected
      */
     protected createSiteRouteAssets(): void;
     /**
      * @summary Method to deploy the static assets into s3 bucket for static site
-     * @protected
      */
     protected deploySite(): void;
     /**
      * Method to invalidation the cloudfront distribution cache after a deployment
-     * @protected
      */
     protected invalidateDistributionCache(): void;
 }

package/dist/src/lib/construct/static-site/main.js

@@ -28,11 +28,7 @@ const cloudfront = __importStar(require("aws-cdk-lib/aws-cloudfront"));
 const origins = __importStar(require("aws-cdk-lib/aws-cloudfront-origins"));
 const common_1 = require("../../common");
 /**
- * @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'
@@ -45,7 +41,6 @@ const common_1 = require("../../common");
  *     this.initResources()
  *   }
  * }
- * @mixin
  */
 class StaticSite extends common_1.CommonConstruct {
     /* static site properties */
@@ -69,7 +64,6 @@ class StaticSite extends common_1.CommonConstruct {
     }
     /**
      * @summary Initialise and provision resources
-     * @protected
      */
     initResources() {
         this.resolveHostedZone();
@@ -87,14 +81,12 @@ class StaticSite extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to resolve a hosted zone based on domain attributes
-     * @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
      */
     resolveCertificate() {
         if (this.props.siteCertificate.useExistingCertificate &&
@@ -106,14 +98,12 @@ class StaticSite extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create a site log bucket
-     * @protected
      */
     createSiteLogBucket() {
         this.siteLogBucket = this.s3Manager.createS3Bucket(`${this.id}-site-logs`, this, this.props.siteLogBucket);
     }
     /**
      * @summary Method to create a site bucket
-     * @protected
      */
     createSiteBucket() {
         this.siteBucket = this.s3Manager.createS3Bucket(`${this.id}-site`, this, this.props.siteBucket);
@@ -123,7 +113,6 @@ class StaticSite extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create a site cloudfront function
-     * @protected
      */
     createSiteCloudfrontFunction() {
         if (this.props.siteCloudfrontFunctionProps) {
@@ -132,26 +121,23 @@ class StaticSite extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create a site cloudfront function associations
-     * @protected
      */
     resolveSiteFunctionAssociations() {
         if (this.props.siteCloudfrontFunctionProps) {
             this.siteFunctionAssociations = [
                 {
-                    function: this.siteCloudfrontFunction,
                     eventType: cloudfront.FunctionEventType.VIEWER_REQUEST,
+                    function: this.siteCloudfrontFunction,
                 },
             ];
         }
     }
     /**
      * @summary Method to create a site origin access identity
-     * @protected
      */
     createSiteOriginAccessIdentity() { }
     /**
      * @summary Method to create a site cloudfront distribution
-     * @protected
      */
     createSiteDistribution() {
         if (!this.props.siteDistribution)
@@ -160,21 +146,18 @@ class StaticSite extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create route53 records for static site
-     * @protected
      */
     createSiteRouteAssets() {
         this.siteARecord = this.route53Manager.createCloudFrontTargetARecord(`${this.id}-domain-a-record`, this, this.siteDistribution, this.siteHostedZone, this.props.siteRecordName, this.props.skipStageForARecords);
     }
     /**
      * @summary Method to deploy the static assets into s3 bucket for static site
-     * @protected
      */
     deploySite() {
         this.s3Manager.doBucketDeployment(`${this.id}-deployment`, this, this.siteBucket, this.siteDistribution, [this.props.siteSource], '', true);
     }
     /**
      * Method to invalidation the cloudfront distribution cache after a deployment
-     * @protected
      */
     invalidateDistributionCache() {
         if (this.props.siteCacheInvalidationDockerFilePath) {

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

@@ -2,25 +2,23 @@ import { CommonStackProps } from '../../common';
 import { AcmProps, CloudfrontFunctionProps, DistributionProps, S3BucketProps } from '../../services';
 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;
 }