Amazon Compute Optimizer · JSON Structure

Compute Optimizer Auto Scaling Group Recommendation Option Structure

Describes a recommendation option for an Auto Scaling group.

Type: object Properties: 6
Cost OptimizationFinOpsMachine LearningResource Recommendations

AutoScalingGroupRecommendationOption is a JSON Structure definition published by Amazon Compute Optimizer, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

configuration projectedUtilizationMetrics performanceRisk rank savingsOpportunity migrationEffort

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-compute-optimizer/refs/heads/main/json-structure/compute-optimizer-auto-scaling-group-recommendation-option-structure.json",
  "name": "AutoScalingGroupRecommendationOption",
  "description": "Describes a recommendation option for an Auto Scaling group.",
  "type": "object",
  "properties": {
    "configuration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AutoScalingGroupConfiguration"
        },
        {
          "description": "An array of objects that describe an Auto Scaling group configuration."
        }
      ]
    },
    "projectedUtilizationMetrics": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProjectedUtilizationMetrics"
        },
        {
          "description": "<p>An array of objects that describe the projected utilization metrics of the Auto Scaling group recommendation option.</p> <note> <p>The <code>Cpu</code> and <code>Memory</code> metrics are the only projected utilization metrics returned. Additionally, the <code>Memory</code> metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see <a href=\"https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent\">Enabling Memory Utilization with the CloudWatch Agent</a>.</p> </note>"
        }
      ]
    },
    "performanceRisk": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PerformanceRisk"
        },
        {
          "description": "<p>The performance risk of the Auto Scaling group configuration recommendation.</p> <p>Performance risk indicates the likelihood of the recommended instance type not meeting the resource needs of your workload. Compute Optimizer calculates an individual performance risk score for each specification of the recommended instance, including CPU, memory, EBS throughput, EBS IOPS, disk throughput, disk IOPS, network throughput, and network PPS. The performance risk of the recommended instance is calculated as the maximum performance risk score across the analyzed resource specifications.</p> <p>The value ranges from <code>0</code> - <code>4</code>, with <code>0</code> meaning that the recommended resource is predicted to always provide enough hardware capability. The higher the performance risk is, the more likely you should validate whether the recommendation will meet the performance requirements of your workload before migrating your resource.</p>"
        }
      ]
    },
    "rank": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Rank"
        },
        {
          "description": "<p>The rank of the Auto Scaling group recommendation option.</p> <p>The top recommendation option is ranked as <code>1</code>.</p>"
        }
      ]
    },
    "savingsOpportunity": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SavingsOpportunity"
        },
        {
          "description": "An object that describes the savings opportunity for the Auto Scaling group recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage."
        }
      ]
    },
    "migrationEffort": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MigrationEffort"
        },
        {
          "description": "<p>The level of effort required to migrate from the current instance type to the recommended instance type.</p> <p>For example, the migration effort is <code>Low</code> if Amazon EMR is the inferred workload type and an Amazon Web Services Graviton instance type is recommended. The migration effort is <code>Medium</code> if a workload type couldn't be inferred but an Amazon Web Services Graviton instance type is recommended. The migration effort is <code>VeryLow</code> if both the current and recommended instance types are of the same CPU architecture.</p>"
        }
      ]
    }
  }
}