Class ManagedScaling
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ManagedScaling.Builder,
ManagedScaling>
The managed scaling settings for the Auto Scaling group capacity provider.
When managed scaling is turned on, Amazon ECS manages the scale-in and scale-out actions of the Auto Scaling group.
Amazon ECS manages a target tracking scaling policy using an Amazon ECS managed CloudWatch metric with the specified
targetCapacity
value as the target value for the metric. For more information, see Using managed scaling in the Amazon Elastic Container Service Developer Guide.
If managed scaling is off, the user must manage the scaling of the Auto Scaling group.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ManagedScaling.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Integer
The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group.final Integer
The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time.final Integer
The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time.static Class
<? extends ManagedScaling.Builder> final ManagedScalingStatus
status()
Determines whether to use managed scaling for the capacity provider.final String
Determines whether to use managed scaling for the capacity provider.final Integer
The target capacity utilization as a percentage for the capacity provider.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
-
status
Determines whether to use managed scaling for the capacity provider.
If the service returns an enum value that is not available in the current SDK version,
status
will returnManagedScalingStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- Determines whether to use managed scaling for the capacity provider.
- See Also:
-
statusAsString
Determines whether to use managed scaling for the capacity provider.
If the service returns an enum value that is not available in the current SDK version,
status
will returnManagedScalingStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- Determines whether to use managed scaling for the capacity provider.
- See Also:
-
targetCapacity
The target capacity utilization as a percentage for the capacity provider. The specified value must be greater than
0
and less than or equal to100
. For example, if you want the capacity provider to maintain 10% spare capacity, then that means the utilization is 90%, so use atargetCapacity
of90
. The default value of100
percent results in the Amazon EC2 instances in your Auto Scaling group being completely used.- Returns:
- The target capacity utilization as a percentage for the capacity provider. The specified value must be
greater than
0
and less than or equal to100
. For example, if you want the capacity provider to maintain 10% spare capacity, then that means the utilization is 90%, so use atargetCapacity
of90
. The default value of100
percent results in the Amazon EC2 instances in your Auto Scaling group being completely used.
-
minimumScalingStepSize
The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter If this parameter is omitted, the default value of
1
is used.When additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size.
If you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value and will ignore both the maximum scaling step size as well as the capacity demand.
- Returns:
- The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in
process is not affected by this parameter If this parameter is omitted, the default value of
1
is used.When additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size.
If you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value and will ignore both the maximum scaling step size as well as the capacity demand.
-
maximumScalingStepSize
The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter. If this parameter is omitted, the default value of
10000
is used.- Returns:
- The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in
process is not affected by this parameter. If this parameter is omitted, the default value of
10000
is used.
-
instanceWarmupPeriod
The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group. If this parameter is omitted, the default value of
300
seconds is used.- Returns:
- The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch
metrics for Auto Scaling group. If this parameter is omitted, the default value of
300
seconds is used.
-
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<ManagedScaling.Builder,
ManagedScaling> - 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
-