@gradientedge/cdk-utils 4.2.0 → 4.2.1

package/src/lib/manager/{iamManager.ts → aws/iamManager.ts}

@@ -3,19 +3,19 @@ import * as ecs from 'aws-cdk-lib/aws-ecs'
 import * as iam from 'aws-cdk-lib/aws-iam'
 import * as logs from 'aws-cdk-lib/aws-logs'
 import * as s3 from 'aws-cdk-lib/aws-s3'
-import { CommonConstruct } from '../common/commonConstruct'
-import { createCfnOutput } from '../utils'
+import * as common from '../../common'
+import * as utils from '../../utils'
 
 /**
  * @stability stable
  * @category Security, Identity & Compliance
  * @summary Provides operations on AWS IAM.
- * - 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.
+ * - 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.
  * @example
  * import * as common from '@gradientedge/cdk-utils'
  *
- * class CustomConstruct extends common.CommonConstruct {
+ * class CustomConstruct extends common.common.CommonConstruct {
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
@@ -28,9 +28,9 @@ import { createCfnOutput } from '../utils'
 export class IamManager {
   /**
    * @summary Method to create iam statement to read secrets
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    */
-  public statementForReadSecrets(scope: CommonConstruct) {
+  public statementForReadSecrets(scope: common.CommonConstruct) {
     return new iam.PolicyStatement({
       effect: iam.Effect.ALLOW,
       actions: ['secretsmanager:GetSecretValue'],
@@ -40,9 +40,9 @@ export class IamManager {
 
   /**
    * @summary Method to create iam statement to read app config
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    */
-  public statementForReadAnyAppConfig(scope: CommonConstruct) {
+  public statementForReadAnyAppConfig(scope: common.CommonConstruct) {
     return new iam.PolicyStatement({
       effect: iam.Effect.ALLOW,
       actions: [
@@ -65,10 +65,10 @@ export class IamManager {
 
   /**
    * @summary Method to create iam statement to list s3 buckets
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {s3.IBucket} bucket
    */
-  public statementForListBucket(scope: CommonConstruct, bucket: s3.IBucket) {
+  public statementForListBucket(scope: common.CommonConstruct, bucket: s3.IBucket) {
     return new iam.PolicyStatement({
       effect: iam.Effect.ALLOW,
       actions: ['s3:ListBucket'],
@@ -78,9 +78,9 @@ export class IamManager {
 
   /**
    * @summary Method to create iam statement to list all s3 buckets
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    */
-  public statementForListAllMyBuckets(scope: CommonConstruct) {
+  public statementForListAllMyBuckets(scope: common.CommonConstruct) {
     return new iam.PolicyStatement({
       effect: iam.Effect.ALLOW,
       actions: ['s3:ListAllMyBuckets'],
@@ -90,10 +90,10 @@ export class IamManager {
 
   /**
    * @summary Method to create iam statement to get s3 objects in buckets
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {s3.IBucket} bucket
    */
-  public statementForGetAnyS3Objects(scope: CommonConstruct, bucket: s3.IBucket) {
+  public statementForGetAnyS3Objects(scope: common.CommonConstruct, bucket: s3.IBucket) {
     return new iam.PolicyStatement({
       effect: iam.Effect.ALLOW,
       actions: ['s3:GetObject', 's3:GetObjectAcl'],
@@ -103,10 +103,10 @@ export class IamManager {
 
   /**
    * @summary Method to create iam statement to delete s3 objects in buckets
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {s3.IBucket} bucket
    */
-  public statementForDeleteAnyS3Objects(scope: CommonConstruct, bucket: s3.IBucket) {
+  public statementForDeleteAnyS3Objects(scope: common.CommonConstruct, bucket: s3.IBucket) {
     return new iam.PolicyStatement({
       effect: iam.Effect.ALLOW,
       actions: ['s3:DeleteObject'],
@@ -116,10 +116,10 @@ export class IamManager {
 
   /**
    * @summary Method to create iam statement to write s3 objects in buckets
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {s3.IBucket} bucket
    */
-  public statementForPutAnyS3Objects(scope: CommonConstruct, bucket: s3.IBucket) {
+  public statementForPutAnyS3Objects(scope: common.CommonConstruct, bucket: s3.IBucket) {
     return new iam.PolicyStatement({
       effect: iam.Effect.ALLOW,
       actions: ['s3:PutObject', 's3:PutObjectAcl'],
@@ -129,9 +129,9 @@ export class IamManager {
 
   /**
    * @summary Method to create iam statement to pass iam role
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    */
-  public statementForPassRole(scope: CommonConstruct) {
+  public statementForPassRole(scope: common.CommonConstruct) {
     return new iam.PolicyStatement({
       effect: iam.Effect.ALLOW,
       actions: ['iam:PassRole'],
@@ -141,9 +141,9 @@ export class IamManager {
 
   /**
    * @summary Method to create iam statement to invalidate cloudfront cache
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    */
-  public statementForCloudfrontInvalidation(scope: CommonConstruct) {
+  public statementForCloudfrontInvalidation(scope: common.CommonConstruct) {
     return new iam.PolicyStatement({
       effect: iam.Effect.ALLOW,
       actions: ['cloudfront:GetInvalidation', 'cloudfront:CreateInvalidation'],
@@ -153,9 +153,9 @@ export class IamManager {
 
   /**
    * @summary Method to create iam policy to invalidate cloudfront cache
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    */
-  public policyForCloudfrontInvalidation(scope: CommonConstruct) {
+  public policyForCloudfrontInvalidation(scope: common.CommonConstruct) {
     return new iam.PolicyDocument({
       statements: [
         this.statementForCreateAnyLogStream(),
@@ -178,9 +178,9 @@ export class IamManager {
   /**
    * @summary Method to create iam role to invalidate cloudfront cache
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    */
-  public roleForCloudfrontInvalidation(id: string, scope: CommonConstruct) {
+  public roleForCloudfrontInvalidation(id: string, scope: common.CommonConstruct) {
     return new iam.Role(scope, `${id}-install-deps-project-role`, {
       assumedBy: new iam.ServicePrincipal('codebuild.amazonaws.com'),
       inlinePolicies: {
@@ -191,10 +191,10 @@ export class IamManager {
 
   /**
    * @summary Method to create iam statement to assume iam role
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {iam.ServicePrincipal[]} servicePrincipals
    */
-  public statementForAssumeRole(scope: CommonConstruct, servicePrincipals: iam.ServicePrincipal[]) {
+  public statementForAssumeRole(scope: common.CommonConstruct, servicePrincipals: iam.ServicePrincipal[]) {
     return new iam.PolicyStatement({
       effect: iam.Effect.ALLOW,
       actions: ['sts:AssumeRole'],
@@ -204,9 +204,9 @@ export class IamManager {
 
   /**
    * @summary Method to create iam statement to pass ecs role
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    */
-  public statementForEcsPassRole(scope: CommonConstruct) {
+  public statementForEcsPassRole(scope: common.CommonConstruct) {
     return new iam.PolicyStatement({
       effect: iam.Effect.ALLOW,
       actions: ['iam:PassRole'],
@@ -217,11 +217,11 @@ export class IamManager {
 
   /**
    * @summary Method to create iam statement to run ecs task
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {ecs.ICluster} cluster
    * @param {ecs.ITaskDefinition} task
    */
-  public statementForRunEcsTask(scope: CommonConstruct, cluster: ecs.ICluster, task: ecs.ITaskDefinition) {
+  public statementForRunEcsTask(scope: common.CommonConstruct, cluster: ecs.ICluster, task: ecs.ITaskDefinition) {
     return new iam.PolicyStatement({
       effect: iam.Effect.ALLOW,
       actions: ['ecs:RunTask'],
@@ -232,10 +232,10 @@ export class IamManager {
 
   /**
    * @summary Method to create iam statement to create log stream
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {logs.CfnLogGroup} logGroup
    */
-  public statementForCreateLogStream(scope: CommonConstruct, logGroup: logs.CfnLogGroup) {
+  public statementForCreateLogStream(scope: common.CommonConstruct, logGroup: logs.CfnLogGroup) {
     return new iam.PolicyStatement({
       effect: iam.Effect.ALLOW,
       actions: ['logs:CreateLogStream'],
@@ -261,10 +261,10 @@ export class IamManager {
 
   /**
    * @summary Method to create iam statement to write log events
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {logs.CfnLogGroup} logGroup
    */
-  public statementForPutLogEvent(scope: CommonConstruct, logGroup: logs.CfnLogGroup) {
+  public statementForPutLogEvent(scope: common.CommonConstruct, logGroup: logs.CfnLogGroup) {
     return new iam.PolicyStatement({
       effect: iam.Effect.ALLOW,
       actions: ['logs:PutLogEvents'],
@@ -291,10 +291,10 @@ export class IamManager {
   /**
    * @summary Method to create iam statement for cloud trail
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {logs.CfnLogGroup} logGroup
    */
-  public createRoleForCloudTrail(id: string, scope: CommonConstruct, logGroup: logs.CfnLogGroup) {
+  public createRoleForCloudTrail(id: string, scope: common.CommonConstruct, logGroup: logs.CfnLogGroup) {
     const policy = new iam.PolicyDocument({
       statements: [this.statementForCreateLogStream(scope, logGroup), this.statementForPutLogEvent(scope, logGroup)],
     })
@@ -311,8 +311,8 @@ export class IamManager {
       roleName: `${id}-${scope.props.stage}`,
     })
 
-    createCfnOutput(`${id}Arn`, scope, role.attrArn)
-    createCfnOutput(`${id}Name`, scope, role.roleName)
+    utils.createCfnOutput(`${id}Arn`, scope, role.attrArn)
+    utils.createCfnOutput(`${id}Name`, scope, role.roleName)
 
     return role
   }
@@ -320,11 +320,16 @@ export class IamManager {
   /**
    * @summary Method to create iam statement for ecs event
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {ecs.ICluster} cluster
    * @param {ecs.ITaskDefinition} task
    */
-  public createRoleForEcsEvent(id: string, scope: CommonConstruct, cluster: ecs.ICluster, task: ecs.ITaskDefinition) {
+  public createRoleForEcsEvent(
+    id: string,
+    scope: common.CommonConstruct,
+    cluster: ecs.ICluster,
+    task: ecs.ITaskDefinition
+  ) {
     const policy = new iam.PolicyDocument({
       statements: [this.statementForRunEcsTask(scope, cluster, task), this.statementForEcsPassRole(scope)],
     })
@@ -336,8 +341,8 @@ export class IamManager {
       roleName: `${id}-${scope.props.stage}`,
     })
 
-    createCfnOutput(`${id}Arn`, scope, role.roleArn)
-    createCfnOutput(`${id}Name`, scope, role.roleName)
+    utils.createCfnOutput(`${id}Arn`, scope, role.roleArn)
+    utils.createCfnOutput(`${id}Name`, scope, role.roleName)
 
     return role
   }
@@ -345,10 +350,10 @@ export class IamManager {
   /**
    * @summary Method to create iam statement for ecs execution
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {iam.PolicyDocument} policy
    */
-  public createRoleForEcsExecution(id: string, scope: CommonConstruct, policy: iam.PolicyDocument) {
+  public createRoleForEcsExecution(id: string, scope: common.CommonConstruct, policy: iam.PolicyDocument) {
     const role = new iam.Role(scope, `${id}`, {
       assumedBy: new iam.ServicePrincipal('ecs-tasks.amazonaws.com'),
       description: `Role for ${id} ECS Task execution`,
@@ -363,8 +368,8 @@ export class IamManager {
       roleName: `${id}-${scope.props.stage}`,
     })
 
-    createCfnOutput(`${id}Arn`, scope, role.roleArn)
-    createCfnOutput(`${id}Name`, scope, role.roleName)
+    utils.createCfnOutput(`${id}Arn`, scope, role.roleArn)
+    utils.createCfnOutput(`${id}Name`, scope, role.roleName)
 
     return role
   }
@@ -372,12 +377,18 @@ export class IamManager {
   /**
    * @summary Method to create iam statement for lambda execution
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {iam.PolicyDocument} policy
+   * @param {iam.ServicePrincipal} servicePrinicpal
    */
-  public createRoleForLambda(id: string, scope: CommonConstruct, policy: iam.PolicyDocument) {
+  public createRoleForLambda(
+    id: string,
+    scope: common.CommonConstruct,
+    policy: iam.PolicyDocument,
+    servicePrinicpal?: iam.ServicePrincipal
+  ) {
     const role = new iam.Role(scope, `${id}`, {
-      assumedBy: new iam.ServicePrincipal('lambda.amazonaws.com'),
+      assumedBy: servicePrinicpal ?? new iam.ServicePrincipal('lambda.amazonaws.com'),
       description: `Role for ${id} Lambda function`,
       inlinePolicies: { policy },
       managedPolicies: [
@@ -390,8 +401,8 @@ export class IamManager {
       roleName: `${id}-${scope.props.stage}`,
     })
 
-    createCfnOutput(`${id}Arn`, scope, role.roleArn)
-    createCfnOutput(`${id}Name`, scope, role.roleName)
+    utils.createCfnOutput(`${id}Arn`, scope, role.roleArn)
+    utils.createCfnOutput(`${id}Name`, scope, role.roleName)
 
     return role
   }

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

@@ -0,0 +1,21 @@
+export * from './acmManager'
+export * from './apiManager'
+export * from './appConfigManager'
+export * from './cloudFrontManager'
+export * from './cloudTrailManager'
+export * from './cloudWatchManager'
+export * from './codeBuildManager'
+export * from './ecrManager'
+export * from './ecsManager'
+export * from './eksManager'
+export * from './eventManager'
+export * from './iamManager'
+export * from './lambdaManager'
+export * from './logManager'
+export * from './route53Manager'
+export * from './s3Manager'
+export * from './secretsManager'
+export * from './snsManager'
+export * from './ssmManager'
+export * from './vpcManager'
+export * from './wafManager'

package/src/lib/manager/{lambdaManager.ts → aws/lambdaManager.ts}

@@ -1,24 +1,24 @@
+import * as pylambda from '@aws-cdk/aws-lambda-python-alpha'
 import * as cdk from 'aws-cdk-lib'
 import * as ec2 from 'aws-cdk-lib/aws-ec2'
 import * as efs from 'aws-cdk-lib/aws-efs'
 import * as iam from 'aws-cdk-lib/aws-iam'
 import * as lambda from 'aws-cdk-lib/aws-lambda'
-import * as pylambda from '@aws-cdk/aws-lambda-python-alpha'
-import { CommonConstruct } from '../common/commonConstruct'
-import { LambdaEdgeProps, LambdaProps } from '../types'
-import { createCfnOutput } from '../utils'
+import * as common from '../../common'
+import * as types from '../../types'
+import * as utils from '../../utils'
 import { CloudFrontManager } from './cloudFrontManager'
 
 /**
  * @stability stable
  * @category Compute
  * @summary Provides operations on AWS Lambda.
- * - 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.
+ * - 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.
  * @example
  * import * as common from '@gradientedge/cdk-utils'
  *
- * class CustomConstruct extends common.CommonConstruct {
+ * class CustomConstruct extends common.common.CommonConstruct {
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
@@ -32,10 +32,10 @@ export class LambdaManager {
   /**
    * @summary Method to create a lambda layer (nodejs)
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {lambda.AssetCode} code
    */
-  public createLambdaLayer(id: string, scope: CommonConstruct, code: lambda.AssetCode) {
+  public createLambdaLayer(id: string, scope: common.CommonConstruct, code: lambda.AssetCode) {
     const lambdaLayer = new lambda.LayerVersion(scope, `${id}`, {
       compatibleRuntimes: [lambda.Runtime.NODEJS_14_X],
       code: code,
@@ -43,7 +43,7 @@ export class LambdaManager {
       layerVersionName: `${id}-${scope.props.stage}`,
     })
 
-    createCfnOutput(`${id}-lambdaLayerArn`, scope, lambdaLayer.layerVersionArn)
+    utils.createCfnOutput(`${id}-lambdaLayerArn`, scope, lambdaLayer.layerVersionArn)
 
     return lambdaLayer
   }
@@ -51,10 +51,10 @@ export class LambdaManager {
   /**
    * @summary Method to create a lambda layer (python)
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {string} entry path to layer source
    */
-  public createPythonLambdaLayer(id: string, scope: CommonConstruct, entry: string) {
+  public createPythonLambdaLayer(id: string, scope: common.CommonConstruct, entry: string) {
     const lambdaLayer = new pylambda.PythonLayerVersion(scope, `${id}`, {
       compatibleRuntimes: [lambda.Runtime.PYTHON_3_8],
       description: `${id}`,
@@ -62,7 +62,7 @@ export class LambdaManager {
       layerVersionName: `${id}-${scope.props.stage}`,
     })
 
-    createCfnOutput(`${id}-lambdaLayerArn`, scope, lambdaLayer.layerVersionArn)
+    utils.createCfnOutput(`${id}-lambdaLayerArn`, scope, lambdaLayer.layerVersionArn)
 
     return lambdaLayer
   }
@@ -70,8 +70,8 @@ export class LambdaManager {
   /**
    * @summary Method to create a lambda function (nodejs)
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {LambdaProps} props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.LambdaProps} props
    * @param {iam.Role | iam.CfnRole} role
    * @param {lambda.ILayerVersion[]} layers
    * @param {lambda.AssetCode} code
@@ -84,8 +84,8 @@ export class LambdaManager {
    */
   public createLambdaFunction(
     id: string,
-    scope: CommonConstruct,
-    props: LambdaProps,
+    scope: common.CommonConstruct,
+    props: types.LambdaProps,
     role: iam.Role | iam.CfnRole,
     layers: lambda.ILayerVersion[],
     code: lambda.AssetCode,
@@ -120,8 +120,8 @@ export class LambdaManager {
       vpc: vpc,
     })
 
-    createCfnOutput(`${id}-lambdaArn`, scope, lambdaFunction.functionArn)
-    createCfnOutput(`${id}-lambdaName`, scope, lambdaFunction.functionName)
+    utils.createCfnOutput(`${id}-lambdaArn`, scope, lambdaFunction.functionArn)
+    utils.createCfnOutput(`${id}-lambdaName`, scope, lambdaFunction.functionName)
 
     return lambdaFunction
   }
@@ -129,8 +129,8 @@ export class LambdaManager {
   /**
    * @summary Method to create a lambda function (python)
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {LambdaProps} props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.LambdaProps} props
    * @param {iam.Role | iam.CfnRole} role
    * @param {lambda.ILayerVersion[]} layers
    * @param {string} entry path to lambda source
@@ -145,8 +145,8 @@ export class LambdaManager {
 
   public createPythonLambdaFunction(
     id: string,
-    scope: CommonConstruct,
-    props: LambdaProps,
+    scope: common.CommonConstruct,
+    props: types.LambdaProps,
     role: iam.Role | iam.CfnRole,
     layers: lambda.ILayerVersion[],
     entry: string,
@@ -183,8 +183,8 @@ export class LambdaManager {
       vpc: vpc,
     })
 
-    createCfnOutput(`${id}-lambdaArn`, scope, lambdaFunction.functionArn)
-    createCfnOutput(`${id}-lambdaName`, scope, lambdaFunction.functionName)
+    utils.createCfnOutput(`${id}-lambdaArn`, scope, lambdaFunction.functionArn)
+    utils.createCfnOutput(`${id}-lambdaName`, scope, lambdaFunction.functionName)
 
     return lambdaFunction
   }
@@ -193,8 +193,8 @@ export class LambdaManager {
    * @summary Method to provision a Lambda@Edge function
    *
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {LambdaEdgeProps} props lambda@edge properties
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.LambdaEdgeProps} props lambda@edge properties
    * @param {lambda.ILayerVersion[]} layers
    * @param {lambda.AssetCode} code
    * @param {Map<string, string>} environment
@@ -205,8 +205,8 @@ export class LambdaManager {
    */
   public createEdgeFunction(
     id: string,
-    scope: CommonConstruct,
-    props: LambdaEdgeProps,
+    scope: common.CommonConstruct,
+    props: types.LambdaEdgeProps,
     layers: lambda.ILayerVersion[],
     code: lambda.AssetCode,
     environment?: any,

package/src/lib/manager/{logManager.ts → aws/logManager.ts}

@@ -1,19 +1,19 @@
 import * as cdk from 'aws-cdk-lib'
 import * as logs from 'aws-cdk-lib/aws-logs'
-import { CommonConstruct } from '../common/commonConstruct'
-import { LogProps, MetricFilterProps } from '../types'
-import { createCfnOutput } from '../utils'
+import * as common from '../../common'
+import * as types from '../../types'
+import * as utils from '../../utils'
 
 /**
  * @stability stable
  * @category Management & Governance
  * @summary Provides operations on AWS CloudWatch.
- * - 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.
+ * - 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.
  * @example
  * import * as common from '@gradientedge/cdk-utils'
  *
- * class CustomConstruct extends common.CommonConstruct {
+ * class CustomConstruct extends common.common.CommonConstruct {
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
@@ -27,11 +27,16 @@ export class LogManager {
   /**
    * @summary Method to create a cloudwatch metric filter
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {MetricFilterProps} props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.MetricFilterProps} props
    * @param {logs.ILogGroup} logGroup
    */
-  public createMetricFilter(id: string, scope: CommonConstruct, props: MetricFilterProps, logGroup: logs.ILogGroup) {
+  public createMetricFilter(
+    id: string,
+    scope: common.CommonConstruct,
+    props: types.MetricFilterProps,
+    logGroup: logs.ILogGroup
+  ) {
     if (!props) throw `MetricFilter props undefined`
 
     const metricFilter = new logs.MetricFilter(scope, `${id}`, {
@@ -57,10 +62,10 @@ export class LogManager {
   /**
    * @summary Method to create a cloudwatch log group (cfn)
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {LogProps} props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.LogProps} props
    */
-  public createCfnLogGroup(id: string, scope: CommonConstruct, props: LogProps) {
+  public createCfnLogGroup(id: string, scope: common.CommonConstruct, props: types.LogProps) {
     if (!props) throw `Logs props undefined`
 
     const logGroup = new logs.CfnLogGroup(scope, `${id}`, {
@@ -68,7 +73,7 @@ export class LogManager {
       retentionInDays: props.retention,
     })
 
-    createCfnOutput(`${id}-logGroupArn`, scope, logGroup.attrArn)
+    utils.createCfnOutput(`${id}-logGroupArn`, scope, logGroup.attrArn)
 
     return logGroup
   }
@@ -76,10 +81,10 @@ export class LogManager {
   /**
    * @summary Method to create a cloudwatch log group
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {LogProps} props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.LogProps} props
    */
-  public createLogGroup(id: string, scope: CommonConstruct, props: LogProps) {
+  public createLogGroup(id: string, scope: common.CommonConstruct, props: types.LogProps) {
     if (!props) throw `Logs props undefined`
 
     const logGroup = new logs.LogGroup(scope, `${id}`, {
@@ -88,7 +93,7 @@ export class LogManager {
       removalPolicy: props.removalPolicy ?? cdk.RemovalPolicy.DESTROY,
     })
 
-    createCfnOutput(`${id}-logGroupArn`, scope, logGroup.logGroupArn)
+    utils.createCfnOutput(`${id}-logGroupArn`, scope, logGroup.logGroupArn)
 
     return logGroup
   }