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

Resource Orchestration Service:ALIYUN::ECS::CustomImage

最終更新日:Jan 16, 2025

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,
    "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 (デフォルト)

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) ブートモード

説明

指定したイメージでサポートされているブートモードをよく理解しておく必要があります。 このプロパティを使用してイメージのブートモードを変更する場合、イメージでサポートされているブートモードを指定する必要があります。 これにより、イメージを使用するインスタンスを予期どおりに起動できます。

タグの構文

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

タグのプロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

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:
       
      # ECS カスタムイメージを作成します
    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" // ECS カスタムイメージを作成します
      },
      "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"
            ]
          }
        }
      }
    }          

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