ALIYUN::ESS::ScalingGroupEnable - Resource Orchestration Service - Alibaba Cloud ドキュメントセンター

ALIYUN::ESS::ScalingGroupEnable は、スケーリンググループを有効にするために使用されます。

構文

{
  "Type": "ALIYUN::ESS::ScalingGroupEnable",
  "Properties": {
    "ScalingConfigurationId": String,
    "ScalingRuleArisExecuteVersion": Integer,
    "ScalingRuleAris": List,
    "ScalingGroupId": String,
    "RemoveInstanceIds": List,
    "InstanceIds": List,
    "DetachOptions": Map,
    "AttachOptions": Map
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ScalingGroupId	String	はい	いいえ	スケーリンググループのID。	なし。
ScalingConfigurationId	String	いいえ	いいえ	スケーリンググループで有効にするスケーリング設定のID。	なし。
InstanceIds	List	いいえ	はい	スケーリンググループが有効になった後に、スケーリンググループに追加するElastic Compute Service (ECS) インスタンスのID。	最大 20 個のインスタンス ID を指定できます。
ScalingRuleArisExecuteVersion	Integer	いいえ	はい	実行するスケーリングルールの識別子のバージョン。このプロパティの値を変更すると、システムは ScalingRuleAris プロパティで指定されたすべてのスケーリングルールを 1 回実行します。	最小値: 0。
ScalingRuleAris	List	いいえ	はい	スケーリングルールの固有識別子のリスト。非アクティブなスケーリングルールの固有識別子は、クエリ結果で無視され、エラーは報告されません。	最大 10 個の識別子を指定できます。
RemoveInstanceIds	List	いいえ	はい	スケーリンググループから削除する ECS インスタンスの ID。	最大 1,000 個のインスタンス ID を指定できます。
DetachOptions	Map	いいえ	はい	スケーリンググループから削除するインスタンスの設定項目。	詳細については、「DetachOptions プロパティ」をご参照ください。
AttachOptions	Map	いいえ	はい	スケーリンググループに追加するインスタンスの設定項目。	詳細については、「AttachOptions プロパティ」をご参照ください。

AttachOptions 構文

{
    "LifecycleHook": Boolean,
    "Entrusted": Boolean
}

AttachOptions プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

LifecycleHook

Boolean

いいえ

はい

スケールアウトアクティビティのライフサイクルフックをトリガーするかどうかを指定します。

デフォルト値: false。有効な値:

true
false

Entrusted

Boolean

いいえ

はい

スケーリンググループが、スケーリンググループに手動で追加されたインスタンスのライフサイクルを管理するかどうかを指定します。

デフォルト値: false。有効な値:

true: スケーリンググループは、手動で追加されたインスタンスと自動的に作成されたインスタンスのライフサイクルを同じ方法で管理します。
DetachInstances オペレーションを呼び出してスケーリンググループからインスタンスを削除する場合、インスタンスは解放されません。それ以外の場合、インスタンスはスケーリンググループから削除されると解放されます。
false: スケーリンググループは、手動で追加されたインスタンスのライフサイクルを管理しません。インスタンスがスケーリンググループから削除されても、インスタンスは解放されません。

説明

このプロパティは、サブスクリプションインスタンスには有効ではありません。

DetachOptions 構文

{
    "LifecycleHook": Boolean,
    "DecreaseDesiredCapacity": Boolean,
    "DetachOption": "String"
}

DetachOptions プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
LifecycleHook	Boolean	いいえ	はい	スケールインアクティビティのライフサイクルフックをトリガーするかどうかを指定します。	デフォルト値: false。有効な値: true false
DecreaseDesiredCapacity	Boolean	いいえ	はい	スケーリンググループ内のインスタンスの予想数を変更するかどうかを指定します。	デフォルト値: true。有効な値: true: 特定数の ECS インスタンスまたは弾性コンテナインスタンスがスケーリンググループから削除されると、スケーリンググループ内のインスタンスの予想数が減少します。 false: 特定数の ECS インスタンスまたは弾性コンテナインスタンスがスケーリンググループから削除されても、スケーリンググループ内のインスタンスの予想数は変更されません。
DetachOption	String	いいえ	はい	スケーリンググループに関連付けられている Server Load Balancer (SLB) インスタンスのデフォルトサーバーグループと vServer グループから ECS インスタンスと弾性コンテナインスタンスを削除するかどうか、およびこれらのインスタンスの IP アドレスをスケーリンググループに関連付けられている ApsaraDB RDS インスタンスへのアクセスを管理するために使用されるホワイトリストから削除するかどうかを指定します。	値を both に設定します。この場合、ECS インスタンスと弾性コンテナインスタンスは、関連付けられている SLB インスタンスのデフォルトサーバーグループと vServer グループから削除され、これらのインスタンスの IP アドレスは関連するホワイトリストから削除されます。

戻り値

Fn::GetAtt

LifecycleState: スケーリンググループの状態。
ScalingInstances: スケーリンググループで自動的に作成されるインスタンス。
ScalingGroupId: スケーリンググループの ID。
ScalingRuleArisExecuteResultInstancesRemoved: ScalingRuleAris プロパティで指定されたスケーリングルールを実行することでスケーリンググループから削除されるインスタンス。
ScalingRuleArisExecuteResultNumberOfAddedInstances: ScalingRuleAris プロパティで指定されたスケーリングルールを実行することでスケーリンググループに追加されるインスタンスの数。
ScalingInstanceDetails: スケーリングアクティビティがトリガーされるインスタンスの詳細。
ScalingRuleArisExecuteErrorInfo: ScalingRuleAris プロパティで指定されたスケーリングルールの実行に関するエラー情報。
ScalingRuleArisExecuteResultInstancesAdded: ScalingRuleAris プロパティで指定されたスケーリングルールを実行することでスケーリンググループに追加されるインスタンス。

例

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ECSInstanceIds:
    Type: CommaDelimitedList
    AssociationProperty: ALIYUN::ECS::Instance::InstanceId
  AutoScalingGroupId:
    Type: String
    AssociationProperty: ALIYUN::ESS::AutoScalingGroup::AutoScalingGroupId
  ScalingConfigurationId:
    Type: String
    AssociationProperty: ALIYUN::ESS::ScalingConfiguration::ScalingConfigurationId
Resources:
  ScalingGroupEnable:
    Type: ALIYUN::ESS::ScalingGroupEnable
    Properties:
      ScalingGroupId:
        Ref: AutoScalingGroupId
      ScalingConfigurationId:
        Ref: ScalingConfigurationId
      InstanceIds:
        Ref: InstanceIds
Outputs:
  ScalingGroupEnable:
    Value:
      Fn::GetAtt:
        - ScalingGroupEnable
        - LifecycleState

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ECSInstanceIds": {
      "Type": "CommaDelimitedList",
      "AssociationProperty": "ALIYUN::ECS::Instance::InstanceId"
    },
    "AutoScalingGroupId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ESS::AutoScalingGroup::AutoScalingGroupId"
    },
    "ScalingConfigurationId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ESS::ScalingConfiguration::ScalingConfigurationId"
    }
  },
  "Resources": {
    "ScalingGroupEnable": {
      "Type": "ALIYUN::ESS::ScalingGroupEnable",
      "Properties": {
        "ScalingGroupId": {
          "Ref": "AutoScalingGroupId"
        },
        "ScalingConfigurationId": {
          "Ref": "ScalingConfigurationId"
        },
        "InstanceIds": {
          "Ref": "InstanceIds"
        }
      }
    }
  },
  "Outputs": {
    "ScalingGroupEnable": {
      "Value": {
        "Fn::GetAtt": [
          "ScalingGroupEnable",
          "LifecycleState"
        ]
      }
    }
  }
}