Skip to content

InstanceGroupCloneProps

Properties for defining a InstanceGroupClone.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ecs-instancegroupclone

Initializer

using AlibabaCloud.SDK.ROS.CDK.Ecs;
new InstanceGroupCloneProps {
    object MaxAmount,
    object SourceInstanceId,
    object AutoReleaseTime = null,
    object AutoRenew = null,
    object AutoRenewPeriod = null,
    object BackendServerWeight = null,
    object CpuOptions = null,
    object DeletionProtection = null,
    object DeploymentSetId = null,
    object Description = null,
    object DiskMappings = null,
    object EniMappings = null,
    object HostNames = null,
    object HpcClusterId = null,
    object ImageId = null,
    object ImageOptions = null,
    object InstanceName = null,
    object InternetMaxBandwidthIn = null,
    object InternetMaxBandwidthOut = null,
    object Ipv6AddressCount = null,
    object Ipv6Addresses = null,
    object KeyPairName = null,
    object LaunchTemplateId = null,
    object LaunchTemplateName = null,
    object LaunchTemplateVersion = null,
    object LoadBalancerIdToAttach = null,
    object NetworkInterfaceQueueNumber = null,
    object NetworkOptions = null,
    object Password = null,
    object PasswordInherit = null,
    object Period = null,
    object PeriodUnit = null,
    object RamRoleName = null,
    object ResourceGroupId = null,
    object SecurityGroupId = null,
    object SecurityGroupIds = null,
    object SecurityOptions = null,
    object SpotPriceLimit = null,
    object SpotStrategy = null,
    object SystemDiskAutoSnapshotPolicyId = null,
    object SystemDiskBurstingEnabled = null,
    object SystemDiskCategory = null,
    object SystemDiskDescription = null,
    object SystemDiskDiskName = null,
    object SystemDiskEncryptAlgorithm = null,
    object SystemDiskEncrypted = null,
    object SystemDiskKmsKeyId = null,
    object SystemDiskProvisionedIops = null,
    object SystemDiskStorageClusterId = null,
    TagsProperty[] Tags = null,
    object UniqueSuffix = null,
    object UpdatePolicy = null,
    object ZoneId = null
};

Properties

Name Type Description
MaxAmount object Property maxAmount: Max number of instances to create, should be bigger than 'MinAmount' and smaller than 1000.
SourceInstanceId object Property sourceInstanceId: Source ecs instance used to copy properties to clone new ecs instance.
AutoReleaseTime object Property autoReleaseTime: Auto release time for created instance, Follow ISO8601 standard using UTC time.
AutoRenew object Property autoRenew: Whether renew the fee automatically?
AutoRenewPeriod object Property autoRenewPeriod: The time period of auto renew.
BackendServerWeight object Property backendServerWeight: The weight of backend server of load balancer.
CpuOptions object Property cpuOptions: Cpu options.
DeletionProtection object Property deletionProtection: Whether an instance can be released manually through the console or API, deletion protection only support postPaid instance.
DeploymentSetId object Property deploymentSetId: Deployment set ID.
Description object Property description: Description of the instance, [2, 256] characters.
DiskMappings object Property diskMappings: Disk mappings to attach to instance.
EniMappings object Property eniMappings: NetworkInterface to attach to instance.
HostNames object Property hostNames: The hostname of instance N.
HpcClusterId object Property hpcClusterId: The HPC cluster ID to which the instance belongs.The change of the property does not affect existing instances.
ImageId object Property imageId: Image ID to create ecs instance.
ImageOptions object Property imageOptions: Image options.
InstanceName object Property instanceName: Display name of the instance, [2, 128] English or Chinese characters, must start with a letter or Chinese in size, can contain numbers, '_' or '.', '-'. Support to use the regular expression to set the different instance name for each ECS instance. InstanceName could be specified as 'name_prefix[begin_number,bits]name_suffix', such as 'testinstance[123,4]tail'. If you creates 3 instances with the instance name 'testinstance[123,4]tail', all the instances' names are testinstance0123tail, testinstance0124tail, testinstance0125tail. The 'name_prefix[begin_number,bits]name_suffix' should follow those rules: 1. 'name_prefix' is required. 2. 'name_suffix' is optional. 3. The name regular expression can't include any spaces. 4. The 'bits' must be in range [1, 6]. 5. The 'begin_number' must be in range [0, 999999]. 6. You could only specify 'begin_number'. The 'bits' will be set as 6 by default. 7. You also could only specify the [] or [,]. The 'begin_number' will be set as 0 by default, the 'bits' will be set as 6 by default. 8. If the bits of 'begin_number' is less than the 'bits' you specified, like [1234,1], the 'bits' will be set as 6 by default.
InternetMaxBandwidthIn object Property internetMaxBandwidthIn: Max internet out band width setting, unit in Mbps(Mega bit per second).
InternetMaxBandwidthOut object Property internetMaxBandwidthOut: Set internet output bandwidth of instance.
Ipv6AddressCount object Property ipv6AddressCount: Specifies the number of randomly generated IPv6 addresses for the elastic NIC.
Ipv6Addresses object Property ipv6Addresses: Specify one or more IPv6 addresses for the elastic NIC.
KeyPairName object Property keyPairName: SSH key pair name.Old instances will not be changed.
LaunchTemplateId object Property launchTemplateId: ID of launch template.
LaunchTemplateName object Property launchTemplateName: Name of launch template.
LaunchTemplateVersion object Property launchTemplateVersion: Version of launch template.
LoadBalancerIdToAttach object Property loadBalancerIdToAttach: After the instance is created.
NetworkInterfaceQueueNumber object Property networkInterfaceQueueNumber: The number of queues supported by the primary ENI.
NetworkOptions object Property networkOptions: Network options.
Password object Property password: Password of created ecs instance.
PasswordInherit object Property passwordInherit: Specifies whether to use the password preset in the image.
Period object Property period: Prepaid time period.
PeriodUnit object Property periodUnit: Unit of prepaid time period, it could be Week\/Month\/Year.
RamRoleName object Property ramRoleName: Instance RAM role name.
ResourceGroupId object Property resourceGroupId: Resource group id.
SecurityGroupId object Property securityGroupId: Security group to create ecs instance.
SecurityGroupIds object Property securityGroupIds: The IDs of security groups N to which the instance belongs.
SecurityOptions object Property securityOptions: Security options.
SpotPriceLimit object Property spotPriceLimit: The hourly price threshold of a instance, and it takes effect only when parameter InstanceChargeType is PostPaid.
SpotStrategy object Property spotStrategy: The spot strategy of a Pay-As-You-Go instance, and it takes effect only when parameter InstanceChargeType is PostPaid.
SystemDiskAutoSnapshotPolicyId object Property systemDiskAutoSnapshotPolicyId: Auto snapshot policy ID.
SystemDiskBurstingEnabled object Property systemDiskBurstingEnabled: Whether enable bursting.
SystemDiskCategory object Property systemDiskCategory: Category of system disk.
SystemDiskDescription object Property systemDiskDescription: Description of created system disk.Old instances will not be changed.
SystemDiskDiskName object Property systemDiskDiskName: Name of created system disk.Old instances will not be changed.
SystemDiskEncryptAlgorithm object Property systemDiskEncryptAlgorithm: The algorithm to use to encrypt the system disk.
SystemDiskEncrypted object Property systemDiskEncrypted: Specifies whether to encrypt the system disk.
SystemDiskKmsKeyId object Property systemDiskKmsKeyId: The ID of the KMS key to use for the system disk.
SystemDiskProvisionedIops object Property systemDiskProvisionedIops: Provisioning IOPS.
SystemDiskStorageClusterId object Property systemDiskStorageClusterId: The ID of the dedicated block storage cluster.
Tags TagsProperty[] Property tags: Tags to attach to instance.
UniqueSuffix object Property uniqueSuffix: Specifies whether to automatically append incremental suffixes to the hostname specified by the HostName parameter and to the instance name specified by the InstanceName parameter when you batch create instances.
UpdatePolicy object Property updatePolicy: Specify the policy at update.
ZoneId object Property zoneId: The ID of the zone to which the instance belongs.

MaxAmountRequired

public object MaxAmount { get; set; }
  • Type: object

Property maxAmount: Max number of instances to create, should be bigger than 'MinAmount' and smaller than 1000.


SourceInstanceIdRequired

public object SourceInstanceId { get; set; }
  • Type: object

Property sourceInstanceId: Source ecs instance used to copy properties to clone new ecs instance.

It will copy the InstanceType, ImageId, InternetChargeType, InternetMaxBandwidthIn, InternetMaxBandwidthOut and the system disk and data disk configurations. If the instance network is VPC, it will also clone the relative properties. If specified instance with more than one security group, it will use the first security group to create instance. you can also specify the SecurityGroupId to override it.


AutoReleaseTimeOptional

public object AutoReleaseTime { get; set; }
  • Type: object

Property autoReleaseTime: Auto release time for created instance, Follow ISO8601 standard using UTC time.

format is 'yyyy-MM-ddTHH:mm:ssZ'. Not bigger than 3 years from this day onwards


AutoRenewOptional

public object AutoRenew { get; set; }
  • Type: object

Property autoRenew: Whether renew the fee automatically?

When the parameter InstanceChargeType is PrePaid, it will take effect. Range of value:True: automatic renewal.False: no automatic renewal. Default value is False.Old instances will not be changed.


AutoRenewPeriodOptional

public object AutoRenewPeriod { get; set; }
  • Type: object

Property autoRenewPeriod: The time period of auto renew.

When the parameter InstanceChargeType is PrePaid, it will take effect.It could be 1, 2, 3, 6, 12, 24, 36, 48, 60. Default value is 1.Old instances will not be changed.


BackendServerWeightOptional

public object BackendServerWeight { get; set; }
  • Type: object

Property backendServerWeight: The weight of backend server of load balancer.

From 0 to 100, 0 means offline. Default is 100.


CpuOptionsOptional

public object CpuOptions { get; set; }
  • Type: object

Property cpuOptions: Cpu options.


DeletionProtectionOptional

public object DeletionProtection { get; set; }
  • Type: object

Property deletionProtection: Whether an instance can be released manually through the console or API, deletion protection only support postPaid instance.


DeploymentSetIdOptional

public object DeploymentSetId { get; set; }
  • Type: object

Property deploymentSetId: Deployment set ID.

The change of the property does not affect existing instances.


DescriptionOptional

public object Description { get; set; }
  • Type: object

Property description: Description of the instance, [2, 256] characters.

Do not fill or empty, the default is empty. Old instances will not be changed.


DiskMappingsOptional

public object DiskMappings { get; set; }
  • Type: object

Property diskMappings: Disk mappings to attach to instance.

Max support 16 disks. If the image contains a data disk, you can specify other parameters of the data disk via the same value of parameter "Device". If parameter "Category" is not specified, it will be cloud_efficiency instead of "Category" of data disk in the image.Old instances will not be changed.


EniMappingsOptional

public object EniMappings { get; set; }
  • Type: object

Property eniMappings: NetworkInterface to attach to instance.

Max support 2 ENIs.


HostNamesOptional

public object HostNames { get; set; }
  • Type: object

Property hostNames: The hostname of instance N.

You can use this parameter to specify different hostnames for multiple instances. Take note of the following items:

  • The maximum value of N must be the same as the Amount value. For example, if you set Amount to 2, you can use HostNames.1 and HostNames.2 to specify hostnames for the individual instances. Examples: HostNames.1=test1 and HostNames.2=test2.
  • You cannot specify both HostName and HostNames.N.
  • The hostname cannot start or end with a period (.) or hyphen (-). The hostname cannot contain consecutive periods (.) or hyphens (-).
  • For Windows instances, the hostname must be 2 to 15 characters in length and cannot contain periods (.) or contain only digits. The hostname can contain letters, digits, and hyphens (-).
  • For instances that run other operating systems such as Linux, the hostname must be 2 to 64 characters in length. You can use periods (.) to separate a hostname into multiple segments. Each segment can contain letters, digits, and hyphens (-).

HpcClusterIdOptional

public object HpcClusterId { get; set; }
  • Type: object

Property hpcClusterId: The HPC cluster ID to which the instance belongs.The change of the property does not affect existing instances.


ImageIdOptional

public object ImageId { get; set; }
  • Type: object

Property imageId: Image ID to create ecs instance.


ImageOptionsOptional

public object ImageOptions { get; set; }
  • Type: object

Property imageOptions: Image options.


InstanceNameOptional

public object InstanceName { get; set; }
  • Type: object

Property instanceName: Display name of the instance, [2, 128] English or Chinese characters, must start with a letter or Chinese in size, can contain numbers, '_' or '.', '-'. Support to use the regular expression to set the different instance name for each ECS instance. InstanceName could be specified as 'name_prefix[begin_number,bits]name_suffix', such as 'testinstance[123,4]tail'. If you creates 3 instances with the instance name 'testinstance[123,4]tail', all the instances' names are testinstance0123tail, testinstance0124tail, testinstance0125tail. The 'name_prefix[begin_number,bits]name_suffix' should follow those rules: 1. 'name_prefix' is required. 2. 'name_suffix' is optional. 3. The name regular expression can't include any spaces. 4. The 'bits' must be in range [1, 6]. 5. The 'begin_number' must be in range [0, 999999]. 6. You could only specify 'begin_number'. The 'bits' will be set as 6 by default. 7. You also could only specify the [] or [,]. The 'begin_number' will be set as 0 by default, the 'bits' will be set as 6 by default. 8. If the bits of 'begin_number' is less than the 'bits' you specified, like [1234,1], the 'bits' will be set as 6 by default.


InternetMaxBandwidthInOptional

public object InternetMaxBandwidthIn { get; set; }
  • Type: object

Property internetMaxBandwidthIn: Max internet out band width setting, unit in Mbps(Mega bit per second).

The range is [0,200], default is 200 Mbps.


InternetMaxBandwidthOutOptional

public object InternetMaxBandwidthOut { get; set; }
  • Type: object

Property internetMaxBandwidthOut: Set internet output bandwidth of instance.

Unit is Mbps(Mega bit per second). Range is [0,200]. Default is 1.While the property is not 0, public ip will be assigned for instance.


Ipv6AddressCountOptional

public object Ipv6AddressCount { get; set; }
  • Type: object

Property ipv6AddressCount: Specifies the number of randomly generated IPv6 addresses for the elastic NIC.

Note You cannot specify the parameters Ipv6Addresses and Ipv6AddressCount at the same time. The change of the property does not affect existing instances.


Ipv6AddressesOptional

public object Ipv6Addresses { get; set; }
  • Type: object

Property ipv6Addresses: Specify one or more IPv6 addresses for the elastic NIC.

Currently, the maximum list size is 1. Example value: 2001:db8:1234:1a00::*** . Note You cannot specify the parameters Ipv6Addresses and Ipv6AddressCount at the same time. The change of the property does not affect existing instances.


KeyPairNameOptional

public object KeyPairName { get; set; }
  • Type: object

Property keyPairName: SSH key pair name.Old instances will not be changed.


LaunchTemplateIdOptional

public object LaunchTemplateId { get; set; }
  • Type: object

Property launchTemplateId: ID of launch template.

Launch template id or name must be specified to use launch template


LaunchTemplateNameOptional

public object LaunchTemplateName { get; set; }
  • Type: object

Property launchTemplateName: Name of launch template.

Launch template id or name must be specified to use launch template


LaunchTemplateVersionOptional

public object LaunchTemplateVersion { get; set; }
  • Type: object

Property launchTemplateVersion: Version of launch template.

Default version is used if version is not specified.


LoadBalancerIdToAttachOptional

public object LoadBalancerIdToAttach { get; set; }
  • Type: object

Property loadBalancerIdToAttach: After the instance is created.

Automatic attach it to the load balancer.


NetworkInterfaceQueueNumberOptional

public object NetworkInterfaceQueueNumber { get; set; }
  • Type: object

Property networkInterfaceQueueNumber: The number of queues supported by the primary ENI.

Take note of the following items:

  • The value of this parameter cannot exceed the maximum number of queues per ENI allowed for the instance type.
  • The total number of queues for all ENIs on the instance cannot exceed the queue quota for the instance type.
  • If NetworkInterface.N.InstanceType is set to Primary, you cannot specify NetworkInterfaceQueueNumber but can specify NetworkInterface.N.QueueNumber

NetworkOptionsOptional

public object NetworkOptions { get; set; }
  • Type: object

Property networkOptions: Network options.


PasswordOptional

public object Password { get; set; }
  • Type: object

Property password: Password of created ecs instance.

Must contain at least 3 types of special character, lower character, upper character, number.


PasswordInheritOptional

public object PasswordInherit { get; set; }
  • Type: object

Property passwordInherit: Specifies whether to use the password preset in the image.

To use the PasswordInherit parameter, the Password parameter must be empty and you must make sure that the selected image has a password configured.


PeriodOptional

public object Period { get; set; }
  • Type: object

Property period: Prepaid time period.

Unit is month, it could be from 1 to 9 or 12, 24, 36, 48, 60. Default value is 1.Old instances will not be changed.


PeriodUnitOptional

public object PeriodUnit { get; set; }
  • Type: object

Property periodUnit: Unit of prepaid time period, it could be Week\/Month\/Year.

Default value is Month.Old instances will not be changed.


RamRoleNameOptional

public object RamRoleName { get; set; }
  • Type: object

Property ramRoleName: Instance RAM role name.

The name is provided and maintained by Resource Access Management (RAM) and can be queried using ListRoles. For more information, see RAM API CreateRole and ListRoles.


ResourceGroupIdOptional

public object ResourceGroupId { get; set; }
  • Type: object

Property resourceGroupId: Resource group id.


SecurityGroupIdOptional

public object SecurityGroupId { get; set; }
  • Type: object

Property securityGroupId: Security group to create ecs instance.

For classic instance need the security group not belong to VPC, for VPC instance, please make sure the security group belong to specified VPC.


SecurityGroupIdsOptional

public object SecurityGroupIds { get; set; }
  • Type: object

Property securityGroupIds: The IDs of security groups N to which the instance belongs.

The valid values of N are based on the maximum number of security groups to which an instance can belong. For more information, see Security group limits.Note: You cannot specify both SecurityGroupId and SecurityGroupIds at the same time.


SecurityOptionsOptional

public object SecurityOptions { get; set; }
  • Type: object

Property securityOptions: Security options.


SpotPriceLimitOptional

public object SpotPriceLimit { get; set; }
  • Type: object

Property spotPriceLimit: The hourly price threshold of a instance, and it takes effect only when parameter InstanceChargeType is PostPaid.

Three decimals is allowed at most.


SpotStrategyOptional

public object SpotStrategy { get; set; }
  • Type: object

Property spotStrategy: The spot strategy of a Pay-As-You-Go instance, and it takes effect only when parameter InstanceChargeType is PostPaid.

Value range: "NoSpot: A regular Pay-As-You-Go instance", "SpotWithPriceLimit: A price threshold for a spot instance, ""SpotAsPriceGo: A price that is based on the highest Pay-As-You-Go instance. "Default value: NoSpot.


SystemDiskAutoSnapshotPolicyIdOptional

public object SystemDiskAutoSnapshotPolicyId { get; set; }
  • Type: object

Property systemDiskAutoSnapshotPolicyId: Auto snapshot policy ID.


SystemDiskBurstingEnabledOptional

public object SystemDiskBurstingEnabled { get; set; }
  • Type: object

Property systemDiskBurstingEnabled: Whether enable bursting.


SystemDiskCategoryOptional

public object SystemDiskCategory { get; set; }
  • Type: object

Property systemDiskCategory: Category of system disk.

Default is cloud_efficiency. support cloud|cloud_efficiency|cloud_ssd|cloud_essd|ephemeral_ssd|cloud_auto|cloud_essd_entry.Old instances will not be changed.


SystemDiskDescriptionOptional

public object SystemDiskDescription { get; set; }
  • Type: object

Property systemDiskDescription: Description of created system disk.Old instances will not be changed.


SystemDiskDiskNameOptional

public object SystemDiskDiskName { get; set; }
  • Type: object

Property systemDiskDiskName: Name of created system disk.Old instances will not be changed.


SystemDiskEncryptAlgorithmOptional

public object SystemDiskEncryptAlgorithm { get; set; }
  • Type: object

Property systemDiskEncryptAlgorithm: The algorithm to use to encrypt the system disk.

Valid values:

  • ase-256
  • sm4-128 Default value: ase-256.

SystemDiskEncryptedOptional

public object SystemDiskEncrypted { get; set; }
  • Type: object

Property systemDiskEncrypted: Specifies whether to encrypt the system disk.

Valid values:

  • true: encrypts the system disk.
  • false: does not encrypt the system disk. Default value: false.

SystemDiskKmsKeyIdOptional

public object SystemDiskKmsKeyId { get; set; }
  • Type: object

Property systemDiskKmsKeyId: The ID of the KMS key to use for the system disk.


SystemDiskProvisionedIopsOptional

public object SystemDiskProvisionedIops { get; set; }
  • Type: object

Property systemDiskProvisionedIops: Provisioning IOPS.


SystemDiskStorageClusterIdOptional

public object SystemDiskStorageClusterId { get; set; }
  • Type: object

Property systemDiskStorageClusterId: The ID of the dedicated block storage cluster.

If you want to use disks in a dedicated block storage cluster as system disks when you create instances, you must specify this parameter.


TagsOptional

public TagsProperty[] Tags { get; set; }

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.


UniqueSuffixOptional

public object UniqueSuffix { get; set; }
  • Type: object

Property uniqueSuffix: Specifies whether to automatically append incremental suffixes to the hostname specified by the HostName parameter and to the instance name specified by the InstanceName parameter when you batch create instances.

The incremental suffixes can range from 001 to 999. Valid values:

  • true: appends incremental suffixes to the hostname and the instance name.
  • false: does not append incremental suffixes to the hostname or the instance name. Default value: false. When the HostName or InstanceName value is set in the name_prefix[begin_number,bits] format without a suffix (name_suffix), the UniqueSuffix parameter does not take effect. The names are sorted in the specified sequence.

UpdatePolicyOptional

public object UpdatePolicy { get; set; }
  • Type: object

Property updatePolicy: Specify the policy at update.

The value can be 'ForNewInstances' or 'ForAllInstances'. If UpdatePolicy is 'ForAllInstance', The updatable parameters are InstanceType, ImageId, SystemDiskSize, SystemDiskCategory, Password, UserData,InternetChargeType, InternetMaxBandwidthOut, InternetMaxBandwidthIn. The default is 'ForNewInstances'


ZoneIdOptional

public object ZoneId { get; set; }
  • Type: object

Property zoneId: The ID of the zone to which the instance belongs.

For more information, call the DescribeZones operation to query the most recent zone list. Default value is empty, which means random selection.