software.amazon.awssdk.services.autoscaling.model

Class PredictiveScalingConfiguration

java.lang.Object

software.amazon.awssdk.services.autoscaling.model.PredictiveScalingConfiguration

All Implemented Interfaces:

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

@Generated(value="software.amazon.awssdk:codegen")
public final class PredictiveScalingConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PredictiveScalingConfiguration.Builder,PredictiveScalingConfiguration>

Represents a predictive scaling policy configuration to use with Amazon EC2 Auto Scaling.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PredictiveScalingConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static PredictiveScalingConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMetricSpecifications() For responses, this returns true if the service returned a value for the MetricSpecifications property.
PredictiveScalingMaxCapacityBreachBehavior	maxCapacityBreachBehavior() Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group.
String	maxCapacityBreachBehaviorAsString() Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group.
Integer	maxCapacityBuffer() The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity.
List<PredictiveScalingMetricSpecification>	metricSpecifications() This structure includes the metrics and target utilization to use for predictive scaling.
PredictiveScalingMode	mode() The predictive scaling mode.
String	modeAsString() The predictive scaling mode.
Integer	schedulingBufferTime() The amount of time, in seconds, by which the instance launch time can be advanced.
List<SdkField<?>>	sdkFields()
static Class<? extends PredictiveScalingConfiguration.Builder>	serializableBuilderClass()
PredictiveScalingConfiguration.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

hasMetricSpecifications

public final boolean hasMetricSpecifications()

For responses, this returns true if the service returned a value for the MetricSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

metricSpecifications

public final List<PredictiveScalingMetricSpecification> metricSpecifications()

This structure includes the metrics and target utilization to use for predictive scaling.

This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetricSpecifications() method.

Returns:

This structure includes the metrics and target utilization to use for predictive scaling.

This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.

mode

public final PredictiveScalingMode mode()

The predictive scaling mode. Defaults to ForecastOnly if not specified.

If the service returns an enum value that is not available in the current SDK version, mode will return PredictiveScalingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

Returns:

The predictive scaling mode. Defaults to ForecastOnly if not specified.

See Also:

PredictiveScalingMode

modeAsString

public final String modeAsString()

The predictive scaling mode. Defaults to ForecastOnly if not specified.

If the service returns an enum value that is not available in the current SDK version, mode will return PredictiveScalingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

Returns:

The predictive scaling mode. Defaults to ForecastOnly if not specified.

See Also:

PredictiveScalingMode

schedulingBufferTime

public final Integer schedulingBufferTime()

The amount of time, in seconds, by which the instance launch time can be advanced. For example, the forecast says to add capacity at 10:00 AM, and you choose to pre-launch instances by 5 minutes. In that case, the instances will be launched at 9:55 AM. The intention is to give resources time to be provisioned. It can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.

The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified.

Returns:

The amount of time, in seconds, by which the instance launch time can be advanced. For example, the forecast says to add capacity at 10:00 AM, and you choose to pre-launch instances by 5 minutes. In that case, the instances will be launched at 9:55 AM. The intention is to give resources time to be provisioned. It can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.

The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified.

maxCapacityBreachBehavior

public final PredictiveScalingMaxCapacityBreachBehavior maxCapacityBreachBehavior()

Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group. Defaults to HonorMaxCapacity if not specified.

The following are possible values:

• HonorMaxCapacity - Amazon EC2 Auto Scaling cannot scale out capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.

• IncreaseMaxCapacity - Amazon EC2 Auto Scaling can scale out capacity higher than the maximum capacity when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value for MaxCapacityBuffer.

If the service returns an enum value that is not available in the current SDK version, maxCapacityBreachBehavior will return PredictiveScalingMaxCapacityBreachBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from maxCapacityBreachBehaviorAsString().

Returns:

Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group. Defaults to HonorMaxCapacity if not specified.

The following are possible values:

• HonorMaxCapacity - Amazon EC2 Auto Scaling cannot scale out capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.

• IncreaseMaxCapacity - Amazon EC2 Auto Scaling can scale out capacity higher than the maximum capacity when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value for MaxCapacityBuffer.

See Also:

PredictiveScalingMaxCapacityBreachBehavior

maxCapacityBreachBehaviorAsString

public final String maxCapacityBreachBehaviorAsString()

Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group. Defaults to HonorMaxCapacity if not specified.

The following are possible values:

• HonorMaxCapacity - Amazon EC2 Auto Scaling cannot scale out capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.

• IncreaseMaxCapacity - Amazon EC2 Auto Scaling can scale out capacity higher than the maximum capacity when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value for MaxCapacityBuffer.

If the service returns an enum value that is not available in the current SDK version, maxCapacityBreachBehavior will return PredictiveScalingMaxCapacityBreachBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from maxCapacityBreachBehaviorAsString().

Returns:

Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group. Defaults to HonorMaxCapacity if not specified.

The following are possible values:

• HonorMaxCapacity - Amazon EC2 Auto Scaling cannot scale out capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.

• IncreaseMaxCapacity - Amazon EC2 Auto Scaling can scale out capacity higher than the maximum capacity when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value for MaxCapacityBuffer.

See Also:

PredictiveScalingMaxCapacityBreachBehavior

maxCapacityBuffer

public final Integer maxCapacityBuffer()

The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.

If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity.

Required if the MaxCapacityBreachBehavior property is set to IncreaseMaxCapacity, and cannot be used otherwise.

Returns:

The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.

If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity.

Required if the MaxCapacityBreachBehavior property is set to IncreaseMaxCapacity, and cannot be used otherwise.

toBuilder

public PredictiveScalingConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PredictiveScalingConfiguration.Builder,PredictiveScalingConfiguration>

builder

public static PredictiveScalingConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends PredictiveScalingConfiguration.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