You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::AutoScalingPlans::Types::TargetTrackingConfiguration
- Inherits:
-
Struct
- Object
- Struct
- Aws::AutoScalingPlans::Types::TargetTrackingConfiguration
- Defined in:
- (unknown)
Overview
When passing TargetTrackingConfiguration as input to an Aws::Client method, you can use a vanilla Hash:
{
predefined_scaling_metric_specification: {
predefined_scaling_metric_type: "ASGAverageCPUUtilization", # required, accepts ASGAverageCPUUtilization, ASGAverageNetworkIn, ASGAverageNetworkOut, DynamoDBReadCapacityUtilization, DynamoDBWriteCapacityUtilization, ECSServiceAverageCPUUtilization, ECSServiceAverageMemoryUtilization, ALBRequestCountPerTarget, RDSReaderAverageCPUUtilization, RDSReaderAverageDatabaseConnections, EC2SpotFleetRequestAverageCPUUtilization, EC2SpotFleetRequestAverageNetworkIn, EC2SpotFleetRequestAverageNetworkOut
resource_label: "ResourceLabel",
},
customized_scaling_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,
scale_out_cooldown: 1,
scale_in_cooldown: 1,
estimated_instance_warmup: 1,
}
Describes a target tracking configuration to use with AWS Auto Scaling. Used with ScalingInstruction and ScalingPolicy.
Returned by:
Instance Attribute Summary collapse
-
#customized_scaling_metric_specification ⇒ Types::CustomizedScalingMetricSpecification
A customized metric.
-
#disable_scale_in ⇒ Boolean
Indicates whether scale in by the target tracking scaling policy is disabled.
-
#estimated_instance_warmup ⇒ Integer
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
-
#predefined_scaling_metric_specification ⇒ Types::PredefinedScalingMetricSpecification
A predefined metric.
-
#scale_in_cooldown ⇒ Integer
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.
-
#scale_out_cooldown ⇒ Integer
The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.
-
#target_value ⇒ Float
The target value for the metric.
Instance Attribute Details
#customized_scaling_metric_specification ⇒ Types::CustomizedScalingMetricSpecification
A customized metric. You can specify either a predefined metric or a customized metric.
#disable_scale_in ⇒ Boolean
Indicates whether scale in by the target tracking scaling policy is
disabled. If the value is true
, scale in is disabled and the target
tracking scaling policy doesn\'t remove capacity from the scalable
resource. Otherwise, scale in is enabled and the target tracking scaling
policy can remove capacity from the scalable resource.
The default value is false
.
#estimated_instance_warmup ⇒ Integer
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.
#predefined_scaling_metric_specification ⇒ Types::PredefinedScalingMetricSpecification
A predefined metric. You can specify either a predefined metric or a customized metric.
#scale_in_cooldown ⇒ Integer
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. This value is not used if the scalable resource is an Auto Scaling group.
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, AWS Auto Scaling scales out your scalable target immediately.
#scale_out_cooldown ⇒ Integer
The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start. This value is not used if the scalable resource is an Auto Scaling group.
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.
#target_value ⇒ Float
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).