Instance

It has been deprecated from version "1.7.0". Setting "internet_max_bandwidth_out" larger than 0 can allocate a public ip address for an instance.

The automatic release time of the PostPaid instance. The time follows the ISO 8601 standard and is in UTC time. Format: yyyy-MM-ddTHH:mm:ssZ. It must be at least half an hour later than the current time and less than 3 years since the current time. Set it to null can cancel automatic release attribute and the ECS instance will not be released automatically.

Auto renewal period of an instance, in the unit of month. It is valid when instance_charge_type is PrePaid. Default to 1. Valid value:

The Zone to start the instance in. It is ignored and will be computed when set vswitch_id.

Performance mode of the t5 burstable instance. Valid values: 'Standard', 'Unlimited'.

The list of data disks created with instance.

Whether enable the deletion protection or not. Default value: false.

(Optional, Available in 1.149.0+) The group number of the instance in a deployment set when the deployment set is use.

The ID of the deployment set to which to deploy the instance. NOTE: From version 1.176.0, instance's deploymentSetId can be removed when 'deployment_set_id' = "".

The description of the data disk.

Specifies whether to send a dry-run request. Default to false.

If it is true, the "PrePaid" instance will be change to "PostPaid" and then deleted forcibly. However, because of changing instance charge type has CPU core count quota limitation, so strongly recommand that "Don't modify instance charge type frequentlly in one month".

Host name of the ECS, which is a string of at least two characters. “hostname” cannot start or end with “.” or “-“. In addition, two or more consecutive “.” or “-“ symbols are not allowed. On Windows, the host name can contain a maximum of 15 characters, which can be a combination of uppercase/lowercase letters, numerals, and “-“. The host name cannot contain dots (“.”) or contain only numeric characters. When it is changed, the instance will reboot to make the change take effect. On other OSs such as Linux, the host name can contain a maximum of 64 characters, which can be segments separated by dots (“.”), where each segment can contain uppercase/lowercase letters, numerals, or “_“. When it is changed, the instance will reboot to make the change take effect.

The ID of the Elastic High Performance Computing (E-HPC) cluster to which to assign the instance.

Specifies whether to enable the access channel for instance metadata. Valid values: enabled, disabled. Default value: enabled.

The HTTP PUT response hop limit for accessing instance metadata. Valid values: 1 to 64. Default value: 1.

Specifies whether to forcefully use the security-enhanced mode (IMDSv2) to access instance metadata. Default value: optional. Valid values:

The Image to use for the instance. ECS instance's image can be replaced via changing image_id. When it is changed, the instance will reboot to make the change take effect.

Whether to change instance disks charge type when changing instance charge type.

Valid values are PrePaid, PostPaid, The default is PostPaid.

The type of instance to start. When it is changed, the instance will reboot to make the change take effect.

Internet charge type of the instance, Valid values are PayByBandwidth, PayByTraffic. Default is PayByTraffic. At present, 'PrePaid' instance cannot change the value to "PayByBandwidth" from "PayByTraffic".

Maximum incoming bandwidth from the public network, measured in Mbps (Mega bit per second). Value range: 1, 200. If this value is not specified, then automatically sets it to 200 Mbps.

Maximum outgoing bandwidth to the public network, measured in Mbps (Mega bit per second). Value range: 0, 100. Default to 0 Mbps.

It has been deprecated on instance resource. All the launched alicloud instances will be I/O optimized.

The number of IPv6 addresses to randomly generate for the primary ENI. Valid values: 1 to 10. NOTE: You cannot specify both the ipv6_addresses and ipv6_address_count parameters.

A list of IPv6 address to be assigned to the primary ENI. Support up to 10.

Whether to use outdated instance type. Default to false.

The name of key pair that can login ECS instance successfully without password. If it is specified, the password would be invalid.

An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored. When it is changed, the instance will reboot to make the change take effect.

An KMS encryption context used to decrypt kms_encrypted_password before creating or updating an instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set. When it is changed, the instance will reboot to make the change take effect.

The maintenance action. Valid values: Stop, AutoRecover and AutoRedeploy.

Specifies whether to send an event notification before instance shutdown. Valid values: true, false. Default value: false.

The time of maintenance. See the following Block maintenance_time.

The operation type. It is valid when instance_charge_type is PrePaid. Default value: upgrade. Valid values: upgrade, downgrade. NOTE: When the new instance type specified by the instance_type parameter has lower specifications than the current instance type, you must set operator_type to downgrade.

Password to an instance is a string of 8 to 30 characters. It must contain uppercase/lowercase letters and numerals, but cannot contain special symbols. When it is changed, the instance will reboot to make the change take effect.

The duration unit that you will buy the resource. It is valid when instance_charge_type is 'PrePaid'. Valid value: "Week", "Month". Default to "Month".

Instance private IP address can be specified when you creating new instance. It is valid when vswitch_id is specified. When it is changed, the instance will reboot to make the change take effect.

The instance public ip.

Whether to renew an ECS instance automatically or not. It is valid when instance_charge_type is PrePaid. Default to "Normal". Valid values:

The Id of resource group which the instance belongs.

Instance RAM role name. The name is provided and maintained by RAM. You can use alicloud.ram.Role to create a new one.

The number of private IP addresses to be automatically assigned from within the CIDR block of the vswitch. NOTE: To assign secondary private IP addresses, you must specify secondary_private_ips or secondary_private_ip_address_count but not both.

A list of Secondary private IP addresses which is selected from within the CIDR block of the VSwitch.

The security enhancement strategy.

A list of security group ids to associate with.

The retention time of the preemptive instance in hours. Valid values: 0, 1, 2, 3, 4, 5, 6. Retention duration 2~6 is under invitation test, please submit a work order if you need to open. If the value is 0, the mode is no protection period. Default value is 1.

The hourly price threshold of a instance, and it takes effect only when parameter 'spot_strategy' is 'SpotWithPriceLimit'. Three decimals is allowed at most.

The spot strategy of a Pay-As-You-Go instance, and it takes effect only when parameter instance_charge_type is 'PostPaid'. Value range:

The instance status. Valid values: "Running", "Stopped". You can control the instance start and stop through this parameter. Default to Running.

The stop mode of the pay-as-you-go instance. Valid values: StopCharging,KeepCharging, Not-applicable. Default value: If the prerequisites required for enabling the economical mode are met, and you have enabled this mode in the ECS console, the default value is StopCharging. For more information, see "Enable the economical mode" in Economical mode. Otherwise, the default value is KeepCharging. Note: Not-applicable: Economical mode is not applicable to the instance.`

The ID of the automatic snapshot policy applied to the system disk.

Valid values are ephemeral_ssd, cloud_efficiency, cloud_ssd, cloud_essd, cloud, cloud_auto. only is used to some none I/O optimized instance. Default to cloud_efficiency. Valid values cloud_auto Available in 1.184.0+.

The description of the system disk. The description must be 2 to 256 characters in length and cannot start with http:// or https://.

The algorithm to be used to encrypt the system disk. Valid values are aes-256, sm4-128. Default value is aes-256.

Specifies whether to encrypt the system disk. Valid values: true,false. Default value: false.

The ID of the Key Management Service (KMS) key to be used for the system disk.

The name of the system disk. The name must be 2 to 128 characters in length and can contain letters, digits, periods (.), colons (:), underscores (_), and hyphens (-). It must start with a letter and cannot start with http:// or https://.

The performance level of the ESSD used as the system disk, Valid values: PL0, PL1, PL2, PL3, Default to PL1;For more information about ESSD, See Encryption Context.

Size of the system disk, measured in GiB. Value range: 20, 500. The specified value must be equal to or greater than max{20, Imagesize}. Default value: max{40, ImageSize}.

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. For more information about dedicated block storage clusters, see What is Dedicated Block Storage Cluster?.

A mapping of tags to assign to the resource.

User-defined data to customize the startup behaviors of an ECS instance and to pass data into an ECS instance. From version 1.60.0, it can be update in-place. If updated, the instance will reboot to make the change take effect. Note: Not all of changes will take effect and it depends on cloud-init module type.

A mapping of tags to assign to the devices created by the instance at launch time.

The virtual switch ID to launch in VPC. This parameter must be set unless you can create classic network instances. When it is changed, the instance will reboot to make the change take effect.