Package software.amazon.awscdk.services.applicationautoscaling

Interface CfnScalingPolicy.PredictiveScalingPolicyConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScalingPolicy.PredictiveScalingPolicyConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnScalingPolicy

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

Represents a predictive scaling policy configuration.

Predictive scaling is supported on Amazon ECS services.

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.applicationautoscaling.*;
 PredictiveScalingPolicyConfigurationProperty predictiveScalingPolicyConfigurationProperty = PredictiveScalingPolicyConfigurationProperty.builder()
         .metricSpecifications(List.of(PredictiveScalingMetricSpecificationProperty.builder()
                 .targetValue(123)
                 // the properties below are optional
                 .customizedCapacityMetricSpecification(PredictiveScalingCustomizedCapacityMetricProperty.builder()
                         .metricDataQueries(List.of(PredictiveScalingMetricDataQueryProperty.builder()
                                 .expression("expression")
                                 .id("id")
                                 .label("label")
                                 .metricStat(PredictiveScalingMetricStatProperty.builder()
                                         .metric(PredictiveScalingMetricProperty.builder()
                                                 .dimensions(List.of(PredictiveScalingMetricDimensionProperty.builder()
                                                         .name("name")
                                                         .value("value")
                                                         .build()))
                                                 .metricName("metricName")
                                                 .namespace("namespace")
                                                 .build())
                                         .stat("stat")
                                         .unit("unit")
                                         .build())
                                 .returnData(false)
                                 .build()))
                         .build())
                 .customizedLoadMetricSpecification(PredictiveScalingCustomizedLoadMetricProperty.builder()
                         .metricDataQueries(List.of(PredictiveScalingMetricDataQueryProperty.builder()
                                 .expression("expression")
                                 .id("id")
                                 .label("label")
                                 .metricStat(PredictiveScalingMetricStatProperty.builder()
                                         .metric(PredictiveScalingMetricProperty.builder()
                                                 .dimensions(List.of(PredictiveScalingMetricDimensionProperty.builder()
                                                         .name("name")
                                                         .value("value")
                                                         .build()))
                                                 .metricName("metricName")
                                                 .namespace("namespace")
                                                 .build())
                                         .stat("stat")
                                         .unit("unit")
                                         .build())
                                 .returnData(false)
                                 .build()))
                         .build())
                 .customizedScalingMetricSpecification(PredictiveScalingCustomizedScalingMetricProperty.builder()
                         .metricDataQueries(List.of(PredictiveScalingMetricDataQueryProperty.builder()
                                 .expression("expression")
                                 .id("id")
                                 .label("label")
                                 .metricStat(PredictiveScalingMetricStatProperty.builder()
                                         .metric(PredictiveScalingMetricProperty.builder()
                                                 .dimensions(List.of(PredictiveScalingMetricDimensionProperty.builder()
                                                         .name("name")
                                                         .value("value")
                                                         .build()))
                                                 .metricName("metricName")
                                                 .namespace("namespace")
                                                 .build())
                                         .stat("stat")
                                         .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-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnScalingPolicy.PredictiveScalingPolicyConfigurationProperty.Builder	builder()
default String	getMaxCapacityBreachBehavior()	Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity.
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, that the start 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-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration-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.

Defaults to HonorMaxCapacity if not specified.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration-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.

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-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration-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-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration-mode

getSchedulingBufferTime

@Stability(Stable)
@Nullable
default Number getSchedulingBufferTime()

The amount of time, in seconds, that the start time can be advanced.

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-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration-schedulingbuffertime

builder

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

Returns:

a CfnScalingPolicy.PredictiveScalingPolicyConfigurationProperty.Builder of CfnScalingPolicy.PredictiveScalingPolicyConfigurationProperty