@gradientedge/cdk-utils 8.88.0 → 8.90.0

package/dist/src/lib/services/aws/step-function/types.d.ts

@@ -0,0 +1,120 @@
+import { ChoiceProps, FailProps, MapProps, ParallelProps, PassProps, RetryProps, StateMachineProps, SucceedProps, WaitProps } from 'aws-cdk-lib/aws-stepfunctions';
+import { CallApiGatewayRestApiEndpointProps, DynamoDeleteItemProps, DynamoGetItemProps, DynamoPutItemProps, LambdaInvokeProps, SqsSendMessageProps, StepFunctionsStartExecutionProps } from 'aws-cdk-lib/aws-stepfunctions-tasks';
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnSucceedProps extends SucceedProps {
+    name: string;
+}
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnRetryProps extends RetryProps {
+    intervalInSecs: number;
+}
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnFailProps extends FailProps {
+    name: string;
+}
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnPassProps extends PassProps {
+    name: string;
+}
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnDynamoGetItemProps extends DynamoGetItemProps {
+    name: string;
+    retries?: SfnRetryProps[];
+}
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnDynamoPutItemProps extends DynamoPutItemProps {
+    name: string;
+    retries?: SfnRetryProps[];
+}
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnDynamoDeleteItemProps extends DynamoDeleteItemProps {
+    name: string;
+    retries?: SfnRetryProps[];
+}
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnSqsSendMessageProps extends SqsSendMessageProps {
+    name: string;
+    retries?: SfnRetryProps[];
+}
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnParallelProps extends ParallelProps {
+    name: string;
+    retries?: SfnRetryProps[];
+}
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnChoiceProps extends ChoiceProps {
+    name: string;
+}
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnWaitProps extends WaitProps {
+    name: string;
+    delayInSeconds: number;
+}
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnLambdaInvokeProps extends LambdaInvokeProps {
+    name: string;
+    retries?: SfnRetryProps[];
+}
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnCallApiGatewayRestApiEndpointProps extends CallApiGatewayRestApiEndpointProps {
+    name: string;
+    retries?: SfnRetryProps[];
+}
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnStateMachineProps extends StateMachineProps {
+}
+/**
+ * @category cdk-utils.sfn-manager
+ * @subcategory Properties
+ */
+export interface SfnMapProps extends MapProps {
+}
+/**
+ * @category cdk-utils.sfn-manager
+ * @subcategory Properties
+ */
+export interface SfnStartExecutionProps extends StepFunctionsStartExecutionProps {
+    retries?: SfnRetryProps[];
+}

package/dist/src/lib/services/aws/step-function/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/lib/services/aws/systems-manager/index.d.ts

@@ -0,0 +1,2 @@
+export * from './main';
+export * from './types';

package/dist/src/lib/services/aws/systems-manager/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./main"), exports);
+__exportStar(require("./types"), exports);

package/dist/src/lib/{manager/aws/ssm-manager.d.ts → services/aws/systems-manager/main.d.ts}

@@ -1,18 +1,18 @@
 import * as ssm from 'aws-cdk-lib/aws-ssm';
 import * as cr from 'aws-cdk-lib/custom-resources';
-import * as common from '../../common';
-import * as types from '../../types';
+import { CommonConstruct } from '../../../common';
+import { SSMParameterReaderProps } from './types';
 /**
  * @stability stable
  * @category cdk-utils.ssm-manager
  * @subcategory Construct
  * @classdesc Provides operations on AWS Systems Manager.
- * - 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.
+ * - 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.
  * @example
- * import { common.CommonConstruct } from '@gradientedge/cdk-utils'
+ * import { CommonConstruct } from '@gradientedge/cdk-utils'
  *
- * class CustomConstruct extends common.CommonConstruct {
+ * class CustomConstruct extends CommonConstruct {
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
@@ -27,25 +27,25 @@ export declare class SsmManager {
     /**
      * Method to write a string parameter to the parameters store
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {CommonConstruct} scope scope in which this resource is defined
      * @param {ssm.StringParameterProps} props parameter props
      */
-    writeStringToParameters(id: string, scope: common.CommonConstruct, props: ssm.StringParameterProps): ssm.StringParameter;
+    writeStringToParameters(id: string, scope: CommonConstruct, props: ssm.StringParameterProps): ssm.StringParameter;
     /**
      * Method to read a string parameter from the parameters store
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {CommonConstruct} scope scope in which this resource is defined
      * @param {string} parameterName parameter name to lookup
      */
-    readStringParameter(id: string, scope: common.CommonConstruct, parameterName: string): string;
+    readStringParameter(id: string, scope: CommonConstruct, parameterName: string): string;
     /**
      * Method to read a string parameter from the parameters store in a given region
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {CommonConstruct} scope scope in which this resource is defined
      * @param {string} parameterName parameter name to lookup
      * @param {string} region region name to lookup parameter
      */
-    readStringParameterFromRegion(id: string, scope: common.CommonConstruct, parameterName: string, region: string): string;
+    readStringParameterFromRegion(id: string, scope: CommonConstruct, parameterName: string, region: string): string;
 }
 /**
  * @category cdk-utils.ssm-manager
@@ -53,7 +53,7 @@ export declare class SsmManager {
  * @classdesc Provides utilities to read same/cross region SSM parameters
  */
 export declare class SSMParameterReader extends cr.AwsCustomResource {
-    constructor(scope: common.CommonConstruct, name: string, props: types.SSMParameterReaderProps);
+    constructor(scope: CommonConstruct, name: string, props: SSMParameterReaderProps);
     /**
      *
      */

package/dist/src/lib/{manager/aws/ssm-manager.js → services/aws/systems-manager/main.js}

@@ -26,18 +26,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SSMParameterReader = exports.SsmManager = void 0;
 const ssm = __importStar(require("aws-cdk-lib/aws-ssm"));
 const cr = __importStar(require("aws-cdk-lib/custom-resources"));
-const utils = __importStar(require("../../utils"));
+const utils = __importStar(require("../../../utils"));
 /**
  * @stability stable
  * @category cdk-utils.ssm-manager
  * @subcategory Construct
  * @classdesc Provides operations on AWS Systems Manager.
- * - 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.
+ * - 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.
  * @example
- * import { common.CommonConstruct } from '@gradientedge/cdk-utils'
+ * import { CommonConstruct } from '@gradientedge/cdk-utils'
  *
- * class CustomConstruct extends common.CommonConstruct {
+ * class CustomConstruct extends CommonConstruct {
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
@@ -52,7 +52,7 @@ class SsmManager {
     /**
      * Method to write a string parameter to the parameters store
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {CommonConstruct} scope scope in which this resource is defined
      * @param {ssm.StringParameterProps} props parameter props
      */
     writeStringToParameters(id, scope, props) {
@@ -70,7 +70,7 @@ class SsmManager {
     /**
      * Method to read a string parameter from the parameters store
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {CommonConstruct} scope scope in which this resource is defined
      * @param {string} parameterName parameter name to lookup
      */
     readStringParameter(id, scope, parameterName) {
@@ -81,7 +81,7 @@ class SsmManager {
     /**
      * Method to read a string parameter from the parameters store in a given region
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {CommonConstruct} scope scope in which this resource is defined
      * @param {string} parameterName parameter name to lookup
      * @param {string} region region name to lookup parameter
      */

package/dist/src/lib/services/aws/systems-manager/types.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @category cdk-utils.ssm-manager
+ * @subcategory Properties
+ */
+export interface SSMParameterReaderProps {
+    parameterName: string;
+    region: string;
+}

package/dist/src/lib/services/aws/systems-manager/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1 @@
+export * from './main';

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

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./main"), exports);

package/dist/src/lib/{manager/aws/vpc-manager.d.ts → services/aws/virtual-private-cloud/main.d.ts}

@@ -1,16 +1,16 @@
 import * as cdk from 'aws-cdk-lib';
 import * as ec2 from 'aws-cdk-lib/aws-ec2';
-import * as common from '../../common';
+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 common.CommonConstruct} constructor.
- * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.
+ * - 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.
  * @example
- * import * as common from '@gradientedge/cdk-utils'
+ * import { CommonConstruct } from '@gradientedge/cdk-utils'
  *
- * class CustomConstruct extends common.common.CommonConstruct {
+ * class CustomConstruct extends CommonConstruct {
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
@@ -24,22 +24,22 @@ export declare class VpcManager {
     /**
      * @summary Method to create a new vpc
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {CommonConstruct} scope scope in which this resource is defined
      * @param {ec2.VpcProps} props
      */
-    createVpc(id: string, scope: common.CommonConstruct, props: ec2.VpcProps): cdk.aws_ec2.Vpc;
+    createVpc(id: string, scope: CommonConstruct, props: ec2.VpcProps): cdk.aws_ec2.Vpc;
     /**
      * @summary Method to create a common vpc
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {CommonConstruct} scope scope in which this resource is defined
      * @param {ec2.VpcProps} props
      * @param {string?} vpcIdentifier optional identifier for VPC
      */
-    createCommonVpc(scope: common.CommonConstruct, props: ec2.VpcProps, vpcIdentifier?: string): cdk.aws_ec2.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 {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {CommonConstruct} scope scope in which this resource is defined
      * @param {string?} vpcIdentifier optional identifier for VPC
      */
-    retrieveCommonVpc(id: string, scope: common.CommonConstruct, vpcIdentifier?: string): cdk.aws_ec2.IVpc;
+    retrieveCommonVpc(id: string, scope: CommonConstruct, vpcIdentifier?: string): cdk.aws_ec2.IVpc;
 }

package/dist/src/lib/{manager/aws/vpc-manager.js → services/aws/virtual-private-cloud/main.js}

@@ -26,7 +26,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.VpcManager = void 0;
 const cdk = __importStar(require("aws-cdk-lib"));
 const ec2 = __importStar(require("aws-cdk-lib/aws-ec2"));
-const utils = __importStar(require("../../utils"));
+const utils = __importStar(require("../../../utils"));
 /**
  * @stability stable
  * @category cdk-utils.vpc-manager
@@ -37,12 +37,12 @@ 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 common.CommonConstruct} constructor.
- * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.
+ * - 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.
  * @example
- * import * as common from '@gradientedge/cdk-utils'
+ * import { CommonConstruct } from '@gradientedge/cdk-utils'
  *
- * class CustomConstruct extends common.common.CommonConstruct {
+ * class CustomConstruct extends CommonConstruct {
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
@@ -56,7 +56,7 @@ class VpcManager {
     /**
      * @summary Method to create a new vpc
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {CommonConstruct} scope scope in which this resource is defined
      * @param {ec2.VpcProps} props
      */
     createVpc(id, scope, props) {
@@ -77,7 +77,7 @@ class VpcManager {
     }
     /**
      * @summary Method to create a common vpc
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {CommonConstruct} scope scope in which this resource is defined
      * @param {ec2.VpcProps} props
      * @param {string?} vpcIdentifier optional identifier for VPC
      */
@@ -89,7 +89,7 @@ class VpcManager {
     /**
      * @summary Method to retrieve a common vpc
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {CommonConstruct} scope scope in which this resource is defined
      * @param {string?} vpcIdentifier optional identifier for VPC
      */
     retrieveCommonVpc(id, scope, vpcIdentifier) {

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

@@ -0,0 +1 @@
+export * from './main';

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

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./main"), exports);

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

@@ -0,0 +1,39 @@
+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.
+ * @example
+ * import { CommonConstruct } from '@gradientedge/cdk-utils'
+ *
+ * class CustomConstruct extends CommonConstruct {
+ *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     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
+     */
+    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
+     */
+    createWebAcl(id: string, scope: CommonConstruct, props: WafWebACLProps): wafv2.CfnWebACL;
+}

package/dist/src/lib/{manager/aws/waf-manager.js → services/aws/web-application-firewall/main.js}

@@ -25,18 +25,18 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WafManager = void 0;
 const wafv2 = __importStar(require("aws-cdk-lib/aws-wafv2"));
-const utils = __importStar(require("../../utils"));
+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 common.CommonConstruct} constructor.
- * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.
+ * - 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.
  * @example
- * import * as common from '@gradientedge/cdk-utils'
+ * import { CommonConstruct } from '@gradientedge/cdk-utils'
  *
- * class CustomConstruct extends common.common.CommonConstruct {
+ * class CustomConstruct extends CommonConstruct {
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
@@ -50,8 +50,8 @@ class WafManager {
     /**
      * @summary Method to create an ip set
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.WafIPSetProps} props
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {WafIPSetProps} props
      */
     createIpSet(id, scope, props) {
         if (!props)
@@ -70,8 +70,8 @@ class WafManager {
     /**
      * @summary Method to create a web acl
      * @param {string} id scoped id of the resource
-     * @param {common.CommonConstruct} scope scope in which this resource is defined
-     * @param {types.WafWebACLProps} props
+     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param {WafWebACLProps} props
      */
     createWebAcl(id, scope, props) {
         if (!props)

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

@@ -0,0 +1,13 @@
+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/services/aws/web-application-firewall/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });