published on Thursday, Sep 3, 2026 by Volcengine
published on Thursday, Sep 3, 2026 by Volcengine
Volcano Engine Cloud Server (ECS) ScheduledInstance. A ScheduledInstance allows you to schedule the automatic delivery of a batch of ECS instances at a future time. Supports two types: Elastic Scheduled Instance (Esi) and Elastic Scheduled Instance - Segmented (Segmented).
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as volcenginecc from "@volcengine/pulumi-volcenginecc";
const example = new volcenginecc.ecs.ScheduledInstance("example", {
imageId: "image-xxxxxxxxxxxxxxxxxxxx",
instanceName: "ecs-example",
instanceTypeId: "ecs.c3a.large",
scheduledInstanceName: "scheduled-example",
zoneId: "cn-beijing-a",
networkInterfaces: [{
security_group_ids: ["sg-xxxxxxxxxxxxxxxxxxxx"],
subnet_id: "subnet-xxxxxxxxxxxxxxxxxxxx",
vpc_id: "vpc-xxxxxxxxxxxxxxxxxxxx",
primary_ip_address: "",
private_ip_addresses: [],
}],
volumes: [{
size: 20,
volume_type: "ESSD_PL0",
delete_with_instance: false,
extra_performance_iops: 0,
extra_performance_throughput_mb: 0,
extra_performance_type_id: "",
snapshot_id: "",
}],
instanceCount: 1,
minCount: 1,
elasticScheduledInstanceType: "Esi",
startDeliveryAt: "2026-12-31T02:00:00+08:00",
endDeliveryAt: "2026-12-31T02:10:00+08:00",
hostName: "cc-test",
uniqueSuffix: false,
suffixIndex: 1,
projectName: "default",
description: "instance-desc",
scheduledInstanceDescription: "desc",
keyPairName: "example-keypair",
keepImageCredential: false,
installRunCommandAgent: false,
deletionProtection: false,
securityEnhancementStrategy: "Active",
httpTokens: "optional",
userData: "",
eipAddress: {
bandwidth_mbps: 1,
bandwidth_package_id: "",
charge_type: "PayByTraffic",
isp: "BGP",
release_with_instance: false,
security_protection_instance_id: 0,
security_protection_types: [],
},
tags: [
{
key: "key1",
value: "1",
},
{
key: "key2",
value: "2",
},
],
});
import pulumi
import pulumi_volcenginecc as volcenginecc
example = volcenginecc.ecs.ScheduledInstance("example",
image_id="image-xxxxxxxxxxxxxxxxxxxx",
instance_name="ecs-example",
instance_type_id="ecs.c3a.large",
scheduled_instance_name="scheduled-example",
zone_id="cn-beijing-a",
network_interfaces=[{
"security_group_ids": ["sg-xxxxxxxxxxxxxxxxxxxx"],
"subnet_id": "subnet-xxxxxxxxxxxxxxxxxxxx",
"vpc_id": "vpc-xxxxxxxxxxxxxxxxxxxx",
"primary_ip_address": "",
"private_ip_addresses": [],
}],
volumes=[{
"size": 20,
"volume_type": "ESSD_PL0",
"delete_with_instance": False,
"extra_performance_iops": 0,
"extra_performance_throughput_mb": 0,
"extra_performance_type_id": "",
"snapshot_id": "",
}],
instance_count=1,
min_count=1,
elastic_scheduled_instance_type="Esi",
start_delivery_at="2026-12-31T02:00:00+08:00",
end_delivery_at="2026-12-31T02:10:00+08:00",
host_name="cc-test",
unique_suffix=False,
suffix_index=1,
project_name="default",
description="instance-desc",
scheduled_instance_description="desc",
key_pair_name="example-keypair",
keep_image_credential=False,
install_run_command_agent=False,
deletion_protection=False,
security_enhancement_strategy="Active",
http_tokens="optional",
user_data="",
eip_address={
"bandwidth_mbps": 1,
"bandwidth_package_id": "",
"charge_type": "PayByTraffic",
"isp": "BGP",
"release_with_instance": False,
"security_protection_instance_id": 0,
"security_protection_types": [],
},
tags=[
{
"key": "key1",
"value": "1",
},
{
"key": "key2",
"value": "2",
},
])
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/ecs"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ecs.NewScheduledInstance(ctx, "example", &ecs.ScheduledInstanceArgs{
ImageId: pulumi.String("image-xxxxxxxxxxxxxxxxxxxx"),
InstanceName: pulumi.String("ecs-example"),
InstanceTypeId: pulumi.String("ecs.c3a.large"),
ScheduledInstanceName: pulumi.String("scheduled-example"),
ZoneId: pulumi.String("cn-beijing-a"),
NetworkInterfaces: ecs.ScheduledInstanceNetworkInterfaceArray{
&ecs.ScheduledInstanceNetworkInterfaceArgs{
Security_group_ids: []string{
"sg-xxxxxxxxxxxxxxxxxxxx",
},
Subnet_id: "subnet-xxxxxxxxxxxxxxxxxxxx",
Vpc_id: "vpc-xxxxxxxxxxxxxxxxxxxx",
Primary_ip_address: "",
Private_ip_addresses: []interface{}{},
},
},
Volumes: ecs.ScheduledInstanceVolumeArray{
&ecs.ScheduledInstanceVolumeArgs{
Size: pulumi.Int(20),
Volume_type: "ESSD_PL0",
Delete_with_instance: false,
Extra_performance_iops: 0,
Extra_performance_throughput_mb: 0,
Extra_performance_type_id: "",
Snapshot_id: "",
},
},
InstanceCount: pulumi.Int(1),
MinCount: pulumi.Int(1),
ElasticScheduledInstanceType: pulumi.String("Esi"),
StartDeliveryAt: pulumi.String("2026-12-31T02:00:00+08:00"),
EndDeliveryAt: pulumi.String("2026-12-31T02:10:00+08:00"),
HostName: pulumi.String("cc-test"),
UniqueSuffix: pulumi.Bool(false),
SuffixIndex: pulumi.Int(1),
ProjectName: pulumi.String("default"),
Description: pulumi.String("instance-desc"),
ScheduledInstanceDescription: pulumi.String("desc"),
KeyPairName: pulumi.String("example-keypair"),
KeepImageCredential: pulumi.Bool(false),
InstallRunCommandAgent: pulumi.Bool(false),
DeletionProtection: pulumi.Bool(false),
SecurityEnhancementStrategy: pulumi.String("Active"),
HttpTokens: pulumi.String("optional"),
UserData: pulumi.String(""),
EipAddress: &ecs.ScheduledInstanceEipAddressArgs{
Bandwidth_mbps: 1,
Bandwidth_package_id: "",
Charge_type: "PayByTraffic",
Isp: pulumi.String("BGP"),
Release_with_instance: false,
Security_protection_instance_id: 0,
Security_protection_types: []interface{}{},
},
Tags: ecs.ScheduledInstanceTagArray{
&ecs.ScheduledInstanceTagArgs{
Key: pulumi.String("key1"),
Value: pulumi.String("1"),
},
&ecs.ScheduledInstanceTagArgs{
Key: pulumi.String("key2"),
Value: pulumi.String("2"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcenginecc = Volcengine.Pulumi.Volcenginecc;
return await Deployment.RunAsync(() =>
{
var example = new Volcenginecc.Ecs.ScheduledInstance("example", new()
{
ImageId = "image-xxxxxxxxxxxxxxxxxxxx",
InstanceName = "ecs-example",
InstanceTypeId = "ecs.c3a.large",
ScheduledInstanceName = "scheduled-example",
ZoneId = "cn-beijing-a",
NetworkInterfaces = new[]
{
new Volcenginecc.Ecs.Inputs.ScheduledInstanceNetworkInterfaceArgs
{
Security_group_ids = new[]
{
"sg-xxxxxxxxxxxxxxxxxxxx",
},
Subnet_id = "subnet-xxxxxxxxxxxxxxxxxxxx",
Vpc_id = "vpc-xxxxxxxxxxxxxxxxxxxx",
Primary_ip_address = "",
Private_ip_addresses = new() { },
},
},
Volumes = new[]
{
new Volcenginecc.Ecs.Inputs.ScheduledInstanceVolumeArgs
{
Size = 20,
Volume_type = "ESSD_PL0",
Delete_with_instance = false,
Extra_performance_iops = 0,
Extra_performance_throughput_mb = 0,
Extra_performance_type_id = "",
Snapshot_id = "",
},
},
InstanceCount = 1,
MinCount = 1,
ElasticScheduledInstanceType = "Esi",
StartDeliveryAt = "2026-12-31T02:00:00+08:00",
EndDeliveryAt = "2026-12-31T02:10:00+08:00",
HostName = "cc-test",
UniqueSuffix = false,
SuffixIndex = 1,
ProjectName = "default",
Description = "instance-desc",
ScheduledInstanceDescription = "desc",
KeyPairName = "example-keypair",
KeepImageCredential = false,
InstallRunCommandAgent = false,
DeletionProtection = false,
SecurityEnhancementStrategy = "Active",
HttpTokens = "optional",
UserData = "",
EipAddress = new Volcenginecc.Ecs.Inputs.ScheduledInstanceEipAddressArgs
{
Bandwidth_mbps = 1,
Bandwidth_package_id = "",
Charge_type = "PayByTraffic",
Isp = "BGP",
Release_with_instance = false,
Security_protection_instance_id = 0,
Security_protection_types = new() { },
},
Tags = new[]
{
new Volcenginecc.Ecs.Inputs.ScheduledInstanceTagArgs
{
Key = "key1",
Value = "1",
},
new Volcenginecc.Ecs.Inputs.ScheduledInstanceTagArgs
{
Key = "key2",
Value = "2",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.ecs.ScheduledInstance;
import com.volcengine.volcenginecc.ecs.ScheduledInstanceArgs;
import com.pulumi.volcenginecc.ecs.inputs.ScheduledInstanceNetworkInterfaceArgs;
import com.pulumi.volcenginecc.ecs.inputs.ScheduledInstanceVolumeArgs;
import com.pulumi.volcenginecc.ecs.inputs.ScheduledInstanceEipAddressArgs;
import com.pulumi.volcenginecc.ecs.inputs.ScheduledInstanceTagArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new ScheduledInstance("example", ScheduledInstanceArgs.builder()
.imageId("image-xxxxxxxxxxxxxxxxxxxx")
.instanceName("ecs-example")
.instanceTypeId("ecs.c3a.large")
.scheduledInstanceName("scheduled-example")
.zoneId("cn-beijing-a")
.networkInterfaces(ScheduledInstanceNetworkInterfaceArgs.builder()
.security_group_ids(Arrays.asList("sg-xxxxxxxxxxxxxxxxxxxx"))
.subnet_id("subnet-xxxxxxxxxxxxxxxxxxxx")
.vpc_id("vpc-xxxxxxxxxxxxxxxxxxxx")
.primary_ip_address("")
.private_ip_addresses(Arrays.asList())
.build())
.volumes(ScheduledInstanceVolumeArgs.builder()
.size(20)
.volume_type("ESSD_PL0")
.delete_with_instance(false)
.extra_performance_iops(0)
.extra_performance_throughput_mb(0)
.extra_performance_type_id("")
.snapshot_id("")
.build())
.instanceCount(1)
.minCount(1)
.elasticScheduledInstanceType("Esi")
.startDeliveryAt("2026-12-31T02:00:00+08:00")
.endDeliveryAt("2026-12-31T02:10:00+08:00")
.hostName("cc-test")
.uniqueSuffix(false)
.suffixIndex(1)
.projectName("default")
.description("instance-desc")
.scheduledInstanceDescription("desc")
.keyPairName("example-keypair")
.keepImageCredential(false)
.installRunCommandAgent(false)
.deletionProtection(false)
.securityEnhancementStrategy("Active")
.httpTokens("optional")
.userData("")
.eipAddress(ScheduledInstanceEipAddressArgs.builder()
.bandwidth_mbps(1)
.bandwidth_package_id("")
.charge_type("PayByTraffic")
.isp("BGP")
.release_with_instance(false)
.security_protection_instance_id(0)
.security_protection_types(Arrays.asList())
.build())
.tags(
ScheduledInstanceTagArgs.builder()
.key("key1")
.value("1")
.build(),
ScheduledInstanceTagArgs.builder()
.key("key2")
.value("2")
.build())
.build());
}
}
resources:
example:
type: volcenginecc:ecs:ScheduledInstance
properties:
imageId: image-xxxxxxxxxxxxxxxxxxxx
instanceName: ecs-example
instanceTypeId: ecs.c3a.large
scheduledInstanceName: scheduled-example
zoneId: cn-beijing-a
networkInterfaces:
- security_group_ids:
- sg-xxxxxxxxxxxxxxxxxxxx
subnet_id: subnet-xxxxxxxxxxxxxxxxxxxx
vpc_id: vpc-xxxxxxxxxxxxxxxxxxxx
primary_ip_address: ""
private_ip_addresses: []
volumes:
- size: 20
volume_type: ESSD_PL0
delete_with_instance: false
extra_performance_iops: 0
extra_performance_throughput_mb: 0
extra_performance_type_id: ""
snapshot_id: ""
instanceCount: 1
minCount: 1
elasticScheduledInstanceType: Esi
startDeliveryAt: 2026-12-31T02:00:00+08:00
endDeliveryAt: 2026-12-31T02:10:00+08:00
hostName: cc-test
uniqueSuffix: false
suffixIndex: 1
projectName: default
description: instance-desc
scheduledInstanceDescription: desc
keyPairName: example-keypair
keepImageCredential: false
installRunCommandAgent: false
deletionProtection: false
securityEnhancementStrategy: Active
httpTokens: optional
userData: ""
eipAddress:
bandwidth_mbps: 1
bandwidth_package_id: ""
charge_type: PayByTraffic
isp: BGP
release_with_instance: false
security_protection_instance_id: 0
security_protection_types: []
tags:
- key: key1
value: '1'
- key: key2
value: '2'
pulumi {
required_providers {
volcenginecc = {
source = "pulumi/volcenginecc"
}
}
}
resource "volcenginecc_ecs_scheduledinstance" "example" {
image_id = "image-xxxxxxxxxxxxxxxxxxxx"
instance_name = "ecs-example"
instance_type_id = "ecs.c3a.large"
scheduled_instance_name = "scheduled-example"
zone_id = "cn-beijing-a"
network_interfaces {
security_group_ids = ["sg-xxxxxxxxxxxxxxxxxxxx"]
subnet_id = "subnet-xxxxxxxxxxxxxxxxxxxx"
vpc_id = "vpc-xxxxxxxxxxxxxxxxxxxx"
primary_ip_address = ""
private_ip_addresses = []
}
volumes {
size = 20
volume_type = "ESSD_PL0"
delete_with_instance = false
extra_performance_iops = 0
extra_performance_throughput_mb = 0
extra_performance_type_id = ""
snapshot_id = ""
}
instance_count = 1
min_count = 1
elastic_scheduled_instance_type = "Esi"
start_delivery_at = "2026-12-31T02:00:00+08:00"
end_delivery_at = "2026-12-31T02:10:00+08:00"
host_name = "cc-test"
unique_suffix = false
suffix_index = 1
project_name = "default"
description = "instance-desc"
scheduled_instance_description = "desc"
key_pair_name = "example-keypair"
keep_image_credential = false
install_run_command_agent = false
deletion_protection = false
security_enhancement_strategy = "Active"
http_tokens = "optional"
user_data = ""
eip_address = {
bandwidth_mbps = 1
bandwidth_package_id = ""
charge_type = "PayByTraffic"
isp = "BGP"
release_with_instance = false
security_protection_instance_id = 0
security_protection_types = []
}
tags {
key = "key1"
value = "1"
}
tags {
key = "key2"
value = "2"
}
}
Create ScheduledInstance Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ScheduledInstance(name: string, args: ScheduledInstanceArgs, opts?: CustomResourceOptions);@overload
def ScheduledInstance(resource_name: str,
args: ScheduledInstanceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ScheduledInstance(resource_name: str,
opts: Optional[ResourceOptions] = None,
image_id: Optional[str] = None,
zone_id: Optional[str] = None,
volumes: Optional[Sequence[ScheduledInstanceVolumeArgs]] = None,
scheduled_instance_name: Optional[str] = None,
network_interfaces: Optional[Sequence[ScheduledInstanceNetworkInterfaceArgs]] = None,
instance_type_id: Optional[str] = None,
instance_name: Optional[str] = None,
keep_image_credential: Optional[bool] = None,
password: Optional[str] = None,
hpc_cluster_id: Optional[str] = None,
http_tokens: Optional[str] = None,
end_delivery_at: Optional[str] = None,
install_run_command_agent: Optional[bool] = None,
instance_count: Optional[int] = None,
elastic_scheduled_instance_type: Optional[str] = None,
eip_address: Optional[ScheduledInstanceEipAddressArgs] = None,
auto_release_at: Optional[str] = None,
key_pair_name: Optional[str] = None,
min_count: Optional[int] = None,
description: Optional[str] = None,
host_name: Optional[str] = None,
project_name: Optional[str] = None,
scheduled_instance_description: Optional[str] = None,
delivery_type: Optional[str] = None,
security_enhancement_strategy: Optional[str] = None,
start_delivery_at: Optional[str] = None,
suffix_index: Optional[int] = None,
tags: Optional[Sequence[ScheduledInstanceTagArgs]] = None,
unique_suffix: Optional[bool] = None,
user_data: Optional[str] = None,
deletion_protection: Optional[bool] = None,
cpu_max_frequency: Optional[float] = None)func NewScheduledInstance(ctx *Context, name string, args ScheduledInstanceArgs, opts ...ResourceOption) (*ScheduledInstance, error)public ScheduledInstance(string name, ScheduledInstanceArgs args, CustomResourceOptions? opts = null)
public ScheduledInstance(String name, ScheduledInstanceArgs args)
public ScheduledInstance(String name, ScheduledInstanceArgs args, CustomResourceOptions options)
type: volcenginecc:ecs:ScheduledInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "volcenginecc_ecs_scheduled_instance" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args ScheduledInstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ScheduledInstanceArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ScheduledInstanceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ScheduledInstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ScheduledInstanceArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var scheduledInstanceResource = new Volcenginecc.Ecs.ScheduledInstance("scheduledInstanceResource", new()
{
ImageId = "string",
ZoneId = "string",
Volumes = new[]
{
new Volcenginecc.Ecs.Inputs.ScheduledInstanceVolumeArgs
{
DeleteWithInstance = false,
ExtraPerformanceIops = 0,
ExtraPerformanceThroughputMb = 0,
ExtraPerformanceTypeId = "string",
Size = 0,
SnapshotId = "string",
VolumeType = "string",
},
},
ScheduledInstanceName = "string",
NetworkInterfaces = new[]
{
new Volcenginecc.Ecs.Inputs.ScheduledInstanceNetworkInterfaceArgs
{
PrimaryIpAddress = "string",
PrivateIpAddresses = new[]
{
"string",
},
SecurityGroupIds = new[]
{
"string",
},
SubnetId = "string",
VpcId = "string",
},
},
InstanceTypeId = "string",
InstanceName = "string",
KeepImageCredential = false,
Password = "string",
HpcClusterId = "string",
HttpTokens = "string",
EndDeliveryAt = "string",
InstallRunCommandAgent = false,
InstanceCount = 0,
ElasticScheduledInstanceType = "string",
EipAddress = new Volcenginecc.Ecs.Inputs.ScheduledInstanceEipAddressArgs
{
BandwidthMbps = 0,
BandwidthPackageId = "string",
ChargeType = "string",
Isp = "string",
ReleaseWithInstance = false,
SecurityProtectionInstanceId = 0,
SecurityProtectionTypes = new[]
{
"string",
},
},
AutoReleaseAt = "string",
KeyPairName = "string",
MinCount = 0,
Description = "string",
HostName = "string",
ProjectName = "string",
ScheduledInstanceDescription = "string",
DeliveryType = "string",
SecurityEnhancementStrategy = "string",
StartDeliveryAt = "string",
SuffixIndex = 0,
Tags = new[]
{
new Volcenginecc.Ecs.Inputs.ScheduledInstanceTagArgs
{
Key = "string",
Value = "string",
},
},
UniqueSuffix = false,
UserData = "string",
DeletionProtection = false,
CpuMaxFrequency = 0.0,
});
example, err := ecs.NewScheduledInstance(ctx, "scheduledInstanceResource", &ecs.ScheduledInstanceArgs{
ImageId: pulumi.String("string"),
ZoneId: pulumi.String("string"),
Volumes: ecs.ScheduledInstanceVolumeArray{
&ecs.ScheduledInstanceVolumeArgs{
DeleteWithInstance: pulumi.Bool(false),
ExtraPerformanceIops: pulumi.Int(0),
ExtraPerformanceThroughputMb: pulumi.Int(0),
ExtraPerformanceTypeId: pulumi.String("string"),
Size: pulumi.Int(0),
SnapshotId: pulumi.String("string"),
VolumeType: pulumi.String("string"),
},
},
ScheduledInstanceName: pulumi.String("string"),
NetworkInterfaces: ecs.ScheduledInstanceNetworkInterfaceArray{
&ecs.ScheduledInstanceNetworkInterfaceArgs{
PrimaryIpAddress: pulumi.String("string"),
PrivateIpAddresses: pulumi.StringArray{
pulumi.String("string"),
},
SecurityGroupIds: pulumi.StringArray{
pulumi.String("string"),
},
SubnetId: pulumi.String("string"),
VpcId: pulumi.String("string"),
},
},
InstanceTypeId: pulumi.String("string"),
InstanceName: pulumi.String("string"),
KeepImageCredential: pulumi.Bool(false),
Password: pulumi.String("string"),
HpcClusterId: pulumi.String("string"),
HttpTokens: pulumi.String("string"),
EndDeliveryAt: pulumi.String("string"),
InstallRunCommandAgent: pulumi.Bool(false),
InstanceCount: pulumi.Int(0),
ElasticScheduledInstanceType: pulumi.String("string"),
EipAddress: &ecs.ScheduledInstanceEipAddressArgs{
BandwidthMbps: pulumi.Int(0),
BandwidthPackageId: pulumi.String("string"),
ChargeType: pulumi.String("string"),
Isp: pulumi.String("string"),
ReleaseWithInstance: pulumi.Bool(false),
SecurityProtectionInstanceId: pulumi.Int(0),
SecurityProtectionTypes: pulumi.StringArray{
pulumi.String("string"),
},
},
AutoReleaseAt: pulumi.String("string"),
KeyPairName: pulumi.String("string"),
MinCount: pulumi.Int(0),
Description: pulumi.String("string"),
HostName: pulumi.String("string"),
ProjectName: pulumi.String("string"),
ScheduledInstanceDescription: pulumi.String("string"),
DeliveryType: pulumi.String("string"),
SecurityEnhancementStrategy: pulumi.String("string"),
StartDeliveryAt: pulumi.String("string"),
SuffixIndex: pulumi.Int(0),
Tags: ecs.ScheduledInstanceTagArray{
&ecs.ScheduledInstanceTagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
UniqueSuffix: pulumi.Bool(false),
UserData: pulumi.String("string"),
DeletionProtection: pulumi.Bool(false),
CpuMaxFrequency: pulumi.Float64(0),
})
resource "volcenginecc_ecs_scheduled_instance" "scheduledInstanceResource" {
lifecycle {
create_before_destroy = true
}
image_id = "string"
zone_id = "string"
volumes {
delete_with_instance = false
extra_performance_iops = 0
extra_performance_throughput_mb = 0
extra_performance_type_id = "string"
size = 0
snapshot_id = "string"
volume_type = "string"
}
scheduled_instance_name = "string"
network_interfaces {
primary_ip_address = "string"
private_ip_addresses = ["string"]
security_group_ids = ["string"]
subnet_id = "string"
vpc_id = "string"
}
instance_type_id = "string"
instance_name = "string"
keep_image_credential = false
password = "string"
hpc_cluster_id = "string"
http_tokens = "string"
end_delivery_at = "string"
install_run_command_agent = false
instance_count = 0
elastic_scheduled_instance_type = "string"
eip_address = {
bandwidth_mbps = 0
bandwidth_package_id = "string"
charge_type = "string"
isp = "string"
release_with_instance = false
security_protection_instance_id = 0
security_protection_types = ["string"]
}
auto_release_at = "string"
key_pair_name = "string"
min_count = 0
description = "string"
host_name = "string"
project_name = "string"
scheduled_instance_description = "string"
delivery_type = "string"
security_enhancement_strategy = "string"
start_delivery_at = "string"
suffix_index = 0
tags {
key = "string"
value = "string"
}
unique_suffix = false
user_data = "string"
deletion_protection = false
cpu_max_frequency = 0
}
var scheduledInstanceResource = new ScheduledInstance("scheduledInstanceResource", ScheduledInstanceArgs.builder()
.imageId("string")
.zoneId("string")
.volumes(ScheduledInstanceVolumeArgs.builder()
.deleteWithInstance(false)
.extraPerformanceIops(0)
.extraPerformanceThroughputMb(0)
.extraPerformanceTypeId("string")
.size(0)
.snapshotId("string")
.volumeType("string")
.build())
.scheduledInstanceName("string")
.networkInterfaces(ScheduledInstanceNetworkInterfaceArgs.builder()
.primaryIpAddress("string")
.privateIpAddresses("string")
.securityGroupIds("string")
.subnetId("string")
.vpcId("string")
.build())
.instanceTypeId("string")
.instanceName("string")
.keepImageCredential(false)
.password("string")
.hpcClusterId("string")
.httpTokens("string")
.endDeliveryAt("string")
.installRunCommandAgent(false)
.instanceCount(0)
.elasticScheduledInstanceType("string")
.eipAddress(ScheduledInstanceEipAddressArgs.builder()
.bandwidthMbps(0)
.bandwidthPackageId("string")
.chargeType("string")
.isp("string")
.releaseWithInstance(false)
.securityProtectionInstanceId(0)
.securityProtectionTypes("string")
.build())
.autoReleaseAt("string")
.keyPairName("string")
.minCount(0)
.description("string")
.hostName("string")
.projectName("string")
.scheduledInstanceDescription("string")
.deliveryType("string")
.securityEnhancementStrategy("string")
.startDeliveryAt("string")
.suffixIndex(0)
.tags(ScheduledInstanceTagArgs.builder()
.key("string")
.value("string")
.build())
.uniqueSuffix(false)
.userData("string")
.deletionProtection(false)
.cpuMaxFrequency(0.0)
.build());
scheduled_instance_resource = volcenginecc.ecs.ScheduledInstance("scheduledInstanceResource",
image_id="string",
zone_id="string",
volumes=[{
"delete_with_instance": False,
"extra_performance_iops": 0,
"extra_performance_throughput_mb": 0,
"extra_performance_type_id": "string",
"size": 0,
"snapshot_id": "string",
"volume_type": "string",
}],
scheduled_instance_name="string",
network_interfaces=[{
"primary_ip_address": "string",
"private_ip_addresses": ["string"],
"security_group_ids": ["string"],
"subnet_id": "string",
"vpc_id": "string",
}],
instance_type_id="string",
instance_name="string",
keep_image_credential=False,
password="string",
hpc_cluster_id="string",
http_tokens="string",
end_delivery_at="string",
install_run_command_agent=False,
instance_count=0,
elastic_scheduled_instance_type="string",
eip_address={
"bandwidth_mbps": 0,
"bandwidth_package_id": "string",
"charge_type": "string",
"isp": "string",
"release_with_instance": False,
"security_protection_instance_id": 0,
"security_protection_types": ["string"],
},
auto_release_at="string",
key_pair_name="string",
min_count=0,
description="string",
host_name="string",
project_name="string",
scheduled_instance_description="string",
delivery_type="string",
security_enhancement_strategy="string",
start_delivery_at="string",
suffix_index=0,
tags=[{
"key": "string",
"value": "string",
}],
unique_suffix=False,
user_data="string",
deletion_protection=False,
cpu_max_frequency=float(0))
const scheduledInstanceResource = new volcenginecc.ecs.ScheduledInstance("scheduledInstanceResource", {
imageId: "string",
zoneId: "string",
volumes: [{
deleteWithInstance: false,
extraPerformanceIops: 0,
extraPerformanceThroughputMb: 0,
extraPerformanceTypeId: "string",
size: 0,
snapshotId: "string",
volumeType: "string",
}],
scheduledInstanceName: "string",
networkInterfaces: [{
primaryIpAddress: "string",
privateIpAddresses: ["string"],
securityGroupIds: ["string"],
subnetId: "string",
vpcId: "string",
}],
instanceTypeId: "string",
instanceName: "string",
keepImageCredential: false,
password: "string",
hpcClusterId: "string",
httpTokens: "string",
endDeliveryAt: "string",
installRunCommandAgent: false,
instanceCount: 0,
elasticScheduledInstanceType: "string",
eipAddress: {
bandwidthMbps: 0,
bandwidthPackageId: "string",
chargeType: "string",
isp: "string",
releaseWithInstance: false,
securityProtectionInstanceId: 0,
securityProtectionTypes: ["string"],
},
autoReleaseAt: "string",
keyPairName: "string",
minCount: 0,
description: "string",
hostName: "string",
projectName: "string",
scheduledInstanceDescription: "string",
deliveryType: "string",
securityEnhancementStrategy: "string",
startDeliveryAt: "string",
suffixIndex: 0,
tags: [{
key: "string",
value: "string",
}],
uniqueSuffix: false,
userData: "string",
deletionProtection: false,
cpuMaxFrequency: 0,
});
type: volcenginecc:ecs:ScheduledInstance
properties:
autoReleaseAt: string
cpuMaxFrequency: 0
deletionProtection: false
deliveryType: string
description: string
eipAddress:
bandwidthMbps: 0
bandwidthPackageId: string
chargeType: string
isp: string
releaseWithInstance: false
securityProtectionInstanceId: 0
securityProtectionTypes:
- string
elasticScheduledInstanceType: string
endDeliveryAt: string
hostName: string
hpcClusterId: string
httpTokens: string
imageId: string
installRunCommandAgent: false
instanceCount: 0
instanceName: string
instanceTypeId: string
keepImageCredential: false
keyPairName: string
minCount: 0
networkInterfaces:
- primaryIpAddress: string
privateIpAddresses:
- string
securityGroupIds:
- string
subnetId: string
vpcId: string
password: string
projectName: string
scheduledInstanceDescription: string
scheduledInstanceName: string
securityEnhancementStrategy: string
startDeliveryAt: string
suffixIndex: 0
tags:
- key: string
value: string
uniqueSuffix: false
userData: string
volumes:
- deleteWithInstance: false
extraPerformanceIops: 0
extraPerformanceThroughputMb: 0
extraPerformanceTypeId: string
size: 0
snapshotId: string
volumeType: string
zoneId: string
ScheduledInstance Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ScheduledInstance resource accepts the following input properties:
- Image
Id string - The image ID used to launch the instance. You can use [DescribeImages] to query available image resources.
- Instance
Name string Instance name - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods "." - Length must be between 1 and 128 characters
Note: - If the instance has a
SuffixIndexsequential suffix, the instance name length includes the suffix - When creating instances in bulk, you can use thename_prefix[begin_number,bits]name_suffixformat to customize sequential instance names. For details, see [Batch Set Sequential Instance Names or Host Names]- Instance
Type stringId - Instance type. - For supported instance types available for reservation, see [Elastic Scheduled Instance Overview]. - You can call [DescribeAvailableResource] to query inventory information for compute resources in the availability zone.
- Network
Interfaces List<Volcengine.Scheduled Instance Network Interface> - Network interface configuration information specified when creating the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Scheduled
Instance stringName - Name of the elastic reservation order. Values: - Cannot start with a number, hyphen, or underscore. - Can only contain Chinese characters, letters, numbers, underscores, and hyphens. - Length limit: 1–128 characters. - Special characters are not supported.
- Volumes
List<Volcengine.
Scheduled Instance Volume> - Cloud disk configuration information specified when creating an instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Zone
Id string - Availability zone ID where the instance is located. You can call [DescribeZones] to query the availability zones in a region.
- Auto
Release stringAt - Instance automatic release time. Must be at a 10-minute mark. When
ElasticScheduledInstanceTypeis set to Segmented, this parameter is required. Value range: - WhenDeliveryTypeis Reserve, the earliest release time is one hour after the reserved delivery time slot. - WhenDeliveryTypeis Immediate, the earliest release time is the next 10-minute mark after the current time. For example, if the current time is 5:02, the earliest automatic release time is 5:20. - Cpu
Max doubleFrequency Specify the maximum CPU frequency in GHz. Value range: between the base frequency and turbo frequency of the CPU.
Note: - Currently, only g3al (4xlarge, 8xlarge, 16xlarge, 32xlarge), c3al (4xlarge, 8xlarge, 16xlarge, 32xlarge), r3al (4xlarge, 8xlarge, 16xlarge), g4i, c4i, r4i, g4ie, c4ie, r4ie instances support this parameter. For details on base/turbo frequency and more information, see [Instance Specifications]. - This feature is in invitation-only testing. To use it, contact your account manager.
- Deletion
Protection bool - Instance deletion protection attribute. Specifies whether the instance can be deleted via console or API. Values: - true: Enable instance deletion protection - false (default): Disable instance deletion protection
- Delivery
Type string - Elastic Scheduled Instance - Segmented delivery type. Values: - Reserve (default): scheduled delivery - Immediate: immediate delivery
Note: - This parameter is required only when
ElasticScheduledInstanceTypeis set toSegmented. - Elastic Scheduled Instance - Segmented is currently in invitation testing. To apply for a trial, please contact your account manager. - Description string
- Instance description. The default value is an empty string. - Must start with a letter or Chinese character. - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals sign '=', English comma ',', Chinese comma ',', and Chinese period '。' - Maximum length is 255 characters.
- Eip
Address Volcengine.Scheduled Instance Eip Address - Public IP configuration specified when creating the instance.
- Elastic
Scheduled stringInstance Type - Elastic scheduled instance type. Options: - Esi (default): Elastic scheduled instance. - Segmented: Elastic scheduled instance (time segment). Note: Elastic scheduled instance (time segment) is currently in invite-only beta. To try it, please contact your account manager.
- End
Delivery stringAt - Instance end delivery time. Must be on a 10-minute mark, and the interval with
StartDeliveryAtmust be 10 minutes - IfElasticScheduledInstanceTypeisEsi, the end delivery time must be within 4–8 hours after reservation - IfElasticScheduledInstanceTypeisSegmented: - IfDeliveryTypeisReserve, the end delivery time must be within 24 hours after reservation - IfDeliveryTypeisImmediate, this parameter is not required - Host
Name string Instance hostname, which is the computer name inside the instance operating system. - Linux instances: - Letters, numbers, periods ("."), and hyphens ("-") are allowed. - Cannot start or end with a hyphen or period, and hyphens and periods cannot be used consecutively. - Length must be between 2 and 63 characters for Linux systems. - Windows instances: - Letters, numbers, and hyphens ("-") are allowed, but the name cannot consist of only numbers. - Cannot start or end with a hyphen, and hyphens cannot be used consecutively. - Length must be between 2 and 15 characters for Windows systems.
Note: - If left blank, the hostname is automatically generated according to the iv - + initial hostname rule, for example, iv-3tigy72q3u3vj0******. - Initial hostname generation logic: - Linux: Extract all characters after the instance ID i-. - Windows: Extract the last 12 characters after the instance ID i-. - When creating instances in batches, you can use the
name_prefix[begin_number,bits]name_suffixformat to customize sequential hostnames. For details, see [Batch Set Sequential Instance Names or Hostnames].- Hpc
Cluster stringId - When creating a high-performance computing GPU instance, specify the high-performance computing cluster ID.
- Http
Tokens string - Instance metadata access mode: whether to enforce enhanced mode. Values: - optional (default): Not enforced (compatible mode), meaning instance metadata can be accessed either directly or via token-based authentication. - required: Enforced (enhanced mode only), meaning instance metadata can only be accessed via token-based authentication. Note: - For details on how to view metadata and supported metadata items, see [View Instance Metadata]. - Enhanced mode is currently in invitation testing. To request access, contact your account manager.
- Install
Run boolCommand Agent Whether to install the Cloud Assistant Agent when creating the instance. Values: - true: Install during creation - false (default): Do not install during creation
Note: For more information about Cloud Assistant, see [Cloud Assistant Overview].
- Instance
Count int Number of instances to create. Value range: - If
ElasticScheduledInstanceTypeis set toEsi, value range is 1–500. - IfElasticScheduledInstanceTypeis set toSegmented, then: - IfDeliveryTypeisReserve, value range is 1–500. - IfDeliveryTypeisImmediate, value range is 1–100.Note: If 0 is entered, the default is 1.
- Keep
Image boolCredential - Whether to retain image settings. Values: - true: Retain image settings. If retained, the instance will use the preset password or key pair from the image for login. - false (default): Do not retain image settings.
Note: - Only custom images and shared images support this feature. - When this parameter is set to
true, do not specifyPassWordorKeyPairName. - Key
Pair stringName To log in to the instance using an SSH key, specify the name of an existing key pair. You can call [DescribeKeyPairs] to view existing key pairs; if none are available, call [CreateKeyPair] to create one
Note: - Windows instances do not support SSH key login. Even if this parameter is provided, only the password
Passwordis valid - Linux instances support login via password or key pair. If bothKeyPairNameandPasswordare set when calling this API, onlyKeyPairNametakes effect- Min
Count int - Specify the minimum number of Elastic Scheduled Instances to create. Value range: - ESI-General, ESI-Segmented (Scheduled Delivery): 1–500 - ESI-Segmented (Immediate Delivery): 1–100
Note: - The minimum instance creation quantity
MinCount≤ creation quantityCount. - If inventory quantity > creation quantityCount, create according toCount. - If minimum creation quantityMinCount≤ inventory quantity ≤ creation quantityCount, create according to inventory quantity. - If inventory quantity < minimum creation quantityMinCount, creation fails due to insufficient inventory. - Password string
- If you want to log in to the instance using the 'password' method, specify the initial login password for the administrator account through this parameter. The Linux administrator account is root, and the Windows administrator account is Administrator. Password complexity requirements: - Length must be between 8 and 30 characters. - Password must contain at least three of the following: uppercase letters, lowercase letters, numbers, and special characters. - Allowed special characters: `~!@#$%^&*()_-+=|{}[]:;'<>,.?/ - Cannot start with '/' or '$6$'. Note: Login credentials support three methods: 'password', 'key pair', and 'retain image settings'. When using the 'password' method to log in, it is recommended to increase password complexity for enhanced security.
- Project
Name string - Project to which the resource belongs. Each resource can belong to only one project. - Can only contain letters, numbers, underscore '_', period '.', and hyphen '-'. - Maximum length is 64 characters.
- Scheduled
Instance stringDescription - Description of the flexible reservation order. The default value is an empty string. - Must start with a letter or Chinese character. - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals sign '=', English comma ',', Chinese comma ',', and Chinese period '。' - Maximum length is 255 characters.
- Security
Enhancement stringStrategy - Whether to enable security hardening. Values: - Active: Enable security hardening, applies only to public images. - InActive: Disable security hardening, applies to all image types.
- Start
Delivery stringAt - Instance delivery start time. Must be on a 10-minute mark (e.g., 10:00, 10:10, 10:20, etc.). - When
ElasticScheduledInstanceTypeis set toEsi, delivery time is within 4–8 hours after reservation. - WhenElasticScheduledInstanceTypeis set toSegmented: - IfDeliveryTypeisReserve, delivery time is within 24 hours after reservation. - IfDeliveryTypeisImmediate, this parameter is not required. - Suffix
Index int - Starting sequence number for ordered suffix. Value range: 1–999. Default is 1.
-
List<Volcengine.
Scheduled Instance Tag> - Flexible reservation order tag information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Unique
Suffix bool - Indicates whether to automatically add an ordered suffix to
HostNameandInstanceNamewhen creating multiple instances. Values: - true: Enable ordered suffix. - false (default): Disable ordered suffix. Note: - When ordered suffix is enabled andHostNameis empty, the system will automatically generate a host name without an ordered suffix. - When ordered suffix is enabled and the[begin_number,bits]naming format is specified forHostNameorInstanceName, see [Batch Set Ordered Instance Names or Host Names] for the final effect. - User
Data string - Instance custom data. Custom data must be Base64-encoded, and the size before encoding must not exceed 16KB. If not specified, defaults to empty.
- Image
Id string - The image ID used to launch the instance. You can use [DescribeImages] to query available image resources.
- Instance
Name string Instance name - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods "." - Length must be between 1 and 128 characters
Note: - If the instance has a
SuffixIndexsequential suffix, the instance name length includes the suffix - When creating instances in bulk, you can use thename_prefix[begin_number,bits]name_suffixformat to customize sequential instance names. For details, see [Batch Set Sequential Instance Names or Host Names]- Instance
Type stringId - Instance type. - For supported instance types available for reservation, see [Elastic Scheduled Instance Overview]. - You can call [DescribeAvailableResource] to query inventory information for compute resources in the availability zone.
- Network
Interfaces []ScheduledInstance Network Interface Args - Network interface configuration information specified when creating the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Scheduled
Instance stringName - Name of the elastic reservation order. Values: - Cannot start with a number, hyphen, or underscore. - Can only contain Chinese characters, letters, numbers, underscores, and hyphens. - Length limit: 1–128 characters. - Special characters are not supported.
- Volumes
[]Scheduled
Instance Volume Args - Cloud disk configuration information specified when creating an instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Zone
Id string - Availability zone ID where the instance is located. You can call [DescribeZones] to query the availability zones in a region.
- Auto
Release stringAt - Instance automatic release time. Must be at a 10-minute mark. When
ElasticScheduledInstanceTypeis set to Segmented, this parameter is required. Value range: - WhenDeliveryTypeis Reserve, the earliest release time is one hour after the reserved delivery time slot. - WhenDeliveryTypeis Immediate, the earliest release time is the next 10-minute mark after the current time. For example, if the current time is 5:02, the earliest automatic release time is 5:20. - Cpu
Max float64Frequency Specify the maximum CPU frequency in GHz. Value range: between the base frequency and turbo frequency of the CPU.
Note: - Currently, only g3al (4xlarge, 8xlarge, 16xlarge, 32xlarge), c3al (4xlarge, 8xlarge, 16xlarge, 32xlarge), r3al (4xlarge, 8xlarge, 16xlarge), g4i, c4i, r4i, g4ie, c4ie, r4ie instances support this parameter. For details on base/turbo frequency and more information, see [Instance Specifications]. - This feature is in invitation-only testing. To use it, contact your account manager.
- Deletion
Protection bool - Instance deletion protection attribute. Specifies whether the instance can be deleted via console or API. Values: - true: Enable instance deletion protection - false (default): Disable instance deletion protection
- Delivery
Type string - Elastic Scheduled Instance - Segmented delivery type. Values: - Reserve (default): scheduled delivery - Immediate: immediate delivery
Note: - This parameter is required only when
ElasticScheduledInstanceTypeis set toSegmented. - Elastic Scheduled Instance - Segmented is currently in invitation testing. To apply for a trial, please contact your account manager. - Description string
- Instance description. The default value is an empty string. - Must start with a letter or Chinese character. - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals sign '=', English comma ',', Chinese comma ',', and Chinese period '。' - Maximum length is 255 characters.
- Eip
Address ScheduledInstance Eip Address Args - Public IP configuration specified when creating the instance.
- Elastic
Scheduled stringInstance Type - Elastic scheduled instance type. Options: - Esi (default): Elastic scheduled instance. - Segmented: Elastic scheduled instance (time segment). Note: Elastic scheduled instance (time segment) is currently in invite-only beta. To try it, please contact your account manager.
- End
Delivery stringAt - Instance end delivery time. Must be on a 10-minute mark, and the interval with
StartDeliveryAtmust be 10 minutes - IfElasticScheduledInstanceTypeisEsi, the end delivery time must be within 4–8 hours after reservation - IfElasticScheduledInstanceTypeisSegmented: - IfDeliveryTypeisReserve, the end delivery time must be within 24 hours after reservation - IfDeliveryTypeisImmediate, this parameter is not required - Host
Name string Instance hostname, which is the computer name inside the instance operating system. - Linux instances: - Letters, numbers, periods ("."), and hyphens ("-") are allowed. - Cannot start or end with a hyphen or period, and hyphens and periods cannot be used consecutively. - Length must be between 2 and 63 characters for Linux systems. - Windows instances: - Letters, numbers, and hyphens ("-") are allowed, but the name cannot consist of only numbers. - Cannot start or end with a hyphen, and hyphens cannot be used consecutively. - Length must be between 2 and 15 characters for Windows systems.
Note: - If left blank, the hostname is automatically generated according to the iv - + initial hostname rule, for example, iv-3tigy72q3u3vj0******. - Initial hostname generation logic: - Linux: Extract all characters after the instance ID i-. - Windows: Extract the last 12 characters after the instance ID i-. - When creating instances in batches, you can use the
name_prefix[begin_number,bits]name_suffixformat to customize sequential hostnames. For details, see [Batch Set Sequential Instance Names or Hostnames].- Hpc
Cluster stringId - When creating a high-performance computing GPU instance, specify the high-performance computing cluster ID.
- Http
Tokens string - Instance metadata access mode: whether to enforce enhanced mode. Values: - optional (default): Not enforced (compatible mode), meaning instance metadata can be accessed either directly or via token-based authentication. - required: Enforced (enhanced mode only), meaning instance metadata can only be accessed via token-based authentication. Note: - For details on how to view metadata and supported metadata items, see [View Instance Metadata]. - Enhanced mode is currently in invitation testing. To request access, contact your account manager.
- Install
Run boolCommand Agent Whether to install the Cloud Assistant Agent when creating the instance. Values: - true: Install during creation - false (default): Do not install during creation
Note: For more information about Cloud Assistant, see [Cloud Assistant Overview].
- Instance
Count int Number of instances to create. Value range: - If
ElasticScheduledInstanceTypeis set toEsi, value range is 1–500. - IfElasticScheduledInstanceTypeis set toSegmented, then: - IfDeliveryTypeisReserve, value range is 1–500. - IfDeliveryTypeisImmediate, value range is 1–100.Note: If 0 is entered, the default is 1.
- Keep
Image boolCredential - Whether to retain image settings. Values: - true: Retain image settings. If retained, the instance will use the preset password or key pair from the image for login. - false (default): Do not retain image settings.
Note: - Only custom images and shared images support this feature. - When this parameter is set to
true, do not specifyPassWordorKeyPairName. - Key
Pair stringName To log in to the instance using an SSH key, specify the name of an existing key pair. You can call [DescribeKeyPairs] to view existing key pairs; if none are available, call [CreateKeyPair] to create one
Note: - Windows instances do not support SSH key login. Even if this parameter is provided, only the password
Passwordis valid - Linux instances support login via password or key pair. If bothKeyPairNameandPasswordare set when calling this API, onlyKeyPairNametakes effect- Min
Count int - Specify the minimum number of Elastic Scheduled Instances to create. Value range: - ESI-General, ESI-Segmented (Scheduled Delivery): 1–500 - ESI-Segmented (Immediate Delivery): 1–100
Note: - The minimum instance creation quantity
MinCount≤ creation quantityCount. - If inventory quantity > creation quantityCount, create according toCount. - If minimum creation quantityMinCount≤ inventory quantity ≤ creation quantityCount, create according to inventory quantity. - If inventory quantity < minimum creation quantityMinCount, creation fails due to insufficient inventory. - Password string
- If you want to log in to the instance using the 'password' method, specify the initial login password for the administrator account through this parameter. The Linux administrator account is root, and the Windows administrator account is Administrator. Password complexity requirements: - Length must be between 8 and 30 characters. - Password must contain at least three of the following: uppercase letters, lowercase letters, numbers, and special characters. - Allowed special characters: `~!@#$%^&*()_-+=|{}[]:;'<>,.?/ - Cannot start with '/' or '$6$'. Note: Login credentials support three methods: 'password', 'key pair', and 'retain image settings'. When using the 'password' method to log in, it is recommended to increase password complexity for enhanced security.
- Project
Name string - Project to which the resource belongs. Each resource can belong to only one project. - Can only contain letters, numbers, underscore '_', period '.', and hyphen '-'. - Maximum length is 64 characters.
- Scheduled
Instance stringDescription - Description of the flexible reservation order. The default value is an empty string. - Must start with a letter or Chinese character. - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals sign '=', English comma ',', Chinese comma ',', and Chinese period '。' - Maximum length is 255 characters.
- Security
Enhancement stringStrategy - Whether to enable security hardening. Values: - Active: Enable security hardening, applies only to public images. - InActive: Disable security hardening, applies to all image types.
- Start
Delivery stringAt - Instance delivery start time. Must be on a 10-minute mark (e.g., 10:00, 10:10, 10:20, etc.). - When
ElasticScheduledInstanceTypeis set toEsi, delivery time is within 4–8 hours after reservation. - WhenElasticScheduledInstanceTypeis set toSegmented: - IfDeliveryTypeisReserve, delivery time is within 24 hours after reservation. - IfDeliveryTypeisImmediate, this parameter is not required. - Suffix
Index int - Starting sequence number for ordered suffix. Value range: 1–999. Default is 1.
-
[]Scheduled
Instance Tag Args - Flexible reservation order tag information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Unique
Suffix bool - Indicates whether to automatically add an ordered suffix to
HostNameandInstanceNamewhen creating multiple instances. Values: - true: Enable ordered suffix. - false (default): Disable ordered suffix. Note: - When ordered suffix is enabled andHostNameis empty, the system will automatically generate a host name without an ordered suffix. - When ordered suffix is enabled and the[begin_number,bits]naming format is specified forHostNameorInstanceName, see [Batch Set Ordered Instance Names or Host Names] for the final effect. - User
Data string - Instance custom data. Custom data must be Base64-encoded, and the size before encoding must not exceed 16KB. If not specified, defaults to empty.
- image_
id string - The image ID used to launch the instance. You can use [DescribeImages] to query available image resources.
- instance_
name string Instance name - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods "." - Length must be between 1 and 128 characters
Note: - If the instance has a
SuffixIndexsequential suffix, the instance name length includes the suffix - When creating instances in bulk, you can use thename_prefix[begin_number,bits]name_suffixformat to customize sequential instance names. For details, see [Batch Set Sequential Instance Names or Host Names]- instance_
type_ stringid - Instance type. - For supported instance types available for reservation, see [Elastic Scheduled Instance Overview]. - You can call [DescribeAvailableResource] to query inventory information for compute resources in the availability zone.
- network_
interfaces list(object) - Network interface configuration information specified when creating the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- scheduled_
instance_ stringname - Name of the elastic reservation order. Values: - Cannot start with a number, hyphen, or underscore. - Can only contain Chinese characters, letters, numbers, underscores, and hyphens. - Length limit: 1–128 characters. - Special characters are not supported.
- volumes list(object)
- Cloud disk configuration information specified when creating an instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- zone_
id string - Availability zone ID where the instance is located. You can call [DescribeZones] to query the availability zones in a region.
- auto_
release_ stringat - Instance automatic release time. Must be at a 10-minute mark. When
ElasticScheduledInstanceTypeis set to Segmented, this parameter is required. Value range: - WhenDeliveryTypeis Reserve, the earliest release time is one hour after the reserved delivery time slot. - WhenDeliveryTypeis Immediate, the earliest release time is the next 10-minute mark after the current time. For example, if the current time is 5:02, the earliest automatic release time is 5:20. - cpu_
max_ numberfrequency Specify the maximum CPU frequency in GHz. Value range: between the base frequency and turbo frequency of the CPU.
Note: - Currently, only g3al (4xlarge, 8xlarge, 16xlarge, 32xlarge), c3al (4xlarge, 8xlarge, 16xlarge, 32xlarge), r3al (4xlarge, 8xlarge, 16xlarge), g4i, c4i, r4i, g4ie, c4ie, r4ie instances support this parameter. For details on base/turbo frequency and more information, see [Instance Specifications]. - This feature is in invitation-only testing. To use it, contact your account manager.
- deletion_
protection bool - Instance deletion protection attribute. Specifies whether the instance can be deleted via console or API. Values: - true: Enable instance deletion protection - false (default): Disable instance deletion protection
- delivery_
type string - Elastic Scheduled Instance - Segmented delivery type. Values: - Reserve (default): scheduled delivery - Immediate: immediate delivery
Note: - This parameter is required only when
ElasticScheduledInstanceTypeis set toSegmented. - Elastic Scheduled Instance - Segmented is currently in invitation testing. To apply for a trial, please contact your account manager. - description string
- Instance description. The default value is an empty string. - Must start with a letter or Chinese character. - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals sign '=', English comma ',', Chinese comma ',', and Chinese period '。' - Maximum length is 255 characters.
- eip_
address object - Public IP configuration specified when creating the instance.
- elastic_
scheduled_ stringinstance_ type - Elastic scheduled instance type. Options: - Esi (default): Elastic scheduled instance. - Segmented: Elastic scheduled instance (time segment). Note: Elastic scheduled instance (time segment) is currently in invite-only beta. To try it, please contact your account manager.
- end_
delivery_ stringat - Instance end delivery time. Must be on a 10-minute mark, and the interval with
StartDeliveryAtmust be 10 minutes - IfElasticScheduledInstanceTypeisEsi, the end delivery time must be within 4–8 hours after reservation - IfElasticScheduledInstanceTypeisSegmented: - IfDeliveryTypeisReserve, the end delivery time must be within 24 hours after reservation - IfDeliveryTypeisImmediate, this parameter is not required - host_
name string Instance hostname, which is the computer name inside the instance operating system. - Linux instances: - Letters, numbers, periods ("."), and hyphens ("-") are allowed. - Cannot start or end with a hyphen or period, and hyphens and periods cannot be used consecutively. - Length must be between 2 and 63 characters for Linux systems. - Windows instances: - Letters, numbers, and hyphens ("-") are allowed, but the name cannot consist of only numbers. - Cannot start or end with a hyphen, and hyphens cannot be used consecutively. - Length must be between 2 and 15 characters for Windows systems.
Note: - If left blank, the hostname is automatically generated according to the iv - + initial hostname rule, for example, iv-3tigy72q3u3vj0******. - Initial hostname generation logic: - Linux: Extract all characters after the instance ID i-. - Windows: Extract the last 12 characters after the instance ID i-. - When creating instances in batches, you can use the
name_prefix[begin_number,bits]name_suffixformat to customize sequential hostnames. For details, see [Batch Set Sequential Instance Names or Hostnames].- hpc_
cluster_ stringid - When creating a high-performance computing GPU instance, specify the high-performance computing cluster ID.
- http_
tokens string - Instance metadata access mode: whether to enforce enhanced mode. Values: - optional (default): Not enforced (compatible mode), meaning instance metadata can be accessed either directly or via token-based authentication. - required: Enforced (enhanced mode only), meaning instance metadata can only be accessed via token-based authentication. Note: - For details on how to view metadata and supported metadata items, see [View Instance Metadata]. - Enhanced mode is currently in invitation testing. To request access, contact your account manager.
- install_
run_ boolcommand_ agent Whether to install the Cloud Assistant Agent when creating the instance. Values: - true: Install during creation - false (default): Do not install during creation
Note: For more information about Cloud Assistant, see [Cloud Assistant Overview].
- instance_
count number Number of instances to create. Value range: - If
ElasticScheduledInstanceTypeis set toEsi, value range is 1–500. - IfElasticScheduledInstanceTypeis set toSegmented, then: - IfDeliveryTypeisReserve, value range is 1–500. - IfDeliveryTypeisImmediate, value range is 1–100.Note: If 0 is entered, the default is 1.
- keep_
image_ boolcredential - Whether to retain image settings. Values: - true: Retain image settings. If retained, the instance will use the preset password or key pair from the image for login. - false (default): Do not retain image settings.
Note: - Only custom images and shared images support this feature. - When this parameter is set to
true, do not specifyPassWordorKeyPairName. - key_
pair_ stringname To log in to the instance using an SSH key, specify the name of an existing key pair. You can call [DescribeKeyPairs] to view existing key pairs; if none are available, call [CreateKeyPair] to create one
Note: - Windows instances do not support SSH key login. Even if this parameter is provided, only the password
Passwordis valid - Linux instances support login via password or key pair. If bothKeyPairNameandPasswordare set when calling this API, onlyKeyPairNametakes effect- min_
count number - Specify the minimum number of Elastic Scheduled Instances to create. Value range: - ESI-General, ESI-Segmented (Scheduled Delivery): 1–500 - ESI-Segmented (Immediate Delivery): 1–100
Note: - The minimum instance creation quantity
MinCount≤ creation quantityCount. - If inventory quantity > creation quantityCount, create according toCount. - If minimum creation quantityMinCount≤ inventory quantity ≤ creation quantityCount, create according to inventory quantity. - If inventory quantity < minimum creation quantityMinCount, creation fails due to insufficient inventory. - password string
- If you want to log in to the instance using the 'password' method, specify the initial login password for the administrator account through this parameter. The Linux administrator account is root, and the Windows administrator account is Administrator. Password complexity requirements: - Length must be between 8 and 30 characters. - Password must contain at least three of the following: uppercase letters, lowercase letters, numbers, and special characters. - Allowed special characters: `~!@#$%^&*()_-+=|{}[]:;'<>,.?/ - Cannot start with '/' or '$6$'. Note: Login credentials support three methods: 'password', 'key pair', and 'retain image settings'. When using the 'password' method to log in, it is recommended to increase password complexity for enhanced security.
- project_
name string - Project to which the resource belongs. Each resource can belong to only one project. - Can only contain letters, numbers, underscore '_', period '.', and hyphen '-'. - Maximum length is 64 characters.
- scheduled_
instance_ stringdescription - Description of the flexible reservation order. The default value is an empty string. - Must start with a letter or Chinese character. - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals sign '=', English comma ',', Chinese comma ',', and Chinese period '。' - Maximum length is 255 characters.
- security_
enhancement_ stringstrategy - Whether to enable security hardening. Values: - Active: Enable security hardening, applies only to public images. - InActive: Disable security hardening, applies to all image types.
- start_
delivery_ stringat - Instance delivery start time. Must be on a 10-minute mark (e.g., 10:00, 10:10, 10:20, etc.). - When
ElasticScheduledInstanceTypeis set toEsi, delivery time is within 4–8 hours after reservation. - WhenElasticScheduledInstanceTypeis set toSegmented: - IfDeliveryTypeisReserve, delivery time is within 24 hours after reservation. - IfDeliveryTypeisImmediate, this parameter is not required. - suffix_
index number - Starting sequence number for ordered suffix. Value range: 1–999. Default is 1.
- list(object)
- Flexible reservation order tag information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- unique_
suffix bool - Indicates whether to automatically add an ordered suffix to
HostNameandInstanceNamewhen creating multiple instances. Values: - true: Enable ordered suffix. - false (default): Disable ordered suffix. Note: - When ordered suffix is enabled andHostNameis empty, the system will automatically generate a host name without an ordered suffix. - When ordered suffix is enabled and the[begin_number,bits]naming format is specified forHostNameorInstanceName, see [Batch Set Ordered Instance Names or Host Names] for the final effect. - user_
data string - Instance custom data. Custom data must be Base64-encoded, and the size before encoding must not exceed 16KB. If not specified, defaults to empty.
- image
Id String - The image ID used to launch the instance. You can use [DescribeImages] to query available image resources.
- instance
Name String Instance name - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods "." - Length must be between 1 and 128 characters
Note: - If the instance has a
SuffixIndexsequential suffix, the instance name length includes the suffix - When creating instances in bulk, you can use thename_prefix[begin_number,bits]name_suffixformat to customize sequential instance names. For details, see [Batch Set Sequential Instance Names or Host Names]- instance
Type StringId - Instance type. - For supported instance types available for reservation, see [Elastic Scheduled Instance Overview]. - You can call [DescribeAvailableResource] to query inventory information for compute resources in the availability zone.
- network
Interfaces List<ScheduledInstance Network Interface> - Network interface configuration information specified when creating the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- scheduled
Instance StringName - Name of the elastic reservation order. Values: - Cannot start with a number, hyphen, or underscore. - Can only contain Chinese characters, letters, numbers, underscores, and hyphens. - Length limit: 1–128 characters. - Special characters are not supported.
- volumes
List<Scheduled
Instance Volume> - Cloud disk configuration information specified when creating an instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- zone
Id String - Availability zone ID where the instance is located. You can call [DescribeZones] to query the availability zones in a region.
- auto
Release StringAt - Instance automatic release time. Must be at a 10-minute mark. When
ElasticScheduledInstanceTypeis set to Segmented, this parameter is required. Value range: - WhenDeliveryTypeis Reserve, the earliest release time is one hour after the reserved delivery time slot. - WhenDeliveryTypeis Immediate, the earliest release time is the next 10-minute mark after the current time. For example, if the current time is 5:02, the earliest automatic release time is 5:20. - cpu
Max DoubleFrequency Specify the maximum CPU frequency in GHz. Value range: between the base frequency and turbo frequency of the CPU.
Note: - Currently, only g3al (4xlarge, 8xlarge, 16xlarge, 32xlarge), c3al (4xlarge, 8xlarge, 16xlarge, 32xlarge), r3al (4xlarge, 8xlarge, 16xlarge), g4i, c4i, r4i, g4ie, c4ie, r4ie instances support this parameter. For details on base/turbo frequency and more information, see [Instance Specifications]. - This feature is in invitation-only testing. To use it, contact your account manager.
- deletion
Protection Boolean - Instance deletion protection attribute. Specifies whether the instance can be deleted via console or API. Values: - true: Enable instance deletion protection - false (default): Disable instance deletion protection
- delivery
Type String - Elastic Scheduled Instance - Segmented delivery type. Values: - Reserve (default): scheduled delivery - Immediate: immediate delivery
Note: - This parameter is required only when
ElasticScheduledInstanceTypeis set toSegmented. - Elastic Scheduled Instance - Segmented is currently in invitation testing. To apply for a trial, please contact your account manager. - description String
- Instance description. The default value is an empty string. - Must start with a letter or Chinese character. - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals sign '=', English comma ',', Chinese comma ',', and Chinese period '。' - Maximum length is 255 characters.
- eip
Address ScheduledInstance Eip Address - Public IP configuration specified when creating the instance.
- elastic
Scheduled StringInstance Type - Elastic scheduled instance type. Options: - Esi (default): Elastic scheduled instance. - Segmented: Elastic scheduled instance (time segment). Note: Elastic scheduled instance (time segment) is currently in invite-only beta. To try it, please contact your account manager.
- end
Delivery StringAt - Instance end delivery time. Must be on a 10-minute mark, and the interval with
StartDeliveryAtmust be 10 minutes - IfElasticScheduledInstanceTypeisEsi, the end delivery time must be within 4–8 hours after reservation - IfElasticScheduledInstanceTypeisSegmented: - IfDeliveryTypeisReserve, the end delivery time must be within 24 hours after reservation - IfDeliveryTypeisImmediate, this parameter is not required - host
Name String Instance hostname, which is the computer name inside the instance operating system. - Linux instances: - Letters, numbers, periods ("."), and hyphens ("-") are allowed. - Cannot start or end with a hyphen or period, and hyphens and periods cannot be used consecutively. - Length must be between 2 and 63 characters for Linux systems. - Windows instances: - Letters, numbers, and hyphens ("-") are allowed, but the name cannot consist of only numbers. - Cannot start or end with a hyphen, and hyphens cannot be used consecutively. - Length must be between 2 and 15 characters for Windows systems.
Note: - If left blank, the hostname is automatically generated according to the iv - + initial hostname rule, for example, iv-3tigy72q3u3vj0******. - Initial hostname generation logic: - Linux: Extract all characters after the instance ID i-. - Windows: Extract the last 12 characters after the instance ID i-. - When creating instances in batches, you can use the
name_prefix[begin_number,bits]name_suffixformat to customize sequential hostnames. For details, see [Batch Set Sequential Instance Names or Hostnames].- hpc
Cluster StringId - When creating a high-performance computing GPU instance, specify the high-performance computing cluster ID.
- http
Tokens String - Instance metadata access mode: whether to enforce enhanced mode. Values: - optional (default): Not enforced (compatible mode), meaning instance metadata can be accessed either directly or via token-based authentication. - required: Enforced (enhanced mode only), meaning instance metadata can only be accessed via token-based authentication. Note: - For details on how to view metadata and supported metadata items, see [View Instance Metadata]. - Enhanced mode is currently in invitation testing. To request access, contact your account manager.
- install
Run BooleanCommand Agent Whether to install the Cloud Assistant Agent when creating the instance. Values: - true: Install during creation - false (default): Do not install during creation
Note: For more information about Cloud Assistant, see [Cloud Assistant Overview].
- instance
Count Integer Number of instances to create. Value range: - If
ElasticScheduledInstanceTypeis set toEsi, value range is 1–500. - IfElasticScheduledInstanceTypeis set toSegmented, then: - IfDeliveryTypeisReserve, value range is 1–500. - IfDeliveryTypeisImmediate, value range is 1–100.Note: If 0 is entered, the default is 1.
- keep
Image BooleanCredential - Whether to retain image settings. Values: - true: Retain image settings. If retained, the instance will use the preset password or key pair from the image for login. - false (default): Do not retain image settings.
Note: - Only custom images and shared images support this feature. - When this parameter is set to
true, do not specifyPassWordorKeyPairName. - key
Pair StringName To log in to the instance using an SSH key, specify the name of an existing key pair. You can call [DescribeKeyPairs] to view existing key pairs; if none are available, call [CreateKeyPair] to create one
Note: - Windows instances do not support SSH key login. Even if this parameter is provided, only the password
Passwordis valid - Linux instances support login via password or key pair. If bothKeyPairNameandPasswordare set when calling this API, onlyKeyPairNametakes effect- min
Count Integer - Specify the minimum number of Elastic Scheduled Instances to create. Value range: - ESI-General, ESI-Segmented (Scheduled Delivery): 1–500 - ESI-Segmented (Immediate Delivery): 1–100
Note: - The minimum instance creation quantity
MinCount≤ creation quantityCount. - If inventory quantity > creation quantityCount, create according toCount. - If minimum creation quantityMinCount≤ inventory quantity ≤ creation quantityCount, create according to inventory quantity. - If inventory quantity < minimum creation quantityMinCount, creation fails due to insufficient inventory. - password String
- If you want to log in to the instance using the 'password' method, specify the initial login password for the administrator account through this parameter. The Linux administrator account is root, and the Windows administrator account is Administrator. Password complexity requirements: - Length must be between 8 and 30 characters. - Password must contain at least three of the following: uppercase letters, lowercase letters, numbers, and special characters. - Allowed special characters: `~!@#$%^&*()_-+=|{}[]:;'<>,.?/ - Cannot start with '/' or '$6$'. Note: Login credentials support three methods: 'password', 'key pair', and 'retain image settings'. When using the 'password' method to log in, it is recommended to increase password complexity for enhanced security.
- project
Name String - Project to which the resource belongs. Each resource can belong to only one project. - Can only contain letters, numbers, underscore '_', period '.', and hyphen '-'. - Maximum length is 64 characters.
- scheduled
Instance StringDescription - Description of the flexible reservation order. The default value is an empty string. - Must start with a letter or Chinese character. - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals sign '=', English comma ',', Chinese comma ',', and Chinese period '。' - Maximum length is 255 characters.
- security
Enhancement StringStrategy - Whether to enable security hardening. Values: - Active: Enable security hardening, applies only to public images. - InActive: Disable security hardening, applies to all image types.
- start
Delivery StringAt - Instance delivery start time. Must be on a 10-minute mark (e.g., 10:00, 10:10, 10:20, etc.). - When
ElasticScheduledInstanceTypeis set toEsi, delivery time is within 4–8 hours after reservation. - WhenElasticScheduledInstanceTypeis set toSegmented: - IfDeliveryTypeisReserve, delivery time is within 24 hours after reservation. - IfDeliveryTypeisImmediate, this parameter is not required. - suffix
Index Integer - Starting sequence number for ordered suffix. Value range: 1–999. Default is 1.
-
List<Scheduled
Instance Tag> - Flexible reservation order tag information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- unique
Suffix Boolean - Indicates whether to automatically add an ordered suffix to
HostNameandInstanceNamewhen creating multiple instances. Values: - true: Enable ordered suffix. - false (default): Disable ordered suffix. Note: - When ordered suffix is enabled andHostNameis empty, the system will automatically generate a host name without an ordered suffix. - When ordered suffix is enabled and the[begin_number,bits]naming format is specified forHostNameorInstanceName, see [Batch Set Ordered Instance Names or Host Names] for the final effect. - user
Data String - Instance custom data. Custom data must be Base64-encoded, and the size before encoding must not exceed 16KB. If not specified, defaults to empty.
- image
Id string - The image ID used to launch the instance. You can use [DescribeImages] to query available image resources.
- instance
Name string Instance name - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods "." - Length must be between 1 and 128 characters
Note: - If the instance has a
SuffixIndexsequential suffix, the instance name length includes the suffix - When creating instances in bulk, you can use thename_prefix[begin_number,bits]name_suffixformat to customize sequential instance names. For details, see [Batch Set Sequential Instance Names or Host Names]- instance
Type stringId - Instance type. - For supported instance types available for reservation, see [Elastic Scheduled Instance Overview]. - You can call [DescribeAvailableResource] to query inventory information for compute resources in the availability zone.
- network
Interfaces ScheduledInstance Network Interface[] - Network interface configuration information specified when creating the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- scheduled
Instance stringName - Name of the elastic reservation order. Values: - Cannot start with a number, hyphen, or underscore. - Can only contain Chinese characters, letters, numbers, underscores, and hyphens. - Length limit: 1–128 characters. - Special characters are not supported.
- volumes
Scheduled
Instance Volume[] - Cloud disk configuration information specified when creating an instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- zone
Id string - Availability zone ID where the instance is located. You can call [DescribeZones] to query the availability zones in a region.
- auto
Release stringAt - Instance automatic release time. Must be at a 10-minute mark. When
ElasticScheduledInstanceTypeis set to Segmented, this parameter is required. Value range: - WhenDeliveryTypeis Reserve, the earliest release time is one hour after the reserved delivery time slot. - WhenDeliveryTypeis Immediate, the earliest release time is the next 10-minute mark after the current time. For example, if the current time is 5:02, the earliest automatic release time is 5:20. - cpu
Max numberFrequency Specify the maximum CPU frequency in GHz. Value range: between the base frequency and turbo frequency of the CPU.
Note: - Currently, only g3al (4xlarge, 8xlarge, 16xlarge, 32xlarge), c3al (4xlarge, 8xlarge, 16xlarge, 32xlarge), r3al (4xlarge, 8xlarge, 16xlarge), g4i, c4i, r4i, g4ie, c4ie, r4ie instances support this parameter. For details on base/turbo frequency and more information, see [Instance Specifications]. - This feature is in invitation-only testing. To use it, contact your account manager.
- deletion
Protection boolean - Instance deletion protection attribute. Specifies whether the instance can be deleted via console or API. Values: - true: Enable instance deletion protection - false (default): Disable instance deletion protection
- delivery
Type string - Elastic Scheduled Instance - Segmented delivery type. Values: - Reserve (default): scheduled delivery - Immediate: immediate delivery
Note: - This parameter is required only when
ElasticScheduledInstanceTypeis set toSegmented. - Elastic Scheduled Instance - Segmented is currently in invitation testing. To apply for a trial, please contact your account manager. - description string
- Instance description. The default value is an empty string. - Must start with a letter or Chinese character. - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals sign '=', English comma ',', Chinese comma ',', and Chinese period '。' - Maximum length is 255 characters.
- eip
Address ScheduledInstance Eip Address - Public IP configuration specified when creating the instance.
- elastic
Scheduled stringInstance Type - Elastic scheduled instance type. Options: - Esi (default): Elastic scheduled instance. - Segmented: Elastic scheduled instance (time segment). Note: Elastic scheduled instance (time segment) is currently in invite-only beta. To try it, please contact your account manager.
- end
Delivery stringAt - Instance end delivery time. Must be on a 10-minute mark, and the interval with
StartDeliveryAtmust be 10 minutes - IfElasticScheduledInstanceTypeisEsi, the end delivery time must be within 4–8 hours after reservation - IfElasticScheduledInstanceTypeisSegmented: - IfDeliveryTypeisReserve, the end delivery time must be within 24 hours after reservation - IfDeliveryTypeisImmediate, this parameter is not required - host
Name string Instance hostname, which is the computer name inside the instance operating system. - Linux instances: - Letters, numbers, periods ("."), and hyphens ("-") are allowed. - Cannot start or end with a hyphen or period, and hyphens and periods cannot be used consecutively. - Length must be between 2 and 63 characters for Linux systems. - Windows instances: - Letters, numbers, and hyphens ("-") are allowed, but the name cannot consist of only numbers. - Cannot start or end with a hyphen, and hyphens cannot be used consecutively. - Length must be between 2 and 15 characters for Windows systems.
Note: - If left blank, the hostname is automatically generated according to the iv - + initial hostname rule, for example, iv-3tigy72q3u3vj0******. - Initial hostname generation logic: - Linux: Extract all characters after the instance ID i-. - Windows: Extract the last 12 characters after the instance ID i-. - When creating instances in batches, you can use the
name_prefix[begin_number,bits]name_suffixformat to customize sequential hostnames. For details, see [Batch Set Sequential Instance Names or Hostnames].- hpc
Cluster stringId - When creating a high-performance computing GPU instance, specify the high-performance computing cluster ID.
- http
Tokens string - Instance metadata access mode: whether to enforce enhanced mode. Values: - optional (default): Not enforced (compatible mode), meaning instance metadata can be accessed either directly or via token-based authentication. - required: Enforced (enhanced mode only), meaning instance metadata can only be accessed via token-based authentication. Note: - For details on how to view metadata and supported metadata items, see [View Instance Metadata]. - Enhanced mode is currently in invitation testing. To request access, contact your account manager.
- install
Run booleanCommand Agent Whether to install the Cloud Assistant Agent when creating the instance. Values: - true: Install during creation - false (default): Do not install during creation
Note: For more information about Cloud Assistant, see [Cloud Assistant Overview].
- instance
Count number Number of instances to create. Value range: - If
ElasticScheduledInstanceTypeis set toEsi, value range is 1–500. - IfElasticScheduledInstanceTypeis set toSegmented, then: - IfDeliveryTypeisReserve, value range is 1–500. - IfDeliveryTypeisImmediate, value range is 1–100.Note: If 0 is entered, the default is 1.
- keep
Image booleanCredential - Whether to retain image settings. Values: - true: Retain image settings. If retained, the instance will use the preset password or key pair from the image for login. - false (default): Do not retain image settings.
Note: - Only custom images and shared images support this feature. - When this parameter is set to
true, do not specifyPassWordorKeyPairName. - key
Pair stringName To log in to the instance using an SSH key, specify the name of an existing key pair. You can call [DescribeKeyPairs] to view existing key pairs; if none are available, call [CreateKeyPair] to create one
Note: - Windows instances do not support SSH key login. Even if this parameter is provided, only the password
Passwordis valid - Linux instances support login via password or key pair. If bothKeyPairNameandPasswordare set when calling this API, onlyKeyPairNametakes effect- min
Count number - Specify the minimum number of Elastic Scheduled Instances to create. Value range: - ESI-General, ESI-Segmented (Scheduled Delivery): 1–500 - ESI-Segmented (Immediate Delivery): 1–100
Note: - The minimum instance creation quantity
MinCount≤ creation quantityCount. - If inventory quantity > creation quantityCount, create according toCount. - If minimum creation quantityMinCount≤ inventory quantity ≤ creation quantityCount, create according to inventory quantity. - If inventory quantity < minimum creation quantityMinCount, creation fails due to insufficient inventory. - password string
- If you want to log in to the instance using the 'password' method, specify the initial login password for the administrator account through this parameter. The Linux administrator account is root, and the Windows administrator account is Administrator. Password complexity requirements: - Length must be between 8 and 30 characters. - Password must contain at least three of the following: uppercase letters, lowercase letters, numbers, and special characters. - Allowed special characters: `~!@#$%^&*()_-+=|{}[]:;'<>,.?/ - Cannot start with '/' or '$6$'. Note: Login credentials support three methods: 'password', 'key pair', and 'retain image settings'. When using the 'password' method to log in, it is recommended to increase password complexity for enhanced security.
- project
Name string - Project to which the resource belongs. Each resource can belong to only one project. - Can only contain letters, numbers, underscore '_', period '.', and hyphen '-'. - Maximum length is 64 characters.
- scheduled
Instance stringDescription - Description of the flexible reservation order. The default value is an empty string. - Must start with a letter or Chinese character. - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals sign '=', English comma ',', Chinese comma ',', and Chinese period '。' - Maximum length is 255 characters.
- security
Enhancement stringStrategy - Whether to enable security hardening. Values: - Active: Enable security hardening, applies only to public images. - InActive: Disable security hardening, applies to all image types.
- start
Delivery stringAt - Instance delivery start time. Must be on a 10-minute mark (e.g., 10:00, 10:10, 10:20, etc.). - When
ElasticScheduledInstanceTypeis set toEsi, delivery time is within 4–8 hours after reservation. - WhenElasticScheduledInstanceTypeis set toSegmented: - IfDeliveryTypeisReserve, delivery time is within 24 hours after reservation. - IfDeliveryTypeisImmediate, this parameter is not required. - suffix
Index number - Starting sequence number for ordered suffix. Value range: 1–999. Default is 1.
-
Scheduled
Instance Tag[] - Flexible reservation order tag information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- unique
Suffix boolean - Indicates whether to automatically add an ordered suffix to
HostNameandInstanceNamewhen creating multiple instances. Values: - true: Enable ordered suffix. - false (default): Disable ordered suffix. Note: - When ordered suffix is enabled andHostNameis empty, the system will automatically generate a host name without an ordered suffix. - When ordered suffix is enabled and the[begin_number,bits]naming format is specified forHostNameorInstanceName, see [Batch Set Ordered Instance Names or Host Names] for the final effect. - user
Data string - Instance custom data. Custom data must be Base64-encoded, and the size before encoding must not exceed 16KB. If not specified, defaults to empty.
- image_
id str - The image ID used to launch the instance. You can use [DescribeImages] to query available image resources.
- instance_
name str Instance name - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods "." - Length must be between 1 and 128 characters
Note: - If the instance has a
SuffixIndexsequential suffix, the instance name length includes the suffix - When creating instances in bulk, you can use thename_prefix[begin_number,bits]name_suffixformat to customize sequential instance names. For details, see [Batch Set Sequential Instance Names or Host Names]- instance_
type_ strid - Instance type. - For supported instance types available for reservation, see [Elastic Scheduled Instance Overview]. - You can call [DescribeAvailableResource] to query inventory information for compute resources in the availability zone.
- network_
interfaces Sequence[ScheduledInstance Network Interface Args] - Network interface configuration information specified when creating the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- scheduled_
instance_ strname - Name of the elastic reservation order. Values: - Cannot start with a number, hyphen, or underscore. - Can only contain Chinese characters, letters, numbers, underscores, and hyphens. - Length limit: 1–128 characters. - Special characters are not supported.
- volumes
Sequence[Scheduled
Instance Volume Args] - Cloud disk configuration information specified when creating an instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- zone_
id str - Availability zone ID where the instance is located. You can call [DescribeZones] to query the availability zones in a region.
- auto_
release_ strat - Instance automatic release time. Must be at a 10-minute mark. When
ElasticScheduledInstanceTypeis set to Segmented, this parameter is required. Value range: - WhenDeliveryTypeis Reserve, the earliest release time is one hour after the reserved delivery time slot. - WhenDeliveryTypeis Immediate, the earliest release time is the next 10-minute mark after the current time. For example, if the current time is 5:02, the earliest automatic release time is 5:20. - cpu_
max_ floatfrequency Specify the maximum CPU frequency in GHz. Value range: between the base frequency and turbo frequency of the CPU.
Note: - Currently, only g3al (4xlarge, 8xlarge, 16xlarge, 32xlarge), c3al (4xlarge, 8xlarge, 16xlarge, 32xlarge), r3al (4xlarge, 8xlarge, 16xlarge), g4i, c4i, r4i, g4ie, c4ie, r4ie instances support this parameter. For details on base/turbo frequency and more information, see [Instance Specifications]. - This feature is in invitation-only testing. To use it, contact your account manager.
- deletion_
protection bool - Instance deletion protection attribute. Specifies whether the instance can be deleted via console or API. Values: - true: Enable instance deletion protection - false (default): Disable instance deletion protection
- delivery_
type str - Elastic Scheduled Instance - Segmented delivery type. Values: - Reserve (default): scheduled delivery - Immediate: immediate delivery
Note: - This parameter is required only when
ElasticScheduledInstanceTypeis set toSegmented. - Elastic Scheduled Instance - Segmented is currently in invitation testing. To apply for a trial, please contact your account manager. - description str
- Instance description. The default value is an empty string. - Must start with a letter or Chinese character. - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals sign '=', English comma ',', Chinese comma ',', and Chinese period '。' - Maximum length is 255 characters.
- eip_
address ScheduledInstance Eip Address Args - Public IP configuration specified when creating the instance.
- elastic_
scheduled_ strinstance_ type - Elastic scheduled instance type. Options: - Esi (default): Elastic scheduled instance. - Segmented: Elastic scheduled instance (time segment). Note: Elastic scheduled instance (time segment) is currently in invite-only beta. To try it, please contact your account manager.
- end_
delivery_ strat - Instance end delivery time. Must be on a 10-minute mark, and the interval with
StartDeliveryAtmust be 10 minutes - IfElasticScheduledInstanceTypeisEsi, the end delivery time must be within 4–8 hours after reservation - IfElasticScheduledInstanceTypeisSegmented: - IfDeliveryTypeisReserve, the end delivery time must be within 24 hours after reservation - IfDeliveryTypeisImmediate, this parameter is not required - host_
name str Instance hostname, which is the computer name inside the instance operating system. - Linux instances: - Letters, numbers, periods ("."), and hyphens ("-") are allowed. - Cannot start or end with a hyphen or period, and hyphens and periods cannot be used consecutively. - Length must be between 2 and 63 characters for Linux systems. - Windows instances: - Letters, numbers, and hyphens ("-") are allowed, but the name cannot consist of only numbers. - Cannot start or end with a hyphen, and hyphens cannot be used consecutively. - Length must be between 2 and 15 characters for Windows systems.
Note: - If left blank, the hostname is automatically generated according to the iv - + initial hostname rule, for example, iv-3tigy72q3u3vj0******. - Initial hostname generation logic: - Linux: Extract all characters after the instance ID i-. - Windows: Extract the last 12 characters after the instance ID i-. - When creating instances in batches, you can use the
name_prefix[begin_number,bits]name_suffixformat to customize sequential hostnames. For details, see [Batch Set Sequential Instance Names or Hostnames].- hpc_
cluster_ strid - When creating a high-performance computing GPU instance, specify the high-performance computing cluster ID.
- http_
tokens str - Instance metadata access mode: whether to enforce enhanced mode. Values: - optional (default): Not enforced (compatible mode), meaning instance metadata can be accessed either directly or via token-based authentication. - required: Enforced (enhanced mode only), meaning instance metadata can only be accessed via token-based authentication. Note: - For details on how to view metadata and supported metadata items, see [View Instance Metadata]. - Enhanced mode is currently in invitation testing. To request access, contact your account manager.
- install_
run_ boolcommand_ agent Whether to install the Cloud Assistant Agent when creating the instance. Values: - true: Install during creation - false (default): Do not install during creation
Note: For more information about Cloud Assistant, see [Cloud Assistant Overview].
- instance_
count int Number of instances to create. Value range: - If
ElasticScheduledInstanceTypeis set toEsi, value range is 1–500. - IfElasticScheduledInstanceTypeis set toSegmented, then: - IfDeliveryTypeisReserve, value range is 1–500. - IfDeliveryTypeisImmediate, value range is 1–100.Note: If 0 is entered, the default is 1.
- keep_
image_ boolcredential - Whether to retain image settings. Values: - true: Retain image settings. If retained, the instance will use the preset password or key pair from the image for login. - false (default): Do not retain image settings.
Note: - Only custom images and shared images support this feature. - When this parameter is set to
true, do not specifyPassWordorKeyPairName. - key_
pair_ strname To log in to the instance using an SSH key, specify the name of an existing key pair. You can call [DescribeKeyPairs] to view existing key pairs; if none are available, call [CreateKeyPair] to create one
Note: - Windows instances do not support SSH key login. Even if this parameter is provided, only the password
Passwordis valid - Linux instances support login via password or key pair. If bothKeyPairNameandPasswordare set when calling this API, onlyKeyPairNametakes effect- min_
count int - Specify the minimum number of Elastic Scheduled Instances to create. Value range: - ESI-General, ESI-Segmented (Scheduled Delivery): 1–500 - ESI-Segmented (Immediate Delivery): 1–100
Note: - The minimum instance creation quantity
MinCount≤ creation quantityCount. - If inventory quantity > creation quantityCount, create according toCount. - If minimum creation quantityMinCount≤ inventory quantity ≤ creation quantityCount, create according to inventory quantity. - If inventory quantity < minimum creation quantityMinCount, creation fails due to insufficient inventory. - password str
- If you want to log in to the instance using the 'password' method, specify the initial login password for the administrator account through this parameter. The Linux administrator account is root, and the Windows administrator account is Administrator. Password complexity requirements: - Length must be between 8 and 30 characters. - Password must contain at least three of the following: uppercase letters, lowercase letters, numbers, and special characters. - Allowed special characters: `~!@#$%^&*()_-+=|{}[]:;'<>,.?/ - Cannot start with '/' or '$6$'. Note: Login credentials support three methods: 'password', 'key pair', and 'retain image settings'. When using the 'password' method to log in, it is recommended to increase password complexity for enhanced security.
- project_
name str - Project to which the resource belongs. Each resource can belong to only one project. - Can only contain letters, numbers, underscore '_', period '.', and hyphen '-'. - Maximum length is 64 characters.
- scheduled_
instance_ strdescription - Description of the flexible reservation order. The default value is an empty string. - Must start with a letter or Chinese character. - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals sign '=', English comma ',', Chinese comma ',', and Chinese period '。' - Maximum length is 255 characters.
- security_
enhancement_ strstrategy - Whether to enable security hardening. Values: - Active: Enable security hardening, applies only to public images. - InActive: Disable security hardening, applies to all image types.
- start_
delivery_ strat - Instance delivery start time. Must be on a 10-minute mark (e.g., 10:00, 10:10, 10:20, etc.). - When
ElasticScheduledInstanceTypeis set toEsi, delivery time is within 4–8 hours after reservation. - WhenElasticScheduledInstanceTypeis set toSegmented: - IfDeliveryTypeisReserve, delivery time is within 24 hours after reservation. - IfDeliveryTypeisImmediate, this parameter is not required. - suffix_
index int - Starting sequence number for ordered suffix. Value range: 1–999. Default is 1.
-
Sequence[Scheduled
Instance Tag Args] - Flexible reservation order tag information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- unique_
suffix bool - Indicates whether to automatically add an ordered suffix to
HostNameandInstanceNamewhen creating multiple instances. Values: - true: Enable ordered suffix. - false (default): Disable ordered suffix. Note: - When ordered suffix is enabled andHostNameis empty, the system will automatically generate a host name without an ordered suffix. - When ordered suffix is enabled and the[begin_number,bits]naming format is specified forHostNameorInstanceName, see [Batch Set Ordered Instance Names or Host Names] for the final effect. - user_
data str - Instance custom data. Custom data must be Base64-encoded, and the size before encoding must not exceed 16KB. If not specified, defaults to empty.
- image
Id String - The image ID used to launch the instance. You can use [DescribeImages] to query available image resources.
- instance
Name String Instance name - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods "." - Length must be between 1 and 128 characters
Note: - If the instance has a
SuffixIndexsequential suffix, the instance name length includes the suffix - When creating instances in bulk, you can use thename_prefix[begin_number,bits]name_suffixformat to customize sequential instance names. For details, see [Batch Set Sequential Instance Names or Host Names]- instance
Type StringId - Instance type. - For supported instance types available for reservation, see [Elastic Scheduled Instance Overview]. - You can call [DescribeAvailableResource] to query inventory information for compute resources in the availability zone.
- network
Interfaces List<Property Map> - Network interface configuration information specified when creating the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- scheduled
Instance StringName - Name of the elastic reservation order. Values: - Cannot start with a number, hyphen, or underscore. - Can only contain Chinese characters, letters, numbers, underscores, and hyphens. - Length limit: 1–128 characters. - Special characters are not supported.
- volumes List<Property Map>
- Cloud disk configuration information specified when creating an instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- zone
Id String - Availability zone ID where the instance is located. You can call [DescribeZones] to query the availability zones in a region.
- auto
Release StringAt - Instance automatic release time. Must be at a 10-minute mark. When
ElasticScheduledInstanceTypeis set to Segmented, this parameter is required. Value range: - WhenDeliveryTypeis Reserve, the earliest release time is one hour after the reserved delivery time slot. - WhenDeliveryTypeis Immediate, the earliest release time is the next 10-minute mark after the current time. For example, if the current time is 5:02, the earliest automatic release time is 5:20. - cpu
Max NumberFrequency Specify the maximum CPU frequency in GHz. Value range: between the base frequency and turbo frequency of the CPU.
Note: - Currently, only g3al (4xlarge, 8xlarge, 16xlarge, 32xlarge), c3al (4xlarge, 8xlarge, 16xlarge, 32xlarge), r3al (4xlarge, 8xlarge, 16xlarge), g4i, c4i, r4i, g4ie, c4ie, r4ie instances support this parameter. For details on base/turbo frequency and more information, see [Instance Specifications]. - This feature is in invitation-only testing. To use it, contact your account manager.
- deletion
Protection Boolean - Instance deletion protection attribute. Specifies whether the instance can be deleted via console or API. Values: - true: Enable instance deletion protection - false (default): Disable instance deletion protection
- delivery
Type String - Elastic Scheduled Instance - Segmented delivery type. Values: - Reserve (default): scheduled delivery - Immediate: immediate delivery
Note: - This parameter is required only when
ElasticScheduledInstanceTypeis set toSegmented. - Elastic Scheduled Instance - Segmented is currently in invitation testing. To apply for a trial, please contact your account manager. - description String
- Instance description. The default value is an empty string. - Must start with a letter or Chinese character. - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals sign '=', English comma ',', Chinese comma ',', and Chinese period '。' - Maximum length is 255 characters.
- eip
Address Property Map - Public IP configuration specified when creating the instance.
- elastic
Scheduled StringInstance Type - Elastic scheduled instance type. Options: - Esi (default): Elastic scheduled instance. - Segmented: Elastic scheduled instance (time segment). Note: Elastic scheduled instance (time segment) is currently in invite-only beta. To try it, please contact your account manager.
- end
Delivery StringAt - Instance end delivery time. Must be on a 10-minute mark, and the interval with
StartDeliveryAtmust be 10 minutes - IfElasticScheduledInstanceTypeisEsi, the end delivery time must be within 4–8 hours after reservation - IfElasticScheduledInstanceTypeisSegmented: - IfDeliveryTypeisReserve, the end delivery time must be within 24 hours after reservation - IfDeliveryTypeisImmediate, this parameter is not required - host
Name String Instance hostname, which is the computer name inside the instance operating system. - Linux instances: - Letters, numbers, periods ("."), and hyphens ("-") are allowed. - Cannot start or end with a hyphen or period, and hyphens and periods cannot be used consecutively. - Length must be between 2 and 63 characters for Linux systems. - Windows instances: - Letters, numbers, and hyphens ("-") are allowed, but the name cannot consist of only numbers. - Cannot start or end with a hyphen, and hyphens cannot be used consecutively. - Length must be between 2 and 15 characters for Windows systems.
Note: - If left blank, the hostname is automatically generated according to the iv - + initial hostname rule, for example, iv-3tigy72q3u3vj0******. - Initial hostname generation logic: - Linux: Extract all characters after the instance ID i-. - Windows: Extract the last 12 characters after the instance ID i-. - When creating instances in batches, you can use the
name_prefix[begin_number,bits]name_suffixformat to customize sequential hostnames. For details, see [Batch Set Sequential Instance Names or Hostnames].- hpc
Cluster StringId - When creating a high-performance computing GPU instance, specify the high-performance computing cluster ID.
- http
Tokens String - Instance metadata access mode: whether to enforce enhanced mode. Values: - optional (default): Not enforced (compatible mode), meaning instance metadata can be accessed either directly or via token-based authentication. - required: Enforced (enhanced mode only), meaning instance metadata can only be accessed via token-based authentication. Note: - For details on how to view metadata and supported metadata items, see [View Instance Metadata]. - Enhanced mode is currently in invitation testing. To request access, contact your account manager.
- install
Run BooleanCommand Agent Whether to install the Cloud Assistant Agent when creating the instance. Values: - true: Install during creation - false (default): Do not install during creation
Note: For more information about Cloud Assistant, see [Cloud Assistant Overview].
- instance
Count Number Number of instances to create. Value range: - If
ElasticScheduledInstanceTypeis set toEsi, value range is 1–500. - IfElasticScheduledInstanceTypeis set toSegmented, then: - IfDeliveryTypeisReserve, value range is 1–500. - IfDeliveryTypeisImmediate, value range is 1–100.Note: If 0 is entered, the default is 1.
- keep
Image BooleanCredential - Whether to retain image settings. Values: - true: Retain image settings. If retained, the instance will use the preset password or key pair from the image for login. - false (default): Do not retain image settings.
Note: - Only custom images and shared images support this feature. - When this parameter is set to
true, do not specifyPassWordorKeyPairName. - key
Pair StringName To log in to the instance using an SSH key, specify the name of an existing key pair. You can call [DescribeKeyPairs] to view existing key pairs; if none are available, call [CreateKeyPair] to create one
Note: - Windows instances do not support SSH key login. Even if this parameter is provided, only the password
Passwordis valid - Linux instances support login via password or key pair. If bothKeyPairNameandPasswordare set when calling this API, onlyKeyPairNametakes effect- min
Count Number - Specify the minimum number of Elastic Scheduled Instances to create. Value range: - ESI-General, ESI-Segmented (Scheduled Delivery): 1–500 - ESI-Segmented (Immediate Delivery): 1–100
Note: - The minimum instance creation quantity
MinCount≤ creation quantityCount. - If inventory quantity > creation quantityCount, create according toCount. - If minimum creation quantityMinCount≤ inventory quantity ≤ creation quantityCount, create according to inventory quantity. - If inventory quantity < minimum creation quantityMinCount, creation fails due to insufficient inventory. - password String
- If you want to log in to the instance using the 'password' method, specify the initial login password for the administrator account through this parameter. The Linux administrator account is root, and the Windows administrator account is Administrator. Password complexity requirements: - Length must be between 8 and 30 characters. - Password must contain at least three of the following: uppercase letters, lowercase letters, numbers, and special characters. - Allowed special characters: `~!@#$%^&*()_-+=|{}[]:;'<>,.?/ - Cannot start with '/' or '$6$'. Note: Login credentials support three methods: 'password', 'key pair', and 'retain image settings'. When using the 'password' method to log in, it is recommended to increase password complexity for enhanced security.
- project
Name String - Project to which the resource belongs. Each resource can belong to only one project. - Can only contain letters, numbers, underscore '_', period '.', and hyphen '-'. - Maximum length is 64 characters.
- scheduled
Instance StringDescription - Description of the flexible reservation order. The default value is an empty string. - Must start with a letter or Chinese character. - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals sign '=', English comma ',', Chinese comma ',', and Chinese period '。' - Maximum length is 255 characters.
- security
Enhancement StringStrategy - Whether to enable security hardening. Values: - Active: Enable security hardening, applies only to public images. - InActive: Disable security hardening, applies to all image types.
- start
Delivery StringAt - Instance delivery start time. Must be on a 10-minute mark (e.g., 10:00, 10:10, 10:20, etc.). - When
ElasticScheduledInstanceTypeis set toEsi, delivery time is within 4–8 hours after reservation. - WhenElasticScheduledInstanceTypeis set toSegmented: - IfDeliveryTypeisReserve, delivery time is within 24 hours after reservation. - IfDeliveryTypeisImmediate, this parameter is not required. - suffix
Index Number - Starting sequence number for ordered suffix. Value range: 1–999. Default is 1.
- List<Property Map>
- Flexible reservation order tag information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- unique
Suffix Boolean - Indicates whether to automatically add an ordered suffix to
HostNameandInstanceNamewhen creating multiple instances. Values: - true: Enable ordered suffix. - false (default): Disable ordered suffix. Note: - When ordered suffix is enabled andHostNameis empty, the system will automatically generate a host name without an ordered suffix. - When ordered suffix is enabled and the[begin_number,bits]naming format is specified forHostNameorInstanceName, see [Batch Set Ordered Instance Names or Host Names] for the final effect. - user
Data String - Instance custom data. Custom data must be Base64-encoded, and the size before encoding must not exceed 16KB. If not specified, defaults to empty.
Outputs
All input properties are implicitly available as output properties. Additionally, the ScheduledInstance resource produces the following output properties:
- Created
At string - ScheduledInstance creation time.
- Delivery
Count int - Number of delivered instances
- Id string
- The provider-assigned unique ID for this managed resource.
- Instance
Config Volcengine.Scheduled Instance Instance Config - Instance configuration information for the elastic reservation order.
- Invalid
At string - Elastic reservation order expiration time.
- Release
Count int - Number of released instances.
- Scheduled
Instance stringId - Elastic reservation order ID.
- Status string
- ScheduledInstance status.
- Updated
At string - Elastic reservation order update time.
- Created
At string - ScheduledInstance creation time.
- Delivery
Count int - Number of delivered instances
- Id string
- The provider-assigned unique ID for this managed resource.
- Instance
Config ScheduledInstance Instance Config - Instance configuration information for the elastic reservation order.
- Invalid
At string - Elastic reservation order expiration time.
- Release
Count int - Number of released instances.
- Scheduled
Instance stringId - Elastic reservation order ID.
- Status string
- ScheduledInstance status.
- Updated
At string - Elastic reservation order update time.
- created_
at string - ScheduledInstance creation time.
- delivery_
count number - Number of delivered instances
- id string
- The provider-assigned unique ID for this managed resource.
- instance_
config object - Instance configuration information for the elastic reservation order.
- invalid_
at string - Elastic reservation order expiration time.
- release_
count number - Number of released instances.
- scheduled_
instance_ stringid - Elastic reservation order ID.
- status string
- ScheduledInstance status.
- updated_
at string - Elastic reservation order update time.
- created
At String - ScheduledInstance creation time.
- delivery
Count Integer - Number of delivered instances
- id String
- The provider-assigned unique ID for this managed resource.
- instance
Config ScheduledInstance Instance Config - Instance configuration information for the elastic reservation order.
- invalid
At String - Elastic reservation order expiration time.
- release
Count Integer - Number of released instances.
- scheduled
Instance StringId - Elastic reservation order ID.
- status String
- ScheduledInstance status.
- updated
At String - Elastic reservation order update time.
- created
At string - ScheduledInstance creation time.
- delivery
Count number - Number of delivered instances
- id string
- The provider-assigned unique ID for this managed resource.
- instance
Config ScheduledInstance Instance Config - Instance configuration information for the elastic reservation order.
- invalid
At string - Elastic reservation order expiration time.
- release
Count number - Number of released instances.
- scheduled
Instance stringId - Elastic reservation order ID.
- status string
- ScheduledInstance status.
- updated
At string - Elastic reservation order update time.
- created_
at str - ScheduledInstance creation time.
- delivery_
count int - Number of delivered instances
- id str
- The provider-assigned unique ID for this managed resource.
- instance_
config ScheduledInstance Instance Config - Instance configuration information for the elastic reservation order.
- invalid_
at str - Elastic reservation order expiration time.
- release_
count int - Number of released instances.
- scheduled_
instance_ strid - Elastic reservation order ID.
- status str
- ScheduledInstance status.
- updated_
at str - Elastic reservation order update time.
- created
At String - ScheduledInstance creation time.
- delivery
Count Number - Number of delivered instances
- id String
- The provider-assigned unique ID for this managed resource.
- instance
Config Property Map - Instance configuration information for the elastic reservation order.
- invalid
At String - Elastic reservation order expiration time.
- release
Count Number - Number of released instances.
- scheduled
Instance StringId - Elastic reservation order ID.
- status String
- ScheduledInstance status.
- updated
At String - Elastic reservation order update time.
Look up Existing ScheduledInstance Resource
Get an existing ScheduledInstance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ScheduledInstanceState, opts?: CustomResourceOptions): ScheduledInstance@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
auto_release_at: Optional[str] = None,
cpu_max_frequency: Optional[float] = None,
created_at: Optional[str] = None,
deletion_protection: Optional[bool] = None,
delivery_count: Optional[int] = None,
delivery_type: Optional[str] = None,
description: Optional[str] = None,
eip_address: Optional[ScheduledInstanceEipAddressArgs] = None,
elastic_scheduled_instance_type: Optional[str] = None,
end_delivery_at: Optional[str] = None,
host_name: Optional[str] = None,
hpc_cluster_id: Optional[str] = None,
http_tokens: Optional[str] = None,
image_id: Optional[str] = None,
install_run_command_agent: Optional[bool] = None,
instance_config: Optional[ScheduledInstanceInstanceConfigArgs] = None,
instance_count: Optional[int] = None,
instance_name: Optional[str] = None,
instance_type_id: Optional[str] = None,
invalid_at: Optional[str] = None,
keep_image_credential: Optional[bool] = None,
key_pair_name: Optional[str] = None,
min_count: Optional[int] = None,
network_interfaces: Optional[Sequence[ScheduledInstanceNetworkInterfaceArgs]] = None,
password: Optional[str] = None,
project_name: Optional[str] = None,
release_count: Optional[int] = None,
scheduled_instance_description: Optional[str] = None,
scheduled_instance_id: Optional[str] = None,
scheduled_instance_name: Optional[str] = None,
security_enhancement_strategy: Optional[str] = None,
start_delivery_at: Optional[str] = None,
status: Optional[str] = None,
suffix_index: Optional[int] = None,
tags: Optional[Sequence[ScheduledInstanceTagArgs]] = None,
unique_suffix: Optional[bool] = None,
updated_at: Optional[str] = None,
user_data: Optional[str] = None,
volumes: Optional[Sequence[ScheduledInstanceVolumeArgs]] = None,
zone_id: Optional[str] = None) -> ScheduledInstancefunc GetScheduledInstance(ctx *Context, name string, id IDInput, state *ScheduledInstanceState, opts ...ResourceOption) (*ScheduledInstance, error)public static ScheduledInstance Get(string name, Input<string> id, ScheduledInstanceState? state, CustomResourceOptions? opts = null)public static ScheduledInstance get(String name, Output<String> id, ScheduledInstanceState state, CustomResourceOptions options)resources: _: type: volcenginecc:ecs:ScheduledInstance get: id: ${id}import {
to = volcenginecc_ecs_scheduled_instance.example
id = "${id}"
}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Auto
Release stringAt - Instance automatic release time. Must be at a 10-minute mark. When
ElasticScheduledInstanceTypeis set to Segmented, this parameter is required. Value range: - WhenDeliveryTypeis Reserve, the earliest release time is one hour after the reserved delivery time slot. - WhenDeliveryTypeis Immediate, the earliest release time is the next 10-minute mark after the current time. For example, if the current time is 5:02, the earliest automatic release time is 5:20. - Cpu
Max doubleFrequency Specify the maximum CPU frequency in GHz. Value range: between the base frequency and turbo frequency of the CPU.
Note: - Currently, only g3al (4xlarge, 8xlarge, 16xlarge, 32xlarge), c3al (4xlarge, 8xlarge, 16xlarge, 32xlarge), r3al (4xlarge, 8xlarge, 16xlarge), g4i, c4i, r4i, g4ie, c4ie, r4ie instances support this parameter. For details on base/turbo frequency and more information, see [Instance Specifications]. - This feature is in invitation-only testing. To use it, contact your account manager.
- Created
At string - ScheduledInstance creation time.
- Deletion
Protection bool - Instance deletion protection attribute. Specifies whether the instance can be deleted via console or API. Values: - true: Enable instance deletion protection - false (default): Disable instance deletion protection
- Delivery
Count int - Number of delivered instances
- Delivery
Type string - Elastic Scheduled Instance - Segmented delivery type. Values: - Reserve (default): scheduled delivery - Immediate: immediate delivery
Note: - This parameter is required only when
ElasticScheduledInstanceTypeis set toSegmented. - Elastic Scheduled Instance - Segmented is currently in invitation testing. To apply for a trial, please contact your account manager. - Description string
- Instance description. The default value is an empty string. - Must start with a letter or Chinese character. - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals sign '=', English comma ',', Chinese comma ',', and Chinese period '。' - Maximum length is 255 characters.
- Eip
Address Volcengine.Scheduled Instance Eip Address - Public IP configuration specified when creating the instance.
- Elastic
Scheduled stringInstance Type - Elastic scheduled instance type. Options: - Esi (default): Elastic scheduled instance. - Segmented: Elastic scheduled instance (time segment). Note: Elastic scheduled instance (time segment) is currently in invite-only beta. To try it, please contact your account manager.
- End
Delivery stringAt - Instance end delivery time. Must be on a 10-minute mark, and the interval with
StartDeliveryAtmust be 10 minutes - IfElasticScheduledInstanceTypeisEsi, the end delivery time must be within 4–8 hours after reservation - IfElasticScheduledInstanceTypeisSegmented: - IfDeliveryTypeisReserve, the end delivery time must be within 24 hours after reservation - IfDeliveryTypeisImmediate, this parameter is not required - Host
Name string Instance hostname, which is the computer name inside the instance operating system. - Linux instances: - Letters, numbers, periods ("."), and hyphens ("-") are allowed. - Cannot start or end with a hyphen or period, and hyphens and periods cannot be used consecutively. - Length must be between 2 and 63 characters for Linux systems. - Windows instances: - Letters, numbers, and hyphens ("-") are allowed, but the name cannot consist of only numbers. - Cannot start or end with a hyphen, and hyphens cannot be used consecutively. - Length must be between 2 and 15 characters for Windows systems.
Note: - If left blank, the hostname is automatically generated according to the iv - + initial hostname rule, for example, iv-3tigy72q3u3vj0******. - Initial hostname generation logic: - Linux: Extract all characters after the instance ID i-. - Windows: Extract the last 12 characters after the instance ID i-. - When creating instances in batches, you can use the
name_prefix[begin_number,bits]name_suffixformat to customize sequential hostnames. For details, see [Batch Set Sequential Instance Names or Hostnames].- Hpc
Cluster stringId - When creating a high-performance computing GPU instance, specify the high-performance computing cluster ID.
- Http
Tokens string - Instance metadata access mode: whether to enforce enhanced mode. Values: - optional (default): Not enforced (compatible mode), meaning instance metadata can be accessed either directly or via token-based authentication. - required: Enforced (enhanced mode only), meaning instance metadata can only be accessed via token-based authentication. Note: - For details on how to view metadata and supported metadata items, see [View Instance Metadata]. - Enhanced mode is currently in invitation testing. To request access, contact your account manager.
- Image
Id string - The image ID used to launch the instance. You can use [DescribeImages] to query available image resources.
- Install
Run boolCommand Agent Whether to install the Cloud Assistant Agent when creating the instance. Values: - true: Install during creation - false (default): Do not install during creation
Note: For more information about Cloud Assistant, see [Cloud Assistant Overview].
- Instance
Config Volcengine.Scheduled Instance Instance Config - Instance configuration information for the elastic reservation order.
- Instance
Count int Number of instances to create. Value range: - If
ElasticScheduledInstanceTypeis set toEsi, value range is 1–500. - IfElasticScheduledInstanceTypeis set toSegmented, then: - IfDeliveryTypeisReserve, value range is 1–500. - IfDeliveryTypeisImmediate, value range is 1–100.Note: If 0 is entered, the default is 1.
- Instance
Name string Instance name - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods "." - Length must be between 1 and 128 characters
Note: - If the instance has a
SuffixIndexsequential suffix, the instance name length includes the suffix - When creating instances in bulk, you can use thename_prefix[begin_number,bits]name_suffixformat to customize sequential instance names. For details, see [Batch Set Sequential Instance Names or Host Names]- Instance
Type stringId - Instance type. - For supported instance types available for reservation, see [Elastic Scheduled Instance Overview]. - You can call [DescribeAvailableResource] to query inventory information for compute resources in the availability zone.
- Invalid
At string - Elastic reservation order expiration time.
- Keep
Image boolCredential - Whether to retain image settings. Values: - true: Retain image settings. If retained, the instance will use the preset password or key pair from the image for login. - false (default): Do not retain image settings.
Note: - Only custom images and shared images support this feature. - When this parameter is set to
true, do not specifyPassWordorKeyPairName. - Key
Pair stringName To log in to the instance using an SSH key, specify the name of an existing key pair. You can call [DescribeKeyPairs] to view existing key pairs; if none are available, call [CreateKeyPair] to create one
Note: - Windows instances do not support SSH key login. Even if this parameter is provided, only the password
Passwordis valid - Linux instances support login via password or key pair. If bothKeyPairNameandPasswordare set when calling this API, onlyKeyPairNametakes effect- Min
Count int - Specify the minimum number of Elastic Scheduled Instances to create. Value range: - ESI-General, ESI-Segmented (Scheduled Delivery): 1–500 - ESI-Segmented (Immediate Delivery): 1–100
Note: - The minimum instance creation quantity
MinCount≤ creation quantityCount. - If inventory quantity > creation quantityCount, create according toCount. - If minimum creation quantityMinCount≤ inventory quantity ≤ creation quantityCount, create according to inventory quantity. - If inventory quantity < minimum creation quantityMinCount, creation fails due to insufficient inventory. - Network
Interfaces List<Volcengine.Scheduled Instance Network Interface> - Network interface configuration information specified when creating the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Password string
- If you want to log in to the instance using the 'password' method, specify the initial login password for the administrator account through this parameter. The Linux administrator account is root, and the Windows administrator account is Administrator. Password complexity requirements: - Length must be between 8 and 30 characters. - Password must contain at least three of the following: uppercase letters, lowercase letters, numbers, and special characters. - Allowed special characters: `~!@#$%^&*()_-+=|{}[]:;'<>,.?/ - Cannot start with '/' or '$6$'. Note: Login credentials support three methods: 'password', 'key pair', and 'retain image settings'. When using the 'password' method to log in, it is recommended to increase password complexity for enhanced security.
- Project
Name string - Project to which the resource belongs. Each resource can belong to only one project. - Can only contain letters, numbers, underscore '_', period '.', and hyphen '-'. - Maximum length is 64 characters.
- Release
Count int - Number of released instances.
- Scheduled
Instance stringDescription - Description of the flexible reservation order. The default value is an empty string. - Must start with a letter or Chinese character. - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals sign '=', English comma ',', Chinese comma ',', and Chinese period '。' - Maximum length is 255 characters.
- Scheduled
Instance stringId - Elastic reservation order ID.
- Scheduled
Instance stringName - Name of the elastic reservation order. Values: - Cannot start with a number, hyphen, or underscore. - Can only contain Chinese characters, letters, numbers, underscores, and hyphens. - Length limit: 1–128 characters. - Special characters are not supported.
- Security
Enhancement stringStrategy - Whether to enable security hardening. Values: - Active: Enable security hardening, applies only to public images. - InActive: Disable security hardening, applies to all image types.
- Start
Delivery stringAt - Instance delivery start time. Must be on a 10-minute mark (e.g., 10:00, 10:10, 10:20, etc.). - When
ElasticScheduledInstanceTypeis set toEsi, delivery time is within 4–8 hours after reservation. - WhenElasticScheduledInstanceTypeis set toSegmented: - IfDeliveryTypeisReserve, delivery time is within 24 hours after reservation. - IfDeliveryTypeisImmediate, this parameter is not required. - Status string
- ScheduledInstance status.
- Suffix
Index int - Starting sequence number for ordered suffix. Value range: 1–999. Default is 1.
-
List<Volcengine.
Scheduled Instance Tag> - Flexible reservation order tag information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Unique
Suffix bool - Indicates whether to automatically add an ordered suffix to
HostNameandInstanceNamewhen creating multiple instances. Values: - true: Enable ordered suffix. - false (default): Disable ordered suffix. Note: - When ordered suffix is enabled andHostNameis empty, the system will automatically generate a host name without an ordered suffix. - When ordered suffix is enabled and the[begin_number,bits]naming format is specified forHostNameorInstanceName, see [Batch Set Ordered Instance Names or Host Names] for the final effect. - Updated
At string - Elastic reservation order update time.
- User
Data string - Instance custom data. Custom data must be Base64-encoded, and the size before encoding must not exceed 16KB. If not specified, defaults to empty.
- Volumes
List<Volcengine.
Scheduled Instance Volume> - Cloud disk configuration information specified when creating an instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Zone
Id string - Availability zone ID where the instance is located. You can call [DescribeZones] to query the availability zones in a region.
- Auto
Release stringAt - Instance automatic release time. Must be at a 10-minute mark. When
ElasticScheduledInstanceTypeis set to Segmented, this parameter is required. Value range: - WhenDeliveryTypeis Reserve, the earliest release time is one hour after the reserved delivery time slot. - WhenDeliveryTypeis Immediate, the earliest release time is the next 10-minute mark after the current time. For example, if the current time is 5:02, the earliest automatic release time is 5:20. - Cpu
Max float64Frequency Specify the maximum CPU frequency in GHz. Value range: between the base frequency and turbo frequency of the CPU.
Note: - Currently, only g3al (4xlarge, 8xlarge, 16xlarge, 32xlarge), c3al (4xlarge, 8xlarge, 16xlarge, 32xlarge), r3al (4xlarge, 8xlarge, 16xlarge), g4i, c4i, r4i, g4ie, c4ie, r4ie instances support this parameter. For details on base/turbo frequency and more information, see [Instance Specifications]. - This feature is in invitation-only testing. To use it, contact your account manager.
- Created
At string - ScheduledInstance creation time.
- Deletion
Protection bool - Instance deletion protection attribute. Specifies whether the instance can be deleted via console or API. Values: - true: Enable instance deletion protection - false (default): Disable instance deletion protection
- Delivery
Count int - Number of delivered instances
- Delivery
Type string - Elastic Scheduled Instance - Segmented delivery type. Values: - Reserve (default): scheduled delivery - Immediate: immediate delivery
Note: - This parameter is required only when
ElasticScheduledInstanceTypeis set toSegmented. - Elastic Scheduled Instance - Segmented is currently in invitation testing. To apply for a trial, please contact your account manager. - Description string
- Instance description. The default value is an empty string. - Must start with a letter or Chinese character. - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals sign '=', English comma ',', Chinese comma ',', and Chinese period '。' - Maximum length is 255 characters.
- Eip
Address ScheduledInstance Eip Address Args - Public IP configuration specified when creating the instance.
- Elastic
Scheduled stringInstance Type - Elastic scheduled instance type. Options: - Esi (default): Elastic scheduled instance. - Segmented: Elastic scheduled instance (time segment). Note: Elastic scheduled instance (time segment) is currently in invite-only beta. To try it, please contact your account manager.
- End
Delivery stringAt - Instance end delivery time. Must be on a 10-minute mark, and the interval with
StartDeliveryAtmust be 10 minutes - IfElasticScheduledInstanceTypeisEsi, the end delivery time must be within 4–8 hours after reservation - IfElasticScheduledInstanceTypeisSegmented: - IfDeliveryTypeisReserve, the end delivery time must be within 24 hours after reservation - IfDeliveryTypeisImmediate, this parameter is not required - Host
Name string Instance hostname, which is the computer name inside the instance operating system. - Linux instances: - Letters, numbers, periods ("."), and hyphens ("-") are allowed. - Cannot start or end with a hyphen or period, and hyphens and periods cannot be used consecutively. - Length must be between 2 and 63 characters for Linux systems. - Windows instances: - Letters, numbers, and hyphens ("-") are allowed, but the name cannot consist of only numbers. - Cannot start or end with a hyphen, and hyphens cannot be used consecutively. - Length must be between 2 and 15 characters for Windows systems.
Note: - If left blank, the hostname is automatically generated according to the iv - + initial hostname rule, for example, iv-3tigy72q3u3vj0******. - Initial hostname generation logic: - Linux: Extract all characters after the instance ID i-. - Windows: Extract the last 12 characters after the instance ID i-. - When creating instances in batches, you can use the
name_prefix[begin_number,bits]name_suffixformat to customize sequential hostnames. For details, see [Batch Set Sequential Instance Names or Hostnames].- Hpc
Cluster stringId - When creating a high-performance computing GPU instance, specify the high-performance computing cluster ID.
- Http
Tokens string - Instance metadata access mode: whether to enforce enhanced mode. Values: - optional (default): Not enforced (compatible mode), meaning instance metadata can be accessed either directly or via token-based authentication. - required: Enforced (enhanced mode only), meaning instance metadata can only be accessed via token-based authentication. Note: - For details on how to view metadata and supported metadata items, see [View Instance Metadata]. - Enhanced mode is currently in invitation testing. To request access, contact your account manager.
- Image
Id string - The image ID used to launch the instance. You can use [DescribeImages] to query available image resources.
- Install
Run boolCommand Agent Whether to install the Cloud Assistant Agent when creating the instance. Values: - true: Install during creation - false (default): Do not install during creation
Note: For more information about Cloud Assistant, see [Cloud Assistant Overview].
- Instance
Config ScheduledInstance Instance Config Args - Instance configuration information for the elastic reservation order.
- Instance
Count int Number of instances to create. Value range: - If
ElasticScheduledInstanceTypeis set toEsi, value range is 1–500. - IfElasticScheduledInstanceTypeis set toSegmented, then: - IfDeliveryTypeisReserve, value range is 1–500. - IfDeliveryTypeisImmediate, value range is 1–100.Note: If 0 is entered, the default is 1.
- Instance
Name string Instance name - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods "." - Length must be between 1 and 128 characters
Note: - If the instance has a
SuffixIndexsequential suffix, the instance name length includes the suffix - When creating instances in bulk, you can use thename_prefix[begin_number,bits]name_suffixformat to customize sequential instance names. For details, see [Batch Set Sequential Instance Names or Host Names]- Instance
Type stringId - Instance type. - For supported instance types available for reservation, see [Elastic Scheduled Instance Overview]. - You can call [DescribeAvailableResource] to query inventory information for compute resources in the availability zone.
- Invalid
At string - Elastic reservation order expiration time.
- Keep
Image boolCredential - Whether to retain image settings. Values: - true: Retain image settings. If retained, the instance will use the preset password or key pair from the image for login. - false (default): Do not retain image settings.
Note: - Only custom images and shared images support this feature. - When this parameter is set to
true, do not specifyPassWordorKeyPairName. - Key
Pair stringName To log in to the instance using an SSH key, specify the name of an existing key pair. You can call [DescribeKeyPairs] to view existing key pairs; if none are available, call [CreateKeyPair] to create one
Note: - Windows instances do not support SSH key login. Even if this parameter is provided, only the password
Passwordis valid - Linux instances support login via password or key pair. If bothKeyPairNameandPasswordare set when calling this API, onlyKeyPairNametakes effect- Min
Count int - Specify the minimum number of Elastic Scheduled Instances to create. Value range: - ESI-General, ESI-Segmented (Scheduled Delivery): 1–500 - ESI-Segmented (Immediate Delivery): 1–100
Note: - The minimum instance creation quantity
MinCount≤ creation quantityCount. - If inventory quantity > creation quantityCount, create according toCount. - If minimum creation quantityMinCount≤ inventory quantity ≤ creation quantityCount, create according to inventory quantity. - If inventory quantity < minimum creation quantityMinCount, creation fails due to insufficient inventory. - Network
Interfaces []ScheduledInstance Network Interface Args - Network interface configuration information specified when creating the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Password string
- If you want to log in to the instance using the 'password' method, specify the initial login password for the administrator account through this parameter. The Linux administrator account is root, and the Windows administrator account is Administrator. Password complexity requirements: - Length must be between 8 and 30 characters. - Password must contain at least three of the following: uppercase letters, lowercase letters, numbers, and special characters. - Allowed special characters: `~!@#$%^&*()_-+=|{}[]:;'<>,.?/ - Cannot start with '/' or '$6$'. Note: Login credentials support three methods: 'password', 'key pair', and 'retain image settings'. When using the 'password' method to log in, it is recommended to increase password complexity for enhanced security.
- Project
Name string - Project to which the resource belongs. Each resource can belong to only one project. - Can only contain letters, numbers, underscore '_', period '.', and hyphen '-'. - Maximum length is 64 characters.
- Release
Count int - Number of released instances.
- Scheduled
Instance stringDescription - Description of the flexible reservation order. The default value is an empty string. - Must start with a letter or Chinese character. - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals sign '=', English comma ',', Chinese comma ',', and Chinese period '。' - Maximum length is 255 characters.
- Scheduled
Instance stringId - Elastic reservation order ID.
- Scheduled
Instance stringName - Name of the elastic reservation order. Values: - Cannot start with a number, hyphen, or underscore. - Can only contain Chinese characters, letters, numbers, underscores, and hyphens. - Length limit: 1–128 characters. - Special characters are not supported.
- Security
Enhancement stringStrategy - Whether to enable security hardening. Values: - Active: Enable security hardening, applies only to public images. - InActive: Disable security hardening, applies to all image types.
- Start
Delivery stringAt - Instance delivery start time. Must be on a 10-minute mark (e.g., 10:00, 10:10, 10:20, etc.). - When
ElasticScheduledInstanceTypeis set toEsi, delivery time is within 4–8 hours after reservation. - WhenElasticScheduledInstanceTypeis set toSegmented: - IfDeliveryTypeisReserve, delivery time is within 24 hours after reservation. - IfDeliveryTypeisImmediate, this parameter is not required. - Status string
- ScheduledInstance status.
- Suffix
Index int - Starting sequence number for ordered suffix. Value range: 1–999. Default is 1.
-
[]Scheduled
Instance Tag Args - Flexible reservation order tag information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Unique
Suffix bool - Indicates whether to automatically add an ordered suffix to
HostNameandInstanceNamewhen creating multiple instances. Values: - true: Enable ordered suffix. - false (default): Disable ordered suffix. Note: - When ordered suffix is enabled andHostNameis empty, the system will automatically generate a host name without an ordered suffix. - When ordered suffix is enabled and the[begin_number,bits]naming format is specified forHostNameorInstanceName, see [Batch Set Ordered Instance Names or Host Names] for the final effect. - Updated
At string - Elastic reservation order update time.
- User
Data string - Instance custom data. Custom data must be Base64-encoded, and the size before encoding must not exceed 16KB. If not specified, defaults to empty.
- Volumes
[]Scheduled
Instance Volume Args - Cloud disk configuration information specified when creating an instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Zone
Id string - Availability zone ID where the instance is located. You can call [DescribeZones] to query the availability zones in a region.
- auto_
release_ stringat - Instance automatic release time. Must be at a 10-minute mark. When
ElasticScheduledInstanceTypeis set to Segmented, this parameter is required. Value range: - WhenDeliveryTypeis Reserve, the earliest release time is one hour after the reserved delivery time slot. - WhenDeliveryTypeis Immediate, the earliest release time is the next 10-minute mark after the current time. For example, if the current time is 5:02, the earliest automatic release time is 5:20. - cpu_
max_ numberfrequency Specify the maximum CPU frequency in GHz. Value range: between the base frequency and turbo frequency of the CPU.
Note: - Currently, only g3al (4xlarge, 8xlarge, 16xlarge, 32xlarge), c3al (4xlarge, 8xlarge, 16xlarge, 32xlarge), r3al (4xlarge, 8xlarge, 16xlarge), g4i, c4i, r4i, g4ie, c4ie, r4ie instances support this parameter. For details on base/turbo frequency and more information, see [Instance Specifications]. - This feature is in invitation-only testing. To use it, contact your account manager.
- created_
at string - ScheduledInstance creation time.
- deletion_
protection bool - Instance deletion protection attribute. Specifies whether the instance can be deleted via console or API. Values: - true: Enable instance deletion protection - false (default): Disable instance deletion protection
- delivery_
count number - Number of delivered instances
- delivery_
type string - Elastic Scheduled Instance - Segmented delivery type. Values: - Reserve (default): scheduled delivery - Immediate: immediate delivery
Note: - This parameter is required only when
ElasticScheduledInstanceTypeis set toSegmented. - Elastic Scheduled Instance - Segmented is currently in invitation testing. To apply for a trial, please contact your account manager. - description string
- Instance description. The default value is an empty string. - Must start with a letter or Chinese character. - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals sign '=', English comma ',', Chinese comma ',', and Chinese period '。' - Maximum length is 255 characters.
- eip_
address object - Public IP configuration specified when creating the instance.
- elastic_
scheduled_ stringinstance_ type - Elastic scheduled instance type. Options: - Esi (default): Elastic scheduled instance. - Segmented: Elastic scheduled instance (time segment). Note: Elastic scheduled instance (time segment) is currently in invite-only beta. To try it, please contact your account manager.
- end_
delivery_ stringat - Instance end delivery time. Must be on a 10-minute mark, and the interval with
StartDeliveryAtmust be 10 minutes - IfElasticScheduledInstanceTypeisEsi, the end delivery time must be within 4–8 hours after reservation - IfElasticScheduledInstanceTypeisSegmented: - IfDeliveryTypeisReserve, the end delivery time must be within 24 hours after reservation - IfDeliveryTypeisImmediate, this parameter is not required - host_
name string Instance hostname, which is the computer name inside the instance operating system. - Linux instances: - Letters, numbers, periods ("."), and hyphens ("-") are allowed. - Cannot start or end with a hyphen or period, and hyphens and periods cannot be used consecutively. - Length must be between 2 and 63 characters for Linux systems. - Windows instances: - Letters, numbers, and hyphens ("-") are allowed, but the name cannot consist of only numbers. - Cannot start or end with a hyphen, and hyphens cannot be used consecutively. - Length must be between 2 and 15 characters for Windows systems.
Note: - If left blank, the hostname is automatically generated according to the iv - + initial hostname rule, for example, iv-3tigy72q3u3vj0******. - Initial hostname generation logic: - Linux: Extract all characters after the instance ID i-. - Windows: Extract the last 12 characters after the instance ID i-. - When creating instances in batches, you can use the
name_prefix[begin_number,bits]name_suffixformat to customize sequential hostnames. For details, see [Batch Set Sequential Instance Names or Hostnames].- hpc_
cluster_ stringid - When creating a high-performance computing GPU instance, specify the high-performance computing cluster ID.
- http_
tokens string - Instance metadata access mode: whether to enforce enhanced mode. Values: - optional (default): Not enforced (compatible mode), meaning instance metadata can be accessed either directly or via token-based authentication. - required: Enforced (enhanced mode only), meaning instance metadata can only be accessed via token-based authentication. Note: - For details on how to view metadata and supported metadata items, see [View Instance Metadata]. - Enhanced mode is currently in invitation testing. To request access, contact your account manager.
- image_
id string - The image ID used to launch the instance. You can use [DescribeImages] to query available image resources.
- install_
run_ boolcommand_ agent Whether to install the Cloud Assistant Agent when creating the instance. Values: - true: Install during creation - false (default): Do not install during creation
Note: For more information about Cloud Assistant, see [Cloud Assistant Overview].
- instance_
config object - Instance configuration information for the elastic reservation order.
- instance_
count number Number of instances to create. Value range: - If
ElasticScheduledInstanceTypeis set toEsi, value range is 1–500. - IfElasticScheduledInstanceTypeis set toSegmented, then: - IfDeliveryTypeisReserve, value range is 1–500. - IfDeliveryTypeisImmediate, value range is 1–100.Note: If 0 is entered, the default is 1.
- instance_
name string Instance name - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods "." - Length must be between 1 and 128 characters
Note: - If the instance has a
SuffixIndexsequential suffix, the instance name length includes the suffix - When creating instances in bulk, you can use thename_prefix[begin_number,bits]name_suffixformat to customize sequential instance names. For details, see [Batch Set Sequential Instance Names or Host Names]- instance_
type_ stringid - Instance type. - For supported instance types available for reservation, see [Elastic Scheduled Instance Overview]. - You can call [DescribeAvailableResource] to query inventory information for compute resources in the availability zone.
- invalid_
at string - Elastic reservation order expiration time.
- keep_
image_ boolcredential - Whether to retain image settings. Values: - true: Retain image settings. If retained, the instance will use the preset password or key pair from the image for login. - false (default): Do not retain image settings.
Note: - Only custom images and shared images support this feature. - When this parameter is set to
true, do not specifyPassWordorKeyPairName. - key_
pair_ stringname To log in to the instance using an SSH key, specify the name of an existing key pair. You can call [DescribeKeyPairs] to view existing key pairs; if none are available, call [CreateKeyPair] to create one
Note: - Windows instances do not support SSH key login. Even if this parameter is provided, only the password
Passwordis valid - Linux instances support login via password or key pair. If bothKeyPairNameandPasswordare set when calling this API, onlyKeyPairNametakes effect- min_
count number - Specify the minimum number of Elastic Scheduled Instances to create. Value range: - ESI-General, ESI-Segmented (Scheduled Delivery): 1–500 - ESI-Segmented (Immediate Delivery): 1–100
Note: - The minimum instance creation quantity
MinCount≤ creation quantityCount. - If inventory quantity > creation quantityCount, create according toCount. - If minimum creation quantityMinCount≤ inventory quantity ≤ creation quantityCount, create according to inventory quantity. - If inventory quantity < minimum creation quantityMinCount, creation fails due to insufficient inventory. - network_
interfaces list(object) - Network interface configuration information specified when creating the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- password string
- If you want to log in to the instance using the 'password' method, specify the initial login password for the administrator account through this parameter. The Linux administrator account is root, and the Windows administrator account is Administrator. Password complexity requirements: - Length must be between 8 and 30 characters. - Password must contain at least three of the following: uppercase letters, lowercase letters, numbers, and special characters. - Allowed special characters: `~!@#$%^&*()_-+=|{}[]:;'<>,.?/ - Cannot start with '/' or '$6$'. Note: Login credentials support three methods: 'password', 'key pair', and 'retain image settings'. When using the 'password' method to log in, it is recommended to increase password complexity for enhanced security.
- project_
name string - Project to which the resource belongs. Each resource can belong to only one project. - Can only contain letters, numbers, underscore '_', period '.', and hyphen '-'. - Maximum length is 64 characters.
- release_
count number - Number of released instances.
- scheduled_
instance_ stringdescription - Description of the flexible reservation order. The default value is an empty string. - Must start with a letter or Chinese character. - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals sign '=', English comma ',', Chinese comma ',', and Chinese period '。' - Maximum length is 255 characters.
- scheduled_
instance_ stringid - Elastic reservation order ID.
- scheduled_
instance_ stringname - Name of the elastic reservation order. Values: - Cannot start with a number, hyphen, or underscore. - Can only contain Chinese characters, letters, numbers, underscores, and hyphens. - Length limit: 1–128 characters. - Special characters are not supported.
- security_
enhancement_ stringstrategy - Whether to enable security hardening. Values: - Active: Enable security hardening, applies only to public images. - InActive: Disable security hardening, applies to all image types.
- start_
delivery_ stringat - Instance delivery start time. Must be on a 10-minute mark (e.g., 10:00, 10:10, 10:20, etc.). - When
ElasticScheduledInstanceTypeis set toEsi, delivery time is within 4–8 hours after reservation. - WhenElasticScheduledInstanceTypeis set toSegmented: - IfDeliveryTypeisReserve, delivery time is within 24 hours after reservation. - IfDeliveryTypeisImmediate, this parameter is not required. - status string
- ScheduledInstance status.
- suffix_
index number - Starting sequence number for ordered suffix. Value range: 1–999. Default is 1.
- list(object)
- Flexible reservation order tag information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- unique_
suffix bool - Indicates whether to automatically add an ordered suffix to
HostNameandInstanceNamewhen creating multiple instances. Values: - true: Enable ordered suffix. - false (default): Disable ordered suffix. Note: - When ordered suffix is enabled andHostNameis empty, the system will automatically generate a host name without an ordered suffix. - When ordered suffix is enabled and the[begin_number,bits]naming format is specified forHostNameorInstanceName, see [Batch Set Ordered Instance Names or Host Names] for the final effect. - updated_
at string - Elastic reservation order update time.
- user_
data string - Instance custom data. Custom data must be Base64-encoded, and the size before encoding must not exceed 16KB. If not specified, defaults to empty.
- volumes list(object)
- Cloud disk configuration information specified when creating an instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- zone_
id string - Availability zone ID where the instance is located. You can call [DescribeZones] to query the availability zones in a region.
- auto
Release StringAt - Instance automatic release time. Must be at a 10-minute mark. When
ElasticScheduledInstanceTypeis set to Segmented, this parameter is required. Value range: - WhenDeliveryTypeis Reserve, the earliest release time is one hour after the reserved delivery time slot. - WhenDeliveryTypeis Immediate, the earliest release time is the next 10-minute mark after the current time. For example, if the current time is 5:02, the earliest automatic release time is 5:20. - cpu
Max DoubleFrequency Specify the maximum CPU frequency in GHz. Value range: between the base frequency and turbo frequency of the CPU.
Note: - Currently, only g3al (4xlarge, 8xlarge, 16xlarge, 32xlarge), c3al (4xlarge, 8xlarge, 16xlarge, 32xlarge), r3al (4xlarge, 8xlarge, 16xlarge), g4i, c4i, r4i, g4ie, c4ie, r4ie instances support this parameter. For details on base/turbo frequency and more information, see [Instance Specifications]. - This feature is in invitation-only testing. To use it, contact your account manager.
- created
At String - ScheduledInstance creation time.
- deletion
Protection Boolean - Instance deletion protection attribute. Specifies whether the instance can be deleted via console or API. Values: - true: Enable instance deletion protection - false (default): Disable instance deletion protection
- delivery
Count Integer - Number of delivered instances
- delivery
Type String - Elastic Scheduled Instance - Segmented delivery type. Values: - Reserve (default): scheduled delivery - Immediate: immediate delivery
Note: - This parameter is required only when
ElasticScheduledInstanceTypeis set toSegmented. - Elastic Scheduled Instance - Segmented is currently in invitation testing. To apply for a trial, please contact your account manager. - description String
- Instance description. The default value is an empty string. - Must start with a letter or Chinese character. - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals sign '=', English comma ',', Chinese comma ',', and Chinese period '。' - Maximum length is 255 characters.
- eip
Address ScheduledInstance Eip Address - Public IP configuration specified when creating the instance.
- elastic
Scheduled StringInstance Type - Elastic scheduled instance type. Options: - Esi (default): Elastic scheduled instance. - Segmented: Elastic scheduled instance (time segment). Note: Elastic scheduled instance (time segment) is currently in invite-only beta. To try it, please contact your account manager.
- end
Delivery StringAt - Instance end delivery time. Must be on a 10-minute mark, and the interval with
StartDeliveryAtmust be 10 minutes - IfElasticScheduledInstanceTypeisEsi, the end delivery time must be within 4–8 hours after reservation - IfElasticScheduledInstanceTypeisSegmented: - IfDeliveryTypeisReserve, the end delivery time must be within 24 hours after reservation - IfDeliveryTypeisImmediate, this parameter is not required - host
Name String Instance hostname, which is the computer name inside the instance operating system. - Linux instances: - Letters, numbers, periods ("."), and hyphens ("-") are allowed. - Cannot start or end with a hyphen or period, and hyphens and periods cannot be used consecutively. - Length must be between 2 and 63 characters for Linux systems. - Windows instances: - Letters, numbers, and hyphens ("-") are allowed, but the name cannot consist of only numbers. - Cannot start or end with a hyphen, and hyphens cannot be used consecutively. - Length must be between 2 and 15 characters for Windows systems.
Note: - If left blank, the hostname is automatically generated according to the iv - + initial hostname rule, for example, iv-3tigy72q3u3vj0******. - Initial hostname generation logic: - Linux: Extract all characters after the instance ID i-. - Windows: Extract the last 12 characters after the instance ID i-. - When creating instances in batches, you can use the
name_prefix[begin_number,bits]name_suffixformat to customize sequential hostnames. For details, see [Batch Set Sequential Instance Names or Hostnames].- hpc
Cluster StringId - When creating a high-performance computing GPU instance, specify the high-performance computing cluster ID.
- http
Tokens String - Instance metadata access mode: whether to enforce enhanced mode. Values: - optional (default): Not enforced (compatible mode), meaning instance metadata can be accessed either directly or via token-based authentication. - required: Enforced (enhanced mode only), meaning instance metadata can only be accessed via token-based authentication. Note: - For details on how to view metadata and supported metadata items, see [View Instance Metadata]. - Enhanced mode is currently in invitation testing. To request access, contact your account manager.
- image
Id String - The image ID used to launch the instance. You can use [DescribeImages] to query available image resources.
- install
Run BooleanCommand Agent Whether to install the Cloud Assistant Agent when creating the instance. Values: - true: Install during creation - false (default): Do not install during creation
Note: For more information about Cloud Assistant, see [Cloud Assistant Overview].
- instance
Config ScheduledInstance Instance Config - Instance configuration information for the elastic reservation order.
- instance
Count Integer Number of instances to create. Value range: - If
ElasticScheduledInstanceTypeis set toEsi, value range is 1–500. - IfElasticScheduledInstanceTypeis set toSegmented, then: - IfDeliveryTypeisReserve, value range is 1–500. - IfDeliveryTypeisImmediate, value range is 1–100.Note: If 0 is entered, the default is 1.
- instance
Name String Instance name - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods "." - Length must be between 1 and 128 characters
Note: - If the instance has a
SuffixIndexsequential suffix, the instance name length includes the suffix - When creating instances in bulk, you can use thename_prefix[begin_number,bits]name_suffixformat to customize sequential instance names. For details, see [Batch Set Sequential Instance Names or Host Names]- instance
Type StringId - Instance type. - For supported instance types available for reservation, see [Elastic Scheduled Instance Overview]. - You can call [DescribeAvailableResource] to query inventory information for compute resources in the availability zone.
- invalid
At String - Elastic reservation order expiration time.
- keep
Image BooleanCredential - Whether to retain image settings. Values: - true: Retain image settings. If retained, the instance will use the preset password or key pair from the image for login. - false (default): Do not retain image settings.
Note: - Only custom images and shared images support this feature. - When this parameter is set to
true, do not specifyPassWordorKeyPairName. - key
Pair StringName To log in to the instance using an SSH key, specify the name of an existing key pair. You can call [DescribeKeyPairs] to view existing key pairs; if none are available, call [CreateKeyPair] to create one
Note: - Windows instances do not support SSH key login. Even if this parameter is provided, only the password
Passwordis valid - Linux instances support login via password or key pair. If bothKeyPairNameandPasswordare set when calling this API, onlyKeyPairNametakes effect- min
Count Integer - Specify the minimum number of Elastic Scheduled Instances to create. Value range: - ESI-General, ESI-Segmented (Scheduled Delivery): 1–500 - ESI-Segmented (Immediate Delivery): 1–100
Note: - The minimum instance creation quantity
MinCount≤ creation quantityCount. - If inventory quantity > creation quantityCount, create according toCount. - If minimum creation quantityMinCount≤ inventory quantity ≤ creation quantityCount, create according to inventory quantity. - If inventory quantity < minimum creation quantityMinCount, creation fails due to insufficient inventory. - network
Interfaces List<ScheduledInstance Network Interface> - Network interface configuration information specified when creating the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- password String
- If you want to log in to the instance using the 'password' method, specify the initial login password for the administrator account through this parameter. The Linux administrator account is root, and the Windows administrator account is Administrator. Password complexity requirements: - Length must be between 8 and 30 characters. - Password must contain at least three of the following: uppercase letters, lowercase letters, numbers, and special characters. - Allowed special characters: `~!@#$%^&*()_-+=|{}[]:;'<>,.?/ - Cannot start with '/' or '$6$'. Note: Login credentials support three methods: 'password', 'key pair', and 'retain image settings'. When using the 'password' method to log in, it is recommended to increase password complexity for enhanced security.
- project
Name String - Project to which the resource belongs. Each resource can belong to only one project. - Can only contain letters, numbers, underscore '_', period '.', and hyphen '-'. - Maximum length is 64 characters.
- release
Count Integer - Number of released instances.
- scheduled
Instance StringDescription - Description of the flexible reservation order. The default value is an empty string. - Must start with a letter or Chinese character. - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals sign '=', English comma ',', Chinese comma ',', and Chinese period '。' - Maximum length is 255 characters.
- scheduled
Instance StringId - Elastic reservation order ID.
- scheduled
Instance StringName - Name of the elastic reservation order. Values: - Cannot start with a number, hyphen, or underscore. - Can only contain Chinese characters, letters, numbers, underscores, and hyphens. - Length limit: 1–128 characters. - Special characters are not supported.
- security
Enhancement StringStrategy - Whether to enable security hardening. Values: - Active: Enable security hardening, applies only to public images. - InActive: Disable security hardening, applies to all image types.
- start
Delivery StringAt - Instance delivery start time. Must be on a 10-minute mark (e.g., 10:00, 10:10, 10:20, etc.). - When
ElasticScheduledInstanceTypeis set toEsi, delivery time is within 4–8 hours after reservation. - WhenElasticScheduledInstanceTypeis set toSegmented: - IfDeliveryTypeisReserve, delivery time is within 24 hours after reservation. - IfDeliveryTypeisImmediate, this parameter is not required. - status String
- ScheduledInstance status.
- suffix
Index Integer - Starting sequence number for ordered suffix. Value range: 1–999. Default is 1.
-
List<Scheduled
Instance Tag> - Flexible reservation order tag information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- unique
Suffix Boolean - Indicates whether to automatically add an ordered suffix to
HostNameandInstanceNamewhen creating multiple instances. Values: - true: Enable ordered suffix. - false (default): Disable ordered suffix. Note: - When ordered suffix is enabled andHostNameis empty, the system will automatically generate a host name without an ordered suffix. - When ordered suffix is enabled and the[begin_number,bits]naming format is specified forHostNameorInstanceName, see [Batch Set Ordered Instance Names or Host Names] for the final effect. - updated
At String - Elastic reservation order update time.
- user
Data String - Instance custom data. Custom data must be Base64-encoded, and the size before encoding must not exceed 16KB. If not specified, defaults to empty.
- volumes
List<Scheduled
Instance Volume> - Cloud disk configuration information specified when creating an instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- zone
Id String - Availability zone ID where the instance is located. You can call [DescribeZones] to query the availability zones in a region.
- auto
Release stringAt - Instance automatic release time. Must be at a 10-minute mark. When
ElasticScheduledInstanceTypeis set to Segmented, this parameter is required. Value range: - WhenDeliveryTypeis Reserve, the earliest release time is one hour after the reserved delivery time slot. - WhenDeliveryTypeis Immediate, the earliest release time is the next 10-minute mark after the current time. For example, if the current time is 5:02, the earliest automatic release time is 5:20. - cpu
Max numberFrequency Specify the maximum CPU frequency in GHz. Value range: between the base frequency and turbo frequency of the CPU.
Note: - Currently, only g3al (4xlarge, 8xlarge, 16xlarge, 32xlarge), c3al (4xlarge, 8xlarge, 16xlarge, 32xlarge), r3al (4xlarge, 8xlarge, 16xlarge), g4i, c4i, r4i, g4ie, c4ie, r4ie instances support this parameter. For details on base/turbo frequency and more information, see [Instance Specifications]. - This feature is in invitation-only testing. To use it, contact your account manager.
- created
At string - ScheduledInstance creation time.
- deletion
Protection boolean - Instance deletion protection attribute. Specifies whether the instance can be deleted via console or API. Values: - true: Enable instance deletion protection - false (default): Disable instance deletion protection
- delivery
Count number - Number of delivered instances
- delivery
Type string - Elastic Scheduled Instance - Segmented delivery type. Values: - Reserve (default): scheduled delivery - Immediate: immediate delivery
Note: - This parameter is required only when
ElasticScheduledInstanceTypeis set toSegmented. - Elastic Scheduled Instance - Segmented is currently in invitation testing. To apply for a trial, please contact your account manager. - description string
- Instance description. The default value is an empty string. - Must start with a letter or Chinese character. - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals sign '=', English comma ',', Chinese comma ',', and Chinese period '。' - Maximum length is 255 characters.
- eip
Address ScheduledInstance Eip Address - Public IP configuration specified when creating the instance.
- elastic
Scheduled stringInstance Type - Elastic scheduled instance type. Options: - Esi (default): Elastic scheduled instance. - Segmented: Elastic scheduled instance (time segment). Note: Elastic scheduled instance (time segment) is currently in invite-only beta. To try it, please contact your account manager.
- end
Delivery stringAt - Instance end delivery time. Must be on a 10-minute mark, and the interval with
StartDeliveryAtmust be 10 minutes - IfElasticScheduledInstanceTypeisEsi, the end delivery time must be within 4–8 hours after reservation - IfElasticScheduledInstanceTypeisSegmented: - IfDeliveryTypeisReserve, the end delivery time must be within 24 hours after reservation - IfDeliveryTypeisImmediate, this parameter is not required - host
Name string Instance hostname, which is the computer name inside the instance operating system. - Linux instances: - Letters, numbers, periods ("."), and hyphens ("-") are allowed. - Cannot start or end with a hyphen or period, and hyphens and periods cannot be used consecutively. - Length must be between 2 and 63 characters for Linux systems. - Windows instances: - Letters, numbers, and hyphens ("-") are allowed, but the name cannot consist of only numbers. - Cannot start or end with a hyphen, and hyphens cannot be used consecutively. - Length must be between 2 and 15 characters for Windows systems.
Note: - If left blank, the hostname is automatically generated according to the iv - + initial hostname rule, for example, iv-3tigy72q3u3vj0******. - Initial hostname generation logic: - Linux: Extract all characters after the instance ID i-. - Windows: Extract the last 12 characters after the instance ID i-. - When creating instances in batches, you can use the
name_prefix[begin_number,bits]name_suffixformat to customize sequential hostnames. For details, see [Batch Set Sequential Instance Names or Hostnames].- hpc
Cluster stringId - When creating a high-performance computing GPU instance, specify the high-performance computing cluster ID.
- http
Tokens string - Instance metadata access mode: whether to enforce enhanced mode. Values: - optional (default): Not enforced (compatible mode), meaning instance metadata can be accessed either directly or via token-based authentication. - required: Enforced (enhanced mode only), meaning instance metadata can only be accessed via token-based authentication. Note: - For details on how to view metadata and supported metadata items, see [View Instance Metadata]. - Enhanced mode is currently in invitation testing. To request access, contact your account manager.
- image
Id string - The image ID used to launch the instance. You can use [DescribeImages] to query available image resources.
- install
Run booleanCommand Agent Whether to install the Cloud Assistant Agent when creating the instance. Values: - true: Install during creation - false (default): Do not install during creation
Note: For more information about Cloud Assistant, see [Cloud Assistant Overview].
- instance
Config ScheduledInstance Instance Config - Instance configuration information for the elastic reservation order.
- instance
Count number Number of instances to create. Value range: - If
ElasticScheduledInstanceTypeis set toEsi, value range is 1–500. - IfElasticScheduledInstanceTypeis set toSegmented, then: - IfDeliveryTypeisReserve, value range is 1–500. - IfDeliveryTypeisImmediate, value range is 1–100.Note: If 0 is entered, the default is 1.
- instance
Name string Instance name - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods "." - Length must be between 1 and 128 characters
Note: - If the instance has a
SuffixIndexsequential suffix, the instance name length includes the suffix - When creating instances in bulk, you can use thename_prefix[begin_number,bits]name_suffixformat to customize sequential instance names. For details, see [Batch Set Sequential Instance Names or Host Names]- instance
Type stringId - Instance type. - For supported instance types available for reservation, see [Elastic Scheduled Instance Overview]. - You can call [DescribeAvailableResource] to query inventory information for compute resources in the availability zone.
- invalid
At string - Elastic reservation order expiration time.
- keep
Image booleanCredential - Whether to retain image settings. Values: - true: Retain image settings. If retained, the instance will use the preset password or key pair from the image for login. - false (default): Do not retain image settings.
Note: - Only custom images and shared images support this feature. - When this parameter is set to
true, do not specifyPassWordorKeyPairName. - key
Pair stringName To log in to the instance using an SSH key, specify the name of an existing key pair. You can call [DescribeKeyPairs] to view existing key pairs; if none are available, call [CreateKeyPair] to create one
Note: - Windows instances do not support SSH key login. Even if this parameter is provided, only the password
Passwordis valid - Linux instances support login via password or key pair. If bothKeyPairNameandPasswordare set when calling this API, onlyKeyPairNametakes effect- min
Count number - Specify the minimum number of Elastic Scheduled Instances to create. Value range: - ESI-General, ESI-Segmented (Scheduled Delivery): 1–500 - ESI-Segmented (Immediate Delivery): 1–100
Note: - The minimum instance creation quantity
MinCount≤ creation quantityCount. - If inventory quantity > creation quantityCount, create according toCount. - If minimum creation quantityMinCount≤ inventory quantity ≤ creation quantityCount, create according to inventory quantity. - If inventory quantity < minimum creation quantityMinCount, creation fails due to insufficient inventory. - network
Interfaces ScheduledInstance Network Interface[] - Network interface configuration information specified when creating the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- password string
- If you want to log in to the instance using the 'password' method, specify the initial login password for the administrator account through this parameter. The Linux administrator account is root, and the Windows administrator account is Administrator. Password complexity requirements: - Length must be between 8 and 30 characters. - Password must contain at least three of the following: uppercase letters, lowercase letters, numbers, and special characters. - Allowed special characters: `~!@#$%^&*()_-+=|{}[]:;'<>,.?/ - Cannot start with '/' or '$6$'. Note: Login credentials support three methods: 'password', 'key pair', and 'retain image settings'. When using the 'password' method to log in, it is recommended to increase password complexity for enhanced security.
- project
Name string - Project to which the resource belongs. Each resource can belong to only one project. - Can only contain letters, numbers, underscore '_', period '.', and hyphen '-'. - Maximum length is 64 characters.
- release
Count number - Number of released instances.
- scheduled
Instance stringDescription - Description of the flexible reservation order. The default value is an empty string. - Must start with a letter or Chinese character. - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals sign '=', English comma ',', Chinese comma ',', and Chinese period '。' - Maximum length is 255 characters.
- scheduled
Instance stringId - Elastic reservation order ID.
- scheduled
Instance stringName - Name of the elastic reservation order. Values: - Cannot start with a number, hyphen, or underscore. - Can only contain Chinese characters, letters, numbers, underscores, and hyphens. - Length limit: 1–128 characters. - Special characters are not supported.
- security
Enhancement stringStrategy - Whether to enable security hardening. Values: - Active: Enable security hardening, applies only to public images. - InActive: Disable security hardening, applies to all image types.
- start
Delivery stringAt - Instance delivery start time. Must be on a 10-minute mark (e.g., 10:00, 10:10, 10:20, etc.). - When
ElasticScheduledInstanceTypeis set toEsi, delivery time is within 4–8 hours after reservation. - WhenElasticScheduledInstanceTypeis set toSegmented: - IfDeliveryTypeisReserve, delivery time is within 24 hours after reservation. - IfDeliveryTypeisImmediate, this parameter is not required. - status string
- ScheduledInstance status.
- suffix
Index number - Starting sequence number for ordered suffix. Value range: 1–999. Default is 1.
-
Scheduled
Instance Tag[] - Flexible reservation order tag information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- unique
Suffix boolean - Indicates whether to automatically add an ordered suffix to
HostNameandInstanceNamewhen creating multiple instances. Values: - true: Enable ordered suffix. - false (default): Disable ordered suffix. Note: - When ordered suffix is enabled andHostNameis empty, the system will automatically generate a host name without an ordered suffix. - When ordered suffix is enabled and the[begin_number,bits]naming format is specified forHostNameorInstanceName, see [Batch Set Ordered Instance Names or Host Names] for the final effect. - updated
At string - Elastic reservation order update time.
- user
Data string - Instance custom data. Custom data must be Base64-encoded, and the size before encoding must not exceed 16KB. If not specified, defaults to empty.
- volumes
Scheduled
Instance Volume[] - Cloud disk configuration information specified when creating an instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- zone
Id string - Availability zone ID where the instance is located. You can call [DescribeZones] to query the availability zones in a region.
- auto_
release_ strat - Instance automatic release time. Must be at a 10-minute mark. When
ElasticScheduledInstanceTypeis set to Segmented, this parameter is required. Value range: - WhenDeliveryTypeis Reserve, the earliest release time is one hour after the reserved delivery time slot. - WhenDeliveryTypeis Immediate, the earliest release time is the next 10-minute mark after the current time. For example, if the current time is 5:02, the earliest automatic release time is 5:20. - cpu_
max_ floatfrequency Specify the maximum CPU frequency in GHz. Value range: between the base frequency and turbo frequency of the CPU.
Note: - Currently, only g3al (4xlarge, 8xlarge, 16xlarge, 32xlarge), c3al (4xlarge, 8xlarge, 16xlarge, 32xlarge), r3al (4xlarge, 8xlarge, 16xlarge), g4i, c4i, r4i, g4ie, c4ie, r4ie instances support this parameter. For details on base/turbo frequency and more information, see [Instance Specifications]. - This feature is in invitation-only testing. To use it, contact your account manager.
- created_
at str - ScheduledInstance creation time.
- deletion_
protection bool - Instance deletion protection attribute. Specifies whether the instance can be deleted via console or API. Values: - true: Enable instance deletion protection - false (default): Disable instance deletion protection
- delivery_
count int - Number of delivered instances
- delivery_
type str - Elastic Scheduled Instance - Segmented delivery type. Values: - Reserve (default): scheduled delivery - Immediate: immediate delivery
Note: - This parameter is required only when
ElasticScheduledInstanceTypeis set toSegmented. - Elastic Scheduled Instance - Segmented is currently in invitation testing. To apply for a trial, please contact your account manager. - description str
- Instance description. The default value is an empty string. - Must start with a letter or Chinese character. - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals sign '=', English comma ',', Chinese comma ',', and Chinese period '。' - Maximum length is 255 characters.
- eip_
address ScheduledInstance Eip Address Args - Public IP configuration specified when creating the instance.
- elastic_
scheduled_ strinstance_ type - Elastic scheduled instance type. Options: - Esi (default): Elastic scheduled instance. - Segmented: Elastic scheduled instance (time segment). Note: Elastic scheduled instance (time segment) is currently in invite-only beta. To try it, please contact your account manager.
- end_
delivery_ strat - Instance end delivery time. Must be on a 10-minute mark, and the interval with
StartDeliveryAtmust be 10 minutes - IfElasticScheduledInstanceTypeisEsi, the end delivery time must be within 4–8 hours after reservation - IfElasticScheduledInstanceTypeisSegmented: - IfDeliveryTypeisReserve, the end delivery time must be within 24 hours after reservation - IfDeliveryTypeisImmediate, this parameter is not required - host_
name str Instance hostname, which is the computer name inside the instance operating system. - Linux instances: - Letters, numbers, periods ("."), and hyphens ("-") are allowed. - Cannot start or end with a hyphen or period, and hyphens and periods cannot be used consecutively. - Length must be between 2 and 63 characters for Linux systems. - Windows instances: - Letters, numbers, and hyphens ("-") are allowed, but the name cannot consist of only numbers. - Cannot start or end with a hyphen, and hyphens cannot be used consecutively. - Length must be between 2 and 15 characters for Windows systems.
Note: - If left blank, the hostname is automatically generated according to the iv - + initial hostname rule, for example, iv-3tigy72q3u3vj0******. - Initial hostname generation logic: - Linux: Extract all characters after the instance ID i-. - Windows: Extract the last 12 characters after the instance ID i-. - When creating instances in batches, you can use the
name_prefix[begin_number,bits]name_suffixformat to customize sequential hostnames. For details, see [Batch Set Sequential Instance Names or Hostnames].- hpc_
cluster_ strid - When creating a high-performance computing GPU instance, specify the high-performance computing cluster ID.
- http_
tokens str - Instance metadata access mode: whether to enforce enhanced mode. Values: - optional (default): Not enforced (compatible mode), meaning instance metadata can be accessed either directly or via token-based authentication. - required: Enforced (enhanced mode only), meaning instance metadata can only be accessed via token-based authentication. Note: - For details on how to view metadata and supported metadata items, see [View Instance Metadata]. - Enhanced mode is currently in invitation testing. To request access, contact your account manager.
- image_
id str - The image ID used to launch the instance. You can use [DescribeImages] to query available image resources.
- install_
run_ boolcommand_ agent Whether to install the Cloud Assistant Agent when creating the instance. Values: - true: Install during creation - false (default): Do not install during creation
Note: For more information about Cloud Assistant, see [Cloud Assistant Overview].
- instance_
config ScheduledInstance Instance Config Args - Instance configuration information for the elastic reservation order.
- instance_
count int Number of instances to create. Value range: - If
ElasticScheduledInstanceTypeis set toEsi, value range is 1–500. - IfElasticScheduledInstanceTypeis set toSegmented, then: - IfDeliveryTypeisReserve, value range is 1–500. - IfDeliveryTypeisImmediate, value range is 1–100.Note: If 0 is entered, the default is 1.
- instance_
name str Instance name - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods "." - Length must be between 1 and 128 characters
Note: - If the instance has a
SuffixIndexsequential suffix, the instance name length includes the suffix - When creating instances in bulk, you can use thename_prefix[begin_number,bits]name_suffixformat to customize sequential instance names. For details, see [Batch Set Sequential Instance Names or Host Names]- instance_
type_ strid - Instance type. - For supported instance types available for reservation, see [Elastic Scheduled Instance Overview]. - You can call [DescribeAvailableResource] to query inventory information for compute resources in the availability zone.
- invalid_
at str - Elastic reservation order expiration time.
- keep_
image_ boolcredential - Whether to retain image settings. Values: - true: Retain image settings. If retained, the instance will use the preset password or key pair from the image for login. - false (default): Do not retain image settings.
Note: - Only custom images and shared images support this feature. - When this parameter is set to
true, do not specifyPassWordorKeyPairName. - key_
pair_ strname To log in to the instance using an SSH key, specify the name of an existing key pair. You can call [DescribeKeyPairs] to view existing key pairs; if none are available, call [CreateKeyPair] to create one
Note: - Windows instances do not support SSH key login. Even if this parameter is provided, only the password
Passwordis valid - Linux instances support login via password or key pair. If bothKeyPairNameandPasswordare set when calling this API, onlyKeyPairNametakes effect- min_
count int - Specify the minimum number of Elastic Scheduled Instances to create. Value range: - ESI-General, ESI-Segmented (Scheduled Delivery): 1–500 - ESI-Segmented (Immediate Delivery): 1–100
Note: - The minimum instance creation quantity
MinCount≤ creation quantityCount. - If inventory quantity > creation quantityCount, create according toCount. - If minimum creation quantityMinCount≤ inventory quantity ≤ creation quantityCount, create according to inventory quantity. - If inventory quantity < minimum creation quantityMinCount, creation fails due to insufficient inventory. - network_
interfaces Sequence[ScheduledInstance Network Interface Args] - Network interface configuration information specified when creating the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- password str
- If you want to log in to the instance using the 'password' method, specify the initial login password for the administrator account through this parameter. The Linux administrator account is root, and the Windows administrator account is Administrator. Password complexity requirements: - Length must be between 8 and 30 characters. - Password must contain at least three of the following: uppercase letters, lowercase letters, numbers, and special characters. - Allowed special characters: `~!@#$%^&*()_-+=|{}[]:;'<>,.?/ - Cannot start with '/' or '$6$'. Note: Login credentials support three methods: 'password', 'key pair', and 'retain image settings'. When using the 'password' method to log in, it is recommended to increase password complexity for enhanced security.
- project_
name str - Project to which the resource belongs. Each resource can belong to only one project. - Can only contain letters, numbers, underscore '_', period '.', and hyphen '-'. - Maximum length is 64 characters.
- release_
count int - Number of released instances.
- scheduled_
instance_ strdescription - Description of the flexible reservation order. The default value is an empty string. - Must start with a letter or Chinese character. - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals sign '=', English comma ',', Chinese comma ',', and Chinese period '。' - Maximum length is 255 characters.
- scheduled_
instance_ strid - Elastic reservation order ID.
- scheduled_
instance_ strname - Name of the elastic reservation order. Values: - Cannot start with a number, hyphen, or underscore. - Can only contain Chinese characters, letters, numbers, underscores, and hyphens. - Length limit: 1–128 characters. - Special characters are not supported.
- security_
enhancement_ strstrategy - Whether to enable security hardening. Values: - Active: Enable security hardening, applies only to public images. - InActive: Disable security hardening, applies to all image types.
- start_
delivery_ strat - Instance delivery start time. Must be on a 10-minute mark (e.g., 10:00, 10:10, 10:20, etc.). - When
ElasticScheduledInstanceTypeis set toEsi, delivery time is within 4–8 hours after reservation. - WhenElasticScheduledInstanceTypeis set toSegmented: - IfDeliveryTypeisReserve, delivery time is within 24 hours after reservation. - IfDeliveryTypeisImmediate, this parameter is not required. - status str
- ScheduledInstance status.
- suffix_
index int - Starting sequence number for ordered suffix. Value range: 1–999. Default is 1.
-
Sequence[Scheduled
Instance Tag Args] - Flexible reservation order tag information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- unique_
suffix bool - Indicates whether to automatically add an ordered suffix to
HostNameandInstanceNamewhen creating multiple instances. Values: - true: Enable ordered suffix. - false (default): Disable ordered suffix. Note: - When ordered suffix is enabled andHostNameis empty, the system will automatically generate a host name without an ordered suffix. - When ordered suffix is enabled and the[begin_number,bits]naming format is specified forHostNameorInstanceName, see [Batch Set Ordered Instance Names or Host Names] for the final effect. - updated_
at str - Elastic reservation order update time.
- user_
data str - Instance custom data. Custom data must be Base64-encoded, and the size before encoding must not exceed 16KB. If not specified, defaults to empty.
- volumes
Sequence[Scheduled
Instance Volume Args] - Cloud disk configuration information specified when creating an instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- zone_
id str - Availability zone ID where the instance is located. You can call [DescribeZones] to query the availability zones in a region.
- auto
Release StringAt - Instance automatic release time. Must be at a 10-minute mark. When
ElasticScheduledInstanceTypeis set to Segmented, this parameter is required. Value range: - WhenDeliveryTypeis Reserve, the earliest release time is one hour after the reserved delivery time slot. - WhenDeliveryTypeis Immediate, the earliest release time is the next 10-minute mark after the current time. For example, if the current time is 5:02, the earliest automatic release time is 5:20. - cpu
Max NumberFrequency Specify the maximum CPU frequency in GHz. Value range: between the base frequency and turbo frequency of the CPU.
Note: - Currently, only g3al (4xlarge, 8xlarge, 16xlarge, 32xlarge), c3al (4xlarge, 8xlarge, 16xlarge, 32xlarge), r3al (4xlarge, 8xlarge, 16xlarge), g4i, c4i, r4i, g4ie, c4ie, r4ie instances support this parameter. For details on base/turbo frequency and more information, see [Instance Specifications]. - This feature is in invitation-only testing. To use it, contact your account manager.
- created
At String - ScheduledInstance creation time.
- deletion
Protection Boolean - Instance deletion protection attribute. Specifies whether the instance can be deleted via console or API. Values: - true: Enable instance deletion protection - false (default): Disable instance deletion protection
- delivery
Count Number - Number of delivered instances
- delivery
Type String - Elastic Scheduled Instance - Segmented delivery type. Values: - Reserve (default): scheduled delivery - Immediate: immediate delivery
Note: - This parameter is required only when
ElasticScheduledInstanceTypeis set toSegmented. - Elastic Scheduled Instance - Segmented is currently in invitation testing. To apply for a trial, please contact your account manager. - description String
- Instance description. The default value is an empty string. - Must start with a letter or Chinese character. - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals sign '=', English comma ',', Chinese comma ',', and Chinese period '。' - Maximum length is 255 characters.
- eip
Address Property Map - Public IP configuration specified when creating the instance.
- elastic
Scheduled StringInstance Type - Elastic scheduled instance type. Options: - Esi (default): Elastic scheduled instance. - Segmented: Elastic scheduled instance (time segment). Note: Elastic scheduled instance (time segment) is currently in invite-only beta. To try it, please contact your account manager.
- end
Delivery StringAt - Instance end delivery time. Must be on a 10-minute mark, and the interval with
StartDeliveryAtmust be 10 minutes - IfElasticScheduledInstanceTypeisEsi, the end delivery time must be within 4–8 hours after reservation - IfElasticScheduledInstanceTypeisSegmented: - IfDeliveryTypeisReserve, the end delivery time must be within 24 hours after reservation - IfDeliveryTypeisImmediate, this parameter is not required - host
Name String Instance hostname, which is the computer name inside the instance operating system. - Linux instances: - Letters, numbers, periods ("."), and hyphens ("-") are allowed. - Cannot start or end with a hyphen or period, and hyphens and periods cannot be used consecutively. - Length must be between 2 and 63 characters for Linux systems. - Windows instances: - Letters, numbers, and hyphens ("-") are allowed, but the name cannot consist of only numbers. - Cannot start or end with a hyphen, and hyphens cannot be used consecutively. - Length must be between 2 and 15 characters for Windows systems.
Note: - If left blank, the hostname is automatically generated according to the iv - + initial hostname rule, for example, iv-3tigy72q3u3vj0******. - Initial hostname generation logic: - Linux: Extract all characters after the instance ID i-. - Windows: Extract the last 12 characters after the instance ID i-. - When creating instances in batches, you can use the
name_prefix[begin_number,bits]name_suffixformat to customize sequential hostnames. For details, see [Batch Set Sequential Instance Names or Hostnames].- hpc
Cluster StringId - When creating a high-performance computing GPU instance, specify the high-performance computing cluster ID.
- http
Tokens String - Instance metadata access mode: whether to enforce enhanced mode. Values: - optional (default): Not enforced (compatible mode), meaning instance metadata can be accessed either directly or via token-based authentication. - required: Enforced (enhanced mode only), meaning instance metadata can only be accessed via token-based authentication. Note: - For details on how to view metadata and supported metadata items, see [View Instance Metadata]. - Enhanced mode is currently in invitation testing. To request access, contact your account manager.
- image
Id String - The image ID used to launch the instance. You can use [DescribeImages] to query available image resources.
- install
Run BooleanCommand Agent Whether to install the Cloud Assistant Agent when creating the instance. Values: - true: Install during creation - false (default): Do not install during creation
Note: For more information about Cloud Assistant, see [Cloud Assistant Overview].
- instance
Config Property Map - Instance configuration information for the elastic reservation order.
- instance
Count Number Number of instances to create. Value range: - If
ElasticScheduledInstanceTypeis set toEsi, value range is 1–500. - IfElasticScheduledInstanceTypeis set toSegmented, then: - IfDeliveryTypeisReserve, value range is 1–500. - IfDeliveryTypeisImmediate, value range is 1–100.Note: If 0 is entered, the default is 1.
- instance
Name String Instance name - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods "." - Length must be between 1 and 128 characters
Note: - If the instance has a
SuffixIndexsequential suffix, the instance name length includes the suffix - When creating instances in bulk, you can use thename_prefix[begin_number,bits]name_suffixformat to customize sequential instance names. For details, see [Batch Set Sequential Instance Names or Host Names]- instance
Type StringId - Instance type. - For supported instance types available for reservation, see [Elastic Scheduled Instance Overview]. - You can call [DescribeAvailableResource] to query inventory information for compute resources in the availability zone.
- invalid
At String - Elastic reservation order expiration time.
- keep
Image BooleanCredential - Whether to retain image settings. Values: - true: Retain image settings. If retained, the instance will use the preset password or key pair from the image for login. - false (default): Do not retain image settings.
Note: - Only custom images and shared images support this feature. - When this parameter is set to
true, do not specifyPassWordorKeyPairName. - key
Pair StringName To log in to the instance using an SSH key, specify the name of an existing key pair. You can call [DescribeKeyPairs] to view existing key pairs; if none are available, call [CreateKeyPair] to create one
Note: - Windows instances do not support SSH key login. Even if this parameter is provided, only the password
Passwordis valid - Linux instances support login via password or key pair. If bothKeyPairNameandPasswordare set when calling this API, onlyKeyPairNametakes effect- min
Count Number - Specify the minimum number of Elastic Scheduled Instances to create. Value range: - ESI-General, ESI-Segmented (Scheduled Delivery): 1–500 - ESI-Segmented (Immediate Delivery): 1–100
Note: - The minimum instance creation quantity
MinCount≤ creation quantityCount. - If inventory quantity > creation quantityCount, create according toCount. - If minimum creation quantityMinCount≤ inventory quantity ≤ creation quantityCount, create according to inventory quantity. - If inventory quantity < minimum creation quantityMinCount, creation fails due to insufficient inventory. - network
Interfaces List<Property Map> - Network interface configuration information specified when creating the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- password String
- If you want to log in to the instance using the 'password' method, specify the initial login password for the administrator account through this parameter. The Linux administrator account is root, and the Windows administrator account is Administrator. Password complexity requirements: - Length must be between 8 and 30 characters. - Password must contain at least three of the following: uppercase letters, lowercase letters, numbers, and special characters. - Allowed special characters: `~!@#$%^&*()_-+=|{}[]:;'<>,.?/ - Cannot start with '/' or '$6$'. Note: Login credentials support three methods: 'password', 'key pair', and 'retain image settings'. When using the 'password' method to log in, it is recommended to increase password complexity for enhanced security.
- project
Name String - Project to which the resource belongs. Each resource can belong to only one project. - Can only contain letters, numbers, underscore '_', period '.', and hyphen '-'. - Maximum length is 64 characters.
- release
Count Number - Number of released instances.
- scheduled
Instance StringDescription - Description of the flexible reservation order. The default value is an empty string. - Must start with a letter or Chinese character. - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals sign '=', English comma ',', Chinese comma ',', and Chinese period '。' - Maximum length is 255 characters.
- scheduled
Instance StringId - Elastic reservation order ID.
- scheduled
Instance StringName - Name of the elastic reservation order. Values: - Cannot start with a number, hyphen, or underscore. - Can only contain Chinese characters, letters, numbers, underscores, and hyphens. - Length limit: 1–128 characters. - Special characters are not supported.
- security
Enhancement StringStrategy - Whether to enable security hardening. Values: - Active: Enable security hardening, applies only to public images. - InActive: Disable security hardening, applies to all image types.
- start
Delivery StringAt - Instance delivery start time. Must be on a 10-minute mark (e.g., 10:00, 10:10, 10:20, etc.). - When
ElasticScheduledInstanceTypeis set toEsi, delivery time is within 4–8 hours after reservation. - WhenElasticScheduledInstanceTypeis set toSegmented: - IfDeliveryTypeisReserve, delivery time is within 24 hours after reservation. - IfDeliveryTypeisImmediate, this parameter is not required. - status String
- ScheduledInstance status.
- suffix
Index Number - Starting sequence number for ordered suffix. Value range: 1–999. Default is 1.
- List<Property Map>
- Flexible reservation order tag information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- unique
Suffix Boolean - Indicates whether to automatically add an ordered suffix to
HostNameandInstanceNamewhen creating multiple instances. Values: - true: Enable ordered suffix. - false (default): Disable ordered suffix. Note: - When ordered suffix is enabled andHostNameis empty, the system will automatically generate a host name without an ordered suffix. - When ordered suffix is enabled and the[begin_number,bits]naming format is specified forHostNameorInstanceName, see [Batch Set Ordered Instance Names or Host Names] for the final effect. - updated
At String - Elastic reservation order update time.
- user
Data String - Instance custom data. Custom data must be Base64-encoded, and the size before encoding must not exceed 16KB. If not specified, defaults to empty.
- volumes List<Property Map>
- Cloud disk configuration information specified when creating an instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- zone
Id String - Availability zone ID where the instance is located. You can call [DescribeZones] to query the availability zones in a region.
Supporting Types
ScheduledInstanceEipAddress, ScheduledInstanceEipAddressArgs
- Bandwidth
Mbps int - The maximum bandwidth for the public IP address. Default value: 1. Unit: Mbps. - When
ChargeTypeis set toPayByBandwidth: valid range is 1–500. - WhenChargeTypeis set toPayByTraffic: valid range is 1–200. - Bandwidth
Package stringId - ID of the shared bandwidth package, indicating that the public IP will be added to the shared bandwidth package. - You can call the [DescribeBandwidthPackages] API to query the ID of the shared bandwidth package. - The following conditions must be met to add a public IP to a shared bandwidth package: - Both must have the same security protection type. - Both must be in the same region. - The billing method for the public IP must be pay-as-you-go. - The shared bandwidth package must be of IPv4 type.
- Charge
Type string - Public IP billing method. Options: - PayByBandwidth (default): Pay-as-you-go by bandwidth cap. - PayByTraffic: Pay-as-you-go by actual traffic. - PrePaid: Subscription.
Note: When the instance billing type
InstanceChargeTypeis set toPostPaid, this parameter cannot be set toPrePaid. - Isp string
- Public IP line type. Defaults to BGP. Options: - BGP: BGP (multi-line). - If your account has applied for and enabled static single-line permissions, you can use: - ChinaMobile: China Mobile static single-line. - ChinaTelecom: China Telecom static single-line. - ChinaUnicom: China Unicom static single-line. - If your account has applied for and enabled BGP single-line permissions, you can use SingleLine_BGP. - If your account has applied for and enabled static BGP permissions, you can use Static_BGP.
- Release
With boolInstance - Whether the public IP is released with the instance - true: The public IP is released with the instance - false (default): The public IP is not released with the instance
- Security
Protection intInstance Id - DDoS Native Protection (Enterprise Edition) ID. - You can call the [DescInstanceList] API to query the DDoS Native Protection (Enterprise Edition) ID. - When
SecurityProtectionTypesis set toAntiDDoS_Enhanced, this parameter is required. - Security
Protection List<string>Types Security protection type for public IP. - Parameter - N: Indicates the sequence number of the security protection type. Currently, only 1 is supported. - Values: - AntiDDoS_Enhanced: Apply for a public IP with enhanced protection, which can be added to a DDoS native protection (Enterprise Edition) instance.
Note: - If
EipAddress.SecurityProtectionTypes.Nis set toAntiDDoS_Enhanced,EipAddress.ChargeTypecannot bePrePaid, andEipAddress.ISPmust be set toBGP. - Enhanced protection public IP is in invitation-only testing. To try it, contact your account manager.- If not specified, the default protection type public IP will be applied.
- Bandwidth
Mbps int - The maximum bandwidth for the public IP address. Default value: 1. Unit: Mbps. - When
ChargeTypeis set toPayByBandwidth: valid range is 1–500. - WhenChargeTypeis set toPayByTraffic: valid range is 1–200. - Bandwidth
Package stringId - ID of the shared bandwidth package, indicating that the public IP will be added to the shared bandwidth package. - You can call the [DescribeBandwidthPackages] API to query the ID of the shared bandwidth package. - The following conditions must be met to add a public IP to a shared bandwidth package: - Both must have the same security protection type. - Both must be in the same region. - The billing method for the public IP must be pay-as-you-go. - The shared bandwidth package must be of IPv4 type.
- Charge
Type string - Public IP billing method. Options: - PayByBandwidth (default): Pay-as-you-go by bandwidth cap. - PayByTraffic: Pay-as-you-go by actual traffic. - PrePaid: Subscription.
Note: When the instance billing type
InstanceChargeTypeis set toPostPaid, this parameter cannot be set toPrePaid. - Isp string
- Public IP line type. Defaults to BGP. Options: - BGP: BGP (multi-line). - If your account has applied for and enabled static single-line permissions, you can use: - ChinaMobile: China Mobile static single-line. - ChinaTelecom: China Telecom static single-line. - ChinaUnicom: China Unicom static single-line. - If your account has applied for and enabled BGP single-line permissions, you can use SingleLine_BGP. - If your account has applied for and enabled static BGP permissions, you can use Static_BGP.
- Release
With boolInstance - Whether the public IP is released with the instance - true: The public IP is released with the instance - false (default): The public IP is not released with the instance
- Security
Protection intInstance Id - DDoS Native Protection (Enterprise Edition) ID. - You can call the [DescInstanceList] API to query the DDoS Native Protection (Enterprise Edition) ID. - When
SecurityProtectionTypesis set toAntiDDoS_Enhanced, this parameter is required. - Security
Protection []stringTypes Security protection type for public IP. - Parameter - N: Indicates the sequence number of the security protection type. Currently, only 1 is supported. - Values: - AntiDDoS_Enhanced: Apply for a public IP with enhanced protection, which can be added to a DDoS native protection (Enterprise Edition) instance.
Note: - If
EipAddress.SecurityProtectionTypes.Nis set toAntiDDoS_Enhanced,EipAddress.ChargeTypecannot bePrePaid, andEipAddress.ISPmust be set toBGP. - Enhanced protection public IP is in invitation-only testing. To try it, contact your account manager.- If not specified, the default protection type public IP will be applied.
- bandwidth_
mbps number - The maximum bandwidth for the public IP address. Default value: 1. Unit: Mbps. - When
ChargeTypeis set toPayByBandwidth: valid range is 1–500. - WhenChargeTypeis set toPayByTraffic: valid range is 1–200. - bandwidth_
package_ stringid - ID of the shared bandwidth package, indicating that the public IP will be added to the shared bandwidth package. - You can call the [DescribeBandwidthPackages] API to query the ID of the shared bandwidth package. - The following conditions must be met to add a public IP to a shared bandwidth package: - Both must have the same security protection type. - Both must be in the same region. - The billing method for the public IP must be pay-as-you-go. - The shared bandwidth package must be of IPv4 type.
- charge_
type string - Public IP billing method. Options: - PayByBandwidth (default): Pay-as-you-go by bandwidth cap. - PayByTraffic: Pay-as-you-go by actual traffic. - PrePaid: Subscription.
Note: When the instance billing type
InstanceChargeTypeis set toPostPaid, this parameter cannot be set toPrePaid. - isp string
- Public IP line type. Defaults to BGP. Options: - BGP: BGP (multi-line). - If your account has applied for and enabled static single-line permissions, you can use: - ChinaMobile: China Mobile static single-line. - ChinaTelecom: China Telecom static single-line. - ChinaUnicom: China Unicom static single-line. - If your account has applied for and enabled BGP single-line permissions, you can use SingleLine_BGP. - If your account has applied for and enabled static BGP permissions, you can use Static_BGP.
- release_
with_ boolinstance - Whether the public IP is released with the instance - true: The public IP is released with the instance - false (default): The public IP is not released with the instance
- security_
protection_ numberinstance_ id - DDoS Native Protection (Enterprise Edition) ID. - You can call the [DescInstanceList] API to query the DDoS Native Protection (Enterprise Edition) ID. - When
SecurityProtectionTypesis set toAntiDDoS_Enhanced, this parameter is required. - security_
protection_ list(string)types Security protection type for public IP. - Parameter - N: Indicates the sequence number of the security protection type. Currently, only 1 is supported. - Values: - AntiDDoS_Enhanced: Apply for a public IP with enhanced protection, which can be added to a DDoS native protection (Enterprise Edition) instance.
Note: - If
EipAddress.SecurityProtectionTypes.Nis set toAntiDDoS_Enhanced,EipAddress.ChargeTypecannot bePrePaid, andEipAddress.ISPmust be set toBGP. - Enhanced protection public IP is in invitation-only testing. To try it, contact your account manager.- If not specified, the default protection type public IP will be applied.
- bandwidth
Mbps Integer - The maximum bandwidth for the public IP address. Default value: 1. Unit: Mbps. - When
ChargeTypeis set toPayByBandwidth: valid range is 1–500. - WhenChargeTypeis set toPayByTraffic: valid range is 1–200. - bandwidth
Package StringId - ID of the shared bandwidth package, indicating that the public IP will be added to the shared bandwidth package. - You can call the [DescribeBandwidthPackages] API to query the ID of the shared bandwidth package. - The following conditions must be met to add a public IP to a shared bandwidth package: - Both must have the same security protection type. - Both must be in the same region. - The billing method for the public IP must be pay-as-you-go. - The shared bandwidth package must be of IPv4 type.
- charge
Type String - Public IP billing method. Options: - PayByBandwidth (default): Pay-as-you-go by bandwidth cap. - PayByTraffic: Pay-as-you-go by actual traffic. - PrePaid: Subscription.
Note: When the instance billing type
InstanceChargeTypeis set toPostPaid, this parameter cannot be set toPrePaid. - isp String
- Public IP line type. Defaults to BGP. Options: - BGP: BGP (multi-line). - If your account has applied for and enabled static single-line permissions, you can use: - ChinaMobile: China Mobile static single-line. - ChinaTelecom: China Telecom static single-line. - ChinaUnicom: China Unicom static single-line. - If your account has applied for and enabled BGP single-line permissions, you can use SingleLine_BGP. - If your account has applied for and enabled static BGP permissions, you can use Static_BGP.
- release
With BooleanInstance - Whether the public IP is released with the instance - true: The public IP is released with the instance - false (default): The public IP is not released with the instance
- security
Protection IntegerInstance Id - DDoS Native Protection (Enterprise Edition) ID. - You can call the [DescInstanceList] API to query the DDoS Native Protection (Enterprise Edition) ID. - When
SecurityProtectionTypesis set toAntiDDoS_Enhanced, this parameter is required. - security
Protection List<String>Types Security protection type for public IP. - Parameter - N: Indicates the sequence number of the security protection type. Currently, only 1 is supported. - Values: - AntiDDoS_Enhanced: Apply for a public IP with enhanced protection, which can be added to a DDoS native protection (Enterprise Edition) instance.
Note: - If
EipAddress.SecurityProtectionTypes.Nis set toAntiDDoS_Enhanced,EipAddress.ChargeTypecannot bePrePaid, andEipAddress.ISPmust be set toBGP. - Enhanced protection public IP is in invitation-only testing. To try it, contact your account manager.- If not specified, the default protection type public IP will be applied.
- bandwidth
Mbps number - The maximum bandwidth for the public IP address. Default value: 1. Unit: Mbps. - When
ChargeTypeis set toPayByBandwidth: valid range is 1–500. - WhenChargeTypeis set toPayByTraffic: valid range is 1–200. - bandwidth
Package stringId - ID of the shared bandwidth package, indicating that the public IP will be added to the shared bandwidth package. - You can call the [DescribeBandwidthPackages] API to query the ID of the shared bandwidth package. - The following conditions must be met to add a public IP to a shared bandwidth package: - Both must have the same security protection type. - Both must be in the same region. - The billing method for the public IP must be pay-as-you-go. - The shared bandwidth package must be of IPv4 type.
- charge
Type string - Public IP billing method. Options: - PayByBandwidth (default): Pay-as-you-go by bandwidth cap. - PayByTraffic: Pay-as-you-go by actual traffic. - PrePaid: Subscription.
Note: When the instance billing type
InstanceChargeTypeis set toPostPaid, this parameter cannot be set toPrePaid. - isp string
- Public IP line type. Defaults to BGP. Options: - BGP: BGP (multi-line). - If your account has applied for and enabled static single-line permissions, you can use: - ChinaMobile: China Mobile static single-line. - ChinaTelecom: China Telecom static single-line. - ChinaUnicom: China Unicom static single-line. - If your account has applied for and enabled BGP single-line permissions, you can use SingleLine_BGP. - If your account has applied for and enabled static BGP permissions, you can use Static_BGP.
- release
With booleanInstance - Whether the public IP is released with the instance - true: The public IP is released with the instance - false (default): The public IP is not released with the instance
- security
Protection numberInstance Id - DDoS Native Protection (Enterprise Edition) ID. - You can call the [DescInstanceList] API to query the DDoS Native Protection (Enterprise Edition) ID. - When
SecurityProtectionTypesis set toAntiDDoS_Enhanced, this parameter is required. - security
Protection string[]Types Security protection type for public IP. - Parameter - N: Indicates the sequence number of the security protection type. Currently, only 1 is supported. - Values: - AntiDDoS_Enhanced: Apply for a public IP with enhanced protection, which can be added to a DDoS native protection (Enterprise Edition) instance.
Note: - If
EipAddress.SecurityProtectionTypes.Nis set toAntiDDoS_Enhanced,EipAddress.ChargeTypecannot bePrePaid, andEipAddress.ISPmust be set toBGP. - Enhanced protection public IP is in invitation-only testing. To try it, contact your account manager.- If not specified, the default protection type public IP will be applied.
- bandwidth_
mbps int - The maximum bandwidth for the public IP address. Default value: 1. Unit: Mbps. - When
ChargeTypeis set toPayByBandwidth: valid range is 1–500. - WhenChargeTypeis set toPayByTraffic: valid range is 1–200. - bandwidth_
package_ strid - ID of the shared bandwidth package, indicating that the public IP will be added to the shared bandwidth package. - You can call the [DescribeBandwidthPackages] API to query the ID of the shared bandwidth package. - The following conditions must be met to add a public IP to a shared bandwidth package: - Both must have the same security protection type. - Both must be in the same region. - The billing method for the public IP must be pay-as-you-go. - The shared bandwidth package must be of IPv4 type.
- charge_
type str - Public IP billing method. Options: - PayByBandwidth (default): Pay-as-you-go by bandwidth cap. - PayByTraffic: Pay-as-you-go by actual traffic. - PrePaid: Subscription.
Note: When the instance billing type
InstanceChargeTypeis set toPostPaid, this parameter cannot be set toPrePaid. - isp str
- Public IP line type. Defaults to BGP. Options: - BGP: BGP (multi-line). - If your account has applied for and enabled static single-line permissions, you can use: - ChinaMobile: China Mobile static single-line. - ChinaTelecom: China Telecom static single-line. - ChinaUnicom: China Unicom static single-line. - If your account has applied for and enabled BGP single-line permissions, you can use SingleLine_BGP. - If your account has applied for and enabled static BGP permissions, you can use Static_BGP.
- release_
with_ boolinstance - Whether the public IP is released with the instance - true: The public IP is released with the instance - false (default): The public IP is not released with the instance
- security_
protection_ intinstance_ id - DDoS Native Protection (Enterprise Edition) ID. - You can call the [DescInstanceList] API to query the DDoS Native Protection (Enterprise Edition) ID. - When
SecurityProtectionTypesis set toAntiDDoS_Enhanced, this parameter is required. - security_
protection_ Sequence[str]types Security protection type for public IP. - Parameter - N: Indicates the sequence number of the security protection type. Currently, only 1 is supported. - Values: - AntiDDoS_Enhanced: Apply for a public IP with enhanced protection, which can be added to a DDoS native protection (Enterprise Edition) instance.
Note: - If
EipAddress.SecurityProtectionTypes.Nis set toAntiDDoS_Enhanced,EipAddress.ChargeTypecannot bePrePaid, andEipAddress.ISPmust be set toBGP. - Enhanced protection public IP is in invitation-only testing. To try it, contact your account manager.- If not specified, the default protection type public IP will be applied.
- bandwidth
Mbps Number - The maximum bandwidth for the public IP address. Default value: 1. Unit: Mbps. - When
ChargeTypeis set toPayByBandwidth: valid range is 1–500. - WhenChargeTypeis set toPayByTraffic: valid range is 1–200. - bandwidth
Package StringId - ID of the shared bandwidth package, indicating that the public IP will be added to the shared bandwidth package. - You can call the [DescribeBandwidthPackages] API to query the ID of the shared bandwidth package. - The following conditions must be met to add a public IP to a shared bandwidth package: - Both must have the same security protection type. - Both must be in the same region. - The billing method for the public IP must be pay-as-you-go. - The shared bandwidth package must be of IPv4 type.
- charge
Type String - Public IP billing method. Options: - PayByBandwidth (default): Pay-as-you-go by bandwidth cap. - PayByTraffic: Pay-as-you-go by actual traffic. - PrePaid: Subscription.
Note: When the instance billing type
InstanceChargeTypeis set toPostPaid, this parameter cannot be set toPrePaid. - isp String
- Public IP line type. Defaults to BGP. Options: - BGP: BGP (multi-line). - If your account has applied for and enabled static single-line permissions, you can use: - ChinaMobile: China Mobile static single-line. - ChinaTelecom: China Telecom static single-line. - ChinaUnicom: China Unicom static single-line. - If your account has applied for and enabled BGP single-line permissions, you can use SingleLine_BGP. - If your account has applied for and enabled static BGP permissions, you can use Static_BGP.
- release
With BooleanInstance - Whether the public IP is released with the instance - true: The public IP is released with the instance - false (default): The public IP is not released with the instance
- security
Protection NumberInstance Id - DDoS Native Protection (Enterprise Edition) ID. - You can call the [DescInstanceList] API to query the DDoS Native Protection (Enterprise Edition) ID. - When
SecurityProtectionTypesis set toAntiDDoS_Enhanced, this parameter is required. - security
Protection List<String>Types Security protection type for public IP. - Parameter - N: Indicates the sequence number of the security protection type. Currently, only 1 is supported. - Values: - AntiDDoS_Enhanced: Apply for a public IP with enhanced protection, which can be added to a DDoS native protection (Enterprise Edition) instance.
Note: - If
EipAddress.SecurityProtectionTypes.Nis set toAntiDDoS_Enhanced,EipAddress.ChargeTypecannot bePrePaid, andEipAddress.ISPmust be set toBGP. - Enhanced protection public IP is in invitation-only testing. To try it, contact your account manager.- If not specified, the default protection type public IP will be applied.
ScheduledInstanceInstanceConfig, ScheduledInstanceInstanceConfigArgs
- Description string
- Description of the instance.
- Eip
Address Volcengine.Scheduled Instance Instance Config Eip Address - Public IP information bound to the instance.
- Host
Name string - Instance hostname.
- Hpc
Cluster stringId - High performance computing cluster ID.
- Image
Id string - Image ID
- Instance
Name string - Instance name.
- Instance
Type stringId - Instance type.
- Key
Pair stringName - Key pair name.
- Network
Interfaces List<Volcengine.Scheduled Instance Instance Config Network Interface> - Network interface information attached to the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Project
Name string - Project to which the instance belongs.
-
List<Volcengine.
Scheduled Instance Instance Config Tag> - Tag information for the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Volumes
List<Volcengine.
Scheduled Instance Instance Config Volume> - Information about the cloud disks attached to the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Zone
Id string - Availability zone ID where the elastic reservation order is located.
- Description string
- Description of the instance.
- Eip
Address ScheduledInstance Instance Config Eip Address - Public IP information bound to the instance.
- Host
Name string - Instance hostname.
- Hpc
Cluster stringId - High performance computing cluster ID.
- Image
Id string - Image ID
- Instance
Name string - Instance name.
- Instance
Type stringId - Instance type.
- Key
Pair stringName - Key pair name.
- Network
Interfaces []ScheduledInstance Instance Config Network Interface - Network interface information attached to the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Project
Name string - Project to which the instance belongs.
-
[]Scheduled
Instance Instance Config Tag - Tag information for the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Volumes
[]Scheduled
Instance Instance Config Volume - Information about the cloud disks attached to the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Zone
Id string - Availability zone ID where the elastic reservation order is located.
- description string
- Description of the instance.
- eip_
address object - Public IP information bound to the instance.
- host_
name string - Instance hostname.
- hpc_
cluster_ stringid - High performance computing cluster ID.
- image_
id string - Image ID
- instance_
name string - Instance name.
- instance_
type_ stringid - Instance type.
- key_
pair_ stringname - Key pair name.
- network_
interfaces list(object) - Network interface information attached to the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- project_
name string - Project to which the instance belongs.
- list(object)
- Tag information for the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- volumes list(object)
- Information about the cloud disks attached to the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- zone_
id string - Availability zone ID where the elastic reservation order is located.
- description String
- Description of the instance.
- eip
Address ScheduledInstance Instance Config Eip Address - Public IP information bound to the instance.
- host
Name String - Instance hostname.
- hpc
Cluster StringId - High performance computing cluster ID.
- image
Id String - Image ID
- instance
Name String - Instance name.
- instance
Type StringId - Instance type.
- key
Pair StringName - Key pair name.
- network
Interfaces List<ScheduledInstance Instance Config Network Interface> - Network interface information attached to the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- project
Name String - Project to which the instance belongs.
-
List<Scheduled
Instance Instance Config Tag> - Tag information for the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- volumes
List<Scheduled
Instance Instance Config Volume> - Information about the cloud disks attached to the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- zone
Id String - Availability zone ID where the elastic reservation order is located.
- description string
- Description of the instance.
- eip
Address ScheduledInstance Instance Config Eip Address - Public IP information bound to the instance.
- host
Name string - Instance hostname.
- hpc
Cluster stringId - High performance computing cluster ID.
- image
Id string - Image ID
- instance
Name string - Instance name.
- instance
Type stringId - Instance type.
- key
Pair stringName - Key pair name.
- network
Interfaces ScheduledInstance Instance Config Network Interface[] - Network interface information attached to the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- project
Name string - Project to which the instance belongs.
-
Scheduled
Instance Instance Config Tag[] - Tag information for the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- volumes
Scheduled
Instance Instance Config Volume[] - Information about the cloud disks attached to the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- zone
Id string - Availability zone ID where the elastic reservation order is located.
- description str
- Description of the instance.
- eip_
address ScheduledInstance Instance Config Eip Address - Public IP information bound to the instance.
- host_
name str - Instance hostname.
- hpc_
cluster_ strid - High performance computing cluster ID.
- image_
id str - Image ID
- instance_
name str - Instance name.
- instance_
type_ strid - Instance type.
- key_
pair_ strname - Key pair name.
- network_
interfaces Sequence[ScheduledInstance Instance Config Network Interface] - Network interface information attached to the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- project_
name str - Project to which the instance belongs.
-
Sequence[Scheduled
Instance Instance Config Tag] - Tag information for the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- volumes
Sequence[Scheduled
Instance Instance Config Volume] - Information about the cloud disks attached to the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- zone_
id str - Availability zone ID where the elastic reservation order is located.
- description String
- Description of the instance.
- eip
Address Property Map - Public IP information bound to the instance.
- host
Name String - Instance hostname.
- hpc
Cluster StringId - High performance computing cluster ID.
- image
Id String - Image ID
- instance
Name String - Instance name.
- instance
Type StringId - Instance type.
- key
Pair StringName - Key pair name.
- network
Interfaces List<Property Map> - Network interface information attached to the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- project
Name String - Project to which the instance belongs.
- List<Property Map>
- Tag information for the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- volumes List<Property Map>
- Information about the cloud disks attached to the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- zone
Id String - Availability zone ID where the elastic reservation order is located.
ScheduledInstanceInstanceConfigEipAddress, ScheduledInstanceInstanceConfigEipAddressArgs
- Bandwidth
Mbps int - Maximum bandwidth for the public IP, in Mbps
- Default: 1
- Value range:
- If
ChargeTypeisPayByBandwidth: 1–500 - IfChargeTypeisPayByTraffic: 1–200 - Bandwidth
Package stringId - Shared bandwidth package ID.
- Charge
Type string - Billing method for public IP. Values: - PayByBandwidth (default): Pay-as-you-go by bandwidth cap - PayByTraffic: Pay-as-you-go by actual traffic - PrePaid: Subscription
- Isp string
- Line type. Values: - BGP (default): BGP (multi-line). - If your account has applied for and enabled static single-line permissions, you can use the following values: - ChinaMobile: China Mobile static single line. - ChinaTelecom: China Telecom static single line. - ChinaUnicom: China Unicom static single line. - If your account has applied for and enabled BGP single-line permissions, you can use SingleLine_BGP. - If your account has applied for and enabled static BGP permissions, you can use Static_BGP.
- Release
With boolInstance - Whether the public IP is released with the instance. Only applies to pay-as-you-go public IPs. Options: - true: Public IP is released with the instance. When the instance is automatically reclaimed by the system (24 hours after unsubscribe, expiration, etc.) or deleted via [DeleteInstance] or [DeleteInstances] API, the public IP is released together with the instance. - false: Public IP is not released with the instance.
- Security
Protection stringInstance Id - ID of the bound security protection package. This parameter is returned only when
SecurityProtectionTypesis not empty. - Security
Protection List<string>Types - Security protection type for public IP. - AntiDDoS_Enhanced: Public IP with enhanced protection (can be added to DDoS Native Protection (Enterprise Edition) instance). - Null: Public IP with basic protection.
- Bandwidth
Mbps int - Maximum bandwidth for the public IP, in Mbps
- Default: 1
- Value range:
- If
ChargeTypeisPayByBandwidth: 1–500 - IfChargeTypeisPayByTraffic: 1–200 - Bandwidth
Package stringId - Shared bandwidth package ID.
- Charge
Type string - Billing method for public IP. Values: - PayByBandwidth (default): Pay-as-you-go by bandwidth cap - PayByTraffic: Pay-as-you-go by actual traffic - PrePaid: Subscription
- Isp string
- Line type. Values: - BGP (default): BGP (multi-line). - If your account has applied for and enabled static single-line permissions, you can use the following values: - ChinaMobile: China Mobile static single line. - ChinaTelecom: China Telecom static single line. - ChinaUnicom: China Unicom static single line. - If your account has applied for and enabled BGP single-line permissions, you can use SingleLine_BGP. - If your account has applied for and enabled static BGP permissions, you can use Static_BGP.
- Release
With boolInstance - Whether the public IP is released with the instance. Only applies to pay-as-you-go public IPs. Options: - true: Public IP is released with the instance. When the instance is automatically reclaimed by the system (24 hours after unsubscribe, expiration, etc.) or deleted via [DeleteInstance] or [DeleteInstances] API, the public IP is released together with the instance. - false: Public IP is not released with the instance.
- Security
Protection stringInstance Id - ID of the bound security protection package. This parameter is returned only when
SecurityProtectionTypesis not empty. - Security
Protection []stringTypes - Security protection type for public IP. - AntiDDoS_Enhanced: Public IP with enhanced protection (can be added to DDoS Native Protection (Enterprise Edition) instance). - Null: Public IP with basic protection.
- bandwidth_
mbps number - Maximum bandwidth for the public IP, in Mbps
- Default: 1
- Value range:
- If
ChargeTypeisPayByBandwidth: 1–500 - IfChargeTypeisPayByTraffic: 1–200 - bandwidth_
package_ stringid - Shared bandwidth package ID.
- charge_
type string - Billing method for public IP. Values: - PayByBandwidth (default): Pay-as-you-go by bandwidth cap - PayByTraffic: Pay-as-you-go by actual traffic - PrePaid: Subscription
- isp string
- Line type. Values: - BGP (default): BGP (multi-line). - If your account has applied for and enabled static single-line permissions, you can use the following values: - ChinaMobile: China Mobile static single line. - ChinaTelecom: China Telecom static single line. - ChinaUnicom: China Unicom static single line. - If your account has applied for and enabled BGP single-line permissions, you can use SingleLine_BGP. - If your account has applied for and enabled static BGP permissions, you can use Static_BGP.
- release_
with_ boolinstance - Whether the public IP is released with the instance. Only applies to pay-as-you-go public IPs. Options: - true: Public IP is released with the instance. When the instance is automatically reclaimed by the system (24 hours after unsubscribe, expiration, etc.) or deleted via [DeleteInstance] or [DeleteInstances] API, the public IP is released together with the instance. - false: Public IP is not released with the instance.
- security_
protection_ stringinstance_ id - ID of the bound security protection package. This parameter is returned only when
SecurityProtectionTypesis not empty. - security_
protection_ list(string)types - Security protection type for public IP. - AntiDDoS_Enhanced: Public IP with enhanced protection (can be added to DDoS Native Protection (Enterprise Edition) instance). - Null: Public IP with basic protection.
- bandwidth
Mbps Integer - Maximum bandwidth for the public IP, in Mbps
- Default: 1
- Value range:
- If
ChargeTypeisPayByBandwidth: 1–500 - IfChargeTypeisPayByTraffic: 1–200 - bandwidth
Package StringId - Shared bandwidth package ID.
- charge
Type String - Billing method for public IP. Values: - PayByBandwidth (default): Pay-as-you-go by bandwidth cap - PayByTraffic: Pay-as-you-go by actual traffic - PrePaid: Subscription
- isp String
- Line type. Values: - BGP (default): BGP (multi-line). - If your account has applied for and enabled static single-line permissions, you can use the following values: - ChinaMobile: China Mobile static single line. - ChinaTelecom: China Telecom static single line. - ChinaUnicom: China Unicom static single line. - If your account has applied for and enabled BGP single-line permissions, you can use SingleLine_BGP. - If your account has applied for and enabled static BGP permissions, you can use Static_BGP.
- release
With BooleanInstance - Whether the public IP is released with the instance. Only applies to pay-as-you-go public IPs. Options: - true: Public IP is released with the instance. When the instance is automatically reclaimed by the system (24 hours after unsubscribe, expiration, etc.) or deleted via [DeleteInstance] or [DeleteInstances] API, the public IP is released together with the instance. - false: Public IP is not released with the instance.
- security
Protection StringInstance Id - ID of the bound security protection package. This parameter is returned only when
SecurityProtectionTypesis not empty. - security
Protection List<String>Types - Security protection type for public IP. - AntiDDoS_Enhanced: Public IP with enhanced protection (can be added to DDoS Native Protection (Enterprise Edition) instance). - Null: Public IP with basic protection.
- bandwidth
Mbps number - Maximum bandwidth for the public IP, in Mbps
- Default: 1
- Value range:
- If
ChargeTypeisPayByBandwidth: 1–500 - IfChargeTypeisPayByTraffic: 1–200 - bandwidth
Package stringId - Shared bandwidth package ID.
- charge
Type string - Billing method for public IP. Values: - PayByBandwidth (default): Pay-as-you-go by bandwidth cap - PayByTraffic: Pay-as-you-go by actual traffic - PrePaid: Subscription
- isp string
- Line type. Values: - BGP (default): BGP (multi-line). - If your account has applied for and enabled static single-line permissions, you can use the following values: - ChinaMobile: China Mobile static single line. - ChinaTelecom: China Telecom static single line. - ChinaUnicom: China Unicom static single line. - If your account has applied for and enabled BGP single-line permissions, you can use SingleLine_BGP. - If your account has applied for and enabled static BGP permissions, you can use Static_BGP.
- release
With booleanInstance - Whether the public IP is released with the instance. Only applies to pay-as-you-go public IPs. Options: - true: Public IP is released with the instance. When the instance is automatically reclaimed by the system (24 hours after unsubscribe, expiration, etc.) or deleted via [DeleteInstance] or [DeleteInstances] API, the public IP is released together with the instance. - false: Public IP is not released with the instance.
- security
Protection stringInstance Id - ID of the bound security protection package. This parameter is returned only when
SecurityProtectionTypesis not empty. - security
Protection string[]Types - Security protection type for public IP. - AntiDDoS_Enhanced: Public IP with enhanced protection (can be added to DDoS Native Protection (Enterprise Edition) instance). - Null: Public IP with basic protection.
- bandwidth_
mbps int - Maximum bandwidth for the public IP, in Mbps
- Default: 1
- Value range:
- If
ChargeTypeisPayByBandwidth: 1–500 - IfChargeTypeisPayByTraffic: 1–200 - bandwidth_
package_ strid - Shared bandwidth package ID.
- charge_
type str - Billing method for public IP. Values: - PayByBandwidth (default): Pay-as-you-go by bandwidth cap - PayByTraffic: Pay-as-you-go by actual traffic - PrePaid: Subscription
- isp str
- Line type. Values: - BGP (default): BGP (multi-line). - If your account has applied for and enabled static single-line permissions, you can use the following values: - ChinaMobile: China Mobile static single line. - ChinaTelecom: China Telecom static single line. - ChinaUnicom: China Unicom static single line. - If your account has applied for and enabled BGP single-line permissions, you can use SingleLine_BGP. - If your account has applied for and enabled static BGP permissions, you can use Static_BGP.
- release_
with_ boolinstance - Whether the public IP is released with the instance. Only applies to pay-as-you-go public IPs. Options: - true: Public IP is released with the instance. When the instance is automatically reclaimed by the system (24 hours after unsubscribe, expiration, etc.) or deleted via [DeleteInstance] or [DeleteInstances] API, the public IP is released together with the instance. - false: Public IP is not released with the instance.
- security_
protection_ strinstance_ id - ID of the bound security protection package. This parameter is returned only when
SecurityProtectionTypesis not empty. - security_
protection_ Sequence[str]types - Security protection type for public IP. - AntiDDoS_Enhanced: Public IP with enhanced protection (can be added to DDoS Native Protection (Enterprise Edition) instance). - Null: Public IP with basic protection.
- bandwidth
Mbps Number - Maximum bandwidth for the public IP, in Mbps
- Default: 1
- Value range:
- If
ChargeTypeisPayByBandwidth: 1–500 - IfChargeTypeisPayByTraffic: 1–200 - bandwidth
Package StringId - Shared bandwidth package ID.
- charge
Type String - Billing method for public IP. Values: - PayByBandwidth (default): Pay-as-you-go by bandwidth cap - PayByTraffic: Pay-as-you-go by actual traffic - PrePaid: Subscription
- isp String
- Line type. Values: - BGP (default): BGP (multi-line). - If your account has applied for and enabled static single-line permissions, you can use the following values: - ChinaMobile: China Mobile static single line. - ChinaTelecom: China Telecom static single line. - ChinaUnicom: China Unicom static single line. - If your account has applied for and enabled BGP single-line permissions, you can use SingleLine_BGP. - If your account has applied for and enabled static BGP permissions, you can use Static_BGP.
- release
With BooleanInstance - Whether the public IP is released with the instance. Only applies to pay-as-you-go public IPs. Options: - true: Public IP is released with the instance. When the instance is automatically reclaimed by the system (24 hours after unsubscribe, expiration, etc.) or deleted via [DeleteInstance] or [DeleteInstances] API, the public IP is released together with the instance. - false: Public IP is not released with the instance.
- security
Protection StringInstance Id - ID of the bound security protection package. This parameter is returned only when
SecurityProtectionTypesis not empty. - security
Protection List<String>Types - Security protection type for public IP. - AntiDDoS_Enhanced: Public IP with enhanced protection (can be added to DDoS Native Protection (Enterprise Edition) instance). - Null: Public IP with basic protection.
ScheduledInstanceInstanceConfigNetworkInterface, ScheduledInstanceInstanceConfigNetworkInterfaceArgs
- Security
Group List<string>Ids - Security group ID associated with the network interface.
- Subnet
Id string - Private network subnet ID of the instance.
- Security
Group []stringIds - Security group ID associated with the network interface.
- Subnet
Id string - Private network subnet ID of the instance.
- security_
group_ list(string)ids - Security group ID associated with the network interface.
- subnet_
id string - Private network subnet ID of the instance.
- security
Group List<String>Ids - Security group ID associated with the network interface.
- subnet
Id String - Private network subnet ID of the instance.
- security
Group string[]Ids - Security group ID associated with the network interface.
- subnet
Id string - Private network subnet ID of the instance.
- security_
group_ Sequence[str]ids - Security group ID associated with the network interface.
- subnet_
id str - Private network subnet ID of the instance.
- security
Group List<String>Ids - Security group ID associated with the network interface.
- subnet
Id String - Private network subnet ID of the instance.
ScheduledInstanceInstanceConfigTag, ScheduledInstanceInstanceConfigTagArgs
ScheduledInstanceInstanceConfigVolume, ScheduledInstanceInstanceConfigVolumeArgs
- Kind string
- Disk type. Values: - system: System disk - data: Data disk
- Size int
- Cloud disk capacity, in GiB.
- Volume
Type string - Cloud disk type. Values: - ESSD_PL0: Ultra-fast SSD PL0 - ESSD_FlexPL: Ultra-fast SSD FlexPL
- Kind string
- Disk type. Values: - system: System disk - data: Data disk
- Size int
- Cloud disk capacity, in GiB.
- Volume
Type string - Cloud disk type. Values: - ESSD_PL0: Ultra-fast SSD PL0 - ESSD_FlexPL: Ultra-fast SSD FlexPL
- kind string
- Disk type. Values: - system: System disk - data: Data disk
- size number
- Cloud disk capacity, in GiB.
- volume_
type string - Cloud disk type. Values: - ESSD_PL0: Ultra-fast SSD PL0 - ESSD_FlexPL: Ultra-fast SSD FlexPL
- kind String
- Disk type. Values: - system: System disk - data: Data disk
- size Integer
- Cloud disk capacity, in GiB.
- volume
Type String - Cloud disk type. Values: - ESSD_PL0: Ultra-fast SSD PL0 - ESSD_FlexPL: Ultra-fast SSD FlexPL
- kind string
- Disk type. Values: - system: System disk - data: Data disk
- size number
- Cloud disk capacity, in GiB.
- volume
Type string - Cloud disk type. Values: - ESSD_PL0: Ultra-fast SSD PL0 - ESSD_FlexPL: Ultra-fast SSD FlexPL
- kind str
- Disk type. Values: - system: System disk - data: Data disk
- size int
- Cloud disk capacity, in GiB.
- volume_
type str - Cloud disk type. Values: - ESSD_PL0: Ultra-fast SSD PL0 - ESSD_FlexPL: Ultra-fast SSD FlexPL
- kind String
- Disk type. Values: - system: System disk - data: Data disk
- size Number
- Cloud disk capacity, in GiB.
- volume
Type String - Cloud disk type. Values: - ESSD_PL0: Ultra-fast SSD PL0 - ESSD_FlexPL: Ultra-fast SSD FlexPL
ScheduledInstanceNetworkInterface, ScheduledInstanceNetworkInterfaceArgs
- Primary
Ip stringAddress - Specify the primary IP address of the NIC. Currently, only one primary IP address can be specified for either the primary or auxiliary NIC. - Parameter - N: indicates the NIC index, N = 1 means primary NIC; N ≥ 2 means auxiliary NIC. - Separate multiple NICs with &.
- Private
Ip List<string>Addresses - Specify the secondary IP address of the primary network interface. Currently, only the primary network interface supports specifying secondary IPs. - The first N: Indicates the sequence number of the primary network interface. Only one primary network interface can be bound. - The second N: Indicates the sequence number of the secondary IP on the primary network interface. The maximum number of assignable secondary IP addresses is the number of private IPs per single network interface for this [instance type] minus one primary private IP. - Separate multiple secondary IPs with &.
- Security
Group List<string>Ids - Security group ID associated with the network interface. - The first N: Indicates the sequence number of the network interface, N = 1 is the primary network interface; N ≥ 2 is a secondary network interface. - The second N: Indicates the sequence number of the security group associated with the network interface, value range: 1–5. - Use & to separate multiple security group IDs.
- Subnet
Id string - Private network subnet ID of the instance. When creating an instance, you can bind auxiliary NICs at the same time. - Parameter - N: indicates the NIC index, N = 1 means primary NIC; N ≥ 2 means auxiliary NIC. - Separate multiple private network subnet IDs with &.
- Vpc
Id string - Private network
- Primary
Ip stringAddress - Specify the primary IP address of the NIC. Currently, only one primary IP address can be specified for either the primary or auxiliary NIC. - Parameter - N: indicates the NIC index, N = 1 means primary NIC; N ≥ 2 means auxiliary NIC. - Separate multiple NICs with &.
- Private
Ip []stringAddresses - Specify the secondary IP address of the primary network interface. Currently, only the primary network interface supports specifying secondary IPs. - The first N: Indicates the sequence number of the primary network interface. Only one primary network interface can be bound. - The second N: Indicates the sequence number of the secondary IP on the primary network interface. The maximum number of assignable secondary IP addresses is the number of private IPs per single network interface for this [instance type] minus one primary private IP. - Separate multiple secondary IPs with &.
- Security
Group []stringIds - Security group ID associated with the network interface. - The first N: Indicates the sequence number of the network interface, N = 1 is the primary network interface; N ≥ 2 is a secondary network interface. - The second N: Indicates the sequence number of the security group associated with the network interface, value range: 1–5. - Use & to separate multiple security group IDs.
- Subnet
Id string - Private network subnet ID of the instance. When creating an instance, you can bind auxiliary NICs at the same time. - Parameter - N: indicates the NIC index, N = 1 means primary NIC; N ≥ 2 means auxiliary NIC. - Separate multiple private network subnet IDs with &.
- Vpc
Id string - Private network
- primary_
ip_ stringaddress - Specify the primary IP address of the NIC. Currently, only one primary IP address can be specified for either the primary or auxiliary NIC. - Parameter - N: indicates the NIC index, N = 1 means primary NIC; N ≥ 2 means auxiliary NIC. - Separate multiple NICs with &.
- private_
ip_ list(string)addresses - Specify the secondary IP address of the primary network interface. Currently, only the primary network interface supports specifying secondary IPs. - The first N: Indicates the sequence number of the primary network interface. Only one primary network interface can be bound. - The second N: Indicates the sequence number of the secondary IP on the primary network interface. The maximum number of assignable secondary IP addresses is the number of private IPs per single network interface for this [instance type] minus one primary private IP. - Separate multiple secondary IPs with &.
- security_
group_ list(string)ids - Security group ID associated with the network interface. - The first N: Indicates the sequence number of the network interface, N = 1 is the primary network interface; N ≥ 2 is a secondary network interface. - The second N: Indicates the sequence number of the security group associated with the network interface, value range: 1–5. - Use & to separate multiple security group IDs.
- subnet_
id string - Private network subnet ID of the instance. When creating an instance, you can bind auxiliary NICs at the same time. - Parameter - N: indicates the NIC index, N = 1 means primary NIC; N ≥ 2 means auxiliary NIC. - Separate multiple private network subnet IDs with &.
- vpc_
id string - Private network
- primary
Ip StringAddress - Specify the primary IP address of the NIC. Currently, only one primary IP address can be specified for either the primary or auxiliary NIC. - Parameter - N: indicates the NIC index, N = 1 means primary NIC; N ≥ 2 means auxiliary NIC. - Separate multiple NICs with &.
- private
Ip List<String>Addresses - Specify the secondary IP address of the primary network interface. Currently, only the primary network interface supports specifying secondary IPs. - The first N: Indicates the sequence number of the primary network interface. Only one primary network interface can be bound. - The second N: Indicates the sequence number of the secondary IP on the primary network interface. The maximum number of assignable secondary IP addresses is the number of private IPs per single network interface for this [instance type] minus one primary private IP. - Separate multiple secondary IPs with &.
- security
Group List<String>Ids - Security group ID associated with the network interface. - The first N: Indicates the sequence number of the network interface, N = 1 is the primary network interface; N ≥ 2 is a secondary network interface. - The second N: Indicates the sequence number of the security group associated with the network interface, value range: 1–5. - Use & to separate multiple security group IDs.
- subnet
Id String - Private network subnet ID of the instance. When creating an instance, you can bind auxiliary NICs at the same time. - Parameter - N: indicates the NIC index, N = 1 means primary NIC; N ≥ 2 means auxiliary NIC. - Separate multiple private network subnet IDs with &.
- vpc
Id String - Private network
- primary
Ip stringAddress - Specify the primary IP address of the NIC. Currently, only one primary IP address can be specified for either the primary or auxiliary NIC. - Parameter - N: indicates the NIC index, N = 1 means primary NIC; N ≥ 2 means auxiliary NIC. - Separate multiple NICs with &.
- private
Ip string[]Addresses - Specify the secondary IP address of the primary network interface. Currently, only the primary network interface supports specifying secondary IPs. - The first N: Indicates the sequence number of the primary network interface. Only one primary network interface can be bound. - The second N: Indicates the sequence number of the secondary IP on the primary network interface. The maximum number of assignable secondary IP addresses is the number of private IPs per single network interface for this [instance type] minus one primary private IP. - Separate multiple secondary IPs with &.
- security
Group string[]Ids - Security group ID associated with the network interface. - The first N: Indicates the sequence number of the network interface, N = 1 is the primary network interface; N ≥ 2 is a secondary network interface. - The second N: Indicates the sequence number of the security group associated with the network interface, value range: 1–5. - Use & to separate multiple security group IDs.
- subnet
Id string - Private network subnet ID of the instance. When creating an instance, you can bind auxiliary NICs at the same time. - Parameter - N: indicates the NIC index, N = 1 means primary NIC; N ≥ 2 means auxiliary NIC. - Separate multiple private network subnet IDs with &.
- vpc
Id string - Private network
- primary_
ip_ straddress - Specify the primary IP address of the NIC. Currently, only one primary IP address can be specified for either the primary or auxiliary NIC. - Parameter - N: indicates the NIC index, N = 1 means primary NIC; N ≥ 2 means auxiliary NIC. - Separate multiple NICs with &.
- private_
ip_ Sequence[str]addresses - Specify the secondary IP address of the primary network interface. Currently, only the primary network interface supports specifying secondary IPs. - The first N: Indicates the sequence number of the primary network interface. Only one primary network interface can be bound. - The second N: Indicates the sequence number of the secondary IP on the primary network interface. The maximum number of assignable secondary IP addresses is the number of private IPs per single network interface for this [instance type] minus one primary private IP. - Separate multiple secondary IPs with &.
- security_
group_ Sequence[str]ids - Security group ID associated with the network interface. - The first N: Indicates the sequence number of the network interface, N = 1 is the primary network interface; N ≥ 2 is a secondary network interface. - The second N: Indicates the sequence number of the security group associated with the network interface, value range: 1–5. - Use & to separate multiple security group IDs.
- subnet_
id str - Private network subnet ID of the instance. When creating an instance, you can bind auxiliary NICs at the same time. - Parameter - N: indicates the NIC index, N = 1 means primary NIC; N ≥ 2 means auxiliary NIC. - Separate multiple private network subnet IDs with &.
- vpc_
id str - Private network
- primary
Ip StringAddress - Specify the primary IP address of the NIC. Currently, only one primary IP address can be specified for either the primary or auxiliary NIC. - Parameter - N: indicates the NIC index, N = 1 means primary NIC; N ≥ 2 means auxiliary NIC. - Separate multiple NICs with &.
- private
Ip List<String>Addresses - Specify the secondary IP address of the primary network interface. Currently, only the primary network interface supports specifying secondary IPs. - The first N: Indicates the sequence number of the primary network interface. Only one primary network interface can be bound. - The second N: Indicates the sequence number of the secondary IP on the primary network interface. The maximum number of assignable secondary IP addresses is the number of private IPs per single network interface for this [instance type] minus one primary private IP. - Separate multiple secondary IPs with &.
- security
Group List<String>Ids - Security group ID associated with the network interface. - The first N: Indicates the sequence number of the network interface, N = 1 is the primary network interface; N ≥ 2 is a secondary network interface. - The second N: Indicates the sequence number of the security group associated with the network interface, value range: 1–5. - Use & to separate multiple security group IDs.
- subnet
Id String - Private network subnet ID of the instance. When creating an instance, you can bind auxiliary NICs at the same time. - Parameter - N: indicates the NIC index, N = 1 means primary NIC; N ≥ 2 means auxiliary NIC. - Separate multiple private network subnet IDs with &.
- vpc
Id String - Private network
ScheduledInstanceTag, ScheduledInstanceTagArgs
ScheduledInstanceVolume, ScheduledInstanceVolumeArgs
- Delete
With boolInstance - Whether the cloud disk is released with the instance. Values: - true (default): The cloud disk is released with the instance. - false: The cloud disk is not released with the instance. Note: - Parameter - N: Indicates the sequence number of the cloud disk, value range: 1–16. N = 1 indicates the system disk, which is released with the instance by default and cannot be retained; N ≥ 2 indicates a data disk, which can be optionally released with the instance. - Separate multiple cloud disks with &.
- Extra
Performance intIops Extra IOPS performance size for the cloud disk, supported only by ESSD FlexPL data disks, measured in operations/second. This parameter must be set when
ExtraPerformanceTypeIdisBalanceorIOPS. The value ranges for each type are as follows: - IOPS type: 1–50000 - Balance type: 1–50000Note: - Parameter - N: Indicates the sequence number of the cloud disk, value range: 1–16. N = 1 indicates the system disk, so when N is 1, this parameter is ignored. N ≥ 2 indicates a data disk, and this parameter can be set normally. - Use & to separate multiple cloud disks.
- Extra
Performance intThroughput Mb - Extra disk throughput performance in MB/s. Supported only by ESSD FlexPL data disks. Set this parameter when
ExtraPerformanceTypeIdisThroughput. Value range: 1–650. Note: - Parameter - N: indicates the disk index, value range: 1–16. N = 1 means system disk; if N is 1, this parameter will be ignored. N ≥ 2 means data disk; you can set this parameter normally. - Separate multiple disks with &. - Extra
Performance stringType Id Type of extra cloud disk performance, supported only by ESSD FlexPL data disks. Values: - Balance: Balanced extra performance - IOPS: IOPS extra performance - Throughput: Throughput extra performance For more information about extra performance, see [Cloud Disk Extra Performance].
Note: - Parameter - N: Indicates the sequence number of the cloud disk. Value range: 1–16. N = 1 indicates the system disk. If N is set to 1, this parameter will be ignored. N ≥ 2 indicates a data disk. This parameter can be set normally. - Use & to separate multiple cloud disks.
- Size int
Cloud disk capacity, in GiB. N ranges from 1 to 16, where N = 1 is the system disk, and N ≥ 2 are data disks. Separate multiple cloud disks with &. Cloud disk capacity ranges: - System disk: - ESSD_PL0: 20–2048 - ESSD_FlexPL: 20–2048
Note: Default: max{40, image size of ImageId}
- Data disk: - ESSD_PL0: 10–32768 - ESSD_FlexPL: 10–32768Note: If this parameter is not specified, the snapshot size corresponding to
Volumes.N.SnapshotIdis used as the data disk capacity. IfVolumes.N.SnapshotIdis not specified, an error LimitExceeded.DataVolumeSize is returned- Snapshot
Id string - Create a disk from a snapshot; only data disks are supported. You can call the [DescribeSnapshots] API to query the snapshot ID. - Parameter - N: Indicates the disk sequence number, value range: 1–16. N = 1 indicates the system disk; when N is 1, this parameter will be ignored. N ≥ 2 indicates a data disk; you can specify the target data disk snapshot ID. - Use & to separate multiple disks. Note: - Only ultra-fast SSDs support creating disks from snapshots; performance SSDs do not support snapshot-related features. - Only snapshots in the 'Available' state support creating new disks. Snapshots in 'Creating', 'Rolling back', 'Deleting', or 'Error' states do not support creating new disks.
- Volume
Type string - Cloud disk type. Values: - ESSD_PL0: Ultra-fast SSD PL0 - ESSD_FlexPL: Ultra-fast SSD FlexPL Note: - Parameter - N: Indicates the disk number, range: 1–16. N = 1 indicates the system disk; N ≥ 2 indicates a data disk. - Use & to separate multiple disks.
- Delete
With boolInstance - Whether the cloud disk is released with the instance. Values: - true (default): The cloud disk is released with the instance. - false: The cloud disk is not released with the instance. Note: - Parameter - N: Indicates the sequence number of the cloud disk, value range: 1–16. N = 1 indicates the system disk, which is released with the instance by default and cannot be retained; N ≥ 2 indicates a data disk, which can be optionally released with the instance. - Separate multiple cloud disks with &.
- Extra
Performance intIops Extra IOPS performance size for the cloud disk, supported only by ESSD FlexPL data disks, measured in operations/second. This parameter must be set when
ExtraPerformanceTypeIdisBalanceorIOPS. The value ranges for each type are as follows: - IOPS type: 1–50000 - Balance type: 1–50000Note: - Parameter - N: Indicates the sequence number of the cloud disk, value range: 1–16. N = 1 indicates the system disk, so when N is 1, this parameter is ignored. N ≥ 2 indicates a data disk, and this parameter can be set normally. - Use & to separate multiple cloud disks.
- Extra
Performance intThroughput Mb - Extra disk throughput performance in MB/s. Supported only by ESSD FlexPL data disks. Set this parameter when
ExtraPerformanceTypeIdisThroughput. Value range: 1–650. Note: - Parameter - N: indicates the disk index, value range: 1–16. N = 1 means system disk; if N is 1, this parameter will be ignored. N ≥ 2 means data disk; you can set this parameter normally. - Separate multiple disks with &. - Extra
Performance stringType Id Type of extra cloud disk performance, supported only by ESSD FlexPL data disks. Values: - Balance: Balanced extra performance - IOPS: IOPS extra performance - Throughput: Throughput extra performance For more information about extra performance, see [Cloud Disk Extra Performance].
Note: - Parameter - N: Indicates the sequence number of the cloud disk. Value range: 1–16. N = 1 indicates the system disk. If N is set to 1, this parameter will be ignored. N ≥ 2 indicates a data disk. This parameter can be set normally. - Use & to separate multiple cloud disks.
- Size int
Cloud disk capacity, in GiB. N ranges from 1 to 16, where N = 1 is the system disk, and N ≥ 2 are data disks. Separate multiple cloud disks with &. Cloud disk capacity ranges: - System disk: - ESSD_PL0: 20–2048 - ESSD_FlexPL: 20–2048
Note: Default: max{40, image size of ImageId}
- Data disk: - ESSD_PL0: 10–32768 - ESSD_FlexPL: 10–32768Note: If this parameter is not specified, the snapshot size corresponding to
Volumes.N.SnapshotIdis used as the data disk capacity. IfVolumes.N.SnapshotIdis not specified, an error LimitExceeded.DataVolumeSize is returned- Snapshot
Id string - Create a disk from a snapshot; only data disks are supported. You can call the [DescribeSnapshots] API to query the snapshot ID. - Parameter - N: Indicates the disk sequence number, value range: 1–16. N = 1 indicates the system disk; when N is 1, this parameter will be ignored. N ≥ 2 indicates a data disk; you can specify the target data disk snapshot ID. - Use & to separate multiple disks. Note: - Only ultra-fast SSDs support creating disks from snapshots; performance SSDs do not support snapshot-related features. - Only snapshots in the 'Available' state support creating new disks. Snapshots in 'Creating', 'Rolling back', 'Deleting', or 'Error' states do not support creating new disks.
- Volume
Type string - Cloud disk type. Values: - ESSD_PL0: Ultra-fast SSD PL0 - ESSD_FlexPL: Ultra-fast SSD FlexPL Note: - Parameter - N: Indicates the disk number, range: 1–16. N = 1 indicates the system disk; N ≥ 2 indicates a data disk. - Use & to separate multiple disks.
- delete_
with_ boolinstance - Whether the cloud disk is released with the instance. Values: - true (default): The cloud disk is released with the instance. - false: The cloud disk is not released with the instance. Note: - Parameter - N: Indicates the sequence number of the cloud disk, value range: 1–16. N = 1 indicates the system disk, which is released with the instance by default and cannot be retained; N ≥ 2 indicates a data disk, which can be optionally released with the instance. - Separate multiple cloud disks with &.
- extra_
performance_ numberiops Extra IOPS performance size for the cloud disk, supported only by ESSD FlexPL data disks, measured in operations/second. This parameter must be set when
ExtraPerformanceTypeIdisBalanceorIOPS. The value ranges for each type are as follows: - IOPS type: 1–50000 - Balance type: 1–50000Note: - Parameter - N: Indicates the sequence number of the cloud disk, value range: 1–16. N = 1 indicates the system disk, so when N is 1, this parameter is ignored. N ≥ 2 indicates a data disk, and this parameter can be set normally. - Use & to separate multiple cloud disks.
- extra_
performance_ numberthroughput_ mb - Extra disk throughput performance in MB/s. Supported only by ESSD FlexPL data disks. Set this parameter when
ExtraPerformanceTypeIdisThroughput. Value range: 1–650. Note: - Parameter - N: indicates the disk index, value range: 1–16. N = 1 means system disk; if N is 1, this parameter will be ignored. N ≥ 2 means data disk; you can set this parameter normally. - Separate multiple disks with &. - extra_
performance_ stringtype_ id Type of extra cloud disk performance, supported only by ESSD FlexPL data disks. Values: - Balance: Balanced extra performance - IOPS: IOPS extra performance - Throughput: Throughput extra performance For more information about extra performance, see [Cloud Disk Extra Performance].
Note: - Parameter - N: Indicates the sequence number of the cloud disk. Value range: 1–16. N = 1 indicates the system disk. If N is set to 1, this parameter will be ignored. N ≥ 2 indicates a data disk. This parameter can be set normally. - Use & to separate multiple cloud disks.
- size number
Cloud disk capacity, in GiB. N ranges from 1 to 16, where N = 1 is the system disk, and N ≥ 2 are data disks. Separate multiple cloud disks with &. Cloud disk capacity ranges: - System disk: - ESSD_PL0: 20–2048 - ESSD_FlexPL: 20–2048
Note: Default: max{40, image size of ImageId}
- Data disk: - ESSD_PL0: 10–32768 - ESSD_FlexPL: 10–32768Note: If this parameter is not specified, the snapshot size corresponding to
Volumes.N.SnapshotIdis used as the data disk capacity. IfVolumes.N.SnapshotIdis not specified, an error LimitExceeded.DataVolumeSize is returned- snapshot_
id string - Create a disk from a snapshot; only data disks are supported. You can call the [DescribeSnapshots] API to query the snapshot ID. - Parameter - N: Indicates the disk sequence number, value range: 1–16. N = 1 indicates the system disk; when N is 1, this parameter will be ignored. N ≥ 2 indicates a data disk; you can specify the target data disk snapshot ID. - Use & to separate multiple disks. Note: - Only ultra-fast SSDs support creating disks from snapshots; performance SSDs do not support snapshot-related features. - Only snapshots in the 'Available' state support creating new disks. Snapshots in 'Creating', 'Rolling back', 'Deleting', or 'Error' states do not support creating new disks.
- volume_
type string - Cloud disk type. Values: - ESSD_PL0: Ultra-fast SSD PL0 - ESSD_FlexPL: Ultra-fast SSD FlexPL Note: - Parameter - N: Indicates the disk number, range: 1–16. N = 1 indicates the system disk; N ≥ 2 indicates a data disk. - Use & to separate multiple disks.
- delete
With BooleanInstance - Whether the cloud disk is released with the instance. Values: - true (default): The cloud disk is released with the instance. - false: The cloud disk is not released with the instance. Note: - Parameter - N: Indicates the sequence number of the cloud disk, value range: 1–16. N = 1 indicates the system disk, which is released with the instance by default and cannot be retained; N ≥ 2 indicates a data disk, which can be optionally released with the instance. - Separate multiple cloud disks with &.
- extra
Performance IntegerIops Extra IOPS performance size for the cloud disk, supported only by ESSD FlexPL data disks, measured in operations/second. This parameter must be set when
ExtraPerformanceTypeIdisBalanceorIOPS. The value ranges for each type are as follows: - IOPS type: 1–50000 - Balance type: 1–50000Note: - Parameter - N: Indicates the sequence number of the cloud disk, value range: 1–16. N = 1 indicates the system disk, so when N is 1, this parameter is ignored. N ≥ 2 indicates a data disk, and this parameter can be set normally. - Use & to separate multiple cloud disks.
- extra
Performance IntegerThroughput Mb - Extra disk throughput performance in MB/s. Supported only by ESSD FlexPL data disks. Set this parameter when
ExtraPerformanceTypeIdisThroughput. Value range: 1–650. Note: - Parameter - N: indicates the disk index, value range: 1–16. N = 1 means system disk; if N is 1, this parameter will be ignored. N ≥ 2 means data disk; you can set this parameter normally. - Separate multiple disks with &. - extra
Performance StringType Id Type of extra cloud disk performance, supported only by ESSD FlexPL data disks. Values: - Balance: Balanced extra performance - IOPS: IOPS extra performance - Throughput: Throughput extra performance For more information about extra performance, see [Cloud Disk Extra Performance].
Note: - Parameter - N: Indicates the sequence number of the cloud disk. Value range: 1–16. N = 1 indicates the system disk. If N is set to 1, this parameter will be ignored. N ≥ 2 indicates a data disk. This parameter can be set normally. - Use & to separate multiple cloud disks.
- size Integer
Cloud disk capacity, in GiB. N ranges from 1 to 16, where N = 1 is the system disk, and N ≥ 2 are data disks. Separate multiple cloud disks with &. Cloud disk capacity ranges: - System disk: - ESSD_PL0: 20–2048 - ESSD_FlexPL: 20–2048
Note: Default: max{40, image size of ImageId}
- Data disk: - ESSD_PL0: 10–32768 - ESSD_FlexPL: 10–32768Note: If this parameter is not specified, the snapshot size corresponding to
Volumes.N.SnapshotIdis used as the data disk capacity. IfVolumes.N.SnapshotIdis not specified, an error LimitExceeded.DataVolumeSize is returned- snapshot
Id String - Create a disk from a snapshot; only data disks are supported. You can call the [DescribeSnapshots] API to query the snapshot ID. - Parameter - N: Indicates the disk sequence number, value range: 1–16. N = 1 indicates the system disk; when N is 1, this parameter will be ignored. N ≥ 2 indicates a data disk; you can specify the target data disk snapshot ID. - Use & to separate multiple disks. Note: - Only ultra-fast SSDs support creating disks from snapshots; performance SSDs do not support snapshot-related features. - Only snapshots in the 'Available' state support creating new disks. Snapshots in 'Creating', 'Rolling back', 'Deleting', or 'Error' states do not support creating new disks.
- volume
Type String - Cloud disk type. Values: - ESSD_PL0: Ultra-fast SSD PL0 - ESSD_FlexPL: Ultra-fast SSD FlexPL Note: - Parameter - N: Indicates the disk number, range: 1–16. N = 1 indicates the system disk; N ≥ 2 indicates a data disk. - Use & to separate multiple disks.
- delete
With booleanInstance - Whether the cloud disk is released with the instance. Values: - true (default): The cloud disk is released with the instance. - false: The cloud disk is not released with the instance. Note: - Parameter - N: Indicates the sequence number of the cloud disk, value range: 1–16. N = 1 indicates the system disk, which is released with the instance by default and cannot be retained; N ≥ 2 indicates a data disk, which can be optionally released with the instance. - Separate multiple cloud disks with &.
- extra
Performance numberIops Extra IOPS performance size for the cloud disk, supported only by ESSD FlexPL data disks, measured in operations/second. This parameter must be set when
ExtraPerformanceTypeIdisBalanceorIOPS. The value ranges for each type are as follows: - IOPS type: 1–50000 - Balance type: 1–50000Note: - Parameter - N: Indicates the sequence number of the cloud disk, value range: 1–16. N = 1 indicates the system disk, so when N is 1, this parameter is ignored. N ≥ 2 indicates a data disk, and this parameter can be set normally. - Use & to separate multiple cloud disks.
- extra
Performance numberThroughput Mb - Extra disk throughput performance in MB/s. Supported only by ESSD FlexPL data disks. Set this parameter when
ExtraPerformanceTypeIdisThroughput. Value range: 1–650. Note: - Parameter - N: indicates the disk index, value range: 1–16. N = 1 means system disk; if N is 1, this parameter will be ignored. N ≥ 2 means data disk; you can set this parameter normally. - Separate multiple disks with &. - extra
Performance stringType Id Type of extra cloud disk performance, supported only by ESSD FlexPL data disks. Values: - Balance: Balanced extra performance - IOPS: IOPS extra performance - Throughput: Throughput extra performance For more information about extra performance, see [Cloud Disk Extra Performance].
Note: - Parameter - N: Indicates the sequence number of the cloud disk. Value range: 1–16. N = 1 indicates the system disk. If N is set to 1, this parameter will be ignored. N ≥ 2 indicates a data disk. This parameter can be set normally. - Use & to separate multiple cloud disks.
- size number
Cloud disk capacity, in GiB. N ranges from 1 to 16, where N = 1 is the system disk, and N ≥ 2 are data disks. Separate multiple cloud disks with &. Cloud disk capacity ranges: - System disk: - ESSD_PL0: 20–2048 - ESSD_FlexPL: 20–2048
Note: Default: max{40, image size of ImageId}
- Data disk: - ESSD_PL0: 10–32768 - ESSD_FlexPL: 10–32768Note: If this parameter is not specified, the snapshot size corresponding to
Volumes.N.SnapshotIdis used as the data disk capacity. IfVolumes.N.SnapshotIdis not specified, an error LimitExceeded.DataVolumeSize is returned- snapshot
Id string - Create a disk from a snapshot; only data disks are supported. You can call the [DescribeSnapshots] API to query the snapshot ID. - Parameter - N: Indicates the disk sequence number, value range: 1–16. N = 1 indicates the system disk; when N is 1, this parameter will be ignored. N ≥ 2 indicates a data disk; you can specify the target data disk snapshot ID. - Use & to separate multiple disks. Note: - Only ultra-fast SSDs support creating disks from snapshots; performance SSDs do not support snapshot-related features. - Only snapshots in the 'Available' state support creating new disks. Snapshots in 'Creating', 'Rolling back', 'Deleting', or 'Error' states do not support creating new disks.
- volume
Type string - Cloud disk type. Values: - ESSD_PL0: Ultra-fast SSD PL0 - ESSD_FlexPL: Ultra-fast SSD FlexPL Note: - Parameter - N: Indicates the disk number, range: 1–16. N = 1 indicates the system disk; N ≥ 2 indicates a data disk. - Use & to separate multiple disks.
- delete_
with_ boolinstance - Whether the cloud disk is released with the instance. Values: - true (default): The cloud disk is released with the instance. - false: The cloud disk is not released with the instance. Note: - Parameter - N: Indicates the sequence number of the cloud disk, value range: 1–16. N = 1 indicates the system disk, which is released with the instance by default and cannot be retained; N ≥ 2 indicates a data disk, which can be optionally released with the instance. - Separate multiple cloud disks with &.
- extra_
performance_ intiops Extra IOPS performance size for the cloud disk, supported only by ESSD FlexPL data disks, measured in operations/second. This parameter must be set when
ExtraPerformanceTypeIdisBalanceorIOPS. The value ranges for each type are as follows: - IOPS type: 1–50000 - Balance type: 1–50000Note: - Parameter - N: Indicates the sequence number of the cloud disk, value range: 1–16. N = 1 indicates the system disk, so when N is 1, this parameter is ignored. N ≥ 2 indicates a data disk, and this parameter can be set normally. - Use & to separate multiple cloud disks.
- extra_
performance_ intthroughput_ mb - Extra disk throughput performance in MB/s. Supported only by ESSD FlexPL data disks. Set this parameter when
ExtraPerformanceTypeIdisThroughput. Value range: 1–650. Note: - Parameter - N: indicates the disk index, value range: 1–16. N = 1 means system disk; if N is 1, this parameter will be ignored. N ≥ 2 means data disk; you can set this parameter normally. - Separate multiple disks with &. - extra_
performance_ strtype_ id Type of extra cloud disk performance, supported only by ESSD FlexPL data disks. Values: - Balance: Balanced extra performance - IOPS: IOPS extra performance - Throughput: Throughput extra performance For more information about extra performance, see [Cloud Disk Extra Performance].
Note: - Parameter - N: Indicates the sequence number of the cloud disk. Value range: 1–16. N = 1 indicates the system disk. If N is set to 1, this parameter will be ignored. N ≥ 2 indicates a data disk. This parameter can be set normally. - Use & to separate multiple cloud disks.
- size int
Cloud disk capacity, in GiB. N ranges from 1 to 16, where N = 1 is the system disk, and N ≥ 2 are data disks. Separate multiple cloud disks with &. Cloud disk capacity ranges: - System disk: - ESSD_PL0: 20–2048 - ESSD_FlexPL: 20–2048
Note: Default: max{40, image size of ImageId}
- Data disk: - ESSD_PL0: 10–32768 - ESSD_FlexPL: 10–32768Note: If this parameter is not specified, the snapshot size corresponding to
Volumes.N.SnapshotIdis used as the data disk capacity. IfVolumes.N.SnapshotIdis not specified, an error LimitExceeded.DataVolumeSize is returned- snapshot_
id str - Create a disk from a snapshot; only data disks are supported. You can call the [DescribeSnapshots] API to query the snapshot ID. - Parameter - N: Indicates the disk sequence number, value range: 1–16. N = 1 indicates the system disk; when N is 1, this parameter will be ignored. N ≥ 2 indicates a data disk; you can specify the target data disk snapshot ID. - Use & to separate multiple disks. Note: - Only ultra-fast SSDs support creating disks from snapshots; performance SSDs do not support snapshot-related features. - Only snapshots in the 'Available' state support creating new disks. Snapshots in 'Creating', 'Rolling back', 'Deleting', or 'Error' states do not support creating new disks.
- volume_
type str - Cloud disk type. Values: - ESSD_PL0: Ultra-fast SSD PL0 - ESSD_FlexPL: Ultra-fast SSD FlexPL Note: - Parameter - N: Indicates the disk number, range: 1–16. N = 1 indicates the system disk; N ≥ 2 indicates a data disk. - Use & to separate multiple disks.
- delete
With BooleanInstance - Whether the cloud disk is released with the instance. Values: - true (default): The cloud disk is released with the instance. - false: The cloud disk is not released with the instance. Note: - Parameter - N: Indicates the sequence number of the cloud disk, value range: 1–16. N = 1 indicates the system disk, which is released with the instance by default and cannot be retained; N ≥ 2 indicates a data disk, which can be optionally released with the instance. - Separate multiple cloud disks with &.
- extra
Performance NumberIops Extra IOPS performance size for the cloud disk, supported only by ESSD FlexPL data disks, measured in operations/second. This parameter must be set when
ExtraPerformanceTypeIdisBalanceorIOPS. The value ranges for each type are as follows: - IOPS type: 1–50000 - Balance type: 1–50000Note: - Parameter - N: Indicates the sequence number of the cloud disk, value range: 1–16. N = 1 indicates the system disk, so when N is 1, this parameter is ignored. N ≥ 2 indicates a data disk, and this parameter can be set normally. - Use & to separate multiple cloud disks.
- extra
Performance NumberThroughput Mb - Extra disk throughput performance in MB/s. Supported only by ESSD FlexPL data disks. Set this parameter when
ExtraPerformanceTypeIdisThroughput. Value range: 1–650. Note: - Parameter - N: indicates the disk index, value range: 1–16. N = 1 means system disk; if N is 1, this parameter will be ignored. N ≥ 2 means data disk; you can set this parameter normally. - Separate multiple disks with &. - extra
Performance StringType Id Type of extra cloud disk performance, supported only by ESSD FlexPL data disks. Values: - Balance: Balanced extra performance - IOPS: IOPS extra performance - Throughput: Throughput extra performance For more information about extra performance, see [Cloud Disk Extra Performance].
Note: - Parameter - N: Indicates the sequence number of the cloud disk. Value range: 1–16. N = 1 indicates the system disk. If N is set to 1, this parameter will be ignored. N ≥ 2 indicates a data disk. This parameter can be set normally. - Use & to separate multiple cloud disks.
- size Number
Cloud disk capacity, in GiB. N ranges from 1 to 16, where N = 1 is the system disk, and N ≥ 2 are data disks. Separate multiple cloud disks with &. Cloud disk capacity ranges: - System disk: - ESSD_PL0: 20–2048 - ESSD_FlexPL: 20–2048
Note: Default: max{40, image size of ImageId}
- Data disk: - ESSD_PL0: 10–32768 - ESSD_FlexPL: 10–32768Note: If this parameter is not specified, the snapshot size corresponding to
Volumes.N.SnapshotIdis used as the data disk capacity. IfVolumes.N.SnapshotIdis not specified, an error LimitExceeded.DataVolumeSize is returned- snapshot
Id String - Create a disk from a snapshot; only data disks are supported. You can call the [DescribeSnapshots] API to query the snapshot ID. - Parameter - N: Indicates the disk sequence number, value range: 1–16. N = 1 indicates the system disk; when N is 1, this parameter will be ignored. N ≥ 2 indicates a data disk; you can specify the target data disk snapshot ID. - Use & to separate multiple disks. Note: - Only ultra-fast SSDs support creating disks from snapshots; performance SSDs do not support snapshot-related features. - Only snapshots in the 'Available' state support creating new disks. Snapshots in 'Creating', 'Rolling back', 'Deleting', or 'Error' states do not support creating new disks.
- volume
Type String - Cloud disk type. Values: - ESSD_PL0: Ultra-fast SSD PL0 - ESSD_FlexPL: Ultra-fast SSD FlexPL Note: - Parameter - N: Indicates the disk number, range: 1–16. N = 1 indicates the system disk; N ≥ 2 indicates a data disk. - Use & to separate multiple disks.
Import
$ pulumi import volcenginecc:ecs/scheduledInstance:ScheduledInstance example "scheduled_instance_id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- volcenginecc volcengine/pulumi-volcenginecc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
volcengineccTerraform Provider.
published on Thursday, Sep 3, 2026 by Volcengine