@gradientedge/cdk-utils 8.118.0 → 8.120.0

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

@@ -1,7 +1,12 @@
-import * as ssm from 'aws-cdk-lib/aws-ssm'
-import * as cr from 'aws-cdk-lib/custom-resources'
-import * as utils from '../../../utils'
-import { CommonConstruct } from '../../../common'
+import { StringParameter, StringParameterProps } from 'aws-cdk-lib/aws-ssm'
+import {
+  AwsCustomResource,
+  AwsCustomResourcePolicy,
+  AwsSdkCall,
+  PhysicalResourceId,
+} from 'aws-cdk-lib/custom-resources'
+import { CommonConstruct } from '../../common'
+import { createCfnOutput } from '../../utils'
 import { SSMParameterReaderProps } from './types'
 
 /**
@@ -29,17 +34,17 @@ export class SsmManager {
    * @param scope scope in which this resource is defined
    * @param props parameter props
    */
-  public writeStringToParameters(id: string, scope: CommonConstruct, props: ssm.StringParameterProps) {
+  public writeStringToParameters(id: string, scope: CommonConstruct, props: StringParameterProps) {
     if (!props) throw `Parameter props undefined for ${id}`
 
-    const parameter = new ssm.StringParameter(scope, `${id}`, {
+    const parameter = new StringParameter(scope, `${id}`, {
       description: `${props.description} - ${scope.props.stage} stage`,
       parameterName: `${props.parameterName}-${scope.props.stage}`,
       stringValue: props.stringValue,
     })
 
-    utils.createCfnOutput(`${id}-parameterArn`, scope, parameter.parameterArn)
-    utils.createCfnOutput(`${id}-parameterName`, scope, parameter.parameterName)
+    createCfnOutput(`${id}-parameterArn`, scope, parameter.parameterArn)
+    createCfnOutput(`${id}-parameterName`, scope, parameter.parameterName)
 
     return parameter
   }
@@ -53,7 +58,7 @@ export class SsmManager {
   public readStringParameter(id: string, scope: CommonConstruct, parameterName: string) {
     if (!parameterName || parameterName == '') throw 'Invalid parameter name'
 
-    return ssm.StringParameter.valueFromLookup(scope, parameterName)
+    return StringParameter.valueFromLookup(scope, parameterName)
   }
 
   /**
@@ -77,23 +82,23 @@ export class SsmManager {
 /**
  * @classdesc Provides utilities to read same/cross region SSM parameters
  */
-export class SSMParameterReader extends cr.AwsCustomResource {
+export class SSMParameterReader extends AwsCustomResource {
   constructor(scope: CommonConstruct, name: string, props: SSMParameterReaderProps) {
     const { parameterName, region } = props
 
-    const ssmAwsSdkCall: cr.AwsSdkCall = {
+    const ssmAwsSdkCall: AwsSdkCall = {
       action: 'getParameter',
       parameters: {
         Name: `${parameterName}-${scope.props.stage}`,
       },
-      physicalResourceId: cr.PhysicalResourceId.of(Date.now().toString()),
+      physicalResourceId: PhysicalResourceId.of(Date.now().toString()),
       region,
       service: 'SSM',
     }
 
     super(scope, name, {
       onUpdate: ssmAwsSdkCall,
-      policy: cr.AwsCustomResourcePolicy.fromSdkCalls({ resources: cr.AwsCustomResourcePolicy.ANY_RESOURCE }),
+      policy: AwsCustomResourcePolicy.fromSdkCalls({ resources: AwsCustomResourcePolicy.ANY_RESOURCE }),
     })
   }
 

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

@@ -1,7 +1,7 @@
-import * as cdk from 'aws-cdk-lib'
-import * as ec2 from 'aws-cdk-lib/aws-ec2'
-import * as utils from '../../../utils'
-import { CommonConstruct } from '../../../common'
+import { Tags } from 'aws-cdk-lib'
+import { Vpc, VpcProps } from 'aws-cdk-lib/aws-ec2'
+import { CommonConstruct } from '../../common'
+import { createCfnOutput } from '../../utils'
 
 /**
  */
@@ -21,7 +21,7 @@ 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}
+ * @see [CDK VPC Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.@aws-cdk_aws-Vpc.html}
  */
 export class VpcManager {
   /**
@@ -30,28 +30,28 @@ export class VpcManager {
    * @param scope scope in which this resource is defined
    * @param props
    */
-  public createVpc(id: string, scope: CommonConstruct, props: ec2.VpcProps) {
+  public createVpc(id: string, scope: CommonConstruct, props: VpcProps) {
     if (!props) throw `Vpc props undefined for ${id}`
-    const vpc = new ec2.Vpc(scope, `${id}`, {
+    const vpc = new Vpc(scope, `${id}`, {
       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())
-    utils.createCfnOutput(`${id}PrivateSubnetIds`, scope, vpc.privateSubnets.map(subnet => subnet.subnetId).toString())
-    utils.createCfnOutput(
+    createCfnOutput(`${id}Id`, scope, vpc.vpcId)
+    createCfnOutput(`${id}PublicSubnetIds`, scope, vpc.publicSubnets.map(subnet => subnet.subnetId).toString())
+    createCfnOutput(`${id}PrivateSubnetIds`, scope, vpc.privateSubnets.map(subnet => subnet.subnetId).toString())
+    createCfnOutput(
       `${id}PublicSubnetRouteTableIds`,
       scope,
       vpc.publicSubnets.map(subnet => subnet.routeTable.routeTableId).toString()
     )
-    utils.createCfnOutput(
+    createCfnOutput(
       `${id}PrivateSubnetRouteTableIds`,
       scope,
       vpc.privateSubnets.map(subnet => subnet.routeTable.routeTableId).toString()
     )
-    utils.createCfnOutput(`${id}AvailabilityZones`, scope, vpc.availabilityZones.toString())
-    utils.createCfnOutput(`${id}DefaultSecurityGroup`, scope, vpc.vpcDefaultSecurityGroup.toString())
+    createCfnOutput(`${id}AvailabilityZones`, scope, vpc.availabilityZones.toString())
+    createCfnOutput(`${id}DefaultSecurityGroup`, scope, vpc.vpcDefaultSecurityGroup.toString())
 
     return vpc
   }
@@ -62,9 +62,9 @@ export class VpcManager {
    * @param props
    * @param vpcIdentifier optional identifier for VPC
    */
-  public createCommonVpc(scope: CommonConstruct, props: ec2.VpcProps, vpcIdentifier?: string) {
+  public createCommonVpc(scope: CommonConstruct, props: VpcProps, vpcIdentifier?: string) {
     const vpc = this.createVpc(CommonVpcIdentifier, scope, props)
-    cdk.Tags.of(vpc).add('Name', vpcIdentifier ?? CommonVpcIdentifier)
+    Tags.of(vpc).add('Name', vpcIdentifier ?? CommonVpcIdentifier)
 
     return vpc
   }
@@ -76,6 +76,6 @@ export class VpcManager {
    * @param vpcIdentifier optional identifier for VPC
    */
   public retrieveCommonVpc(id: string, scope: CommonConstruct, vpcIdentifier?: string) {
-    return ec2.Vpc.fromLookup(scope, `${id}`, { vpcName: vpcIdentifier ?? CommonVpcIdentifier })
+    return Vpc.fromLookup(scope, `${id}`, { vpcName: vpcIdentifier ?? CommonVpcIdentifier })
   }
 }

package/src/lib/services/{aws/web-application-firewall → web-application-firewall}/main.ts

@@ -1,6 +1,6 @@
-import * as wafv2 from 'aws-cdk-lib/aws-wafv2'
-import * as utils from '../../../utils'
-import { CommonConstruct } from '../../../common'
+import { CfnIPSet, CfnWebACL } from 'aws-cdk-lib/aws-wafv2'
+import { CommonConstruct } from '../../common'
+import { createCfnOutput } from '../../utils'
 import { WafIPSetProps, WafWebACLProps } from './types'
 
 /**
@@ -29,7 +29,7 @@ export class WafManager {
   public createIpSet(id: string, scope: CommonConstruct, props: WafIPSetProps) {
     if (!props) throw `WAF Ip Set props undefined for ${id}`
 
-    const ipSet = new wafv2.CfnIPSet(scope, `${id}`, {
+    const ipSet = new CfnIPSet(scope, `${id}`, {
       addresses: props.addresses,
       description: `IP Set for ${id} - ${scope.props.stage} stage`,
       ipAddressVersion: props.ipAddressVersion,
@@ -37,8 +37,8 @@ export class WafManager {
       scope: props.scope,
     })
 
-    utils.createCfnOutput(`${id}-ipSetId`, scope, ipSet.attrId)
-    utils.createCfnOutput(`${id}-ipSetArn`, scope, ipSet.attrArn)
+    createCfnOutput(`${id}-ipSetId`, scope, ipSet.attrId)
+    createCfnOutput(`${id}-ipSetArn`, scope, ipSet.attrArn)
 
     return ipSet
   }
@@ -52,7 +52,7 @@ export class WafManager {
   public createWebAcl(id: string, scope: CommonConstruct, props: WafWebACLProps) {
     if (!props) throw `WAF WebACL props undefined for ${id}`
 
-    const webAcl = new wafv2.CfnWebACL(scope, `${id}`, {
+    const webAcl = new CfnWebACL(scope, `${id}`, {
       defaultAction: props.defaultAction,
       description: `Web Acl for ${id} - ${scope.props.stage} stage`,
       name: scope.isProductionStage() ? props.name : `${props.name}-${scope.props.stage}`,
@@ -62,8 +62,8 @@ export class WafManager {
       visibilityConfig: props.visibilityConfig,
     })
 
-    utils.createCfnOutput(`${id}-webAclId`, scope, webAcl.attrId)
-    utils.createCfnOutput(`${id}-webAclArn`, scope, webAcl.attrArn)
+    createCfnOutput(`${id}-webAclId`, scope, webAcl.attrId)
+    createCfnOutput(`${id}-webAclArn`, scope, webAcl.attrArn)
 
     return webAcl
   }

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

@@ -1,8 +1,8 @@
-import * as cdk from 'aws-cdk-lib'
-import * as _ from 'lodash'
-import { CommonConstruct } from '../../common'
 import { fromEnv, fromIni } from '@aws-sdk/credential-providers'
 import { AwsCredentialIdentityProvider } from '@aws-sdk/types'
+import { CfnOutput } from 'aws-cdk-lib'
+import _ from 'lodash'
+import { CommonConstruct } from '../../common'
 
 /**
  * @summary Helper method to add CloudFormation outputs from the construct
@@ -19,9 +19,9 @@ export function createCfnOutput(
   value?: string,
   description?: string,
   overrideId = true
-): cdk.CfnOutput {
+): CfnOutput {
   const camelName = _.camelCase(id)
-  const output = new cdk.CfnOutput(scope, id, {
+  const output = new CfnOutput(scope, id, {
     description,
     exportName: `${scope.props.stackName}-${camelName}`,
     value: value ?? '',
@@ -32,6 +32,9 @@ export function createCfnOutput(
   return output
 }
 
+/**
+ *
+ */
 export function determineCredentials(): AwsCredentialIdentityProvider {
   if (process.env.AWS_PROFILE) return fromIni()
   return fromEnv()

package/dist/src/lib/services/aws/api-gateway/types.d.ts

@@ -1,7 +0,0 @@
-import { TagProps } from '../../../types';
-import * as apig from 'aws-cdk-lib/aws-apigateway';
-/**
- */
-export interface LambdaRestApiProps extends apig.LambdaRestApiProps {
-    tags?: TagProps[];
-}

package/dist/src/lib/services/aws/elastic-container-registry/main.js

@@ -1,60 +0,0 @@
-"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EcrManager = void 0;
-const ecr = __importStar(require("aws-cdk-lib/aws-ecr-assets"));
-const utils = __importStar(require("../../../utils"));
-/**
- * @classdesc Provides operations on AWS Elastic Container Registry.
- * - 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.ecrManager.createDockerImage('MyImage', this, dockerfilePath)
- *   }
- * }
- * @see [CDK ECR Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecr-readme.html}
- */
-class EcrManager {
-    /**
-     * @summary Method to create a docker image in ecr
-     * @param id scoped id of the resource
-     * @param scope scope in which this resource is defined
-     * @param dockerfilePath
-     */
-    createDockerImage(id, scope, dockerfilePath) {
-        const asset = new ecr.DockerImageAsset(scope, `${id}`, {
-            directory: dockerfilePath,
-        });
-        utils.createCfnOutput(`${id}-dockerImageArn`, scope, asset.imageUri);
-        return asset;
-    }
-}
-exports.EcrManager = EcrManager;

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

@@ -1,28 +0,0 @@
-export * from './api-gateway';
-export * from './appconfig';
-export * from './certificate-manager';
-export * from './cloudfront';
-export * from './cloudtrail';
-export * from './cloudwatch';
-export * from './codebuild';
-export * from './constants';
-export * from './dynamodb';
-export * from './elastic-container-registry';
-export * from './elastic-container-service';
-export * from './elastic-file-system';
-export * from './elastic-kubernetes-service';
-export * from './elasticache';
-export * from './eventbridge';
-export * from './evidently';
-export * from './identity-access-management';
-export * from './key-management-service';
-export * from './lambda';
-export * from './route53';
-export * from './secrets-manager';
-export * from './simple-notification-service';
-export * from './simple-queue-service';
-export * from './simple-storage-service';
-export * from './step-function';
-export * from './systems-manager';
-export * from './virtual-private-cloud';
-export * from './web-application-firewall';

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

@@ -1,44 +0,0 @@
-"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("./api-gateway"), exports);
-__exportStar(require("./appconfig"), exports);
-__exportStar(require("./certificate-manager"), exports);
-__exportStar(require("./cloudfront"), exports);
-__exportStar(require("./cloudtrail"), exports);
-__exportStar(require("./cloudwatch"), exports);
-__exportStar(require("./codebuild"), exports);
-__exportStar(require("./constants"), exports);
-__exportStar(require("./dynamodb"), exports);
-__exportStar(require("./elastic-container-registry"), exports);
-__exportStar(require("./elastic-container-service"), exports);
-__exportStar(require("./elastic-file-system"), exports);
-__exportStar(require("./elastic-kubernetes-service"), exports);
-__exportStar(require("./elasticache"), exports);
-__exportStar(require("./eventbridge"), exports);
-__exportStar(require("./evidently"), exports);
-__exportStar(require("./identity-access-management"), exports);
-__exportStar(require("./key-management-service"), exports);
-__exportStar(require("./lambda"), exports);
-__exportStar(require("./route53"), exports);
-__exportStar(require("./secrets-manager"), exports);
-__exportStar(require("./simple-notification-service"), exports);
-__exportStar(require("./simple-queue-service"), exports);
-__exportStar(require("./simple-storage-service"), exports);
-__exportStar(require("./step-function"), exports);
-__exportStar(require("./systems-manager"), exports);
-__exportStar(require("./virtual-private-cloud"), exports);
-__exportStar(require("./web-application-firewall"), exports);

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

@@ -1,93 +0,0 @@
-"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-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 CommonVpcIdentifier = 'CommonVpc';
-/**
- * @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.
- * @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.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 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}`, {
-            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());
-        utils.createCfnOutput(`${id}PrivateSubnetIds`, scope, vpc.privateSubnets.map(subnet => subnet.subnetId).toString());
-        utils.createCfnOutput(`${id}PublicSubnetRouteTableIds`, scope, vpc.publicSubnets.map(subnet => subnet.routeTable.routeTableId).toString());
-        utils.createCfnOutput(`${id}PrivateSubnetRouteTableIds`, scope, vpc.privateSubnets.map(subnet => subnet.routeTable.routeTableId).toString());
-        utils.createCfnOutput(`${id}AvailabilityZones`, scope, vpc.availabilityZones.toString());
-        utils.createCfnOutput(`${id}DefaultSecurityGroup`, scope, vpc.vpcDefaultSecurityGroup.toString());
-        return vpc;
-    }
-    /**
-     * @summary Method to create a common 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);
-        cdk.Tags.of(vpc).add('Name', vpcIdentifier ?? CommonVpcIdentifier);
-        return vpc;
-    }
-    /**
-     * @summary Method to retrieve a common 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 });
-    }
-}
-exports.VpcManager = VpcManager;

package/src/lib/services/aws/api-gateway/types.ts

@@ -1,8 +0,0 @@
-import { TagProps } from '../../../types'
-import * as apig from 'aws-cdk-lib/aws-apigateway'
-
-/**
- */
-export interface LambdaRestApiProps extends apig.LambdaRestApiProps {
-  tags?: TagProps[]
-}

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

@@ -1,28 +0,0 @@
-export * from './api-gateway'
-export * from './appconfig'
-export * from './certificate-manager'
-export * from './cloudfront'
-export * from './cloudtrail'
-export * from './cloudwatch'
-export * from './codebuild'
-export * from './constants'
-export * from './dynamodb'
-export * from './elastic-container-registry'
-export * from './elastic-container-service'
-export * from './elastic-file-system'
-export * from './elastic-kubernetes-service'
-export * from './elasticache'
-export * from './eventbridge'
-export * from './evidently'
-export * from './identity-access-management'
-export * from './key-management-service'
-export * from './lambda'
-export * from './route53'
-export * from './secrets-manager'
-export * from './simple-notification-service'
-export * from './simple-queue-service'
-export * from './simple-storage-service'
-export * from './step-function'
-export * from './systems-manager'
-export * from './virtual-private-cloud'
-export * from './web-application-firewall'