Amazon EC2 Auto Scaling · Schema
PredefinedMetricSpecification
Represents a predefined metric for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.
Amazon Web ServicesAuto ScalingComputeEC2High AvailabilityScaling
Properties
| Name | Type | Description |
|---|---|---|
| PredefinedMetricType | object | |
| ResourceLabel | object |
JSON Schema
{
"$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-predefined-metric-specification-schema.json",
"title": "PredefinedMetricSpecification",
"description": "Represents a predefined metric for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.",
"type": "object",
"properties": {
"PredefinedMetricType": {
"allOf": [
{
"$ref": "#/components/schemas/MetricType"
},
{
"description": "<p>The metric type. The following predefined metrics are available:</p> <ul> <li> <p> <code>ASGAverageCPUUtilization</code> - Average CPU utilization of the Auto Scaling group.</p> </li> <li> <p> <code>ASGAverageNetworkIn</code> - Average number of bytes received on all network interfaces by the Auto Scaling group.</p> </li> <li> <p> <code>ASGAverageNetworkOut</code> - Average number of bytes sent out on all network interfaces by the Auto Scaling group.</p> </li> <li> <p> <code>ALBRequestCountPerTarget</code> - Average Application Load Balancer request count per target for your Auto Scaling group.</p> </li> </ul>"
}
]
},
"ResourceLabel": {
"allOf": [
{
"$ref": "#/components/schemas/XmlStringMaxLen1023"
},
{
"description": "<p>A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.</p> <p>You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:</p> <p> <code>app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff</code>.</p> <p>Where:</p> <ul> <li> <p>app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN</p> </li> <li> <p>targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.</p> </li> </ul> <p>To find the ARN for an Application Load Balancer, use the <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html\">DescribeLoadBalancers</a> API operation. To find the ARN for the target group, use the <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html\">DescribeTargetGroups</a> API operation.</p>"
}
]
}
},
"required": [
"PredefinedMetricType"
]
}