Skip to content

InstanceGroupProps

Properties for defining a InstanceGroup.

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

Initializer

import com.aliyun.ros.cdk.ecs.InstanceGroupProps;
InstanceGroupProps.builder()
    .instanceType(java.lang.String)
    .instanceType(IResolvable)
    .maxAmount(java.lang.Number)
    .maxAmount(IResolvable)
//  .affinity(java.lang.String)
//  .affinity(IResolvable)
//  .allocatePublicIp(java.lang.Boolean)
//  .allocatePublicIp(IResolvable)
//  .autoReleaseTime(java.lang.String)
//  .autoReleaseTime(IResolvable)
//  .autoRenew(java.lang.String)
//  .autoRenew(IResolvable)
//  .autoRenewPeriod(java.lang.Number)
//  .autoRenewPeriod(IResolvable)
//  .cpuOptions(IResolvable)
//  .cpuOptions(CpuOptionsProperty)
//  .creditSpecification(java.lang.String)
//  .creditSpecification(IResolvable)
//  .dedicatedHostId(java.lang.String)
//  .dedicatedHostId(IResolvable)
//  .deletionForce(java.lang.Boolean)
//  .deletionForce(IResolvable)
//  .deletionProtection(java.lang.Boolean)
//  .deletionProtection(IResolvable)
//  .deploymentSetGroupNo(java.lang.Number)
//  .deploymentSetGroupNo(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>)
//  .hostName(java.lang.String)
//  .hostName(IResolvable)
//  .hostNames(IResolvable)
//  .hostNames(java.util.List<java.lang.String)
//  .hostNames(IResolvable>)
//  .hpcClusterId(java.lang.String)
//  .hpcClusterId(IResolvable)
//  .httpEndpoint(java.lang.String)
//  .httpEndpoint(IResolvable)
//  .httpTokens(java.lang.String)
//  .httpTokens(IResolvable)
//  .imageFamily(java.lang.String)
//  .imageFamily(IResolvable)
//  .imageId(java.lang.String)
//  .imageId(IResolvable)
//  .imageOptions(IResolvable)
//  .imageOptions(ImageOptionsProperty)
//  .instanceChargeType(java.lang.String)
//  .instanceChargeType(IResolvable)
//  .instanceName(java.lang.String)
//  .instanceName(IResolvable)
//  .internetChargeType(java.lang.String)
//  .internetChargeType(IResolvable)
//  .internetMaxBandwidthOut(java.lang.Number)
//  .internetMaxBandwidthOut(IResolvable)
//  .ioOptimized(java.lang.String)
//  .ioOptimized(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)
//  .networkInterfaceQueueNumber(java.lang.Number)
//  .networkInterfaceQueueNumber(IResolvable)
//  .networkOptions(IResolvable)
//  .networkOptions(NetworkOptionsProperty)
//  .networkType(java.lang.String)
//  .networkType(IResolvable)
//  .password(java.lang.String)
//  .password(IResolvable)
//  .passwordInherit(java.lang.Boolean)
//  .passwordInherit(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .periodUnit(java.lang.String)
//  .periodUnit(IResolvable)
//  .privateIpAddress(java.lang.String)
//  .privateIpAddress(IResolvable)
//  .privatePoolOptions(IResolvable)
//  .privatePoolOptions(PrivatePoolOptionsProperty)
//  .ramRoleName(java.lang.String)
//  .ramRoleName(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .schedulerOptions(IResolvable)
//  .schedulerOptions(SchedulerOptionsProperty)
//  .securityEnhancementStrategy(java.lang.String)
//  .securityEnhancementStrategy(IResolvable)
//  .securityGroupId(java.lang.String)
//  .securityGroupId(IResolvable)
//  .securityGroupIds(IResolvable)
//  .securityGroupIds(java.util.List<java.lang.String)
//  .securityGroupIds(IResolvable>)
//  .securityOptions(IResolvable)
//  .securityOptions(SecurityOptionsProperty)
//  .spotDuration(java.lang.Number)
//  .spotDuration(IResolvable)
//  .spotInterruptionBehavior(java.lang.String)
//  .spotInterruptionBehavior(IResolvable)
//  .spotPriceLimit(java.lang.String)
//  .spotPriceLimit(IResolvable)
//  .spotStrategy(java.lang.String)
//  .spotStrategy(IResolvable)
//  .storageSetId(java.lang.String)
//  .storageSetId(IResolvable)
//  .storageSetPartitionNumber(java.lang.Number)
//  .storageSetPartitionNumber(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)
//  .systemDiskPerformanceLevel(java.lang.String)
//  .systemDiskPerformanceLevel(IResolvable)
//  .systemDiskProvisionedIops(java.lang.Number)
//  .systemDiskProvisionedIops(IResolvable)
//  .systemDiskSize(java.lang.Number)
//  .systemDiskSize(IResolvable)
//  .systemDiskStorageClusterId(java.lang.String)
//  .systemDiskStorageClusterId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .tenancy(java.lang.String)
//  .tenancy(IResolvable)
//  .uniqueSuffix(java.lang.Boolean)
//  .uniqueSuffix(IResolvable)
//  .updatePolicy(java.lang.String)
//  .updatePolicy(IResolvable)
//  .useAdditionalService(java.lang.Boolean)
//  .useAdditionalService(IResolvable)
//  .userData(java.lang.String)
//  .userData(IResolvable)
//  .vpcId(java.lang.String)
//  .vpcId(IResolvable)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(IResolvable)
//  .zoneId(java.lang.String)
//  .zoneId(IResolvable)
//  .zoneIds(IResolvable)
//  .zoneIds(java.util.List<java.lang.String)
//  .zoneIds(IResolvable>)
    .build();

Properties

Name Type Description
instanceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceType: Ecs instance supported instance type, make sure it should be correct.
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.
affinity java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property affinity: Specifies whether to associate the instance on a dedicated host with the dedicated host.
allocatePublicIp java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property allocatePublicIp: The public ip for ecs instance, if properties is true, will allocate public ip.
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.
cpuOptions com.aliyun.ros.cdk.core.IResolvable OR CpuOptionsProperty Property cpuOptions: Cpu options.
creditSpecification java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property creditSpecification: The performance mode of the burstable instance.
dedicatedHostId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dedicatedHostId: which dedicated host will be deployed.
deletionForce java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property deletionForce: Whether force delete the instance.
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.
deploymentSetGroupNo java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property deploymentSetGroupNo: The number of the deployment set group to which to deploy the 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.
hostName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property hostName: Host name of created ecs 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.
httpEndpoint java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property httpEndpoint: Specifies whether the access channel is enabled for instance metadata.
httpTokens java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property httpTokens: Specifies whether the security hardening mode (IMDSv2) is forcefully used to access instance metadata.
imageFamily java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property imageFamily: The name of the image family.
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.
instanceChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceChargeType: Instance Charge type, allowed value: Prepaid and Postpaid.
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.
internetChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property internetChargeType: Instance internet access charge type.Support 'PayByBandwidth' and 'PayByTraffic' only. Default is PayByTraffic.
internetMaxBandwidthOut java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property internetMaxBandwidthOut: Set internet output bandwidth of instance.
ioOptimized java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ioOptimized: The 'optimized' instance can provide better IO performance.
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.
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.
networkType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property networkType: Instance network type.
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.
privateIpAddress java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property privateIpAddress: Private IP for the instance created.
privatePoolOptions com.aliyun.ros.cdk.core.IResolvable OR PrivatePoolOptionsProperty Property privatePoolOptions: The options of the private pool.
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.
schedulerOptions com.aliyun.ros.cdk.core.IResolvable OR SchedulerOptionsProperty Property schedulerOptions: undefined.
securityEnhancementStrategy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property securityEnhancementStrategy:.
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.
spotDuration java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property spotDuration: The protection period of the preemptible instance.
spotInterruptionBehavior java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property spotInterruptionBehavior: The interruption mode of the preemptible instance.
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.
storageSetId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property storageSetId: The storage set ID.
storageSetPartitionNumber java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property storageSetPartitionNumber: The maximum number of partitions in the storage set.
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.
systemDiskPerformanceLevel java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property systemDiskPerformanceLevel: The performance level of the enhanced SSD used as the system disk.Default value: PL1. Valid values:PL0: A single enhanced SSD delivers up to 10,000 random read\/write IOPS.PL1: A single enhanced SSD delivers up to 50,000 random read\/write IOPS.PL2: A single enhanced SSD delivers up to 100,000 random read\/write IOPS.PL3: A single enhanced SSD delivers up to 1,000,000 random read\/write IOPS.
systemDiskProvisionedIops java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property systemDiskProvisionedIops: Provisioning IOPS.
systemDiskSize java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property systemDiskSize: Disk size of the system disk, range from 20 to 500 GB.
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.
tenancy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property tenancy: Specifies whether to create the instance on a dedicated host.
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.
useAdditionalService java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property useAdditionalService: Specifies whether to use the system configurations for virtual machines provided by Alibaba Cloud.
userData java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property userData: User data to pass to instance.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: The VPC id to create ecs instance.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: The vSwitch Id to create ecs instance.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: The ID of the zone to which the instance belongs.
zoneIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property zoneIds: Zone ids for query parameters.

instanceTypeRequired

public java.lang.Object getInstanceType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceType: Ecs instance supported instance type, make sure it should be correct.


maxAmountRequired

public java.lang.Object getMaxAmount();
  • 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.


affinityOptional

public java.lang.Object getAffinity();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property affinity: Specifies whether to associate the instance on a dedicated host with the dedicated host.

Valid values:

  • default: does not associate the ECS instance with the dedicated host. When you start an instance that was stopped in economical mode, the instance is automatically deployed to another dedicated host in the automatic deployment resource pool if the available resources of the original dedicated host are insufficient.
  • host: associates the ECS instance with the dedicated host. When you start an instance that was stopped in economical mode, the instance remains on the original dedicated host. If the available resources of the original dedicated host are insufficient, the instance cannot start. Default value: default.

allocatePublicIpOptional

public java.lang.Object getAllocatePublicIp();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property allocatePublicIp: The public ip for ecs instance, if properties is true, will allocate public ip.

If property InternetMaxBandwidthOut set to 0, it will not assign public ip.


autoReleaseTimeOptional

public java.lang.Object getAutoReleaseTime();
  • 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

public java.lang.Object getAutoRenew();
  • 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

public java.lang.Object getAutoRenewPeriod();
  • 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.


cpuOptionsOptional

public java.lang.Object getCpuOptions();

Property cpuOptions: Cpu options.


creditSpecificationOptional

public java.lang.Object getCreditSpecification();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property creditSpecification: The performance mode of the burstable instance.

Valid values:

  • Standard: the standard mode.
  • Unlimited: the unlimited mode.

dedicatedHostIdOptional

public java.lang.Object getDedicatedHostId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dedicatedHostId: which dedicated host will be deployed.


deletionForceOptional

public java.lang.Object getDeletionForce();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property deletionForce: Whether force delete the instance.

Default value is false.


deletionProtectionOptional

public java.lang.Object getDeletionProtection();
  • 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.


deploymentSetGroupNoOptional

public java.lang.Object getDeploymentSetGroupNo();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property deploymentSetGroupNo: The number of the deployment set group to which to deploy the instance.

If the deployment set specified by DeploymentSetId uses the high availability group strategy (AvailabilityGroup), you can use DeploymentSetGroupNo to specify a deployment set group in the deployment set. Valid values: 1 to 7.


deploymentSetIdOptional

public java.lang.Object getDeploymentSetId();
  • 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

public java.lang.Object getDescription();
  • 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

public java.lang.Object getDiskMappings();
  • 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

public java.lang.Object getEniMappings();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListEniMappingsProperty>

Property eniMappings: NetworkInterface to attach to instance.

Max support 2 ENIs.


hostNameOptional

public java.lang.Object getHostName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property hostName: Host name of created ecs instance.

at least 2 characters, and '.' '-' Is not the first and last characters as hostname, not continuous use. Windows platform can be up to 15 characters, allowing letters (without limiting case), numbers and '-', and does not support the number of points, not all is digital ('.').Other (Linux, etc.) platform up to 64 characters, allowing support number multiple points for the period between the points, each permit letters (without limiting case), numbers and '-' components. Support to use the regular expression to set the different instance name for each ECS instance. HostName could be specified as 'name_prefix[begin_number,bits]name_suffix', such as 'host[123,4]tail'. If you creates 3 instances with hostname 'host[123,4]tail', all the host names of instances are host0123tail, host0124tail, host0125tail. 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. The host name is specified by regular expression works after restart instance manually.

hostNamesOptional

public java.lang.Object getHostNames();
  • 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

public java.lang.Object getHpcClusterId();
  • 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.


httpEndpointOptional

public java.lang.Object getHttpEndpoint();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property httpEndpoint: Specifies whether the access channel is enabled for instance metadata.

Valid values:

  • enabled
  • disabled Default value: enabled.

httpTokensOptional

public java.lang.Object getHttpTokens();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property httpTokens: Specifies whether the security hardening mode (IMDSv2) is forcefully used to access instance metadata.

Valid values:

  • optional: does not forcefully use the security-enhanced mode (IMDSv2).
  • required: forcefully uses the security-enhanced mode (IMDSv2). After you set this parameter to required, you cannot access instance metadata in normal mode. Default value: optional.

imageFamilyOptional

public java.lang.Object getImageFamily();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property imageFamily: The name of the image family.

You can set this parameter to obtain the latest available custom image from the specified image family to create the instance.

  • ImageFamily must be empty if ImageId is specified.
  • ImageFamily can be specified if ImageId is not specified.

imageIdOptional

public java.lang.Object getImageId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property imageId: Image ID to create ecs instance.


imageOptionsOptional

public java.lang.Object getImageOptions();

Property imageOptions: Image options.


instanceChargeTypeOptional

public java.lang.Object getInstanceChargeType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceChargeType: Instance Charge type, allowed value: Prepaid and Postpaid.

If specified Prepaid, please ensure you have sufficient balance in your account. Or instance creation will be failure. Default value is Postpaid.Old instances will not be changed.


instanceNameOptional

public java.lang.Object getInstanceName();
  • 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.


internetChargeTypeOptional

public java.lang.Object getInternetChargeType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property internetChargeType: Instance internet access charge type.Support 'PayByBandwidth' and 'PayByTraffic' only. Default is PayByTraffic.


internetMaxBandwidthOutOptional

public java.lang.Object getInternetMaxBandwidthOut();
  • 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.


ioOptimizedOptional

public java.lang.Object getIoOptimized();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property ioOptimized: The 'optimized' instance can provide better IO performance.

Support 'none' and 'optimized' only, default is 'optimized'.


ipv6AddressCountOptional

public java.lang.Object getIpv6AddressCount();
  • 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

public java.lang.Object getIpv6Addresses();
  • 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

public java.lang.Object getKeyPairName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


launchTemplateIdOptional

public java.lang.Object getLaunchTemplateId();
  • 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

public java.lang.Object getLaunchTemplateName();
  • 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

public java.lang.Object getLaunchTemplateVersion();
  • 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.


networkInterfaceQueueNumberOptional

public java.lang.Object getNetworkInterfaceQueueNumber();
  • 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

public java.lang.Object getNetworkOptions();

Property networkOptions: Network options.


networkTypeOptional

public java.lang.Object getNetworkType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property networkType: Instance network type.

Support 'vpc' and 'classic', for compatible reason, default is 'classic'. If vswitch id and vpc id is specified, the property will be forced to be set to 'vpc'


passwordOptional

public java.lang.Object getPassword();
  • 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

public java.lang.Object getPasswordInherit();
  • 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

public java.lang.Object getPeriod();
  • 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

public java.lang.Object getPeriodUnit();
  • 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.


privateIpAddressOptional

public java.lang.Object getPrivateIpAddress();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property privateIpAddress: Private IP for the instance created.

Only works for VPC instance and cannot duplicated with existing instance.


privatePoolOptionsOptional

public java.lang.Object getPrivatePoolOptions();

Property privatePoolOptions: The options of the private pool.


ramRoleNameOptional

public java.lang.Object getRamRoleName();
  • 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

public java.lang.Object getResourceGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: Resource group id.


schedulerOptionsOptional

public java.lang.Object getSchedulerOptions();

Property schedulerOptions: undefined.


securityEnhancementStrategyOptional

public java.lang.Object getSecurityEnhancementStrategy();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property securityEnhancementStrategy:.


securityGroupIdOptional

public java.lang.Object getSecurityGroupId();
  • 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

public java.lang.Object getSecurityGroupIds();
  • 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

public java.lang.Object getSecurityOptions();

Property securityOptions: Security options.


spotDurationOptional

public java.lang.Object getSpotDuration();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property spotDuration: The protection period of the preemptible instance.

Unit: hours. Valid values: 0, 1, 2, 3, 4, 5, and 6. Protection periods of 2, 3, 4, 5, and 6 hours are in invitational preview. If you want to set this parameter to one of these values, submit a ticket. If this parameter is set to 0, no protection period is configured for the preemptible instance. Default value: 1.


spotInterruptionBehaviorOptional

public java.lang.Object getSpotInterruptionBehavior();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property spotInterruptionBehavior: The interruption mode of the preemptible instance.

Default value: Terminate. Set the value to Terminate, which specifies to release the instance.


spotPriceLimitOptional

public java.lang.Object getSpotPriceLimit();
  • 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

public java.lang.Object getSpotStrategy();
  • 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.


storageSetIdOptional

public java.lang.Object getStorageSetId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property storageSetId: The storage set ID.


storageSetPartitionNumberOptional

public java.lang.Object getStorageSetPartitionNumber();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property storageSetPartitionNumber: The maximum number of partitions in the storage set.

The value must be greater than or equal to 2.


systemDiskAutoSnapshotPolicyIdOptional

public java.lang.Object getSystemDiskAutoSnapshotPolicyId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property systemDiskAutoSnapshotPolicyId: Auto snapshot policy ID.


systemDiskBurstingEnabledOptional

public java.lang.Object getSystemDiskBurstingEnabled();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property systemDiskBurstingEnabled: Whether enable bursting.


systemDiskCategoryOptional

public java.lang.Object getSystemDiskCategory();
  • 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

public java.lang.Object getSystemDiskDescription();
  • 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

public java.lang.Object getSystemDiskDiskName();
  • 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

public java.lang.Object getSystemDiskEncryptAlgorithm();
  • 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

public java.lang.Object getSystemDiskEncrypted();
  • 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

public java.lang.Object getSystemDiskKmsKeyId();
  • 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.


systemDiskPerformanceLevelOptional

public java.lang.Object getSystemDiskPerformanceLevel();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property systemDiskPerformanceLevel: The performance level of the enhanced SSD used as the system disk.Default value: PL1. Valid values:PL0: A single enhanced SSD delivers up to 10,000 random read\/write IOPS.PL1: A single enhanced SSD delivers up to 50,000 random read\/write IOPS.PL2: A single enhanced SSD delivers up to 100,000 random read\/write IOPS.PL3: A single enhanced SSD delivers up to 1,000,000 random read\/write IOPS.


systemDiskProvisionedIopsOptional

public java.lang.Object getSystemDiskProvisionedIops();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property systemDiskProvisionedIops: Provisioning IOPS.


systemDiskSizeOptional

public java.lang.Object getSystemDiskSize();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property systemDiskSize: Disk size of the system disk, range from 20 to 500 GB.

If you specify with your own image, make sure the system disk size bigger than image size.


systemDiskStorageClusterIdOptional

public java.lang.Object getSystemDiskStorageClusterId();
  • 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

public java.util.List<TagsProperty> getTags();

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.


tenancyOptional

public java.lang.Object getTenancy();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property tenancy: Specifies whether to create the instance on a dedicated host.

Valid values:

  • default: creates the instance on a non-dedicated host.
  • host: creates the instance on a dedicated host. If you do not specify DedicatedHostId, Alibaba Cloud selects a dedicated host for the instance. Default value: default.

uniqueSuffixOptional

public java.lang.Object getUniqueSuffix();
  • 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

public java.lang.Object getUpdatePolicy();
  • 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'


useAdditionalServiceOptional

public java.lang.Object getUseAdditionalService();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property useAdditionalService: Specifies whether to use the system configurations for virtual machines provided by Alibaba Cloud.

System configurations for Windows: NTP and KMS. System configurations for Linux: NTP and YUM.


userDataOptional

public java.lang.Object getUserData();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property userData: User data to pass to instance.

[1, 16KB] characters.User data should not be base64 encoded. If you want to pass base64 encoded string to the property, use function Fn::Base64Decode to decode the base64 string first.


vpcIdOptional

public java.lang.Object getVpcId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vpcId: The VPC id to create ecs instance.


vSwitchIdOptional

public java.lang.Object getVSwitchId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vSwitchId: The vSwitch Id to create ecs instance.


zoneIdOptional

public java.lang.Object getZoneId();
  • 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.


zoneIdsOptional

public java.lang.Object getZoneIds();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property zoneIds: Zone ids for query parameters.