Use ALIYUN::ECS::InstanceClone in a call to clone an ECS instance - Resource Orchestration Service

ALIYUN::ECS::InstanceClone is used to clone an Elastic Compute Service (ECS) instance.

Syntax

{
  "Type": "ALIYUN::ECS::InstanceClone",
  "Properties": {
    "DeletionProtection": Boolean,
    "DiskMappings": List,
    "LoadBalancerIdToAttach": String,
    "Description": String,
    "BackendServerWeight": Integer,
    "Tags": List,
    "SecurityGroupId": String,
    "RamRoleName": String,
    "ImageId": String,
    "ResourceGroupId": String,
    "SpotPriceLimit": String,
    "InstanceChargeType": String,
    "SourceInstanceId": String,
    "Period": Number,
    "SpotStrategy": String,
    "Password": String,
    "InstanceName": String,
    "ZoneId": String,
    "KeyPairName": String,
    "InternetMaxBandwidthIn": Integer
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
ResourceGroupId	String	No	No	The ID of the resource group to which the new ECS instance belongs.	None.
SourceInstanceId	String	Yes	No	The ID of the source ECS instance.	You can clone all data and settings of the source ECS instance, including the instance type, image, bandwidth metering method, bandwidth limit, and network type. If the source ECS instance belongs to multiple security groups, the new instance is added to the first security group.
BackendServerWeight	Integer	No	No	The weight of the new ECS instance that you want to attach to the Server Load Balancer (SLB) instance.	Valid values: 0 to 100. Default value: 100.
LoadBalancerIdToAttach	String	No	No	The ID of the SLB instance to which you want to attach the new ECS instance.	None.
Description	String	No	No	The description.	The description can be up to 256 characters in length.
ImageId	String	No	Yes	The ID of the image that you want to use to start the new ECS instance. You can use a public image, a custom image, or an Alibaba Cloud Marketplace image.	To specify a public image, you can enter a partial image ID instead of the complete image ID. Public images support fuzzy search. Examples: If you enter ubuntu, the system matches it with the following image ID: ubuntu16_0402_64_20G_alibase_20170818.vhd. If you enter ubuntu_14, the system matches it with the following image ID: ubuntu_14_0405_64_20G_alibase_20170824.vhd. If you enter ubuntu1432, the system matches it with the following image ID: ubuntu_14_0405_32_40G_alibase_20170711.vhd. If you enter ubuntu_16_0402_32, the system matches it with the following image ID: ubuntu_16_0402_32_40G_alibase_20170711.vhd.
SecurityGroupId	String	No	No	The ID of the security group to which the new ECS instance belongs.	None.
InstanceName	String	No	Yes	The name of the new ECS instance.	The name must be 2 to 128 characters in length. It must start with a letter and cannot start with `http://` or `https://`. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).
Password	String	No	No	The password that is used to log on to the new ECS instance.	The password must be 8 to 30 characters in length. It must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. The following special characters are supported: `( ) ' ~ ! @ # $ % ^ & * - + = \| { } [ ] : ; ‘ < > , . ? /`. If you specify this property, you must call specific Resource Orchestration Service (ROS) API operations by using HTTPS to prevent the exposure of your password.
DiskMappings	List	No	Yes	The disks that you want to attach to the new ECS instance.	You can attach up to 16 disks. For more information, see DiskMappings properties.
Tags	List	No	Yes	The custom tags.	You can add up to 20 tags in the following format: `[{"Key":"tagKey","Value":"tagValue"},{"Key":"tagKey2","Value":"tagValue2"}]`. For more information, see Tags properties.
ZoneId	String	No	No	The zone ID.	None.
InstanceChargeType	String	No	No	The billing method of the new ECS instance.	Valid values: PrePaid: subscription Note If you set this property to PrePaid, make sure that your account has sufficient balance. If your account has insufficient balance, the instance fails to be created. PostPaid (default): pay-as-you-go
Period	Number	No	No	The billing cycle.	Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, and 36. Unit: month. This property is required if you set InstanceChargeType to PrePaid. This property is optional if you set InstanceChargeType to PostPaid.
KeyPairName	String	No	Yes	The name of the key pair that you want to use to connect to the new ECS instance.	For Windows instances, the KeyPairName property is empty by default. For Linux instances, the Password property takes effect even if you specify the KeyPairName property. However, password-based logons are disabled by default, and the value of the KeyPairName property is used to verify logons.
RamRoleName	String	No	No	The name of the Resource Access Management (RAM) role for the new ECS instance.	For more information, see CreateRole and ListRoles.
SpotPriceLimit	String	No	No	The maximum hourly price of the new ECS instance.	The value of this property can contain up to three decimal places. This property takes effect when SpotStrategy is set to SpotWithPriceLimit.
SpotStrategy	String	No	No	The bidding policy for the pay-as-you-go instance.	This property takes effect when InstanceChargeType is set to PostPaid. Valid values: NoSpot (default): The instance is created as a regular pay-as-you-go instance. SpotWithPriceLimit: The instance is created as a preemptible instance that has a user-defined maximum hourly price. SpotAsPriceGo: The instance is created as a preemptible instance whose bidding price is based on the market price at the time of purchase. The market price can be up to the pay-as-you-go price.
DeletionProtection	Boolean	No	No	The release protection property of the new ECS instance. You can use this property to specify whether you can release the instance in the ECS console or by calling the DeleteInstance operation.	Valid values: true false (default)
InternetMaxBandwidthIn	Integer	No	No	The maximum outbound public bandwidth.	Unit: Mbit/s. Valid values: 0 to 200. Default value: 200.

DiskMappings syntax

"DiskMappings": [
  {
    "Category": String,
    "DiskName": String,
    "Description": String,
    "Device": String,
    "SnapshotId": String,
    "PerformanceLevel": String,
    "Size": String
  }
]

DiskMappings properties

Property	Type	Required	Editable	Description	Constraint
Size	String	Yes	No	The size of the data disk.	Valid values: 20 to 500. Unit: GB.
Category	String	No	No	The category of the data disk.	Valid values: cloud: basic disk cloud_ssd: standard SSD cloud_essd: Enterprise SSD (ESSD) cloud_efficiency: ultra disk ephemeral_ssd: local SSD For I/O optimized instances, the default value is cloud_efficiency. For non-I/O optimized instances, the default value is cloud.
DiskName	String	No	No	The name of the data disk.	The name must be 2 to 128 characters in length. It must start with a letter and cannot start with `http://` or `https://`. It can contain letters, digits, underscores (_), colons (:), and hyphens (-).
PerformanceLevel	String	No	No	The performance level (PL) of the ESSD that you want to use as the system disk.	Valid values: PL0: An ESSD can deliver up to 10,000 random read/write IOPS. PL1 (default): An ESSD can deliver up to 50,000 random read/write IOPS. PL2: An ESSD can deliver up to 100,000 random read/write IOPS. PL3: An ESSD can deliver up to 1,000,000 random read/write IOPS. For more information about how to select the PL of the ESSD, see ESSDs.
Description	String	No	No	The description.	The description must be 2 to 256 characters in length. By default, this property is empty.
Device	String	No	No	The mount target.	This property will be removed. We recommend that you use other properties to improve code compatibility.
SnapshotId	String	No	No	The ID of the snapshot that you want to use to create the data disk.	None.

Tags syntax

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

Tags properties

Property	Type	Required	Editable	Description	Constraint
Key	String	Yes	No	The tag key.	The tag key must be 1 to 128 characters in length, and cannot contain `http://` or `https://`. It cannot start with `aliyun` or `acs:`.
Value	String	No	No	The tag value.	The tag value can be up to 128 characters in length, and cannot contain `http://` or `https://`. It cannot start with `aliyun` or `acs:`.

Return values

Fn::GetAtt

InstanceId: the ID of the new ECS instance. The instance ID is a GUID that is generated by the system for an instance.
PrivateIp: the private IP address of the new ECS instance in a virtual private cloud (VPC). This property takes effect when NetworkType is set to vpc.
InnerIp: the private IP address of the new ECS instance in the classic network. This property takes effect when NetworkType is set to classic.
PublicIp: the public IP address of the new ECS instance in the classic network. This property takes effect when NetworkType is set to classic.
ZoneId: the zone ID of the new ECS instance.
HostName: the hostname of the new ECS instance.
PrimaryNetworkInterfaceId: the primary elastic network interface (ENI) ID of the new ECS instance.
SecurityGroupIds: the IDs of security groups to which the new ECS instance belongs.

Examples

`YAML` format

ROSTemplateFormatVersion: '2015-09-01'
Description: Test ECS Instance Clone
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  SourceInstanceId:
    Type: String
    AssociationProperty: ALIYUN::ECS::Instance::InstanceId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
Resources:
  InstanceClone:
    Type: ALIYUN::ECS::InstanceClone
    Properties:
      SourceInstanceId:
        Ref: SourceInstanceId

`JSON` format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": "Test ECS Instance Clone",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "SourceInstanceId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::Instance::InstanceId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  },
  "Resources": {
    "InstanceClone": {
      "Type": "ALIYUN::ECS::InstanceClone",
      "Properties": {
        "SourceInstanceId": {
          "Ref": "SourceInstanceId"
        }
      }
    }
  }
}

Syntax

Properties

DiskMappings syntax

DiskMappings properties

Tags syntax

Tags properties

Return values

Examples

YAML format

JSON format

`YAML` format

`JSON` format