Class ManagedScaling
- java.lang.Object
-
- software.amazon.awssdk.services.ecs.model.ManagedScaling
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ManagedScaling.Builder,ManagedScaling>
@Generated("software.amazon.awssdk:codegen") public final class ManagedScaling extends Object implements SdkPojo, Serializable, 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
targetCapacityvalue 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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceManagedScaling.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ManagedScaling.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()IntegerinstanceWarmupPeriod()The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group.IntegermaximumScalingStepSize()The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time.IntegerminimumScalingStepSize()The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends ManagedScaling.Builder>serializableBuilderClass()ManagedScalingStatusstatus()Determines whether to use managed scaling for the capacity provider.StringstatusAsString()Determines whether to use managed scaling for the capacity provider.IntegertargetCapacity()The target capacity utilization as a percentage for the capacity provider.ManagedScaling.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
status
public final ManagedScalingStatus 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,
statuswill 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:
ManagedScalingStatus
-
statusAsString
public final String 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,
statuswill 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:
ManagedScalingStatus
-
targetCapacity
public final Integer targetCapacity()
The target capacity utilization as a percentage for the capacity provider. The specified value must be greater than
0and 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 atargetCapacityof90. The default value of100percent 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
0and 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 atargetCapacityof90. The default value of100percent results in the Amazon EC2 instances in your Auto Scaling group being completely used.
-
minimumScalingStepSize
public final Integer 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
1is 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
1is 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
public final Integer maximumScalingStepSize()
The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. If this parameter is omitted, the default value of
10000is used.- Returns:
- The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. If this parameter
is omitted, the default value of
10000is used.
-
instanceWarmupPeriod
public final Integer 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
300seconds 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
300seconds is used.
-
toBuilder
public ManagedScaling.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ManagedScaling.Builder,ManagedScaling>
-
builder
public static ManagedScaling.Builder builder()
-
serializableBuilderClass
public static Class<? extends ManagedScaling.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String 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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-