@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class PredictiveScalingConfiguration extends Object implements Serializable, Cloneable
Represents a predictive scaling policy configuration to use with Amazon EC2 Auto Scaling.
| Constructor and Description |
|---|
PredictiveScalingConfiguration() |
| Modifier and Type | Method and Description |
|---|---|
PredictiveScalingConfiguration |
clone() |
boolean |
equals(Object obj) |
String |
getMaxCapacityBreachBehavior()
Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity
of the Auto Scaling group.
|
Integer |
getMaxCapacityBuffer()
The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity.
|
List<PredictiveScalingMetricSpecification> |
getMetricSpecifications()
This structure includes the metrics and target utilization to use for predictive scaling.
|
String |
getMode()
The predictive scaling mode.
|
Integer |
getSchedulingBufferTime()
The amount of time, in seconds, by which the instance launch time can be advanced.
|
int |
hashCode() |
void |
setMaxCapacityBreachBehavior(String maxCapacityBreachBehavior)
Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity
of the Auto Scaling group.
|
void |
setMaxCapacityBuffer(Integer maxCapacityBuffer)
The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity.
|
void |
setMetricSpecifications(Collection<PredictiveScalingMetricSpecification> metricSpecifications)
This structure includes the metrics and target utilization to use for predictive scaling.
|
void |
setMode(String mode)
The predictive scaling mode.
|
void |
setSchedulingBufferTime(Integer schedulingBufferTime)
The amount of time, in seconds, by which the instance launch time can be advanced.
|
String |
toString()
Returns a string representation of this object.
|
PredictiveScalingConfiguration |
withMaxCapacityBreachBehavior(PredictiveScalingMaxCapacityBreachBehavior maxCapacityBreachBehavior)
Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity
of the Auto Scaling group.
|
PredictiveScalingConfiguration |
withMaxCapacityBreachBehavior(String maxCapacityBreachBehavior)
Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity
of the Auto Scaling group.
|
PredictiveScalingConfiguration |
withMaxCapacityBuffer(Integer maxCapacityBuffer)
The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity.
|
PredictiveScalingConfiguration |
withMetricSpecifications(Collection<PredictiveScalingMetricSpecification> metricSpecifications)
This structure includes the metrics and target utilization to use for predictive scaling.
|
PredictiveScalingConfiguration |
withMetricSpecifications(PredictiveScalingMetricSpecification... metricSpecifications)
This structure includes the metrics and target utilization to use for predictive scaling.
|
PredictiveScalingConfiguration |
withMode(PredictiveScalingMode mode)
The predictive scaling mode.
|
PredictiveScalingConfiguration |
withMode(String mode)
The predictive scaling mode.
|
PredictiveScalingConfiguration |
withSchedulingBufferTime(Integer schedulingBufferTime)
The amount of time, in seconds, by which the instance launch time can be advanced.
|
public List<PredictiveScalingMetricSpecification> getMetricSpecifications()
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.
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.
public void setMetricSpecifications(Collection<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.
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.
public PredictiveScalingConfiguration withMetricSpecifications(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.
NOTE: This method appends the values to the existing list (if any). Use
setMetricSpecifications(java.util.Collection) or withMetricSpecifications(java.util.Collection)
if you want to override the existing values.
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.
public PredictiveScalingConfiguration withMetricSpecifications(Collection<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.
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.
public void setMode(String mode)
The predictive scaling mode. Defaults to ForecastOnly if not specified.
mode - The predictive scaling mode. Defaults to ForecastOnly if not specified.PredictiveScalingModepublic String getMode()
The predictive scaling mode. Defaults to ForecastOnly if not specified.
ForecastOnly if not specified.PredictiveScalingModepublic PredictiveScalingConfiguration withMode(String mode)
The predictive scaling mode. Defaults to ForecastOnly if not specified.
mode - The predictive scaling mode. Defaults to ForecastOnly if not specified.PredictiveScalingModepublic PredictiveScalingConfiguration withMode(PredictiveScalingMode mode)
The predictive scaling mode. Defaults to ForecastOnly if not specified.
mode - The predictive scaling mode. Defaults to ForecastOnly if not specified.PredictiveScalingModepublic void setSchedulingBufferTime(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.
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.
public Integer getSchedulingBufferTime()
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.
The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified.
public PredictiveScalingConfiguration withSchedulingBufferTime(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.
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.
public void setMaxCapacityBreachBehavior(String 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 can't increase the maximum capacity of the group when the
forecast capacity is close to or exceeds the maximum capacity.
IncreaseMaxCapacity - Amazon EC2 Auto Scaling can increase the maximum capacity of the group 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.
Use caution when allowing the maximum capacity to be automatically increased. This can lead to more instances being launched than intended if the increased maximum capacity is not monitored and managed. The increased maximum capacity then becomes the new normal maximum capacity for the Auto Scaling group until you manually update it. The maximum capacity does not automatically decrease back to the original maximum.
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 can't increase the maximum capacity of the group
when the forecast capacity is close to or exceeds the maximum capacity.
IncreaseMaxCapacity - Amazon EC2 Auto Scaling can increase the maximum capacity of the group
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.
Use caution when allowing the maximum capacity to be automatically increased. This can lead to more instances being launched than intended if the increased maximum capacity is not monitored and managed. The increased maximum capacity then becomes the new normal maximum capacity for the Auto Scaling group until you manually update it. The maximum capacity does not automatically decrease back to the original maximum.
PredictiveScalingMaxCapacityBreachBehaviorpublic String getMaxCapacityBreachBehavior()
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 can't increase the maximum capacity of the group when the
forecast capacity is close to or exceeds the maximum capacity.
IncreaseMaxCapacity - Amazon EC2 Auto Scaling can increase the maximum capacity of the group 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.
Use caution when allowing the maximum capacity to be automatically increased. This can lead to more instances being launched than intended if the increased maximum capacity is not monitored and managed. The increased maximum capacity then becomes the new normal maximum capacity for the Auto Scaling group until you manually update it. The maximum capacity does not automatically decrease back to the original maximum.
HonorMaxCapacity if not specified.
The following are possible values:
HonorMaxCapacity - Amazon EC2 Auto Scaling can't increase the maximum capacity of the group
when the forecast capacity is close to or exceeds the maximum capacity.
IncreaseMaxCapacity - Amazon EC2 Auto Scaling can increase the maximum capacity of the group
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.
Use caution when allowing the maximum capacity to be automatically increased. This can lead to more instances being launched than intended if the increased maximum capacity is not monitored and managed. The increased maximum capacity then becomes the new normal maximum capacity for the Auto Scaling group until you manually update it. The maximum capacity does not automatically decrease back to the original maximum.
PredictiveScalingMaxCapacityBreachBehaviorpublic PredictiveScalingConfiguration withMaxCapacityBreachBehavior(String 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 can't increase the maximum capacity of the group when the
forecast capacity is close to or exceeds the maximum capacity.
IncreaseMaxCapacity - Amazon EC2 Auto Scaling can increase the maximum capacity of the group 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.
Use caution when allowing the maximum capacity to be automatically increased. This can lead to more instances being launched than intended if the increased maximum capacity is not monitored and managed. The increased maximum capacity then becomes the new normal maximum capacity for the Auto Scaling group until you manually update it. The maximum capacity does not automatically decrease back to the original maximum.
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 can't increase the maximum capacity of the group
when the forecast capacity is close to or exceeds the maximum capacity.
IncreaseMaxCapacity - Amazon EC2 Auto Scaling can increase the maximum capacity of the group
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.
Use caution when allowing the maximum capacity to be automatically increased. This can lead to more instances being launched than intended if the increased maximum capacity is not monitored and managed. The increased maximum capacity then becomes the new normal maximum capacity for the Auto Scaling group until you manually update it. The maximum capacity does not automatically decrease back to the original maximum.
PredictiveScalingMaxCapacityBreachBehaviorpublic PredictiveScalingConfiguration withMaxCapacityBreachBehavior(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 can't increase the maximum capacity of the group when the
forecast capacity is close to or exceeds the maximum capacity.
IncreaseMaxCapacity - Amazon EC2 Auto Scaling can increase the maximum capacity of the group 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.
Use caution when allowing the maximum capacity to be automatically increased. This can lead to more instances being launched than intended if the increased maximum capacity is not monitored and managed. The increased maximum capacity then becomes the new normal maximum capacity for the Auto Scaling group until you manually update it. The maximum capacity does not automatically decrease back to the original maximum.
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 can't increase the maximum capacity of the group
when the forecast capacity is close to or exceeds the maximum capacity.
IncreaseMaxCapacity - Amazon EC2 Auto Scaling can increase the maximum capacity of the group
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.
Use caution when allowing the maximum capacity to be automatically increased. This can lead to more instances being launched than intended if the increased maximum capacity is not monitored and managed. The increased maximum capacity then becomes the new normal maximum capacity for the Auto Scaling group until you manually update it. The maximum capacity does not automatically decrease back to the original maximum.
PredictiveScalingMaxCapacityBreachBehaviorpublic void setMaxCapacityBuffer(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.
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.
public Integer getMaxCapacityBuffer()
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.
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.
public PredictiveScalingConfiguration withMaxCapacityBuffer(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.
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.
public String toString()
toString in class ObjectObject.toString()public PredictiveScalingConfiguration clone()