ScalingRuleProps

Properties for defining a ScalingRule.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ess-scalingrule

Initializer

using AlibabaCloud.SDK.ROS.CDK.Ess;
new ScalingRuleProps {
    object ScalingGroupId,
    object AdjustmentType = null,
    object AdjustmentValue = null,
    object Cooldown = null,
    object DisableScaleIn = null,
    object EstimatedInstanceWarmup = null,
    object InitialMaxSize = null,
    object MetricName = null,
    object MinAdjustmentMagnitude = null,
    object PredictiveScalingMode = null,
    object PredictiveTaskBufferTime = null,
    object PredictiveValueBehavior = null,
    object PredictiveValueBuffer = null,
    object ScaleInEvaluationCount = null,
    object ScaleOutEvaluationCount = null,
    object ScalingRuleName = null,
    object ScalingRuleType = null,
    object StepAdjustment = null,
    object TargetValue = null
};

Properties

Name	Type	Description
ScalingGroupId	object	Property scalingGroupId: ID of the scaling group of a scaling rule.
AdjustmentType	object	Property adjustmentType: Adjustment mode of a scaling rule.
AdjustmentValue	object	Property adjustmentValue: Adjusted value of a scaling rule.
Cooldown	object	Property cooldown: Cool-down time of a scaling rule.
DisableScaleIn	object	Property disableScaleIn: Specifies whether to disable scale-in.
EstimatedInstanceWarmup	object	Property estimatedInstanceWarmup: The warm-up period of the ECS instances.
InitialMaxSize	object	Property initialMaxSize: The maximum number of ECS instances in the scaling group, which is used together with PredictiveValueBehavior.
MetricName	object	Property metricName: The predefined metric to monitor.
MinAdjustmentMagnitude	object	Property minAdjustmentMagnitude: The minimum number of ECS instances to be adjusted in a scaling rule.
PredictiveScalingMode	object	Property predictiveScalingMode: The mode of the predictive scaling rule.
PredictiveTaskBufferTime	object	Property predictiveTaskBufferTime: The amount of buffer time ahead of the forecast task execution time.
PredictiveValueBehavior	object	Property predictiveValueBehavior: The action taken on the predicted maximum value.
PredictiveValueBuffer	object	Property predictiveValueBuffer: The ratio of the increment to the predicted value when PredictiveValueBehavior is set to PredictiveValueOverrideMaxWithBuffer.
ScaleInEvaluationCount	object	Property scaleInEvaluationCount: The number of consecutive times that the event-triggered task created for scale-in activities meets the threshold conditions before an alert is triggered.
ScaleOutEvaluationCount	object	Property scaleOutEvaluationCount: The number of consecutive times that the event-triggered task created for scale-out activities meets the threshold conditions before an alert is triggered.
ScalingRuleName	object	Property scalingRuleName: Name shown for the scaling group, which is a string containing 2 to 40 English or Chinese characters.
ScalingRuleType	object	Property scalingRuleType: The type of the scaling rule.
StepAdjustment	object	Property stepAdjustment:.
TargetValue	object	Property targetValue: The target value of a metric.

---

ScalingGroupId^Required

public object ScalingGroupId { get; set; }

• Type: object

Property scalingGroupId: ID of the scaling group of a scaling rule.

---

AdjustmentType^Optional

public object AdjustmentType { get; set; }

• Type: object

Property adjustmentType: Adjustment mode of a scaling rule.

Optional values:

• QuantityChangeInCapacity: It is used to increase or decrease a specified number of ECS instances.
• PercentChangeInCapacity: It is used to increase or decrease a specified proportion of ECS instances.
• TotalCapacity: It is used to adjust the quantity of ECS instances in the current scaling group to a specified value.

---

AdjustmentValue^Optional

public object AdjustmentValue { get; set; }

• Type: object

Property adjustmentValue: Adjusted value of a scaling rule.

Value range:

• QuantityChangeInCapacity: [-500, 500]
• PercentChangeInCapacity: [-100, 10000]
• TotalCapacity: [0, 1000]

---

Cooldown^Optional

public object Cooldown { get; set; }

• Type: object

Property cooldown: Cool-down time of a scaling rule.

Value range: [0, 86,400], in seconds. The default value is empty.

---

DisableScaleIn^Optional

public object DisableScaleIn { get; set; }

• Type: object

Property disableScaleIn: Specifies whether to disable scale-in.

This parameter is applicable only to target tracking scaling rules. Default value: false

---

EstimatedInstanceWarmup^Optional

public object EstimatedInstanceWarmup { get; set; }

• Type: object

Property estimatedInstanceWarmup: The warm-up period of the ECS instances.

This parameter is applicable to target tracking scaling rules and step scaling rules. The system adds ECS instances that are in the warm-up state to the scaling group, but does not report monitoring data during the warm-up period to CloudMonitor. Note: When calculating the number of ECS instances to be adjusted, the system does not count ECS instances in the warm-up state as part of the current capacity of the scaling group. Valid values: 0 to 86400. Unit: seconds. Default value: 300.

---

InitialMaxSize^Optional

public object InitialMaxSize { get; set; }

• Type: object

Property initialMaxSize: The maximum number of ECS instances in the scaling group, which is used together with PredictiveValueBehavior.

Default value: the same as the value of MaxSize

---

MetricName^Optional

public object MetricName { get; set; }

• Type: object

Property metricName: The predefined metric to monitor.

This parameter is required and applicable only to target tracking scaling rules and predictive scaling rules. Valid values of a target tracking scaling rule:

• CpuUtilization: the average CPU utilization- ClassicInternetRx: the average public network inbound traffic over the classic network
• ClassicInternetTx: the average public network outbound traffic over the classic network
• VpcInternetRx: the average public network inbound traffic over the VPC
• VpcInternetTx: the average public network outbound traffic over the VPC
• IntranetRx: the average internal network inbound traffic
• IntranetTx: the average internal network outbound traffic Valid values of a predictive scaling rule:
• CpuUtilization: the average CPU utilization
• IntranetRx: the average internal network inbound traffic
• IntranetTx: the average internal network outbound traffic

---

MinAdjustmentMagnitude^Optional

public object MinAdjustmentMagnitude { get; set; }

• Type: object

Property minAdjustmentMagnitude: The minimum number of ECS instances to be adjusted in a scaling rule.

This parameter takes effect only when the scaling rule type is SimpleScalingRule or StepScalingRule and AdjustmentType is PercentChangeInCapacity.

---

PredictiveScalingMode^Optional

public object PredictiveScalingMode { get; set; }

• Type: object

Property predictiveScalingMode: The mode of the predictive scaling rule.

Valid values:

• PredictAndScale: generates forecasts and creates forecast tasks.
• PredictOnly: generates forecasts but does not create forecast tasks. Default value: PredictAndScale

---

PredictiveTaskBufferTime^Optional

public object PredictiveTaskBufferTime { get; set; }

• Type: object

Property predictiveTaskBufferTime: The amount of buffer time ahead of the forecast task execution time.

By default, all scheduled tasks that are automatically created for a predictive scaling rule are executed at the beginning of each hour. You can set a buffer time to execute forecast tasks ahead of schedule, so that resources can be prepared in advance. Valid values: 0 to 60. Unit: minutes. Default value: 0

---

PredictiveValueBehavior^Optional

public object PredictiveValueBehavior { get; set; }

• Type: object

Property predictiveValueBehavior: The action taken on the predicted maximum value.

Valid values:

• MaxOverridePredictiveValue: uses the initial maximum capacity as the maximum value for forecast tasks when the predicted value is greater than the initial maximum capacity.

• PredictiveValueOverrideMax: uses the predicted value as the maximum value for forecast tasks when the predicted value is greater than the initial maximum capacity.

• PredictiveValueOverrideMaxWithBuffer: increases the predicted value with a ratio, which is specified by PredictiveValueBuffer. If the value after the increase is greater than the initial maximum capacity, the value after the increase is used as the maximum value for forecast tasks. Default value: MaxOverridePredictiveValue

---

PredictiveValueBuffer^Optional

public object PredictiveValueBuffer { get; set; }

• Type: object

Property predictiveValueBuffer: The ratio of the increment to the predicted value when PredictiveValueBehavior is set to PredictiveValueOverrideMaxWithBuffer.

When the value after the increase is greater than the initial maximum capacity, the value after the increase is used for forecast tasks. Valid values: 0 to 100 Default value: 0

---

ScaleInEvaluationCount^Optional

public object ScaleInEvaluationCount { get; set; }

• Type: object

Property scaleInEvaluationCount: The number of consecutive times that the event-triggered task created for scale-in activities meets the threshold conditions before an alert is triggered.

After a target tracking scaling rule is created, an event-triggered task is automatically created and then associated with the target tracking scaling rule. Default value: 15.

---

ScaleOutEvaluationCount^Optional

public object ScaleOutEvaluationCount { get; set; }

• Type: object

Property scaleOutEvaluationCount: The number of consecutive times that the event-triggered task created for scale-out activities meets the threshold conditions before an alert is triggered.

After a target tracking scaling rule is created, an event-triggered task is automatically created and then associated with the target tracking scaling rule. Default value: 3.

---

ScalingRuleName^Optional

public object ScalingRuleName { get; set; }

• Type: object

Property scalingRuleName: Name shown for the scaling group, which is a string containing 2 to 40 English or Chinese characters.

It must begin with a number, a letter (case-insensitive) or a Chinese character and can contain numbers, "_", "-" or ".". The account name in the same scaling group is unique in the same region. If this parameter value is not specified, the default value is ScalingRuleId.

---

ScalingRuleType^Optional

public object ScalingRuleType { get; set; }

• Type: object

Property scalingRuleType: The type of the scaling rule.

Valid values:

• SimpleScalingRule: scales ECS instances based on the values of AdjustmentType and AdjustmentValue.
• TargetTrackingScalingRule: dynamically calculates the number of ECS instances to be adjusted and tries to keep the value of a predefined monitoring metric close to TargetValue.
• StepScalingRule: scales ECS instances in steps based on specified thresholds and metric values.
• PredictiveScalingRule: uses machine learning to analyze historical monitoring data of the scaling group and then predicts the future values of monitored metrics, the rule then automatically creates scheduled tasks to set the boundary values for the scaling group. If this parameter value is not specified, the default value is SimpleScalingRule.

---

StepAdjustment^Optional

public object StepAdjustment { get; set; }

• Type: object

Property stepAdjustment:.

---

TargetValue^Optional

public object TargetValue { get; set; }

• Type: object

Property targetValue: The target value of a metric.

This parameter is required and applicable only to target tracking scaling rules and predictive scaling rules. The value of TargetValue must be greater than 0 and can have a maximum of three decimal places.

---