@aws-cdk/metrics-facade-alpha 2.261.0-alpha.0

package/lib/services/aws-ecs/.jsiirc.json

@@ -0,0 +1,16 @@
+{
+  "targets": {
+    "java": {
+      "package": "software.amazon.awscdk.metricsfacade.alpha.services.ecs"
+    },
+    "dotnet": {
+      "namespace": "Amazon.CDK.MetricsFacade.Alpha.AWS.ECS"
+    },
+    "python": {
+      "module": "aws_cdk.metrics_facade_alpha.aws_ecs"
+    },
+    "go": {
+      "packageName": "metricsfacadealphaawsecs"
+    }
+  }
+}

package/lib/services/aws-ecs/index.d.ts

@@ -0,0 +1 @@
+export * from './metrics.generated';

package/lib/services/aws-ecs/index.js

@@ -0,0 +1,17 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./metrics.generated"), exports);

package/lib/services/aws-ecs/metrics.generated.d.ts

@@ -0,0 +1,105 @@
+import * as cloudwatch from "aws-cdk-lib/aws-cloudwatch";
+import { IClusterRef } from "aws-cdk-lib/aws-ecs";
+/**
+ * CloudWatch metrics facade for AWS/ECS
+ * This class contains helper functions to initialize the dimension-sets classes
+ * for selected resources if available.
+ *
+ * @stability external
+ */
+export declare abstract class ECSMetrics {
+    /**
+     * Create ClusterMetrics from a Cluster reference
+     */
+    static fromCluster(ref: IClusterRef): ECSMetrics.ClusterMetrics;
+}
+export declare namespace ECSMetrics {
+    /**
+     * Metrics for dimension set: Service {ClusterName, ServiceName}
+     *
+     * @stability external
+     */
+    class ServiceMetrics {
+        private readonly dimensions;
+        constructor(props: ECSMetrics.ServiceMetricsProps);
+        /**
+         * Average of the CPUUtilization metric
+         *
+         * @default - Average over 5 minutes
+         */
+        cpuUtilization(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the MemoryUtilization metric
+         *
+         * @default - Average over 5 minutes
+         */
+        memoryUtilization(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+    }
+    /**
+     * Dimensions for ServiceMetrics
+     *
+     * @struct
+     * @stability external
+     */
+    interface ServiceMetricsProps {
+        /**
+         * The ClusterName dimension
+         */
+        readonly clusterName: string;
+        /**
+         * The ServiceName dimension
+         */
+        readonly serviceName: string;
+    }
+    /**
+     * Metrics for dimension set: Cluster {ClusterName}
+     *
+     * @stability external
+     */
+    class ClusterMetrics {
+        private readonly dimensions;
+        constructor(props: ECSMetrics.ClusterMetricsProps);
+        /**
+         * Average of the CPUUtilization metric
+         *
+         * @default - Average over 5 minutes
+         */
+        cpuUtilization(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the MemoryUtilization metric
+         *
+         * @default - Average over 5 minutes
+         */
+        memoryUtilization(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the CPUReservation metric
+         *
+         * @default - Average over 5 minutes
+         */
+        cpuReservation(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the MemoryReservation metric
+         *
+         * @default - Average over 5 minutes
+         */
+        memoryReservation(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the GPUReservation metric
+         *
+         * @default - Average over 5 minutes
+         */
+        gpuReservation(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+    }
+    /**
+     * Dimensions for ClusterMetrics
+     *
+     * @struct
+     * @stability external
+     */
+    interface ClusterMetricsProps {
+        /**
+         * The ClusterName dimension
+         */
+        readonly clusterName: string;
+    }
+}

package/lib/services/aws-ecs/metrics.generated.js

@@ -0,0 +1,185 @@
+"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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ECSMetrics = void 0;
+/* eslint-disable @stylistic/max-len, eol-last */
+const cloudwatch = __importStar(require("aws-cdk-lib/aws-cloudwatch"));
+/**
+ * CloudWatch metrics facade for AWS/ECS
+ * This class contains helper functions to initialize the dimension-sets classes
+ * for selected resources if available.
+ *
+ * @stability external
+ */
+class ECSMetrics {
+    /**
+     * Create ClusterMetrics from a Cluster reference
+     */
+    static fromCluster(ref) {
+        return new ECSMetrics.ClusterMetrics({
+            clusterName: ref.clusterRef.clusterName
+        });
+    }
+}
+exports.ECSMetrics = ECSMetrics;
+(function (ECSMetrics) {
+    /**
+     * Metrics for dimension set: Service {ClusterName, ServiceName}
+     *
+     * @stability external
+     */
+    class ServiceMetrics {
+        dimensions;
+        constructor(props) {
+            this.dimensions = {
+                ClusterName: props.clusterName,
+                ServiceName: props.serviceName
+            };
+        }
+        /**
+         * Average of the CPUUtilization metric
+         *
+         * @default - Average over 5 minutes
+         */
+        cpuUtilization(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/ECS",
+                metricName: "CPUUtilization",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+        /**
+         * Average of the MemoryUtilization metric
+         *
+         * @default - Average over 5 minutes
+         */
+        memoryUtilization(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/ECS",
+                metricName: "MemoryUtilization",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+    }
+    ECSMetrics.ServiceMetrics = ServiceMetrics;
+    /**
+     * Metrics for dimension set: Cluster {ClusterName}
+     *
+     * @stability external
+     */
+    class ClusterMetrics {
+        dimensions;
+        constructor(props) {
+            this.dimensions = {
+                ClusterName: props.clusterName
+            };
+        }
+        /**
+         * Average of the CPUUtilization metric
+         *
+         * @default - Average over 5 minutes
+         */
+        cpuUtilization(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/ECS",
+                metricName: "CPUUtilization",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+        /**
+         * Average of the MemoryUtilization metric
+         *
+         * @default - Average over 5 minutes
+         */
+        memoryUtilization(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/ECS",
+                metricName: "MemoryUtilization",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+        /**
+         * Average of the CPUReservation metric
+         *
+         * @default - Average over 5 minutes
+         */
+        cpuReservation(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/ECS",
+                metricName: "CPUReservation",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+        /**
+         * Average of the MemoryReservation metric
+         *
+         * @default - Average over 5 minutes
+         */
+        memoryReservation(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/ECS",
+                metricName: "MemoryReservation",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+        /**
+         * Average of the GPUReservation metric
+         *
+         * @default - Average over 5 minutes
+         */
+        gpuReservation(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/ECS",
+                metricName: "GPUReservation",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+    }
+    ECSMetrics.ClusterMetrics = ClusterMetrics;
+})(ECSMetrics || (exports.ECSMetrics = ECSMetrics = {}));

package/lib/services/aws-efs/.jsiirc.json

@@ -0,0 +1,16 @@
+{
+  "targets": {
+    "java": {
+      "package": "software.amazon.awscdk.metricsfacade.alpha.services.efs"
+    },
+    "dotnet": {
+      "namespace": "Amazon.CDK.MetricsFacade.Alpha.AWS.EFS"
+    },
+    "python": {
+      "module": "aws_cdk.metrics_facade_alpha.aws_efs"
+    },
+    "go": {
+      "packageName": "metricsfacadealphaawsefs"
+    }
+  }
+}

package/lib/services/aws-efs/index.d.ts

@@ -0,0 +1 @@
+export * from './metrics.generated';

package/lib/services/aws-efs/index.js

@@ -0,0 +1,17 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./metrics.generated"), exports);

package/lib/services/aws-efs/metrics.generated.d.ts

@@ -0,0 +1,130 @@
+import * as cloudwatch from "aws-cdk-lib/aws-cloudwatch";
+import { IFileSystemRef } from "aws-cdk-lib/aws-efs";
+/**
+ * CloudWatch metrics facade for AWS/EFS
+ * This class contains helper functions to initialize the dimension-sets classes
+ * for selected resources if available.
+ *
+ * @stability external
+ */
+export declare abstract class EFSMetrics {
+    /**
+     * Create FileSystemMetrics from a FileSystem reference
+     */
+    static fromFileSystem(ref: IFileSystemRef): EFSMetrics.FileSystemMetrics;
+}
+export declare namespace EFSMetrics {
+    /**
+     * Metrics for dimension set: FileSystem {FileSystemId}
+     *
+     * @stability external
+     */
+    class FileSystemMetrics {
+        private readonly dimensions;
+        constructor(props: EFSMetrics.FileSystemMetricsProps);
+        /**
+         * Average of the BurstCreditBalance metric
+         *
+         * @default - Average over 5 minutes
+         */
+        burstCreditBalance(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Sum of the ClientConnections metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        clientConnections(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the DataReadIOBytes metric
+         *
+         * @default - Average over 5 minutes
+         */
+        dataReadIoBytes(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the DataWriteIOBytes metric
+         *
+         * @default - Average over 5 minutes
+         */
+        dataWriteIoBytes(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the MetadataIOBytes metric
+         *
+         * @default - Average over 5 minutes
+         */
+        metadataIoBytes(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the MeteredIOBytes metric
+         *
+         * @default - Average over 5 minutes
+         */
+        meteredIoBytes(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the PercentIOLimit metric
+         *
+         * @default - Average over 5 minutes
+         */
+        percentIoLimit(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the PermittedThroughput metric
+         *
+         * @default - Average over 5 minutes
+         */
+        permittedThroughput(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Sum of the TotalIOBytes metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        totalIoBytes(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+    }
+    /**
+     * Dimensions for FileSystemMetrics
+     *
+     * @struct
+     * @stability external
+     */
+    interface FileSystemMetricsProps {
+        /**
+         * The FileSystemId dimension
+         */
+        readonly fileSystemId: string;
+    }
+    /**
+     * Metrics for dimension set: StorageClass {FileSystemId, StorageClass}
+     *
+     * @stability external
+     */
+    class StorageClassMetrics {
+        private readonly dimensions;
+        constructor(props: EFSMetrics.StorageClassMetricsProps);
+        /**
+         * Average of the StorageBytes metric
+         *
+         * @default - Average over 5 minutes
+         */
+        storageBytes(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+    }
+    /**
+     * Dimensions for StorageClassMetrics
+     *
+     * @struct
+     * @stability external
+     */
+    interface StorageClassMetricsProps {
+        /**
+         * The FileSystemId dimension
+         */
+        readonly fileSystemId: string;
+        /**
+         * The StorageClass dimension
+         */
+        readonly storageClass: EFSMetrics.StorageClassMetricsStorageClass;
+    }
+    /**
+     * Known values for the StorageClass dimension
+     */
+    enum StorageClassMetricsStorageClass {
+        /** StorageClass = Total */
+        TOTAL = "Total"
+    }
+}