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

Class: Aws::ApplicationAutoScaling::Types::TargetTrackingScalingPolicyConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing TargetTrackingScalingPolicyConfiguration as input to an Aws::Client method, you can use a vanilla Hash:

{
  target_value: 1.0, # required
  predefined_metric_specification: {
    predefined_metric_type: "DynamoDBReadCapacityUtilization", # required, accepts DynamoDBReadCapacityUtilization, DynamoDBWriteCapacityUtilization
    resource_label: "ResourceLabel",
  },
  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",
  },
  scale_out_cooldown: 1,
  scale_in_cooldown: 1,
  disable_scale_in: false,
}

Represents a target tracking scaling policy configuration.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#customized_metric_specificationTypes::CustomizedMetricSpecification

Reserved for future use.

Returns:

#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 capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

Returns:

  • (Boolean)

    Indicates whether scale in by the target tracking policy is disabled.

#predefined_metric_specificationTypes::PredefinedMetricSpecification

A predefined metric.

Returns:

#scale_in_cooldownInteger

The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.

The cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application\'s availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.

Returns:

  • (Integer)

    The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.

#scale_out_cooldownInteger

The amount of time, in seconds, after a scale out activity completes before another scale out activity can start.

While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.

Returns:

  • (Integer)

    The amount of time, in seconds, after a scale out activity completes before another scale out activity can start.

#target_valueFloat

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

Returns:

  • (Float)

    The target value for the metric.