Class CfnScalingPlan.ScalingInstructionProperty
ScalingInstruction
is a property of ScalingPlan that specifies the scaling instruction for a scalable resource in a scaling plan. Each scaling instruction applies to one resource.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.AutoScalingPlans
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ScalingInstructionProperty : Object, CfnScalingPlan.IScalingInstructionProperty
Syntax (vb)
Public Class ScalingInstructionProperty
Inherits Object
Implements CfnScalingPlan.IScalingInstructionProperty
Remarks
AWS Auto Scaling creates target tracking scaling policies based on the scaling instructions. Target tracking scaling policies adjust the capacity of your scalable resource as required to maintain resource utilization at the target value that you specified.
AWS Auto Scaling also configures predictive scaling for your Amazon EC2 Auto Scaling groups using a subset of properties, including the load metric, the scaling metric, the target value for the scaling metric, the predictive scaling mode (forecast and scale or forecast only), and the desired behavior when the forecast capacity exceeds the maximum capacity of the resource. With predictive scaling, AWS Auto Scaling generates forecasts with traffic predictions for the two days ahead and schedules scaling actions that proactively add and remove resource capacity to match the forecast.
We recommend waiting a minimum of 24 hours after creating an Auto Scaling group to configure predictive scaling. At minimum, there must be 24 hours of historical data to generate a forecast. For more information, see Best practices for scaling plans in the Scaling Plans User Guide .
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.AutoScalingPlans;
var scalingInstructionProperty = new ScalingInstructionProperty {
MaxCapacity = 123,
MinCapacity = 123,
ResourceId = "resourceId",
ScalableDimension = "scalableDimension",
ServiceNamespace = "serviceNamespace",
TargetTrackingConfigurations = new [] { new TargetTrackingConfigurationProperty {
TargetValue = 123,
// the properties below are optional
CustomizedScalingMetricSpecification = new CustomizedScalingMetricSpecificationProperty {
MetricName = "metricName",
Namespace = "namespace",
Statistic = "statistic",
// the properties below are optional
Dimensions = new [] { new MetricDimensionProperty {
Name = "name",
Value = "value"
} },
Unit = "unit"
},
DisableScaleIn = false,
EstimatedInstanceWarmup = 123,
PredefinedScalingMetricSpecification = new PredefinedScalingMetricSpecificationProperty {
PredefinedScalingMetricType = "predefinedScalingMetricType",
// the properties below are optional
ResourceLabel = "resourceLabel"
},
ScaleInCooldown = 123,
ScaleOutCooldown = 123
} },
// the properties below are optional
CustomizedLoadMetricSpecification = new CustomizedLoadMetricSpecificationProperty {
MetricName = "metricName",
Namespace = "namespace",
Statistic = "statistic",
// the properties below are optional
Dimensions = new [] { new MetricDimensionProperty {
Name = "name",
Value = "value"
} },
Unit = "unit"
},
DisableDynamicScaling = false,
PredefinedLoadMetricSpecification = new PredefinedLoadMetricSpecificationProperty {
PredefinedLoadMetricType = "predefinedLoadMetricType",
// the properties below are optional
ResourceLabel = "resourceLabel"
},
PredictiveScalingMaxCapacityBehavior = "predictiveScalingMaxCapacityBehavior",
PredictiveScalingMaxCapacityBuffer = 123,
PredictiveScalingMode = "predictiveScalingMode",
ScalingPolicyUpdateBehavior = "scalingPolicyUpdateBehavior",
ScheduledActionBufferTime = 123
};
Synopsis
Constructors
ScalingInstructionProperty() |
Properties
CustomizedLoadMetricSpecification | The customized load metric to use for predictive scaling. |
DisableDynamicScaling | Controls whether dynamic scaling is disabled. |
MaxCapacity | The maximum capacity of the resource. |
MinCapacity | The minimum capacity of the resource. |
PredefinedLoadMetricSpecification | The predefined load metric to use for predictive scaling. |
PredictiveScalingMaxCapacityBehavior | Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. |
PredictiveScalingMaxCapacityBuffer | The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. |
PredictiveScalingMode | The predictive scaling mode. |
ResourceId | The ID of the resource. This string consists of the resource type and unique identifier. |
ScalableDimension | The scalable dimension associated with the resource. |
ScalingPolicyUpdateBehavior | Controls whether a resource's externally created scaling policies are deleted and new target tracking scaling policies created. |
ScheduledActionBufferTime | The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. |
ServiceNamespace | The namespace of the AWS service. |
TargetTrackingConfigurations | The target tracking configurations (up to 10). |
Constructors
ScalingInstructionProperty()
public ScalingInstructionProperty()
Properties
CustomizedLoadMetricSpecification
The customized load metric to use for predictive scaling.
public object CustomizedLoadMetricSpecification { get; set; }
Property Value
System.Object
Remarks
This property or a PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.
DisableDynamicScaling
Controls whether dynamic scaling is disabled.
public object DisableDynamicScaling { get; set; }
Property Value
System.Object
Remarks
When dynamic scaling is enabled, AWS Auto Scaling creates target tracking scaling policies based on the specified target tracking configurations.
The default is enabled ( false
).
MaxCapacity
The maximum capacity of the resource.
public double MaxCapacity { get; set; }
Property Value
System.Double
Remarks
The exception to this upper limit is if you specify a non-default setting for PredictiveScalingMaxCapacityBehavior .
MinCapacity
The minimum capacity of the resource.
public double MinCapacity { get; set; }
Property Value
System.Double
Remarks
PredefinedLoadMetricSpecification
The predefined load metric to use for predictive scaling.
public object PredefinedLoadMetricSpecification { get; set; }
Property Value
System.Object
Remarks
This property or a CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.
PredictiveScalingMaxCapacityBehavior
Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource.
public string PredictiveScalingMaxCapacityBehavior { get; set; }
Property Value
System.String
Remarks
The default value is SetForecastCapacityToMaxCapacity
.
The following are possible values:
Valid only when configuring predictive scaling.
PredictiveScalingMaxCapacityBuffer
The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity.
public Nullable<double> PredictiveScalingMaxCapacityBuffer { get; set; }
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. With a 10 percent buffer, if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.
Valid only when configuring predictive scaling. Required if PredictiveScalingMaxCapacityBehavior is set to SetMaxCapacityAboveForecastCapacity
, and cannot be used otherwise.
The range is 1-100.
PredictiveScalingMode
The predictive scaling mode.
public string PredictiveScalingMode { get; set; }
Property Value
System.String
Remarks
The default value is ForecastAndScale
. Otherwise, AWS Auto Scaling forecasts capacity but does not apply any scheduled scaling actions based on the capacity forecast.
ResourceId
The ID of the resource. This string consists of the resource type and unique identifier.
public string ResourceId { get; set; }
Property Value
System.String
Remarks
ScalableDimension
The scalable dimension associated with the resource.
public string ScalableDimension { get; set; }
Property Value
System.String
Remarks
ScalingPolicyUpdateBehavior
Controls whether a resource's externally created scaling policies are deleted and new target tracking scaling policies created.
public string ScalingPolicyUpdateBehavior { get; set; }
Property Value
System.String
Remarks
The default value is KeepExternalPolicies
.
Valid only when configuring dynamic scaling.
ScheduledActionBufferTime
The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out.
public Nullable<double> ScheduledActionBufferTime { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
For example, if the forecast says to add capacity at 10:00 AM, and the buffer time is 5 minutes, then the run time of the corresponding scheduled scaling action will be 9:55 AM. The intention is to give resources time to be provisioned. For example, 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). The default is 300 seconds.
Valid only when configuring predictive scaling.
ServiceNamespace
The namespace of the AWS service.
public string ServiceNamespace { get; set; }
Property Value
System.String
Remarks
TargetTrackingConfigurations
The target tracking configurations (up to 10).
public object TargetTrackingConfigurations { get; set; }
Property Value
System.Object
Remarks
Each of these structures must specify a unique scaling metric and a target value for the metric.