Interface CfnScalingPolicy.IPredictiveScalingConfigurationProperty

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

Namespace: Amazon.CDK.AWS.AutoScaling

Assembly: Amazon.CDK.AWS.AutoScaling.dll

Syntax (csharp)

public interface IPredictiveScalingConfigurationProperty

Syntax (vb)

Public Interface IPredictiveScalingConfigurationProperty

Remarks

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

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AutoScaling;

var predictiveScalingConfigurationProperty = new PredictiveScalingConfigurationProperty {
    MetricSpecifications = new [] { new PredictiveScalingMetricSpecificationProperty {
        TargetValue = 123,

        // the properties below are optional
        CustomizedCapacityMetricSpecification = new PredictiveScalingCustomizedCapacityMetricProperty {
            MetricDataQueries = new [] { new MetricDataQueryProperty {
                Id = "id",

                // the properties below are optional
                Expression = "expression",
                Label = "label",
                MetricStat = new MetricStatProperty {
                    Metric = new MetricProperty {
                        MetricName = "metricName",
                        Namespace = "namespace",

                        // the properties below are optional
                        Dimensions = new [] { new MetricDimensionProperty {
                            Name = "name",
                            Value = "value"
                        } }
                    },
                    Stat = "stat",

                    // the properties below are optional
                    Unit = "unit"
                },
                ReturnData = false
            } }
        },
        CustomizedLoadMetricSpecification = new PredictiveScalingCustomizedLoadMetricProperty {
            MetricDataQueries = new [] { new MetricDataQueryProperty {
                Id = "id",

                // the properties below are optional
                Expression = "expression",
                Label = "label",
                MetricStat = new MetricStatProperty {
                    Metric = new MetricProperty {
                        MetricName = "metricName",
                        Namespace = "namespace",

                        // the properties below are optional
                        Dimensions = new [] { new MetricDimensionProperty {
                            Name = "name",
                            Value = "value"
                        } }
                    },
                    Stat = "stat",

                    // the properties below are optional
                    Unit = "unit"
                },
                ReturnData = false
            } }
        },
        CustomizedScalingMetricSpecification = new PredictiveScalingCustomizedScalingMetricProperty {
            MetricDataQueries = new [] { new MetricDataQueryProperty {
                Id = "id",

                // the properties below are optional
                Expression = "expression",
                Label = "label",
                MetricStat = new MetricStatProperty {
                    Metric = new MetricProperty {
                        MetricName = "metricName",
                        Namespace = "namespace",

                        // the properties below are optional
                        Dimensions = new [] { new MetricDimensionProperty {
                            Name = "name",
                            Value = "value"
                        } }
                    },
                    Stat = "stat",

                    // the properties below are optional
                    Unit = "unit"
                },
                ReturnData = false
            } }
        },
        PredefinedLoadMetricSpecification = new PredictiveScalingPredefinedLoadMetricProperty {
            PredefinedMetricType = "predefinedMetricType",

            // the properties below are optional
            ResourceLabel = "resourceLabel"
        },
        PredefinedMetricPairSpecification = new PredictiveScalingPredefinedMetricPairProperty {
            PredefinedMetricType = "predefinedMetricType",

            // the properties below are optional
            ResourceLabel = "resourceLabel"
        },
        PredefinedScalingMetricSpecification = new PredictiveScalingPredefinedScalingMetricProperty {
            PredefinedMetricType = "predefinedMetricType",

            // the properties below are optional
            ResourceLabel = "resourceLabel"
        }
    } },

    // the properties below are optional
    MaxCapacityBreachBehavior = "maxCapacityBreachBehavior",
    MaxCapacityBuffer = 123,
    Mode = "mode",
    SchedulingBufferTime = 123
};

Synopsis

Properties

MaxCapacityBreachBehavior	Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group.
MaxCapacityBuffer	The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity.
MetricSpecifications	This structure includes the metrics and target utilization to use for predictive scaling.
Mode	The predictive scaling mode.
SchedulingBufferTime	The amount of time, in seconds, by which the instance launch time can be advanced.

Properties

MaxCapacityBreachBehavior

Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group.

virtual string MaxCapacityBreachBehavior { get; }

Property Value

System.String

Remarks

Defaults to HonorMaxCapacity if not specified.

The following are possible values:

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

MaxCapacityBuffer

The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity.

virtual Nullable<double> MaxCapacityBuffer { get; }

Property Value

System.Nullable<System.Double>

Remarks

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.

MetricSpecifications

This structure includes the metrics and target utilization to use for predictive scaling.

object MetricSpecifications { get; }

Property Value

System.Object

Remarks

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.

Mode

The predictive scaling mode.

virtual string Mode { get; }

Property Value

System.String

Remarks

Defaults to ForecastOnly if not specified.

SchedulingBufferTime

The amount of time, in seconds, by which the instance launch time can be advanced.

virtual Nullable<double> SchedulingBufferTime { get; }

Property Value

System.Nullable<System.Double>

Remarks

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.