Package software.amazon.awscdk.cfnpropertymixins.services.autoscaling

Class CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.autoscaling.CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty>

Enclosing interface:

CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty

@Stability(Stable)
public static final class CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty>

A builder for CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty	build()	Builds the configured instance.
CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty.Builder	maxCapacityBreachBehavior(String maxCapacityBreachBehavior)	Sets the value of CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty.getMaxCapacityBreachBehavior()
CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty.Builder	maxCapacityBuffer(Number maxCapacityBuffer)	Sets the value of CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty.getMaxCapacityBuffer()
CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty.Builder	metricSpecifications(List<? extends Object> metricSpecifications)	Sets the value of CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty.getMetricSpecifications()
CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty.Builder	metricSpecifications(IResolvable metricSpecifications)	Sets the value of CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty.getMetricSpecifications()
CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty.Builder	mode(String mode)	Sets the value of CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty.getMode()
CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty.Builder	schedulingBufferTime(Number schedulingBufferTime)	Sets the value of CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty.getSchedulingBufferTime()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

maxCapacityBreachBehavior

@Stability(Stable)
public CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty.Builder maxCapacityBreachBehavior(String maxCapacityBreachBehavior)

Sets the value of CfnScalingPolicyPropsMixin.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 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.

Returns:

this

maxCapacityBuffer

@Stability(Stable)
public CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty.Builder maxCapacityBuffer(Number maxCapacityBuffer)

Sets the value of CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty.getMaxCapacityBuffer()

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 to IncreaseMaxCapacity , and cannot be used otherwise.

Returns:

this

metricSpecifications

@Stability(Stable)
public CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty.Builder metricSpecifications(IResolvable metricSpecifications)

Sets the value of CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty.getMetricSpecifications()

Parameters:

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.

Returns:

this

metricSpecifications

@Stability(Stable)
public CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty.Builder metricSpecifications(List<? extends Object> metricSpecifications)

Sets the value of CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty.getMetricSpecifications()

Parameters:

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.

Returns:

this

mode

@Stability(Stable)
public CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty.Builder mode(String mode)

Sets the value of CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty.getMode()

Parameters:

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

Returns:

this

schedulingBufferTime

@Stability(Stable)
public CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty.Builder schedulingBufferTime(Number schedulingBufferTime)

Sets the value of CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty.getSchedulingBufferTime()

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

@Stability(Stable)
public CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty>

Returns:

a new instance of CfnScalingPolicyPropsMixin.PredictiveScalingConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided