TargetTrackingConfiguration

Represents a target tracking scaling policy configuration to use with Amazon EC2 Auto Scaling.

Amazon Web ServicesAuto ScalingComputeEC2High AvailabilityScaling

Properties

Name Type Description
PredefinedMetricSpecification object
CustomizedMetricSpecification object
TargetValue object
DisableScaleIn object
View JSON Schema on GitHub

JSON Schema

ec2-auto-scaling-target-tracking-configuration-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-ec2-auto-scaling/refs/heads/main/json-schema/ec2-auto-scaling-target-tracking-configuration-schema.json",
  "title": "TargetTrackingConfiguration",
  "description": "Represents a target tracking scaling policy configuration to use with Amazon EC2 Auto Scaling.",
  "type": "object",
  "properties": {
    "PredefinedMetricSpecification": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PredefinedMetricSpecification"
        },
        {
          "description": "A predefined metric. You must specify either a predefined metric or a customized metric."
        }
      ]
    },
    "CustomizedMetricSpecification": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CustomizedMetricSpecification"
        },
        {
          "description": "A customized metric. You must specify either a predefined metric or a customized metric."
        }
      ]
    },
    "TargetValue": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MetricScale"
        },
        {
          "description": "<p>The target value for the metric.</p> <note> <p>Some metrics are based on a count instead of a percentage, such as the request count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy specifies one of these metrics, specify the target utilization as the optimal average request or message count per instance during any one-minute interval. </p> </note>"
        }
      ]
    },
    "DisableScaleIn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DisableScaleIn"
        },
        {
          "description": "Indicates whether scaling in by the target tracking scaling policy is disabled. If scaling in is disabled, the target tracking scaling policy doesn't remove instances from the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from the Auto Scaling group. The default is <code>false</code>."
        }
      ]
    }
  },
  "required": [
    "TargetValue"
  ]
}