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",
}

Represents a predefined metric for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.

Instance Attribute Summary collapse

Instance Attribute Details

#predefined_metric_typeString

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.

Returns:

  • (String)


3902
3903
3904
3905
3906
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3902

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

#resource_labelString

Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Auto Scaling group.

The format is 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.

Returns:

  • (String)


3902
3903
3904
3905
3906
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3902

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