Package software.amazon.awscdk.services.autoscaling

Interface CfnScalingPolicy.PredictiveScalingConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScalingPolicy.PredictiveScalingConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnScalingPolicy

@Stability(Stable)
public static interface CfnScalingPolicy.PredictiveScalingConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

PredictiveScalingConfiguration is a property of the AWS::AutoScaling::ScalingPolicy resource that specifies a predictive scaling policy for Amazon EC2 Auto Scaling.

For more information, see Predictive scaling in the Amazon EC2 Auto Scaling User Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.autoscaling.*;
 PredictiveScalingConfigurationProperty predictiveScalingConfigurationProperty = PredictiveScalingConfigurationProperty.builder()
         .metricSpecifications(List.of(PredictiveScalingMetricSpecificationProperty.builder()
                 .targetValue(123)
                 // the properties below are optional
                 .customizedCapacityMetricSpecification(PredictiveScalingCustomizedCapacityMetricProperty.builder()
                         .metricDataQueries(List.of(MetricDataQueryProperty.builder()
                                 .id("id")
                                 // the properties below are optional
                                 .expression("expression")
                                 .label("label")
                                 .metricStat(MetricStatProperty.builder()
                                         .metric(MetricProperty.builder()
                                                 .metricName("metricName")
                                                 .namespace("namespace")
                                                 // the properties below are optional
                                                 .dimensions(List.of(MetricDimensionProperty.builder()
                                                         .name("name")
                                                         .value("value")
                                                         .build()))
                                                 .build())
                                         .stat("stat")
                                         // the properties below are optional
                                         .unit("unit")
                                         .build())
                                 .returnData(false)
                                 .build()))
                         .build())
                 .customizedLoadMetricSpecification(PredictiveScalingCustomizedLoadMetricProperty.builder()
                         .metricDataQueries(List.of(MetricDataQueryProperty.builder()
                                 .id("id")
                                 // the properties below are optional
                                 .expression("expression")
                                 .label("label")
                                 .metricStat(MetricStatProperty.builder()
                                         .metric(MetricProperty.builder()
                                                 .metricName("metricName")
                                                 .namespace("namespace")
                                                 // the properties below are optional
                                                 .dimensions(List.of(MetricDimensionProperty.builder()
                                                         .name("name")
                                                         .value("value")
                                                         .build()))
                                                 .build())
                                         .stat("stat")
                                         // the properties below are optional
                                         .unit("unit")
                                         .build())
                                 .returnData(false)
                                 .build()))
                         .build())
                 .customizedScalingMetricSpecification(PredictiveScalingCustomizedScalingMetricProperty.builder()
                         .metricDataQueries(List.of(MetricDataQueryProperty.builder()
                                 .id("id")
                                 // the properties below are optional
                                 .expression("expression")
                                 .label("label")
                                 .metricStat(MetricStatProperty.builder()
                                         .metric(MetricProperty.builder()
                                                 .metricName("metricName")
                                                 .namespace("namespace")
                                                 // the properties below are optional
                                                 .dimensions(List.of(MetricDimensionProperty.builder()
                                                         .name("name")
                                                         .value("value")
                                                         .build()))
                                                 .build())
                                         .stat("stat")
                                         // the properties below are optional
                                         .unit("unit")
                                         .build())
                                 .returnData(false)
                                 .build()))
                         .build())
                 .predefinedLoadMetricSpecification(PredictiveScalingPredefinedLoadMetricProperty.builder()
                         .predefinedMetricType("predefinedMetricType")
                         // the properties below are optional
                         .resourceLabel("resourceLabel")
                         .build())
                 .predefinedMetricPairSpecification(PredictiveScalingPredefinedMetricPairProperty.builder()
                         .predefinedMetricType("predefinedMetricType")
                         // the properties below are optional
                         .resourceLabel("resourceLabel")
                         .build())
                 .predefinedScalingMetricSpecification(PredictiveScalingPredefinedScalingMetricProperty.builder()
                         .predefinedMetricType("predefinedMetricType")
                         // the properties below are optional
                         .resourceLabel("resourceLabel")
                         .build())
                 .build()))
         // the properties below are optional
         .maxCapacityBreachBehavior("maxCapacityBreachBehavior")
         .maxCapacityBuffer(123)
         .mode("mode")
         .schedulingBufferTime(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnScalingPolicy.PredictiveScalingConfigurationProperty.Builder	A builder for CfnScalingPolicy.PredictiveScalingConfigurationProperty
static final class	CfnScalingPolicy.PredictiveScalingConfigurationProperty.Jsii$Proxy	An implementation for CfnScalingPolicy.PredictiveScalingConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnScalingPolicy.PredictiveScalingConfigurationProperty.Builder	builder()
default String	getMaxCapacityBreachBehavior()	Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group.
default Number	getMaxCapacityBuffer()	The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity.
Object	getMetricSpecifications()	This structure includes the metrics and target utilization to use for predictive scaling.
default String	getMode()	The predictive scaling mode.
default Number	getSchedulingBufferTime()	The amount of time, in seconds, by which the instance launch time can be advanced.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMetricSpecifications

@Stability(Stable)
@NotNull
Object 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.

See Also:

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

getMaxCapacityBreachBehavior

@Stability(Stable)
@Nullable
default 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.

See Also:

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

getMaxCapacityBuffer

@Stability(Stable)
@Nullable
default Number 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.

See Also:

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

getMode

@Stability(Stable)
@Nullable
default String getMode()

The predictive scaling mode.

Defaults to ForecastOnly if not specified.

See Also:

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

getSchedulingBufferTime

@Stability(Stable)
@Nullable
default Number 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.

See Also:

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

builder

@Stability(Stable)
static CfnScalingPolicy.PredictiveScalingConfigurationProperty.Builder builder()

Returns:

a CfnScalingPolicy.PredictiveScalingConfigurationProperty.Builder of CfnScalingPolicy.PredictiveScalingConfigurationProperty