Auto Scaling 用の DATASOURCE::ESS::ScalingGroups 概要 - ROS

DATASOURCE::ESS::ScalingGroups は、スケーリンググループを照会するために使用されます。

構文

{
  "Type": "DATASOURCE::ESS::ScalingGroups",
  "Properties": {
    "ScalingGroupNames": List,
    "GroupType": String,
    "ScalingGroupIds": List,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ScalingGroupNames	List	いいえ	はい	スケーリンググループの名前。	非アクティブなスケーリンググループの名前の場合、システムはクエリ結果に名前を表示したり、エラーを報告したりしません。説明リクエストで最大 20 のスケーリンググループ名を照会できます。
GroupType	String	いいえ	はい	スケーリンググループで管理されているインスタンスタイプ。	有効な値: ECS（デフォルト）: Elastic Compute Service（ECS）インスタンス ECI: エラスティックコンテナインスタンス
ScalingGroupIds	List	いいえ	はい	スケーリンググループのID。	非アクティブなスケーリンググループの ID の場合、システムはクエリ結果に ID を表示したり、エラーを報告したりしません。説明リクエストで最大 20 のスケーリンググループ ID を照会できます。
RefreshOptions	String	いいえ	はい	スタックが更新されたときのデータソースリソースの更新ポリシー。	有効な値: Never（デフォルト）: スタックが更新されてもデータソースリソースを更新しません。 Always: スタックが更新されたときにデータソースリソースを更新します。

戻り値 (Fn::GetAtt)

ScalingGroups: スケーリンググループの詳細。
ScalingGroupIds: スケーリンググループの ID。

プロパティ	タイプ	説明	制約
ScalingGroupIds	List	スケーリンググループの ID。	なし。
ScalingGroups	List	スケーリンググループの詳細。	なし。
DesiredCapacity	Number	スケーリンググループ内の ECS インスタンスの予想数。	Auto Scaling は、スケーリンググループ内の ECS インスタンスの予想数を自動的に維持します。
LifecycleState	String	スケーリンググループのステータス。	有効な値: Active: スケーリンググループはアクティブです。アクティブなスケーリンググループは、スケーリングルールを実行し、スケーリングアクティビティをトリガーするリクエストを受信できます。 Inactive: スケーリンググループは非アクティブです。
TotalInstanceCount	Number	スケーリンググループ内の ECS インスタンスの総数。	なし。
Weighted	Boolean	インスタンスタイプの重みが指定されているかどうかを示します。	有効な値: true false
RemovalPolicies	List	スケーリンググループから ECS インスタンスが削除される基になるポリシー。	有効な値: OldestInstance: 最も早く作成された ECS インスタンスが削除されます。 NewestInstance: 最も最近作成された ECS インスタンスが削除されます。 OldestScalingConfiguration: 最も古いスケーリング設定に基づいて作成された ECS インスタンスが削除されます。
PendingWaitCapacity	Number	スケーリンググループに追加されるのを待機している ECS インスタンスの数。	なし。
TotalCapacity	Number	Weighted が指定されている場合は、スケーリンググループ内のすべての ECS インスタンスの合計加重容量。Weighted が指定されていない場合は、スケーリンググループ内のすべての ECS インスタンスの総数。	なし。
RemovingWaitCapacity	Number	スケーリンググループから削除されるのを待機している ECS インスタンスの数。	なし。
IsElasticStrengthInAlarm	Boolean	アラートがトリガーされるかどうかを示します。	なし。
ProtectedCapacity	Number	スケーリンググループで保護されている ECS インスタンスの数。	なし。
StandbyCapacity	Number	スケーリンググループでスタンバイ状態のインスタンスの数。	なし。
ScalingPolicy	String	スケーリンググループの再利用モード。	有効な値: recycle: エコノミーモード release: リリースモード説明インスタンスを削除する方法の詳細については、「RemoveInstances」をご参照ください。
SuspendedProcesses	List	中断されたプロセス。	有効な値: ScaleIn: スケールインプロセス ScaleOut: スケールアウトプロセス HealthCheck: ヘルスチェックプロセス AlarmNotification: イベントトリガータスクプロセス ScheduledAction: スケジュールタスクプロセス
RemovingCapacity	Number	スケーリンググループから削除されている ECS インスタンスの数。	なし。
VSwitchIds	List	スケーリンググループに関連付けられている vSwitch の ID。	VSwitchIds が指定されている場合、VSwitchId は無視されます。
ScalingGroupId	String	スケーリンググループの ID。	なし。
PendingCapacity	Number	スケーリンググループに追加され、まだ構成されている ECS インスタンスの数。	なし。
VSwitchId	String	スケーリンググループに関連付けられている vSwitch の ID。	なし。
LoadBalancerIds	List	スケーリンググループに関連付けられている Server Load Balancer (SLB) インスタンスの ID。	なし。
GroupDeletionProtection	Boolean	スケーリンググループで削除保護機能が有効になっているかどうかを示します。	有効な値: true: スケーリンググループで削除保護機能が有効になっています。この場合、スケーリンググループを削除することはできません。 false: スケーリンググループで削除保護機能が無効になっています。
MaxSize	Number	スケーリンググループ内の ECS インスタンス数の上限。	なし。
ScalingGroupName	String	スケーリンググループの名前。	なし。
MinSize	Number	スケーリンググループ内の ECS インスタンス数の下限。	なし。
ActiveCapacity	Number	スケーリンググループに追加され、想定どおりに実行されている ECS インスタンスの数。	なし。
DefaultCooldown	Number	スケーリンググループのデフォルトのクールダウン期間。	クールダウン期間中、Auto Scaling は、スケーリンググループの CloudMonitor イベントトリガータスクによってトリガーされたスケーリングアクティビティのみを実行します。
VpcId	String	スケーリンググループが属する仮想プライベートクラウド (VPC) の ID。	なし。
GroupType	String	スケーリンググループで管理されているインスタンスタイプ。	有効な値: ECS (デフォルト): ECS インスタンス ECI: エラスティックコンテナインスタンス
SystemSuspended	Boolean	Auto Scaling がスケーリンググループでスケーリングアクティビティの実行を停止するかどうかを示します。	有効な値: true: Auto Scaling は、スケーリンググループでスケーリングアクティビティの実行を停止します。これは、スケーリンググループで連続したスケーリングアクティビティが 7 日間以上失敗したことを示します。スケーリングアクティビティの実行を再開するには、スケーリンググループまたはスケーリング設定を変更する必要があります。 false: Auto Scaling は、スケーリンググループでスケーリングアクティビティを実行します。
CreationTime	String	スケーリンググループが作成された時刻。	なし。
MultiAZPolicy	String	マルチゾーンスケーリンググループの ECS インスタンスのスケーリングポリシー。	有効な値: PRIORITY: Auto Scaling は、VSwitchIds の値に基づいて ECS インスタンスをスケーリングします。 Auto Scaling が最も優先度の高い vSwitch が存在するゾーンで ECS インスタンスをスケールアウトできない場合、Auto Scaling は次に優先度の高い vSwitch が存在するゾーンで ECS インスタンスをスケールアウトします。 COST_OPTIMIZED: Auto Scaling は、vCPU 単価の昇順に基づいて ECS インスタンスをスケールアウトします。スケーリング設定で複数のプリエンプティブインスタンスタイプが指定されている場合、Auto Scaling は優先的にプリエンプティブインスタンスを作成します。在庫不足のためにプリエンプティブインスタンスを作成できない場合は、CompensateWithOnDemand を使用して、従量課金インスタンスを自動的に作成するかどうかを指定できます。説明 COST_OPTIMIZED は、スケーリング設定で複数のインスタンスタイプが指定されている場合、またはプリエンプティブインスタンスが使用されている場合にのみ有効です。 BALANCE: Auto Scaling は、スケーリンググループに指定されたゾーン全体に ECS インスタンスを均等に分散します。在庫不足のために ECS インスタンスをゾーン全体に均等に分散できない場合は、RebalanceInstances オペレーションを呼び出して分散のバランスをとることができます。
StoppedCapacity	Number	スケーリンググループでエコノミーモードになっているインスタンスの数。	なし。
DBInstanceIds	List	スケーリンググループに関連付けられている ApsaraDB RDS インスタンスの ID。	例: `[ "rm-bp15556qzebg1**", "rm-shj1829939342**"]`。
HealthCheckType	String	スケーリンググループのヘルスチェックタイプ。	有効な値: NONE: ヘルスチェックは実行されません。 ECS: スケーリンググループの ECS インスタンスでヘルスチェックが実行されます。

例

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "GroupType": {
      "Type": "String",
      "Description": "スケーリンググループによって管理されるインスタンスタイプ。有効な値:\nECS: Elastic Compute Service (ECS) インスタンス\nECI: エラスティックコンテナインスタンス\nデフォルト値: ECS。", // 翻訳済みのコメント
      "Default": "ECS"
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ESS::ScalingGroups",
      "Properties": {
        "GroupType": {
          "Ref": "GroupType"
        }
      }
    }
  },
  "Outputs": {
    "ScalingGroups": {
      "Description": "スケーリンググループのリスト。", // 翻訳済みのコメント
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ScalingGroups"
        ]
      }
    },
    "ScalingGroupIds": {
      "Description": "スケーリンググループ ID のリスト。", // 翻訳済みのコメント
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ScalingGroupIds"
        ]
      }
    }
  }
}

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  GroupType:
    Type: String
    Description: |-
      スケーリンググループによって管理されるインスタンスタイプ。有効な値:
      ECS: Elastic Compute Service (ECS) インスタンス
      ECI: エラスティックコンテナインスタンス
      デフォルト値: ECS。 // 翻訳済みのコメント
    Default: ECS
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ESS::ScalingGroups
    Properties:
      GroupType:
        Ref: GroupType
Outputs:
  ScalingGroups:
    Description: スケーリンググループのリスト。 // 翻訳済みのコメント
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ScalingGroups
  ScalingGroupIds:
    Description: スケーリンググループ ID のリスト。 // 翻訳済みのコメント
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ScalingGroupIds