@aws-amplify/graphql-api-construct 1.18.3-ai-next.0 → 1.18.3

package/node_modules/@aws-cdk/cfnspec/lib/augmentations/AWS_RDS_DBCluster.json

@@ -0,0 +1,70 @@
+{
+  "options": {
+    "classFile": "cluster",
+    "class": "DatabaseClusterBase",
+    "interfaceFile": "cluster-ref",
+    "interface": "IDatabaseCluster"
+  },
+  "metrics": {
+    "namespace": "AWS/RDS",
+    "dimensions": { "DBClusterIdentifier": "this.clusterIdentifier" },
+    "metrics": [
+      {
+        "name": "CPUUtilization",
+        "documentation": "The percentage of CPU utilization."
+      },
+      {
+        "name": "DatabaseConnections",
+        "documentation": "The number of database connections in use."
+      },
+      {
+        "name": "Deadlocks",
+        "documentation": "The average number of deadlocks in the database per second."
+      },
+      {
+        "name": "EngineUptime",
+        "documentation": "The amount of time that the instance has been running, in seconds."
+      },
+      {
+        "name": "FreeableMemory",
+        "documentation": "The amount of available random access memory, in bytes."
+      },
+      {
+        "name": "FreeLocalStorage",
+        "documentation": "The amount of local storage available, in bytes."
+      },
+      {
+        "name": "NetworkReceiveThroughput",
+        "documentation": "The amount of network throughput received from clients by each instance, in bytes per second."
+      },
+      {
+        "name": "NetworkThroughput",
+        "documentation": "The amount of network throughput both received from and transmitted to clients by each instance, in bytes per second."
+      },
+      {
+        "name": "NetworkTransmitThroughput",
+        "documentation": "The amount of network throughput sent to clients by each instance, in bytes per second."
+      },
+      {
+        "name": "SnapshotStorageUsed",
+        "documentation": "The total amount of backup storage in bytes consumed by all Aurora snapshots outside its backup retention window."
+      },
+      {
+        "name": "TotalBackupStorageBilled",
+        "documentation": "The total amount of backup storage in bytes for which you are billed."
+      },
+      {
+        "name": "VolumeBytesUsed",
+        "documentation": "The amount of storage used by your Aurora DB instance, in bytes."
+      },
+      {
+        "name": "VolumeReadIOPs",
+        "documentation": "The number of billed read I/O operations from a cluster volume, reported at 5-minute intervals."
+      },
+      {
+        "name": "VolumeWriteIOPs",
+        "documentation": "The number of write disk I/O operations to the cluster volume, reported at 5-minute intervals."
+      }
+    ]
+  }
+}

package/node_modules/@aws-cdk/cfnspec/lib/augmentations/AWS_RDS_DBInstance.json

@@ -0,0 +1,37 @@
+{
+  "options": {
+    "classFile": "instance",
+    "class": "DatabaseInstanceBase",
+    "interface": "IDatabaseInstance"
+  },
+  "metrics": {
+    "namespace": "AWS/RDS",
+    "dimensions": { "DBInstanceIdentifier": "this.instanceIdentifier" },
+    "metrics": [
+      {
+        "name": "CPUUtilization",
+        "documentation": "The percentage of CPU utilization."
+      },
+      {
+        "name": "DatabaseConnections",
+        "documentation": "The number of database connections in use."
+      },
+      {
+        "name": "FreeStorageSpace",
+        "documentation": "The amount of available storage space."
+      },
+      {
+        "name": "FreeableMemory",
+        "documentation": "The amount of available random access memory."
+      },
+      {
+        "name": "WriteIOPS",
+        "documentation": "The average number of disk read I/O operations per second."
+      },
+      {
+        "name": "ReadIOPS",
+        "documentation": "The average number of disk write I/O operations per second."
+      }
+    ]
+  }
+}

package/node_modules/@aws-cdk/cfnspec/lib/augmentations/AWS_SNS_Topic.json

@@ -0,0 +1,52 @@
+{
+  "metrics": {
+    "namespace": "AWS/SNS",
+    "dimensions": { "TopicName": "this.topicName" },
+    "metrics": [
+      {
+        "name": "PublishSize",
+        "documentation": "Metric for the size of messages published through this topic"
+      },
+      {
+        "name": "NumberOfMessagesPublished",
+        "documentation": "The number of messages published to your Amazon SNS topics.",
+        "type": "count"
+      },
+      {
+        "name": "NumberOfNotificationsDelivered",
+        "documentation": "The number of messages successfully delivered from your Amazon SNS topics to subscribing endpoints.",
+        "type": "count"
+      },
+      {
+        "name": "NumberOfNotificationsFailed",
+        "documentation": "The number of messages that Amazon SNS failed to deliver.",
+        "type": "count"
+      },
+      {
+        "name": "NumberOfNotificationsFilteredOut",
+        "documentation": "The number of messages that were rejected by subscription filter policies.",
+        "type": "count"
+      },
+      {
+        "name": "NumberOfNotificationsFilteredOut-NoMessageAttributes",
+        "documentation": "The number of messages that were rejected by subscription filter policies because the messages have no attributes.",
+        "type": "count"
+      },
+      {
+        "name": "NumberOfNotificationsFilteredOut-InvalidAttributes",
+        "documentation": "The number of messages that were rejected by subscription filter policies because the messages' attributes are invalid",
+        "type": "count"
+      },
+      {
+        "name": "SMSMonthToDateSpentUSD",
+        "documentation": "The charges you have accrued since the start of the current calendar month for sending SMS messages.",
+        "type": "gauge"
+      },
+      {
+        "name": "SMSSuccessRate",
+        "documentation": "The rate of successful SMS message deliveries.",
+        "type": "count"
+      }
+    ]
+  }
+}

package/node_modules/@aws-cdk/cfnspec/lib/augmentations/AWS_SQS_Queue.json

@@ -0,0 +1,53 @@
+{
+  "metrics": {
+    "namespace": "AWS/SQS",
+    "dimensions": { "QueueName": "this.queueName" },
+    "metrics": [
+      {
+        "name": "ApproximateAgeOfOldestMessage",
+        "documentation": "The approximate age of the oldest non-deleted message in the queue.",
+        "type": "gauge"
+      },
+      {
+        "name": "ApproximateNumberOfMessagesDelayed",
+        "documentation": "The number of messages in the queue that are delayed and not available for reading immediately.",
+        "type": "gauge"
+      },
+      {
+        "name": "ApproximateNumberOfMessagesNotVisible",
+        "documentation": "The number of messages that are in flight.",
+        "type": "gauge"
+      },
+      {
+        "name": "ApproximateNumberOfMessagesVisible",
+        "documentation": "The number of messages available for retrieval from the queue.",
+        "type": "gauge"
+      },
+      {
+        "name": "NumberOfEmptyReceives",
+        "documentation": "The number of ReceiveMessage API calls that did not return a message.",
+        "type": "count"
+      },
+      {
+        "name": "NumberOfMessagesDeleted",
+        "documentation": "The number of messages deleted from the queue.",
+        "type": "count"
+      },
+      {
+        "name": "NumberOfMessagesReceived",
+        "documentation": "The number of messages returned by calls to the ReceiveMessage action.",
+        "type": "count"
+      },
+      {
+        "name": "NumberOfMessagesSent",
+        "documentation": "The number of messages added to a queue.",
+        "type": "count"
+      },
+      {
+        "name": "SentMessageSize",
+        "documentation": "The size of messages added to a queue."
+      }
+    ]
+  }
+}
+

package/node_modules/@aws-cdk/cfnspec/lib/canned-metrics/README.md

@@ -0,0 +1,168 @@
+# Canned Metrics
+
+This source of AWS metrics is kindly provided to us by the CloudWatch Explorer team
+(and used in their console).
+
+## What are we generating?
+
+We are currently generating helpers to make it easier to product the `object.metricXXX()`
+methods on resources. They will take care of the props (but not of instantiating a
+`cloudwatch.Metric` object).
+
+## Why are we not generating customer facing APIs from these?
+
+We totally should, however there are some concerns that make this non-trivial.
+
+All of the following concerns would require manual annotations.
+
+### Adding methods
+
+Our metrics helpers currently live ON the resource objects and interfaces.
+
+This makes it so we have to codegen additional methods onto handwritten classes. This is not
+impossible, and "augmentations" already do that, but it's somewhat uncomfortable. We need
+to know interface and class names to codegen the appropriate additional methods, so these
+need to be annotated everywhere.
+
+### Renaming metrics
+
+Whether this is a good thing or a bad thing might be a matter of opinion, but we
+do rename metrics methods from the canonical names to make them more readable.
+
+API Gateway: 4xx/5xx are translated to client/server
+
+```js
+metricClientError => '4XXError'
+metricServerError => '5XXError'
+```
+
+StepFunctions State Machine: remove "executions", hide plurality change
+
+```js
+metricFailed => 'ExecutionsFailed'
+metricThrottled => 'ExecutionThrottled' // Yes the 's' is missing on purpose!
+```
+
+Renames will need to be annotated.
+
+Some metrics functions don't even map to a single metric because the actual
+metric name is a parameter.
+
+ApplicationLoadBalancer: The metric method indicates the SOURCE of the
+HTTP code (ELB or backend), the metric name itself comes from an ENUM.
+
+```js
+  public metricHttpCodeElb(code: HttpCodeElb, props?: cloudwatch.MetricOptions) {
+  public metricHttpCodeTarget(code: HttpCodeTarget, props?: cloudwatch.MetricOptions) {
+```
+
+NetworkLoadBalancer: get rid of underscores and recapitalize abbreviations
+
+```js
+metricTcpClientResetCount => 'TCP_Client_Reset_Count'
+```
+
+### Mapping dimensions to attribute names
+
+Attribute names are chosen by hand, but dimension names are fixed. We need some kind
+of mapping between the value that needs to go into the dimension, and the attribute
+of the resource that we get it from.
+
+Examples:
+
+CodeBuild (simple enough)
+
+```js
+dimensions: { ProjectName: project.projectName },
+```
+
+API Gateway (slightly less clear)
+
+```js
+dimensions: { ApiName: api.restApiName },
+```
+
+ALB (even less clear)
+
+```js
+dimensions: { LoadBalancer: resource.loadBalancerFullName }
+```
+
+This mapping requires annotations somewhere.
+
+### Metrics not consistently available on interface
+
+Some of these dimension values are available for imported resources, but some
+are not. In the examples above, `restApiName` and `loadBalancerFullName` are
+only available as return values by CloudFormation, and are not known for
+imported resources (as they are different identifiers than we usually expect
+people to import by).
+
+This means that the metrics cannot be made available on the resources
+**interfaces**, only on the resource **classes**.
+
+The lack of consistency here makes it harder to codegen for (requires
+annotations).
+
+## Additional logic in metrics methods
+
+Although *many* metrics are simply of the form "give me this value for this resource",
+not all of them are. Some require additional parameters or additional logic.
+
+Examples:
+
+ChatBot Slack configuration: metrics only in `us-east-1` regardless of stack region
+
+```js
+    return new cloudwatch.Metric({
+      namespace: 'AWS/Chatbot',
+      region: 'us-east-1',
+      dimensions: {
+        ConfigurationName: this.slackChannelConfigurationName,
+      },
+      metricName,
+      ...props,
+    });
+  }
+```
+
+### Resource dimensions aren't necessarily complete
+
+Some metrics require an additional dimensions that is not part of the resource
+definition.
+
+DynamoDB: User must supply an additional `Operation` dimension
+
+Some metrics are emitted under `{ TableName, Operation }` instead of just `TableName`.
+The API will have to have a non-standard shape like:
+
+```js
+  public metricSystemErrors(operation: Operation, options?: cloudwatch.MetricOptions): cloudwatch.IMetric {
+```
+
+### No docstrings
+
+All of our methods have docstrings that try and describe what the metric actually
+represents.
+
+The model from CloudWatch Explorer does not have docstrings, so we would
+still need to annotate them to make it user friendly.
+
+### Incomplete model
+
+The CW Model is certainly very exhaustive, but it's not complete. We currently
+have metrics methods we would lose if we were to switch over completely.
+
+### Backwards compatibility of default statistics
+
+Since the CW Explorer team uses
+these metrics as templates, they are free to change them at any time. For
+example, when they decide that a `defaultStatistic` of `Average` should have
+been `Sum`, for example. On the other hand, we have a fixed statistic
+contract -- once a metric object emits under a particular statistic, we can
+never change it or we will break downstream users.
+
+
+## Updating
+
+To update these metrics, see the `build-tools/update-metrics.sh` script.

package/node_modules/@aws-cdk/cfnspec/lib/canned-metrics/canned-metrics-schema.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Get the canned metrics source file
+ */
+export declare function loadCannedMetricsFile(): CannedMetricsFile;
+/**
+ * Schema definitions for the accompanying file "services.json".
+ */
+export declare type CannedMetricsFile = MetricInfoGroup[];
+export interface MetricInfoGroup {
+    /**
+     * List of metric templates
+     */
+    readonly metricTemplates: MetricTemplate[];
+}
+export interface MetricTemplate {
+    /**
+     * CloudFormation resource name
+     */
+    readonly resourceType: string;
+    /**
+     * Metric namespace
+     */
+    readonly namespace: string;
+    /**
+     * Set of dimensions for this set of metrics
+     */
+    readonly dimensions: Dimension[];
+    /**
+     * Set of metrics these dimensions apply to
+     */
+    readonly metrics: Metric[];
+}
+/**
+ * Dimension for this set of metric templates
+ */
+export interface Dimension {
+    /**
+     * Name of the dimension
+     */
+    readonly dimensionName: string;
+    /**
+     * A potential fixed value for this dimension
+     *
+     * (Currently unused by the spec reader, but could be used)
+     */
+    readonly dimensionValue?: string;
+}
+/**
+ * A description of an available metric
+ */
+export interface Metric {
+    /**
+     * Name of the metric
+     */
+    readonly name: string;
+    /**
+     * Default (suggested) statistic for this metric
+     */
+    readonly defaultStat: string;
+}

package/node_modules/@aws-cdk/cfnspec/lib/canned-metrics/canned-metrics-schema.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadCannedMetricsFile = void 0;
+/**
+ * Get the canned metrics source file
+ */
+function loadCannedMetricsFile() {
+    // eslint-disable-next-line @typescript-eslint/no-require-imports
+    return require('./services.json');
+}
+exports.loadCannedMetricsFile = loadCannedMetricsFile;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2FubmVkLW1ldHJpY3Mtc2NoZW1hLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiY2FubmVkLW1ldHJpY3Mtc2NoZW1hLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBOztHQUVHO0FBQ0gsU0FBZ0IscUJBQXFCO0lBQ25DLGlFQUFpRTtJQUNqRSxPQUFPLE9BQU8sQ0FBQyxpQkFBaUIsQ0FBQyxDQUFDO0FBQ3BDLENBQUM7QUFIRCxzREFHQyIsInNvdXJjZXNDb250ZW50IjpbIi8qKlxuICogR2V0IHRoZSBjYW5uZWQgbWV0cmljcyBzb3VyY2UgZmlsZVxuICovXG5leHBvcnQgZnVuY3Rpb24gbG9hZENhbm5lZE1ldHJpY3NGaWxlKCk6IENhbm5lZE1ldHJpY3NGaWxlIHtcbiAgLy8gZXNsaW50LWRpc2FibGUtbmV4dC1saW5lIEB0eXBlc2NyaXB0LWVzbGludC9uby1yZXF1aXJlLWltcG9ydHNcbiAgcmV0dXJuIHJlcXVpcmUoJy4vc2VydmljZXMuanNvbicpO1xufVxuXG4vKipcbiAqIFNjaGVtYSBkZWZpbml0aW9ucyBmb3IgdGhlIGFjY29tcGFueWluZyBmaWxlIFwic2VydmljZXMuanNvblwiLlxuICovXG5leHBvcnQgdHlwZSBDYW5uZWRNZXRyaWNzRmlsZSA9IE1ldHJpY0luZm9Hcm91cFtdO1xuXG5leHBvcnQgaW50ZXJmYWNlIE1ldHJpY0luZm9Hcm91cCB7XG4gIC8qKlxuICAgKiBMaXN0IG9mIG1ldHJpYyB0ZW1wbGF0ZXNcbiAgICovXG4gIHJlYWRvbmx5IG1ldHJpY1RlbXBsYXRlczogTWV0cmljVGVtcGxhdGVbXTtcbn1cblxuXG5leHBvcnQgaW50ZXJmYWNlIE1ldHJpY1RlbXBsYXRlIHtcbiAgLyoqXG4gICAqIENsb3VkRm9ybWF0aW9uIHJlc291cmNlIG5hbWVcbiAgICovXG4gIHJlYWRvbmx5IHJlc291cmNlVHlwZTogc3RyaW5nO1xuXG4gIC8qKlxuICAgKiBNZXRyaWMgbmFtZXNwYWNlXG4gICAqL1xuICByZWFkb25seSBuYW1lc3BhY2U6IHN0cmluZztcblxuICAvKipcbiAgICogU2V0IG9mIGRpbWVuc2lvbnMgZm9yIHRoaXMgc2V0IG9mIG1ldHJpY3NcbiAgICovXG4gIHJlYWRvbmx5IGRpbWVuc2lvbnM6IERpbWVuc2lvbltdO1xuXG4gIC8qKlxuICAgKiBTZXQgb2YgbWV0cmljcyB0aGVzZSBkaW1lbnNpb25zIGFwcGx5IHRvXG4gICAqL1xuICByZWFkb25seSBtZXRyaWNzOiBNZXRyaWNbXTtcbn1cblxuLyoqXG4gKiBEaW1lbnNpb24gZm9yIHRoaXMgc2V0IG9mIG1ldHJpYyB0ZW1wbGF0ZXNcbiAqL1xuZXhwb3J0IGludGVyZmFjZSBEaW1lbnNpb24ge1xuICAvKipcbiAgICogTmFtZSBvZiB0aGUgZGltZW5zaW9uXG4gICAqL1xuICByZWFkb25seSBkaW1lbnNpb25OYW1lOiBzdHJpbmc7XG5cbiAgLyoqXG4gICAqIEEgcG90ZW50aWFsIGZpeGVkIHZhbHVlIGZvciB0aGlzIGRpbWVuc2lvblxuICAgKlxuICAgKiAoQ3VycmVudGx5IHVudXNlZCBieSB0aGUgc3BlYyByZWFkZXIsIGJ1dCBjb3VsZCBiZSB1c2VkKVxuICAgKi9cbiAgcmVhZG9ubHkgZGltZW5zaW9uVmFsdWU/OiBzdHJpbmc7XG59XG5cbi8qKlxuICogQSBkZXNjcmlwdGlvbiBvZiBhbiBhdmFpbGFibGUgbWV0cmljXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgTWV0cmljIHtcbiAgLyoqXG4gICAqIE5hbWUgb2YgdGhlIG1ldHJpY1xuICAgKi9cbiAgcmVhZG9ubHkgbmFtZTogc3RyaW5nO1xuXG4gIC8qKlxuICAgKiBEZWZhdWx0IChzdWdnZXN0ZWQpIHN0YXRpc3RpYyBmb3IgdGhpcyBtZXRyaWNcbiAgICovXG4gIHJlYWRvbmx5IGRlZmF1bHRTdGF0OiBzdHJpbmc7XG59Il19