調用ALIYUN::ECS::CustomImage建立自訂鏡像 -

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。	指定該參數表示使用執行個體建立自訂鏡像。更多資訊，請參見使用執行個體建立自訂鏡像。
ImageName	String	否	否	自訂鏡像名稱。	長度為2~128個字元。必須以英文字母或漢字開頭，不能以`http://`和`https://`開頭。可包含英文字母、漢字、數字、底線（_）和短劃線（-）。
SnapshotId	String	否	否	快照ID。	指定該參數表示使用快照建立自訂鏡像。更多資訊，請參見使用快照建立自訂鏡像。
Tag	List	否	否	標籤。	更多資訊，請參見Tag屬性。
ResourceGroupId	String	否	是	自訂鏡像所在的企業資源組ID。	無
Platform	String	否	否	指定資料盤快照作為自訂鏡像的系統硬碟後，需要通過Platform確定系統硬碟的作業系統發行版。	取值： 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	否	否	鏡像檢測策略。	不配置此參數時不觸發檢測。僅支援標準（Standard）檢測模式。說明目前已支援大部分的Linux、Windows版本，關於鏡像檢測項與作業系統限制說明，請參見鏡像檢測概述和鏡像檢測作業系統限制。
ImageVersion	String	否	否	鏡像版本。	當您指定了執行個體ID，並且該執行個體的鏡像是雲市場鏡像或者來自雲市場鏡像建立的自訂鏡像時。該參數必須和當前執行個體的鏡像的ImageVersion相同或置為空白。
BootMode	String	否	否	修改鏡像的啟動模式。	取值： BIOS：BIOS啟動模式。 UEFI：UEFI啟動模式。說明您需要瞭解指定的鏡像支援的啟動模式，當通過該參數修改啟動模式後，必須與鏡像本身支援的啟動模式比對，執行個體才能正常啟動。

Tag文法

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

Tag屬性

屬性名稱	類型	必須	允許更新	描述	約束
Key	String	否	否	標籤鍵。	長度為1~128個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或`https://`。
Value	String	否	否	標籤值。	長度為0~128個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或`https://`。

DiskDeviceMapping文法

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

DiskDeviceMapping屬性

屬性名稱	類型	必須	允許更新	描述	約束
Device	String	否	否	自訂鏡像中的裝置名稱。	取值：普通雲端硬碟：`/dev/xvd[a-z]`。其他雲端硬碟：`/dev/vd[a-z]`。
SnapshotId	String	否	否	快照ID。	無
Size	Integer	否	否	雲端硬碟的大小。	取值：如果沒有指定SnapshotId：普通雲端硬碟：5~2000。預設值：5。其他雲端硬碟：20~32,768。預設值：20。如果指定了SnapshotId，Size取值必須大於等於SnapshotId的大小，預設值為SnapshotId的大小。單位：GiB。
DiskType	String	否	否	自訂鏡像中的雲端硬碟類型。	您可以通過該參數使用資料盤快照作為自訂鏡像的系統硬碟。如果不指定該參數，預設為快照對應的雲端硬碟類型。取值： system：系統硬碟。 data：資料盤。

傳回值

Fn::GetAtt

ImageId：自訂鏡像ID。

SourceRegionId：執行個體或快照所在的地區ID。

樣本

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Description:
  zh-cn: 建立自訂鏡像。
  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": {
    "zh-cn": "建立自訂鏡像。",
    "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"
        ]
      }
    }
  }
}

更多樣本，請參見建立自訂鏡像和將一個地區下的自訂鏡像複製到其他地區的組合樣本：YAML樣本。