Skip to content

InstanceGroupProps

Properties for defining a InstanceGroup.

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

Initializer 

using AlibabaCloud.SDK.ROS.CDK.Ecs;
new InstanceGroupProps {
    object InstanceType,
    object MaxAmount,
    object Affinity = null,
    object AllocatePublicIp = null,
    object AutoReleaseTime = null,
    object AutoRenew = null,
    object AutoRenewPeriod = null,
    object CpuOptions = null,
    object CreditSpecification = null,
    object DedicatedHostId = null,
    object DeletionForce = null,
    object DeletionProtection = null,
    object DeploymentSetGroupNo = null,
    object DeploymentSetId = null,
    object Description = null,
    object DiskMappings = null,
    object EniMappings = null,
    object HostName = null,
    object HostNames = null,
    object HpcClusterId = null,
    object HttpEndpoint = null,
    object HttpTokens = null,
    object ImageFamily = null,
    object ImageId = null,
    object ImageOptions = null,
    object InstanceChargeType = null,
    object InstanceName = null,
    object InternetChargeType = null,
    object InternetMaxBandwidthOut = null,
    object IoOptimized = null,
    object Ipv6AddressCount = null,
    object Ipv6Addresses = null,
    object KeyPairName = null,
    object LaunchTemplateId = null,
    object LaunchTemplateName = null,
    object LaunchTemplateVersion = null,
    object NetworkInterfaceQueueNumber = null,
    object NetworkOptions = null,
    object NetworkType = null,
    object Password = null,
    object PasswordInherit = null,
    object Period = null,
    object PeriodUnit = null,
    object PrivateIpAddress = null,
    object PrivatePoolOptions = null,
    object RamRoleName = null,
    object ResourceGroupId = null,
    object SchedulerOptions = null,
    object SecurityEnhancementStrategy = null,
    object SecurityGroupId = null,
    object SecurityGroupIds = null,
    object SecurityOptions = null,
    object SpotDuration = null,
    object SpotInterruptionBehavior = null,
    object SpotPriceLimit = null,
    object SpotStrategy = null,
    object StorageSetId = null,
    object StorageSetPartitionNumber = 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 SystemDiskPerformanceLevel = null,
    object SystemDiskProvisionedIops = null,
    object SystemDiskSize = null,
    object SystemDiskStorageClusterId = null,
    TagsProperty[] Tags = null,
    object Tenancy = null,
    object UniqueSuffix = null,
    object UpdatePolicy = null,
    object UseAdditionalService = null,
    object UserData = null,
    object VpcId = null,
    object VSwitchId = null,
    object ZoneId = null,
    object ZoneIds = null
};

Properties

Name Type Description
InstanceType object Property instanceType: Ecs instance supported instance type, make sure it should be correct.
MaxAmount object Property maxAmount: Max number of instances to create, should be bigger than 'MinAmount' and smaller than 1000.
Affinity object Property affinity: Specifies whether to associate the instance on a dedicated host with the dedicated host.
AllocatePublicIp object Property allocatePublicIp: The public ip for ecs instance, if properties is true, will allocate public ip.
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.
CpuOptions object Property cpuOptions: Cpu options.
CreditSpecification object Property creditSpecification: The performance mode of the burstable instance.
DedicatedHostId object Property dedicatedHostId: which dedicated host will be deployed.
DeletionForce object Property deletionForce: Whether force delete the instance.
DeletionProtection object Property deletionProtection: Whether an instance can be released manually through the console or API, deletion protection only support postPaid instance.
DeploymentSetGroupNo object Property deploymentSetGroupNo: The number of the deployment set group to which to deploy the 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.
HostName object Property hostName: Host name of created ecs 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.
HttpEndpoint object Property httpEndpoint: Specifies whether the access channel is enabled for instance metadata.
HttpTokens object Property httpTokens: Specifies whether the security hardening mode (IMDSv2) is forcefully used to access instance metadata.
ImageFamily object Property imageFamily: The name of the image family.
ImageId object Property imageId: Image ID to create ecs instance.
ImageOptions object Property imageOptions: Image options.
InstanceChargeType object Property instanceChargeType: Instance Charge type, allowed value: Prepaid and Postpaid.
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.
InternetChargeType object Property internetChargeType: Instance internet access charge type.Support 'PayByBandwidth' and 'PayByTraffic' only. Default is PayByTraffic.
InternetMaxBandwidthOut object Property internetMaxBandwidthOut: Set internet output bandwidth of instance.
IoOptimized object Property ioOptimized: The 'optimized' instance can provide better IO performance.
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.
NetworkInterfaceQueueNumber object Property networkInterfaceQueueNumber: The number of queues supported by the primary ENI.
NetworkOptions object Property networkOptions: Network options.
NetworkType object Property networkType: Instance network type.
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.
PrivateIpAddress object Property privateIpAddress: Private IP for the instance created.
PrivatePoolOptions object Property privatePoolOptions: The options of the private pool.
RamRoleName object Property ramRoleName: Instance RAM role name.
ResourceGroupId object Property resourceGroupId: Resource group id.
SchedulerOptions object Property schedulerOptions: undefined.
SecurityEnhancementStrategy object Property securityEnhancementStrategy:.
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.
SpotDuration object Property spotDuration: The protection period of the preemptible instance.
SpotInterruptionBehavior object Property spotInterruptionBehavior: The interruption mode of the preemptible instance.
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.
StorageSetId object Property storageSetId: The storage set ID.
StorageSetPartitionNumber object Property storageSetPartitionNumber: The maximum number of partitions in the storage set.
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.
SystemDiskPerformanceLevel object 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 object Property systemDiskProvisionedIops: Provisioning IOPS.
SystemDiskSize object Property systemDiskSize: Disk size of the system disk, range from 20 to 500 GB.
SystemDiskStorageClusterId object Property systemDiskStorageClusterId: The ID of the dedicated block storage cluster.
Tags TagsProperty[] Property tags: Tags to attach to instance.
Tenancy object Property tenancy: Specifies whether to create the instance on a dedicated host.
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.
UseAdditionalService object Property useAdditionalService: Specifies whether to use the system configurations for virtual machines provided by Alibaba Cloud.
UserData object Property userData: User data to pass to instance.
VpcId object Property vpcId: The VPC id to create ecs instance.
VSwitchId object Property vSwitchId: The vSwitch Id to create ecs instance.
ZoneId object Property zoneId: The ID of the zone to which the instance belongs.
ZoneIds object Property zoneIds: Zone ids for query parameters.

InstanceTypeRequired 

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

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

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.

AffinityOptional 

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

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 object AllocatePublicIp { get; set; }
  • Type: object

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 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.

CpuOptionsOptional 

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

Property cpuOptions: Cpu options.

CreditSpecificationOptional 

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

Property creditSpecification: The performance mode of the burstable instance.

Valid values:

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

DedicatedHostIdOptional 

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

Property dedicatedHostId: which dedicated host will be deployed.

DeletionForceOptional 

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

Property deletionForce: Whether force delete the instance.

Default value is false.

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.

DeploymentSetGroupNoOptional 

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

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 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.

HostNameOptional 

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

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 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.

HttpEndpointOptional 

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

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

Valid values:

  • enabled
  • disabled Default value: enabled.

HttpTokensOptional 

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

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 object ImageFamily { get; set; }
  • Type: object

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 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.

InstanceChargeTypeOptional 

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

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 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.

InternetChargeTypeOptional 

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

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

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.

IoOptimizedOptional 

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

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

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

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.

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.

NetworkTypeOptional 

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

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 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.

PrivateIpAddressOptional 

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

Property privateIpAddress: Private IP for the instance created.

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

PrivatePoolOptionsOptional 

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

Property privatePoolOptions: The options of the private pool.

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.

SchedulerOptionsOptional 

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

Property schedulerOptions: undefined.

SecurityEnhancementStrategyOptional 

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

Property securityEnhancementStrategy:.

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.

SpotDurationOptional 

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

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 object SpotInterruptionBehavior { get; set; }
  • Type: object

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 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.

StorageSetIdOptional 

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

Property storageSetId: The storage set ID.

StorageSetPartitionNumberOptional 

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

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

The value must be greater than or equal to 2.

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.

SystemDiskPerformanceLevelOptional 

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

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 object SystemDiskProvisionedIops { get; set; }
  • Type: object

Property systemDiskProvisionedIops: Provisioning IOPS.

SystemDiskSizeOptional 

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

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 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.

TenancyOptional 

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

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 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'

UseAdditionalServiceOptional 

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

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 object UserData { get; set; }
  • Type: object

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 object VpcId { get; set; }
  • Type: object

Property vpcId: The VPC id to create ecs instance.

VSwitchIdOptional 

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

Property vSwitchId: The vSwitch Id to create ecs instance.

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.

ZoneIdsOptional 

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

Property zoneIds: Zone ids for query parameters.