すべてのプロダクト
Search
ドキュメントセンター

Resource Orchestration Service:ALIYUN::ECS::LaunchTemplate

最終更新日:Jan 16, 2025

ALIYUN::ECS::LaunchTemplate は、起動テンプレートを作成するために使用されます。起動テンプレートを使用して、Elastic Compute Service ( ECS ) インスタンスを作成できます。

構文

{
  "Type": "ALIYUN::ECS::LaunchTemplate",
  "Properties": {
    "LaunchTemplateName": String,
    "VersionDescription": String,
    "ImageId": String,
    "InstanceType": String,
    "SecurityGroupId": String,
    "NetworkType": String,
    "VSwitchId": String,
    "InstanceName": String,
    "Description": String,
    "InternetMaxBandwidthOut": Integer,
    "HostName": String,
    "ZoneId": String,
    "SystemDiskCategory": String,
    "SystemDiskSize": Number,
    "SystemDiskDiskName": String,
    "SystemDiskDescription": String,
    "IoOptimized": String,
    "InternetChargeType": String,
    "UserData": String,
    "KeyPairName": String,
    "RamRoleName": String,
    "AutoReleaseTime": String,
    "SpotStrategy": String,
    "SpotPriceLimit": String,
    "SecurityEnhancementStrategy": String,
    "DiskMappings": List,
    "NetworkInterfaces": List,
    "Tags": List,
    "TemplateTags": List,
    "TemplateResourceGroupId": String,
    "SecurityGroupIds": List,
    "ResourceGroupId": String,
    "SpotDuration": Integer,
    "ImageOwnerAlias": String,
    "Period": Integer,
    "Ipv6AddressCount": Integer,
    "PrivateIpAddress": String,
    "PasswordInherit": Boolean,
    "SystemDiskDeleteWithInstance": Boolean,
    "DeploymentSetId": String,
    "InstanceChargeType": String,
    "SystemDiskPerformanceLevel": String
  }
}

プロパティ

プロパティタイプ必須編集可能説明制約
LaunchTemplateNameStringはいいいえ起動テンプレートの名前。名前は 2 ~ 128 文字で、文字、数字、コロン (:)、アンダースコア (_)、ハイフン (-) を使用できます。名前は文字で始める必要がありますが、http:// または https:// で始めることはできません。
VersionDescriptionStringいいえいいえ起動テンプレートバージョンの説明。説明は 2 ~ 128 文字である必要があります。説明は文字で始める必要がありますが、http:// または https:// で始めることはできません。
ImageIdStringいいえいいえイメージの ID 。なし。
InstanceTypeStringいいえいいえインスタンスタイプ。なし。
SecurityGroupIdStringいいえいいえセキュリティグループの ID 。なし。
NetworkTypeStringいいえいいえインスタンスのネットワークタイプ。有効な値:
  • classic: クラシックネットワーク
  • vpc: virtual private cloud ( VPC )
VSwitchIdStringいいえいいえvSwitch の ID 。このプロパティは、NetworkType プロパティを vpc に設定した場合に有効になります。
InstanceNameStringいいえいいえインスタンスの名前。名前は 2 ~ 128 文字である必要があります。名前は文字で始める必要がありますが、http:// または https:// で始めることはできません。
DescriptionStringいいえいいえインスタンスの説明。説明は 2 ~ 128 文字である必要があります。説明は文字で始める必要がありますが、http:// または https:// で始めることはできません。
InternetMaxBandwidthOutIntegerいいえいいえ最大アウトバウンドパブリック帯域幅。有効な値:0 ~ 100。

単位:Mbit/s。

HostNameStringいいえいいえインスタンスのホスト名。

ホスト名は、ピリオド (.) またはハイフン (-) で開始または終了したり、連続したピリオド (.) またはハイフン (-) を含めることはできません。

ホスト名は、次の要件を満たしている必要があります。
  • Windows インスタンス:ホスト名は 2 ~ 15 文字で、文字、数字、ハイフン (-) を使用できます。ホスト名は数字のみを含めることはできません。
  • Linux インスタンスなどのその他のインスタンス:ホスト名は 2 ~ 64 文字で、文字、数字、ハイフン (-) を使用できます。
ZoneIdStringいいえいいえインスタンスが属するゾーンの ID 。なし。
SystemDiskCategoryStringいいえいいえシステムディスクのカテゴリ。有効な値:
  • cloud: ベーシックディスク
  • cloud_efficiency: ウルトラディスク
  • cloud_ssd: 標準 SSD
  • ephemeral_ssd: ローカル SSD
SystemDiskSizeNumberいいえいいえシステムディスクのサイズ。有効な値:20 ~ 500。

単位:GB。

SystemDiskDiskNameStringいいえいいえシステムディスクの名前。名前は 2 ~ 128 文字で、文字、数字、コロン (:)、アンダースコア (_)、ハイフン (-) を使用できます。名前は文字で始める必要がありますが、http:// または https:// で始めることはできません。
SystemDiskDescriptionStringいいえいいえシステムディスクの説明。説明は 2 ~ 256 文字である必要があります。説明は http:// または https:// で始めることはできません。
IoOptimizedStringいいえいいえインスタンスが I/O 最適化インスタンスかどうかを指定します。有効な値:
  • none: インスタンスは I/O 最適化インスタンスではありません。
  • optimized: インスタンスは I/O 最適化インスタンスです。
InternetChargeTypeStringいいえいいえネットワーク使用量の計測方法。有効な値:
  • PayByBandwidth: 帯域幅課金
  • PayByTraffic: データ転送課金
UserDataStringいいえいいえインスタンスのユーザーデータ。ユーザーデータは Base64 でエンコードする必要があります。未加工データの最大サイズは 16 KB です。
KeyPairNameStringいいえいいえキーペアの名前。このプロパティは、Linux インスタンスの場合にのみ必須です。デフォルトでは、Linux インスタンスではパスワードベースのログオンは無効になっています。
RamRoleNameStringいいえいいえインスタンスの RAM ロールの名前。なし。
AutoReleaseTimeStringいいえいいえシステムがインスタンスを自動的に解放する時刻。ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式で時刻を指定します。時刻は UTC である必要があります。
SpotStrategyStringいいえいいえ従量課金インスタンスのプリエンプションポリシー。

このプロパティは、InstanceChargeType プロパティを PostPaid に設定した場合に有効になります。

有効な値:

  • NoSpot: インスタンスは従量課金インスタンスとして作成されます。
  • SpotWithPriceLimit: インスタンスは、1 時間あたりの最大価格を指定するプリエンプティブインスタンスとして作成されます。
  • SpotAsPriceGo: インスタンスは、購入時の市場価格に基づいて価格が設定されるプリエンプティブインスタンスとして作成されます。市場価格は、従量課金インスタンスの価格と同じになる場合があります。
SpotPriceLimitStringいいえいいえインスタンスの 1 時間あたりの最大価格。このプロパティの値には、小数点以下 3 桁まで含めることができます。
SecurityEnhancementStrategyStringいいえいいえセキュリティ強化を有効にするかどうかを指定します。有効な値:
  • Active: セキュリティ強化を有効にします。
  • Deactive: セキュリティ強化を無効にします。
DiskMappingsListいいえいいえデータディスク。最大 16 個のデータディスクを接続できます。

詳細については、「DiskMappings プロパティ」をご参照ください。

NetworkInterfacesListいいえいいえElastic Network Interface ( ENI )。最大 8 つの ENI を接続できます。

詳細については、「NetworkInterfaces プロパティ」をご参照ください。

TagsListいいえいいえインスタンス、セキュリティグループ、ディスク、ENI のタグ。インスタンス、セキュリティグループ、ディスク、または ENI に最大 20 個のタグを指定できます。

詳細については、「Tags プロパティ」をご参照ください。

TemplateTagsListいいえいいえ起動テンプレートのタグ。最大 20 個のタグを追加できます。

詳細については、「TemplateTags プロパティ」をご参照ください。

TemplateResourceGroupIdStringいいえいいえ起動テンプレートが属するリソースグループの ID 。なし。
SecurityGroupIdsListいいえいいえインスタンスを追加する 1 つ以上のセキュリティグループの ID 。このプロパティの値は、インスタンスを追加できるセキュリティグループの最大数によって異なります。
説明 SecurityGroupId プロパティと SecurityGroupIds プロパティの両方を指定することはできません。
ResourceGroupIdStringいいえいいえインスタンス、Elastic Block Storage ( EBS ) デバイス、ENI が属するリソースグループの ID 。なし。
SpotDurationIntegerいいえいいえプリエンプティブインスタンスの保持期間。有効な値:0 ~ 6。

デフォルト値:1。

単位:時間。

説明 値を 2 ~ 6 に設定するには、チケットを送信する必要があります。
ImageOwnerAliasStringいいえいいえイメージのソース。有効な値:
  • system: Alibaba Cloud が提供するパブリックイメージ
  • self: 作成したカスタムイメージ
  • others: 別の Alibaba Cloud アカウントからの共有イメージ
  • marketplace: Alibaba Cloud Marketplace イメージ
PeriodIntegerいいえいいえ起動テンプレートのサブスクリプション期間。このプロパティは、InstanceChargeType プロパティを PrePaid に設定した場合に有効になり、必須です。

有効な値:1、2、3、4、5、6、7、8、9、12、24、36、48、60。

単位:月。

Ipv6AddressCountIntegerいいえいいえシステムがプライマリ ENI に対してランダムに生成する IPv6 アドレスの数。有効な値:1 ~ 10。
PrivateIpAddressStringいいえいいえインスタンスのプライベート IP アドレス。VPC タイプの ECS インスタンスにプライベート IP アドレスを設定する場合は、vSwitch の CIDR ブロックからアイドル状態の IP アドレスを選択する必要があります。
PasswordInheritBooleanいいえいいえイメージのプリセットパスワードを使用するかどうかを指定します。有効な値:
  • true
  • false
説明 PasswordInherit プロパティと Password プロパティのいずれか 1 つのみを指定する必要があります。
SystemDiskDeleteWithInstanceBooleanいいえいいえインスタンスの解放時にシステムディスクを解放するかどうかを指定します。デフォルト値:true。有効な値:
  • true
  • false
DeploymentSetIdStringいいえいいえデプロイメントセットの ID 。なし。
InstanceChargeTypeStringいいえいいえインスタンスの課金方法。有効な値:
  • PrePaid: サブスクリプション
  • PostPaid: 従量課金
SystemDiskPerformanceLevelStringいいえいいえシステムディスクとして使用される Enhanced SSD ( ESSD ) のパフォーマンスレベル ( PL )。デフォルト値:PL0。有効な値:
  • PL0: ESSD は最大 10,000 ランダム読み取り/書き込み IOPS を提供できます。
  • PL1: ESSD は最大 50,000 ランダム読み取り/書き込み IOPS を提供できます。
  • PL2: ESSD は最大 100,000 ランダム読み取り/書き込み IOPS を提供できます。
  • PL3: ESSD は最大 1,000,000 ランダム読み取り/書き込み IOPS を提供できます。

DiskMappings 構文

"DiskMappings": [
  {
    "Category": String,
    "DiskName": String,
    "Description": String,
    "SnapshotId": String,
    "Size": String,
    "Encrypted": String,
    "DeleteWithInstance": String,
    "PerformanceLevel": String
  }
]

DiskMappings プロパティ

プロパティタイプ必須編集可能説明制約
CategoryStringいいえいいえデータディスクのカテゴリ。有効な値:
  • cloud: ベーシックディスク
  • cloud_efficiency: ウルトラディスク
  • cloud_ssd: 標準 SSD
  • ephemeral_ssd: ローカル SSD
DiskNameStringいいえいいえデータディスクの名前。名前は 2 ~ 128 文字で、文字、数字、コロン (:)、アンダースコア (_)、ハイフン (-) を使用できます。名前は文字で始める必要がありますが、http:// または https:// で始めることはできません。
DescriptionStringいいえいいえデータディスクの説明。説明は 2 ~ 256 文字である必要があります。名前は http:// または https:// で始めることはできません。
SnapshotIdStringいいえいいえデータディスクの作成に使用するスナップショットの ID 。なし。
SizeStringいいえいいえシステムディスクのサイズ。

有効な値:

  • Category プロパティを cloud に設定した場合の有効な値:5 ~ 2000。
  • Category プロパティを cloud_efficiency に設定した場合の有効な値:20 ~ 32768。
  • Category プロパティを cloud_ssd に設定した場合の有効な値:20 ~ 32768。
  • Category プロパティを ephemeral_ssd に設定した場合の有効な値:5 ~ 800。

単位:GB。

EncryptedBooleanいいえいいえデータディスクを暗号化するかどうかを指定します。有効な値:
  • true
  • false
DeleteWithInstanceBooleanいいえいいえインスタンスの解放時にデータディスクを解放するかどうかを指定します。有効な値:
  • true
  • false
PerformanceLevelStringいいえいいえデータディスクとして使用される ESSD の PL 。デフォルト値:PL0。有効な値:
  • PL0: ESSD は最大 10,000 ランダム読み取り/書き込み IOPS を提供できます。
  • PL1: ESSD は最大 50,000 ランダム読み取り/書き込み IOPS を提供できます。
  • PL2: ESSD は最大 100,000 ランダム読み取り/書き込み IOPS を提供できます。
  • PL3: ESSD は最大 1,000,000 ランダム読み取り/書き込み IOPS を提供できます。

NetworkInterfaces 構文

"NetworkInterfaces": [
  {
    "PrimaryIpAddress": String,
    "VSwitchId": String,
    "SecurityGroupId": String,
    "NetworkInterfaceName": String,
    "Description": String
  }
]

NetworkInterfaces プロパティ

プロパティタイプ必須編集可能説明制約
PrimaryIpAddressStringいいえいいえENI のプライマリプライベート IP アドレス。なし。
VSwitchIdStringいいえいいえENI が属する vSwitch の ID 。なし。
SecurityGroupIdStringいいえいいえENI が属するセキュリティグループの ID 。なし。
NetworkInterfaceNameStringいいえいいえENI の名前。なし。
DescriptionStringいいえいいえENI の説明。説明は 2 ~ 256 文字である必要があります。説明は http:// または https:// で始めることはできません。

Tags 構文

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Tags プロパティ

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

TemplateTags 構文

"TemplateTags": [
  {
    "Value": String,
    "Key": String
  }
]

TemplateTags プロパティ

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

戻り値

Fn::GetAtt

  • LaunchTemplateId: 起動テンプレートの ID 。
  • LaunchTemplateName: 起動テンプレートの名前。
  • DefaultVersionNumber: 起動テンプレートのデフォルトバージョン番号。
  • LatestVersionNumber: 起動テンプレートの最新バージョン番号。

  • YAML 形式

    ROSTemplateFormatVersion: '2015-09-01'
    Description: Test ECS LaunchTemplate  # ECS 起動テンプレートのテスト
    Parameters:
      VSwitchId:
        Type: String
        AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
      SecurityGroupId:
        AssociationProperty: ALIYUN::ECS::SecurityGroup::SecurityGroupId
        Type: String
    Resources:
      LaunchTemplate:
        Type: ALIYUN::ECS::LaunchTemplate
        Properties:
          LaunchTemplateName: mytest
          VersionDescription: Test create LaunchTemplate # 起動テンプレートの作成テスト
          ImageId: centos_7
          InstanceType: ecs.c5.large
          SystemDiskCategory: cloud_essd
          SecurityGroupId:
            Ref: SecurityGroupId
          VSwitchId:
            Ref: VSwitchId
    Outputs: {}
  • JSON 形式

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Description": "Test ECS LaunchTemplate", // ECS 起動テンプレートのテスト
      "Parameters": {
        "VSwitchId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId"
        },
        "SecurityGroupId": {
          "AssociationProperty": "ALIYUN::ECS::SecurityGroup::SecurityGroupId",
          "Type": "String"
        }
      },
      "Resources": {
        "LaunchTemplate": {
          "Type": "ALIYUN::ECS::LaunchTemplate",
          "Properties": {
            "LaunchTemplateName": "mytest",
            "VersionDescription": "Test create LaunchTemplate", // 起動テンプレートの作成テスト
            "ImageId": "centos_7",
            "InstanceType": "ecs.c5.large",
            "SystemDiskCategory": "cloud_essd",
            "SecurityGroupId": {
              "Ref": "SecurityGroupId"
            },
            "VSwitchId": {
              "Ref": "VSwitchId"
            }
          }
        }
      },
      "Outputs": {
      }
    }

その他の例については、LaunchTemplate.jsonLaunchTemplate.yml をご覧ください。例では、ALIYUN::ECS::LaunchTemplate および ALIYUN::ECS::AutoProvisioningGroup リソースタイプが使用されています。