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

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

@@ -0,0 +1,159 @@
+import * as cloudwatch from "aws-cdk-lib/aws-cloudwatch";
+import { IActivityRef, IStateMachineRef } from "aws-cdk-lib/aws-stepfunctions";
+/**
+ * CloudWatch metrics facade for AWS/States
+ * This class contains helper functions to initialize the dimension-sets classes
+ * for selected resources if available.
+ *
+ * @stability external
+ */
+export declare abstract class StatesMetrics {
+    /**
+     * Create ActivityMetrics from a Activity reference
+     */
+    static fromActivity(ref: IActivityRef): StatesMetrics.ActivityMetrics;
+    /**
+     * Create StateMachineMetrics from a StateMachine reference
+     */
+    static fromStateMachine(ref: IStateMachineRef): StatesMetrics.StateMachineMetrics;
+}
+export declare namespace StatesMetrics {
+    /**
+     * Metrics for dimension set: StateMachine {StateMachineArn}
+     *
+     * @stability external
+     */
+    class StateMachineMetrics {
+        private readonly dimensions;
+        constructor(props: StatesMetrics.StateMachineMetricsProps);
+        /**
+         * Sum of the ExecutionsAborted metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        executionsAborted(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Sum of the ExecutionsFailed metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        executionsFailed(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Sum of the ExecutionsStarted metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        executionsStarted(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Sum of the ExecutionsSucceeded metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        executionsSucceeded(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Sum of the ExecutionThrottled metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        executionThrottled(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Sum of the ExecutionsTimedOut metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        executionsTimedOut(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the ExecutionTime metric
+         *
+         * @default - Average over 5 minutes
+         */
+        executionTime(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+    }
+    /**
+     * Dimensions for StateMachineMetrics
+     *
+     * @struct
+     * @stability external
+     */
+    interface StateMachineMetricsProps {
+        /**
+         * The StateMachineArn dimension
+         */
+        readonly stateMachineArn: string;
+    }
+    /**
+     * Metrics for dimension set: Activity {ActivityArn}
+     *
+     * @stability external
+     */
+    class ActivityMetrics {
+        private readonly dimensions;
+        constructor(props: StatesMetrics.ActivityMetricsProps);
+        /**
+         * Sum of the ActivitiesFailed metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        activitiesFailed(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Sum of the ActivitiesHeartbeatTimedOut metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        activitiesHeartbeatTimedOut(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Sum of the ActivitiesScheduled metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        activitiesScheduled(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Sum of the ActivitiesStarted metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        activitiesStarted(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Sum of the ActivitiesSucceeded metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        activitiesSucceeded(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Sum of the ActivitiesTimedOut metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        activitiesTimedOut(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the ActivityRunTime metric
+         *
+         * @default - Average over 5 minutes
+         */
+        activityRunTime(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the ActivityScheduleTime metric
+         *
+         * @default - Average over 5 minutes
+         */
+        activityScheduleTime(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the ActivityTime metric
+         *
+         * @default - Average over 5 minutes
+         */
+        activityTime(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+    }
+    /**
+     * Dimensions for ActivityMetrics
+     *
+     * @struct
+     * @stability external
+     */
+    interface ActivityMetricsProps {
+        /**
+         * The ActivityArn dimension
+         */
+        readonly activityArn: string;
+    }
+}

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

@@ -0,0 +1,318 @@
+"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.StatesMetrics = void 0;
+/* eslint-disable @stylistic/max-len, eol-last */
+const cloudwatch = __importStar(require("aws-cdk-lib/aws-cloudwatch"));
+/**
+ * CloudWatch metrics facade for AWS/States
+ * This class contains helper functions to initialize the dimension-sets classes
+ * for selected resources if available.
+ *
+ * @stability external
+ */
+class StatesMetrics {
+    /**
+     * Create ActivityMetrics from a Activity reference
+     */
+    static fromActivity(ref) {
+        return new StatesMetrics.ActivityMetrics({
+            activityArn: ref.activityRef.activityArn
+        });
+    }
+    /**
+     * Create StateMachineMetrics from a StateMachine reference
+     */
+    static fromStateMachine(ref) {
+        return new StatesMetrics.StateMachineMetrics({
+            stateMachineArn: ref.stateMachineRef.stateMachineArn
+        });
+    }
+}
+exports.StatesMetrics = StatesMetrics;
+(function (StatesMetrics) {
+    /**
+     * Metrics for dimension set: StateMachine {StateMachineArn}
+     *
+     * @stability external
+     */
+    class StateMachineMetrics {
+        dimensions;
+        constructor(props) {
+            this.dimensions = {
+                StateMachineArn: props.stateMachineArn
+            };
+        }
+        /**
+         * Sum of the ExecutionsAborted metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        executionsAborted(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/States",
+                metricName: "ExecutionsAborted",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+        /**
+         * Sum of the ExecutionsFailed metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        executionsFailed(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/States",
+                metricName: "ExecutionsFailed",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+        /**
+         * Sum of the ExecutionsStarted metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        executionsStarted(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/States",
+                metricName: "ExecutionsStarted",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+        /**
+         * Sum of the ExecutionsSucceeded metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        executionsSucceeded(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/States",
+                metricName: "ExecutionsSucceeded",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+        /**
+         * Sum of the ExecutionThrottled metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        executionThrottled(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/States",
+                metricName: "ExecutionThrottled",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+        /**
+         * Sum of the ExecutionsTimedOut metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        executionsTimedOut(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/States",
+                metricName: "ExecutionsTimedOut",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+        /**
+         * Average of the ExecutionTime metric
+         *
+         * @default - Average over 5 minutes
+         */
+        executionTime(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/States",
+                metricName: "ExecutionTime",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+    }
+    StatesMetrics.StateMachineMetrics = StateMachineMetrics;
+    /**
+     * Metrics for dimension set: Activity {ActivityArn}
+     *
+     * @stability external
+     */
+    class ActivityMetrics {
+        dimensions;
+        constructor(props) {
+            this.dimensions = {
+                ActivityArn: props.activityArn
+            };
+        }
+        /**
+         * Sum of the ActivitiesFailed metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        activitiesFailed(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/States",
+                metricName: "ActivitiesFailed",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+        /**
+         * Sum of the ActivitiesHeartbeatTimedOut metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        activitiesHeartbeatTimedOut(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/States",
+                metricName: "ActivitiesHeartbeatTimedOut",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+        /**
+         * Sum of the ActivitiesScheduled metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        activitiesScheduled(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/States",
+                metricName: "ActivitiesScheduled",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+        /**
+         * Sum of the ActivitiesStarted metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        activitiesStarted(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/States",
+                metricName: "ActivitiesStarted",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+        /**
+         * Sum of the ActivitiesSucceeded metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        activitiesSucceeded(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/States",
+                metricName: "ActivitiesSucceeded",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+        /**
+         * Sum of the ActivitiesTimedOut metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        activitiesTimedOut(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/States",
+                metricName: "ActivitiesTimedOut",
+                dimensionsMap: this.dimensions,
+                statistic: "Sum",
+                ...options
+            });
+        }
+        /**
+         * Average of the ActivityRunTime metric
+         *
+         * @default - Average over 5 minutes
+         */
+        activityRunTime(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/States",
+                metricName: "ActivityRunTime",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+        /**
+         * Average of the ActivityScheduleTime metric
+         *
+         * @default - Average over 5 minutes
+         */
+        activityScheduleTime(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/States",
+                metricName: "ActivityScheduleTime",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+        /**
+         * Average of the ActivityTime metric
+         *
+         * @default - Average over 5 minutes
+         */
+        activityTime(options) {
+            return new cloudwatch.Metric({
+                namespace: "AWS/States",
+                metricName: "ActivityTime",
+                dimensionsMap: this.dimensions,
+                statistic: "Average",
+                ...options
+            });
+        }
+    }
+    StatesMetrics.ActivityMetrics = ActivityMetrics;
+})(StatesMetrics || (exports.StatesMetrics = StatesMetrics = {}));

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

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

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

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

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

@@ -0,0 +1,80 @@
+import * as cloudwatch from "aws-cdk-lib/aws-cloudwatch";
+import { ICanaryRef } from "aws-cdk-lib/aws-synthetics";
+/**
+ * CloudWatch metrics facade for CloudWatchSynthetics
+ * This class contains helper functions to initialize the dimension-sets classes
+ * for selected resources if available.
+ *
+ * @stability external
+ */
+export declare abstract class CloudWatchSyntheticsMetrics {
+    /**
+     * Create CanaryMetrics from a Canary reference
+     */
+    static fromCanary(ref: ICanaryRef): CloudWatchSyntheticsMetrics.CanaryMetrics;
+}
+export declare namespace CloudWatchSyntheticsMetrics {
+    /**
+     * Metrics for dimension set: Canary {CanaryName}
+     *
+     * @stability external
+     */
+    class CanaryMetrics {
+        private readonly dimensions;
+        constructor(props: CloudWatchSyntheticsMetrics.CanaryMetricsProps);
+        /**
+         * Sum of the 2xx metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        _2xx(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Sum of the 4xx metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        _4xx(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Sum of the 5xx metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        _5xx(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Maximum of the Duration metric
+         *
+         * @default - Maximum over 5 minutes
+         */
+        duration(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Sum of the Failed metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        failed(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Sum of the Failed requests metric
+         *
+         * @default - Sum over 5 minutes
+         */
+        failedRequests(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+        /**
+         * Average of the SuccessPercent metric
+         *
+         * @default - Average over 5 minutes
+         */
+        successPercent(options?: cloudwatch.MetricOptions): cloudwatch.IMetric;
+    }
+    /**
+     * Dimensions for CanaryMetrics
+     *
+     * @struct
+     * @stability external
+     */
+    interface CanaryMetricsProps {
+        /**
+         * The CanaryName dimension
+         */
+        readonly canaryName: string;
+    }
+}