カスタムイメージを作成するために ALIYUN::ECS::CustomImage を使用する - Resource Orchestration Service

ALIYUN::ECS::CustomImage は、カスタムイメージを作成するために使用されます。

構文

{
  "Type": "ALIYUN::ECS::CustomImage",
  "Properties": {
    "Description": String,
    "InstanceId": String,
    "ImageName": String,
    "SnapshotId": String,
    "Tag": List,
    "ResourceGroupId": String,
    "Platform": String,
    "DiskDeviceMapping": List,
    "Architecture": String,
    "ImageFamily": String,
    "Features": Map,
    "SourceRegionId": String,
    "DetectionStrategy": String,
    "ImageVersion": String,
    "BootMode": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Description	String	いいえ	いいえ	カスタムイメージの説明。	説明は 2 ～ 256 文字でなければなりません。`http://` または `https://` で始めることはできません。
InstanceId	String	いいえ	いいえ	インスタンス ID。	このプロパティを指定すると、Elastic Compute Service (ECS) インスタンスを使用してカスタムイメージが作成されます。詳細については、「インスタンスからカスタムイメージを作成する」をご参照ください。
ImageName	String	いいえ	いいえ	カスタムイメージの名前。	名前は 2 ～ 128 文字で、英字、数字、アンダースコア (_)、およびハイフン (-) を使用できます。英字で始まり、`http://` または `https://` で始めることはできません。
SnapshotId	String	いいえ	いいえ	スナップショット ID。	このプロパティを指定すると、スナップショットを使用してカスタムイメージが作成されます。詳細については、「スナップショットからカスタムイメージを作成する」をご参照ください。
Tag	List	いいえ	いいえ	タグ。	詳細については、「タグのプロパティ」をご参照ください。
ResourceGroupId	String	いいえ	はい	カスタムイメージが属するリソースグループの ID。	なし。
Platform	String	いいえ	いいえ	システムディスクの OS ディストリビューション。データディスクのスナップショットを指定してカスタムイメージのシステムディスクを作成する場合、Platform プロパティを使用してシステムディスクの OS ディストリビューションを指定する必要があります。	有効値: CentOS Ubuntu SUSE OpenSUSE RedHat Debian CoreOS Aliyun Windows Server 2012 Windows 7 Customized Linux Others Linux (デフォルト)
Features	Map	いいえ	いいえ	カスタムイメージの機能属性。	詳細については、「Features プロパティ」をご参照ください。
DiskDeviceMapping	List	いいえ	いいえ	カスタムイメージとスナップショット間のマッピング。	詳細については、「DiskDeviceMapping プロパティ」をご参照ください。
Architecture	String	いいえ	いいえ	システムディスクのシステムアーキテクチャ。データディスクのスナップショットを指定してカスタムイメージのシステムディスクを作成する場合、Architecture プロパティを使用してシステムディスクのシステムアーキテクチャを指定する必要があります。	有効値: i386 x86_64 (デフォルト)
ImageFamily	String	いいえ	いいえ	イメージファミリの名前。	名前は 2 ～ 128 文字で、英字、数字、コロン(:)、アンダースコア (_)、およびハイフン (-) を使用できます。英字で始まり、`aliyun` または `acs:` で始めることはできません。`http://` または `https://` を含めることはできません。
SourceRegionId	String	いいえ	いいえ	インスタンスまたはスナップショットが属するリージョンの ID。	デフォルトでは、現在のリージョンの ID が使用されます。
DetectionStrategy	String	いいえ	いいえ	カスタムイメージをチェックするために使用するモード。	このプロパティを指定しない場合、カスタムイメージはチェックされません。標準チェックモードのみがサポートされています。説明ほとんどの Linux および Windows ディストリビューションがサポートされています。イメージチェックのチェック項目と OS の制限事項については、「概要」および「イメージチェックのオペレーティングシステムの制限」をご参照ください。
ImageVersion	String	いいえ	いいえ	カスタムイメージのバージョン。	InstanceId を指定し、インスタンスのイメージが Alibaba Cloud Marketplace のイメージ、または Alibaba Cloud Marketplace のイメージから作成されたカスタムイメージである場合、ImageVersion を空のままにするか、ImageVersion をインスタンスのイメージバージョンに設定する必要があります。
BootMode	String	いいえ	いいえ	カスタムイメージのブートモード。	有効値: BIOS: Basic Input/Output System (BIOS) ブートモード UEFI: Unified Extensible Firmware Interface (UEFI) ブートモード説明指定したイメージでサポートされているブートモードをよく理解しておく必要があります。このプロパティを使用してイメージのブートモードを変更する場合は、イメージでサポートされているブートモードを指定する必要があります。こうすることで、イメージを使用するインスタンスを想定どおりに起動できます。

Features 構文

"Features": 
  {
    "ImdsSupport": String
  }

Features プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

ImdsSupport

String

いいえ

イメージメタデータアクセスモード。

有効値:

v1: イメージから ECS インスタンスを作成するときに、イメージメタデータアクセスモードをセキュリティ強化に設定することはできません。
v2: イメージから ECS インスタンスを作成するときに、イメージメタデータアクセスモードをセキュリティ強化に設定できます。

Tag 構文

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

Tag プロパティ

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

DiskDeviceMapping 構文

"DiskDeviceMapping": [
  {
    "Device": String,
    "SnapshotId": String,
    "Size": Integer,
    "DiskType": String
  }
]

DiskDeviceMapping プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Device	String	いいえ	いいえ	カスタムイメージ内のディスクのデバイス名。	有効値: 基本ディスクの場合、有効値の範囲は `/dev/xvda から /dev/xvdz` までアルファベット順です。基本ディスク以外のディスクカテゴリの場合、有効値は /dev/vda から `/dev/vdz` までアルファベット順です。
SnapshotId	String	いいえ	いいえ	スナップショット ID。	なし。
Size	Integer	いいえ	いいえ	ディスクサイズ。	SnapshotId を空のままにした場合、Size では次の有効値がサポートされています。基本ディスクの有効値: 5 ～ 2000。デフォルト値: 5。基本ディスク以外のディスクカテゴリの有効値: 20 ～ 32768。デフォルト値: 20。 SnapshotId を指定した場合、Size の値は SnapshotId の値以上である必要があります。Size のデフォルト値は SnapshotId のデフォルト値と同じです。単位: GiB。
DiskType	String	いいえ	いいえ	カスタムイメージ内のディスクのタイプ。	このプロパティを使用して、データディスクのスナップショットからカスタムイメージのシステムディスクを作成できます。このプロパティを空のままにした場合、スナップショットのディスクタイプが使用されます。有効値: system: システムディスク data: データディスク

戻り値

Fn::GetAtt

ImageId: カスタムイメージの ID。

SourceRegionId: インスタンスまたはスナップショットが属するリージョンの ID。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Description:
  en: Create ECS Custom Image
Parameters:
  InstanceId:
    Type: String
    AssociationProperty: ALIYUN::ECS::Instance::InstanceId
Resources:
  CustomImage:
    Type: ALIYUN::ECS::CustomImage
    Properties:
      InstanceId:
        Ref: InstanceId
      ImageName: myImageName
Outputs:
  ImageId:
    Value:
      Fn::GetAtt:
        - CustomImage
        - ImageId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": {
    "en": "Create ECS Custom Image"
  },
  "Parameters": {
    "InstanceId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::Instance::InstanceId"
    }
  },
  "Resources": {
    "CustomImage": {
      "Type": "ALIYUN::ECS::CustomImage",
      "Properties": {
        "InstanceId": {
          "Ref": "InstanceId"
        },
        "ImageName": "myImageName"
      }
    }
  },
  "Outputs": {
    "ImageId": {
      "Value": {
        "Fn::GetAtt": [
          "CustomImage",
          "ImageId"
        ]
      }
    }
  }
}

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