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

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

@@ -0,0 +1,134 @@
+"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.DocDBMetrics = void 0;
+/* eslint-disable @stylistic/max-len, eol-last */
+const cloudwatch = __importStar(require("aws-cdk-lib/aws-cloudwatch"));
+/**
+ * CloudWatch metrics facade for AWS/DocDB
+ * This class contains helper functions to initialize the dimension-sets classes
+ * for selected resources if available.
+ *
+ * @stability external
+ */
+class DocDBMetrics {
+}
+exports.DocDBMetrics = DocDBMetrics;
+(function (DocDBMetrics) {
+    /**
+     * Metrics for dimension set: DatabaseInstance {DBInstanceIdentifier}
+     *
+     * @stability external
+     */
+    class DatabaseInstanceMetrics {
+        dimensions;
+        constructor(props) {
+            this.dimensions = {
+                DBInstanceIdentifier: props.dbInstanceIdentifier
+            };
+        }
+        /**
+         * Average of the CPUUtilization metric
+         *
+         * @default - Average over 5 minutes
+         */
+        cpuUtilization(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DocDB",
+                metricName: "CPUUtilization",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+        /**
+         * Average of the DatabaseConnections metric
+         *
+         * @default - Average over 5 minutes
+         */
+        databaseConnections(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DocDB",
+                metricName: "DatabaseConnections",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+        /**
+         * Average of the EngineUptime metric
+         *
+         * @default - Average over 5 minutes
+         */
+        engineUptime(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DocDB",
+                metricName: "EngineUptime",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+        /**
+         * Sum of the ReadThroughput metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        readThroughput(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DocDB",
+                metricName: "ReadThroughput",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+        /**
+         * Sum of the WriteThroughput metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        writeThroughput(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DocDB",
+                metricName: "WriteThroughput",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+    }
+    DocDBMetrics.DatabaseInstanceMetrics = DatabaseInstanceMetrics;
+})(DocDBMetrics || (exports.DocDBMetrics = DocDBMetrics = {}));

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

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

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

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

package/lib/services/aws-dynamodb/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-dynamodb/metrics.generated.d.ts

@@ -0,0 +1,444 @@
+import * as cloudwatch from "aws-cdk-lib/aws-cloudwatch";
+import { ITableRef } from "aws-cdk-lib/aws-dynamodb";
+/**
+ * CloudWatch metrics facade for AWS/DynamoDB
+ * This class contains helper functions to initialize the dimension-sets classes
+ * for selected resources if available.
+ *
+ * @stability external
+ */
+export declare abstract class DynamoDBMetrics {
+    /**
+     * Create TableMetrics from a Table reference
+     */
+    static fromTable(ref: ITableRef): DynamoDBMetrics.TableMetrics;
+}
+export declare namespace DynamoDBMetrics {
+    /**
+     * Metrics for dimension set: Table {TableName}
+     *
+     * @stability external
+     */
+    class TableMetrics {
+        private readonly dimensions;
+        constructor(props: DynamoDBMetrics.TableMetricsProps);
+        /**
+         * Sum of the ConditionalCheckFailedRequests metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        conditionalCheckFailedRequests(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Sum of the ConsumedReadCapacityUnits metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        consumedReadCapacityUnits(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Sum of the ConsumedWriteCapacityUnits metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        consumedWriteCapacityUnits(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the ProvisionedReadCapacityUnits metric
+         *
+         * @default - Average over 5 minutes
+         */
+        provisionedReadCapacityUnits(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the ProvisionedWriteCapacityUnits metric
+         *
+         * @default - Average over 5 minutes
+         */
+        provisionedWriteCapacityUnits(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Sum of the ReadThrottleEvents metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        readThrottleEvents(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Sum of the TimeToLiveDeletedItemCount metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        timeToLiveDeletedItemCount(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the TransactionConflict metric
+         *
+         * @default - Average over 5 minutes
+         */
+        transactionConflict(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Sum of the WriteThrottleEvents metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        writeThrottleEvents(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+    }
+    /**
+     * Dimensions for TableMetrics
+     *
+     * @struct
+     * @stability external
+     */
+    interface TableMetricsProps {
+        /**
+         * The TableName dimension
+         */
+        readonly tableName: string;
+    }
+    /**
+     * Metrics for dimension set: GlobalSecondaryIndex {TableName, GlobalSecondaryIndexName}
+     *
+     * @stability external
+     */
+    class GlobalSecondaryIndexMetrics {
+        private readonly dimensions;
+        constructor(props: DynamoDBMetrics.GlobalSecondaryIndexMetricsProps);
+        /**
+         * Sum of the ConsumedReadCapacityUnits metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        consumedReadCapacityUnits(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Sum of the ConsumedWriteCapacityUnits metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        consumedWriteCapacityUnits(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the ProvisionedReadCapacityUnits metric
+         *
+         * @default - Average over 5 minutes
+         */
+        provisionedReadCapacityUnits(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the ProvisionedWriteCapacityUnits metric
+         *
+         * @default - Average over 5 minutes
+         */
+        provisionedWriteCapacityUnits(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Sum of the ReadThrottleEvents metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        readThrottleEvents(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Sum of the WriteThrottleEvents metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        writeThrottleEvents(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Sum of the OnlineIndexConsumedWriteCapacity metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        onlineIndexConsumedWriteCapacity(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the OnlineIndexPercentageProgress metric
+         *
+         * @default - Average over 5 minutes
+         */
+        onlineIndexPercentageProgress(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Sum of the OnlineIndexThrottleEvents metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        onlineIndexThrottleEvents(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+    }
+    /**
+     * Dimensions for GlobalSecondaryIndexMetrics
+     *
+     * @struct
+     * @stability external
+     */
+    interface GlobalSecondaryIndexMetricsProps {
+        /**
+         * The TableName dimension
+         */
+        readonly tableName: string;
+        /**
+         * The GlobalSecondaryIndexName dimension
+         */
+        readonly globalSecondaryIndexName: DynamoDBMetrics.GlobalSecondaryIndexMetricsGlobalSecondaryIndexName;
+    }
+    /**
+     * Known values for the GlobalSecondaryIndexName dimension
+     */
+    enum GlobalSecondaryIndexMetricsGlobalSecondaryIndexName {
+        /** GlobalSecondaryIndexName = GlobalSecondaryIndexName */
+        GLOBAL_SECONDARY_INDEX_NAME = "GlobalSecondaryIndexName"
+    }
+    /**
+     * Metrics for dimension set: Operation {TableName, Operation}
+     *
+     * @stability external
+     */
+    class OperationMetrics {
+        private readonly dimensions;
+        constructor(props: DynamoDBMetrics.OperationMetricsProps);
+        /**
+         * Sum of the ReturnedItemCount metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        returnedItemCount(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the SuccessfulRequestLatency metric
+         *
+         * @default - Average over 5 minutes
+         */
+        successfulRequestLatency(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Sum of the SystemErrors metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        systemErrors(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Sum of the ThrottledRequests metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        throttledRequests(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+    }
+    /**
+     * Dimensions for OperationMetrics
+     *
+     * @struct
+     * @stability external
+     */
+    interface OperationMetricsProps {
+        /**
+         * The TableName dimension
+         */
+        readonly tableName: string;
+        /**
+         * The Operation dimension
+         */
+        readonly operation: DynamoDBMetrics.OperationMetricsOperation;
+    }
+    /**
+     * Known values for the Operation dimension
+     */
+    enum OperationMetricsOperation {
+        /** Operation = GetItem */
+        GET_ITEM = "GetItem",
+        /** Operation = PutItem */
+        PUT_ITEM = "PutItem",
+        /** Operation = Scan */
+        SCAN = "Scan",
+        /** Operation = BatchExecuteStatement */
+        BATCH_EXECUTE_STATEMENT = "BatchExecuteStatement",
+        /** Operation = BatchGetItem */
+        BATCH_GET_ITEM = "BatchGetItem",
+        /** Operation = BatchWriteItem */
+        BATCH_WRITE_ITEM = "BatchWriteItem",
+        /** Operation = DeleteItem */
+        DELETE_ITEM = "DeleteItem",
+        /** Operation = ExecuteStatement */
+        EXECUTE_STATEMENT = "ExecuteStatement",
+        /** Operation = ExecuteTransaction */
+        EXECUTE_TRANSACTION = "ExecuteTransaction",
+        /** Operation = Query */
+        QUERY = "Query",
+        /** Operation = TransactGetItems */
+        TRANSACT_GET_ITEMS = "TransactGetItems",
+        /** Operation = TransactWriteItems */
+        TRANSACT_WRITE_ITEMS = "TransactWriteItems",
+        /** Operation = UpdateItem */
+        UPDATE_ITEM = "UpdateItem",
+        /** Operation = GetRecords */
+        GET_RECORDS = "GetRecords"
+    }
+    /**
+     * Metrics for dimension set: DelegatedOperation {TableName, DelegatedOperation}
+     *
+     * @stability external
+     */
+    class DelegatedOperationMetrics {
+        private readonly dimensions;
+        constructor(props: DynamoDBMetrics.DelegatedOperationMetricsProps);
+        /**
+         * Average of the AgeOfOldestUnreplicatedRecord metric
+         *
+         * @default - Average over 5 minutes
+         */
+        ageOfOldestUnreplicatedRecord(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the ConsumedChangeDataCaptureUnits metric
+         *
+         * @default - Average over 5 minutes
+         */
+        consumedChangeDataCaptureUnits(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the ThrottledPutRecordCount metric
+         *
+         * @default - Average over 5 minutes
+         */
+        throttledPutRecordCount(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+    }
+    /**
+     * Dimensions for DelegatedOperationMetrics
+     *
+     * @struct
+     * @stability external
+     */
+    interface DelegatedOperationMetricsProps {
+        /**
+         * The TableName dimension
+         */
+        readonly tableName: string;
+        /**
+         * The DelegatedOperation dimension
+         */
+        readonly delegatedOperation: string;
+    }
+    /**
+     * Metrics for dimension set: ReceivingRegion {TableName, ReceivingRegion}
+     *
+     * @stability external
+     */
+    class ReceivingRegionMetrics {
+        private readonly dimensions;
+        constructor(props: DynamoDBMetrics.ReceivingRegionMetricsProps);
+        /**
+         * Average of the PendingReplicationCount metric
+         *
+         * @default - Average over 5 minutes
+         */
+        pendingReplicationCount(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the ReplicationLatency metric
+         *
+         * @default - Average over 5 minutes
+         */
+        replicationLatency(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+    }
+    /**
+     * Dimensions for ReceivingRegionMetrics
+     *
+     * @struct
+     * @stability external
+     */
+    interface ReceivingRegionMetricsProps {
+        /**
+         * The TableName dimension
+         */
+        readonly tableName: string;
+        /**
+         * The ReceivingRegion dimension
+         */
+        readonly receivingRegion: string;
+    }
+    /**
+     * Metrics for dimension set: OperationPerStream {TableName, StreamLabel, Operation}
+     *
+     * @stability external
+     */
+    class OperationPerStreamMetrics {
+        private readonly dimensions;
+        constructor(props: DynamoDBMetrics.OperationPerStreamMetricsProps);
+        /**
+         * Average of the ReturnedBytes metric
+         *
+         * @default - Average over 5 minutes
+         */
+        returnedBytes(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the ReturnedRecordsCount metric
+         *
+         * @default - Average over 5 minutes
+         */
+        returnedRecordsCount(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+    }
+    /**
+     * Dimensions for OperationPerStreamMetrics
+     *
+     * @struct
+     * @stability external
+     */
+    interface OperationPerStreamMetricsProps {
+        /**
+         * The TableName dimension
+         */
+        readonly tableName: string;
+        /**
+         * The StreamLabel dimension
+         */
+        readonly streamLabel: string;
+        /**
+         * The Operation dimension
+         */
+        readonly operation: string;
+    }
+    /**
+     * Metrics for dimension set: Account {no dimensions}
+     *
+     * @stability external
+     */
+    class AccountMetrics {
+        private readonly dimensions;
+        constructor();
+        /**
+         * Maximum of the AccountMaxReads metric
+         *
+         * @default - Maximum over 5 minutes
+         */
+        accountMaxReads(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Maximum of the AccountMaxTableLevelReads metric
+         *
+         * @default - Maximum over 5 minutes
+         */
+        accountMaxTableLevelReads(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Maximum of the AccountMaxTableLevelWrites metric
+         *
+         * @default - Maximum over 5 minutes
+         */
+        accountMaxTableLevelWrites(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Maximum of the AccountMaxWrites metric
+         *
+         * @default - Maximum over 5 minutes
+         */
+        accountMaxWrites(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the AccountProvisionedReadCapacityUtilization metric
+         *
+         * @default - Average over 5 minutes
+         */
+        accountProvisionedReadCapacityUtilization(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the AccountProvisionedWriteCapacityUtilization metric
+         *
+         * @default - Average over 5 minutes
+         */
+        accountProvisionedWriteCapacityUtilization(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the MaxProvisionedTableReadCapacityUtilization metric
+         *
+         * @default - Average over 5 minutes
+         */
+        maxProvisionedTableReadCapacityUtilization(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the MaxProvisionedTableWriteCapacityUtilization metric
+         *
+         * @default - Average over 5 minutes
+         */
+        maxProvisionedTableWriteCapacityUtilization(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Sum of the UserErrors metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        userErrors(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+    }
+}