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 scaling policy configuration to use with Amazon EC2 Auto Scaling.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#customized_metric_specificationTypes::CustomizedMetricSpecification

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



8528
8529
8530
8531
8532
8533
8534
8535
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 8528

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

#disable_scale_inBoolean

Indicates whether scaling in by the target tracking scaling policy is disabled. If scaling in is disabled, the target tracking scaling policy doesn't remove instances from the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from the Auto Scaling group. The default is false.

Returns:

  • (Boolean)


8528
8529
8530
8531
8532
8533
8534
8535
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 8528

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

#predefined_metric_specificationTypes::PredefinedMetricSpecification

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



8528
8529
8530
8531
8532
8533
8534
8535
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 8528

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

#target_valueFloat

The target value for the metric.

Some metrics are based on a count instead of a percentage, such as the request count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy specifies one of these metrics, specify the target utilization as the optimal average request or message count per instance during any one-minute interval.

Returns:

  • (Float)


8528
8529
8530
8531
8532
8533
8534
8535
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 8528

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