ACS-ECS-CreateImage.json

{
  "FormatVersion": "OOS-2019-06-01",
  "Description": {
    "en": "Creates an ECS image, applicable to scenarios requiring the creation of a custom image from an existing ECS instance, such as for backup and system migration. During configuration, users need to provide the following required parameter information: Region ID (regionId), which specifies the region of the ECS instance for which the image will be created, ECS Instance ID (instanceId), which identifies the instance from which the image will be created, and Image Name (imageName). Users can also choose whether to create an image only from the system disk (whetherOnlySystemDisk). After the image creation, the template will return the ID of the newly created image.",
    "zh-cn": "创建一个ECS镜像，适用于需要从现有ECS实例创建自定义镜像的场景，例如备份和系统迁移。在配置过程中，用户需要提供以下必填参数信息，地域ID（regionId）：用于指定需要创建镜像的ECS实例所在的地域，ECS实例ID（instanceId）：用于指定要创建镜像的实例，以及图片名称（imageName）。用户还可以选择是否仅创建系统盘映像（whetherOnlySystemDisk）。创建镜像后，模板会返回新创建镜像的ID。",
    "name-en": "Create Image",
    "name-zh-cn": "创建镜像",
    "categories": [
      "image_manage",
      "application_manage"
    ]
  },
  "Parameters": {
    "regionId": {
      "Type": "String",
      "Label": {
        "en": "RegionId",
        "zh-cn": "地域ID"
      },
      "AssociationProperty": "RegionId",
      "Default": "{{ ACS::RegionId }}"
    },
    "instanceId": {
      "Label": {
        "en": "InstanceId",
        "zh-cn": "ECS实例ID"
      },
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::Instance::InstanceId",
      "AssociationPropertyMetadata": {
        "RegionId": "regionId"
      }
    },
    "imageName": {
      "Label": {
        "en": "ImageName",
        "zh-cn": "新镜像的名称"
      },
      "Type": "String",
      "Description": {
        "en": "<p class=\"p\">Note:</p> <ul class=\"ul\"> <li class=\"li\">Length is 2~128 English or Chinese characters</li> <li class=\"li\"><font color='red'>must start with big or small letters or Chinese, not http:// and https://. </font></li> <li class=\"li\">Can contain numbers, colons (:), underscores (_), or dashes (-). </li> </ul>",
        "zh-cn": "<p class=\"p\">注意：</p> <ul class=\"ul\"> <li class=\"li\">长度为2~128个英文或中文字符</li> <li class=\"li\"><font color='red'>必须以大小字母或中文开头，不能以http://和https://开头。</font></li> <li class=\"li\">可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。</li> </ul>"
      }
    },
    "tags": {
      "Label": {
        "en": "Tags",
        "zh-cn": "镜像标签"
      },
      "Type": "Json",
      "AssociationProperty": "Tags",
      "AssociationPropertyMetadata": {
        "ShowSystem": false
      },
      "Default": []
    },
    "imageFamily": {
      "Label": {
        "en": "ImageFamily",
        "zh-cn": "镜像族系"
      },
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::Image::ImageFamily",
      "Default": ""
    },
    "imageDescription": {
      "Label": {
        "en": "ImageDescription",
        "zh-cn": "镜像描述"
      },
      "Type": "String",
      "Default": ""
    },
    "resourceGroupId": {
      "Label": {
        "en": "ResourceGroupId",
        "zh-cn": "资源组ID"
      },
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::ResourceGroup::ResourceGroupId",
      "Default": ""
    },
    "detectionStrategy": {
      "Label": {
        "en": "DetectionStrategy",
        "zh-cn": "镜像检测策略"
      },
      "Type": "String",
      "AllowedValues": [
        "Standard",
        ""
      ],
      "Default": ""
    },
    "whetherOnlySystemDisk": {
      "Label": {
        "en": "WhetherOnlySystemDisk",
        "zh-cn": "是否仅选择系统盘"
      },
      "Type": "Boolean",
      "Default": false
    },
    "OOSAssumeRole": {
      "Label": {
        "en": "OOSAssumeRole",
        "zh-cn": "OOS扮演的RAM角色"
      },
      "Type": "String",
      "Default": ""
    }
  },
  "RamRole": "{{ OOSAssumeRole }}",
  "Tasks": [
    {
      "Name": "createImage",
      "Action": "ACS::ECS::CreateImage",
      "Description": {
        "en": "Create new image with the specified image name and instance ID",
        "zh-cn": "通过指定实例ID和镜像名称创建新的镜像"
      },
      "When": {
        "Fn::Equals": [
          "{{ whetherOnlySystemDisk }}",
          false
        ]
      },
      "Properties": {
        "regionId": "{{ regionId }}",
        "imageName": "{{ imageName }}__on_{{ ACS::ExecutionId }}_at_{{ Acs::CurrentDate }}",
        "instanceId": "{{ instanceId }}",
        "tags": "{{tags}}",
        "imageFamily": "{{ imageFamily }}",
        "imageDescription": "{{ imageDescription }}",
        "resourceGroupId": "{{ resourceGroupId }}",
        "detectionStrategy": "{{ detectionStrategy }}"
      },
      "Outputs": {
        "imageId": {
          "ValueSelector": "imageId",
          "Type": "String"
        }
      }
    },
    {
      "Name": "createImageOnlySystemDisk",
      "Action": "ACS::ECS::CreateImageForSystemDisk",
      "Description": {
        "en": "Create new system disk image with the specified image name and instance ID",
        "zh-cn": "通过指定实例ID和镜像名称创建新的系统盘镜像"
      },
      "When": {
        "Fn::Equals": [
          "{{ whetherOnlySystemDisk }}",
          true
        ]
      },
      "Properties": {
        "regionId": "{{ regionId }}",
        "imageName": "{{ imageName }}__on_{{ ACS::ExecutionId }}_at_{{ Acs::CurrentDate }}",
        "instanceId": "{{ instanceId }}",
        "tags": "{{tags}}",
        "imageFamily": "{{ imageFamily }}",
        "imageDescription": "{{ imageDescription }}",
        "resourceGroupId": "{{ resourceGroupId }}",
        "detectionStrategy": "{{ detectionStrategy }}"
      },
      "Outputs": {
        "imageId": {
          "ValueSelector": "imageId",
          "Type": "String"
        }
      }
    }
  ],
  "Outputs": {
    "imageId": {
      "Type": "String",
      "Value": {
        "Fn::If": [
          {
            "Fn::Equals": [
              "{{ whetherOnlySystemDisk }}",
              false
            ]
          },
          "{{ createImage.imageId }}",
          "{{ createImageOnlySystemDisk.imageId }}"
        ]
      }
    }
  },
  "Metadata": {
    "ALIYUN::OOS::Interface": {
      "ParameterGroups": [
        {
          "Parameters": [
            "regionId",
            "instanceId"
          ],
          "Label": {
            "default": {
              "zh-cn": "选择实例",
              "en": "Select Ecs Instances"
            }
          }
        },
        {
          "Parameters": [
            "imageName",
            "tags",
            "whetherOnlySystemDisk",
            "imageFamily",
            "imageDescription",
            "resourceGroupId",
            "detectionStrategy"
          ],
          "Label": {
            "default": {
              "zh-cn": "镜像设置",
              "en": "Image Configure"
            }
          }
        },
        {
          "Parameters": [
            "OOSAssumeRole"
          ],
          "Label": {
            "default": {
              "zh-cn": "高级选项",
              "en": "Control Options"
            }
          }
        }
      ]
    }
  }
}