@gradientedge/cdk-utils 5.0.0 → 5.1.0

package/dist/src/lib/common/construct.d.ts

@@ -33,6 +33,7 @@ export declare class CommonConstruct extends Construct {
     eksManager: aws.EksManager;
     elasticacheManager: aws.ElastiCacheManager;
     eventManager: aws.EventManager;
+    eventTargetManager: aws.EventTargetManager;
     iamManager: aws.IamManager;
     kmsManager: aws.KmsManager;
     lambdaManager: aws.LambdaManager;

package/dist/src/lib/common/construct.js

@@ -58,6 +58,7 @@ class CommonConstruct extends constructs_1.Construct {
     eksManager;
     elasticacheManager;
     eventManager;
+    eventTargetManager;
     iamManager;
     kmsManager;
     lambdaManager;
@@ -88,6 +89,7 @@ class CommonConstruct extends constructs_1.Construct {
         this.eksManager = new aws.EksManager();
         this.elasticacheManager = new aws.ElastiCacheManager();
         this.eventManager = new aws.EventManager();
+        this.eventTargetManager = new aws.EventTargetManager();
         this.iamManager = new aws.IamManager();
         this.kmsManager = new aws.KmsManager();
         this.lambdaManager = new aws.LambdaManager();

package/dist/src/lib/manager/aws/event-target-manager.d.ts

@@ -0,0 +1,60 @@
+import * as events from 'aws-cdk-lib/aws-events';
+import * as targets from 'aws-cdk-lib/aws-events-targets';
+import * as logs from 'aws-cdk-lib/aws-logs';
+import * as common from '../../common';
+/**
+ * @stability stable
+ * @category cdk-utils.event-taeget-manager
+ * @subcategory Construct
+ * @classdesc Provides operations on AWS EventBridge Targets.
+ * - 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.common.CommonConstruct {
+ *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.eventTargetManager.createCloudWatchLogGroupNoPolicy('MyLogGrouptarget', this, myLogGroup)
+ *   }
+ * }
+ *
+ * @see [CDK EventBridge Target Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events_targets-readme.html}
+ */
+export declare class EventTargetManager {
+    /**
+     * @summary Method to create a cloud watch log group target without a policy.
+     * - This method is created as a workaround for cdk issue - https://github.com/aws/aws-cdk/issues/17002
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {logs.ILogGroup} logGroup the log group
+     * @param {LogGroupNoPolicyProps} props the log group target properties
+     */
+    createCloudWatchLogGroupNoPolicy(id: string, scope: common.CommonConstruct, logGroup: logs.ILogGroup, props?: LogGroupNoPolicyProps): CloudWatchLogGroupNoPolicy;
+}
+/**
+ * Customize the CloudWatch LogGroup Event Target
+ */
+export interface LogGroupNoPolicyProps extends targets.TargetBaseProps {
+    /**
+     * The event to send to the CloudWatch LogGroup
+     *
+     * This will be the event logged into the CloudWatch LogGroup
+     *
+     * @default - the entire EventBridge event
+     */
+    readonly event?: events.RuleTargetInput;
+}
+/**
+ * Use an AWS CloudWatch LogGroup as an event rule target, but don't apply a policy.
+ */
+export declare class CloudWatchLogGroupNoPolicy implements events.IRuleTarget {
+    private readonly logGroup;
+    private readonly props;
+    constructor(logGroup: logs.ILogGroup, props?: LogGroupNoPolicyProps);
+    /**
+     * Returns a RuleTarget that can be used to log an event into a CloudWatch LogGroup
+     */
+    bind(_rule: events.IRule, _id?: string): events.RuleTargetConfig;
+}

package/dist/src/lib/manager/aws/event-target-manager.js

@@ -0,0 +1,91 @@
+"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.CloudWatchLogGroupNoPolicy = exports.EventTargetManager = void 0;
+const cdk = __importStar(require("aws-cdk-lib"));
+const targets = __importStar(require("aws-cdk-lib/aws-events-targets"));
+/**
+ * @stability stable
+ * @category cdk-utils.event-taeget-manager
+ * @subcategory Construct
+ * @classdesc Provides operations on AWS EventBridge Targets.
+ * - 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.common.CommonConstruct {
+ *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.eventTargetManager.createCloudWatchLogGroupNoPolicy('MyLogGrouptarget', this, myLogGroup)
+ *   }
+ * }
+ *
+ * @see [CDK EventBridge Target Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events_targets-readme.html}
+ */
+class EventTargetManager {
+    /**
+     * @summary Method to create a cloud watch log group target without a policy.
+     * - This method is created as a workaround for cdk issue - https://github.com/aws/aws-cdk/issues/17002
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {logs.ILogGroup} logGroup the log group
+     * @param {LogGroupNoPolicyProps} props the log group target properties
+     */
+    createCloudWatchLogGroupNoPolicy(id, scope, logGroup, props) {
+        return new CloudWatchLogGroupNoPolicy(logGroup, props);
+    }
+}
+exports.EventTargetManager = EventTargetManager;
+/**
+ * Use an AWS CloudWatch LogGroup as an event rule target, but don't apply a policy.
+ */
+class CloudWatchLogGroupNoPolicy {
+    logGroup;
+    props;
+    constructor(logGroup, props = {}) {
+        this.logGroup = logGroup;
+        this.props = props;
+    }
+    /**
+     * Returns a RuleTarget that can be used to log an event into a CloudWatch LogGroup
+     */
+    bind(_rule, _id) {
+        const logGroupStack = cdk.Stack.of(this.logGroup);
+        return {
+            ...targets.bindBaseTargetConfig(this.props),
+            arn: logGroupStack.formatArn({
+                service: 'logs',
+                resource: 'log-group',
+                arnFormat: cdk.ArnFormat.COLON_RESOURCE_NAME,
+                resourceName: this.logGroup.logGroupName,
+            }),
+            input: this.props.event,
+            targetResource: this.logGroup,
+        };
+    }
+}
+exports.CloudWatchLogGroupNoPolicy = CloudWatchLogGroupNoPolicy;

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

@@ -11,6 +11,7 @@ export * from './ecs-manager';
 export * from './eks-manager';
 export * from './elasticache-manager';
 export * from './event-manager';
+export * from './event-target-manager';
 export * from './iam-manager';
 export * from './kms-manager';
 export * from './lambda-manager';

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

@@ -27,6 +27,7 @@ __exportStar(require("./ecs-manager"), exports);
 __exportStar(require("./eks-manager"), exports);
 __exportStar(require("./elasticache-manager"), exports);
 __exportStar(require("./event-manager"), exports);
+__exportStar(require("./event-target-manager"), exports);
 __exportStar(require("./iam-manager"), exports);
 __exportStar(require("./kms-manager"), exports);
 __exportStar(require("./lambda-manager"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils",
-  "version": "5.0.0",
+  "version": "5.1.0",
   "description": "Utilities for AWS CDK provisioning",
   "main": "dist/index.js",
   "engines": {

package/src/lib/common/construct.ts

@@ -35,6 +35,7 @@ export class CommonConstruct extends Construct {
   eksManager: aws.EksManager
   elasticacheManager: aws.ElastiCacheManager
   eventManager: aws.EventManager
+  eventTargetManager: aws.EventTargetManager
   iamManager: aws.IamManager
   kmsManager: aws.KmsManager
   lambdaManager: aws.LambdaManager
@@ -67,6 +68,7 @@ export class CommonConstruct extends Construct {
     this.eksManager = new aws.EksManager()
     this.elasticacheManager = new aws.ElastiCacheManager()
     this.eventManager = new aws.EventManager()
+    this.eventTargetManager = new aws.EventTargetManager()
     this.iamManager = new aws.IamManager()
     this.kmsManager = new aws.KmsManager()
     this.lambdaManager = new aws.LambdaManager()

package/src/lib/manager/aws/event-target-manager.ts

@@ -0,0 +1,84 @@
+import * as cdk from 'aws-cdk-lib'
+import * as events from 'aws-cdk-lib/aws-events'
+import * as targets from 'aws-cdk-lib/aws-events-targets'
+import * as logs from 'aws-cdk-lib/aws-logs'
+import * as common from '../../common'
+
+/**
+ * @stability stable
+ * @category cdk-utils.event-taeget-manager
+ * @subcategory Construct
+ * @classdesc Provides operations on AWS EventBridge Targets.
+ * - 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.common.CommonConstruct {
+ *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.eventTargetManager.createCloudWatchLogGroupNoPolicy('MyLogGrouptarget', this, myLogGroup)
+ *   }
+ * }
+ *
+ * @see [CDK EventBridge Target Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events_targets-readme.html}
+ */
+export class EventTargetManager {
+  /**
+   * @summary Method to create a cloud watch log group target without a policy.
+   * - This method is created as a workaround for cdk issue - https://github.com/aws/aws-cdk/issues/17002
+   * @param {string} id scoped id of the resource
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {logs.ILogGroup} logGroup the log group
+   * @param {LogGroupNoPolicyProps} props the log group target properties
+   */
+  public createCloudWatchLogGroupNoPolicy(
+    id: string,
+    scope: common.CommonConstruct,
+    logGroup: logs.ILogGroup,
+    props?: LogGroupNoPolicyProps
+  ) {
+    return new CloudWatchLogGroupNoPolicy(logGroup, props)
+  }
+}
+
+/**
+ * Customize the CloudWatch LogGroup Event Target
+ */
+export interface LogGroupNoPolicyProps extends targets.TargetBaseProps {
+  /**
+   * The event to send to the CloudWatch LogGroup
+   *
+   * This will be the event logged into the CloudWatch LogGroup
+   *
+   * @default - the entire EventBridge event
+   */
+  readonly event?: events.RuleTargetInput
+}
+
+/**
+ * Use an AWS CloudWatch LogGroup as an event rule target, but don't apply a policy.
+ */
+export class CloudWatchLogGroupNoPolicy implements events.IRuleTarget {
+  constructor(private readonly logGroup: logs.ILogGroup, private readonly props: LogGroupNoPolicyProps = {}) {}
+
+  /**
+   * Returns a RuleTarget that can be used to log an event into a CloudWatch LogGroup
+   */
+  public bind(_rule: events.IRule, _id?: string): events.RuleTargetConfig {
+    const logGroupStack = cdk.Stack.of(this.logGroup)
+
+    return {
+      ...targets.bindBaseTargetConfig(this.props),
+      arn: logGroupStack.formatArn({
+        service: 'logs',
+        resource: 'log-group',
+        arnFormat: cdk.ArnFormat.COLON_RESOURCE_NAME,
+        resourceName: this.logGroup.logGroupName,
+      }),
+      input: this.props.event,
+      targetResource: this.logGroup,
+    }
+  }
+}

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

@@ -11,6 +11,7 @@ export * from './ecs-manager'
 export * from './eks-manager'
 export * from './elasticache-manager'
 export * from './event-manager'
+export * from './event-target-manager'
 export * from './iam-manager'
 export * from './kms-manager'
 export * from './lambda-manager'