feat(apigateway): allow using IRestApi instead of RestApiBase (#405)

As of 2.90.0 aws-cdk now supports restApiName in the IRestApi interface. By using this interface it becomes possible for developers to monitor APIGateway without the need to reference the actual RestAPI.

Related commit: aws/aws-cdk@3bf1361

---

_By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license_

Author: bigbadtrumpet

API.md

@@ -1,4 +1,4 @@
-import { RestApiBase } from "aws-cdk-lib/aws-apigateway";
+import { IRestApi } from "aws-cdk-lib/aws-apigateway";
 import { DimensionsMap } from "aws-cdk-lib/aws-cloudwatch";
 
 import {
@@ -14,9 +14,9 @@ const ApiGatewayNamespace = "AWS/ApiGateway";
 
 export interface ApiGatewayMetricFactoryProps {
   /**
-   * API to monitor (cannot use IRestApi, since it does not provide API name)
+   * API to monitor
    */
-  readonly api: RestApiBase;
+  readonly api: IRestApi;
   /**
    * @default - prod
    */

lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts

@@ -1,6 +1,6 @@
 import { Duration, Stack } from "aws-cdk-lib";
 import { Template } from "aws-cdk-lib/assertions";
-import { RestApi } from "aws-cdk-lib/aws-apigateway";
+import { IRestApi, RestApi } from "aws-cdk-lib/aws-apigateway";
 
 import { AlarmWithAnnotation, ApiGatewayMonitoring } from "../../../lib";
 import { addMonitoringDashboardsToStack } from "../../utils/SnapshotUtil";
@@ -173,3 +173,157 @@ test("snapshot test: all alarms", () => {
   expect(numAlarmsCreated).toStrictEqual(22);
   expect(Template.fromStack(stack)).toMatchSnapshot();
 });
+
+test("snapshot test: all alarms using interface", () => {
+  const stack = new Stack();
+  const api: IRestApi = RestApi.fromRestApiId(
+    stack,
+    "ThisShouldBeTheApiName",
+    "thisIsNotUsed"
+  );
+
+  const scope = new TestMonitoringScope(stack, "Scope");
+
+  let numAlarmsCreated = 0;
+
+  const monitoring = new ApiGatewayMonitoring(scope, {
+    api,
+    humanReadableName: "Dummy API Gateway for testing",
+    alarmFriendlyName: "DummyApi",
+    add5XXFaultRateAlarm: {
+      Warning: {
+        maxErrorRate: 1,
+        datapointsToAlarm: 10,
+      },
+    },
+    add5XXFaultCountAlarm: {
+      Warning: {
+        maxErrorCount: 2,
+        datapointsToAlarm: 20,
+      },
+    },
+    add4XXErrorRateAlarm: {
+      Warning: {
+        maxErrorRate: 0.01,
+        datapointsToAlarm: 11,
+      },
+    },
+    add4XXErrorCountAlarm: {
+      Warning: {
+        maxErrorCount: 0.02,
+        datapointsToAlarm: 22,
+      },
+    },
+    addLatencyP50Alarm: {
+      Warning: {
+        maxLatency: Duration.millis(150),
+        datapointsToAlarm: 150,
+      },
+    },
+    addLatencyP70Alarm: {
+      Warning: {
+        maxLatency: Duration.millis(170),
+        datapointsToAlarm: 170,
+      },
+    },
+    addLatencyP90Alarm: {
+      Warning: {
+        maxLatency: Duration.millis(190),
+        datapointsToAlarm: 190,
+      },
+    },
+    addLatencyP95Alarm: {
+      Warning: {
+        maxLatency: Duration.millis(195),
+        datapointsToAlarm: 195,
+      },
+    },
+    addLatencyP99Alarm: {
+      Warning: {
+        maxLatency: Duration.millis(199),
+        datapointsToAlarm: 199,
+      },
+    },
+    addLatencyP999Alarm: {
+      Warning: {
+        maxLatency: Duration.millis(1999),
+        datapointsToAlarm: 1999,
+      },
+    },
+    addLatencyP9999Alarm: {
+      Warning: {
+        maxLatency: Duration.millis(19999),
+        datapointsToAlarm: 19999,
+      },
+    },
+    addLatencyP100Alarm: {
+      Warning: {
+        maxLatency: Duration.millis(1100),
+        datapointsToAlarm: 1100,
+      },
+    },
+    addLatencyTM50Alarm: {
+      Warning: {
+        maxLatency: Duration.millis(250),
+        datapointsToAlarm: 250,
+      },
+    },
+    addLatencyTM70Alarm: {
+      Warning: {
+        maxLatency: Duration.millis(270),
+        datapointsToAlarm: 270,
+      },
+    },
+    addLatencyTM90Alarm: {
+      Warning: {
+        maxLatency: Duration.millis(290),
+        datapointsToAlarm: 290,
+      },
+    },
+    addLatencyTM95Alarm: {
+      Warning: {
+        maxLatency: Duration.millis(295),
+        datapointsToAlarm: 295,
+      },
+    },
+    addLatencyTM99Alarm: {
+      Warning: {
+        maxLatency: Duration.millis(299),
+        datapointsToAlarm: 299,
+      },
+    },
+    addLatencyTM999Alarm: {
+      Warning: {
+        maxLatency: Duration.millis(2999),
+        datapointsToAlarm: 2999,
+      },
+    },
+    addLatencyTM9999Alarm: {
+      Warning: {
+        maxLatency: Duration.millis(29999),
+        datapointsToAlarm: 29999,
+      },
+    },
+    addLatencyAverageAlarm: {
+      Warning: {
+        maxLatency: Duration.millis(20),
+        datapointsToAlarm: 20,
+      },
+    },
+    addLowTpsAlarm: {
+      Warning: { minTps: 1 },
+    },
+    addHighTpsAlarm: {
+      Warning: { maxTps: 10 },
+    },
+    useCreatedAlarms: {
+      consume(alarms: AlarmWithAnnotation[]) {
+        numAlarmsCreated = alarms.length;
+      },
+    },
+  });
+
+  addMonitoringDashboardsToStack(stack, monitoring);
+  expect(numAlarmsCreated).toStrictEqual(22);
+  expect(Template.fromStack(stack)).toMatchSnapshot();
+});