ROS テンプレートによる ECS 自動プロビジョニンググループのデプロイ - ROS

ALIYUN::ECS::AutoProvisioningGroup は、自動プロビジョニンググループを作成するために使用されます。

構文

{
  "Type": "ALIYUN::ECS::AutoProvisioningGroup",
  "Properties": {
    "SpotInstancePoolsToUseCount": Integer,
    "AutoProvisioningGroupName": String,
    "ValidUntil": String,
    "Description": String,
    "PayAsYouGoAllocationStrategy": String,
    "MaxSpotPrice": Number,
    "LaunchTemplateId": String,
    "DefaultTargetCapacityType": String,
    "SpotInstanceInterruptionBehavior": String,
    "SpotTargetCapacity": String,
    "SpotAllocationStrategy": String,
    "PayAsYouGoTargetCapacity": String,
    "TotalTargetCapacity": String,
    "AutoProvisioningGroupType": String,
    "LaunchTemplateVersion": String,
    "ValidFrom": String,
    "ExcessCapacityTerminationPolicy": String,
    "TerminateInstances": Boolean,
    "TerminateInstancesWithExpiration": Boolean,
    "CheckExecutionStatus": Boolean,
    "LaunchConfiguration": Map
    "LaunchTemplateConfig": List,
    "MinTargetCapacity": String,
    "ResourcePoolOptions": Map,
    "DataDiskConfig": List,
    "ResourceGroupId": String,
    "SystemDiskConfig": List
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
SpotInstancePoolsToUseCount	Integer	いいえ	いいえ	自動プロビジョニンググループが最も低い価格のインスタンスタイプを選択して作成するインスタンスの数。	このプロパティの値は、起動テンプレートの拡張構成の数よりも小さくなければなりません。このプロパティは、SpotAllocationStrategy が lowest-price に設定されている場合に有効になります。
AutoProvisioningGroupName	String	いいえ	いいえ	自動プロビジョニンググループの名前。	名前は 2 ～ 128 文字の長さでなければなりません。文字で始まり、`http://` または `https://` で始めることはできません。文字、数字、コロン（:）、アンダースコア（_）、ハイフン（-）を含めることができます。
ValidUntil	String	いいえ	いいえ	自動プロビジョニンググループの有効期限。自動プロビジョニンググループは、ValidFrom と ValidUntil で指定された期間中に有効です。	ISO 8601 標準の `yyyy-MM-ddTHH:mm:ssZ` 形式で時間を指定します。時間は UTC でなければなりません。
Description	String	いいえ	いいえ	自動プロビジョニンググループの説明。	なし。
PayAsYouGoAllocationStrategy	String	いいえ	いいえ	自動プロビジョニンググループが従量課金インスタンスを作成する際に基づくポリシー。	有効な値： lowest-price（デフォルト）：コスト最適化ポリシー。自動プロビジョニンググループは、最も低い価格のインスタンスタイプを選択してインスタンスを作成します。 prioritized：優先順位ベースのポリシー。自動プロビジョニンググループは、LaunchTemplateConfig で指定された優先順位に基づいて従量課金インスタンスを作成します。
MaxSpotPrice	Number	いいえ	はい	自動プロビジョニンググループ内のプリエンプティブルインスタンスの最大価格。	MaxSpotPrice プロパティと MaxPrice プロパティの両方が指定されている場合、プロパティ値の小さい方の値が優先されます。MaxPrice の詳細については、LaunchTemplateConfig プロパティを参照してください。
LaunchTemplateId	String	いいえ	いいえ	自動プロビジョニンググループに関連付ける起動テンプレートの ID。	DescribeLaunchTemplates オペレーションを呼び出して、使用可能な起動テンプレートを照会できます。 LaunchTemplateId と LaunchConfiguration の両方が指定されている場合、LaunchTemplateId が優先されます。
DefaultTargetCapacityType	String	いいえ	はい	補足インスタンスのタイプ。PayAsYouGoTargetCapacity と SpotTargetCapacity の値の合計が TotalTargetCapacity の値よりも小さい場合、自動プロビジョニンググループは指定された課金方法のインスタンスを作成して、ターゲット容量を満たします。	有効な値： PayAsYouGo：従量課金インスタンス。 Spot（デフォルト）：プリエンプティブルインスタンス。
SpotInstanceInterruptionBehavior	String	いいえ	いいえ	超過したプリエンプティブルインスタンスが停止された後に実行されるアクション。	有効な値： stop（デフォルト）：超過したプリエンプティブルインスタンスを停止状態のまま保持します。 terminate：停止状態の超過したプリエンプティブルインスタンスを解放します。
SpotTargetCapacity	String	いいえ	はい	自動プロビジョニンググループ内のプリエンプティブルインスタンスのターゲット容量。	このプロパティの値は、TotalTargetCapacity の値よりも小さくなければなりません。
SpotAllocationStrategy	String	いいえ	いいえ	プリエンプティブルインスタンスを作成するためのポリシー。	有効な値： lowest-price（デフォルト）：コスト最適化ポリシー。自動プロビジョニンググループは、最も低い価格のインスタンスタイプを選択してインスタンスを作成します。 diversified：バランスのとれた分散ポリシー。自動プロビジョニンググループは、起動テンプレートの拡張構成で指定されたゾーンにインスタンスを作成し、ゾーン全体にインスタンスを均等に分散します。
PayAsYouGoTargetCapacity	String	いいえ	はい	自動プロビジョニンググループ内の従量課金インスタンスのターゲット容量。	このプロパティの値は、TotalTargetCapacity の値よりも小さくなければなりません。
TotalTargetCapacity	String	はい	はい	自動プロビジョニンググループの合計ターゲット容量。	値は、PayAsYouGoTargetCapacity と SpotTargetCapacity の値の合計以上である正の整数でなければなりません。
AutoProvisioningGroupType	String	いいえ	いいえ	自動プロビジョニンググループの配信タイプ。	有効な値： request：ワンタイムデリバリー。自動プロビジョニンググループが起動されると、インスタンスは一度だけ配信されます。インスタンスの配信に失敗した場合、自動プロビジョニンググループは配信を再試行しません。 maintain（デフォルト）：継続的デリバリー。自動プロビジョニンググループが起動されると、ターゲット容量を満たすインスタンスの配信が試行され、リアルタイム容量が監視されます。自動プロビジョニンググループのターゲット容量に達していない場合は常に、自動プロビジョニンググループはターゲット容量に達するまでインスタンスの作成を続けます。
LaunchTemplateVersion	String	いいえ	いいえ	自動プロビジョニンググループに関連付ける起動テンプレートのバージョン。	DescribeLaunchTemplateVersions オペレーションを呼び出して、使用可能なインスタンス起動テンプレートバージョンを照会できます。
ValidFrom	String	いいえ	いいえ	自動プロビジョニンググループの開始時間。自動プロビジョニンググループは、ValidFrom と ValidUntil で指定された期間中に有効です。	ISO 8601 標準の `yyyy-MM-ddTHH:mm:ssZ` 形式で時間を指定します。時間は UTC でなければなりません。
ExcessCapacityTerminationPolicy	String	いいえ	はい	自動プロビジョニンググループの合計ターゲット容量を超えた場合に、超過したプリエンプティブルインスタンスを停止するかどうかを指定します。	有効な値： no-termination（デフォルト）：超過したプリエンプティブルインスタンスを停止しません。 termination：超過したプリエンプティブルインスタンスを停止します。停止されたインスタンスに対して実行されるアクションは、SpotInstanceInterruptionBehavior によって指定されます。
TerminateInstances	Boolean	いいえ	いいえ	自動プロビジョニンググループが削除されたときに、自動プロビジョニンググループ内のインスタンスを解放するかどうかを指定します。	有効な値： true false（デフォルト）
TerminateInstancesWithExpiration	Boolean	いいえ	はい	自動プロビジョニンググループの有効期限が切れたときに、プリエンプティブルインスタンスを停止するかどうかを指定します。	有効な値： true：プリエンプティブルインスタンスを停止します。停止されたインスタンスに対して実行されるアクションは、SpotInstanceInterruptionBehavior によって指定されます。 false（デフォルト）：プリエンプティブルインスタンスを停止しません。
CheckExecutionStatus	Boolean	いいえ	いいえ	実行ステータスを確認するかどうかを指定します。	有効な値： true false
LaunchConfiguration	Map	いいえ	いいえ	起動構成に関する情報。	LaunchTemplateId と LaunchConfiguration の両方が指定されている場合、LaunchTemplateId が優先されます。詳細については、このトピックの「LaunchConfiguration プロパティ」セクションをご参照ください。
LaunchTemplateConfig	List	いいえ	いいえ	起動テンプレートの拡張構成。	最大 20 個の拡張構成を指定できます。詳細については、LaunchTemplateConfig プロパティを参照してください。
MinTargetCapacity	String	いいえ	いいえ	自動プロビジョニンググループの最小ターゲット容量。	値は正の整数でなければなりません。このプロパティを指定する場合は、次の点に注意してください。このプロパティは、`AutoProvisioningGroupType` が instant に設定されている場合にのみ有効になります。現在のリージョンで作成できるインスタンスの数がプロパティ値よりも少ない場合、ALIYUN::ECS::AutoProvisioningGroup は使用できず、インスタンスは作成されません。現在のリージョンで作成できるインスタンスの数がプロパティ値よりも多い場合、指定されたプロパティに基づいてインスタンスを作成できます。
ResourcePoolOptions	Map	いいえ	いいえ	インスタンスの作成に使用するリソースプールオプション。	詳細については、このトピックの「ResourcePoolOptions プロパティ」セクションをご参照ください。
DataDiskConfig	List	いいえ	いいえ	インスタンスのデータディスクに関する情報。	詳細については、このトピックの「DataDiskConfig プロパティ」セクションをご参照ください。
ResourceGroupId	String	いいえ	はい	自動プロビジョニンググループが属するリソースグループの ID。	なし。
SystemDiskConfig	List	いいえ	いいえ	インスタンスのシステムディスクに関する情報です。	詳細については、このトピックの「SystemDiskConfig プロパティ」セクションをご参照ください。

LaunchTemplateConfig 構文

"LaunchTemplateConfig": [
  {
    "Priority": Integer, // 優先度
    "WeightedCapacity": Integer, // 加重キャパシティ
    "VSwitchId": String, // 仮想スイッチ ID
    "InstanceType": String, // インスタンスタイプ
    "MaxPrice": Integer, // 最大価格
    "Cores": List, // コア数
    "Memories": List, // メモリ容量
    "Architectures": List, // アーキテクチャ
    "ExcludedInstanceTypes": List, // 除外されるインスタンスタイプ
    "ImageId": String, // イメージ ID
    "BurstablePerformance": String, // バーストパフォーマンス
    "InstanceFamilyLevel": String // インスタンスファミリレベル
  }
]

LaunchConfiguration プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Priority	Integer	いいえ	いいえ	拡張構成におけるインスタンスタイプの優先順位。	値は 0 以上の整数である必要があります。値 0 は、最高の優先順位を指定します。
WeightedCapacity	Integer	いいえ	いいえ	拡張構成におけるインスタンスタイプの重み。	値は 0 より大きい整数である必要があります。値が大きいほど、単一インスタンスによって提供される計算能力が高く、必要なインスタンス数が少ないことを示します。重みは、指定されたインスタンスタイプの計算能力と、自動プロビジョニンググループによって作成されるクラスター内の単一インスタンスの最小計算能力に基づいて計算されます。たとえば、単一インスタンスの最小計算能力が 8 vCPU と 60 GiB のメモリの場合、8 vCPU と 60 GiB のメモリを持つインスタンスタイプの重みを 1 に、16 vCPU と 120 GiB のメモリを持つインスタンスタイプの重みを 2 に設定できます。
VSwitchId	String	はい	いいえ	拡張構成におけるvSwitch の ID。	起動テンプレートを使用して作成された Elastic Compute Service (ECS) インスタンスは vSwitch に接続され、インスタンスのゾーンは vSwitch によって決定されます。
InstanceType	String	いいえ	いいえ	拡張構成におけるインスタンスタイプ。	なし。
Cores	List	いいえ	いいえ	拡張構成におけるインスタンスタイプの vCPU 数。	なし。
Memories	List	いいえ	いいえ	インスタンスタイプのメモリサイズ。	単位：GiB。このプロパティを使用して、要件を満たすインスタンスタイプをフィルタリングできます。詳細については、「インスタンスファミリーの概要」をご参照ください。1 から 10 個のメモリサイズ (N で示されます) を指定できます。
Architectures	List	いいえ	いいえ	インスタンスタイプのアーキテクチャ。	有効な値： X86：x86。 Heterogeneous：ヘテロジニアスコンピューティング (GPU アクセラレーション、FPGA アクセラレーションなど)。 BareMetal：ECS ベアメタルインスタンス。 Arm：Arm。 SuperComputeCluster：スーパーコンピューティングクラスター (SCC)。デフォルトでは、すべての値が含まれます。
ExcludedInstanceTypes	List	いいえ	いいえ	除外するインスタンスタイプ。	ワイルドカード () を使用して、インスタンスタイプまたはインスタンスファミリーを除外できます。例： ecs.c6.large：ecs.c6.large インスタンスタイプを除外します。 ecs.c6.：c6 インスタンスファミリーを除外します。
ImageId	String	いいえ	いいえ	イメージの ID。	なし。
BurstablePerformance	String	いいえ	いいえ	バースト可能インスタンスタイプを含めるかどうかを指定します。	有効な値： Exclude：バースト可能インスタンスタイプを除外します。 Include：バースト可能インスタンスタイプを含めます。 Required：バースト可能インスタンスタイプのみを含めます。デフォルト値：Include。
InstanceFamilyLevel	String	いいえ	いいえ	インスタンスファミリーのレベル。	このプロパティを使用して、要件を満たすインスタンスタイプをフィルタリングできます。有効な値： EntryLevel：エントリーレベル (共有インスタンスタイプ)。このレベルのインスタンスタイプは最も費用対効果が高いですが、安定した計算パフォーマンスを保証するとは限りません。このレベルのインスタンスタイプは、CPU 使用率が低いシナリオに適しています。詳細については、「共有インスタンスファミリー」をご参照ください。 EnterpriseLevel：エンタープライズレベル。このレベルのインスタンスタイプは、安定したパフォーマンスと専用のリソースを提供し、高い安定性を必要とするビジネスシナリオに適しています。詳細については、「インスタンスファミリーの概要」をご参照ください。 CreditEntryLevel：クレジットベースのエントリーレベル (バースト可能インスタンスタイプ)。CPU クレジットは、計算パフォーマンスを確保するために使用されます。このレベルのインスタンスタイプは、CPU 使用率が低いものの、特定のケースで変動する可能性のあるシナリオに適しています。詳細については、「概要」をご参照ください。
MaxPrice	Integer	いいえ	いいえ	拡張構成におけるプリエンプティブルインスタンスの最大価格。	なし。

LaunchConfiguration 構文

"LaunchConfiguration": {
  "InstanceDescription": String, // インスタンスの説明
  "SystemDiskName": String, // システムディスク名
  "RamRoleName": String, // RAMロール名
  "SystemDiskCategory": String, // システムディスクカテゴリ
  "SecurityGroupId": String, // セキュリティグループID
  "CreditSpecification": String, // クレジット仕様
  "HostName": String, // ホスト名
  "SystemDiskDescription": String, // システムディスクの説明
  "SystemDiskPerformanceLevel": String, // システムディスクのパフォーマンスレベル
  "DataDisk": List, // データディスク
  "ImageFamily": String, // イメージファミリ
  "HostNames": List, // ホスト名
  "InternetMaxBandwidthOut": Integer, // インターネット最大帯域幅 (出力)
  "SystemDiskBurstingEnabled": Boolean, // システムディスクバースト有効化
  "IoOptimized": String, // IO最適化
  "Tag": List, // タグ
  "ImageId": String, // イメージID
  "ResourceGroupId": String, // リソースグループID
  "SystemDiskKMSKeyId": String, // システムディスク KMSキーID
  "KeyPairName": String, // キーペア名
  "PasswordInherit": Boolean, // パスワード継承
  "UserData": String, // ユーザーデータ
  "AutoReleaseTime": String, // 自動リリース時間
  "InstanceName": String, // インスタンス名
  "SystemDiskSize": Integer, // システムディスクサイズ
  "SecurityGroupIds": List, // セキュリティグループID
  "DeploymentSetId": String, // デプロイメントセットID
  "InternetChargeType": String, // インターネット課金タイプ
  "SecurityEnhancementStrategy": String // セキュリティ強化戦略
}

LaunchConfiguration プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
InstanceDescription	String	いいえ	いいえ	インスタンスの説明。	説明は 2 ～ 256 文字で、`http://` または `https://` で始めることはできません。
SystemDiskName	String	いいえ	いいえ	システムディスクの名前。	名前は 2 ～ 128 文字でなければなりません。文字で始まり、`http://` または `https://` で始めることはできません。使用できる文字は、英字、数字、ピリオド(.)、コロン(:)、アンダースコア(_)、ハイフン(-) です。
RamRoleName	String	いいえ	いいえ	インスタンス RAM（Resource Access Management）ロールの名前。	なし。
SystemDiskCategory	String	いいえ	いいえ	システムディスクのカテゴリ。	有効な値： cloud_efficiency: Ultra ディスク。 cloud_ssd: 標準 SSD。 cloud_essd: 企業向け SSD（ESSD）。 cloud: 基本ディスク。廃止されたインスタンスタイプの I/O 最適化されていないインスタンスの場合、デフォルト値は cloud です。他のタイプのインスタンスの場合、デフォルト値は cloud_efficiency です。
HostNames	List	いいえ	いいえ	ホスト名。	なし。
SecurityGroupId	String	はい	いいえ	インスタンスが属するセキュリティグループの ID。	なし。
CreditSpecification	String	いいえ	いいえ	バースト可能インスタンスのパフォーマンスモード。	有効な値： Standard Unlimited
HostName	String	いいえ	いいえ	インスタンスのホスト名。	ホスト名は、ピリオド（.）またはハイフン（-）で開始または終了することはできません。連続したピリオド（.）またはハイフン（-）を含めることはできません。ホスト名は、次の要件を満たしている必要があります。 Windows を実行するインスタンスの場合、ホスト名は 2 ～ 15 文字で、英字、数字、およびハイフン（-）を含めることができます。ピリオド（.）を含めることはできず、数字のみを含めることもできません。 Linux などの異なるオペレーティングシステムを実行するインスタンスの場合、ホスト名は 2 ～ 64 文字でなければなりません。ピリオド（.）を使用して、ホスト名を複数のセグメントに分割できます。各セグメントには、英字、数字、およびハイフン（-）を含めることができます。
SystemDiskBurstingEnabled	Boolean	いいえ	いいえ	システムディスクのパフォーマンスバースト機能を有効にするかどうかを指定します。	有効な値： true false
SystemDiskDescription	String	いいえ	いいえ	システムディスクの説明。	説明は 2 ～ 256 文字でなければならず、`http://` または `https://` で始めることはできません。
ImageFamily	String	いいえ	いいえ	イメージファミリの名前。	名前は 2 ～ 128 文字の長さでなければなりません。文字で始まり、`aliyun` または `acs:` で始めることはできません。`http://` または `https://` を含めることはできません。文字、数字、コロン（:）、アンダースコア（_）、およびハイフン（-）を含めることができます。
SecurityGroupIds	List	いいえ	いいえ	ECS インスタンスが属する 1 つ以上のセキュリティグループの ID。	なし。
AutoReleaseTime	String	いいえ	いいえ	システムが ECS インスタンスを自動的にリリースする時点。	ISO 8601 標準の `yyyy-MM-ddTHH:mm:ssZ` 形式で時間を指定します。指定する時点は、ECS インスタンスが作成されてから 3 年以内である必要があります。
SystemDiskPerformanceLevel	String	いいえ	いいえ	システムディスクとして使用する ESSD のパフォーマンスレベル（PL）。	有効な値： PL0（デフォルト）: ESSD は最大 10,000 ランダム読み取り/書き込み IOPS を提供できます。 PL1: ESSD は最大 50,000 ランダム読み取り/書き込み IOPS を提供できます。 PL2: ESSD は最大 100,000 ランダム読み取り/書き込み IOPS を提供できます。 PL3: ESSD は最大 1,000,000 ランダム読み取り/書き込み IOPS を提供できます。
DataDisk	List	いいえ	いいえ	データディスク。	最大 16 個のデータディスクをアタッチできます。詳細については、「DataDisk プロパティ」をご参照ください。
InternetMaxBandwidthOut	Integer	いいえ	いいえ	最大パブリックアウトバウンド帯域幅。	有効な値: 0 ～ 100。デフォルト値: 0。単位: Mbit/s。
IoOptimized	String	いいえ	いいえ	インスタンスが I/O 最適化されているかどうかを指定します。	有効な値： none: インスタンスは I/O 最適化されていません。 optimized: インスタンスは I/O 最適化されています。
SystemDiskKMSKeyId	String	いいえ	いいえ	システムディスクに使用する Key Management Service（KMS）キーの ID。	なし。
Tag	List	いいえ	いいえ	インスタンスのタグ。	最大 20 個のタグを追加できます。詳細については、「Tag プロパティ」をご参照ください。
ImageId	String	はい	いいえ	イメージの ID。	なし。
ResourceGroupId	String	いいえ	いいえ	インスタンスが属するリソースグループの ID。	なし。
KeyPairName	String	いいえ	いいえ	キーペアの名前。	Windows インスタンス: このプロパティを指定する必要はありません。このプロパティはデフォルトで空です。 Linux インスタンス: このプロパティを指定すると、初期化中に Linux インスタンスのパスワードベースのログインが無効になります。
PasswordInherit	Boolean	いいえ	いいえ	イメージの事前設定されたパスワードを使用するかどうかを指定します。	有効な値： true false
UserData	String	いいえ	いいえ	インスタンスのユーザーデータ。	ユーザーデータは Base64 でエンコードする必要があります。生データのサイズは最大 16 KB です。
InstanceName	String	いいえ	いいえ	インスタンスの名前。	このプロパティのデフォルト値は InstanceId の値です。名前は 2 ～ 128 文字の長さでなければなりません。文字で始まり、`http://` または `https://` で始めることはできません。文字、数字、コロン（:）、アンダースコア（_）、ピリオド（.）、およびハイフン（-）を含めることができます。
SystemDiskSize	Integer	いいえ	いいえ	システムディスクのサイズ。	有効な値: 20 ～ 500。システムディスクのサイズは、イメージのサイズ以上である必要があります。デフォルト値: 40 またはイメージサイズ。単位: GiB。
InternetChargeType	String	いいえ	いいえ	ネットワーク使用量の課金方法。	有効な値： PayByBandwidth: 帯域幅課金。 PayByTraffic: トラフィック課金。説明トラフィック課金方法を使用する場合、最大送受信帯域幅は、保証されたパフォーマンス仕様ではなく、帯域幅の上限として使用されます。需要がリソース供給を超えると、最大帯域幅が制限される場合があります。ビジネスに保証された帯域幅が必要な場合は、帯域幅課金方法を使用してください。
SystemDiskProvisionedIops	Integer	いいえ	いいえ	システムディスクのプロビジョニング IOPS。	なし。
SystemDiskEncrypted	Boolean	いいえ	いいえ	システムディスクを暗号化するかどうかを指定します。	有効な値： true false
DeploymentSetId	String	いいえ	いいえ	デプロイメントセットの ID。	なし。
SecurityEnhancementStrategy	String	いいえ	いいえ	セキュリティ強化を有効にするかどうかを指定します。	有効な値: アクティブ: セキュリティ強化を有効にします。この値は、パブリックイメージに対してのみ有効です。非アクティブ: セキュリティ強化を無効にします。この値は、すべての種類のイメージに対して有効です。

DataDisk 構文

"DataDisk": [
  {
    "DiskName": String, // ディスク名
    "Size": Integer, // サイズ
    "Category": String, // カテゴリ
    "Description": String, // 説明
    "DeleteWithInstance": Boolean, // インスタンスと共に削除
    "SnapshotId": String, // スナップショットID
    "Device": String, // デバイス
    "Encrypted": Boolean, // 暗号化
    "KmsKeyId": String, // KMSキーID
    "InternetChargeType": String, // インターネット課金タイプ
    "ProvisionedIops": Integer, // プロビジョンドIOPS
    "BurstingEnabled": Boolean, // バースト有効化
    "PerformanceLevel": String // パフォーマンスレベル
  }
]

LaunchTemplateConfig プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
DiskName	String	いいえ	いいえ	データディスクの名前。	名前は 2 ～ 128 文字である必要があります。文字で始まり、`http://` または `https://` で始めることはできません。文字、数字、ピリオド（.）、コロン（:）、アンダースコア（_）、およびハイフン（-）を含めることができます。
Size	Integer	いいえ	いいえ	データディスクのサイズ。	有効な値: Category が cloud_efficiency に設定されている場合の有効な値: 20 ～ 32768。 Category が cloud_ssd に設定されている場合の有効な値: 20 ～ 32768。 Category が cloud_essd に設定されている場合の有効な値: 20 ～ 32768。 Category が cloud に設定されている場合の有効な値: 5 ～ 2000。単位：GiB。
Device	String	いいえ	いいえ	ECS インスタンスにアタッチするデータディスクのデバイス名。	例: `/dev/xvda から /dev/xvdz`。
Category	String	いいえ	いいえ	データディスクのカテゴリ。	有効な値: cloud_efficiency: Ultra ディスク。 cloud_ssd: 標準 SSD。 cloud_essd: ESSD。 cloud: 基本ディスク。 I/O 最適化インスタンスの場合、デフォルト値は cloud_efficiency です。I/O 最適化インスタンス以外の場合、デフォルト値は cloud です。
ProvisionedIops	Integer	いいえ	いいえ	プロビジョニングされた IOPS。	なし。
BurstingEnabled	Boolean	いいえ	いいえ	バーストモードを有効にするかどうかを指定します。	有効な値: true false (デフォルト)
Description	String	いいえ	いいえ	データディスクの説明。	説明は 2 ～ 256 文字である必要があり、`http://` または `https://` で始めることはできません。
DeleteWithInstance	Boolean	いいえ	いいえ	データディスクがアタッチされているインスタンスがリリースされたときに、データディスクをリリースするかどうかを指定します。	有効な値: true (デフォルト) false
SnapshotId	String	いいえ	いいえ	データディスクの作成に使用するスナップショットの ID。	このプロパティを指定すると、Size 値は無視されます。データディスクの実際のサイズは、SnapshotId で指定されたスナップショットのサイズです。説明 2013 年 7 月 15 日以降に作成されたスナップショットを使用してください。そうしないと、エラーが返され、リクエストは拒否されます。
Encrypted	Boolean	いいえ	いいえ	データディスクを暗号化するかどうかを指定します。	有効な値: true false (デフォルト)
KmsKeyId	String	いいえ	いいえ	データディスクに使用するキーの ID。	なし。
InternetChargeType	String	いいえ	いいえ	ネットワーク使用量の課金方法。	有効な値: PayByBandwidth: 帯域幅課金。 PayByTraffic: トラフィック課金。説明トラフィック課金方式を使用する場合、最大インバウンド帯域幅と最大アウトバウンド帯域幅は、保証されたパフォーマンス仕様ではなく、帯域幅の上限として使用されます。需要がリソース供給を上回ると、最大帯域幅が制限される場合があります。ビジネスで保証された帯域幅が必要な場合は、帯域幅課金方式を使用してください。
PerformanceLevel	String	いいえ	いいえ	データディスクとして使用する ESSD の PL。	有効な値: PL0 (デフォルト): ESSD は最大 10,000 ランダム読み取り/書き込み IOPS を提供できます。 PL1: ESSD は最大 50,000 ランダム読み取り/書き込み IOPS を提供できます。 PL2: ESSD は最大 100,000 ランダム読み取り/書き込み IOPS を提供できます。 PL3: ESSD は最大 1,000,000 ランダム読み取り/書き込み IOPS を提供できます。

タグ構文

"Tag": [
  {
    "Key": String, // キー
    "Value": String // 値
  }
]

タグのプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
キー	文字列	はい	いいえ	タグのキー。	キーは 1 ～ 128 文字で、`http://` または `https://` を含めることはできません。`aliyun` または `acs:` で始めることはできません。
値	文字列	いいえ	いいえ	タグの値。	値は最大 128 文字で、`http://` または `https://` を含めることはできません。`aliyun` または `acs:` で始めることはできません。

トラブルシューティング

"DataDiskConfig": [
  {
    "DiskCategory": String // ディスクカテゴリ
  }
]

DataDiskConfig プロパティ

プロパティ	型	必須	編集可能	説明	制約
DiskCategory	String	はい	いいえ	インスタンスのデータディスクに関する情報です。	なし。

SystemDiskConfig 構文

"SystemDiskConfig": [
  {
    "DiskCategory": String // ディスクカテゴリ
  }
]

戻り値

プロパティ	タイプ	必須	編集可能	説明	制約
DiskCategory	String	はい	いいえ	インスタンスのシステムディスクに関する情報です。	なし。

ResourcePoolOptions 構文

"ResourcePoolOptions":
  {
    "Strategy": String, // 戦略
    "PrivatePoolIds": List // プライベートプール ID のリスト
  }

例

プロパティ

タイプ

必須

編集可能

説明

制約

Strategy

String

いいえ

インスタンスの作成に使用するリソースプールを選択するための戦略。リソースプールには、エラスティシティ保証または容量予約が有効になった後に生成される非公開プールとパブリックプールが含まれます。

有効な値:

PrivatePoolFirst: 非公開プールを最初に使用します。この値を使用し、ResourcePoolOptions.PrivatePoolIds を指定した場合、指定された非公開プールが最初に使用されます。非公開プールを指定しない場合、または指定された非公開プールの容量が不足している場合は、一致するオープンな非公開プールが使用されます。一致するオープンな非公開プールが存在しない場合は、パブリックプールが使用されます。
PrivatePoolOnly: 非公開プールのみを使用します。この値を使用する場合は、ResourcePoolOptions.PrivatePoolIds を指定する必要があります。指定された非公開プールの容量が不足している場合、インスタンスの作成は失敗します。
PublicPoolOnly: パブリックプールを使用します。

デフォルト値: PublicPoolOnly。

PrivatePoolIds

List

いいえ

非公開プールの ID。

非公開プールの ID は、非公開プールに関連付けられているエラスティシティ保証または容量予約の ID と同じです。このプロパティには、ターゲットモードの非公開プールの ID のみ指定できます。最大 20 個の非公開プールを構成できます。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Description: ECS 自動プロビジョニンググループのテスト
Parameters:
  LaunchTemplateId:
    Type: String
    Description: |-
      自動プロビジョニンググループに関連付けられているインスタンス起動テンプレートの ID。
      DescribeLaunchTemplates 操作を呼び出して、使用可能なインスタンス起動テンプレートをクエリできます。
      自動プロビジョニンググループは、1 つのインスタンス起動テンプレートにのみ関連付けることができます。
      ただし、LaunchTemplateConfig パラメーターを使用して、起動テンプレートの複数の拡張構成を設定できます。
  PayAsYouGoTargetCapacity:
    Type: String
    Description: 自動プロビジョニンググループ内の従量課金インスタンスのターゲットキャパシティ。
    Default: '1'
  TotalTargetCapacity:
    Type: String
    Description: |-
      自動プロビジョニンググループの合計ターゲットキャパシティ。ターゲットキャパシティは、次の 3 つの部分で構成されます。
      PayAsYouGoTargetCapacity パラメーターで指定された従量課金インスタンスのターゲットキャパシティ
      SpotTargetCapacity パラメーターで指定されたプリエンプティブルインスタンスのターゲットキャパシティ
      PayAsYouGoTargetCapacity と SpotTargetCapacity 以外の補足キャパシティ
    Default: '2'
  SpotTargetCapacity:
    Type: String
    Description: 自動プロビジョニンググループ内のプリエンプティブルインスタンスのターゲットキャパシティ。
    Default: '1'
  AutoProvisioningGroupName:
    Type: String
    Description: |-
      作成される自動プロビジョニンググループの名前。2 ～ 128 文字の長さでなければなりません。
      文字で始める必要がありますが、http:// または https:// で始めることはできません。
      文字、数字、コロン（:）、アンダースコア（_）、ハイフン（-）を含めることができます。
    Default: mytest
  SpotAllocationStrategy:
    Type: String
    Description: |-
      プリエンプティブルインスタンスのスケールアウトポリシー。有効な値：
      lowest-price: 自動プロビジョニンググループが最も低いコストのインスタンスタイプを選択してインスタンスを作成するために従うコスト最適化ポリシー。
      diversified: 自動プロビジョニンググループが複数の拡張テンプレート構成で指定されたゾーン全体に均等にインスタンスを作成するために従う分散バランシングポリシー。
      デフォルト値: lowest-price
    AllowedValues:
      - diversified
      - lowest-price
    Default: lowest-price
  PayAsYouGoAllocationStrategy:
    Type: String
    Description: |-
      従量課金インスタンスのスケールアウトポリシー。有効な値：
      lowest-price: 自動プロビジョニンググループが最も低いコストのインスタンスタイプを選択してインスタンスを作成するために従うコスト最適化ポリシー。
      prioritized: 自動プロビジョニンググループがインスタンスを作成するために従う優先順位ベースのポリシー。
      インスタンスタイプの優先順位は、LaunchTemplateConfig.N.Priority パラメーターで指定されます。
      デフォルト値: lowest-price
    AllowedValues:
      - lowest-price
      - prioritized
    Default: lowest-price
  MaxSpotPrice:
    Type: Number
    Description: |-
      自動プロビジョニンググループ内のプリエンプティブルインスタンスのグローバル最大価格。
      MaxSpotPrice パラメーターと LaunchTemplateConfig.N.MaxPrice パラメーターの両方が指定されている場合、最大価格は 2 つの値のうち小さい方の値になります。
    Default: 5
  DefaultTargetCapacityType:
    Type: String
    Description: |-
      補足インスタンスのタイプ。PayAsYouGoTargetCapacity と SpotTargetCapacity の合計値が TotalTargetCapacity の値よりも小さい場合、自動プロビジョニンググループは指定されたタイプのインスタンスを作成してキャパシティ要件を満たします。有効な値：
      PayAsYouGo: 従量課金インスタンス。
      Spot: プリエンプティブルインスタンス。
      デフォルト値: Spot
    AllowedValues:
      - PayAsYouGo
      - Spot
    Default: PayAsYouGo
  AutoProvisioningGroupType:
    Type: String
    Description: |-
      自動プロビジョニンググループのタイプ。有効な値：
      request: ワンタイムデリバリー。自動プロビジョニンググループが開始された後、インスタンスクラスターの作成を 1 回だけ試みます。
      クラスターの作成に失敗した場合、グループは再試行しません。
      maintain: 継続的デリバリーと維持キャパシティタイプ。自動プロビジョニンググループが開始された後、インスタンスクラスターの作成と維持を継続的に試みます。
      自動プロビジョニンググループは、クラスターのリアルタイムキャパシティとターゲットキャパシティを比較します。
      クラスターがターゲットキャパシティを満たしていない場合、グループはクラスターがターゲットキャパシティを満たすまでインスタンスを作成します。
      デフォルト値: maintain
    AllowedValues:
      - maintain
      - request
    Default: maintain
  ExcessCapacityTerminationPolicy:
    Type: String
    Description: |-
      自動プロビジョニンググループのキャパシティがターゲットキャパシティを超えた場合に、超過したプリエンプティブルインスタンスに対して実行されるシャットダウンポリシー。有効な値：
      no-termination: 超過したプリエンプティブルインスタンスはシャットダウンされません。
      termination: 超過したプリエンプティブルインスタンスはシャットダウンされます。これらのシャットダウンインスタンスに対して実行される操作は、SpotInstanceInterruptionBehavior パラメーターで指定されます。
      デフォルト値: no-termination
    AllowedValues:
      - no-termination
      - termination
    Default: termination
  TerminateInstances:
    Type: Boolean
    Description: |-
      自動プロビジョニンググループのインスタンスを解放するかどうかを指定します。有効な値：
      true
      false
      デフォルト: false
    AllowedValues:
      - true
      - false
    Default: true
  TerminateInstancesWithExpiration:
    Type: Boolean
    Description: |-
      自動プロビジョニンググループの有効期限が切れたときのプリエンプティブルインスタンスのシャットダウンポリシー。有効な値：
      true: プリエンプティブルインスタンスをシャットダウンします。これらのシャットダウンインスタンスに対して実行される操作は、SpotInstanceInterruptionBehavior パラメーターで指定されます。
      false: プリエンプティブルインスタンスをシャットダウンしません。
      デフォルト: false
    AllowedValues:
      - true
      - false
    Default: true
Resources:
  AutoProvisioningGroup:
    Type: ALIYUN::ECS::AutoProvisioningGroup
    Properties:
      LaunchTemplateId:
        Ref: LaunchTemplateId
      LaunchTemplateVersion: '1'
      TotalTargetCapacity:
        Ref: TotalTargetCapacity
      PayAsYouGoTargetCapacity:
        Ref: PayAsYouGoTargetCapacity
      SpotTargetCapacity:
        Ref: SpotTargetCapacity
      AutoProvisioningGroupName:
        Ref: AutoProvisioningGroupName
      SpotAllocationStrategy:
        Ref: SpotAllocationStrategy
      Description: 自動プロビジョニンググループのテスト
      PayAsYouGoAllocationStrategy:
        Ref: PayAsYouGoAllocationStrategy
      MaxSpotPrice:
        Ref: MaxSpotPrice
      DefaultTargetCapacityType:
        Ref: DefaultTargetCapacityType
      AutoProvisioningGroupType:
        Ref: AutoProvisioningGroupType
      ExcessCapacityTerminationPolicy:
        Ref: ExcessCapacityTerminationPolicy
      TerminateInstances:
        Ref: TerminateInstances
      TerminateInstancesWithExpiration:
        Ref: TerminateInstancesWithExpiration
Outputs:
  AutoProvisioningGroupId:
    Description: 自動プロビジョニンググループの ID。
    Value:
      Fn::GetAtt:
        - AutoProvisioningGroup
        - AutoProvisioningGroupId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": "ECS 自動プロビジョニンググループのテスト",
  "Parameters": {
    "LaunchTemplateId": {
      "Type": "String",
      "Description": "自動プロビジョニンググループに関連付けられているインスタンス起動テンプレートの ID。\nDescribeLaunchTemplates 操作を呼び出して、使用可能なインスタンス起動テンプレートをクエリできます。\n自動プロビジョニンググループは、1 つのインスタンス起動テンプレートにのみ関連付けることができます。\nただし、LaunchTemplateConfig パラメーターを使用して、起動テンプレートの複数の拡張構成を設定できます。"
    },
    "PayAsYouGoTargetCapacity": {
      "Type": "String",
      "Description": "自動プロビジョニンググループ内の従量課金インスタンスのターゲットキャパシティ。",
      "Default": "1"
    },
    "TotalTargetCapacity": {
      "Type": "String",
      "Description": "自動プロビジョニンググループの合計ターゲットキャパシティ。ターゲットキャパシティは、次の 3 つの部分で構成されます。\nPayAsYouGoTargetCapacity パラメーターで指定された従量課金インスタンスのターゲットキャパシティ\nSpotTargetCapacity パラメーターで指定されたプリエンプティブルインスタンスのターゲットキャパシティ\nPayAsYouGoTargetCapacity と SpotTargetCapacity 以外の補足キャパシティ",
      "Default": "2"
    },
    "SpotTargetCapacity": {
      "Type": "String",
      "Description": "自動プロビジョニンググループ内のプリエンプティブルインスタンスのターゲットキャパシティ。",
      "Default": "1"
    },
    "AutoProvisioningGroupName": {
      "Type": "String",
      "Description": "作成される自動プロビジョニンググループの名前。 2 ～ 128 文字の長さでなければなりません。\n文字で始める必要がありますが、http:// または https:// で始めることはできません。\n文字、数字、コロン（:）、アンダースコア（_）、ハイフン（-）を含めることができます。",
      "Default": "mytest"
    },
    "SpotAllocationStrategy": {
      "Type": "String",
      "Description": "プリエンプティブルインスタンスのスケールアウトポリシー。有効な値：\nlowest-price: 自動プロビジョニンググループが最も低いコストのインスタンスタイプを選択してインスタンスを作成するために従うコスト最適化ポリシー。\ndiversified: 自動プロビジョニンググループが複数の拡張テンプレート構成で指定されたゾーン全体に均等にインスタンスを作成するために従う分散バランシングポリシー。\nデフォルト値: lowest-price",
      "AllowedValues": [
        "diversified",
        "lowest-price"
      ],
      "Default": "lowest-price"
    },
    "PayAsYouGoAllocationStrategy": {
      "Type": "String",
      "Description": "従量課金インスタンスのスケールアウトポリシー。有効な値：\nlowest-price: 自動プロビジョニンググループが最も低いコストのインスタンスタイプを選択してインスタンスを作成するために従うコスト最適化ポリシー。\nprioritized: 自動プロビジョニンググループがインスタンスを作成するために従う優先順位ベースのポリシー。\nインスタンスタイプの優先順位は、LaunchTemplateConfig.N.Priority パラメーターで指定されます。\nデフォルト値: lowest-price",
      "AllowedValues": [
        "lowest-price",
        "prioritized"
      ],
      "Default": "lowest-price"
    },
    "MaxSpotPrice": {
      "Type": "Number",
      "Description": "自動プロビジョニンググループ内のプリエンプティブルインスタンスのグローバル最大価格。\nMaxSpotPrice パラメーターと LaunchTemplateConfig.N.MaxPrice パラメーターの両方が指定されている場合、最大価格は 2 つの値のうち小さい方の値になります。",
      "Default": 5
    },
    "DefaultTargetCapacityType": {
      "Type": "String",
      "Description": "補足インスタンスのタイプ。 PayAsYouGoTargetCapacity と SpotTargetCapacity の合計値が TotalTargetCapacity の値よりも小さい場合、自動プロビジョニンググループは指定されたタイプのインスタンスを作成してキャパシティ要件を満たします。有効な値：\nPayAsYouGo: 従量課金インスタンス。\nSpot: プリエンプティブルインスタンス。\nデフォルト値: Spot",
      "AllowedValues": [
        "PayAsYouGo",
        "Spot"
      ],
      "Default": "PayAsYouGo"
    },
    "AutoProvisioningGroupType": {
      "Type": "String",
      "Description": "自動プロビジョニンググループのタイプ。有効な値：\nrequest: ワンタイムデリバリー。自動プロビジョニンググループが開始された後、インスタンスクラスターの作成を 1 回だけ試みます。クラスターの作成に失敗した場合、グループは再試行しません。\nmaintain: 継続的デリバリーと維持キャパシティタイプ。自動プロビジョニンググループが開始された後、インスタンスクラスターの作成と維持を継続的に試みます。\n自動プロビジョニンググループは、クラスターのリアルタイムキャパシティとターゲットキャパシティを比較します。\nクラスターがターゲットキャパシティを満たしていない場合、グループはクラスターがターゲットキャパシティを満たすまでインスタンスを作成します。\nデフォルト値: maintain",
      "AllowedValues": [
        "maintain",
        "request"
      ],
      "Default": "maintain"
    },
    "ExcessCapacityTerminationPolicy": {
      "Type": "String",
      "Description": "自動プロビジョニンググループのキャパシティがターゲットキャパシティを超えた場合に、超過したプリエンプティブルインスタンスに対して実行されるシャットダウンポリシー。有効な値：\nno-termination: 超過したプリエンプティブルインスタンスはシャットダウンされません。\ntermination: 超過したプリエンプティブルインスタンスはシャットダウンされます。これらのシャットダウンインスタンスに対して実行される操作は、SpotInstanceInterruptionBehavior パラメーターで指定されます。\nデフォルト値: no-termination",
      "AllowedValues": [
        "no-termination",
        "termination"
      ],
      "Default": "termination"
    },
    "TerminateInstances": {
      "Type": "Boolean",
      "Description": "自動プロビジョニンググループのインスタンスを解放するかどうかを指定します。有効な値：\ntrue\nfalse\nデフォルト: false",
      "AllowedValues": [
        true,
        false
      ],
      "Default": true
    },
    "TerminateInstancesWithExpiration": {
      "Type": "Boolean",
      "Description": "自動プロビジョニンググループの有効期限が切れたときのプリエンプティブルインスタンスのシャットダウンポリシー。有効な値：\ntrue: プリエンプティブルインスタンスをシャットダウンします。これらのシャットダウンインスタンスに対して実行される操作は、SpotInstanceInterruptionBehavior パラメーターで指定されます。\nfalse: プリエンプティブルインスタンスをシャットダウンしません。\nデフォルト: false",
      "AllowedValues": [
        true,
        false
      ],
      "Default": true
    }
  },
  "Resources": {
    "AutoProvisioningGroup": {
      "Type": "ALIYUN::ECS::AutoProvisioningGroup",
      "Properties": {
        "LaunchTemplateId": {
          "Ref": "LaunchTemplateId"
        },
        "LaunchTemplateVersion": "1",
        "TotalTargetCapacity": {
          "Ref": "TotalTargetCapacity"
        },
        "PayAsYouGoTargetCapacity": {
          "Ref": "PayAsYouGoTargetCapacity"
        },
        "SpotTargetCapacity": {
          "Ref": "SpotTargetCapacity"
        },
        "AutoProvisioningGroupName": {
          "Ref": "AutoProvisioningGroupName"
        },
        "SpotAllocationStrategy": {
          "Ref": "SpotAllocationStrategy"
        },
        "Description": "自動プロビジョニンググループのテスト",
        "PayAsYouGoAllocationStrategy": {
          "Ref": "PayAsYouGoAllocationStrategy"
        },
        "MaxSpotPrice": {
          "Ref": "MaxSpotPrice"
        },
        "DefaultTargetCapacityType": {
          "Ref": "DefaultTargetCapacityType"
        },
        "AutoProvisioningGroupType": {
          "Ref": "AutoProvisioningGroupType"
        },
        "ExcessCapacityTerminationPolicy": {
          "Ref": "ExcessCapacityTerminationPolicy"
        },
        "TerminateInstances": {
          "Ref": "TerminateInstances"
        },
        "TerminateInstancesWithExpiration": {
          "Ref": "TerminateInstancesWithExpiration"
        }
      }
    }
  },
  "Outputs": {
    "AutoProvisioningGroupId": {
      "Description": "自動プロビジョニンググループの ID。",
      "Value": {
        "Fn::GetAtt": [
          "AutoProvisioningGroup",
          "AutoProvisioningGroupId"
        ]
      }
    }
  }
}

Resource Orchestration Service:ALIYUN::ECS::AutoProvisioningGroup

構文

プロパティ

LaunchTemplateConfig 構文

LaunchConfiguration プロパティ

LaunchConfiguration 構文

LaunchConfiguration プロパティ

DataDisk 構文

LaunchTemplateConfig プロパティ

タグ構文

タグのプロパティ

トラブルシューティング

DataDiskConfig プロパティ

SystemDiskConfig 構文

戻り値

ResourcePoolOptions 構文

例

関連情報

例