Amazon EC2 Auto Scaling · JSON Structure

Ec2 Auto Scaling Metric Stat Structure

This structure defines the CloudWatch metric to return, along with the statistic, period, and unit.

For more information about the CloudWatch terminology below, see Amazon CloudWatch concepts in the Amazon CloudWatch User Guide.

Type: object Properties: 3 Required: 2
Amazon Web ServicesAuto ScalingComputeEC2High AvailabilityScaling

MetricStat is a JSON Structure definition published by Amazon EC2 Auto Scaling, describing 3 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Metric Stat Unit

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-ec2-auto-scaling/refs/heads/main/json-structure/ec2-auto-scaling-metric-stat-structure.json",
  "name": "MetricStat",
  "description": "<p>This structure defines the CloudWatch metric to return, along with the statistic, period, and unit.</p> <p>For more information about the CloudWatch terminology below, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html\">Amazon CloudWatch concepts</a> in the <i>Amazon CloudWatch User Guide</i>.</p>",
  "type": "object",
  "properties": {
    "Metric": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Metric"
        },
        {
          "description": "The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html\">Metric</a> object that is returned by a call to <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html\">ListMetrics</a>."
        }
      ]
    },
    "Stat": {
      "allOf": [
        {
          "$ref": "#/components/schemas/XmlStringMetricStat"
        },
        {
          "description": "<p>The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic\">Statistics</a> in the <i>Amazon CloudWatch User Guide</i>.</p> <p>The most commonly used metrics for predictive scaling are <code>Average</code> and <code>Sum</code>.</p>"
        }
      ]
    },
    "Unit": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MetricUnit"
        },
        {
          "description": "The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html\">MetricDatum</a> data type in the <i>Amazon CloudWatch API Reference</i>."
        }
      ]
    }
  },
  "required": [
    "Metric",
    "Stat"
  ]
}