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

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

@@ -0,0 +1,734 @@
+"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.DynamoDBMetrics = void 0;
+/* eslint-disable @stylistic/max-len, eol-last */
+const cloudwatch = __importStar(require("aws-cdk-lib/aws-cloudwatch"));
+/**
+ * CloudWatch metrics facade for AWS/DynamoDB
+ * This class contains helper functions to initialize the dimension-sets classes
+ * for selected resources if available.
+ *
+ * @stability external
+ */
+class DynamoDBMetrics {
+    /**
+     * Create TableMetrics from a Table reference
+     */
+    static fromTable(ref) {
+        return new DynamoDBMetrics.TableMetrics({
+            tableName: ref.tableRef.tableName
+        });
+    }
+}
+exports.DynamoDBMetrics = DynamoDBMetrics;
+(function (DynamoDBMetrics) {
+    /**
+     * Metrics for dimension set: Table {TableName}
+     *
+     * @stability external
+     */
+    class TableMetrics {
+        dimensions;
+        constructor(props) {
+            this.dimensions = {
+                TableName: props.tableName
+            };
+        }
+        /**
+         * Sum of the ConditionalCheckFailedRequests metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        conditionalCheckFailedRequests(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "ConditionalCheckFailedRequests",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+        /**
+         * Sum of the ConsumedReadCapacityUnits metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        consumedReadCapacityUnits(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "ConsumedReadCapacityUnits",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+        /**
+         * Sum of the ConsumedWriteCapacityUnits metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        consumedWriteCapacityUnits(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "ConsumedWriteCapacityUnits",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+        /**
+         * Average of the ProvisionedReadCapacityUnits metric
+         *
+         * @default - Average over 5 minutes
+         */
+        provisionedReadCapacityUnits(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "ProvisionedReadCapacityUnits",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+        /**
+         * Average of the ProvisionedWriteCapacityUnits metric
+         *
+         * @default - Average over 5 minutes
+         */
+        provisionedWriteCapacityUnits(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "ProvisionedWriteCapacityUnits",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+        /**
+         * Sum of the ReadThrottleEvents metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        readThrottleEvents(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "ReadThrottleEvents",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+        /**
+         * Sum of the TimeToLiveDeletedItemCount metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        timeToLiveDeletedItemCount(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "TimeToLiveDeletedItemCount",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+        /**
+         * Average of the TransactionConflict metric
+         *
+         * @default - Average over 5 minutes
+         */
+        transactionConflict(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "TransactionConflict",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+        /**
+         * Sum of the WriteThrottleEvents metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        writeThrottleEvents(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "WriteThrottleEvents",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+    }
+    DynamoDBMetrics.TableMetrics = TableMetrics;
+    /**
+     * Metrics for dimension set: GlobalSecondaryIndex {TableName, GlobalSecondaryIndexName}
+     *
+     * @stability external
+     */
+    class GlobalSecondaryIndexMetrics {
+        dimensions;
+        constructor(props) {
+            this.dimensions = {
+                TableName: props.tableName,
+                GlobalSecondaryIndexName: props.globalSecondaryIndexName
+            };
+        }
+        /**
+         * Sum of the ConsumedReadCapacityUnits metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        consumedReadCapacityUnits(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "ConsumedReadCapacityUnits",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+        /**
+         * Sum of the ConsumedWriteCapacityUnits metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        consumedWriteCapacityUnits(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "ConsumedWriteCapacityUnits",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+        /**
+         * Average of the ProvisionedReadCapacityUnits metric
+         *
+         * @default - Average over 5 minutes
+         */
+        provisionedReadCapacityUnits(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "ProvisionedReadCapacityUnits",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+        /**
+         * Average of the ProvisionedWriteCapacityUnits metric
+         *
+         * @default - Average over 5 minutes
+         */
+        provisionedWriteCapacityUnits(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "ProvisionedWriteCapacityUnits",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+        /**
+         * Sum of the ReadThrottleEvents metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        readThrottleEvents(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "ReadThrottleEvents",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+        /**
+         * Sum of the WriteThrottleEvents metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        writeThrottleEvents(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "WriteThrottleEvents",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+        /**
+         * Sum of the OnlineIndexConsumedWriteCapacity metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        onlineIndexConsumedWriteCapacity(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "OnlineIndexConsumedWriteCapacity",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+        /**
+         * Average of the OnlineIndexPercentageProgress metric
+         *
+         * @default - Average over 5 minutes
+         */
+        onlineIndexPercentageProgress(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "OnlineIndexPercentageProgress",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+        /**
+         * Sum of the OnlineIndexThrottleEvents metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        onlineIndexThrottleEvents(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "OnlineIndexThrottleEvents",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+    }
+    DynamoDBMetrics.GlobalSecondaryIndexMetrics = GlobalSecondaryIndexMetrics;
+    /**
+     * Known values for the GlobalSecondaryIndexName dimension
+     */
+    let GlobalSecondaryIndexMetricsGlobalSecondaryIndexName;
+    (function (GlobalSecondaryIndexMetricsGlobalSecondaryIndexName) {
+        /** GlobalSecondaryIndexName = GlobalSecondaryIndexName */
+        GlobalSecondaryIndexMetricsGlobalSecondaryIndexName["GLOBAL_SECONDARY_INDEX_NAME"] = "GlobalSecondaryIndexName";
+    })(GlobalSecondaryIndexMetricsGlobalSecondaryIndexName = DynamoDBMetrics.GlobalSecondaryIndexMetricsGlobalSecondaryIndexName || (DynamoDBMetrics.GlobalSecondaryIndexMetricsGlobalSecondaryIndexName = {}));
+    /**
+     * Metrics for dimension set: Operation {TableName, Operation}
+     *
+     * @stability external
+     */
+    class OperationMetrics {
+        dimensions;
+        constructor(props) {
+            this.dimensions = {
+                TableName: props.tableName,
+                Operation: props.operation
+            };
+        }
+        /**
+         * Sum of the ReturnedItemCount metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        returnedItemCount(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "ReturnedItemCount",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+        /**
+         * Average of the SuccessfulRequestLatency metric
+         *
+         * @default - Average over 5 minutes
+         */
+        successfulRequestLatency(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "SuccessfulRequestLatency",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+        /**
+         * Sum of the SystemErrors metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        systemErrors(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "SystemErrors",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+        /**
+         * Sum of the ThrottledRequests metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        throttledRequests(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "ThrottledRequests",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+    }
+    DynamoDBMetrics.OperationMetrics = OperationMetrics;
+    /**
+     * Known values for the Operation dimension
+     */
+    let OperationMetricsOperation;
+    (function (OperationMetricsOperation) {
+        /** Operation = GetItem */
+        OperationMetricsOperation["GET_ITEM"] = "GetItem";
+        /** Operation = PutItem */
+        OperationMetricsOperation["PUT_ITEM"] = "PutItem";
+        /** Operation = Scan */
+        OperationMetricsOperation["SCAN"] = "Scan";
+        /** Operation = BatchExecuteStatement */
+        OperationMetricsOperation["BATCH_EXECUTE_STATEMENT"] = "BatchExecuteStatement";
+        /** Operation = BatchGetItem */
+        OperationMetricsOperation["BATCH_GET_ITEM"] = "BatchGetItem";
+        /** Operation = BatchWriteItem */
+        OperationMetricsOperation["BATCH_WRITE_ITEM"] = "BatchWriteItem";
+        /** Operation = DeleteItem */
+        OperationMetricsOperation["DELETE_ITEM"] = "DeleteItem";
+        /** Operation = ExecuteStatement */
+        OperationMetricsOperation["EXECUTE_STATEMENT"] = "ExecuteStatement";
+        /** Operation = ExecuteTransaction */
+        OperationMetricsOperation["EXECUTE_TRANSACTION"] = "ExecuteTransaction";
+        /** Operation = Query */
+        OperationMetricsOperation["QUERY"] = "Query";
+        /** Operation = TransactGetItems */
+        OperationMetricsOperation["TRANSACT_GET_ITEMS"] = "TransactGetItems";
+        /** Operation = TransactWriteItems */
+        OperationMetricsOperation["TRANSACT_WRITE_ITEMS"] = "TransactWriteItems";
+        /** Operation = UpdateItem */
+        OperationMetricsOperation["UPDATE_ITEM"] = "UpdateItem";
+        /** Operation = GetRecords */
+        OperationMetricsOperation["GET_RECORDS"] = "GetRecords";
+    })(OperationMetricsOperation = DynamoDBMetrics.OperationMetricsOperation || (DynamoDBMetrics.OperationMetricsOperation = {}));
+    /**
+     * Metrics for dimension set: DelegatedOperation {TableName, DelegatedOperation}
+     *
+     * @stability external
+     */
+    class DelegatedOperationMetrics {
+        dimensions;
+        constructor(props) {
+            this.dimensions = {
+                TableName: props.tableName,
+                DelegatedOperation: props.delegatedOperation
+            };
+        }
+        /**
+         * Average of the AgeOfOldestUnreplicatedRecord metric
+         *
+         * @default - Average over 5 minutes
+         */
+        ageOfOldestUnreplicatedRecord(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "AgeOfOldestUnreplicatedRecord",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+        /**
+         * Average of the ConsumedChangeDataCaptureUnits metric
+         *
+         * @default - Average over 5 minutes
+         */
+        consumedChangeDataCaptureUnits(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "ConsumedChangeDataCaptureUnits",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+        /**
+         * Average of the ThrottledPutRecordCount metric
+         *
+         * @default - Average over 5 minutes
+         */
+        throttledPutRecordCount(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "ThrottledPutRecordCount",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+    }
+    DynamoDBMetrics.DelegatedOperationMetrics = DelegatedOperationMetrics;
+    /**
+     * Metrics for dimension set: ReceivingRegion {TableName, ReceivingRegion}
+     *
+     * @stability external
+     */
+    class ReceivingRegionMetrics {
+        dimensions;
+        constructor(props) {
+            this.dimensions = {
+                TableName: props.tableName,
+                ReceivingRegion: props.receivingRegion
+            };
+        }
+        /**
+         * Average of the PendingReplicationCount metric
+         *
+         * @default - Average over 5 minutes
+         */
+        pendingReplicationCount(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "PendingReplicationCount",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+        /**
+         * Average of the ReplicationLatency metric
+         *
+         * @default - Average over 5 minutes
+         */
+        replicationLatency(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "ReplicationLatency",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+    }
+    DynamoDBMetrics.ReceivingRegionMetrics = ReceivingRegionMetrics;
+    /**
+     * Metrics for dimension set: OperationPerStream {TableName, StreamLabel, Operation}
+     *
+     * @stability external
+     */
+    class OperationPerStreamMetrics {
+        dimensions;
+        constructor(props) {
+            this.dimensions = {
+                TableName: props.tableName,
+                StreamLabel: props.streamLabel,
+                Operation: props.operation
+            };
+        }
+        /**
+         * Average of the ReturnedBytes metric
+         *
+         * @default - Average over 5 minutes
+         */
+        returnedBytes(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "ReturnedBytes",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+        /**
+         * Average of the ReturnedRecordsCount metric
+         *
+         * @default - Average over 5 minutes
+         */
+        returnedRecordsCount(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "ReturnedRecordsCount",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+    }
+    DynamoDBMetrics.OperationPerStreamMetrics = OperationPerStreamMetrics;
+    /**
+     * Metrics for dimension set: Account {no dimensions}
+     *
+     * @stability external
+     */
+    class AccountMetrics {
+        dimensions;
+        constructor() {
+            this.dimensions = {};
+        }
+        /**
+         * Maximum of the AccountMaxReads metric
+         *
+         * @default - Maximum over 5 minutes
+         */
+        accountMaxReads(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "AccountMaxReads",
+                dimensionsMap: this.dimensions,
+                statistic: "Maximum",
+                ...options
+            });
+        }
+        /**
+         * Maximum of the AccountMaxTableLevelReads metric
+         *
+         * @default - Maximum over 5 minutes
+         */
+        accountMaxTableLevelReads(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "AccountMaxTableLevelReads",
+                dimensionsMap: this.dimensions,
+                statistic: "Maximum",
+                ...options
+            });
+        }
+        /**
+         * Maximum of the AccountMaxTableLevelWrites metric
+         *
+         * @default - Maximum over 5 minutes
+         */
+        accountMaxTableLevelWrites(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "AccountMaxTableLevelWrites",
+                dimensionsMap: this.dimensions,
+                statistic: "Maximum",
+                ...options
+            });
+        }
+        /**
+         * Maximum of the AccountMaxWrites metric
+         *
+         * @default - Maximum over 5 minutes
+         */
+        accountMaxWrites(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "AccountMaxWrites",
+                dimensionsMap: this.dimensions,
+                statistic: "Maximum",
+                ...options
+            });
+        }
+        /**
+         * Average of the AccountProvisionedReadCapacityUtilization metric
+         *
+         * @default - Average over 5 minutes
+         */
+        accountProvisionedReadCapacityUtilization(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "AccountProvisionedReadCapacityUtilization",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+        /**
+         * Average of the AccountProvisionedWriteCapacityUtilization metric
+         *
+         * @default - Average over 5 minutes
+         */
+        accountProvisionedWriteCapacityUtilization(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "AccountProvisionedWriteCapacityUtilization",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+        /**
+         * Average of the MaxProvisionedTableReadCapacityUtilization metric
+         *
+         * @default - Average over 5 minutes
+         */
+        maxProvisionedTableReadCapacityUtilization(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "MaxProvisionedTableReadCapacityUtilization",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+        /**
+         * Average of the MaxProvisionedTableWriteCapacityUtilization metric
+         *
+         * @default - Average over 5 minutes
+         */
+        maxProvisionedTableWriteCapacityUtilization(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "MaxProvisionedTableWriteCapacityUtilization",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+        /**
+         * Sum of the UserErrors metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        userErrors(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/DynamoDB",
+                metricName: "UserErrors",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+    }
+    DynamoDBMetrics.AccountMetrics = AccountMetrics;
+})(DynamoDBMetrics || (exports.DynamoDBMetrics = DynamoDBMetrics = {}));