/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.autoscaling.model; import java.io.Serializable; import javax.annotation.Generated; /** *
* Represents a predictive scaling policy configuration to use with Amazon EC2 Auto Scaling. *
* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class PredictiveScalingConfiguration implements Serializable, Cloneable { /** ** 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. *
*/ private com.amazonaws.internal.SdkInternalList
* The predictive scaling mode. Defaults to ForecastOnly
if not specified.
*
* 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. *
*/ private Integer schedulingBufferTime; /** *
* 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
.
*
* 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.
*
* 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. *
* * @return 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 java.util.List
* 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(java.util.Collection
* 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
* {@link #setMetricSpecifications(java.util.Collection)} or {@link #withMetricSpecifications(java.util.Collection)}
* if you want to override the existing values.
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PredictiveScalingConfiguration withMetricSpecifications(PredictiveScalingMetricSpecification... metricSpecifications) {
if (this.metricSpecifications == null) {
setMetricSpecifications(new com.amazonaws.internal.SdkInternalList
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PredictiveScalingConfiguration withMetricSpecifications(java.util.Collection
* The predictive scaling mode. Defaults to
* The predictive scaling mode. Defaults to
* The predictive scaling mode. Defaults to
* The predictive scaling mode. Defaults to
* 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.
* ForecastOnly
if not specified.
* ForecastOnly
if not specified.
* @see PredictiveScalingMode
*/
public void setMode(String mode) {
this.mode = mode;
}
/**
* ForecastOnly
if not specified.
* ForecastOnly
if not specified.
* @see PredictiveScalingMode
*/
public String getMode() {
return this.mode;
}
/**
* ForecastOnly
if not specified.
* ForecastOnly
if not specified.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PredictiveScalingMode
*/
public PredictiveScalingConfiguration withMode(String mode) {
setMode(mode);
return this;
}
/**
* ForecastOnly
if not specified.
* ForecastOnly
if not specified.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PredictiveScalingMode
*/
public PredictiveScalingConfiguration withMode(PredictiveScalingMode mode) {
this.mode = mode.toString();
return this;
}
/**
*
* The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 * seconds if not specified. */ public void setSchedulingBufferTime(Integer schedulingBufferTime) { this.schedulingBufferTime = 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. *
* * @return 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() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public PredictiveScalingConfiguration withSchedulingBufferTime(Integer schedulingBufferTime) { setSchedulingBufferTime(schedulingBufferTime); return this; } /** *
* 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
.
*
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
.
*
* 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
.
*
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
.
*
* 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
.
*
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
.
*
* 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
.
*
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
.
*
* 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 void setMaxCapacityBuffer(Integer maxCapacityBuffer) {
this.maxCapacityBuffer = 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.
*
* 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() {
return this.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.
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PredictiveScalingConfiguration withMaxCapacityBuffer(Integer maxCapacityBuffer) {
setMaxCapacityBuffer(maxCapacityBuffer);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getMetricSpecifications() != null)
sb.append("MetricSpecifications: ").append(getMetricSpecifications()).append(",");
if (getMode() != null)
sb.append("Mode: ").append(getMode()).append(",");
if (getSchedulingBufferTime() != null)
sb.append("SchedulingBufferTime: ").append(getSchedulingBufferTime()).append(",");
if (getMaxCapacityBreachBehavior() != null)
sb.append("MaxCapacityBreachBehavior: ").append(getMaxCapacityBreachBehavior()).append(",");
if (getMaxCapacityBuffer() != null)
sb.append("MaxCapacityBuffer: ").append(getMaxCapacityBuffer());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PredictiveScalingConfiguration == false)
return false;
PredictiveScalingConfiguration other = (PredictiveScalingConfiguration) obj;
if (other.getMetricSpecifications() == null ^ this.getMetricSpecifications() == null)
return false;
if (other.getMetricSpecifications() != null && other.getMetricSpecifications().equals(this.getMetricSpecifications()) == false)
return false;
if (other.getMode() == null ^ this.getMode() == null)
return false;
if (other.getMode() != null && other.getMode().equals(this.getMode()) == false)
return false;
if (other.getSchedulingBufferTime() == null ^ this.getSchedulingBufferTime() == null)
return false;
if (other.getSchedulingBufferTime() != null && other.getSchedulingBufferTime().equals(this.getSchedulingBufferTime()) == false)
return false;
if (other.getMaxCapacityBreachBehavior() == null ^ this.getMaxCapacityBreachBehavior() == null)
return false;
if (other.getMaxCapacityBreachBehavior() != null && other.getMaxCapacityBreachBehavior().equals(this.getMaxCapacityBreachBehavior()) == false)
return false;
if (other.getMaxCapacityBuffer() == null ^ this.getMaxCapacityBuffer() == null)
return false;
if (other.getMaxCapacityBuffer() != null && other.getMaxCapacityBuffer().equals(this.getMaxCapacityBuffer()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getMetricSpecifications() == null) ? 0 : getMetricSpecifications().hashCode());
hashCode = prime * hashCode + ((getMode() == null) ? 0 : getMode().hashCode());
hashCode = prime * hashCode + ((getSchedulingBufferTime() == null) ? 0 : getSchedulingBufferTime().hashCode());
hashCode = prime * hashCode + ((getMaxCapacityBreachBehavior() == null) ? 0 : getMaxCapacityBreachBehavior().hashCode());
hashCode = prime * hashCode + ((getMaxCapacityBuffer() == null) ? 0 : getMaxCapacityBuffer().hashCode());
return hashCode;
}
@Override
public PredictiveScalingConfiguration clone() {
try {
return (PredictiveScalingConfiguration) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}