ALIYUN::ESS::ScalingRule - Resource Orchestration Service (ROS) - Alibaba Cloud - Resource Orchestration Service

構文

{
  "Type": "ALIYUN::ESS::ScalingRule",
  "Properties": {
    "AdjustmentValue": Integer,
    "Cooldown": Integer,
    "ScalingGroupId": String,
    "AdjustmentType": String,
    "ScalingRuleName": String,
    "MetricName": String,
    "PredictiveTaskBufferTime": Integer,
    "ScalingRuleType": String,
    "PredictiveValueBuffer": Integer,
    "TargetValue": Number,
    "StepAdjustment": List,
    "PredictiveValueBehavior": String,
    "DisableScaleIn": Boolean,
    "InitialMaxSize": Integer,
    "MinAdjustmentMagnitude": Integer,
    "EstimatedInstanceWarmup": Integer,
    "PredictiveScalingMode": String,
    "ScaleInEvaluationCount": Integer,
    "ScaleOutEvaluationCount": Integer
  }
}

プロパティ

プロパティ名	タイプ	必須	更新を許可	説明	制約
AdjustmentValue	Integer	いいえ	はい	調整値です。簡易スケーリングルールとステップスケーリングルールに適用されます。	有効な値は `AdjustmentType` によって異なります。 `QuantityChangeInCapacity`：-500～500 `PercentChangeInCapacity`：-100～10,000 `TotalCapacity`：0～1,000 説明 1 回のスケーリングアクティビティで調整される ECS インスタンスの数は 500 を超えることはできません。例えば、`AdjustmentType` が `TotalCapacity` の場合、`AdjustmentValue` の設定によって 500 を超えるインスタンスの調整が必要になったとしても、実際に増減されるインスタンス数は 500 に制限されます。
Cooldown	Integer	いいえ	はい	クールダウン期間です。簡易スケーリングルールにのみ適用されます。	有効な値：0～86,400 単位：秒デフォルト値はありません。
ScalingGroupId	String	はい	いいえ	スケーリングルールが属するスケーリンググループの ID です。	なし
AdjustmentType	String	いいえ	はい	調整方法です。簡易スケーリングルールとステップスケーリングルールに適用されます。	有効な値： `QuantityChangeInCapacity`：指定された数の ECS インスタンスを追加または削除します。 `PercentChangeInCapacity`：指定されたパーセンテージの ECS インスタンスを追加または削除します。 `TotalCapacity`：現在のスケーリンググループ内の ECS インスタンスの数を指定された数に調整します。
ScalingRuleName	String	いいえ	はい	スケーリングルールの名前です。	名前の長さは 2～64 文字である必要があります。英字、数字、アンダースコア (_)、ハイフン (-)、ピリオド (.) を使用できます。名前は英字または数字で始まる必要があります。このパラメーターを指定しない場合、デフォルトで `ScalingRuleId` の値が使用されます。
MetricName	String	いいえ	いいえ	事前定義されたメトリクスです。ターゲット追跡スケーリングルールと予測スケーリングルールに適用されます。	有効な値：ターゲット追跡スケーリングルールの場合： `CpuUtilization`：平均 CPU 使用率 `ClassicInternetRx`：クラシックネットワーク経由の平均インバウンドインターネットトラフィック `ClassicInternetTx`：クラシックネットワーク経由の平均アウトバウンドインターネットトラフィック `VpcInternetRx`：Virtual Private Cloud (VPC) 経由の平均インバウンドインターネットトラフィック `VpcInternetTx`：VPC 経由の平均アウトバウンドインターネットトラフィック `IntranetRx`：平均インバウンドプライベートネットワークトラフィック `IntranetTx`：平均アウトバウンドプライベートネットワークトラフィック予測スケーリングルールの場合： `CpuUtilization`：平均 CPU 使用率 `IntranetRx`：平均インバウンドプライベートネットワークトラフィック `IntranetTx`：平均アウトバウンドプライベートネットワークトラフィック
PredictiveTaskBufferTime	Integer	いいえ	いいえ	予測スケーリングルールは、1 時間ごとに実行される予測タスクを自動的に作成します。バッファ時間を設定すると、タスクが事前に実行され、リソースが準備されます。	有効な値：0～60 単位：分デフォルト値：0
ScalingRuleType	String	いいえ	いいえ	スケーリングルールのタイプです。	有効な値： `SimpleScalingRule` (デフォルト)：簡易スケーリングルールです。`AdjustmentType` と `AdjustmentValue` に基づいて ECS インスタンスの数を調整します。 `TargetTrackingScalingRule`：ターゲット追跡スケーリングルールです。事前定義されたメトリクス (`MetricName`) に基づいてスケーリングする ECS インスタンスの数を動的に計算します。このルールは、メトリクス値をターゲット値 (`TargetValue`) に近づけるように動作します。 `StepScalingRule`：ステップスケーリングルールです。しきい値とメトリクス値に基づいて段階的なスケーリング方法を提供します。 `PredictiveScalingRule`：予測スケーリングルールです。機械学習を使用してスケーリンググループの過去のモニタリングデータを分析し、将来のメトリクス値を予測します。このルールは、スケーリンググループの境界を設定するためのスケジュールされたタスクの自動作成もサポートします。
PredictiveValueBuffer	Integer	いいえ	いいえ	予測値を増加させるパーセンテージです。`PredictiveValueBehavior` が `PredictiveValueOverrideMaxWithBuffer` に設定されている場合にのみ有効です。増加した値が初期の最大値より大きい場合、その増加した値が使用されます。	有効な値：0～100 デフォルト値：0
TargetValue	Number	いいえ	いいえ	ターゲット値です。ターゲット追跡スケーリングルールと予測スケーリングルールに適用されます。	`TargetValue` の値は、小数点以下 3 桁まで設定でき、0 より大きい必要があります。
StepAdjustment	List	いいえ	いいえ	ステップ調整です。	詳細については、「StepAdjustment のプロパティ」をご参照ください。
PredictiveValueBehavior	String	いいえ	いいえ	予測スケーリングルールの最大値に対するアクションです。	有効な値： `MaxOverridePredictiveValue` (デフォルト)：初期の最大値が予測値を上書きします。予測値が初期の最大値より大きい場合、予測タスクには初期の最大値が使用されます。 `PredictiveValueOverrideMax`：予測値が初期の最大値を上書きします。予測値が初期の最大値より大きい場合、予測タスクには予測値が使用されます。 `PredictiveValueOverrideMaxWithBuffer`：予測値が指定されたパーセンテージだけ増加します。予測値は `PredictiveValueBuffer` で指定されたパーセンテージだけ増加します。増加した値が初期の最大値より大きい場合、その増加した値が使用されます。
DisableScaleIn	Boolean	いいえ	いいえ	スケールインを無効にするかどうかを指定します。ターゲット追跡スケーリングルールにのみ適用されます。	有効な値： true false (デフォルト)
InitialMaxSize	Integer	いいえ	いいえ	スケーリンググループ内のインスタンスの最大数です。`PredictiveValueBehavior` とともに使用されます。	デフォルト値は、スケーリンググループのインスタンスの最大数 (`MaxSize`) です。
MinAdjustmentMagnitude	Integer	いいえ	いいえ	調整するインスタンスの最小数です。	このパラメーターは、`ScalingRuleType` が `SimpleScalingRule` または `StepScalingRule` で、かつ `AdjustmentType` が `PercentChangeInCapacity` の場合にのみ有効です。
EstimatedInstanceWarmup	Integer	いいえ	いいえ	新しく追加されたインスタンスのウォームアップ期間です。ターゲット追跡スケーリングルールとステップスケーリングルールに適用されます。	有効な値：0～86,400 単位：秒デフォルト値：300 ランプアップ状態の ECS インスタンスは通常どおりスケーリンググループに追加されますが、この期間中、そのモニタリングデータは CloudMonitor にレポートされません。説明スケーリングする ECS インスタンスの数が動的に計算される場合、ランプアップ状態のインスタンスは現在のインスタンス数の一部としてカウントされません。
PredictiveScalingMode	String	いいえ	いいえ	予測スケーリングルールのモードです。	有効な値： `PredictAndScale` (デフォルト)：予測結果を生成し、予測タスクを作成します。 `PredictOnly`：予測結果を生成しますが、予測タスクは作成しません。
ScaleInEvaluationCount	Integer	いいえ	はい	スケールインのイベントトリガータスクがトリガーされる前に、しきい値を満たす必要がある連続回数です。	ターゲット追跡スケーリングルールを作成すると、イベントトリガータスクが自動的に作成されます。デフォルト値：15
ScaleOutEvaluationCount	Integer	いいえ	はい	スケールアウトのイベントトリガータスクがトリガーされる前に、しきい値を満たす必要がある連続回数です。	ターゲット追跡スケーリングルールを作成すると、イベントトリガータスクが自動的に作成されます。デフォルト値：3

StepAdjustment の構文

"StepAdjustment": [
  {
    "MetricIntervalUpperBound": Number,
    "ScalingAdjustment": Integer,
    "MetricIntervalLowerBound": Number
  }
]

StepAdjustment のプロパティ

プロパティ名	タイプ	必須	更新を許可	説明	制約
MetricIntervalUpperBound	Number	いいえ	いいえ	ステップの上限です。ステップスケーリングルールにのみ適用されます。	有効な値：-9.999999E18～9.999999E18
ScalingAdjustment	Integer	いいえ	いいえ	ステップで追加するインスタンスの数です。ステップスケーリングルールにのみ適用されます。	なし
MetricIntervalLowerBound	Number	いいえ	いいえ	ステップの下限です。ステップスケーリングルールにのみ適用されます。	有効な値：-9.999999E18～9.999999E18

戻り値

Fn::GetAtt

ScalingRuleAri：スケーリングルールの一意の識別子です。
ScalingRuleId：システムによって生成された、スケーリングルールのグローバルに一意な ID です。

例

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Description: ESS スケーリングルールのテスト
Parameters:
  AutoScalingGroupId:
    Type: String
    AssociationProperty: ALIYUN::ESS::AutoScalingGroup::AutoScalingGroupId
Resources:
  ScalingRule:
    Type: ALIYUN::ESS::ScalingRule
    Properties:
      AdjustmentType: QuantityChangeInCapacity
      ScalingGroupId:
        Ref: AutoScalingGroupId
      AdjustmentValue: 1
Outputs: {}

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": "ESS スケーリングルールのテスト",
  "Parameters": {
    "AutoScalingGroupId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ESS::AutoScalingGroup::AutoScalingGroupId"
    }
  },
  "Resources": {
    "ScalingRule": {
      "Type": "ALIYUN::ESS::ScalingRule",
      "Properties": {
        "AdjustmentType": "QuantityChangeInCapacity",
        "ScalingGroupId": {
          "Ref": "AutoScalingGroupId"
        },
        "AdjustmentValue": 1
      }
    }
  },
  "Outputs": {
  }
}