feat!: require aws-cdk-lib ^2.160.0

This unfortunately drops the guard for non-serverless DatabaseClusters for Aurora monitoring since the constructs are now nearly indistinguishable based on their properties.
cdklabs · Nov 13, 2024 · 6cdb65a · 6cdb65a
1 parent 4926bd0
commit 6cdb65a
Show file tree

Hide file tree

Showing 13 changed files with 97 additions and 580 deletions.
diff --git a/.projen/deps.json b/.projen/deps.json
diff --git a/.projen/tasks.json b/.projen/tasks.json
diff --git a/.projenrc.ts b/.projenrc.ts
@@ -7,7 +7,7 @@ import {
 } from "projen";
 import { TrailingComma } from "projen/lib/javascript";
 
-const CDK_VERSION = "2.112.0";
+const CDK_VERSION = "2.160.0";
 
 const project = new awscdk.AwsCdkConstructLibrary({
   name: "cdk-monitoring-constructs",
@@ -18,7 +18,7 @@ const project = new awscdk.AwsCdkConstructLibrary({
   keywords: ["cloudwatch", "monitoring"],
 
   defaultReleaseBranch: "main",
-  majorVersion: 8,
+  majorVersion: 9,
   stability: "experimental",
 
   cdkVersion: CDK_VERSION,

diff --git a/README.md b/README.md
@@ -26,10 +26,10 @@ In your `package.json`:
 ```json
 {
   "dependencies": {
-    "cdk-monitoring-constructs": "^7.0.0",
+    "cdk-monitoring-constructs": "^9.0.0",
 
     // peer dependencies of cdk-monitoring-constructs
-    "aws-cdk-lib": "^2.112.0",
+    "aws-cdk-lib": "^2.160.0",
     "constructs": "^10.0.5"
 
     // ...your other dependencies...

diff --git a/lib/monitoring/aws-rds/AuroraClusterMonitoring.ts b/lib/monitoring/aws-rds/AuroraClusterMonitoring.ts
@@ -3,7 +3,6 @@ import {
   HorizontalAnnotation,
   IWidget,
 } from "aws-cdk-lib/aws-cloudwatch";
-import { ServerlessCluster } from "aws-cdk-lib/aws-rds";
 
 import {
   RdsClusterMetricFactory,
@@ -75,12 +74,6 @@ export class AuroraClusterMonitoring extends Monitoring {
   constructor(scope: MonitoringScope, props: AuroraClusterMonitoringProps) {
     super(scope, props);
 
-    if (!this.isServerlessCluster(props.cluster)) {
-      throw Error(
-        "Cluster is not of type `ServerlessCluster`. Monitoring is not applicable.",
-      );
-    }
-
     const metricFactory = new RdsClusterMetricFactory(
       scope.createMetricFactory(),
       props,
@@ -164,10 +157,6 @@ export class AuroraClusterMonitoring extends Monitoring {
     props.useCreatedAlarms?.consume(this.createdAlarms());
   }
 
-  private isServerlessCluster(obj: any): obj is ServerlessCluster {
-    return (obj as any).clusterArn !== undefined;
-  }
-
   summaryWidgets(): IWidget[] {
     return [
       this.createTitleWidget(),

diff --git a/package.json b/package.json
diff --git a/test/dashboard/widget/__snapshots__/BitmapWidget.test.ts.snap b/test/dashboard/widget/__snapshots__/BitmapWidget.test.ts.snap
diff --git a/test/facade/__snapshots__/MonitoringAspect.test.ts.snap b/test/facade/__snapshots__/MonitoringAspect.test.ts.snap
diff --git a/test/monitoring/aws-rds/AuroraClusterMonitoring.test.ts b/test/monitoring/aws-rds/AuroraClusterMonitoring.test.ts
@@ -1,12 +1,6 @@
 import { Stack } from "aws-cdk-lib";
 import { Template } from "aws-cdk-lib/assertions";
-import { InstanceType, SubnetType, Vpc } from "aws-cdk-lib/aws-ec2";
-import {
-  AuroraMysqlEngineVersion,
-  DatabaseCluster,
-  DatabaseClusterEngine,
-  ServerlessCluster,
-} from "aws-cdk-lib/aws-rds";
+import { DatabaseClusterEngine, ServerlessCluster } from "aws-cdk-lib/aws-rds";
 
 import { AuroraClusterMonitoring } from "../../../lib";
 import { addMonitoringDashboardsToStack } from "../../utils/SnapshotUtil";
@@ -31,58 +25,6 @@ test("snapshot test: no alarms", () => {
   expect(Template.fromStack(stack)).toMatchSnapshot();
 });
 
-test("RDS passed into Aurora Cluster", () => {
-  const testGuard = () => {
-    const stack = new Stack();
-    const scope = new TestMonitoringScope(stack, "Scope");
-    const vpc = new Vpc(scope, "DummyVpc", {
-      maxAzs: 3,
-    });
-    const rdsCluster = new DatabaseCluster(scope, "DummyRdsCluster", {
-      engine: DatabaseClusterEngine.auroraMysql({
-        version: AuroraMysqlEngineVersion.VER_2_07_10,
-      }),
-      instanceProps: {
-        instanceType: new InstanceType("t3.small"),
-        vpcSubnets: {
-          subnetType: SubnetType.PUBLIC,
-        },
-        vpc,
-      },
-    });
-
-    new AuroraClusterMonitoring(scope, {
-      alarmFriendlyName: "DummyAuroraCluster",
-      cluster: rdsCluster,
-      addCpuUsageAlarm: {
-        Warning: {
-          maxUsagePercent: 80,
-        },
-      },
-      addMaxConnectionCountAlarm: {
-        Warning: {
-          maxConnectionCount: 100,
-        },
-      },
-      addMinConnectionCountAlarm: {
-        Warning: {
-          minConnectionCount: 0,
-        },
-      },
-      addMaxServerlessDatabaseCapacityAlarm: {
-        Warning: {
-          maxUsageCount: 100,
-        },
-      },
-    });
-  };
-
-  expect(testGuard).toThrow(Error);
-  expect(testGuard).toThrow(
-    "Cluster is not of type `ServerlessCluster`. Monitoring is not applicable.",
-  );
-});
-
 test("snapshot test: all alarms", () => {
   const stack = new Stack();