Skip to content

InstanceGroupProps

Properties for defining a InstanceGroup.

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

Initializer 

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkecs"
&alicloudroscdkecs.InstanceGroupProps {
    InstanceType: interface{},
    MaxAmount: interface{},
    Affinity: interface{},
    AllocatePublicIp: interface{},
    AutoReleaseTime: interface{},
    AutoRenew: interface{},
    AutoRenewPeriod: interface{},
    CpuOptions: interface{},
    CreditSpecification: interface{},
    DedicatedHostId: interface{},
    DeletionForce: interface{},
    DeletionProtection: interface{},
    DeploymentSetGroupNo: interface{},
    DeploymentSetId: interface{},
    Description: interface{},
    DiskMappings: interface{},
    EniMappings: interface{},
    HostName: interface{},
    HostNames: interface{},
    HpcClusterId: interface{},
    HttpEndpoint: interface{},
    HttpTokens: interface{},
    ImageFamily: interface{},
    ImageId: interface{},
    ImageOptions: interface{},
    InstanceChargeType: interface{},
    InstanceName: interface{},
    InternetChargeType: interface{},
    InternetMaxBandwidthOut: interface{},
    IoOptimized: interface{},
    Ipv6AddressCount: interface{},
    Ipv6Addresses: interface{},
    KeyPairName: interface{},
    LaunchTemplateId: interface{},
    LaunchTemplateName: interface{},
    LaunchTemplateVersion: interface{},
    NetworkInterfaceQueueNumber: interface{},
    NetworkOptions: interface{},
    NetworkType: interface{},
    Password: interface{},
    PasswordInherit: interface{},
    Period: interface{},
    PeriodUnit: interface{},
    PrivateIpAddress: interface{},
    PrivatePoolOptions: interface{},
    RamRoleName: interface{},
    ResourceGroupId: interface{},
    SchedulerOptions: interface{},
    SecurityEnhancementStrategy: interface{},
    SecurityGroupId: interface{},
    SecurityGroupIds: interface{},
    SecurityOptions: interface{},
    SpotDuration: interface{},
    SpotInterruptionBehavior: interface{},
    SpotPriceLimit: interface{},
    SpotStrategy: interface{},
    StorageSetId: interface{},
    StorageSetPartitionNumber: interface{},
    SystemDiskAutoSnapshotPolicyId: interface{},
    SystemDiskBurstingEnabled: interface{},
    SystemDiskCategory: interface{},
    SystemDiskDescription: interface{},
    SystemDiskDiskName: interface{},
    SystemDiskEncryptAlgorithm: interface{},
    SystemDiskEncrypted: interface{},
    SystemDiskKmsKeyId: interface{},
    SystemDiskPerformanceLevel: interface{},
    SystemDiskProvisionedIops: interface{},
    SystemDiskSize: interface{},
    SystemDiskStorageClusterId: interface{},
    Tags: *[]github.com/alibabacloud-go/ros-cdk/alicloudroscdkecs.RosInstanceGroup.TagsProperty,
    Tenancy: interface{},
    UniqueSuffix: interface{},
    UpdatePolicy: interface{},
    UseAdditionalService: interface{},
    UserData: interface{},
    VpcId: interface{},
    VSwitchId: interface{},
    ZoneId: interface{},
    ZoneIds: interface{},
}

Properties

Name Type Description
InstanceType interface{} Property instanceType: Ecs instance supported instance type, make sure it should be correct.
MaxAmount interface{} Property maxAmount: Max number of instances to create, should be bigger than 'MinAmount' and smaller than 1000.
Affinity interface{} Property affinity: Specifies whether to associate the instance on a dedicated host with the dedicated host.
AllocatePublicIp interface{} Property allocatePublicIp: The public ip for ecs instance, if properties is true, will allocate public ip.
AutoReleaseTime interface{} Property autoReleaseTime: Auto release time for created instance, Follow ISO8601 standard using UTC time.
AutoRenew interface{} Property autoRenew: Whether renew the fee automatically?
AutoRenewPeriod interface{} Property autoRenewPeriod: The time period of auto renew.
CpuOptions interface{} Property cpuOptions: Cpu options.
CreditSpecification interface{} Property creditSpecification: The performance mode of the burstable instance.
DedicatedHostId interface{} Property dedicatedHostId: which dedicated host will be deployed.
DeletionForce interface{} Property deletionForce: Whether force delete the instance.
DeletionProtection interface{} Property deletionProtection: Whether an instance can be released manually through the console or API, deletion protection only support postPaid instance.
DeploymentSetGroupNo interface{} Property deploymentSetGroupNo: The number of the deployment set group to which to deploy the instance.
DeploymentSetId interface{} Property deploymentSetId: Deployment set ID.
Description interface{} Property description: Description of the instance, [2, 256] characters.
DiskMappings interface{} Property diskMappings: Disk mappings to attach to instance.
EniMappings interface{} Property eniMappings: NetworkInterface to attach to instance.
HostName interface{} Property hostName: Host name of created ecs instance.
HostNames interface{} Property hostNames: The hostname of instance N.
HpcClusterId interface{} Property hpcClusterId: The HPC cluster ID to which the instance belongs.The change of the property does not affect existing instances.
HttpEndpoint interface{} Property httpEndpoint: Specifies whether the access channel is enabled for instance metadata.
HttpTokens interface{} Property httpTokens: Specifies whether the security hardening mode (IMDSv2) is forcefully used to access instance metadata.
ImageFamily interface{} Property imageFamily: The name of the image family.
ImageId interface{} Property imageId: Image ID to create ecs instance.
ImageOptions interface{} Property imageOptions: Image options.
InstanceChargeType interface{} Property instanceChargeType: Instance Charge type, allowed value: Prepaid and Postpaid.
InstanceName interface{} 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 interface{} Property internetChargeType: Instance internet access charge type.Support 'PayByBandwidth' and 'PayByTraffic' only. Default is PayByTraffic.
InternetMaxBandwidthOut interface{} Property internetMaxBandwidthOut: Set internet output bandwidth of instance.
IoOptimized interface{} Property ioOptimized: The 'optimized' instance can provide better IO performance.
Ipv6AddressCount interface{} Property ipv6AddressCount: Specifies the number of randomly generated IPv6 addresses for the elastic NIC.
Ipv6Addresses interface{} Property ipv6Addresses: Specify one or more IPv6 addresses for the elastic NIC.
KeyPairName interface{} Property keyPairName: SSH key pair name.Old instances will not be changed.
LaunchTemplateId interface{} Property launchTemplateId: ID of launch template.
LaunchTemplateName interface{} Property launchTemplateName: Name of launch template.
LaunchTemplateVersion interface{} Property launchTemplateVersion: Version of launch template.
NetworkInterfaceQueueNumber interface{} Property networkInterfaceQueueNumber: The number of queues supported by the primary ENI.
NetworkOptions interface{} Property networkOptions: Network options.
NetworkType interface{} Property networkType: Instance network type.
Password interface{} Property password: Password of created ecs instance.
PasswordInherit interface{} Property passwordInherit: Specifies whether to use the password preset in the image.
Period interface{} Property period: Prepaid time period.
PeriodUnit interface{} Property periodUnit: Unit of prepaid time period, it could be Week\/Month\/Year.
PrivateIpAddress interface{} Property privateIpAddress: Private IP for the instance created.
PrivatePoolOptions interface{} Property privatePoolOptions: The options of the private pool.
RamRoleName interface{} Property ramRoleName: Instance RAM role name.
ResourceGroupId interface{} Property resourceGroupId: Resource group id.
SchedulerOptions interface{} Property schedulerOptions: undefined.
SecurityEnhancementStrategy interface{} Property securityEnhancementStrategy:.
SecurityGroupId interface{} Property securityGroupId: Security group to create ecs instance.
SecurityGroupIds interface{} Property securityGroupIds: The IDs of security groups N to which the instance belongs.
SecurityOptions interface{} Property securityOptions: Security options.
SpotDuration interface{} Property spotDuration: The protection period of the preemptible instance.
SpotInterruptionBehavior interface{} Property spotInterruptionBehavior: The interruption mode of the preemptible instance.
SpotPriceLimit interface{} Property spotPriceLimit: The hourly price threshold of a instance, and it takes effect only when parameter InstanceChargeType is PostPaid.
SpotStrategy interface{} Property spotStrategy: The spot strategy of a Pay-As-You-Go instance, and it takes effect only when parameter InstanceChargeType is PostPaid.
StorageSetId interface{} Property storageSetId: The storage set ID.
StorageSetPartitionNumber interface{} Property storageSetPartitionNumber: The maximum number of partitions in the storage set.
SystemDiskAutoSnapshotPolicyId interface{} Property systemDiskAutoSnapshotPolicyId: Auto snapshot policy ID.
SystemDiskBurstingEnabled interface{} Property systemDiskBurstingEnabled: Whether enable bursting.
SystemDiskCategory interface{} Property systemDiskCategory: Category of system disk.
SystemDiskDescription interface{} Property systemDiskDescription: Description of created system disk.Old instances will not be changed.
SystemDiskDiskName interface{} Property systemDiskDiskName: Name of created system disk.Old instances will not be changed.
SystemDiskEncryptAlgorithm interface{} Property systemDiskEncryptAlgorithm: The algorithm to use to encrypt the system disk.
SystemDiskEncrypted interface{} Property systemDiskEncrypted: Specifies whether to encrypt the system disk.
SystemDiskKmsKeyId interface{} Property systemDiskKmsKeyId: The ID of the KMS key to use for the system disk.
SystemDiskPerformanceLevel interface{} 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 interface{} Property systemDiskProvisionedIops: Provisioning IOPS.
SystemDiskSize interface{} Property systemDiskSize: Disk size of the system disk, range from 20 to 500 GB.
SystemDiskStorageClusterId interface{} Property systemDiskStorageClusterId: The ID of the dedicated block storage cluster.
Tags *[]TagsProperty Property tags: Tags to attach to instance.
Tenancy interface{} Property tenancy: Specifies whether to create the instance on a dedicated host.
UniqueSuffix interface{} 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 interface{} Property updatePolicy: Specify the policy at update.
UseAdditionalService interface{} Property useAdditionalService: Specifies whether to use the system configurations for virtual machines provided by Alibaba Cloud.
UserData interface{} Property userData: User data to pass to instance.
VpcId interface{} Property vpcId: The VPC id to create ecs instance.
VSwitchId interface{} Property vSwitchId: The vSwitch Id to create ecs instance.
ZoneId interface{} Property zoneId: The ID of the zone to which the instance belongs.
ZoneIds interface{} Property zoneIds: Zone ids for query parameters.

InstanceTypeRequired 

InstanceType interface{}
  • Type: interface{}

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

MaxAmountRequired 

MaxAmount interface{}
  • Type: interface{}

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

AffinityOptional 

Affinity interface{}
  • Type: interface{}

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 

AllocatePublicIp interface{}
  • Type: interface{}

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 

AutoReleaseTime interface{}
  • Type: interface{}

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 

AutoRenew interface{}
  • Type: interface{}

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 

AutoRenewPeriod interface{}
  • Type: interface{}

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 

CpuOptions interface{}
  • Type: interface{}

Property cpuOptions: Cpu options.

CreditSpecificationOptional 

CreditSpecification interface{}
  • Type: interface{}

Property creditSpecification: The performance mode of the burstable instance.

Valid values:

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

DedicatedHostIdOptional 

DedicatedHostId interface{}
  • Type: interface{}

Property dedicatedHostId: which dedicated host will be deployed.

DeletionForceOptional 

DeletionForce interface{}
  • Type: interface{}

Property deletionForce: Whether force delete the instance.

Default value is false.

DeletionProtectionOptional 

DeletionProtection interface{}
  • Type: interface{}

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

DeploymentSetGroupNoOptional 

DeploymentSetGroupNo interface{}
  • Type: interface{}

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 

DeploymentSetId interface{}
  • Type: interface{}

Property deploymentSetId: Deployment set ID.

The change of the property does not affect existing instances.

DescriptionOptional 

Description interface{}
  • Type: interface{}

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 

DiskMappings interface{}
  • Type: interface{}

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 

EniMappings interface{}
  • Type: interface{}

Property eniMappings: NetworkInterface to attach to instance.

Max support 2 ENIs.

HostNameOptional 

HostName interface{}
  • Type: interface{}

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 

HostNames interface{}
  • Type: interface{}

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 

HpcClusterId interface{}
  • Type: interface{}

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

HttpEndpointOptional 

HttpEndpoint interface{}
  • Type: interface{}

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

Valid values:

  • enabled
  • disabled Default value: enabled.

HttpTokensOptional 

HttpTokens interface{}
  • Type: interface{}

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 

ImageFamily interface{}
  • Type: interface{}

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 

ImageId interface{}
  • Type: interface{}

Property imageId: Image ID to create ecs instance.

ImageOptionsOptional 

ImageOptions interface{}
  • Type: interface{}

Property imageOptions: Image options.

InstanceChargeTypeOptional 

InstanceChargeType interface{}
  • Type: interface{}

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 

InstanceName interface{}
  • Type: interface{}

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 

InternetChargeType interface{}
  • Type: interface{}

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

InternetMaxBandwidthOutOptional 

InternetMaxBandwidthOut interface{}
  • Type: interface{}

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 

IoOptimized interface{}
  • Type: interface{}

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

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

Ipv6AddressCountOptional 

Ipv6AddressCount interface{}
  • Type: interface{}

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 

Ipv6Addresses interface{}
  • Type: interface{}

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 

KeyPairName interface{}
  • Type: interface{}

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

LaunchTemplateIdOptional 

LaunchTemplateId interface{}
  • Type: interface{}

Property launchTemplateId: ID of launch template.

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

LaunchTemplateNameOptional 

LaunchTemplateName interface{}
  • Type: interface{}

Property launchTemplateName: Name of launch template.

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

LaunchTemplateVersionOptional 

LaunchTemplateVersion interface{}
  • Type: interface{}

Property launchTemplateVersion: Version of launch template.

Default version is used if version is not specified.

NetworkInterfaceQueueNumberOptional 

NetworkInterfaceQueueNumber interface{}
  • Type: interface{}

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 

NetworkOptions interface{}
  • Type: interface{}

Property networkOptions: Network options.

NetworkTypeOptional 

NetworkType interface{}
  • Type: interface{}

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 

Password interface{}
  • Type: interface{}

Property password: Password of created ecs instance.

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

PasswordInheritOptional 

PasswordInherit interface{}
  • Type: interface{}

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 

Period interface{}
  • Type: interface{}

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 

PeriodUnit interface{}
  • Type: interface{}

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

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

PrivateIpAddressOptional 

PrivateIpAddress interface{}
  • Type: interface{}

Property privateIpAddress: Private IP for the instance created.

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

PrivatePoolOptionsOptional 

PrivatePoolOptions interface{}
  • Type: interface{}

Property privatePoolOptions: The options of the private pool.

RamRoleNameOptional 

RamRoleName interface{}
  • Type: interface{}

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 

ResourceGroupId interface{}
  • Type: interface{}

Property resourceGroupId: Resource group id.

SchedulerOptionsOptional 

SchedulerOptions interface{}
  • Type: interface{}

Property schedulerOptions: undefined.

SecurityEnhancementStrategyOptional 

SecurityEnhancementStrategy interface{}
  • Type: interface{}

Property securityEnhancementStrategy:.

SecurityGroupIdOptional 

SecurityGroupId interface{}
  • Type: interface{}

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 

SecurityGroupIds interface{}
  • Type: interface{}

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 

SecurityOptions interface{}
  • Type: interface{}

Property securityOptions: Security options.

SpotDurationOptional 

SpotDuration interface{}
  • Type: interface{}

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 

SpotInterruptionBehavior interface{}
  • Type: interface{}

Property spotInterruptionBehavior: The interruption mode of the preemptible instance.

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

SpotPriceLimitOptional 

SpotPriceLimit interface{}
  • Type: interface{}

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 

SpotStrategy interface{}
  • Type: interface{}

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 

StorageSetId interface{}
  • Type: interface{}

Property storageSetId: The storage set ID.

StorageSetPartitionNumberOptional 

StorageSetPartitionNumber interface{}
  • Type: interface{}

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

The value must be greater than or equal to 2.

SystemDiskAutoSnapshotPolicyIdOptional 

SystemDiskAutoSnapshotPolicyId interface{}
  • Type: interface{}

Property systemDiskAutoSnapshotPolicyId: Auto snapshot policy ID.

SystemDiskBurstingEnabledOptional 

SystemDiskBurstingEnabled interface{}
  • Type: interface{}

Property systemDiskBurstingEnabled: Whether enable bursting.

SystemDiskCategoryOptional 

SystemDiskCategory interface{}
  • Type: interface{}

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 

SystemDiskDescription interface{}
  • Type: interface{}

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

SystemDiskDiskNameOptional 

SystemDiskDiskName interface{}
  • Type: interface{}

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

SystemDiskEncryptAlgorithmOptional 

SystemDiskEncryptAlgorithm interface{}
  • Type: interface{}

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

Valid values:

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

SystemDiskEncryptedOptional 

SystemDiskEncrypted interface{}
  • Type: interface{}

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 

SystemDiskKmsKeyId interface{}
  • Type: interface{}

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

SystemDiskPerformanceLevelOptional 

SystemDiskPerformanceLevel interface{}
  • Type: interface{}

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 

SystemDiskProvisionedIops interface{}
  • Type: interface{}

Property systemDiskProvisionedIops: Provisioning IOPS.

SystemDiskSizeOptional 

SystemDiskSize interface{}
  • Type: interface{}

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 

SystemDiskStorageClusterId interface{}
  • Type: interface{}

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 

Tags *[]TagsProperty

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 

Tenancy interface{}
  • Type: interface{}

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 

UniqueSuffix interface{}
  • Type: interface{}

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 

UpdatePolicy interface{}
  • Type: interface{}

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 

UseAdditionalService interface{}
  • Type: interface{}

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 

UserData interface{}
  • Type: interface{}

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 

VpcId interface{}
  • Type: interface{}

Property vpcId: The VPC id to create ecs instance.

VSwitchIdOptional 

VSwitchId interface{}
  • Type: interface{}

Property vSwitchId: The vSwitch Id to create ecs instance.

ZoneIdOptional 

ZoneId interface{}
  • Type: interface{}

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 

ZoneIds interface{}
  • Type: interface{}

Property zoneIds: Zone ids for query parameters.