Package software.amazon.awscdk.services.autoscaling

Class CfnScalingPolicy.PredictiveScalingConfigurationProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.autoscaling.CfnScalingPolicy.PredictiveScalingConfigurationProperty.Jsii$Proxy

All Implemented Interfaces:

CfnScalingPolicy.PredictiveScalingConfigurationProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnScalingPolicy.PredictiveScalingConfigurationProperty

@Stability(Stable)
@Internal
public static final class CfnScalingPolicy.PredictiveScalingConfigurationProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnScalingPolicy.PredictiveScalingConfigurationProperty

An implementation for CfnScalingPolicy.PredictiveScalingConfigurationProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.autoscaling.CfnScalingPolicy.PredictiveScalingConfigurationProperty

CfnScalingPolicy.PredictiveScalingConfigurationProperty.Builder, CfnScalingPolicy.PredictiveScalingConfigurationProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnScalingPolicy.PredictiveScalingConfigurationProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnScalingPolicy.PredictiveScalingConfigurationProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getMaxCapacityBreachBehavior()	Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group.
final Number	getMaxCapacityBuffer()	The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity.
final Object	getMetricSpecifications()	This structure includes the metrics and target utilization to use for predictive scaling.
final String	getMode()	The predictive scaling mode.
final Number	getSchedulingBufferTime()	The amount of time, in seconds, by which the instance launch time can be advanced.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnScalingPolicy.PredictiveScalingConfigurationProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnScalingPolicy.PredictiveScalingConfigurationProperty.Builder.

Method Details

getMetricSpecifications

public final Object getMetricSpecifications()

Description copied from interface: CfnScalingPolicy.PredictiveScalingConfigurationProperty

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 union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnScalingPolicy.PredictiveScalingMetricSpecificationProperty>

Specified by:

getMetricSpecifications in interface CfnScalingPolicy.PredictiveScalingConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingconfiguration.html#cfn-autoscaling-scalingpolicy-predictivescalingconfiguration-metricspecifications

getMaxCapacityBreachBehavior

public final String getMaxCapacityBreachBehavior()

Description copied from interface: CfnScalingPolicy.PredictiveScalingConfigurationProperty

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.

Specified by:

getMaxCapacityBreachBehavior in interface CfnScalingPolicy.PredictiveScalingConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingconfiguration.html#cfn-autoscaling-scalingpolicy-predictivescalingconfiguration-maxcapacitybreachbehavior

getMaxCapacityBuffer

public final Number getMaxCapacityBuffer()

Description copied from interface: CfnScalingPolicy.PredictiveScalingConfigurationProperty

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.

Specified by:

getMaxCapacityBuffer in interface CfnScalingPolicy.PredictiveScalingConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingconfiguration.html#cfn-autoscaling-scalingpolicy-predictivescalingconfiguration-maxcapacitybuffer

getMode

public final String getMode()

Description copied from interface: CfnScalingPolicy.PredictiveScalingConfigurationProperty

The predictive scaling mode.

Defaults to ForecastOnly if not specified.

Specified by:

getMode in interface CfnScalingPolicy.PredictiveScalingConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingconfiguration.html#cfn-autoscaling-scalingpolicy-predictivescalingconfiguration-mode

getSchedulingBufferTime

public final Number getSchedulingBufferTime()

Description copied from interface: CfnScalingPolicy.PredictiveScalingConfigurationProperty

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.

Specified by:

getSchedulingBufferTime in interface CfnScalingPolicy.PredictiveScalingConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingconfiguration.html#cfn-autoscaling-scalingpolicy-predictivescalingconfiguration-schedulingbuffertime

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object