@gradientedge/cdk-utils 8.88.0 → 8.90.0

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

@@ -8,22 +8,22 @@ import * as iam from 'aws-cdk-lib/aws-iam'
 import * as lambda from 'aws-cdk-lib/aws-lambda'
 import * as s3 from 'aws-cdk-lib/aws-s3'
 import * as cr from 'aws-cdk-lib/custom-resources'
-import * as common from '../../common'
-import { CommonStack } from '../../common'
-import * as types from '../../types'
-import * as utils from '../../utils'
+import { CommonConstruct, CommonStack } from '../../../common'
+import * as utils from '../../../utils'
+import { CloudfrontFunctionProps, CloudFrontProps, DistributionProps } from './types'
+import { LambdaEdgeProps } from '../lambda'
 
 /**
  * @stability stable
  * @category cdk-utils.cloudfront-manager
  * @subcategory Construct
  * @classdesc Provides operations on AWS CloudFront.
- * - 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
@@ -41,7 +41,7 @@ import * as utils from '../../utils'
  * @see [CDK CloudFront Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudfront-readme.html}
  */
 export class CloudFrontManager {
-  public createOriginAccessIdentity(id: string, scope: common.CommonConstruct, accessBucket?: s3.IBucket) {
+  public createOriginAccessIdentity(id: string, scope: CommonConstruct, accessBucket?: s3.IBucket) {
     const oai = new cloudfront.OriginAccessIdentity(scope, `${id}`, {
       comment: `${id} - ${scope.props.stage} stage`,
     })
@@ -53,8 +53,8 @@ export class CloudFrontManager {
   /**
    * @summary Method to create a cloudfront distribution
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {types.CloudFrontProps} props distribution properties
+   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {CloudFrontProps} props distribution properties
    * @param {s3.IBucket?} siteBucket
    * @param {s3.IBucket?} logBucket
    * @param {cloudfront.OriginAccessIdentity?} oai
@@ -63,8 +63,8 @@ export class CloudFrontManager {
    */
   public createCloudFrontDistribution(
     id: string,
-    scope: common.CommonConstruct,
-    props: types.CloudFrontProps,
+    scope: CommonConstruct,
+    props: CloudFrontProps,
     siteBucket?: s3.IBucket,
     logBucket?: s3.IBucket,
     oai?: cloudfront.OriginAccessIdentity,
@@ -120,8 +120,8 @@ export class CloudFrontManager {
   /**
    * Method to create a CloudFront distribution with S3 Origin
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {types.DistributionProps} props distribution properties
+   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {DistributionProps} props distribution properties
    * @param {origins.S3Origin} origin
    * @param {s3.IBucket} siteBucket
    * @param {s3.IBucket?} logBucket
@@ -132,8 +132,8 @@ export class CloudFrontManager {
    */
   public createDistributionWithS3Origin(
     id: string,
-    scope: common.CommonConstruct,
-    props: types.DistributionProps,
+    scope: CommonConstruct,
+    props: DistributionProps,
     origin: origins.S3Origin,
     siteBucket: s3.IBucket,
     logBucket?: s3.IBucket,
@@ -185,8 +185,8 @@ export class CloudFrontManager {
   /**
    * Method to create a CloudFront distribution with HTTP Origin
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {types.DistributionProps} props distribution properties
+   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {DistributionProps} props distribution properties
    * @param {origins.S3Origin} origin
    * @param {string[]} domainNames
    * @param {s3.IBucket?} logBucket
@@ -196,8 +196,8 @@ export class CloudFrontManager {
    */
   public createDistributionWithHttpOrigin(
     id: string,
-    scope: common.CommonConstruct,
-    props: types.DistributionProps,
+    scope: CommonConstruct,
+    props: DistributionProps,
     origin: origins.HttpOrigin,
     domainNames: string[],
     logBucket?: s3.IBucket,
@@ -250,8 +250,8 @@ export class CloudFrontManager {
    * @summary Method to provision a Lambda@Edge function
    *
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {types.LambdaEdgeProps} props lambda@edge properties
+   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {LambdaEdgeProps} props lambda@edge properties
    * @param {lambda.ILayerVersion[]} layers
    * @param {lambda.AssetCode} code
    * @param {iam.Role} role
@@ -263,8 +263,8 @@ export class CloudFrontManager {
    */
   public createEdgeFunction(
     id: string,
-    scope: common.CommonConstruct,
-    props: types.LambdaEdgeProps,
+    scope: CommonConstruct,
+    props: LambdaEdgeProps,
     layers: lambda.ILayerVersion[],
     code: lambda.AssetCode,
     role: iam.Role,
@@ -320,7 +320,7 @@ export class CloudFrontManager {
    */
   public invalidateCache(
     id: string,
-    scope: common.CommonConstruct,
+    scope: CommonConstruct,
     dockerFilePath: string,
     distributionId: string,
     paths?: string
@@ -348,10 +348,10 @@ export class CloudFrontManager {
    * @summary Method to provision a Cloudfront function
    *
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {types.CloudfrontFunctionProps} props
+   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {CloudfrontFunctionProps} props
    */
-  public createCloudfrontFunction(id: string, scope: common.CommonConstruct, props: types.CloudfrontFunctionProps) {
+  public createCloudfrontFunction(id: string, scope: CommonConstruct, props: CloudfrontFunctionProps) {
     const cloudfrontFunction = new cloudfront.Function(scope, `${id}`, {
       code: cloudfront.FunctionCode.fromFile({
         filePath: props.functionFilePath,

package/src/lib/services/aws/cloudfront/types.ts

@@ -0,0 +1,28 @@
+import { TagProps } from '../../../types'
+import * as cf from 'aws-cdk-lib/aws-cloudfront'
+import { CloudFrontWebDistributionProps, FunctionProps } from 'aws-cdk-lib/aws-cloudfront'
+
+/**
+ * @category cdk-utils.cloudfront-manager
+ * @subcategory Properties
+ */
+export interface CloudFrontProps extends CloudFrontWebDistributionProps {
+  tags?: TagProps[]
+}
+
+/**
+ * @category cdk-utils.cloudfront-manager
+ * @subcategory Properties
+ */
+export interface DistributionProps extends cf.DistributionProps {
+  tags?: TagProps[]
+}
+
+/**
+ * @category cdk-utils.cloudfront-manager
+ * @subcategory Properties
+ */
+export interface CloudfrontFunctionProps extends FunctionProps {
+  functionFilePath: string
+  eventType: string
+}

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

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

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

@@ -1,21 +1,21 @@
 import * as cloudtrail from 'aws-cdk-lib/aws-cloudtrail'
 import * as logs from 'aws-cdk-lib/aws-logs'
 import * as s3 from 'aws-cdk-lib/aws-s3'
-import * as common from '../../common'
-import * as types from '../../types'
-import * as utils from '../../utils'
+import * as utils from '../../../utils'
+import { CommonConstruct } from '../../../common'
+import { CloudTrailProps } from './types'
 
 /**
  * @stability stable
  * @category cdk-utils.cloudtrail-manager
  * @subcategory Construct
  * @classdesc Provides operations on AWS CloudTrail.
- * - 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
@@ -36,8 +36,8 @@ export class CloudTrailManager {
   /**
    * @summary Method to create a cloud trail
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {types.CloudTrailProps} props
+   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {CloudTrailProps} props
    * @param {logs.CfnLogGroup} logGroup
    * @param {s3.IBucket} dataBucket
    * @param {s3.IBucket} logBucket
@@ -45,8 +45,8 @@ export class CloudTrailManager {
    */
   public createCloudTrail(
     id: string,
-    scope: common.CommonConstruct,
-    props: types.CloudTrailProps,
+    scope: CommonConstruct,
+    props: CloudTrailProps,
     logGroup: logs.CfnLogGroup,
     dataBucket: s3.IBucket,
     logBucket: s3.IBucket,

package/src/lib/services/aws/cloudtrail/types.ts

@@ -0,0 +1,7 @@
+import { CfnTrailProps } from 'aws-cdk-lib/aws-cloudtrail'
+
+/**
+ * @category cdk-utils.cloudtrail-manager
+ * @subcategory Properties
+ */
+export interface CloudTrailProps extends CfnTrailProps {}

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

@@ -0,0 +1,3 @@
+export * from './logs'
+export * from './main'
+export * from './types'

package/src/lib/{manager/aws/log-manager.ts → services/aws/cloudwatch/logs.ts}

@@ -1,20 +1,20 @@
 import * as cdk from 'aws-cdk-lib'
 import * as logs from 'aws-cdk-lib/aws-logs'
-import * as common from '../../common'
-import * as types from '../../types'
-import * as utils from '../../utils'
+import * as utils from '../../../utils'
+import { CommonConstruct } from '../../../common'
+import { LogProps, MetricFilterProps } from './types'
 
 /**
  * @stability stable
  * @category cdk-utils.cloudwatch-manager
  * @subcategory Construct
  * @classdesc Provides operations on AWS CloudWatch.
- * - 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
@@ -28,16 +28,11 @@ export class LogManager {
   /**
    * @summary Method to create a cloudwatch metric filter
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {types.MetricFilterProps} props
+   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {MetricFilterProps} props
    * @param {logs.ILogGroup} logGroup
    */
-  public createMetricFilter(
-    id: string,
-    scope: common.CommonConstruct,
-    props: types.MetricFilterProps,
-    logGroup: logs.ILogGroup
-  ) {
+  public createMetricFilter(id: string, scope: CommonConstruct, props: MetricFilterProps, logGroup: logs.ILogGroup) {
     if (!props) throw `MetricFilter props undefined for ${id}`
 
     const metricFilter = new logs.MetricFilter(scope, `${id}`, {
@@ -63,10 +58,10 @@ export class LogManager {
   /**
    * @summary Method to create a cloudwatch log group (cfn)
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {types.LogProps} props
+   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {LogProps} props
    */
-  public createCfnLogGroup(id: string, scope: common.CommonConstruct, props: types.LogProps) {
+  public createCfnLogGroup(id: string, scope: CommonConstruct, props: LogProps) {
     if (!props) throw `Logs props undefined for ${id}`
 
     const logGroup = new logs.CfnLogGroup(scope, `${id}`, {
@@ -89,10 +84,10 @@ export class LogManager {
   /**
    * @summary Method to create a cloudwatch log group
    * @param {string} id scoped id of the resource
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {types.LogProps} props
+   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {LogProps} props
    */
-  public createLogGroup(id: string, scope: common.CommonConstruct, props: types.LogProps) {
+  public createLogGroup(id: string, scope: CommonConstruct, props: LogProps) {
     if (!props) throw `Logs props undefined for ${id}`
 
     const logGroup = new logs.LogGroup(scope, `${id}`, {