全部产品
Search
文档中心

资源编排:ALIYUN::ECS::CopyImage

更新时间:Jan 04, 2024

ALIYUN::ECS::CopyImage类型用于将一个地域下的自定义镜像复制到其他地域。

语法

{
  "Type": "ALIYUN::ECS::CopyImage",
  "Properties": {
    "Encrypted": Boolean,
    "DestinationImageName": String,
    "ImageId": String,
    "DestinationRegionId": String,
    "SourceRegionId": String,
    "Tag": List,
    "DestinationDescription": String,
    "KMSKeyId": String,
    "ResourceGroupId": String,
    "AllowCopyInSameRegion": Boolean
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

Encrypted

Boolean

是否加密复制后的自定义镜像。

取值:

  • true:加密。

  • false(默认值):不加密。

DestinationImageName

String

复制后的自定义镜像的名称。

长度为2~128个字符。必须以英文字母或汉字开头,不能以http://https://开头。可包含英文字母、汉字、数字、半角冒号(:)、下划线(_)或短划线(-)。

ImageId

String

源自定义镜像ID。

DestinationRegionId

String

复制后的自定义镜像所在的地域ID。

SourceRegionId

String

源自定义镜像所在的地域ID。

默认为当前地域ID。

Tag

List

标签。

更多信息,请参见Tag属性

DestinationDescription

String

复制后的自定义镜像的描述信息。

长度为2~256个字符,不能以http://https://开头。

KMSKeyId

String

加密自定义镜像使用的密钥ID。

ResourceGroupId

String

资源组ID。

AllowCopyInSameRegion

Boolean

是否允许复制同一区域内的镜像。

取值:

  • true:不会复制镜像,将返回源镜像ID,并且不会删除原始镜像。 

  • false:允许复制同一区域内的镜像。

Tag语法

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

Tag属性

属性名称

类型

必须

允许更新

描述

约束

Key

String

标签键。

长度为1~128个字符,不能以aliyunacs:开头,不能包含http://https://

Value

String

标签值。

长度为0~128个字符,不能以aliyunacs:开头,不能包含http://https://

返回值

Fn::GetAtt

  • ImageId:复制后的自定义镜像ID。

  • DestinationRegionId:目标自定义镜像所在的地域ID。

  • SourceRegionId:源自定义镜像所在的地域ID。

示例

  • YAML格式

    ROSTemplateFormatVersion: '2015-09-01'
    Description:
      zh-cn: 将一个地域下的自定义镜像复制到其他地域。
      en: Create ECS CopyImage
    Parameters:
      ImageId:
        Type: String
        AssociationProperty: ALIYUN::ECS::Image::ImageId
        AssociationPropertyMetadata:
          SupportedImageOwnerAlias:
            - self
    Resources:
      CopyImage:
        Type: ALIYUN::ECS::CopyImage
        Properties:
          Encrypted: false
          ImageId:
            Ref: ImageId
          DestinationRegionId: cn-shanghai
          SourceRegionId: cn-hangzhou
          DestinationDescription: Test CopyImage
    Outputs:
      CopyImageId:
        Value:
          Fn::GetAtt:
            - CopyImage
            - ImageId                    
  • JSON格式

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Description": {
        "zh-cn": "将一个地域下的自定义镜像复制到其他地域。",
        "en": "Create ECS CopyImage"
      },
      "Parameters": {
        "ImageId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Image::ImageId",
          "AssociationPropertyMetadata": {
            "SupportedImageOwnerAlias": [
              "self"
            ]
          }
        }
      },
      "Resources": {
        "CopyImage": {
          "Type": "ALIYUN::ECS::CopyImage",
          "Properties": {
            "Encrypted": false,
            "ImageId": {
              "Ref": "ImageId"
            },
            "DestinationRegionId": "cn-shanghai",
            "SourceRegionId": "cn-hangzhou",
            "DestinationDescription": "Test CopyImage"
          }
        }
      },
      "Outputs": {
        "CopyImageId": {
          "Value": {
            "Fn::GetAtt": [
              "CopyImage",
              "ImageId"
            ]
          }
        }
      }
    }            

更多示例,请参见创建自定义镜像和将一个地域下的自定义镜像复制到其他地域的组合示例:JSON示例YAML示例