You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-autoscaling/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

Instance Attribute Details

#predefined_metric_typeString

The metric type.

Returns:

  • (String)


3037
3038
3039
3040
3041
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3037

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

#resource_labelString

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.

Returns:

  • (String)


3037
3038
3039
3040
3041
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3037

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