Class: Aws::AutoScaling::Types::PredefinedMetricSpecification

Inherits:

Struct

Object
Struct
Aws::AutoScaling::Types::PredefinedMetricSpecification

show all

Includes:: Structure

Defined in:: lib/aws-sdk-autoscaling/types.rb

Overview

Note:

When making an API call, you may pass PredefinedMetricSpecification data as a hash:

{
  predefined_metric_type: "ASGAverageCPUUtilization", # required, accepts ASGAverageCPUUtilization, ASGAverageNetworkIn, ASGAverageNetworkOut, ALBRequestCountPerTarget
  resource_label: "XmlStringMaxLen1023",
}

Configures a predefined metric for a target tracking policy.

Instance Attribute Summary collapse

#predefined_metric_type ⇒ String

The metric type.
#resource_label ⇒ String

Identifies the resource associated with the metric type.

Instance Attribute Details

#predefined_metric_type ⇒ `String`

The metric type.

Returns:

(String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3434

class PredefinedMetricSpecification < Struct.new(
  :predefined_metric_type,
  :resource_label)
  include Aws::Structure
end

#resource_label ⇒ `String`

Identifies the resource associated with the metric type. The following predefined metrics are available:

‘ASGAverageCPUUtilization` - Average CPU utilization of the Auto Scaling group.
‘ASGAverageNetworkIn` - Average number of bytes received on all network interfaces by the Auto Scaling group.
‘ASGAverageNetworkOut` - Average number of bytes sent out on all network interfaces by the Auto Scaling group.
‘ALBRequestCountPerTarget` - Number of requests completed per target in an Application Load Balancer target group.

For predefined metric types ‘ASGAverageCPUUtilization`, `ASGAverageNetworkIn`, and `ASGAverageNetworkOut`, the parameter must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type `ALBRequestCountPerTarget`, the parameter must be specified in the format: `app/load-balancer-name/load-balancer-id/targetgroup/target-group-name/target-group-id `, where `app/load-balancer-name/load-balancer-id ` is the final portion of the load balancer ARN, and `targetgroup/target-group-name/target-group-id ` is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group.