@gradientedge/cdk-utils 8.91.0 → 8.92.0

package/dist/src/lib/services/aws/virtual-private-cloud/main.d.ts

@@ -2,8 +2,6 @@ import * as cdk from 'aws-cdk-lib';
 import * as ec2 from 'aws-cdk-lib/aws-ec2';
 import { CommonConstruct } from '../../../common';
 /**
- * @category cdk-utils.vpc-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS VPC.
  * - 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.
@@ -17,29 +15,28 @@ import { CommonConstruct } from '../../../common';
  *     this.vpcManager.createVpc('MyVPC', this)
  *   }
  * }
- *
  * @see [CDK VPC Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.@aws-cdk_aws-ec2.Vpc.html}
  */
 export declare class VpcManager {
     /**
      * @summary Method to create a new vpc
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {ec2.VpcProps} props
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
      */
     createVpc(id: string, scope: CommonConstruct, props: ec2.VpcProps): cdk.aws_ec2.Vpc;
     /**
      * @summary Method to create a common vpc
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {ec2.VpcProps} props
-     * @param {string?} vpcIdentifier optional identifier for VPC
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param vpcIdentifier optional identifier for VPC
      */
     createCommonVpc(scope: CommonConstruct, props: ec2.VpcProps, vpcIdentifier?: string): cdk.aws_ec2.Vpc;
     /**
      * @summary Method to retrieve a common vpc
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {string?} vpcIdentifier optional identifier for VPC
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param vpcIdentifier optional identifier for VPC
      */
     retrieveCommonVpc(id: string, scope: CommonConstruct, vpcIdentifier?: string): cdk.aws_ec2.IVpc;
 }

package/dist/src/lib/services/aws/virtual-private-cloud/main.js

@@ -28,14 +28,9 @@ const cdk = __importStar(require("aws-cdk-lib"));
 const ec2 = __importStar(require("aws-cdk-lib/aws-ec2"));
 const utils = __importStar(require("../../../utils"));
 /**
- * @stability stable
- * @category cdk-utils.vpc-manager
- * @subcategory Construct
  */
 const CommonVpcIdentifier = 'CommonVpc';
 /**
- * @category cdk-utils.vpc-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS VPC.
  * - 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.
@@ -49,22 +44,21 @@ const CommonVpcIdentifier = 'CommonVpc';
  *     this.vpcManager.createVpc('MyVPC', this)
  *   }
  * }
- *
  * @see [CDK VPC Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.@aws-cdk_aws-ec2.Vpc.html}
  */
 class VpcManager {
     /**
      * @summary Method to create a new vpc
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {ec2.VpcProps} props
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
      */
     createVpc(id, scope, props) {
         if (!props)
             throw `Vpc props undefined for ${id}`;
         const vpc = new ec2.Vpc(scope, `${id}`, {
-            maxAzs: props.maxAzs,
             ipAddresses: props.ipAddresses,
+            maxAzs: props.maxAzs,
         });
         utils.createCfnOutput(`${id}Id`, scope, vpc.vpcId);
         utils.createCfnOutput(`${id}PublicSubnetIds`, scope, vpc.publicSubnets.map(subnet => subnet.subnetId).toString());
@@ -77,9 +71,9 @@ class VpcManager {
     }
     /**
      * @summary Method to create a common vpc
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {ec2.VpcProps} props
-     * @param {string?} vpcIdentifier optional identifier for VPC
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param vpcIdentifier optional identifier for VPC
      */
     createCommonVpc(scope, props, vpcIdentifier) {
         const vpc = this.createVpc(CommonVpcIdentifier, scope, props);
@@ -88,9 +82,9 @@ class VpcManager {
     }
     /**
      * @summary Method to retrieve a common vpc
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {string?} vpcIdentifier optional identifier for VPC
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param vpcIdentifier optional identifier for VPC
      */
     retrieveCommonVpc(id, scope, vpcIdentifier) {
         return ec2.Vpc.fromLookup(scope, `${id}`, { vpcName: vpcIdentifier ?? CommonVpcIdentifier });

package/dist/src/lib/services/aws/web-application-firewall/main.d.ts

@@ -2,9 +2,6 @@ import * as wafv2 from 'aws-cdk-lib/aws-wafv2';
 import { CommonConstruct } from '../../../common';
 import { WafIPSetProps, WafWebACLProps } from './types';
 /**
- * @stability stable
- * @category cdk-utils.waf-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS WAF.
  * - 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.
@@ -18,22 +15,21 @@ import { WafIPSetProps, WafWebACLProps } from './types';
  *     this.wafManager.createWebAcl('MyWebAcl', this)
  *   }
  * }
- *
  * @see [CDK WAF Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_waf-readme.html}
  */
 export declare class WafManager {
     /**
      * @summary Method to create an ip set
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {WafIPSetProps} props
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
      */
     createIpSet(id: string, scope: CommonConstruct, props: WafIPSetProps): wafv2.CfnIPSet;
     /**
      * @summary Method to create a web acl
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {WafWebACLProps} props
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
      */
     createWebAcl(id: string, scope: CommonConstruct, props: WafWebACLProps): wafv2.CfnWebACL;
 }

package/dist/src/lib/services/aws/web-application-firewall/main.js

@@ -27,9 +27,6 @@ exports.WafManager = void 0;
 const wafv2 = __importStar(require("aws-cdk-lib/aws-wafv2"));
 const utils = __importStar(require("../../../utils"));
 /**
- * @stability stable
- * @category cdk-utils.waf-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS WAF.
  * - 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.
@@ -43,24 +40,23 @@ const utils = __importStar(require("../../../utils"));
  *     this.wafManager.createWebAcl('MyWebAcl', this)
  *   }
  * }
- *
  * @see [CDK WAF Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_waf-readme.html}
  */
 class WafManager {
     /**
      * @summary Method to create an ip set
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {WafIPSetProps} props
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
      */
     createIpSet(id, scope, props) {
         if (!props)
             throw `WAF Ip Set props undefined for ${id}`;
         const ipSet = new wafv2.CfnIPSet(scope, `${id}`, {
-            name: scope.isProductionStage() ? props.name : `${props.name}-${scope.props.stage}`,
-            description: `IP Set for ${id} - ${scope.props.stage} stage`,
             addresses: props.addresses,
+            description: `IP Set for ${id} - ${scope.props.stage} stage`,
             ipAddressVersion: props.ipAddressVersion,
+            name: scope.isProductionStage() ? props.name : `${props.name}-${scope.props.stage}`,
             scope: props.scope,
         });
         utils.createCfnOutput(`${id}-ipSetId`, scope, ipSet.attrId);
@@ -69,21 +65,21 @@ class WafManager {
     }
     /**
      * @summary Method to create a web acl
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {WafWebACLProps} props
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
      */
     createWebAcl(id, scope, props) {
         if (!props)
             throw `WAF WebACL props undefined for ${id}`;
         const webAcl = new wafv2.CfnWebACL(scope, `${id}`, {
-            name: scope.isProductionStage() ? props.name : `${props.name}-${scope.props.stage}`,
-            description: `Web Acl for ${id} - ${scope.props.stage} stage`,
             defaultAction: props.defaultAction,
-            scope: props.scope,
-            visibilityConfig: props.visibilityConfig,
+            description: `Web Acl for ${id} - ${scope.props.stage} stage`,
+            name: scope.isProductionStage() ? props.name : `${props.name}-${scope.props.stage}`,
             rules: props.rules,
+            scope: props.scope,
             tags: [{ key: 'service', value: scope.props.name }],
+            visibilityConfig: props.visibilityConfig,
         });
         utils.createCfnOutput(`${id}-webAclId`, scope, webAcl.attrId);
         utils.createCfnOutput(`${id}-webAclArn`, scope, webAcl.attrArn);

package/dist/src/lib/services/aws/web-application-firewall/types.d.ts

@@ -1,13 +1,9 @@
 import { CfnIPSetProps, CfnWebACLProps } from 'aws-cdk-lib/aws-wafv2';
 /**
- * @category cdk-utils.waf-manager
- * @subcategory Properties
  */
 export interface WafIPSetProps extends CfnIPSetProps {
 }
 /**
- * @category cdk-utils.waf-manager
- * @subcategory Properties
  */
 export interface WafWebACLProps extends CfnWebACLProps {
 }

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

@@ -1,6 +1,4 @@
 /**
- * @category cdk-utils.common-stack
- * @subcategory Properties
  */
 export interface TagProps {
     key: string;

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

@@ -1,15 +1,12 @@
 import * as cdk from 'aws-cdk-lib';
 import { CommonConstruct } from '../../common';
 /**
- * @category cdk-utils.utils
  * @summary Helper method to add CloudFormation outputs from the construct
- * @param {string} id scoped id of the resource
- * @param {CommonConstruct} scope scope in which this resource is defined
- * @param {string} id scoped id of the resource
- * @param {string} value the value of the exported output
- * @param {string?} description optional description for the output
- * @param {boolean} overrideId Flag which indicates whether to override the default logical id of the output
- *
- * @return {cdk.CfnOutput} The CloudFormation output
+ * @param id scoped id of the resource
+ * @param scope scope in which this resource is defined
+ * @param value the value of the exported output
+ * @param description optional description for the output
+ * @param overrideId Flag which indicates whether to override the default logical id of the output
+ * @returns The CloudFormation output
  */
 export declare function createCfnOutput(id: string, scope: CommonConstruct, value?: string, description?: string, overrideId?: boolean): cdk.CfnOutput;

package/dist/src/lib/utils/aws/index.js

@@ -27,23 +27,20 @@ exports.createCfnOutput = void 0;
 const cdk = __importStar(require("aws-cdk-lib"));
 const _ = __importStar(require("lodash"));
 /**
- * @category cdk-utils.utils
  * @summary Helper method to add CloudFormation outputs from the construct
- * @param {string} id scoped id of the resource
- * @param {CommonConstruct} scope scope in which this resource is defined
- * @param {string} id scoped id of the resource
- * @param {string} value the value of the exported output
- * @param {string?} description optional description for the output
- * @param {boolean} overrideId Flag which indicates whether to override the default logical id of the output
- *
- * @return {cdk.CfnOutput} The CloudFormation output
+ * @param id scoped id of the resource
+ * @param scope scope in which this resource is defined
+ * @param value the value of the exported output
+ * @param description optional description for the output
+ * @param overrideId Flag which indicates whether to override the default logical id of the output
+ * @returns The CloudFormation output
  */
 function createCfnOutput(id, scope, value, description, overrideId = true) {
     const camelName = _.camelCase(id);
     const output = new cdk.CfnOutput(scope, id, {
+        description,
         exportName: `${scope.props.stackName}-${camelName}`,
         value: value ?? '',
-        description,
     });
     if (overrideId) {
         output.overrideLogicalId(camelName);

package/dist/src/lib/utils/index.d.ts

@@ -1,6 +1,5 @@
 export * from './aws';
 /**
- * @category cdk-utils.utils
  */
 export declare enum LogLevel {
     DEBUG = "DEBUG",
@@ -11,52 +10,46 @@ export declare enum LogLevel {
     CRITICAL = "CRITICAL"
 }
 /**
- * @category cdk-utils.utils
  * @param stage
  */
 export declare const isDevStage: (stage: string) => boolean;
 /**
- * @category cdk-utils.utils
  * @param stage
  */
 export declare const isTestStage: (stage: string) => boolean;
 /**
- * @category cdk-utils.utils
  * @param stage
  */
 export declare const isUatStage: (stage: string) => boolean;
 /**
- * @category cdk-utils.utils
  * @param stage
  */
 export declare const isPrdStage: (stage: string) => boolean;
 /**
- * @category cdk-utils.utils
  * @param error
  */
 export declare function redirectError(error: any): {
-    statusCode: number;
     body: string;
-    isBase64Encoded: boolean;
     headers: {
         'Access-Control-Allow-Origin': string;
     };
-} & {
+    isBase64Encoded: boolean;
     statusCode: number;
+} & {
     body: string;
+    statusCode: number;
 };
 /**
- * @category cdk-utils.utils
  * @param message
  */
 export declare function redirectSuccess(message: any): {
-    statusCode: number;
     body: string;
-    isBase64Encoded: boolean;
     headers: {
         'Access-Control-Allow-Origin': string;
     };
-} & {
+    isBase64Encoded: boolean;
     statusCode: number;
+} & {
     body: string;
+    statusCode: number;
 };

package/dist/src/lib/utils/index.js

@@ -17,18 +17,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.redirectSuccess = exports.redirectError = exports.isPrdStage = exports.isUatStage = exports.isTestStage = exports.isDevStage = exports.LogLevel = void 0;
 __exportStar(require("./aws"), exports);
 /**
- * @category cdk-utils.utils
  */
 const defaultResponseObject = {
-    statusCode: 200,
     body: '',
-    isBase64Encoded: false,
     headers: {
         'Access-Control-Allow-Origin': '*',
     },
+    isBase64Encoded: false,
+    statusCode: 200,
 };
 /**
- * @category cdk-utils.utils
  */
 var LogLevel;
 (function (LogLevel) {
@@ -40,49 +38,43 @@ var LogLevel;
     LogLevel["CRITICAL"] = "CRITICAL";
 })(LogLevel || (exports.LogLevel = LogLevel = {}));
 /**
- * @category cdk-utils.utils
  * @param stage
  */
 const isDevStage = (stage) => stage === 'dev';
 exports.isDevStage = isDevStage;
 /**
- * @category cdk-utils.utils
  * @param stage
  */
 const isTestStage = (stage) => stage === 'tst';
 exports.isTestStage = isTestStage;
 /**
- * @category cdk-utils.utils
  * @param stage
  */
 const isUatStage = (stage) => stage === 'uat';
 exports.isUatStage = isUatStage;
 /**
- * @category cdk-utils.utils
  * @param stage
  */
 const isPrdStage = (stage) => stage === 'prd';
 exports.isPrdStage = isPrdStage;
 /**
- * @category cdk-utils.utils
  * @param error
  */
 function redirectError(error) {
     console.error(error, error.message, error.stack);
     return Object.assign({}, defaultResponseObject, {
+        body: JSON.stringify(Object.assign({}, { error: error.message, success: false })),
         statusCode: 500,
-        body: JSON.stringify(Object.assign({}, { success: false, error: error.message })),
     });
 }
 exports.redirectError = redirectError;
 /**
- * @category cdk-utils.utils
  * @param message
  */
 function redirectSuccess(message) {
     return Object.assign({}, defaultResponseObject, {
+        body: JSON.stringify(Object.assign({}, { error: message, success: true })),
         statusCode: 200,
-        body: JSON.stringify(Object.assign({}, { success: true, error: message })),
     });
 }
 exports.redirectSuccess = redirectSuccess;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils",
-  "version": "8.91.0",
+  "version": "8.92.0",
   "description": "Utilities for AWS CDK provisioning",
   "main": "dist/index.js",
   "engines": {

package/src/lib/common/construct.ts

@@ -5,11 +5,8 @@ import * as utils from '../utils'
 import { CommonStackProps } from './types'
 
 /**
- * @stability stable
- * @category cdk-utils.common-construct
  * @subcategory Construct
  * @classdesc Common construct to use as a base for all higher level constructs.
- *
  * @example
  * import { CommonConstruct } from '@gradientedge/cdk-utils';
  *
@@ -92,10 +89,10 @@ export class CommonConstruct extends Construct {
 
   /**
    * @summary Helper method to add CloudFormation outputs from the construct
-   * @param {string} id scoped id of the resource
-   * @param {string} value the value of the exported output
-   * @param {string?} description optional description for the output
-   * @param {boolean} overrideId Flag which indicates whether to override the default logical id of the output
+   * @param id scoped id of the resource
+   * @param value the value of the exported output
+   * @param description optional description for the output
+   * @param overrideId Flag which indicates whether to override the default logical id of the output
    */
   protected addCfnOutput(id: string, value: string, description?: string, overrideId = true): cdk.CfnOutput {
     return utils.createCfnOutput(id, this, value, description, overrideId)

package/src/lib/common/stack.ts

@@ -8,11 +8,7 @@ const appRoot = require('app-root-path')
 const fs = require('fs')
 
 /**
- * @stability stable
- * @category cdk-utils.common-stack
- * @subcategory Construct
  * @classdesc Common stack to use as a base for all higher level constructs.
- *
  * @example
  * import { CommonStack } from '@gradientedge/cdk-utils'
  *
@@ -46,22 +42,22 @@ export class CommonStack extends cdk.Stack {
 
   /**
    * @summary Method to determine the core CDK construct properties injected via context cdk.json
-   * @param {cdk.StackProps} props The stack properties
-   * @return The stack properties
+   * @param props The stack properties
+   * @returns The stack properties
    */
   protected determineConstructProps(props: cdk.StackProps) {
     return {
-      stackName: props.stackName,
-      name: props.stackName || 'cdk-utils',
-      region: this.node.tryGetContext('region'),
-      stage: this.node.tryGetContext('stage'),
       domainName: this.node.tryGetContext('domainName'),
-      subDomain: this.node.tryGetContext('subDomain'),
+      excludeDomainNameForBuckets: this.node.tryGetContext('excludeDomainNameForBuckets'),
       extraContexts: this.node.tryGetContext('extraContexts'),
-      skipStageForARecords: this.node.tryGetContext('skipStageForARecords'),
       logRetention: this.node.tryGetContext('logRetention'),
-      excludeDomainNameForBuckets: this.node.tryGetContext('excludeDomainNameForBuckets'),
+      name: props.stackName || 'cdk-utils',
       nodejsRuntime: this.node.tryGetContext('nodejsRuntime') ?? CommonStack.NODEJS_RUNTIME,
+      region: this.node.tryGetContext('region'),
+      skipStageForARecords: this.node.tryGetContext('skipStageForARecords'),
+      stackName: props.stackName,
+      stage: this.node.tryGetContext('stage'),
+      subDomain: this.node.tryGetContext('subDomain'),
     }
   }
 

package/src/lib/common/types.ts

@@ -3,8 +3,6 @@ import { Runtime, Tracing } from 'aws-cdk-lib/aws-lambda'
 import { RetentionDays } from 'aws-cdk-lib/aws-logs'
 
 /**
- * @category cdk-utils.common-stack
- * @subcategory Properties
  */
 export interface CommonStackProps extends cdk.StackProps {
   name: string

package/src/lib/construct/api-to-eventbridge-target/api.ts

@@ -7,9 +7,6 @@ import * as sns from 'aws-cdk-lib/aws-sns'
 import { ApiToEventBridgeTargetRestApiType } from './types'
 
 /**
- * @stability stable
- * @category cdk-utils.api-to-eventbridge-target
- * @subcategory member
  * @classdesc Provides a construct to contain api resources for ApiToEventBridgeTargetWithSns
  */
 export class ApiToEventbridgeTargetRestApi implements ApiToEventBridgeTargetRestApiType {

package/src/lib/construct/api-to-eventbridge-target/event.ts

@@ -3,9 +3,6 @@ import * as logs from 'aws-cdk-lib/aws-logs'
 import { ApiToEventBridgeTargetEventType } from './types'
 
 /**
- * @stability stable
- * @category cdk-utils.api-to-eventbridge-target
- * @subcategory member
  * @classdesc Provides a construct to contain event resources for ApiToEventBridgeTargetWithSns
  */
 export class ApiToEventbridgeTargetEvent implements ApiToEventBridgeTargetEventType {