software.amazon.awssdk.services.ecs.model

Class ManagedScaling

java.lang.Object

software.amazon.awssdk.services.ecs.model.ManagedScaling

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ManagedScaling.Builder,ManagedScaling>

@Generated(value="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 enabled, 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 disabled, the user must manage the scaling of the Auto Scaling group.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ManagedScaling.Builder

Method Summary

Modifier and Type	Method and Description
static ManagedScaling.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	instanceWarmupPeriod() The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group.
Integer	maximumScalingStepSize() The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time.
Integer	minimumScalingStepSize() The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time.
List<SdkField<?>>	sdkFields()
static Class<? extends ManagedScaling.Builder>	serializableBuilderClass()
ManagedScalingStatus	status() Determines whether to use managed scaling for the capacity provider.
String	statusAsString() Determines whether to use managed scaling for the capacity provider.
Integer	targetCapacity() The target capacity value for the capacity provider.
ManagedScaling.Builder	toBuilder()
String	toString() 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, status will return ManagedScalingStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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, status will return ManagedScalingStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

Determines whether to use managed scaling for the capacity provider.

See Also:

ManagedScalingStatus

targetCapacity

public final Integer targetCapacity()

The target capacity value for the capacity provider. The specified value must be greater than 0 and less than or equal to 100. A value of 100 results in the Amazon EC2 instances in your Auto Scaling group being completely used.

Returns:

The target capacity value for the capacity provider. The specified value must be greater than 0 and less than or equal to 100. A value of 100 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 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

public final Integer 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 1 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 1 is 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 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

public ManagedScaling.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ManagedScaling.Builder,ManagedScaling>

builder

public static ManagedScaling.Builder builder()

serializableBuilderClass

public static Class<? extends ManagedScaling.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo