@gradientedge/cdk-utils 8.118.0 → 8.119.0

package/src/lib/services/aws/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 { 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/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 { 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/main.ts

@@ -1,6 +1,6 @@
-import * as wafv2 from 'aws-cdk-lib/aws-wafv2'
-import * as utils from '../../../utils'
+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()