Skip to content

InstanceGroupClone

This class encapsulates and extends the ROS resource type ALIYUN::ECS::InstanceGroupClone, which is used to create clones of an Elastic Compute Service (ECS) instance.

Initializers 

import com.aliyun.ros.cdk.ecs.InstanceGroupClone;
InstanceGroupClone.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .maxAmount(java.lang.Number)
    .maxAmount(IResolvable)
    .sourceInstanceId(java.lang.String)
    .sourceInstanceId(IResolvable)
//  .autoReleaseTime(java.lang.String)
//  .autoReleaseTime(IResolvable)
//  .autoRenew(java.lang.String)
//  .autoRenew(IResolvable)
//  .autoRenewPeriod(java.lang.Number)
//  .autoRenewPeriod(IResolvable)
//  .backendServerWeight(java.lang.Number)
//  .backendServerWeight(IResolvable)
//  .cpuOptions(IResolvable)
//  .cpuOptions(CpuOptionsProperty)
//  .deletionProtection(java.lang.Boolean)
//  .deletionProtection(IResolvable)
//  .deploymentSetId(java.lang.String)
//  .deploymentSetId(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .diskMappings(IResolvable)
//  .diskMappings(java.util.List<IResolvable)
//  .diskMappings(DiskMappingsProperty>)
//  .eniMappings(IResolvable)
//  .eniMappings(java.util.List<IResolvable)
//  .eniMappings(EniMappingsProperty>)
//  .hostNames(IResolvable)
//  .hostNames(java.util.List<java.lang.String)
//  .hostNames(IResolvable>)
//  .hpcClusterId(java.lang.String)
//  .hpcClusterId(IResolvable)
//  .imageId(java.lang.String)
//  .imageId(IResolvable)
//  .imageOptions(IResolvable)
//  .imageOptions(ImageOptionsProperty)
//  .instanceName(java.lang.String)
//  .instanceName(IResolvable)
//  .internetMaxBandwidthIn(java.lang.Number)
//  .internetMaxBandwidthIn(IResolvable)
//  .internetMaxBandwidthOut(java.lang.Number)
//  .internetMaxBandwidthOut(IResolvable)
//  .ipv6AddressCount(java.lang.Number)
//  .ipv6AddressCount(IResolvable)
//  .ipv6Addresses(java.util.List<java.lang.Object>)
//  .ipv6Addresses(IResolvable)
//  .keyPairName(java.lang.String)
//  .keyPairName(IResolvable)
//  .launchTemplateId(java.lang.String)
//  .launchTemplateId(IResolvable)
//  .launchTemplateName(java.lang.String)
//  .launchTemplateName(IResolvable)
//  .launchTemplateVersion(java.lang.String)
//  .launchTemplateVersion(IResolvable)
//  .loadBalancerIdToAttach(java.lang.String)
//  .loadBalancerIdToAttach(IResolvable)
//  .networkInterfaceQueueNumber(java.lang.Number)
//  .networkInterfaceQueueNumber(IResolvable)
//  .networkOptions(IResolvable)
//  .networkOptions(NetworkOptionsProperty)
//  .password(java.lang.String)
//  .password(IResolvable)
//  .passwordInherit(java.lang.Boolean)
//  .passwordInherit(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .periodUnit(java.lang.String)
//  .periodUnit(IResolvable)
//  .ramRoleName(java.lang.String)
//  .ramRoleName(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .securityGroupId(java.lang.String)
//  .securityGroupId(IResolvable)
//  .securityGroupIds(IResolvable)
//  .securityGroupIds(java.util.List<java.lang.String)
//  .securityGroupIds(IResolvable>)
//  .securityOptions(IResolvable)
//  .securityOptions(SecurityOptionsProperty)
//  .spotPriceLimit(java.lang.String)
//  .spotPriceLimit(IResolvable)
//  .spotStrategy(java.lang.String)
//  .spotStrategy(IResolvable)
//  .systemDiskAutoSnapshotPolicyId(java.lang.String)
//  .systemDiskAutoSnapshotPolicyId(IResolvable)
//  .systemDiskBurstingEnabled(java.lang.Boolean)
//  .systemDiskBurstingEnabled(IResolvable)
//  .systemDiskCategory(java.lang.String)
//  .systemDiskCategory(IResolvable)
//  .systemDiskDescription(java.lang.String)
//  .systemDiskDescription(IResolvable)
//  .systemDiskDiskName(java.lang.String)
//  .systemDiskDiskName(IResolvable)
//  .systemDiskEncryptAlgorithm(java.lang.String)
//  .systemDiskEncryptAlgorithm(IResolvable)
//  .systemDiskEncrypted(java.lang.String)
//  .systemDiskEncrypted(IResolvable)
//  .systemDiskKmsKeyId(java.lang.String)
//  .systemDiskKmsKeyId(IResolvable)
//  .systemDiskProvisionedIops(java.lang.Number)
//  .systemDiskProvisionedIops(IResolvable)
//  .systemDiskStorageClusterId(java.lang.String)
//  .systemDiskStorageClusterId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .uniqueSuffix(java.lang.Boolean)
//  .uniqueSuffix(IResolvable)
//  .updatePolicy(java.lang.String)
//  .updatePolicy(IResolvable)
//  .zoneId(java.lang.String)
//  .zoneId(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
maxAmount java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property maxAmount: Max number of instances to create, should be bigger than 'MinAmount' and smaller than 1000.
sourceInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property sourceInstanceId: Source ecs instance used to copy properties to clone new ecs instance.
autoReleaseTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property autoReleaseTime: Auto release time for created instance, Follow ISO8601 standard using UTC time.
autoRenew java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property autoRenew: Whether renew the fee automatically?
autoRenewPeriod java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property autoRenewPeriod: The time period of auto renew.
backendServerWeight java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property backendServerWeight: The weight of backend server of load balancer.
cpuOptions com.aliyun.ros.cdk.core.IResolvable OR CpuOptionsProperty Property cpuOptions: Cpu options.
deletionProtection java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property deletionProtection: Whether an instance can be released manually through the console or API, deletion protection only support postPaid instance.
deploymentSetId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property deploymentSetId: Deployment set ID.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: Description of the instance, [2, 256] characters.
diskMappings com.aliyun.ros.cdk.core.IResolvable OR java.util.ListDiskMappingsProperty> Property diskMappings: Disk mappings to attach to instance.
eniMappings com.aliyun.ros.cdk.core.IResolvable OR java.util.ListEniMappingsProperty> Property eniMappings: NetworkInterface to attach to instance.
hostNames com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property hostNames: The hostname of instance N.
hpcClusterId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property hpcClusterId: The HPC cluster ID to which the instance belongs.The change of the property does not affect existing instances.
imageId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property imageId: Image ID to create ecs instance.
imageOptions com.aliyun.ros.cdk.core.IResolvable OR ImageOptionsProperty Property imageOptions: Image options.
instanceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable 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 java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property internetMaxBandwidthIn: Max internet out band width setting, unit in Mbps(Mega bit per second).
internetMaxBandwidthOut java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property internetMaxBandwidthOut: Set internet output bandwidth of instance.
ipv6AddressCount java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property ipv6AddressCount: Specifies the number of randomly generated IPv6 addresses for the elastic NIC.
ipv6Addresses java.util.List OR com.aliyun.ros.cdk.core.IResolvable Property ipv6Addresses: Specify one or more IPv6 addresses for the elastic NIC.
keyPairName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property keyPairName: SSH key pair name.Old instances will not be changed.
launchTemplateId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property launchTemplateId: ID of launch template.
launchTemplateName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property launchTemplateName: Name of launch template.
launchTemplateVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property launchTemplateVersion: Version of launch template.
loadBalancerIdToAttach java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property loadBalancerIdToAttach: After the instance is created.
networkInterfaceQueueNumber java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property networkInterfaceQueueNumber: The number of queues supported by the primary ENI.
networkOptions com.aliyun.ros.cdk.core.IResolvable OR NetworkOptionsProperty Property networkOptions: Network options.
password java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property password: Password of created ecs instance.
passwordInherit java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property passwordInherit: Specifies whether to use the password preset in the image.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property period: Prepaid time period.
periodUnit java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property periodUnit: Unit of prepaid time period, it could be Week\/Month\/Year.
ramRoleName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ramRoleName: Instance RAM role name.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: Resource group id.
securityGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property securityGroupId: Security group to create ecs instance.
securityGroupIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property securityGroupIds: The IDs of security groups N to which the instance belongs.
securityOptions com.aliyun.ros.cdk.core.IResolvable OR SecurityOptionsProperty Property securityOptions: Security options.
spotPriceLimit java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property spotPriceLimit: The hourly price threshold of a instance, and it takes effect only when parameter InstanceChargeType is PostPaid.
spotStrategy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property spotStrategy: The spot strategy of a Pay-As-You-Go instance, and it takes effect only when parameter InstanceChargeType is PostPaid.
systemDiskAutoSnapshotPolicyId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property systemDiskAutoSnapshotPolicyId: Auto snapshot policy ID.
systemDiskBurstingEnabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property systemDiskBurstingEnabled: Whether enable bursting.
systemDiskCategory java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property systemDiskCategory: Category of system disk.
systemDiskDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property systemDiskDescription: Description of created system disk.Old instances will not be changed.
systemDiskDiskName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property systemDiskDiskName: Name of created system disk.Old instances will not be changed.
systemDiskEncryptAlgorithm java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property systemDiskEncryptAlgorithm: The algorithm to use to encrypt the system disk.
systemDiskEncrypted java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property systemDiskEncrypted: Specifies whether to encrypt the system disk.
systemDiskKmsKeyId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property systemDiskKmsKeyId: The ID of the KMS key to use for the system disk.
systemDiskProvisionedIops java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property systemDiskProvisionedIops: Provisioning IOPS.
systemDiskStorageClusterId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property systemDiskStorageClusterId: The ID of the dedicated block storage cluster.
tags java.util.List<TagsProperty> Property tags: Tags to attach to instance.
uniqueSuffix java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable 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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property updatePolicy: Specify the policy at update.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: The ID of the zone to which the instance belongs.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

maxAmountRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

sourceInstanceIdRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

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

cpuOptionsOptional

Property cpuOptions: Cpu options.

deletionProtectionOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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

deploymentSetIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property deploymentSetId: Deployment set ID.

The change of the property does not affect existing instances.

descriptionOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListDiskMappingsProperty>

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

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListEniMappingsProperty>

Property eniMappings: NetworkInterface to attach to instance.

Max support 2 ENIs.

hostNamesOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

imageIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property imageId: Image ID to create ecs instance.

imageOptionsOptional

Property imageOptions: Image options.

instanceNameOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

  • Type: java.util.List OR com.aliyun.ros.cdk.core.IResolvable

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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

launchTemplateIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property launchTemplateId: ID of launch template.

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

launchTemplateNameOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property launchTemplateName: Name of launch template.

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

launchTemplateVersionOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property launchTemplateVersion: Version of launch template.

Default version is used if version is not specified.

loadBalancerIdToAttachOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property loadBalancerIdToAttach: After the instance is created.

Automatic attach it to the load balancer.

networkInterfaceQueueNumberOptional

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

Property networkOptions: Network options.

passwordOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property password: Password of created ecs instance.

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

passwordInheritOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

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

ramRoleNameOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: Resource group id.

securityGroupIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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

Property securityOptions: Security options.

spotPriceLimitOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property systemDiskAutoSnapshotPolicyId: Auto snapshot policy ID.

systemDiskBurstingEnabledOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property systemDiskBurstingEnabled: Whether enable bursting.

systemDiskCategoryOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

systemDiskDiskNameOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

systemDiskEncryptAlgorithmOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Valid values:

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

systemDiskEncryptedOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

systemDiskProvisionedIopsOptional

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property systemDiskProvisionedIops: Provisioning IOPS.

systemDiskStorageClusterIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

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

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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.

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString 

public java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

import com.aliyun.ros.cdk.ecs.InstanceGroupClone;
InstanceGroupClone.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrHostNames com.aliyun.ros.cdk.core.IResolvable Attribute HostNames: Host names of created instances.
attrInnerIps com.aliyun.ros.cdk.core.IResolvable Attribute InnerIps: Inner IP address list of the specified instances.
attrInstanceIds com.aliyun.ros.cdk.core.IResolvable Attribute InstanceIds: The instance id list of created ecs instances.
attrIpv6Addresses com.aliyun.ros.cdk.core.IResolvable Attribute Ipv6Addresses: IPv6 addresses list of created ecs instances.
attrIpv6AddressIds com.aliyun.ros.cdk.core.IResolvable Attribute Ipv6AddressIds: IPv6 address IDs list of created ecs instances.
attrOrderId com.aliyun.ros.cdk.core.IResolvable Attribute OrderId: The order id list of created instance.
attrPrivateIps com.aliyun.ros.cdk.core.IResolvable Attribute PrivateIps: Private IP address list of created ecs instances.
attrPublicIps com.aliyun.ros.cdk.core.IResolvable Attribute PublicIps: Public IP address list of created ecs instances.
attrZoneIds com.aliyun.ros.cdk.core.IResolvable Attribute ZoneIds: Zone id of created instances.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrHostNamesRequired 

public IResolvable getAttrHostNames();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute HostNames: Host names of created instances.

attrInnerIpsRequired 

public IResolvable getAttrInnerIps();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InnerIps: Inner IP address list of the specified instances.

Only for classical instances.

attrInstanceIdsRequired 

public IResolvable getAttrInstanceIds();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceIds: The instance id list of created ecs instances.

attrIpv6AddressesRequired 

public IResolvable getAttrIpv6Addresses();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Ipv6Addresses: IPv6 addresses list of created ecs instances.

Note: The return type is a two-tier list. If the instance does not have any IPv6 address, the element at the corresponding position in the list is null. If all instances does not have any IPv address, will return null.

attrIpv6AddressIdsRequired 

public IResolvable getAttrIpv6AddressIds();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Ipv6AddressIds: IPv6 address IDs list of created ecs instances.

Note: The return type is a two-tier list.If the instance does not have any IPv6 address, the element at the corresponding position in the list is null. If all instances does not have any IPv address, will return null.

attrOrderIdRequired 

public IResolvable getAttrOrderId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute OrderId: The order id list of created instance.

attrPrivateIpsRequired 

public IResolvable getAttrPrivateIps();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PrivateIps: Private IP address list of created ecs instances.

Only for VPC instance.

attrPublicIpsRequired 

public IResolvable getAttrPublicIps();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PublicIps: Public IP address list of created ecs instances.

attrZoneIdsRequired 

public IResolvable getAttrZoneIds();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ZoneIds: Zone id of created instances.