Class TargetTrackingConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<TargetTrackingConfiguration.Builder,
TargetTrackingConfiguration>
Describes a target tracking configuration to use with AWS Auto Scaling. Used with ScalingInstruction and ScalingPolicy.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
A customized metric.final Boolean
Indicates whether scale in by the target tracking scaling policy is disabled.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Integer
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
A predefined metric.final Integer
The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.final Integer
The amount of time, in seconds, to wait for a previous scale-out activity to take effect.static Class
<? extends TargetTrackingConfiguration.Builder> final Double
The target value for the metric.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
predefinedScalingMetricSpecification
A predefined metric. You can specify either a predefined metric or a customized metric.
- Returns:
- A predefined metric. You can specify either a predefined metric or a customized metric.
-
customizedScalingMetricSpecification
A customized metric. You can specify either a predefined metric or a customized metric.
- Returns:
- A customized metric. You can specify either a predefined metric or a customized metric.
-
targetValue
The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360.
- Returns:
- The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360.
-
disableScaleIn
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
.- Returns:
- 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
.
-
scaleOutCooldown
The amount of time, in seconds, to wait for a previous scale-out activity to take effect. This property is not used if the scalable resource is an Auto Scaling group.
With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Auto Scaling successfully scales out using a target tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends.
- Returns:
- The amount of time, in seconds, to wait for a previous scale-out activity to take effect. This property
is not used if the scalable resource is an Auto Scaling group.
With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Auto Scaling successfully scales out using a target tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends.
-
scaleInCooldown
The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. This property is not used if the scalable resource is an Auto Scaling group.
With the scale-in cooldown period, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the scale-in cooldown period, Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.
- Returns:
- The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can
start. This property is not used if the scalable resource is an Auto Scaling group.
With the scale-in cooldown period, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the scale-in cooldown period, Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.
-
estimatedInstanceWarmup
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.
- Returns:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<TargetTrackingConfiguration.Builder,
TargetTrackingConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-