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

Class: Aws::AutoScaling::Types::TargetTrackingConfiguration

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 TargetTrackingConfiguration data as a hash:

{
  predefined_metric_specification: {
    predefined_metric_type: "ASGAverageCPUUtilization", # required, accepts ASGAverageCPUUtilization, ASGAverageNetworkIn, ASGAverageNetworkOut, ALBRequestCountPerTarget
    resource_label: "XmlStringMaxLen1023",
  },
  customized_metric_specification: {
    metric_name: "MetricName", # required
    namespace: "MetricNamespace", # required
    dimensions: [
      {
        name: "MetricDimensionName", # required
        value: "MetricDimensionValue", # required
      },
    ],
    statistic: "Average", # required, accepts Average, Minimum, Maximum, SampleCount, Sum
    unit: "MetricUnit",
  },
  target_value: 1.0, # required
  disable_scale_in: false,
}

Represents a target tracking policy configuration.

Instance Attribute Summary collapse

Instance Attribute Details

#customized_metric_specificationTypes::CustomizedMetricSpecification

A customized metric.



4064
4065
4066
4067
4068
4069
4070
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4064

class TargetTrackingConfiguration < Struct.new(
  :predefined_metric_specification,
  :customized_metric_specification,
  :target_value,
  :disable_scale_in)
  include Aws::Structure
end

#disable_scale_inBoolean

Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove instances from the Auto Scaling group. Otherwise, scale in is enabled and the target tracking policy can remove instances from the Auto Scaling group. The default value is false.

Returns:

  • (Boolean)


4064
4065
4066
4067
4068
4069
4070
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4064

class TargetTrackingConfiguration < Struct.new(
  :predefined_metric_specification,
  :customized_metric_specification,
  :target_value,
  :disable_scale_in)
  include Aws::Structure
end

#predefined_metric_specificationTypes::PredefinedMetricSpecification

A predefined metric. You can specify either a predefined metric or a customized metric.



4064
4065
4066
4067
4068
4069
4070
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4064

class TargetTrackingConfiguration < Struct.new(
  :predefined_metric_specification,
  :customized_metric_specification,
  :target_value,
  :disable_scale_in)
  include Aws::Structure
end

#target_valueFloat

The target value for the metric.

Returns:

  • (Float)


4064
4065
4066
4067
4068
4069
4070
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4064

class TargetTrackingConfiguration < Struct.new(
  :predefined_metric_specification,
  :customized_metric_specification,
  :target_value,
  :disable_scale_in)
  include Aws::Structure
end