Class CfnScalingPolicy.PredictiveScalingConfigurationProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnScalingPolicy.PredictiveScalingConfigurationProperty>
- Enclosing interface:
CfnScalingPolicy.PredictiveScalingConfigurationProperty
CfnScalingPolicy.PredictiveScalingConfigurationProperty
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.maxCapacityBreachBehavior
(String maxCapacityBreachBehavior) maxCapacityBuffer
(Number maxCapacityBuffer) metricSpecifications
(List<? extends Object> metricSpecifications) metricSpecifications
(IResolvable metricSpecifications) Sets the value ofCfnScalingPolicy.PredictiveScalingConfigurationProperty.getMode()
schedulingBufferTime
(Number schedulingBufferTime)
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
metricSpecifications
@Stability(Stable) public CfnScalingPolicy.PredictiveScalingConfigurationProperty.Builder metricSpecifications(IResolvable metricSpecifications) - Parameters:
metricSpecifications
- This structure includes the metrics and target utilization to use for predictive scaling. This parameter is required. 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.- Returns:
this
-
metricSpecifications
@Stability(Stable) public CfnScalingPolicy.PredictiveScalingConfigurationProperty.Builder metricSpecifications(List<? extends Object> metricSpecifications) - Parameters:
metricSpecifications
- This structure includes the metrics and target utilization to use for predictive scaling. This parameter is required. 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.- Returns:
this
-
maxCapacityBreachBehavior
@Stability(Stable) public CfnScalingPolicy.PredictiveScalingConfigurationProperty.Builder maxCapacityBreachBehavior(String maxCapacityBreachBehavior) Sets the value ofCfnScalingPolicy.PredictiveScalingConfigurationProperty.getMaxCapacityBreachBehavior()
- Parameters:
maxCapacityBreachBehavior
- Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group. Defaults toHonorMaxCapacity
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 forMaxCapacityBuffer
.
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.
- Returns:
this
-
maxCapacityBuffer
@Stability(Stable) public CfnScalingPolicy.PredictiveScalingConfigurationProperty.Builder maxCapacityBuffer(Number maxCapacityBuffer) - Parameters:
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 toIncreaseMaxCapacity
, and cannot be used otherwise.- Returns:
this
-
mode
@Stability(Stable) public CfnScalingPolicy.PredictiveScalingConfigurationProperty.Builder mode(String mode) Sets the value ofCfnScalingPolicy.PredictiveScalingConfigurationProperty.getMode()
- Parameters:
mode
- The predictive scaling mode. Defaults toForecastOnly
if not specified.- Returns:
this
-
schedulingBufferTime
@Stability(Stable) public CfnScalingPolicy.PredictiveScalingConfigurationProperty.Builder schedulingBufferTime(Number schedulingBufferTime) - Parameters:
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:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnScalingPolicy.PredictiveScalingConfigurationProperty>
- Returns:
- a new instance of
CfnScalingPolicy.PredictiveScalingConfigurationProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-