@gradientedge/cdk-utils 8.35.0 → 8.37.0

package/README.md

@@ -47,6 +47,12 @@ With **yarn**:
 yarn add @gradientedge/cdk-utils
 ```
 
+With **pnpm**:
+
+```shell
+pnpm add @gradientedge/cdk-utils
+```
+
 ### ![purescript]
 
 ```

package/dist/src/lib/common/stack.d.ts

@@ -37,6 +37,7 @@ export declare class CommonStack extends cdk.Stack {
         extraContexts: any;
         skipStageForARecords: any;
         logRetention: any;
+        excludeDomainNameForBuckets: any;
         nodejsRuntime: any;
     };
     /**

package/dist/src/lib/common/stack.js

@@ -76,6 +76,7 @@ class CommonStack extends cdk.Stack {
             extraContexts: this.node.tryGetContext('extraContexts'),
             skipStageForARecords: this.node.tryGetContext('skipStageForARecords'),
             logRetention: this.node.tryGetContext('logRetention'),
+            excludeDomainNameForBuckets: this.node.tryGetContext('excludeDomainNameForBuckets'),
             nodejsRuntime: this.node.tryGetContext('nodejsRuntime') ?? CommonStack.NODEJS_RUNTIME,
         };
     }

package/dist/src/lib/manager/aws/s3-manager.d.ts

@@ -32,19 +32,26 @@ export declare class S3Manager {
      */
     protected determineBucketLifecycleRules(props: types.S3BucketProps): types.LifecycleRule[] | undefined;
     /**
-     * @summary Method to determine the bucket name
+     * @summary Method to determine the bucket name using account and region
      * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.S3BucketProps} props bucket properties
-     * @private
+     * @param {string} bucketName the bucket name
+     * @protected
      */
-    protected static determineBucketName(scope: common.CommonConstruct, props: types.S3BucketProps): string;
+    protected static determineBucketNameByAccountAndRegion(scope: common.CommonConstruct, bucketName: string): string;
     /**
-     * @summary Method to determine the log bucket name
+     * @summary Method to determine the bucket name using domain name
      * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.S3BucketProps} props bucket properties
+     * @param {string} bucketName the bucket name
+     * @protected
+     */
+    protected static determineBucketNameByDomainName(scope: common.CommonConstruct, bucketName: string): string;
+    /**
+     * @summary Method to determine the bucket name
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {string} bucketName the bucket name
      * @private
      */
-    protected static determineLogBucketName(scope: common.CommonConstruct, props: types.S3BucketProps): string;
+    protected static determineBucketName(scope: common.CommonConstruct, bucketName: string): string;
     /**
      * @summary Method to create a s3 bucket
      * @param {string} id scoped id of the resource

package/dist/src/lib/manager/aws/s3-manager.js

@@ -79,26 +79,36 @@ class S3Manager {
         return bucketLifecycleRules;
     }
     /**
-     * @summary Method to determine the bucket name
+     * @summary Method to determine the bucket name using account and region
      * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.S3BucketProps} props bucket properties
-     * @private
+     * @param {string} bucketName the bucket name
+     * @protected
+     */
+    static determineBucketNameByAccountAndRegion(scope, bucketName) {
+        return `${bucketName}-${cdk.Stack.of(scope).account}-${scope.props.region}-${scope.props.stage}`;
+    }
+    /**
+     * @summary Method to determine the bucket name using domain name
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {string} bucketName the bucket name
+     * @protected
      */
-    static determineBucketName(scope, props) {
+    static determineBucketNameByDomainName(scope, bucketName) {
         return scope.isProductionStage()
-            ? `${props.bucketName}.${scope.fullyQualifiedDomainName}`
-            : `${props.bucketName}-${scope.props.stage}.${scope.fullyQualifiedDomainName}`;
+            ? `${bucketName}.${scope.fullyQualifiedDomainName}`
+            : `${bucketName}-${scope.props.stage}.${scope.fullyQualifiedDomainName}`;
     }
     /**
-     * @summary Method to determine the log bucket name
+     * @summary Method to determine the bucket name
      * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.S3BucketProps} props bucket properties
+     * @param {string} bucketName the bucket name
      * @private
      */
-    static determineLogBucketName(scope, props) {
-        return scope.isProductionStage()
-            ? `${props.logBucketName}.${scope.fullyQualifiedDomainName}`
-            : `${props.logBucketName}-${scope.props.stage}.${scope.fullyQualifiedDomainName}`;
+    static determineBucketName(scope, bucketName) {
+        const sanitisedBucketName = scope.props.excludeDomainNameForBuckets
+            ? S3Manager.determineBucketNameByAccountAndRegion(scope, bucketName)
+            : S3Manager.determineBucketNameByDomainName(scope, bucketName);
+        return sanitisedBucketName;
     }
     /**
      * @summary Method to create a s3 bucket
@@ -110,14 +120,14 @@ class S3Manager {
         if (!props)
             throw `S3 props undefined for ${id}`;
         let bucket;
-        const bucketName = S3Manager.determineBucketName(scope, props);
+        const bucketName = S3Manager.determineBucketName(scope, props.bucketName);
         if (props.existingBucket && props.bucketName) {
             bucket = s3.Bucket.fromBucketName(scope, `${id}`, bucketName);
         }
         else {
             let logBucket;
             if (props.logBucketName) {
-                const logBucketName = S3Manager.determineLogBucketName(scope, props);
+                const logBucketName = S3Manager.determineBucketName(scope, props.logBucketName);
                 logBucket = s3.Bucket.fromBucketName(scope, `${id}-logs`, logBucketName);
             }
             bucket = new s3.Bucket(scope, `${id}-bucket`, {

package/dist/src/lib/types/aws/index.d.ts

@@ -53,6 +53,7 @@ export interface CommonStackProps extends cdk.StackProps {
     stageContextPath?: string;
     skipStageForARecords: boolean;
     logRetention?: logs.RetentionDays;
+    excludeDomainNameForBuckets?: boolean;
     nodejsRuntime?: lambda.Runtime;
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils",
-  "version": "8.35.0",
+  "version": "8.37.0",
   "description": "Utilities for AWS CDK provisioning",
   "main": "dist/index.js",
   "engines": {
@@ -95,7 +95,7 @@
   },
   "config": {
     "commitizen": {
-      "path": "./node_modules/cz-conventional-changelog"
+      "path": "cz-conventional-changelog"
     }
   },
   "workspaces": [

package/src/lib/common/stack.ts

@@ -60,6 +60,7 @@ export class CommonStack extends cdk.Stack {
       extraContexts: this.node.tryGetContext('extraContexts'),
       skipStageForARecords: this.node.tryGetContext('skipStageForARecords'),
       logRetention: this.node.tryGetContext('logRetention'),
+      excludeDomainNameForBuckets: this.node.tryGetContext('excludeDomainNameForBuckets'),
       nodejsRuntime: this.node.tryGetContext('nodejsRuntime') ?? CommonStack.NODEJS_RUNTIME,
     }
   }

package/src/lib/manager/aws/s3-manager.ts

@@ -59,27 +59,38 @@ export class S3Manager {
   }
 
   /**
-   * @summary Method to determine the bucket name
+   * @summary Method to determine the bucket name using account and region
    * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {types.S3BucketProps} props bucket properties
-   * @private
+   * @param {string} bucketName the bucket name
+   * @protected
    */
-  protected static determineBucketName(scope: common.CommonConstruct, props: types.S3BucketProps) {
+  protected static determineBucketNameByAccountAndRegion(scope: common.CommonConstruct, bucketName: string) {
+    return `${bucketName}-${cdk.Stack.of(scope).account}-${scope.props.region}-${scope.props.stage}`
+  }
+
+  /**
+   * @summary Method to determine the bucket name using domain name
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {string} bucketName the bucket name
+   * @protected
+   */
+  protected static determineBucketNameByDomainName(scope: common.CommonConstruct, bucketName: string) {
     return scope.isProductionStage()
-      ? `${props.bucketName}.${scope.fullyQualifiedDomainName}`
-      : `${props.bucketName}-${scope.props.stage}.${scope.fullyQualifiedDomainName}`
+      ? `${bucketName}.${scope.fullyQualifiedDomainName}`
+      : `${bucketName}-${scope.props.stage}.${scope.fullyQualifiedDomainName}`
   }
 
   /**
-   * @summary Method to determine the log bucket name
+   * @summary Method to determine the bucket name
    * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {types.S3BucketProps} props bucket properties
+   * @param {string} bucketName the bucket name
    * @private
    */
-  protected static determineLogBucketName(scope: common.CommonConstruct, props: types.S3BucketProps) {
-    return scope.isProductionStage()
-      ? `${props.logBucketName}.${scope.fullyQualifiedDomainName}`
-      : `${props.logBucketName}-${scope.props.stage}.${scope.fullyQualifiedDomainName}`
+  protected static determineBucketName(scope: common.CommonConstruct, bucketName: string) {
+    const sanitisedBucketName = scope.props.excludeDomainNameForBuckets
+      ? S3Manager.determineBucketNameByAccountAndRegion(scope, bucketName)
+      : S3Manager.determineBucketNameByDomainName(scope, bucketName)
+    return sanitisedBucketName
   }
 
   /**
@@ -93,14 +104,14 @@ export class S3Manager {
 
     let bucket: s3.IBucket
 
-    const bucketName = S3Manager.determineBucketName(scope, props)
+    const bucketName = S3Manager.determineBucketName(scope, props.bucketName)
 
     if (props.existingBucket && props.bucketName) {
       bucket = s3.Bucket.fromBucketName(scope, `${id}`, bucketName)
     } else {
       let logBucket
       if (props.logBucketName) {
-        const logBucketName = S3Manager.determineLogBucketName(scope, props)
+        const logBucketName = S3Manager.determineBucketName(scope, props.logBucketName)
         logBucket = s3.Bucket.fromBucketName(scope, `${id}-logs`, logBucketName)
       }
 

package/src/lib/types/aws/index.ts

@@ -55,6 +55,7 @@ export interface CommonStackProps extends cdk.StackProps {
   stageContextPath?: string
   skipStageForARecords: boolean
   logRetention?: logs.RetentionDays
+  excludeDomainNameForBuckets?: boolean
   nodejsRuntime?: lambda.Runtime
 }