Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. Instance
tencentcloud 1.81.183 published on Wednesday, Apr 16, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.Instance

Explore with Pulumi AI

tencentcloud 1.81.183 published on Wednesday, Apr 16, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

Provides a CVM instance resource.

NOTE: You can launch an CVM instance for a VPC network via specifying parameter vpc_id. One instance can only belong to one VPC.

NOTE: At present, ‘PREPAID’ instance cannot be deleted directly and must wait it to be outdated and released automatically.

Example Usage

Create a general POSTPAID_BY_HOUR CVM instance

import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";

const config = new pulumi.Config();
const availabilityZone = config.get("availabilityZone") || "ap-guangzhou-4";
const images = tencentcloud.getImages({
    imageTypes: ["PUBLIC_IMAGE"],
    imageNameRegex: "OpenCloudOS Server",
});
const types = tencentcloud.getInstanceTypes({
    filters: [{
        name: "instance-family",
        values: [
            "S1",
            "S2",
            "S3",
            "S4",
            "S5",
        ],
    }],
    cpuCoreCount: 2,
    excludeSoldOut: true,
});
// create vpc
const vpc = new tencentcloud.Vpc("vpc", {cidrBlock: "10.0.0.0/16"});
// create subnet
const subnet = new tencentcloud.Subnet("subnet", {
    vpcId: vpc.vpcId,
    availabilityZone: availabilityZone,
    cidrBlock: "10.0.1.0/24",
});
// create CVM instance
const example = new tencentcloud.Instance("example", {
    instanceName: "tf-example",
    availabilityZone: availabilityZone,
    imageId: images.then(images => images.images?.[0]?.imageId),
    instanceType: types.then(types => types.instanceTypes?.[0]?.instanceType),
    systemDiskType: "CLOUD_PREMIUM",
    systemDiskSize: 50,
    hostname: "user",
    projectId: 0,
    vpcId: vpc.vpcId,
    subnetId: subnet.subnetId,
    dataDisks: [{
        dataDiskType: "CLOUD_PREMIUM",
        dataDiskSize: 50,
        encrypt: false,
    }],
    tags: {
        tagKey: "tagValue",
    },
});
Copy
import pulumi
import pulumi_tencentcloud as tencentcloud

config = pulumi.Config()
availability_zone = config.get("availabilityZone")
if availability_zone is None:
    availability_zone = "ap-guangzhou-4"
images = tencentcloud.get_images(image_types=["PUBLIC_IMAGE"],
    image_name_regex="OpenCloudOS Server")
types = tencentcloud.get_instance_types(filters=[{
        "name": "instance-family",
        "values": [
            "S1",
            "S2",
            "S3",
            "S4",
            "S5",
        ],
    }],
    cpu_core_count=2,
    exclude_sold_out=True)
# create vpc
vpc = tencentcloud.Vpc("vpc", cidr_block="10.0.0.0/16")
# create subnet
subnet = tencentcloud.Subnet("subnet",
    vpc_id=vpc.vpc_id,
    availability_zone=availability_zone,
    cidr_block="10.0.1.0/24")
# create CVM instance
example = tencentcloud.Instance("example",
    instance_name="tf-example",
    availability_zone=availability_zone,
    image_id=images.images[0].image_id,
    instance_type=types.instance_types[0].instance_type,
    system_disk_type="CLOUD_PREMIUM",
    system_disk_size=50,
    hostname="user",
    project_id=0,
    vpc_id=vpc.vpc_id,
    subnet_id=subnet.subnet_id,
    data_disks=[{
        "data_disk_type": "CLOUD_PREMIUM",
        "data_disk_size": 50,
        "encrypt": False,
    }],
    tags={
        "tagKey": "tagValue",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		availabilityZone := "ap-guangzhou-4"
		if param := cfg.Get("availabilityZone"); param != "" {
			availabilityZone = param
		}
		images, err := tencentcloud.GetImages(ctx, &tencentcloud.GetImagesArgs{
			ImageTypes: []string{
				"PUBLIC_IMAGE",
			},
			ImageNameRegex: pulumi.StringRef("OpenCloudOS Server"),
		}, nil)
		if err != nil {
			return err
		}
		types, err := tencentcloud.GetInstanceTypes(ctx, &tencentcloud.GetInstanceTypesArgs{
			Filters: []tencentcloud.GetInstanceTypesFilter{
				{
					Name: "instance-family",
					Values: []string{
						"S1",
						"S2",
						"S3",
						"S4",
						"S5",
					},
				},
			},
			CpuCoreCount:   pulumi.Float64Ref(2),
			ExcludeSoldOut: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		// create vpc
		vpc, err := tencentcloud.NewVpc(ctx, "vpc", &tencentcloud.VpcArgs{
			CidrBlock: pulumi.String("10.0.0.0/16"),
		})
		if err != nil {
			return err
		}
		// create subnet
		subnet, err := tencentcloud.NewSubnet(ctx, "subnet", &tencentcloud.SubnetArgs{
			VpcId:            vpc.VpcId,
			AvailabilityZone: pulumi.String(availabilityZone),
			CidrBlock:        pulumi.String("10.0.1.0/24"),
		})
		if err != nil {
			return err
		}
		// create CVM instance
		_, err = tencentcloud.NewInstance(ctx, "example", &tencentcloud.InstanceArgs{
			InstanceName:     pulumi.String("tf-example"),
			AvailabilityZone: pulumi.String(availabilityZone),
			ImageId:          pulumi.String(images.Images[0].ImageId),
			InstanceType:     pulumi.String(types.InstanceTypes[0].InstanceType),
			SystemDiskType:   pulumi.String("CLOUD_PREMIUM"),
			SystemDiskSize:   pulumi.Float64(50),
			Hostname:         pulumi.String("user"),
			ProjectId:        pulumi.Float64(0),
			VpcId:            vpc.VpcId,
			SubnetId:         subnet.SubnetId,
			DataDisks: tencentcloud.InstanceDataDiskArray{
				&tencentcloud.InstanceDataDiskArgs{
					DataDiskType: pulumi.String("CLOUD_PREMIUM"),
					DataDiskSize: pulumi.Float64(50),
					Encrypt:      pulumi.Bool(false),
				},
			},
			Tags: pulumi.StringMap{
				"tagKey": pulumi.String("tagValue"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var availabilityZone = config.Get("availabilityZone") ?? "ap-guangzhou-4";
    var images = Tencentcloud.GetImages.Invoke(new()
    {
        ImageTypes = new[]
        {
            "PUBLIC_IMAGE",
        },
        ImageNameRegex = "OpenCloudOS Server",
    });

    var types = Tencentcloud.GetInstanceTypes.Invoke(new()
    {
        Filters = new[]
        {
            new Tencentcloud.Inputs.GetInstanceTypesFilterInputArgs
            {
                Name = "instance-family",
                Values = new[]
                {
                    "S1",
                    "S2",
                    "S3",
                    "S4",
                    "S5",
                },
            },
        },
        CpuCoreCount = 2,
        ExcludeSoldOut = true,
    });

    // create vpc
    var vpc = new Tencentcloud.Vpc("vpc", new()
    {
        CidrBlock = "10.0.0.0/16",
    });

    // create subnet
    var subnet = new Tencentcloud.Subnet("subnet", new()
    {
        VpcId = vpc.VpcId,
        AvailabilityZone = availabilityZone,
        CidrBlock = "10.0.1.0/24",
    });

    // create CVM instance
    var example = new Tencentcloud.Instance("example", new()
    {
        InstanceName = "tf-example",
        AvailabilityZone = availabilityZone,
        ImageId = images.Apply(getImagesResult => getImagesResult.Images[0]?.ImageId),
        InstanceType = types.Apply(getInstanceTypesResult => getInstanceTypesResult.InstanceTypes[0]?.InstanceType),
        SystemDiskType = "CLOUD_PREMIUM",
        SystemDiskSize = 50,
        Hostname = "user",
        ProjectId = 0,
        VpcId = vpc.VpcId,
        SubnetId = subnet.SubnetId,
        DataDisks = new[]
        {
            new Tencentcloud.Inputs.InstanceDataDiskArgs
            {
                DataDiskType = "CLOUD_PREMIUM",
                DataDiskSize = 50,
                Encrypt = false,
            },
        },
        Tags = 
        {
            { "tagKey", "tagValue" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetImagesArgs;
import com.pulumi.tencentcloud.inputs.GetInstanceTypesArgs;
import com.pulumi.tencentcloud.Vpc;
import com.pulumi.tencentcloud.VpcArgs;
import com.pulumi.tencentcloud.Subnet;
import com.pulumi.tencentcloud.SubnetArgs;
import com.pulumi.tencentcloud.Instance;
import com.pulumi.tencentcloud.InstanceArgs;
import com.pulumi.tencentcloud.inputs.InstanceDataDiskArgs;
import java.util.List;
import java.util.ArrayList;
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) {
        final var config = ctx.config();
        final var availabilityZone = config.get("availabilityZone").orElse("ap-guangzhou-4");
        final var images = TencentcloudFunctions.getImages(GetImagesArgs.builder()
            .imageTypes("PUBLIC_IMAGE")
            .imageNameRegex("OpenCloudOS Server")
            .build());

        final var types = TencentcloudFunctions.getInstanceTypes(GetInstanceTypesArgs.builder()
            .filters(GetInstanceTypesFilterArgs.builder()
                .name("instance-family")
                .values(                
                    "S1",
                    "S2",
                    "S3",
                    "S4",
                    "S5")
                .build())
            .cpuCoreCount(2)
            .excludeSoldOut(true)
            .build());

        // create vpc
        var vpc = new Vpc("vpc", VpcArgs.builder()
            .cidrBlock("10.0.0.0/16")
            .build());

        // create subnet
        var subnet = new Subnet("subnet", SubnetArgs.builder()
            .vpcId(vpc.vpcId())
            .availabilityZone(availabilityZone)
            .cidrBlock("10.0.1.0/24")
            .build());

        // create CVM instance
        var example = new Instance("example", InstanceArgs.builder()
            .instanceName("tf-example")
            .availabilityZone(availabilityZone)
            .imageId(images.applyValue(getImagesResult -> getImagesResult.images()[0].imageId()))
            .instanceType(types.applyValue(getInstanceTypesResult -> getInstanceTypesResult.instanceTypes()[0].instanceType()))
            .systemDiskType("CLOUD_PREMIUM")
            .systemDiskSize(50)
            .hostname("user")
            .projectId(0)
            .vpcId(vpc.vpcId())
            .subnetId(subnet.subnetId())
            .dataDisks(InstanceDataDiskArgs.builder()
                .dataDiskType("CLOUD_PREMIUM")
                .dataDiskSize(50)
                .encrypt(false)
                .build())
            .tags(Map.of("tagKey", "tagValue"))
            .build());

    }
}
Copy
configuration:
  availabilityZone:
    type: string
    default: ap-guangzhou-4
resources:
  # create vpc
  vpc:
    type: tencentcloud:Vpc
    properties:
      cidrBlock: 10.0.0.0/16
  # create subnet
  subnet:
    type: tencentcloud:Subnet
    properties:
      vpcId: ${vpc.vpcId}
      availabilityZone: ${availabilityZone}
      cidrBlock: 10.0.1.0/24
  # create CVM instance
  example:
    type: tencentcloud:Instance
    properties:
      instanceName: tf-example
      availabilityZone: ${availabilityZone}
      imageId: ${images.images[0].imageId}
      instanceType: ${types.instanceTypes[0].instanceType}
      systemDiskType: CLOUD_PREMIUM
      systemDiskSize: 50
      hostname: user
      projectId: 0
      vpcId: ${vpc.vpcId}
      subnetId: ${subnet.subnetId}
      dataDisks:
        - dataDiskType: CLOUD_PREMIUM
          dataDiskSize: 50
          encrypt: false
      tags:
        tagKey: tagValue
variables:
  images:
    fn::invoke:
      function: tencentcloud:getImages
      arguments:
        imageTypes:
          - PUBLIC_IMAGE
        imageNameRegex: OpenCloudOS Server
  types:
    fn::invoke:
      function: tencentcloud:getInstanceTypes
      arguments:
        filters:
          - name: instance-family
            values:
              - S1
              - S2
              - S3
              - S4
              - S5
        cpuCoreCount: 2
        excludeSoldOut: true
Copy

Create a general PREPAID CVM instance

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetImagesArgs;
import com.pulumi.tencentcloud.inputs.GetInstanceTypesArgs;
import com.pulumi.tencentcloud.Vpc;
import com.pulumi.tencentcloud.VpcArgs;
import com.pulumi.tencentcloud.Subnet;
import com.pulumi.tencentcloud.SubnetArgs;
import com.pulumi.tencentcloud.Instance;
import com.pulumi.tencentcloud.InstanceArgs;
import com.pulumi.tencentcloud.inputs.InstanceDataDiskArgs;
import java.util.List;
import java.util.ArrayList;
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) {
        final var config = ctx.config();
        final var availabilityZone = config.get("availabilityZone").orElse("ap-guangzhou-4");
        final var images = TencentcloudFunctions.getImages(GetImagesArgs.builder()
            .imageTypes("PUBLIC_IMAGE")
            .imageNameRegex("OpenCloudOS Server")
            .build());

        final var types = TencentcloudFunctions.getInstanceTypes(GetInstanceTypesArgs.builder()
            .filters(GetInstanceTypesFilterArgs.builder()
                .name("instance-family")
                .values(                
                    "S1",
                    "S2",
                    "S3",
                    "S4",
                    "S5")
                .build())
            .cpuCoreCount(2)
            .excludeSoldOut(true)
            .build());

        // create vpc
        var vpc = new Vpc("vpc", VpcArgs.builder()
            .cidrBlock("10.0.0.0/16")
            .build());

        // create subnet
        var subnet = new Subnet("subnet", SubnetArgs.builder()
            .vpcId(vpc.vpcId())
            .availabilityZone(availabilityZone)
            .cidrBlock("10.0.1.0/24")
            .build());

        // create CVM instance
        var example = new Instance("example", InstanceArgs.builder()
            .instanceName("tf-example")
            .availabilityZone(availabilityZone)
            .imageId(images.applyValue(getImagesResult -> getImagesResult.images()[0].imageId()))
            .instanceType(types.applyValue(getInstanceTypesResult -> getInstanceTypesResult.instanceTypes()[0].instanceType()))
            .systemDiskType("CLOUD_PREMIUM")
            .systemDiskSize(50)
            .hostname("user")
            .projectId(0)
            .vpcId(vpc.vpcId())
            .subnetId(subnet.subnetId())
            .instanceChargeType("PREPAID")
            .instanceChargeTypePrepaidPeriod(1)
            .instanceChargeTypePrepaidRenewFlag("NOTIFY_AND_MANUAL_RENEW")
            .forceDelete(true)
            .dataDisks(InstanceDataDiskArgs.builder()
                .dataDiskType("CLOUD_PREMIUM")
                .dataDiskSize(50)
                .encrypt(false)
                .build())
            .tags(Map.of("tagKey", "tagValue"))
            .timeouts(InstanceTimeoutsArgs.builder()
                .create("30m")
                .build())
            .build());

    }
}
Copy
configuration:
  availabilityZone:
    type: string
    default: ap-guangzhou-4
resources:
  # create vpc
  vpc:
    type: tencentcloud:Vpc
    properties:
      cidrBlock: 10.0.0.0/16
  # create subnet
  subnet:
    type: tencentcloud:Subnet
    properties:
      vpcId: ${vpc.vpcId}
      availabilityZone: ${availabilityZone}
      cidrBlock: 10.0.1.0/24
  # create CVM instance
  example:
    type: tencentcloud:Instance
    properties:
      instanceName: tf-example
      availabilityZone: ${availabilityZone}
      imageId: ${images.images[0].imageId}
      instanceType: ${types.instanceTypes[0].instanceType}
      systemDiskType: CLOUD_PREMIUM
      systemDiskSize: 50
      hostname: user
      projectId: 0
      vpcId: ${vpc.vpcId}
      subnetId: ${subnet.subnetId}
      instanceChargeType: PREPAID
      instanceChargeTypePrepaidPeriod: 1
      instanceChargeTypePrepaidRenewFlag: NOTIFY_AND_MANUAL_RENEW
      forceDelete: true
      dataDisks:
        - dataDiskType: CLOUD_PREMIUM
          dataDiskSize: 50
          encrypt: false
      tags:
        tagKey: tagValue
      timeouts:
        - create: 30m
variables:
  images:
    fn::invoke:
      function: tencentcloud:getImages
      arguments:
        imageTypes:
          - PUBLIC_IMAGE
        imageNameRegex: OpenCloudOS Server
  types:
    fn::invoke:
      function: tencentcloud:getInstanceTypes
      arguments:
        filters:
          - name: instance-family
            values:
              - S1
              - S2
              - S3
              - S4
              - S5
        cpuCoreCount: 2
        excludeSoldOut: true
Copy

Create a dedicated cluster CVM instance

import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";

const config = new pulumi.Config();
const availabilityZone = config.get("availabilityZone") || "ap-guangzhou-4";
const images = tencentcloud.getImages({
    imageTypes: ["PUBLIC_IMAGE"],
    imageNameRegex: "OpenCloudOS Server",
});
const types = tencentcloud.getInstanceTypes({
    filters: [{
        name: "instance-family",
        values: [
            "S1",
            "S2",
            "S3",
            "S4",
            "S5",
        ],
    }],
    cpuCoreCount: 2,
    excludeSoldOut: true,
});
// create vpc
const vpc = new tencentcloud.Vpc("vpc", {cidrBlock: "10.0.0.0/16"});
// create subnet
const subnet = new tencentcloud.Subnet("subnet", {
    vpcId: vpc.vpcId,
    availabilityZone: availabilityZone,
    cidrBlock: "10.0.1.0/24",
    cdcId: "cluster-262n63e8",
    isMulticast: false,
});
// create CVM instance
const example = new tencentcloud.Instance("example", {
    instanceName: "tf-example",
    availabilityZone: availabilityZone,
    imageId: images.then(images => images.images?.[0]?.imageId),
    instanceType: types.then(types => types.instanceTypes?.[0]?.instanceType),
    dedicatedClusterId: "cluster-262n63e8",
    instanceChargeType: "CDCPAID",
    systemDiskType: "CLOUD_SSD",
    systemDiskSize: 50,
    hostname: "user",
    projectId: 0,
    vpcId: vpc.vpcId,
    subnetId: subnet.subnetId,
    dataDisks: [{
        dataDiskType: "CLOUD_SSD",
        dataDiskSize: 50,
        encrypt: false,
    }],
    tags: {
        tagKey: "tagValue",
    },
});
Copy
import pulumi
import pulumi_tencentcloud as tencentcloud

config = pulumi.Config()
availability_zone = config.get("availabilityZone")
if availability_zone is None:
    availability_zone = "ap-guangzhou-4"
images = tencentcloud.get_images(image_types=["PUBLIC_IMAGE"],
    image_name_regex="OpenCloudOS Server")
types = tencentcloud.get_instance_types(filters=[{
        "name": "instance-family",
        "values": [
            "S1",
            "S2",
            "S3",
            "S4",
            "S5",
        ],
    }],
    cpu_core_count=2,
    exclude_sold_out=True)
# create vpc
vpc = tencentcloud.Vpc("vpc", cidr_block="10.0.0.0/16")
# create subnet
subnet = tencentcloud.Subnet("subnet",
    vpc_id=vpc.vpc_id,
    availability_zone=availability_zone,
    cidr_block="10.0.1.0/24",
    cdc_id="cluster-262n63e8",
    is_multicast=False)
# create CVM instance
example = tencentcloud.Instance("example",
    instance_name="tf-example",
    availability_zone=availability_zone,
    image_id=images.images[0].image_id,
    instance_type=types.instance_types[0].instance_type,
    dedicated_cluster_id="cluster-262n63e8",
    instance_charge_type="CDCPAID",
    system_disk_type="CLOUD_SSD",
    system_disk_size=50,
    hostname="user",
    project_id=0,
    vpc_id=vpc.vpc_id,
    subnet_id=subnet.subnet_id,
    data_disks=[{
        "data_disk_type": "CLOUD_SSD",
        "data_disk_size": 50,
        "encrypt": False,
    }],
    tags={
        "tagKey": "tagValue",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		availabilityZone := "ap-guangzhou-4"
		if param := cfg.Get("availabilityZone"); param != "" {
			availabilityZone = param
		}
		images, err := tencentcloud.GetImages(ctx, &tencentcloud.GetImagesArgs{
			ImageTypes: []string{
				"PUBLIC_IMAGE",
			},
			ImageNameRegex: pulumi.StringRef("OpenCloudOS Server"),
		}, nil)
		if err != nil {
			return err
		}
		types, err := tencentcloud.GetInstanceTypes(ctx, &tencentcloud.GetInstanceTypesArgs{
			Filters: []tencentcloud.GetInstanceTypesFilter{
				{
					Name: "instance-family",
					Values: []string{
						"S1",
						"S2",
						"S3",
						"S4",
						"S5",
					},
				},
			},
			CpuCoreCount:   pulumi.Float64Ref(2),
			ExcludeSoldOut: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		// create vpc
		vpc, err := tencentcloud.NewVpc(ctx, "vpc", &tencentcloud.VpcArgs{
			CidrBlock: pulumi.String("10.0.0.0/16"),
		})
		if err != nil {
			return err
		}
		// create subnet
		subnet, err := tencentcloud.NewSubnet(ctx, "subnet", &tencentcloud.SubnetArgs{
			VpcId:            vpc.VpcId,
			AvailabilityZone: pulumi.String(availabilityZone),
			CidrBlock:        pulumi.String("10.0.1.0/24"),
			CdcId:            pulumi.String("cluster-262n63e8"),
			IsMulticast:      pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		// create CVM instance
		_, err = tencentcloud.NewInstance(ctx, "example", &tencentcloud.InstanceArgs{
			InstanceName:       pulumi.String("tf-example"),
			AvailabilityZone:   pulumi.String(availabilityZone),
			ImageId:            pulumi.String(images.Images[0].ImageId),
			InstanceType:       pulumi.String(types.InstanceTypes[0].InstanceType),
			DedicatedClusterId: pulumi.String("cluster-262n63e8"),
			InstanceChargeType: pulumi.String("CDCPAID"),
			SystemDiskType:     pulumi.String("CLOUD_SSD"),
			SystemDiskSize:     pulumi.Float64(50),
			Hostname:           pulumi.String("user"),
			ProjectId:          pulumi.Float64(0),
			VpcId:              vpc.VpcId,
			SubnetId:           subnet.SubnetId,
			DataDisks: tencentcloud.InstanceDataDiskArray{
				&tencentcloud.InstanceDataDiskArgs{
					DataDiskType: pulumi.String("CLOUD_SSD"),
					DataDiskSize: pulumi.Float64(50),
					Encrypt:      pulumi.Bool(false),
				},
			},
			Tags: pulumi.StringMap{
				"tagKey": pulumi.String("tagValue"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var availabilityZone = config.Get("availabilityZone") ?? "ap-guangzhou-4";
    var images = Tencentcloud.GetImages.Invoke(new()
    {
        ImageTypes = new[]
        {
            "PUBLIC_IMAGE",
        },
        ImageNameRegex = "OpenCloudOS Server",
    });

    var types = Tencentcloud.GetInstanceTypes.Invoke(new()
    {
        Filters = new[]
        {
            new Tencentcloud.Inputs.GetInstanceTypesFilterInputArgs
            {
                Name = "instance-family",
                Values = new[]
                {
                    "S1",
                    "S2",
                    "S3",
                    "S4",
                    "S5",
                },
            },
        },
        CpuCoreCount = 2,
        ExcludeSoldOut = true,
    });

    // create vpc
    var vpc = new Tencentcloud.Vpc("vpc", new()
    {
        CidrBlock = "10.0.0.0/16",
    });

    // create subnet
    var subnet = new Tencentcloud.Subnet("subnet", new()
    {
        VpcId = vpc.VpcId,
        AvailabilityZone = availabilityZone,
        CidrBlock = "10.0.1.0/24",
        CdcId = "cluster-262n63e8",
        IsMulticast = false,
    });

    // create CVM instance
    var example = new Tencentcloud.Instance("example", new()
    {
        InstanceName = "tf-example",
        AvailabilityZone = availabilityZone,
        ImageId = images.Apply(getImagesResult => getImagesResult.Images[0]?.ImageId),
        InstanceType = types.Apply(getInstanceTypesResult => getInstanceTypesResult.InstanceTypes[0]?.InstanceType),
        DedicatedClusterId = "cluster-262n63e8",
        InstanceChargeType = "CDCPAID",
        SystemDiskType = "CLOUD_SSD",
        SystemDiskSize = 50,
        Hostname = "user",
        ProjectId = 0,
        VpcId = vpc.VpcId,
        SubnetId = subnet.SubnetId,
        DataDisks = new[]
        {
            new Tencentcloud.Inputs.InstanceDataDiskArgs
            {
                DataDiskType = "CLOUD_SSD",
                DataDiskSize = 50,
                Encrypt = false,
            },
        },
        Tags = 
        {
            { "tagKey", "tagValue" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetImagesArgs;
import com.pulumi.tencentcloud.inputs.GetInstanceTypesArgs;
import com.pulumi.tencentcloud.Vpc;
import com.pulumi.tencentcloud.VpcArgs;
import com.pulumi.tencentcloud.Subnet;
import com.pulumi.tencentcloud.SubnetArgs;
import com.pulumi.tencentcloud.Instance;
import com.pulumi.tencentcloud.InstanceArgs;
import com.pulumi.tencentcloud.inputs.InstanceDataDiskArgs;
import java.util.List;
import java.util.ArrayList;
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) {
        final var config = ctx.config();
        final var availabilityZone = config.get("availabilityZone").orElse("ap-guangzhou-4");
        final var images = TencentcloudFunctions.getImages(GetImagesArgs.builder()
            .imageTypes("PUBLIC_IMAGE")
            .imageNameRegex("OpenCloudOS Server")
            .build());

        final var types = TencentcloudFunctions.getInstanceTypes(GetInstanceTypesArgs.builder()
            .filters(GetInstanceTypesFilterArgs.builder()
                .name("instance-family")
                .values(                
                    "S1",
                    "S2",
                    "S3",
                    "S4",
                    "S5")
                .build())
            .cpuCoreCount(2)
            .excludeSoldOut(true)
            .build());

        // create vpc
        var vpc = new Vpc("vpc", VpcArgs.builder()
            .cidrBlock("10.0.0.0/16")
            .build());

        // create subnet
        var subnet = new Subnet("subnet", SubnetArgs.builder()
            .vpcId(vpc.vpcId())
            .availabilityZone(availabilityZone)
            .cidrBlock("10.0.1.0/24")
            .cdcId("cluster-262n63e8")
            .isMulticast(false)
            .build());

        // create CVM instance
        var example = new Instance("example", InstanceArgs.builder()
            .instanceName("tf-example")
            .availabilityZone(availabilityZone)
            .imageId(images.applyValue(getImagesResult -> getImagesResult.images()[0].imageId()))
            .instanceType(types.applyValue(getInstanceTypesResult -> getInstanceTypesResult.instanceTypes()[0].instanceType()))
            .dedicatedClusterId("cluster-262n63e8")
            .instanceChargeType("CDCPAID")
            .systemDiskType("CLOUD_SSD")
            .systemDiskSize(50)
            .hostname("user")
            .projectId(0)
            .vpcId(vpc.vpcId())
            .subnetId(subnet.subnetId())
            .dataDisks(InstanceDataDiskArgs.builder()
                .dataDiskType("CLOUD_SSD")
                .dataDiskSize(50)
                .encrypt(false)
                .build())
            .tags(Map.of("tagKey", "tagValue"))
            .build());

    }
}
Copy
configuration:
  availabilityZone:
    type: string
    default: ap-guangzhou-4
resources:
  # create vpc
  vpc:
    type: tencentcloud:Vpc
    properties:
      cidrBlock: 10.0.0.0/16
  # create subnet
  subnet:
    type: tencentcloud:Subnet
    properties:
      vpcId: ${vpc.vpcId}
      availabilityZone: ${availabilityZone}
      cidrBlock: 10.0.1.0/24
      cdcId: cluster-262n63e8
      isMulticast: false
  # create CVM instance
  example:
    type: tencentcloud:Instance
    properties:
      instanceName: tf-example
      availabilityZone: ${availabilityZone}
      imageId: ${images.images[0].imageId}
      instanceType: ${types.instanceTypes[0].instanceType}
      dedicatedClusterId: cluster-262n63e8
      instanceChargeType: CDCPAID
      systemDiskType: CLOUD_SSD
      systemDiskSize: 50
      hostname: user
      projectId: 0
      vpcId: ${vpc.vpcId}
      subnetId: ${subnet.subnetId}
      dataDisks:
        - dataDiskType: CLOUD_SSD
          dataDiskSize: 50
          encrypt: false
      tags:
        tagKey: tagValue
variables:
  images:
    fn::invoke:
      function: tencentcloud:getImages
      arguments:
        imageTypes:
          - PUBLIC_IMAGE
        imageNameRegex: OpenCloudOS Server
  types:
    fn::invoke:
      function: tencentcloud:getInstanceTypes
      arguments:
        filters:
          - name: instance-family
            values:
              - S1
              - S2
              - S3
              - S4
              - S5
        cpuCoreCount: 2
        excludeSoldOut: true
Copy

Create Instance Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);
@overload
def Instance(resource_name: str,
             args: InstanceArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Instance(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             image_id: Optional[str] = None,
             availability_zone: Optional[str] = None,
             internet_max_bandwidth_out: Optional[float] = None,
             hpc_cluster_id: Optional[str] = None,
             cdh_host_id: Optional[str] = None,
             cdh_instance_type: Optional[str] = None,
             data_disks: Optional[Sequence[InstanceDataDiskArgs]] = None,
             dedicated_cluster_id: Optional[str] = None,
             disable_api_termination: Optional[bool] = None,
             disable_automation_service: Optional[bool] = None,
             disable_monitor_service: Optional[bool] = None,
             disable_security_service: Optional[bool] = None,
             force_delete: Optional[bool] = None,
             hostname: Optional[str] = None,
             keep_image_login: Optional[bool] = None,
             bandwidth_package_id: Optional[str] = None,
             instance_charge_type: Optional[str] = None,
             instance_charge_type_prepaid_period: Optional[float] = None,
             instance_charge_type_prepaid_renew_flag: Optional[str] = None,
             instance_count: Optional[float] = None,
             instance_id: Optional[str] = None,
             instance_name: Optional[str] = None,
             instance_type: Optional[str] = None,
             internet_charge_type: Optional[str] = None,
             cam_role_name: Optional[str] = None,
             allocate_public_ip: Optional[bool] = None,
             running_flag: Optional[bool] = None,
             key_name: Optional[str] = None,
             orderly_security_groups: Optional[Sequence[str]] = None,
             password: Optional[str] = None,
             placement_group_id: Optional[str] = None,
             private_ip: Optional[str] = None,
             project_id: Optional[float] = None,
             key_ids: Optional[Sequence[str]] = None,
             security_groups: Optional[Sequence[str]] = None,
             spot_instance_type: Optional[str] = None,
             spot_max_price: Optional[str] = None,
             stopped_mode: Optional[str] = None,
             subnet_id: Optional[str] = None,
             system_disk_id: Optional[str] = None,
             system_disk_name: Optional[str] = None,
             system_disk_resize_online: Optional[bool] = None,
             system_disk_size: Optional[float] = None,
             system_disk_type: Optional[str] = None,
             tags: Optional[Mapping[str, str]] = None,
             timeouts: Optional[InstanceTimeoutsArgs] = None,
             user_data: Optional[str] = None,
             user_data_raw: Optional[str] = None,
             vpc_id: Optional[str] = None)
func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)

type: tencentcloud:Instance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. InstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. InstanceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. InstanceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. InstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. InstanceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Instance 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 Instance resource accepts the following input properties:

AvailabilityZone This property is required. string
The available zone for the CVM instance.
ImageId This property is required. string
The image to use for the instance. Modifications may lead to the reinstallation of the instance's operating system..
AllocatePublicIp bool
Associate a public IP address with an instance in a VPC or Classic. Boolean value, Default is false.
BandwidthPackageId string
bandwidth package id. if user is standard user, then the bandwidth_package_id is needed, or default has bandwidth_package_id.
CamRoleName string
CAM role name authorized to access.
CdhHostId string
Id of cdh instance. Note: it only works when instance_charge_type is set to CDHPAID.
CdhInstanceType string
Type of instance created on cdh, the value of this parameter is in the format of CDH_XCXG based on the number of CPU cores and memory capacity. Note: it only works when instance_charge_type is set to CDHPAID.
DataDisks List<InstanceDataDisk>
Settings for data disks.
DedicatedClusterId string
Exclusive cluster id.
DisableApiTermination bool
Whether the termination protection is enabled. Default is false. If set true, which means that this instance can not be deleted by an API action.
DisableAutomationService bool
Disable enhance service for automation, it is enabled by default. When this options is set, monitor agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
DisableMonitorService bool
Disable enhance service for monitor, it is enabled by default. When this options is set, monitor agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
DisableSecurityService bool
Disable enhance service for security, it is enabled by default. When this options is set, security agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
ForceDelete bool
Indicate whether to force delete the instance. Default is false. If set true, the instance will be permanently deleted instead of being moved into the recycle bin. Note: only works for PREPAID instance.
Hostname string
The hostname of the instance. Windows instance: The name should be a combination of 2 to 15 characters comprised of letters (case insensitive), numbers, and hyphens (-). Period (.) is not supported, and the name cannot be a string of pure numbers. Other types (such as Linux) of instances: The name should be a combination of 2 to 60 characters, supporting multiple periods (.). The piece between two periods is composed of letters (case insensitive), numbers, and hyphens (-). Modifications may lead to the reinstallation of the instance's operating system.
HpcClusterId string
High-performance computing cluster ID. If the instance created is a high-performance computing instance, you need to specify the cluster in which the instance is placed, otherwise it cannot be specified.
InstanceChargeType string
The charge type of instance. Valid values are PREPAID, POSTPAID_BY_HOUR, SPOTPAID, CDHPAID and CDCPAID. The default is POSTPAID_BY_HOUR. Note: TencentCloud International only supports POSTPAID_BY_HOUR and CDHPAID. PREPAID instance may not allow to delete before expired. SPOTPAID instance must set spot_instance_type and spot_max_price at the same time. CDHPAID instance must set cdh_instance_type and cdh_host_id.
InstanceChargeTypePrepaidPeriod double
The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when instance_charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60.
InstanceChargeTypePrepaidRenewFlag string
Auto renewal flag. Valid values: NOTIFY_AND_AUTO_RENEW: notify upon expiration and renew automatically, NOTIFY_AND_MANUAL_RENEW: notify upon expiration but do not renew automatically, DISABLE_NOTIFY_AND_MANUAL_RENEW: neither notify upon expiration nor renew automatically. Default value: NOTIFY_AND_MANUAL_RENEW. If this parameter is specified as NOTIFY_AND_AUTO_RENEW, the instance will be automatically renewed on a monthly basis if the account balance is sufficient. NOTE: it only works when instance_charge_type is set to PREPAID.
InstanceCount double
It has been deprecated from version 1.59.18. Use built-in count instead. The number of instances to be purchased. Value range:[1,100]; default value: 1.

Deprecated: Deprecated

InstanceId string
ID of the resource.
InstanceName string
InstanceType string
The type of the instance.
InternetChargeType string
Internet charge type of the instance, Valid values are BANDWIDTH_PREPAID, TRAFFIC_POSTPAID_BY_HOUR, BANDWIDTH_POSTPAID_BY_HOUR and BANDWIDTH_PACKAGE. If not set, internet charge type are consistent with the cvm charge type by default. This value takes NO Effect when changing and does not need to be set when allocate_public_ip is false.
InternetMaxBandwidthOut double
Maximum outgoing bandwidth to the public network, measured in Mbps (Mega bits per second). This value does not need to be set when allocate_public_ip is false.
KeepImageLogin bool
Whether to keep image login or not, default is false. When the image type is private or shared or imported, this parameter can be set true. Modifications may lead to the reinstallation of the instance's operating system..
KeyIds List<string>
The key pair to use for the instance, it looks like skey-16jig7tx. Modifications may lead to the reinstallation of the instance's operating system.
KeyName string
Please use key_ids instead. The key pair to use for the instance, it looks like skey-16jig7tx. Modifications may lead to the reinstallation of the instance's operating system.

Deprecated: Deprecated

OrderlySecurityGroups List<string>
A list of orderly security group IDs to associate with.
Password string
Password for the instance. In order for the new password to take effect, the instance will be restarted after the password change. Modifications may lead to the reinstallation of the instance's operating system.
PlacementGroupId string
The ID of a placement group.
PrivateIp string
The private IP to be assigned to this instance, must be in the provided subnet and available.
ProjectId double
The project the instance belongs to, default to 0.
RunningFlag bool
Set instance to running or stop. Default value is true, the instance will shutdown when this flag is false.
SecurityGroups List<string>
It will be deprecated. Use orderly_security_groups instead. A list of security group IDs to associate with.

Deprecated: Deprecated

SpotInstanceType string
Type of spot instance, only support ONE-TIME now. Note: it only works when instance_charge_type is set to SPOTPAID.
SpotMaxPrice string
Max price of a spot instance, is the format of decimal string, for example "0.50". Note: it only works when instance_charge_type is set to SPOTPAID.
StoppedMode string
Billing method of a pay-as-you-go instance after shutdown. Available values: KEEP_CHARGING,STOP_CHARGING. Default KEEP_CHARGING.
SubnetId string
The ID of a VPC subnet. If you want to create instances in a VPC network, this parameter must be set.
SystemDiskId string
System disk snapshot ID used to initialize the system disk. When system disk type is LOCAL_BASIC and LOCAL_SSD, disk id is not supported.
SystemDiskName string
Name of the system disk.
SystemDiskResizeOnline bool
Resize online.
SystemDiskSize double
Size of the system disk. unit is GB, Default is 50GB. If modified, the instance may force stop.
SystemDiskType string
System disk type. For more information on limits of system disk types, see Storage Overview. Valid values: LOCAL_BASIC: local disk, LOCAL_SSD: local SSD disk, CLOUD_BASIC: cloud disk, CLOUD_SSD: cloud SSD disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_BSSD: Basic SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD. NOTE: If modified, the instance may force stop.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource. For tag limits, please refer to Use Limits.
Timeouts InstanceTimeouts
UserData string
The user data to be injected into this instance. Must be base64 encoded and up to 16 KB.
UserDataRaw string
The user data to be injected into this instance, in plain text. Conflicts with user_data. Up to 16 KB after base64 encoded.
VpcId string
The ID of a VPC network. If you want to create instances in a VPC network, this parameter must be set.
AvailabilityZone This property is required. string
The available zone for the CVM instance.
ImageId This property is required. string
The image to use for the instance. Modifications may lead to the reinstallation of the instance's operating system..
AllocatePublicIp bool
Associate a public IP address with an instance in a VPC or Classic. Boolean value, Default is false.
BandwidthPackageId string
bandwidth package id. if user is standard user, then the bandwidth_package_id is needed, or default has bandwidth_package_id.
CamRoleName string
CAM role name authorized to access.
CdhHostId string
Id of cdh instance. Note: it only works when instance_charge_type is set to CDHPAID.
CdhInstanceType string
Type of instance created on cdh, the value of this parameter is in the format of CDH_XCXG based on the number of CPU cores and memory capacity. Note: it only works when instance_charge_type is set to CDHPAID.
DataDisks []InstanceDataDiskArgs
Settings for data disks.
DedicatedClusterId string
Exclusive cluster id.
DisableApiTermination bool
Whether the termination protection is enabled. Default is false. If set true, which means that this instance can not be deleted by an API action.
DisableAutomationService bool
Disable enhance service for automation, it is enabled by default. When this options is set, monitor agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
DisableMonitorService bool
Disable enhance service for monitor, it is enabled by default. When this options is set, monitor agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
DisableSecurityService bool
Disable enhance service for security, it is enabled by default. When this options is set, security agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
ForceDelete bool
Indicate whether to force delete the instance. Default is false. If set true, the instance will be permanently deleted instead of being moved into the recycle bin. Note: only works for PREPAID instance.
Hostname string
The hostname of the instance. Windows instance: The name should be a combination of 2 to 15 characters comprised of letters (case insensitive), numbers, and hyphens (-). Period (.) is not supported, and the name cannot be a string of pure numbers. Other types (such as Linux) of instances: The name should be a combination of 2 to 60 characters, supporting multiple periods (.). The piece between two periods is composed of letters (case insensitive), numbers, and hyphens (-). Modifications may lead to the reinstallation of the instance's operating system.
HpcClusterId string
High-performance computing cluster ID. If the instance created is a high-performance computing instance, you need to specify the cluster in which the instance is placed, otherwise it cannot be specified.
InstanceChargeType string
The charge type of instance. Valid values are PREPAID, POSTPAID_BY_HOUR, SPOTPAID, CDHPAID and CDCPAID. The default is POSTPAID_BY_HOUR. Note: TencentCloud International only supports POSTPAID_BY_HOUR and CDHPAID. PREPAID instance may not allow to delete before expired. SPOTPAID instance must set spot_instance_type and spot_max_price at the same time. CDHPAID instance must set cdh_instance_type and cdh_host_id.
InstanceChargeTypePrepaidPeriod float64
The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when instance_charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60.
InstanceChargeTypePrepaidRenewFlag string
Auto renewal flag. Valid values: NOTIFY_AND_AUTO_RENEW: notify upon expiration and renew automatically, NOTIFY_AND_MANUAL_RENEW: notify upon expiration but do not renew automatically, DISABLE_NOTIFY_AND_MANUAL_RENEW: neither notify upon expiration nor renew automatically. Default value: NOTIFY_AND_MANUAL_RENEW. If this parameter is specified as NOTIFY_AND_AUTO_RENEW, the instance will be automatically renewed on a monthly basis if the account balance is sufficient. NOTE: it only works when instance_charge_type is set to PREPAID.
InstanceCount float64
It has been deprecated from version 1.59.18. Use built-in count instead. The number of instances to be purchased. Value range:[1,100]; default value: 1.

Deprecated: Deprecated

InstanceId string
ID of the resource.
InstanceName string
InstanceType string
The type of the instance.
InternetChargeType string
Internet charge type of the instance, Valid values are BANDWIDTH_PREPAID, TRAFFIC_POSTPAID_BY_HOUR, BANDWIDTH_POSTPAID_BY_HOUR and BANDWIDTH_PACKAGE. If not set, internet charge type are consistent with the cvm charge type by default. This value takes NO Effect when changing and does not need to be set when allocate_public_ip is false.
InternetMaxBandwidthOut float64
Maximum outgoing bandwidth to the public network, measured in Mbps (Mega bits per second). This value does not need to be set when allocate_public_ip is false.
KeepImageLogin bool
Whether to keep image login or not, default is false. When the image type is private or shared or imported, this parameter can be set true. Modifications may lead to the reinstallation of the instance's operating system..
KeyIds []string
The key pair to use for the instance, it looks like skey-16jig7tx. Modifications may lead to the reinstallation of the instance's operating system.
KeyName string
Please use key_ids instead. The key pair to use for the instance, it looks like skey-16jig7tx. Modifications may lead to the reinstallation of the instance's operating system.

Deprecated: Deprecated

OrderlySecurityGroups []string
A list of orderly security group IDs to associate with.
Password string
Password for the instance. In order for the new password to take effect, the instance will be restarted after the password change. Modifications may lead to the reinstallation of the instance's operating system.
PlacementGroupId string
The ID of a placement group.
PrivateIp string
The private IP to be assigned to this instance, must be in the provided subnet and available.
ProjectId float64
The project the instance belongs to, default to 0.
RunningFlag bool
Set instance to running or stop. Default value is true, the instance will shutdown when this flag is false.
SecurityGroups []string
It will be deprecated. Use orderly_security_groups instead. A list of security group IDs to associate with.

Deprecated: Deprecated

SpotInstanceType string
Type of spot instance, only support ONE-TIME now. Note: it only works when instance_charge_type is set to SPOTPAID.
SpotMaxPrice string
Max price of a spot instance, is the format of decimal string, for example "0.50". Note: it only works when instance_charge_type is set to SPOTPAID.
StoppedMode string
Billing method of a pay-as-you-go instance after shutdown. Available values: KEEP_CHARGING,STOP_CHARGING. Default KEEP_CHARGING.
SubnetId string
The ID of a VPC subnet. If you want to create instances in a VPC network, this parameter must be set.
SystemDiskId string
System disk snapshot ID used to initialize the system disk. When system disk type is LOCAL_BASIC and LOCAL_SSD, disk id is not supported.
SystemDiskName string
Name of the system disk.
SystemDiskResizeOnline bool
Resize online.
SystemDiskSize float64
Size of the system disk. unit is GB, Default is 50GB. If modified, the instance may force stop.
SystemDiskType string
System disk type. For more information on limits of system disk types, see Storage Overview. Valid values: LOCAL_BASIC: local disk, LOCAL_SSD: local SSD disk, CLOUD_BASIC: cloud disk, CLOUD_SSD: cloud SSD disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_BSSD: Basic SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD. NOTE: If modified, the instance may force stop.
Tags map[string]string
A mapping of tags to assign to the resource. For tag limits, please refer to Use Limits.
Timeouts InstanceTimeoutsArgs
UserData string
The user data to be injected into this instance. Must be base64 encoded and up to 16 KB.
UserDataRaw string
The user data to be injected into this instance, in plain text. Conflicts with user_data. Up to 16 KB after base64 encoded.
VpcId string
The ID of a VPC network. If you want to create instances in a VPC network, this parameter must be set.
availabilityZone This property is required. String
The available zone for the CVM instance.
imageId This property is required. String
The image to use for the instance. Modifications may lead to the reinstallation of the instance's operating system..
allocatePublicIp Boolean
Associate a public IP address with an instance in a VPC or Classic. Boolean value, Default is false.
bandwidthPackageId String
bandwidth package id. if user is standard user, then the bandwidth_package_id is needed, or default has bandwidth_package_id.
camRoleName String
CAM role name authorized to access.
cdhHostId String
Id of cdh instance. Note: it only works when instance_charge_type is set to CDHPAID.
cdhInstanceType String
Type of instance created on cdh, the value of this parameter is in the format of CDH_XCXG based on the number of CPU cores and memory capacity. Note: it only works when instance_charge_type is set to CDHPAID.
dataDisks List<InstanceDataDisk>
Settings for data disks.
dedicatedClusterId String
Exclusive cluster id.
disableApiTermination Boolean
Whether the termination protection is enabled. Default is false. If set true, which means that this instance can not be deleted by an API action.
disableAutomationService Boolean
Disable enhance service for automation, it is enabled by default. When this options is set, monitor agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
disableMonitorService Boolean
Disable enhance service for monitor, it is enabled by default. When this options is set, monitor agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
disableSecurityService Boolean
Disable enhance service for security, it is enabled by default. When this options is set, security agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
forceDelete Boolean
Indicate whether to force delete the instance. Default is false. If set true, the instance will be permanently deleted instead of being moved into the recycle bin. Note: only works for PREPAID instance.
hostname String
The hostname of the instance. Windows instance: The name should be a combination of 2 to 15 characters comprised of letters (case insensitive), numbers, and hyphens (-). Period (.) is not supported, and the name cannot be a string of pure numbers. Other types (such as Linux) of instances: The name should be a combination of 2 to 60 characters, supporting multiple periods (.). The piece between two periods is composed of letters (case insensitive), numbers, and hyphens (-). Modifications may lead to the reinstallation of the instance's operating system.
hpcClusterId String
High-performance computing cluster ID. If the instance created is a high-performance computing instance, you need to specify the cluster in which the instance is placed, otherwise it cannot be specified.
instanceChargeType String
The charge type of instance. Valid values are PREPAID, POSTPAID_BY_HOUR, SPOTPAID, CDHPAID and CDCPAID. The default is POSTPAID_BY_HOUR. Note: TencentCloud International only supports POSTPAID_BY_HOUR and CDHPAID. PREPAID instance may not allow to delete before expired. SPOTPAID instance must set spot_instance_type and spot_max_price at the same time. CDHPAID instance must set cdh_instance_type and cdh_host_id.
instanceChargeTypePrepaidPeriod Double
The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when instance_charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60.
instanceChargeTypePrepaidRenewFlag String
Auto renewal flag. Valid values: NOTIFY_AND_AUTO_RENEW: notify upon expiration and renew automatically, NOTIFY_AND_MANUAL_RENEW: notify upon expiration but do not renew automatically, DISABLE_NOTIFY_AND_MANUAL_RENEW: neither notify upon expiration nor renew automatically. Default value: NOTIFY_AND_MANUAL_RENEW. If this parameter is specified as NOTIFY_AND_AUTO_RENEW, the instance will be automatically renewed on a monthly basis if the account balance is sufficient. NOTE: it only works when instance_charge_type is set to PREPAID.
instanceCount Double
It has been deprecated from version 1.59.18. Use built-in count instead. The number of instances to be purchased. Value range:[1,100]; default value: 1.

Deprecated: Deprecated

instanceId String
ID of the resource.
instanceName String
instanceType String
The type of the instance.
internetChargeType String
Internet charge type of the instance, Valid values are BANDWIDTH_PREPAID, TRAFFIC_POSTPAID_BY_HOUR, BANDWIDTH_POSTPAID_BY_HOUR and BANDWIDTH_PACKAGE. If not set, internet charge type are consistent with the cvm charge type by default. This value takes NO Effect when changing and does not need to be set when allocate_public_ip is false.
internetMaxBandwidthOut Double
Maximum outgoing bandwidth to the public network, measured in Mbps (Mega bits per second). This value does not need to be set when allocate_public_ip is false.
keepImageLogin Boolean
Whether to keep image login or not, default is false. When the image type is private or shared or imported, this parameter can be set true. Modifications may lead to the reinstallation of the instance's operating system..
keyIds List<String>
The key pair to use for the instance, it looks like skey-16jig7tx. Modifications may lead to the reinstallation of the instance's operating system.
keyName String
Please use key_ids instead. The key pair to use for the instance, it looks like skey-16jig7tx. Modifications may lead to the reinstallation of the instance's operating system.

Deprecated: Deprecated

orderlySecurityGroups List<String>
A list of orderly security group IDs to associate with.
password String
Password for the instance. In order for the new password to take effect, the instance will be restarted after the password change. Modifications may lead to the reinstallation of the instance's operating system.
placementGroupId String
The ID of a placement group.
privateIp String
The private IP to be assigned to this instance, must be in the provided subnet and available.
projectId Double
The project the instance belongs to, default to 0.
runningFlag Boolean
Set instance to running or stop. Default value is true, the instance will shutdown when this flag is false.
securityGroups List<String>
It will be deprecated. Use orderly_security_groups instead. A list of security group IDs to associate with.

Deprecated: Deprecated

spotInstanceType String
Type of spot instance, only support ONE-TIME now. Note: it only works when instance_charge_type is set to SPOTPAID.
spotMaxPrice String
Max price of a spot instance, is the format of decimal string, for example "0.50". Note: it only works when instance_charge_type is set to SPOTPAID.
stoppedMode String
Billing method of a pay-as-you-go instance after shutdown. Available values: KEEP_CHARGING,STOP_CHARGING. Default KEEP_CHARGING.
subnetId String
The ID of a VPC subnet. If you want to create instances in a VPC network, this parameter must be set.
systemDiskId String
System disk snapshot ID used to initialize the system disk. When system disk type is LOCAL_BASIC and LOCAL_SSD, disk id is not supported.
systemDiskName String
Name of the system disk.
systemDiskResizeOnline Boolean
Resize online.
systemDiskSize Double
Size of the system disk. unit is GB, Default is 50GB. If modified, the instance may force stop.
systemDiskType String
System disk type. For more information on limits of system disk types, see Storage Overview. Valid values: LOCAL_BASIC: local disk, LOCAL_SSD: local SSD disk, CLOUD_BASIC: cloud disk, CLOUD_SSD: cloud SSD disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_BSSD: Basic SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD. NOTE: If modified, the instance may force stop.
tags Map<String,String>
A mapping of tags to assign to the resource. For tag limits, please refer to Use Limits.
timeouts InstanceTimeouts
userData String
The user data to be injected into this instance. Must be base64 encoded and up to 16 KB.
userDataRaw String
The user data to be injected into this instance, in plain text. Conflicts with user_data. Up to 16 KB after base64 encoded.
vpcId String
The ID of a VPC network. If you want to create instances in a VPC network, this parameter must be set.
availabilityZone This property is required. string
The available zone for the CVM instance.
imageId This property is required. string
The image to use for the instance. Modifications may lead to the reinstallation of the instance's operating system..
allocatePublicIp boolean
Associate a public IP address with an instance in a VPC or Classic. Boolean value, Default is false.
bandwidthPackageId string
bandwidth package id. if user is standard user, then the bandwidth_package_id is needed, or default has bandwidth_package_id.
camRoleName string
CAM role name authorized to access.
cdhHostId string
Id of cdh instance. Note: it only works when instance_charge_type is set to CDHPAID.
cdhInstanceType string
Type of instance created on cdh, the value of this parameter is in the format of CDH_XCXG based on the number of CPU cores and memory capacity. Note: it only works when instance_charge_type is set to CDHPAID.
dataDisks InstanceDataDisk[]
Settings for data disks.
dedicatedClusterId string
Exclusive cluster id.
disableApiTermination boolean
Whether the termination protection is enabled. Default is false. If set true, which means that this instance can not be deleted by an API action.
disableAutomationService boolean
Disable enhance service for automation, it is enabled by default. When this options is set, monitor agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
disableMonitorService boolean
Disable enhance service for monitor, it is enabled by default. When this options is set, monitor agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
disableSecurityService boolean
Disable enhance service for security, it is enabled by default. When this options is set, security agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
forceDelete boolean
Indicate whether to force delete the instance. Default is false. If set true, the instance will be permanently deleted instead of being moved into the recycle bin. Note: only works for PREPAID instance.
hostname string
The hostname of the instance. Windows instance: The name should be a combination of 2 to 15 characters comprised of letters (case insensitive), numbers, and hyphens (-). Period (.) is not supported, and the name cannot be a string of pure numbers. Other types (such as Linux) of instances: The name should be a combination of 2 to 60 characters, supporting multiple periods (.). The piece between two periods is composed of letters (case insensitive), numbers, and hyphens (-). Modifications may lead to the reinstallation of the instance's operating system.
hpcClusterId string
High-performance computing cluster ID. If the instance created is a high-performance computing instance, you need to specify the cluster in which the instance is placed, otherwise it cannot be specified.
instanceChargeType string
The charge type of instance. Valid values are PREPAID, POSTPAID_BY_HOUR, SPOTPAID, CDHPAID and CDCPAID. The default is POSTPAID_BY_HOUR. Note: TencentCloud International only supports POSTPAID_BY_HOUR and CDHPAID. PREPAID instance may not allow to delete before expired. SPOTPAID instance must set spot_instance_type and spot_max_price at the same time. CDHPAID instance must set cdh_instance_type and cdh_host_id.
instanceChargeTypePrepaidPeriod number
The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when instance_charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60.
instanceChargeTypePrepaidRenewFlag string
Auto renewal flag. Valid values: NOTIFY_AND_AUTO_RENEW: notify upon expiration and renew automatically, NOTIFY_AND_MANUAL_RENEW: notify upon expiration but do not renew automatically, DISABLE_NOTIFY_AND_MANUAL_RENEW: neither notify upon expiration nor renew automatically. Default value: NOTIFY_AND_MANUAL_RENEW. If this parameter is specified as NOTIFY_AND_AUTO_RENEW, the instance will be automatically renewed on a monthly basis if the account balance is sufficient. NOTE: it only works when instance_charge_type is set to PREPAID.
instanceCount number
It has been deprecated from version 1.59.18. Use built-in count instead. The number of instances to be purchased. Value range:[1,100]; default value: 1.

Deprecated: Deprecated

instanceId string
ID of the resource.
instanceName string
instanceType string
The type of the instance.
internetChargeType string
Internet charge type of the instance, Valid values are BANDWIDTH_PREPAID, TRAFFIC_POSTPAID_BY_HOUR, BANDWIDTH_POSTPAID_BY_HOUR and BANDWIDTH_PACKAGE. If not set, internet charge type are consistent with the cvm charge type by default. This value takes NO Effect when changing and does not need to be set when allocate_public_ip is false.
internetMaxBandwidthOut number
Maximum outgoing bandwidth to the public network, measured in Mbps (Mega bits per second). This value does not need to be set when allocate_public_ip is false.
keepImageLogin boolean
Whether to keep image login or not, default is false. When the image type is private or shared or imported, this parameter can be set true. Modifications may lead to the reinstallation of the instance's operating system..
keyIds string[]
The key pair to use for the instance, it looks like skey-16jig7tx. Modifications may lead to the reinstallation of the instance's operating system.
keyName string
Please use key_ids instead. The key pair to use for the instance, it looks like skey-16jig7tx. Modifications may lead to the reinstallation of the instance's operating system.

Deprecated: Deprecated

orderlySecurityGroups string[]
A list of orderly security group IDs to associate with.
password string
Password for the instance. In order for the new password to take effect, the instance will be restarted after the password change. Modifications may lead to the reinstallation of the instance's operating system.
placementGroupId string
The ID of a placement group.
privateIp string
The private IP to be assigned to this instance, must be in the provided subnet and available.
projectId number
The project the instance belongs to, default to 0.
runningFlag boolean
Set instance to running or stop. Default value is true, the instance will shutdown when this flag is false.
securityGroups string[]
It will be deprecated. Use orderly_security_groups instead. A list of security group IDs to associate with.

Deprecated: Deprecated

spotInstanceType string
Type of spot instance, only support ONE-TIME now. Note: it only works when instance_charge_type is set to SPOTPAID.
spotMaxPrice string
Max price of a spot instance, is the format of decimal string, for example "0.50". Note: it only works when instance_charge_type is set to SPOTPAID.
stoppedMode string
Billing method of a pay-as-you-go instance after shutdown. Available values: KEEP_CHARGING,STOP_CHARGING. Default KEEP_CHARGING.
subnetId string
The ID of a VPC subnet. If you want to create instances in a VPC network, this parameter must be set.
systemDiskId string
System disk snapshot ID used to initialize the system disk. When system disk type is LOCAL_BASIC and LOCAL_SSD, disk id is not supported.
systemDiskName string
Name of the system disk.
systemDiskResizeOnline boolean
Resize online.
systemDiskSize number
Size of the system disk. unit is GB, Default is 50GB. If modified, the instance may force stop.
systemDiskType string
System disk type. For more information on limits of system disk types, see Storage Overview. Valid values: LOCAL_BASIC: local disk, LOCAL_SSD: local SSD disk, CLOUD_BASIC: cloud disk, CLOUD_SSD: cloud SSD disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_BSSD: Basic SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD. NOTE: If modified, the instance may force stop.
tags {[key: string]: string}
A mapping of tags to assign to the resource. For tag limits, please refer to Use Limits.
timeouts InstanceTimeouts
userData string
The user data to be injected into this instance. Must be base64 encoded and up to 16 KB.
userDataRaw string
The user data to be injected into this instance, in plain text. Conflicts with user_data. Up to 16 KB after base64 encoded.
vpcId string
The ID of a VPC network. If you want to create instances in a VPC network, this parameter must be set.
availability_zone This property is required. str
The available zone for the CVM instance.
image_id This property is required. str
The image to use for the instance. Modifications may lead to the reinstallation of the instance's operating system..
allocate_public_ip bool
Associate a public IP address with an instance in a VPC or Classic. Boolean value, Default is false.
bandwidth_package_id str
bandwidth package id. if user is standard user, then the bandwidth_package_id is needed, or default has bandwidth_package_id.
cam_role_name str
CAM role name authorized to access.
cdh_host_id str
Id of cdh instance. Note: it only works when instance_charge_type is set to CDHPAID.
cdh_instance_type str
Type of instance created on cdh, the value of this parameter is in the format of CDH_XCXG based on the number of CPU cores and memory capacity. Note: it only works when instance_charge_type is set to CDHPAID.
data_disks Sequence[InstanceDataDiskArgs]
Settings for data disks.
dedicated_cluster_id str
Exclusive cluster id.
disable_api_termination bool
Whether the termination protection is enabled. Default is false. If set true, which means that this instance can not be deleted by an API action.
disable_automation_service bool
Disable enhance service for automation, it is enabled by default. When this options is set, monitor agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
disable_monitor_service bool
Disable enhance service for monitor, it is enabled by default. When this options is set, monitor agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
disable_security_service bool
Disable enhance service for security, it is enabled by default. When this options is set, security agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
force_delete bool
Indicate whether to force delete the instance. Default is false. If set true, the instance will be permanently deleted instead of being moved into the recycle bin. Note: only works for PREPAID instance.
hostname str
The hostname of the instance. Windows instance: The name should be a combination of 2 to 15 characters comprised of letters (case insensitive), numbers, and hyphens (-). Period (.) is not supported, and the name cannot be a string of pure numbers. Other types (such as Linux) of instances: The name should be a combination of 2 to 60 characters, supporting multiple periods (.). The piece between two periods is composed of letters (case insensitive), numbers, and hyphens (-). Modifications may lead to the reinstallation of the instance's operating system.
hpc_cluster_id str
High-performance computing cluster ID. If the instance created is a high-performance computing instance, you need to specify the cluster in which the instance is placed, otherwise it cannot be specified.
instance_charge_type str
The charge type of instance. Valid values are PREPAID, POSTPAID_BY_HOUR, SPOTPAID, CDHPAID and CDCPAID. The default is POSTPAID_BY_HOUR. Note: TencentCloud International only supports POSTPAID_BY_HOUR and CDHPAID. PREPAID instance may not allow to delete before expired. SPOTPAID instance must set spot_instance_type and spot_max_price at the same time. CDHPAID instance must set cdh_instance_type and cdh_host_id.
instance_charge_type_prepaid_period float
The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when instance_charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60.
instance_charge_type_prepaid_renew_flag str
Auto renewal flag. Valid values: NOTIFY_AND_AUTO_RENEW: notify upon expiration and renew automatically, NOTIFY_AND_MANUAL_RENEW: notify upon expiration but do not renew automatically, DISABLE_NOTIFY_AND_MANUAL_RENEW: neither notify upon expiration nor renew automatically. Default value: NOTIFY_AND_MANUAL_RENEW. If this parameter is specified as NOTIFY_AND_AUTO_RENEW, the instance will be automatically renewed on a monthly basis if the account balance is sufficient. NOTE: it only works when instance_charge_type is set to PREPAID.
instance_count float
It has been deprecated from version 1.59.18. Use built-in count instead. The number of instances to be purchased. Value range:[1,100]; default value: 1.

Deprecated: Deprecated

instance_id str
ID of the resource.
instance_name str
instance_type str
The type of the instance.
internet_charge_type str
Internet charge type of the instance, Valid values are BANDWIDTH_PREPAID, TRAFFIC_POSTPAID_BY_HOUR, BANDWIDTH_POSTPAID_BY_HOUR and BANDWIDTH_PACKAGE. If not set, internet charge type are consistent with the cvm charge type by default. This value takes NO Effect when changing and does not need to be set when allocate_public_ip is false.
internet_max_bandwidth_out float
Maximum outgoing bandwidth to the public network, measured in Mbps (Mega bits per second). This value does not need to be set when allocate_public_ip is false.
keep_image_login bool
Whether to keep image login or not, default is false. When the image type is private or shared or imported, this parameter can be set true. Modifications may lead to the reinstallation of the instance's operating system..
key_ids Sequence[str]
The key pair to use for the instance, it looks like skey-16jig7tx. Modifications may lead to the reinstallation of the instance's operating system.
key_name str
Please use key_ids instead. The key pair to use for the instance, it looks like skey-16jig7tx. Modifications may lead to the reinstallation of the instance's operating system.

Deprecated: Deprecated

orderly_security_groups Sequence[str]
A list of orderly security group IDs to associate with.
password str
Password for the instance. In order for the new password to take effect, the instance will be restarted after the password change. Modifications may lead to the reinstallation of the instance's operating system.
placement_group_id str
The ID of a placement group.
private_ip str
The private IP to be assigned to this instance, must be in the provided subnet and available.
project_id float
The project the instance belongs to, default to 0.
running_flag bool
Set instance to running or stop. Default value is true, the instance will shutdown when this flag is false.
security_groups Sequence[str]
It will be deprecated. Use orderly_security_groups instead. A list of security group IDs to associate with.

Deprecated: Deprecated

spot_instance_type str
Type of spot instance, only support ONE-TIME now. Note: it only works when instance_charge_type is set to SPOTPAID.
spot_max_price str
Max price of a spot instance, is the format of decimal string, for example "0.50". Note: it only works when instance_charge_type is set to SPOTPAID.
stopped_mode str
Billing method of a pay-as-you-go instance after shutdown. Available values: KEEP_CHARGING,STOP_CHARGING. Default KEEP_CHARGING.
subnet_id str
The ID of a VPC subnet. If you want to create instances in a VPC network, this parameter must be set.
system_disk_id str
System disk snapshot ID used to initialize the system disk. When system disk type is LOCAL_BASIC and LOCAL_SSD, disk id is not supported.
system_disk_name str
Name of the system disk.
system_disk_resize_online bool
Resize online.
system_disk_size float
Size of the system disk. unit is GB, Default is 50GB. If modified, the instance may force stop.
system_disk_type str
System disk type. For more information on limits of system disk types, see Storage Overview. Valid values: LOCAL_BASIC: local disk, LOCAL_SSD: local SSD disk, CLOUD_BASIC: cloud disk, CLOUD_SSD: cloud SSD disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_BSSD: Basic SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD. NOTE: If modified, the instance may force stop.
tags Mapping[str, str]
A mapping of tags to assign to the resource. For tag limits, please refer to Use Limits.
timeouts InstanceTimeoutsArgs
user_data str
The user data to be injected into this instance. Must be base64 encoded and up to 16 KB.
user_data_raw str
The user data to be injected into this instance, in plain text. Conflicts with user_data. Up to 16 KB after base64 encoded.
vpc_id str
The ID of a VPC network. If you want to create instances in a VPC network, this parameter must be set.
availabilityZone This property is required. String
The available zone for the CVM instance.
imageId This property is required. String
The image to use for the instance. Modifications may lead to the reinstallation of the instance's operating system..
allocatePublicIp Boolean
Associate a public IP address with an instance in a VPC or Classic. Boolean value, Default is false.
bandwidthPackageId String
bandwidth package id. if user is standard user, then the bandwidth_package_id is needed, or default has bandwidth_package_id.
camRoleName String
CAM role name authorized to access.
cdhHostId String
Id of cdh instance. Note: it only works when instance_charge_type is set to CDHPAID.
cdhInstanceType String
Type of instance created on cdh, the value of this parameter is in the format of CDH_XCXG based on the number of CPU cores and memory capacity. Note: it only works when instance_charge_type is set to CDHPAID.
dataDisks List<Property Map>
Settings for data disks.
dedicatedClusterId String
Exclusive cluster id.
disableApiTermination Boolean
Whether the termination protection is enabled. Default is false. If set true, which means that this instance can not be deleted by an API action.
disableAutomationService Boolean
Disable enhance service for automation, it is enabled by default. When this options is set, monitor agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
disableMonitorService Boolean
Disable enhance service for monitor, it is enabled by default. When this options is set, monitor agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
disableSecurityService Boolean
Disable enhance service for security, it is enabled by default. When this options is set, security agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
forceDelete Boolean
Indicate whether to force delete the instance. Default is false. If set true, the instance will be permanently deleted instead of being moved into the recycle bin. Note: only works for PREPAID instance.
hostname String
The hostname of the instance. Windows instance: The name should be a combination of 2 to 15 characters comprised of letters (case insensitive), numbers, and hyphens (-). Period (.) is not supported, and the name cannot be a string of pure numbers. Other types (such as Linux) of instances: The name should be a combination of 2 to 60 characters, supporting multiple periods (.). The piece between two periods is composed of letters (case insensitive), numbers, and hyphens (-). Modifications may lead to the reinstallation of the instance's operating system.
hpcClusterId String
High-performance computing cluster ID. If the instance created is a high-performance computing instance, you need to specify the cluster in which the instance is placed, otherwise it cannot be specified.
instanceChargeType String
The charge type of instance. Valid values are PREPAID, POSTPAID_BY_HOUR, SPOTPAID, CDHPAID and CDCPAID. The default is POSTPAID_BY_HOUR. Note: TencentCloud International only supports POSTPAID_BY_HOUR and CDHPAID. PREPAID instance may not allow to delete before expired. SPOTPAID instance must set spot_instance_type and spot_max_price at the same time. CDHPAID instance must set cdh_instance_type and cdh_host_id.
instanceChargeTypePrepaidPeriod Number
The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when instance_charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60.
instanceChargeTypePrepaidRenewFlag String
Auto renewal flag. Valid values: NOTIFY_AND_AUTO_RENEW: notify upon expiration and renew automatically, NOTIFY_AND_MANUAL_RENEW: notify upon expiration but do not renew automatically, DISABLE_NOTIFY_AND_MANUAL_RENEW: neither notify upon expiration nor renew automatically. Default value: NOTIFY_AND_MANUAL_RENEW. If this parameter is specified as NOTIFY_AND_AUTO_RENEW, the instance will be automatically renewed on a monthly basis if the account balance is sufficient. NOTE: it only works when instance_charge_type is set to PREPAID.
instanceCount Number
It has been deprecated from version 1.59.18. Use built-in count instead. The number of instances to be purchased. Value range:[1,100]; default value: 1.

Deprecated: Deprecated

instanceId String
ID of the resource.
instanceName String
instanceType String
The type of the instance.
internetChargeType String
Internet charge type of the instance, Valid values are BANDWIDTH_PREPAID, TRAFFIC_POSTPAID_BY_HOUR, BANDWIDTH_POSTPAID_BY_HOUR and BANDWIDTH_PACKAGE. If not set, internet charge type are consistent with the cvm charge type by default. This value takes NO Effect when changing and does not need to be set when allocate_public_ip is false.
internetMaxBandwidthOut Number
Maximum outgoing bandwidth to the public network, measured in Mbps (Mega bits per second). This value does not need to be set when allocate_public_ip is false.
keepImageLogin Boolean
Whether to keep image login or not, default is false. When the image type is private or shared or imported, this parameter can be set true. Modifications may lead to the reinstallation of the instance's operating system..
keyIds List<String>
The key pair to use for the instance, it looks like skey-16jig7tx. Modifications may lead to the reinstallation of the instance's operating system.
keyName String
Please use key_ids instead. The key pair to use for the instance, it looks like skey-16jig7tx. Modifications may lead to the reinstallation of the instance's operating system.

Deprecated: Deprecated

orderlySecurityGroups List<String>
A list of orderly security group IDs to associate with.
password String
Password for the instance. In order for the new password to take effect, the instance will be restarted after the password change. Modifications may lead to the reinstallation of the instance's operating system.
placementGroupId String
The ID of a placement group.
privateIp String
The private IP to be assigned to this instance, must be in the provided subnet and available.
projectId Number
The project the instance belongs to, default to 0.
runningFlag Boolean
Set instance to running or stop. Default value is true, the instance will shutdown when this flag is false.
securityGroups List<String>
It will be deprecated. Use orderly_security_groups instead. A list of security group IDs to associate with.

Deprecated: Deprecated

spotInstanceType String
Type of spot instance, only support ONE-TIME now. Note: it only works when instance_charge_type is set to SPOTPAID.
spotMaxPrice String
Max price of a spot instance, is the format of decimal string, for example "0.50". Note: it only works when instance_charge_type is set to SPOTPAID.
stoppedMode String
Billing method of a pay-as-you-go instance after shutdown. Available values: KEEP_CHARGING,STOP_CHARGING. Default KEEP_CHARGING.
subnetId String
The ID of a VPC subnet. If you want to create instances in a VPC network, this parameter must be set.
systemDiskId String
System disk snapshot ID used to initialize the system disk. When system disk type is LOCAL_BASIC and LOCAL_SSD, disk id is not supported.
systemDiskName String
Name of the system disk.
systemDiskResizeOnline Boolean
Resize online.
systemDiskSize Number
Size of the system disk. unit is GB, Default is 50GB. If modified, the instance may force stop.
systemDiskType String
System disk type. For more information on limits of system disk types, see Storage Overview. Valid values: LOCAL_BASIC: local disk, LOCAL_SSD: local SSD disk, CLOUD_BASIC: cloud disk, CLOUD_SSD: cloud SSD disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_BSSD: Basic SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD. NOTE: If modified, the instance may force stop.
tags Map<String>
A mapping of tags to assign to the resource. For tag limits, please refer to Use Limits.
timeouts Property Map
userData String
The user data to be injected into this instance. Must be base64 encoded and up to 16 KB.
userDataRaw String
The user data to be injected into this instance, in plain text. Conflicts with user_data. Up to 16 KB after base64 encoded.
vpcId String
The ID of a VPC network. If you want to create instances in a VPC network, this parameter must be set.

Outputs

All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:

Cpu double
The number of CPU cores of the instance.
CreateTime string
Create time of the instance.
ExpiredTime string
Expired time of the instance.
Id string
The provider-assigned unique ID for this managed resource.
InstanceStatus string
Current status of the instance.
Memory double
Instance memory capacity, unit in GB.
OsName string
Instance os name.
PublicIp string
Public IP of the instance.
Uuid string
Globally unique ID of the instance.
Cpu float64
The number of CPU cores of the instance.
CreateTime string
Create time of the instance.
ExpiredTime string
Expired time of the instance.
Id string
The provider-assigned unique ID for this managed resource.
InstanceStatus string
Current status of the instance.
Memory float64
Instance memory capacity, unit in GB.
OsName string
Instance os name.
PublicIp string
Public IP of the instance.
Uuid string
Globally unique ID of the instance.
cpu Double
The number of CPU cores of the instance.
createTime String
Create time of the instance.
expiredTime String
Expired time of the instance.
id String
The provider-assigned unique ID for this managed resource.
instanceStatus String
Current status of the instance.
memory Double
Instance memory capacity, unit in GB.
osName String
Instance os name.
publicIp String
Public IP of the instance.
uuid String
Globally unique ID of the instance.
cpu number
The number of CPU cores of the instance.
createTime string
Create time of the instance.
expiredTime string
Expired time of the instance.
id string
The provider-assigned unique ID for this managed resource.
instanceStatus string
Current status of the instance.
memory number
Instance memory capacity, unit in GB.
osName string
Instance os name.
publicIp string
Public IP of the instance.
uuid string
Globally unique ID of the instance.
cpu float
The number of CPU cores of the instance.
create_time str
Create time of the instance.
expired_time str
Expired time of the instance.
id str
The provider-assigned unique ID for this managed resource.
instance_status str
Current status of the instance.
memory float
Instance memory capacity, unit in GB.
os_name str
Instance os name.
public_ip str
Public IP of the instance.
uuid str
Globally unique ID of the instance.
cpu Number
The number of CPU cores of the instance.
createTime String
Create time of the instance.
expiredTime String
Expired time of the instance.
id String
The provider-assigned unique ID for this managed resource.
instanceStatus String
Current status of the instance.
memory Number
Instance memory capacity, unit in GB.
osName String
Instance os name.
publicIp String
Public IP of the instance.
uuid String
Globally unique ID of the instance.

Look up Existing Instance Resource

Get an existing Instance 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?: InstanceState, opts?: CustomResourceOptions): Instance
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allocate_public_ip: Optional[bool] = None,
        availability_zone: Optional[str] = None,
        bandwidth_package_id: Optional[str] = None,
        cam_role_name: Optional[str] = None,
        cdh_host_id: Optional[str] = None,
        cdh_instance_type: Optional[str] = None,
        cpu: Optional[float] = None,
        create_time: Optional[str] = None,
        data_disks: Optional[Sequence[InstanceDataDiskArgs]] = None,
        dedicated_cluster_id: Optional[str] = None,
        disable_api_termination: Optional[bool] = None,
        disable_automation_service: Optional[bool] = None,
        disable_monitor_service: Optional[bool] = None,
        disable_security_service: Optional[bool] = None,
        expired_time: Optional[str] = None,
        force_delete: Optional[bool] = None,
        hostname: Optional[str] = None,
        hpc_cluster_id: Optional[str] = None,
        image_id: Optional[str] = None,
        instance_charge_type: Optional[str] = None,
        instance_charge_type_prepaid_period: Optional[float] = None,
        instance_charge_type_prepaid_renew_flag: Optional[str] = None,
        instance_count: Optional[float] = None,
        instance_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        instance_status: Optional[str] = None,
        instance_type: Optional[str] = None,
        internet_charge_type: Optional[str] = None,
        internet_max_bandwidth_out: Optional[float] = None,
        keep_image_login: Optional[bool] = None,
        key_ids: Optional[Sequence[str]] = None,
        key_name: Optional[str] = None,
        memory: Optional[float] = None,
        orderly_security_groups: Optional[Sequence[str]] = None,
        os_name: Optional[str] = None,
        password: Optional[str] = None,
        placement_group_id: Optional[str] = None,
        private_ip: Optional[str] = None,
        project_id: Optional[float] = None,
        public_ip: Optional[str] = None,
        running_flag: Optional[bool] = None,
        security_groups: Optional[Sequence[str]] = None,
        spot_instance_type: Optional[str] = None,
        spot_max_price: Optional[str] = None,
        stopped_mode: Optional[str] = None,
        subnet_id: Optional[str] = None,
        system_disk_id: Optional[str] = None,
        system_disk_name: Optional[str] = None,
        system_disk_resize_online: Optional[bool] = None,
        system_disk_size: Optional[float] = None,
        system_disk_type: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        timeouts: Optional[InstanceTimeoutsArgs] = None,
        user_data: Optional[str] = None,
        user_data_raw: Optional[str] = None,
        uuid: Optional[str] = None,
        vpc_id: Optional[str] = None) -> Instance
func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
resources:  _:    type: tencentcloud:Instance    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
The following state arguments are supported:
AllocatePublicIp bool
Associate a public IP address with an instance in a VPC or Classic. Boolean value, Default is false.
AvailabilityZone string
The available zone for the CVM instance.
BandwidthPackageId string
bandwidth package id. if user is standard user, then the bandwidth_package_id is needed, or default has bandwidth_package_id.
CamRoleName string
CAM role name authorized to access.
CdhHostId string
Id of cdh instance. Note: it only works when instance_charge_type is set to CDHPAID.
CdhInstanceType string
Type of instance created on cdh, the value of this parameter is in the format of CDH_XCXG based on the number of CPU cores and memory capacity. Note: it only works when instance_charge_type is set to CDHPAID.
Cpu double
The number of CPU cores of the instance.
CreateTime string
Create time of the instance.
DataDisks List<InstanceDataDisk>
Settings for data disks.
DedicatedClusterId string
Exclusive cluster id.
DisableApiTermination bool
Whether the termination protection is enabled. Default is false. If set true, which means that this instance can not be deleted by an API action.
DisableAutomationService bool
Disable enhance service for automation, it is enabled by default. When this options is set, monitor agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
DisableMonitorService bool
Disable enhance service for monitor, it is enabled by default. When this options is set, monitor agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
DisableSecurityService bool
Disable enhance service for security, it is enabled by default. When this options is set, security agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
ExpiredTime string
Expired time of the instance.
ForceDelete bool
Indicate whether to force delete the instance. Default is false. If set true, the instance will be permanently deleted instead of being moved into the recycle bin. Note: only works for PREPAID instance.
Hostname string
The hostname of the instance. Windows instance: The name should be a combination of 2 to 15 characters comprised of letters (case insensitive), numbers, and hyphens (-). Period (.) is not supported, and the name cannot be a string of pure numbers. Other types (such as Linux) of instances: The name should be a combination of 2 to 60 characters, supporting multiple periods (.). The piece between two periods is composed of letters (case insensitive), numbers, and hyphens (-). Modifications may lead to the reinstallation of the instance's operating system.
HpcClusterId string
High-performance computing cluster ID. If the instance created is a high-performance computing instance, you need to specify the cluster in which the instance is placed, otherwise it cannot be specified.
ImageId string
The image to use for the instance. Modifications may lead to the reinstallation of the instance's operating system..
InstanceChargeType string
The charge type of instance. Valid values are PREPAID, POSTPAID_BY_HOUR, SPOTPAID, CDHPAID and CDCPAID. The default is POSTPAID_BY_HOUR. Note: TencentCloud International only supports POSTPAID_BY_HOUR and CDHPAID. PREPAID instance may not allow to delete before expired. SPOTPAID instance must set spot_instance_type and spot_max_price at the same time. CDHPAID instance must set cdh_instance_type and cdh_host_id.
InstanceChargeTypePrepaidPeriod double
The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when instance_charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60.
InstanceChargeTypePrepaidRenewFlag string
Auto renewal flag. Valid values: NOTIFY_AND_AUTO_RENEW: notify upon expiration and renew automatically, NOTIFY_AND_MANUAL_RENEW: notify upon expiration but do not renew automatically, DISABLE_NOTIFY_AND_MANUAL_RENEW: neither notify upon expiration nor renew automatically. Default value: NOTIFY_AND_MANUAL_RENEW. If this parameter is specified as NOTIFY_AND_AUTO_RENEW, the instance will be automatically renewed on a monthly basis if the account balance is sufficient. NOTE: it only works when instance_charge_type is set to PREPAID.
InstanceCount double
It has been deprecated from version 1.59.18. Use built-in count instead. The number of instances to be purchased. Value range:[1,100]; default value: 1.

Deprecated: Deprecated

InstanceId string
ID of the resource.
InstanceName string
InstanceStatus string
Current status of the instance.
InstanceType string
The type of the instance.
InternetChargeType string
Internet charge type of the instance, Valid values are BANDWIDTH_PREPAID, TRAFFIC_POSTPAID_BY_HOUR, BANDWIDTH_POSTPAID_BY_HOUR and BANDWIDTH_PACKAGE. If not set, internet charge type are consistent with the cvm charge type by default. This value takes NO Effect when changing and does not need to be set when allocate_public_ip is false.
InternetMaxBandwidthOut double
Maximum outgoing bandwidth to the public network, measured in Mbps (Mega bits per second). This value does not need to be set when allocate_public_ip is false.
KeepImageLogin bool
Whether to keep image login or not, default is false. When the image type is private or shared or imported, this parameter can be set true. Modifications may lead to the reinstallation of the instance's operating system..
KeyIds List<string>
The key pair to use for the instance, it looks like skey-16jig7tx. Modifications may lead to the reinstallation of the instance's operating system.
KeyName string
Please use key_ids instead. The key pair to use for the instance, it looks like skey-16jig7tx. Modifications may lead to the reinstallation of the instance's operating system.

Deprecated: Deprecated

Memory double
Instance memory capacity, unit in GB.
OrderlySecurityGroups List<string>
A list of orderly security group IDs to associate with.
OsName string
Instance os name.
Password string
Password for the instance. In order for the new password to take effect, the instance will be restarted after the password change. Modifications may lead to the reinstallation of the instance's operating system.
PlacementGroupId string
The ID of a placement group.
PrivateIp string
The private IP to be assigned to this instance, must be in the provided subnet and available.
ProjectId double
The project the instance belongs to, default to 0.
PublicIp string
Public IP of the instance.
RunningFlag bool
Set instance to running or stop. Default value is true, the instance will shutdown when this flag is false.
SecurityGroups List<string>
It will be deprecated. Use orderly_security_groups instead. A list of security group IDs to associate with.

Deprecated: Deprecated

SpotInstanceType string
Type of spot instance, only support ONE-TIME now. Note: it only works when instance_charge_type is set to SPOTPAID.
SpotMaxPrice string
Max price of a spot instance, is the format of decimal string, for example "0.50". Note: it only works when instance_charge_type is set to SPOTPAID.
StoppedMode string
Billing method of a pay-as-you-go instance after shutdown. Available values: KEEP_CHARGING,STOP_CHARGING. Default KEEP_CHARGING.
SubnetId string
The ID of a VPC subnet. If you want to create instances in a VPC network, this parameter must be set.
SystemDiskId string
System disk snapshot ID used to initialize the system disk. When system disk type is LOCAL_BASIC and LOCAL_SSD, disk id is not supported.
SystemDiskName string
Name of the system disk.
SystemDiskResizeOnline bool
Resize online.
SystemDiskSize double
Size of the system disk. unit is GB, Default is 50GB. If modified, the instance may force stop.
SystemDiskType string
System disk type. For more information on limits of system disk types, see Storage Overview. Valid values: LOCAL_BASIC: local disk, LOCAL_SSD: local SSD disk, CLOUD_BASIC: cloud disk, CLOUD_SSD: cloud SSD disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_BSSD: Basic SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD. NOTE: If modified, the instance may force stop.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource. For tag limits, please refer to Use Limits.
Timeouts InstanceTimeouts
UserData string
The user data to be injected into this instance. Must be base64 encoded and up to 16 KB.
UserDataRaw string
The user data to be injected into this instance, in plain text. Conflicts with user_data. Up to 16 KB after base64 encoded.
Uuid string
Globally unique ID of the instance.
VpcId string
The ID of a VPC network. If you want to create instances in a VPC network, this parameter must be set.
AllocatePublicIp bool
Associate a public IP address with an instance in a VPC or Classic. Boolean value, Default is false.
AvailabilityZone string
The available zone for the CVM instance.
BandwidthPackageId string
bandwidth package id. if user is standard user, then the bandwidth_package_id is needed, or default has bandwidth_package_id.
CamRoleName string
CAM role name authorized to access.
CdhHostId string
Id of cdh instance. Note: it only works when instance_charge_type is set to CDHPAID.
CdhInstanceType string
Type of instance created on cdh, the value of this parameter is in the format of CDH_XCXG based on the number of CPU cores and memory capacity. Note: it only works when instance_charge_type is set to CDHPAID.
Cpu float64
The number of CPU cores of the instance.
CreateTime string
Create time of the instance.
DataDisks []InstanceDataDiskArgs
Settings for data disks.
DedicatedClusterId string
Exclusive cluster id.
DisableApiTermination bool
Whether the termination protection is enabled. Default is false. If set true, which means that this instance can not be deleted by an API action.
DisableAutomationService bool
Disable enhance service for automation, it is enabled by default. When this options is set, monitor agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
DisableMonitorService bool
Disable enhance service for monitor, it is enabled by default. When this options is set, monitor agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
DisableSecurityService bool
Disable enhance service for security, it is enabled by default. When this options is set, security agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
ExpiredTime string
Expired time of the instance.
ForceDelete bool
Indicate whether to force delete the instance. Default is false. If set true, the instance will be permanently deleted instead of being moved into the recycle bin. Note: only works for PREPAID instance.
Hostname string
The hostname of the instance. Windows instance: The name should be a combination of 2 to 15 characters comprised of letters (case insensitive), numbers, and hyphens (-). Period (.) is not supported, and the name cannot be a string of pure numbers. Other types (such as Linux) of instances: The name should be a combination of 2 to 60 characters, supporting multiple periods (.). The piece between two periods is composed of letters (case insensitive), numbers, and hyphens (-). Modifications may lead to the reinstallation of the instance's operating system.
HpcClusterId string
High-performance computing cluster ID. If the instance created is a high-performance computing instance, you need to specify the cluster in which the instance is placed, otherwise it cannot be specified.
ImageId string
The image to use for the instance. Modifications may lead to the reinstallation of the instance's operating system..
InstanceChargeType string
The charge type of instance. Valid values are PREPAID, POSTPAID_BY_HOUR, SPOTPAID, CDHPAID and CDCPAID. The default is POSTPAID_BY_HOUR. Note: TencentCloud International only supports POSTPAID_BY_HOUR and CDHPAID. PREPAID instance may not allow to delete before expired. SPOTPAID instance must set spot_instance_type and spot_max_price at the same time. CDHPAID instance must set cdh_instance_type and cdh_host_id.
InstanceChargeTypePrepaidPeriod float64
The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when instance_charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60.
InstanceChargeTypePrepaidRenewFlag string
Auto renewal flag. Valid values: NOTIFY_AND_AUTO_RENEW: notify upon expiration and renew automatically, NOTIFY_AND_MANUAL_RENEW: notify upon expiration but do not renew automatically, DISABLE_NOTIFY_AND_MANUAL_RENEW: neither notify upon expiration nor renew automatically. Default value: NOTIFY_AND_MANUAL_RENEW. If this parameter is specified as NOTIFY_AND_AUTO_RENEW, the instance will be automatically renewed on a monthly basis if the account balance is sufficient. NOTE: it only works when instance_charge_type is set to PREPAID.
InstanceCount float64
It has been deprecated from version 1.59.18. Use built-in count instead. The number of instances to be purchased. Value range:[1,100]; default value: 1.

Deprecated: Deprecated

InstanceId string
ID of the resource.
InstanceName string
InstanceStatus string
Current status of the instance.
InstanceType string
The type of the instance.
InternetChargeType string
Internet charge type of the instance, Valid values are BANDWIDTH_PREPAID, TRAFFIC_POSTPAID_BY_HOUR, BANDWIDTH_POSTPAID_BY_HOUR and BANDWIDTH_PACKAGE. If not set, internet charge type are consistent with the cvm charge type by default. This value takes NO Effect when changing and does not need to be set when allocate_public_ip is false.
InternetMaxBandwidthOut float64
Maximum outgoing bandwidth to the public network, measured in Mbps (Mega bits per second). This value does not need to be set when allocate_public_ip is false.
KeepImageLogin bool
Whether to keep image login or not, default is false. When the image type is private or shared or imported, this parameter can be set true. Modifications may lead to the reinstallation of the instance's operating system..
KeyIds []string
The key pair to use for the instance, it looks like skey-16jig7tx. Modifications may lead to the reinstallation of the instance's operating system.
KeyName string
Please use key_ids instead. The key pair to use for the instance, it looks like skey-16jig7tx. Modifications may lead to the reinstallation of the instance's operating system.

Deprecated: Deprecated

Memory float64
Instance memory capacity, unit in GB.
OrderlySecurityGroups []string
A list of orderly security group IDs to associate with.
OsName string
Instance os name.
Password string
Password for the instance. In order for the new password to take effect, the instance will be restarted after the password change. Modifications may lead to the reinstallation of the instance's operating system.
PlacementGroupId string
The ID of a placement group.
PrivateIp string
The private IP to be assigned to this instance, must be in the provided subnet and available.
ProjectId float64
The project the instance belongs to, default to 0.
PublicIp string
Public IP of the instance.
RunningFlag bool
Set instance to running or stop. Default value is true, the instance will shutdown when this flag is false.
SecurityGroups []string
It will be deprecated. Use orderly_security_groups instead. A list of security group IDs to associate with.

Deprecated: Deprecated

SpotInstanceType string
Type of spot instance, only support ONE-TIME now. Note: it only works when instance_charge_type is set to SPOTPAID.
SpotMaxPrice string
Max price of a spot instance, is the format of decimal string, for example "0.50". Note: it only works when instance_charge_type is set to SPOTPAID.
StoppedMode string
Billing method of a pay-as-you-go instance after shutdown. Available values: KEEP_CHARGING,STOP_CHARGING. Default KEEP_CHARGING.
SubnetId string
The ID of a VPC subnet. If you want to create instances in a VPC network, this parameter must be set.
SystemDiskId string
System disk snapshot ID used to initialize the system disk. When system disk type is LOCAL_BASIC and LOCAL_SSD, disk id is not supported.
SystemDiskName string
Name of the system disk.
SystemDiskResizeOnline bool
Resize online.
SystemDiskSize float64
Size of the system disk. unit is GB, Default is 50GB. If modified, the instance may force stop.
SystemDiskType string
System disk type. For more information on limits of system disk types, see Storage Overview. Valid values: LOCAL_BASIC: local disk, LOCAL_SSD: local SSD disk, CLOUD_BASIC: cloud disk, CLOUD_SSD: cloud SSD disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_BSSD: Basic SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD. NOTE: If modified, the instance may force stop.
Tags map[string]string
A mapping of tags to assign to the resource. For tag limits, please refer to Use Limits.
Timeouts InstanceTimeoutsArgs
UserData string
The user data to be injected into this instance. Must be base64 encoded and up to 16 KB.
UserDataRaw string
The user data to be injected into this instance, in plain text. Conflicts with user_data. Up to 16 KB after base64 encoded.
Uuid string
Globally unique ID of the instance.
VpcId string
The ID of a VPC network. If you want to create instances in a VPC network, this parameter must be set.
allocatePublicIp Boolean
Associate a public IP address with an instance in a VPC or Classic. Boolean value, Default is false.
availabilityZone String
The available zone for the CVM instance.
bandwidthPackageId String
bandwidth package id. if user is standard user, then the bandwidth_package_id is needed, or default has bandwidth_package_id.
camRoleName String
CAM role name authorized to access.
cdhHostId String
Id of cdh instance. Note: it only works when instance_charge_type is set to CDHPAID.
cdhInstanceType String
Type of instance created on cdh, the value of this parameter is in the format of CDH_XCXG based on the number of CPU cores and memory capacity. Note: it only works when instance_charge_type is set to CDHPAID.
cpu Double
The number of CPU cores of the instance.
createTime String
Create time of the instance.
dataDisks List<InstanceDataDisk>
Settings for data disks.
dedicatedClusterId String
Exclusive cluster id.
disableApiTermination Boolean
Whether the termination protection is enabled. Default is false. If set true, which means that this instance can not be deleted by an API action.
disableAutomationService Boolean
Disable enhance service for automation, it is enabled by default. When this options is set, monitor agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
disableMonitorService Boolean
Disable enhance service for monitor, it is enabled by default. When this options is set, monitor agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
disableSecurityService Boolean
Disable enhance service for security, it is enabled by default. When this options is set, security agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
expiredTime String
Expired time of the instance.
forceDelete Boolean
Indicate whether to force delete the instance. Default is false. If set true, the instance will be permanently deleted instead of being moved into the recycle bin. Note: only works for PREPAID instance.
hostname String
The hostname of the instance. Windows instance: The name should be a combination of 2 to 15 characters comprised of letters (case insensitive), numbers, and hyphens (-). Period (.) is not supported, and the name cannot be a string of pure numbers. Other types (such as Linux) of instances: The name should be a combination of 2 to 60 characters, supporting multiple periods (.). The piece between two periods is composed of letters (case insensitive), numbers, and hyphens (-). Modifications may lead to the reinstallation of the instance's operating system.
hpcClusterId String
High-performance computing cluster ID. If the instance created is a high-performance computing instance, you need to specify the cluster in which the instance is placed, otherwise it cannot be specified.
imageId String
The image to use for the instance. Modifications may lead to the reinstallation of the instance's operating system..
instanceChargeType String
The charge type of instance. Valid values are PREPAID, POSTPAID_BY_HOUR, SPOTPAID, CDHPAID and CDCPAID. The default is POSTPAID_BY_HOUR. Note: TencentCloud International only supports POSTPAID_BY_HOUR and CDHPAID. PREPAID instance may not allow to delete before expired. SPOTPAID instance must set spot_instance_type and spot_max_price at the same time. CDHPAID instance must set cdh_instance_type and cdh_host_id.
instanceChargeTypePrepaidPeriod Double
The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when instance_charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60.
instanceChargeTypePrepaidRenewFlag String
Auto renewal flag. Valid values: NOTIFY_AND_AUTO_RENEW: notify upon expiration and renew automatically, NOTIFY_AND_MANUAL_RENEW: notify upon expiration but do not renew automatically, DISABLE_NOTIFY_AND_MANUAL_RENEW: neither notify upon expiration nor renew automatically. Default value: NOTIFY_AND_MANUAL_RENEW. If this parameter is specified as NOTIFY_AND_AUTO_RENEW, the instance will be automatically renewed on a monthly basis if the account balance is sufficient. NOTE: it only works when instance_charge_type is set to PREPAID.
instanceCount Double
It has been deprecated from version 1.59.18. Use built-in count instead. The number of instances to be purchased. Value range:[1,100]; default value: 1.

Deprecated: Deprecated

instanceId String
ID of the resource.
instanceName String
instanceStatus String
Current status of the instance.
instanceType String
The type of the instance.
internetChargeType String
Internet charge type of the instance, Valid values are BANDWIDTH_PREPAID, TRAFFIC_POSTPAID_BY_HOUR, BANDWIDTH_POSTPAID_BY_HOUR and BANDWIDTH_PACKAGE. If not set, internet charge type are consistent with the cvm charge type by default. This value takes NO Effect when changing and does not need to be set when allocate_public_ip is false.
internetMaxBandwidthOut Double
Maximum outgoing bandwidth to the public network, measured in Mbps (Mega bits per second). This value does not need to be set when allocate_public_ip is false.
keepImageLogin Boolean
Whether to keep image login or not, default is false. When the image type is private or shared or imported, this parameter can be set true. Modifications may lead to the reinstallation of the instance's operating system..
keyIds List<String>
The key pair to use for the instance, it looks like skey-16jig7tx. Modifications may lead to the reinstallation of the instance's operating system.
keyName String
Please use key_ids instead. The key pair to use for the instance, it looks like skey-16jig7tx. Modifications may lead to the reinstallation of the instance's operating system.

Deprecated: Deprecated

memory Double
Instance memory capacity, unit in GB.
orderlySecurityGroups List<String>
A list of orderly security group IDs to associate with.
osName String
Instance os name.
password String
Password for the instance. In order for the new password to take effect, the instance will be restarted after the password change. Modifications may lead to the reinstallation of the instance's operating system.
placementGroupId String
The ID of a placement group.
privateIp String
The private IP to be assigned to this instance, must be in the provided subnet and available.
projectId Double
The project the instance belongs to, default to 0.
publicIp String
Public IP of the instance.
runningFlag Boolean
Set instance to running or stop. Default value is true, the instance will shutdown when this flag is false.
securityGroups List<String>
It will be deprecated. Use orderly_security_groups instead. A list of security group IDs to associate with.

Deprecated: Deprecated

spotInstanceType String
Type of spot instance, only support ONE-TIME now. Note: it only works when instance_charge_type is set to SPOTPAID.
spotMaxPrice String
Max price of a spot instance, is the format of decimal string, for example "0.50". Note: it only works when instance_charge_type is set to SPOTPAID.
stoppedMode String
Billing method of a pay-as-you-go instance after shutdown. Available values: KEEP_CHARGING,STOP_CHARGING. Default KEEP_CHARGING.
subnetId String
The ID of a VPC subnet. If you want to create instances in a VPC network, this parameter must be set.
systemDiskId String
System disk snapshot ID used to initialize the system disk. When system disk type is LOCAL_BASIC and LOCAL_SSD, disk id is not supported.
systemDiskName String
Name of the system disk.
systemDiskResizeOnline Boolean
Resize online.
systemDiskSize Double
Size of the system disk. unit is GB, Default is 50GB. If modified, the instance may force stop.
systemDiskType String
System disk type. For more information on limits of system disk types, see Storage Overview. Valid values: LOCAL_BASIC: local disk, LOCAL_SSD: local SSD disk, CLOUD_BASIC: cloud disk, CLOUD_SSD: cloud SSD disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_BSSD: Basic SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD. NOTE: If modified, the instance may force stop.
tags Map<String,String>
A mapping of tags to assign to the resource. For tag limits, please refer to Use Limits.
timeouts InstanceTimeouts
userData String
The user data to be injected into this instance. Must be base64 encoded and up to 16 KB.
userDataRaw String
The user data to be injected into this instance, in plain text. Conflicts with user_data. Up to 16 KB after base64 encoded.
uuid String
Globally unique ID of the instance.
vpcId String
The ID of a VPC network. If you want to create instances in a VPC network, this parameter must be set.
allocatePublicIp boolean
Associate a public IP address with an instance in a VPC or Classic. Boolean value, Default is false.
availabilityZone string
The available zone for the CVM instance.
bandwidthPackageId string
bandwidth package id. if user is standard user, then the bandwidth_package_id is needed, or default has bandwidth_package_id.
camRoleName string
CAM role name authorized to access.
cdhHostId string
Id of cdh instance. Note: it only works when instance_charge_type is set to CDHPAID.
cdhInstanceType string
Type of instance created on cdh, the value of this parameter is in the format of CDH_XCXG based on the number of CPU cores and memory capacity. Note: it only works when instance_charge_type is set to CDHPAID.
cpu number
The number of CPU cores of the instance.
createTime string
Create time of the instance.
dataDisks InstanceDataDisk[]
Settings for data disks.
dedicatedClusterId string
Exclusive cluster id.
disableApiTermination boolean
Whether the termination protection is enabled. Default is false. If set true, which means that this instance can not be deleted by an API action.
disableAutomationService boolean
Disable enhance service for automation, it is enabled by default. When this options is set, monitor agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
disableMonitorService boolean
Disable enhance service for monitor, it is enabled by default. When this options is set, monitor agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
disableSecurityService boolean
Disable enhance service for security, it is enabled by default. When this options is set, security agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
expiredTime string
Expired time of the instance.
forceDelete boolean
Indicate whether to force delete the instance. Default is false. If set true, the instance will be permanently deleted instead of being moved into the recycle bin. Note: only works for PREPAID instance.
hostname string
The hostname of the instance. Windows instance: The name should be a combination of 2 to 15 characters comprised of letters (case insensitive), numbers, and hyphens (-). Period (.) is not supported, and the name cannot be a string of pure numbers. Other types (such as Linux) of instances: The name should be a combination of 2 to 60 characters, supporting multiple periods (.). The piece between two periods is composed of letters (case insensitive), numbers, and hyphens (-). Modifications may lead to the reinstallation of the instance's operating system.
hpcClusterId string
High-performance computing cluster ID. If the instance created is a high-performance computing instance, you need to specify the cluster in which the instance is placed, otherwise it cannot be specified.
imageId string
The image to use for the instance. Modifications may lead to the reinstallation of the instance's operating system..
instanceChargeType string
The charge type of instance. Valid values are PREPAID, POSTPAID_BY_HOUR, SPOTPAID, CDHPAID and CDCPAID. The default is POSTPAID_BY_HOUR. Note: TencentCloud International only supports POSTPAID_BY_HOUR and CDHPAID. PREPAID instance may not allow to delete before expired. SPOTPAID instance must set spot_instance_type and spot_max_price at the same time. CDHPAID instance must set cdh_instance_type and cdh_host_id.
instanceChargeTypePrepaidPeriod number
The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when instance_charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60.
instanceChargeTypePrepaidRenewFlag string
Auto renewal flag. Valid values: NOTIFY_AND_AUTO_RENEW: notify upon expiration and renew automatically, NOTIFY_AND_MANUAL_RENEW: notify upon expiration but do not renew automatically, DISABLE_NOTIFY_AND_MANUAL_RENEW: neither notify upon expiration nor renew automatically. Default value: NOTIFY_AND_MANUAL_RENEW. If this parameter is specified as NOTIFY_AND_AUTO_RENEW, the instance will be automatically renewed on a monthly basis if the account balance is sufficient. NOTE: it only works when instance_charge_type is set to PREPAID.
instanceCount number
It has been deprecated from version 1.59.18. Use built-in count instead. The number of instances to be purchased. Value range:[1,100]; default value: 1.

Deprecated: Deprecated

instanceId string
ID of the resource.
instanceName string
instanceStatus string
Current status of the instance.
instanceType string
The type of the instance.
internetChargeType string
Internet charge type of the instance, Valid values are BANDWIDTH_PREPAID, TRAFFIC_POSTPAID_BY_HOUR, BANDWIDTH_POSTPAID_BY_HOUR and BANDWIDTH_PACKAGE. If not set, internet charge type are consistent with the cvm charge type by default. This value takes NO Effect when changing and does not need to be set when allocate_public_ip is false.
internetMaxBandwidthOut number
Maximum outgoing bandwidth to the public network, measured in Mbps (Mega bits per second). This value does not need to be set when allocate_public_ip is false.
keepImageLogin boolean
Whether to keep image login or not, default is false. When the image type is private or shared or imported, this parameter can be set true. Modifications may lead to the reinstallation of the instance's operating system..
keyIds string[]
The key pair to use for the instance, it looks like skey-16jig7tx. Modifications may lead to the reinstallation of the instance's operating system.
keyName string
Please use key_ids instead. The key pair to use for the instance, it looks like skey-16jig7tx. Modifications may lead to the reinstallation of the instance's operating system.

Deprecated: Deprecated

memory number
Instance memory capacity, unit in GB.
orderlySecurityGroups string[]
A list of orderly security group IDs to associate with.
osName string
Instance os name.
password string
Password for the instance. In order for the new password to take effect, the instance will be restarted after the password change. Modifications may lead to the reinstallation of the instance's operating system.
placementGroupId string
The ID of a placement group.
privateIp string
The private IP to be assigned to this instance, must be in the provided subnet and available.
projectId number
The project the instance belongs to, default to 0.
publicIp string
Public IP of the instance.
runningFlag boolean
Set instance to running or stop. Default value is true, the instance will shutdown when this flag is false.
securityGroups string[]
It will be deprecated. Use orderly_security_groups instead. A list of security group IDs to associate with.

Deprecated: Deprecated

spotInstanceType string
Type of spot instance, only support ONE-TIME now. Note: it only works when instance_charge_type is set to SPOTPAID.
spotMaxPrice string
Max price of a spot instance, is the format of decimal string, for example "0.50". Note: it only works when instance_charge_type is set to SPOTPAID.
stoppedMode string
Billing method of a pay-as-you-go instance after shutdown. Available values: KEEP_CHARGING,STOP_CHARGING. Default KEEP_CHARGING.
subnetId string
The ID of a VPC subnet. If you want to create instances in a VPC network, this parameter must be set.
systemDiskId string
System disk snapshot ID used to initialize the system disk. When system disk type is LOCAL_BASIC and LOCAL_SSD, disk id is not supported.
systemDiskName string
Name of the system disk.
systemDiskResizeOnline boolean
Resize online.
systemDiskSize number
Size of the system disk. unit is GB, Default is 50GB. If modified, the instance may force stop.
systemDiskType string
System disk type. For more information on limits of system disk types, see Storage Overview. Valid values: LOCAL_BASIC: local disk, LOCAL_SSD: local SSD disk, CLOUD_BASIC: cloud disk, CLOUD_SSD: cloud SSD disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_BSSD: Basic SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD. NOTE: If modified, the instance may force stop.
tags {[key: string]: string}
A mapping of tags to assign to the resource. For tag limits, please refer to Use Limits.
timeouts InstanceTimeouts
userData string
The user data to be injected into this instance. Must be base64 encoded and up to 16 KB.
userDataRaw string
The user data to be injected into this instance, in plain text. Conflicts with user_data. Up to 16 KB after base64 encoded.
uuid string
Globally unique ID of the instance.
vpcId string
The ID of a VPC network. If you want to create instances in a VPC network, this parameter must be set.
allocate_public_ip bool
Associate a public IP address with an instance in a VPC or Classic. Boolean value, Default is false.
availability_zone str
The available zone for the CVM instance.
bandwidth_package_id str
bandwidth package id. if user is standard user, then the bandwidth_package_id is needed, or default has bandwidth_package_id.
cam_role_name str
CAM role name authorized to access.
cdh_host_id str
Id of cdh instance. Note: it only works when instance_charge_type is set to CDHPAID.
cdh_instance_type str
Type of instance created on cdh, the value of this parameter is in the format of CDH_XCXG based on the number of CPU cores and memory capacity. Note: it only works when instance_charge_type is set to CDHPAID.
cpu float
The number of CPU cores of the instance.
create_time str
Create time of the instance.
data_disks Sequence[InstanceDataDiskArgs]
Settings for data disks.
dedicated_cluster_id str
Exclusive cluster id.
disable_api_termination bool
Whether the termination protection is enabled. Default is false. If set true, which means that this instance can not be deleted by an API action.
disable_automation_service bool
Disable enhance service for automation, it is enabled by default. When this options is set, monitor agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
disable_monitor_service bool
Disable enhance service for monitor, it is enabled by default. When this options is set, monitor agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
disable_security_service bool
Disable enhance service for security, it is enabled by default. When this options is set, security agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
expired_time str
Expired time of the instance.
force_delete bool
Indicate whether to force delete the instance. Default is false. If set true, the instance will be permanently deleted instead of being moved into the recycle bin. Note: only works for PREPAID instance.
hostname str
The hostname of the instance. Windows instance: The name should be a combination of 2 to 15 characters comprised of letters (case insensitive), numbers, and hyphens (-). Period (.) is not supported, and the name cannot be a string of pure numbers. Other types (such as Linux) of instances: The name should be a combination of 2 to 60 characters, supporting multiple periods (.). The piece between two periods is composed of letters (case insensitive), numbers, and hyphens (-). Modifications may lead to the reinstallation of the instance's operating system.
hpc_cluster_id str
High-performance computing cluster ID. If the instance created is a high-performance computing instance, you need to specify the cluster in which the instance is placed, otherwise it cannot be specified.
image_id str
The image to use for the instance. Modifications may lead to the reinstallation of the instance's operating system..
instance_charge_type str
The charge type of instance. Valid values are PREPAID, POSTPAID_BY_HOUR, SPOTPAID, CDHPAID and CDCPAID. The default is POSTPAID_BY_HOUR. Note: TencentCloud International only supports POSTPAID_BY_HOUR and CDHPAID. PREPAID instance may not allow to delete before expired. SPOTPAID instance must set spot_instance_type and spot_max_price at the same time. CDHPAID instance must set cdh_instance_type and cdh_host_id.
instance_charge_type_prepaid_period float
The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when instance_charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60.
instance_charge_type_prepaid_renew_flag str
Auto renewal flag. Valid values: NOTIFY_AND_AUTO_RENEW: notify upon expiration and renew automatically, NOTIFY_AND_MANUAL_RENEW: notify upon expiration but do not renew automatically, DISABLE_NOTIFY_AND_MANUAL_RENEW: neither notify upon expiration nor renew automatically. Default value: NOTIFY_AND_MANUAL_RENEW. If this parameter is specified as NOTIFY_AND_AUTO_RENEW, the instance will be automatically renewed on a monthly basis if the account balance is sufficient. NOTE: it only works when instance_charge_type is set to PREPAID.
instance_count float
It has been deprecated from version 1.59.18. Use built-in count instead. The number of instances to be purchased. Value range:[1,100]; default value: 1.

Deprecated: Deprecated

instance_id str
ID of the resource.
instance_name str
instance_status str
Current status of the instance.
instance_type str
The type of the instance.
internet_charge_type str
Internet charge type of the instance, Valid values are BANDWIDTH_PREPAID, TRAFFIC_POSTPAID_BY_HOUR, BANDWIDTH_POSTPAID_BY_HOUR and BANDWIDTH_PACKAGE. If not set, internet charge type are consistent with the cvm charge type by default. This value takes NO Effect when changing and does not need to be set when allocate_public_ip is false.
internet_max_bandwidth_out float
Maximum outgoing bandwidth to the public network, measured in Mbps (Mega bits per second). This value does not need to be set when allocate_public_ip is false.
keep_image_login bool
Whether to keep image login or not, default is false. When the image type is private or shared or imported, this parameter can be set true. Modifications may lead to the reinstallation of the instance's operating system..
key_ids Sequence[str]
The key pair to use for the instance, it looks like skey-16jig7tx. Modifications may lead to the reinstallation of the instance's operating system.
key_name str
Please use key_ids instead. The key pair to use for the instance, it looks like skey-16jig7tx. Modifications may lead to the reinstallation of the instance's operating system.

Deprecated: Deprecated

memory float
Instance memory capacity, unit in GB.
orderly_security_groups Sequence[str]
A list of orderly security group IDs to associate with.
os_name str
Instance os name.
password str
Password for the instance. In order for the new password to take effect, the instance will be restarted after the password change. Modifications may lead to the reinstallation of the instance's operating system.
placement_group_id str
The ID of a placement group.
private_ip str
The private IP to be assigned to this instance, must be in the provided subnet and available.
project_id float
The project the instance belongs to, default to 0.
public_ip str
Public IP of the instance.
running_flag bool
Set instance to running or stop. Default value is true, the instance will shutdown when this flag is false.
security_groups Sequence[str]
It will be deprecated. Use orderly_security_groups instead. A list of security group IDs to associate with.

Deprecated: Deprecated

spot_instance_type str
Type of spot instance, only support ONE-TIME now. Note: it only works when instance_charge_type is set to SPOTPAID.
spot_max_price str
Max price of a spot instance, is the format of decimal string, for example "0.50". Note: it only works when instance_charge_type is set to SPOTPAID.
stopped_mode str
Billing method of a pay-as-you-go instance after shutdown. Available values: KEEP_CHARGING,STOP_CHARGING. Default KEEP_CHARGING.
subnet_id str
The ID of a VPC subnet. If you want to create instances in a VPC network, this parameter must be set.
system_disk_id str
System disk snapshot ID used to initialize the system disk. When system disk type is LOCAL_BASIC and LOCAL_SSD, disk id is not supported.
system_disk_name str
Name of the system disk.
system_disk_resize_online bool
Resize online.
system_disk_size float
Size of the system disk. unit is GB, Default is 50GB. If modified, the instance may force stop.
system_disk_type str
System disk type. For more information on limits of system disk types, see Storage Overview. Valid values: LOCAL_BASIC: local disk, LOCAL_SSD: local SSD disk, CLOUD_BASIC: cloud disk, CLOUD_SSD: cloud SSD disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_BSSD: Basic SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD. NOTE: If modified, the instance may force stop.
tags Mapping[str, str]
A mapping of tags to assign to the resource. For tag limits, please refer to Use Limits.
timeouts InstanceTimeoutsArgs
user_data str
The user data to be injected into this instance. Must be base64 encoded and up to 16 KB.
user_data_raw str
The user data to be injected into this instance, in plain text. Conflicts with user_data. Up to 16 KB after base64 encoded.
uuid str
Globally unique ID of the instance.
vpc_id str
The ID of a VPC network. If you want to create instances in a VPC network, this parameter must be set.
allocatePublicIp Boolean
Associate a public IP address with an instance in a VPC or Classic. Boolean value, Default is false.
availabilityZone String
The available zone for the CVM instance.
bandwidthPackageId String
bandwidth package id. if user is standard user, then the bandwidth_package_id is needed, or default has bandwidth_package_id.
camRoleName String
CAM role name authorized to access.
cdhHostId String
Id of cdh instance. Note: it only works when instance_charge_type is set to CDHPAID.
cdhInstanceType String
Type of instance created on cdh, the value of this parameter is in the format of CDH_XCXG based on the number of CPU cores and memory capacity. Note: it only works when instance_charge_type is set to CDHPAID.
cpu Number
The number of CPU cores of the instance.
createTime String
Create time of the instance.
dataDisks List<Property Map>
Settings for data disks.
dedicatedClusterId String
Exclusive cluster id.
disableApiTermination Boolean
Whether the termination protection is enabled. Default is false. If set true, which means that this instance can not be deleted by an API action.
disableAutomationService Boolean
Disable enhance service for automation, it is enabled by default. When this options is set, monitor agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
disableMonitorService Boolean
Disable enhance service for monitor, it is enabled by default. When this options is set, monitor agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
disableSecurityService Boolean
Disable enhance service for security, it is enabled by default. When this options is set, security agent won't be installed. Modifications may lead to the reinstallation of the instance's operating system.
expiredTime String
Expired time of the instance.
forceDelete Boolean
Indicate whether to force delete the instance. Default is false. If set true, the instance will be permanently deleted instead of being moved into the recycle bin. Note: only works for PREPAID instance.
hostname String
The hostname of the instance. Windows instance: The name should be a combination of 2 to 15 characters comprised of letters (case insensitive), numbers, and hyphens (-). Period (.) is not supported, and the name cannot be a string of pure numbers. Other types (such as Linux) of instances: The name should be a combination of 2 to 60 characters, supporting multiple periods (.). The piece between two periods is composed of letters (case insensitive), numbers, and hyphens (-). Modifications may lead to the reinstallation of the instance's operating system.
hpcClusterId String
High-performance computing cluster ID. If the instance created is a high-performance computing instance, you need to specify the cluster in which the instance is placed, otherwise it cannot be specified.
imageId String
The image to use for the instance. Modifications may lead to the reinstallation of the instance's operating system..
instanceChargeType String
The charge type of instance. Valid values are PREPAID, POSTPAID_BY_HOUR, SPOTPAID, CDHPAID and CDCPAID. The default is POSTPAID_BY_HOUR. Note: TencentCloud International only supports POSTPAID_BY_HOUR and CDHPAID. PREPAID instance may not allow to delete before expired. SPOTPAID instance must set spot_instance_type and spot_max_price at the same time. CDHPAID instance must set cdh_instance_type and cdh_host_id.
instanceChargeTypePrepaidPeriod Number
The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when instance_charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60.
instanceChargeTypePrepaidRenewFlag String
Auto renewal flag. Valid values: NOTIFY_AND_AUTO_RENEW: notify upon expiration and renew automatically, NOTIFY_AND_MANUAL_RENEW: notify upon expiration but do not renew automatically, DISABLE_NOTIFY_AND_MANUAL_RENEW: neither notify upon expiration nor renew automatically. Default value: NOTIFY_AND_MANUAL_RENEW. If this parameter is specified as NOTIFY_AND_AUTO_RENEW, the instance will be automatically renewed on a monthly basis if the account balance is sufficient. NOTE: it only works when instance_charge_type is set to PREPAID.
instanceCount Number
It has been deprecated from version 1.59.18. Use built-in count instead. The number of instances to be purchased. Value range:[1,100]; default value: 1.

Deprecated: Deprecated

instanceId String
ID of the resource.
instanceName String
instanceStatus String
Current status of the instance.
instanceType String
The type of the instance.
internetChargeType String
Internet charge type of the instance, Valid values are BANDWIDTH_PREPAID, TRAFFIC_POSTPAID_BY_HOUR, BANDWIDTH_POSTPAID_BY_HOUR and BANDWIDTH_PACKAGE. If not set, internet charge type are consistent with the cvm charge type by default. This value takes NO Effect when changing and does not need to be set when allocate_public_ip is false.
internetMaxBandwidthOut Number
Maximum outgoing bandwidth to the public network, measured in Mbps (Mega bits per second). This value does not need to be set when allocate_public_ip is false.
keepImageLogin Boolean
Whether to keep image login or not, default is false. When the image type is private or shared or imported, this parameter can be set true. Modifications may lead to the reinstallation of the instance's operating system..
keyIds List<String>
The key pair to use for the instance, it looks like skey-16jig7tx. Modifications may lead to the reinstallation of the instance's operating system.
keyName String
Please use key_ids instead. The key pair to use for the instance, it looks like skey-16jig7tx. Modifications may lead to the reinstallation of the instance's operating system.

Deprecated: Deprecated

memory Number
Instance memory capacity, unit in GB.
orderlySecurityGroups List<String>
A list of orderly security group IDs to associate with.
osName String
Instance os name.
password String
Password for the instance. In order for the new password to take effect, the instance will be restarted after the password change. Modifications may lead to the reinstallation of the instance's operating system.
placementGroupId String
The ID of a placement group.
privateIp String
The private IP to be assigned to this instance, must be in the provided subnet and available.
projectId Number
The project the instance belongs to, default to 0.
publicIp String
Public IP of the instance.
runningFlag Boolean
Set instance to running or stop. Default value is true, the instance will shutdown when this flag is false.
securityGroups List<String>
It will be deprecated. Use orderly_security_groups instead. A list of security group IDs to associate with.

Deprecated: Deprecated

spotInstanceType String
Type of spot instance, only support ONE-TIME now. Note: it only works when instance_charge_type is set to SPOTPAID.
spotMaxPrice String
Max price of a spot instance, is the format of decimal string, for example "0.50". Note: it only works when instance_charge_type is set to SPOTPAID.
stoppedMode String
Billing method of a pay-as-you-go instance after shutdown. Available values: KEEP_CHARGING,STOP_CHARGING. Default KEEP_CHARGING.
subnetId String
The ID of a VPC subnet. If you want to create instances in a VPC network, this parameter must be set.
systemDiskId String
System disk snapshot ID used to initialize the system disk. When system disk type is LOCAL_BASIC and LOCAL_SSD, disk id is not supported.
systemDiskName String
Name of the system disk.
systemDiskResizeOnline Boolean
Resize online.
systemDiskSize Number
Size of the system disk. unit is GB, Default is 50GB. If modified, the instance may force stop.
systemDiskType String
System disk type. For more information on limits of system disk types, see Storage Overview. Valid values: LOCAL_BASIC: local disk, LOCAL_SSD: local SSD disk, CLOUD_BASIC: cloud disk, CLOUD_SSD: cloud SSD disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_BSSD: Basic SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD. NOTE: If modified, the instance may force stop.
tags Map<String>
A mapping of tags to assign to the resource. For tag limits, please refer to Use Limits.
timeouts Property Map
userData String
The user data to be injected into this instance. Must be base64 encoded and up to 16 KB.
userDataRaw String
The user data to be injected into this instance, in plain text. Conflicts with user_data. Up to 16 KB after base64 encoded.
uuid String
Globally unique ID of the instance.
vpcId String
The ID of a VPC network. If you want to create instances in a VPC network, this parameter must be set.

Supporting Types

InstanceDataDisk
, InstanceDataDiskArgs

DataDiskSize This property is required. double
Size of the data disk, and unit is GB.
DataDiskType This property is required. string
Data disk type. For more information about limits on different data disk types, see Storage Overview. Valid values: LOCAL_BASIC: local disk, LOCAL_SSD: local SSD disk, LOCAL_NVME: local NVME disk, specified in the InstanceType, LOCAL_PRO: local HDD disk, specified in the InstanceType, CLOUD_BASIC: HDD cloud disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_SSD: SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD, CLOUD_BSSD: Balanced SSD.
DataDiskId string
Data disk ID used to initialize the data disk. When data disk type is LOCAL_BASIC and LOCAL_SSD, disk id is not supported.
DataDiskName string
Name of data disk.
DataDiskSnapshotId string
Snapshot ID of the data disk. The selected data disk snapshot size must be smaller than the data disk size.
DeleteWithInstance bool
Decides whether the disk is deleted with instance(only applied to CLOUD_BASIC, CLOUD_SSD and CLOUD_PREMIUM disk with POSTPAID_BY_HOUR instance), default is true.
DeleteWithInstancePrepaid bool
Decides whether the disk is deleted with instance(only applied to CLOUD_BASIC, CLOUD_SSD and CLOUD_PREMIUM disk with PREPAID instance), default is false.
Encrypt bool
Decides whether the disk is encrypted. Default is false.
ThroughputPerformance double
Add extra performance to the data disk. Only works when disk type is CLOUD_TSSD or CLOUD_HSSD.
DataDiskSize This property is required. float64
Size of the data disk, and unit is GB.
DataDiskType This property is required. string
Data disk type. For more information about limits on different data disk types, see Storage Overview. Valid values: LOCAL_BASIC: local disk, LOCAL_SSD: local SSD disk, LOCAL_NVME: local NVME disk, specified in the InstanceType, LOCAL_PRO: local HDD disk, specified in the InstanceType, CLOUD_BASIC: HDD cloud disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_SSD: SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD, CLOUD_BSSD: Balanced SSD.
DataDiskId string
Data disk ID used to initialize the data disk. When data disk type is LOCAL_BASIC and LOCAL_SSD, disk id is not supported.
DataDiskName string
Name of data disk.
DataDiskSnapshotId string
Snapshot ID of the data disk. The selected data disk snapshot size must be smaller than the data disk size.
DeleteWithInstance bool
Decides whether the disk is deleted with instance(only applied to CLOUD_BASIC, CLOUD_SSD and CLOUD_PREMIUM disk with POSTPAID_BY_HOUR instance), default is true.
DeleteWithInstancePrepaid bool
Decides whether the disk is deleted with instance(only applied to CLOUD_BASIC, CLOUD_SSD and CLOUD_PREMIUM disk with PREPAID instance), default is false.
Encrypt bool
Decides whether the disk is encrypted. Default is false.
ThroughputPerformance float64
Add extra performance to the data disk. Only works when disk type is CLOUD_TSSD or CLOUD_HSSD.
dataDiskSize This property is required. Double
Size of the data disk, and unit is GB.
dataDiskType This property is required. String
Data disk type. For more information about limits on different data disk types, see Storage Overview. Valid values: LOCAL_BASIC: local disk, LOCAL_SSD: local SSD disk, LOCAL_NVME: local NVME disk, specified in the InstanceType, LOCAL_PRO: local HDD disk, specified in the InstanceType, CLOUD_BASIC: HDD cloud disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_SSD: SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD, CLOUD_BSSD: Balanced SSD.
dataDiskId String
Data disk ID used to initialize the data disk. When data disk type is LOCAL_BASIC and LOCAL_SSD, disk id is not supported.
dataDiskName String
Name of data disk.
dataDiskSnapshotId String
Snapshot ID of the data disk. The selected data disk snapshot size must be smaller than the data disk size.
deleteWithInstance Boolean
Decides whether the disk is deleted with instance(only applied to CLOUD_BASIC, CLOUD_SSD and CLOUD_PREMIUM disk with POSTPAID_BY_HOUR instance), default is true.
deleteWithInstancePrepaid Boolean
Decides whether the disk is deleted with instance(only applied to CLOUD_BASIC, CLOUD_SSD and CLOUD_PREMIUM disk with PREPAID instance), default is false.
encrypt Boolean
Decides whether the disk is encrypted. Default is false.
throughputPerformance Double
Add extra performance to the data disk. Only works when disk type is CLOUD_TSSD or CLOUD_HSSD.
dataDiskSize This property is required. number
Size of the data disk, and unit is GB.
dataDiskType This property is required. string
Data disk type. For more information about limits on different data disk types, see Storage Overview. Valid values: LOCAL_BASIC: local disk, LOCAL_SSD: local SSD disk, LOCAL_NVME: local NVME disk, specified in the InstanceType, LOCAL_PRO: local HDD disk, specified in the InstanceType, CLOUD_BASIC: HDD cloud disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_SSD: SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD, CLOUD_BSSD: Balanced SSD.
dataDiskId string
Data disk ID used to initialize the data disk. When data disk type is LOCAL_BASIC and LOCAL_SSD, disk id is not supported.
dataDiskName string
Name of data disk.
dataDiskSnapshotId string
Snapshot ID of the data disk. The selected data disk snapshot size must be smaller than the data disk size.
deleteWithInstance boolean
Decides whether the disk is deleted with instance(only applied to CLOUD_BASIC, CLOUD_SSD and CLOUD_PREMIUM disk with POSTPAID_BY_HOUR instance), default is true.
deleteWithInstancePrepaid boolean
Decides whether the disk is deleted with instance(only applied to CLOUD_BASIC, CLOUD_SSD and CLOUD_PREMIUM disk with PREPAID instance), default is false.
encrypt boolean
Decides whether the disk is encrypted. Default is false.
throughputPerformance number
Add extra performance to the data disk. Only works when disk type is CLOUD_TSSD or CLOUD_HSSD.
data_disk_size This property is required. float
Size of the data disk, and unit is GB.
data_disk_type This property is required. str
Data disk type. For more information about limits on different data disk types, see Storage Overview. Valid values: LOCAL_BASIC: local disk, LOCAL_SSD: local SSD disk, LOCAL_NVME: local NVME disk, specified in the InstanceType, LOCAL_PRO: local HDD disk, specified in the InstanceType, CLOUD_BASIC: HDD cloud disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_SSD: SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD, CLOUD_BSSD: Balanced SSD.
data_disk_id str
Data disk ID used to initialize the data disk. When data disk type is LOCAL_BASIC and LOCAL_SSD, disk id is not supported.
data_disk_name str
Name of data disk.
data_disk_snapshot_id str
Snapshot ID of the data disk. The selected data disk snapshot size must be smaller than the data disk size.
delete_with_instance bool
Decides whether the disk is deleted with instance(only applied to CLOUD_BASIC, CLOUD_SSD and CLOUD_PREMIUM disk with POSTPAID_BY_HOUR instance), default is true.
delete_with_instance_prepaid bool
Decides whether the disk is deleted with instance(only applied to CLOUD_BASIC, CLOUD_SSD and CLOUD_PREMIUM disk with PREPAID instance), default is false.
encrypt bool
Decides whether the disk is encrypted. Default is false.
throughput_performance float
Add extra performance to the data disk. Only works when disk type is CLOUD_TSSD or CLOUD_HSSD.
dataDiskSize This property is required. Number
Size of the data disk, and unit is GB.
dataDiskType This property is required. String
Data disk type. For more information about limits on different data disk types, see Storage Overview. Valid values: LOCAL_BASIC: local disk, LOCAL_SSD: local SSD disk, LOCAL_NVME: local NVME disk, specified in the InstanceType, LOCAL_PRO: local HDD disk, specified in the InstanceType, CLOUD_BASIC: HDD cloud disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_SSD: SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD, CLOUD_BSSD: Balanced SSD.
dataDiskId String
Data disk ID used to initialize the data disk. When data disk type is LOCAL_BASIC and LOCAL_SSD, disk id is not supported.
dataDiskName String
Name of data disk.
dataDiskSnapshotId String
Snapshot ID of the data disk. The selected data disk snapshot size must be smaller than the data disk size.
deleteWithInstance Boolean
Decides whether the disk is deleted with instance(only applied to CLOUD_BASIC, CLOUD_SSD and CLOUD_PREMIUM disk with POSTPAID_BY_HOUR instance), default is true.
deleteWithInstancePrepaid Boolean
Decides whether the disk is deleted with instance(only applied to CLOUD_BASIC, CLOUD_SSD and CLOUD_PREMIUM disk with PREPAID instance), default is false.
encrypt Boolean
Decides whether the disk is encrypted. Default is false.
throughputPerformance Number
Add extra performance to the data disk. Only works when disk type is CLOUD_TSSD or CLOUD_HSSD.

InstanceTimeouts
, InstanceTimeoutsArgs

Create string
Create string
create String
create string
create str
create String

Import

CVM instance can be imported using the id, e.g.

$ pulumi import tencentcloud:index/instance:Instance example ins-2qol3a80
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
tencentcloud tencentcloudstack/terraform-provider-tencentcloud
License
Notes
This Pulumi package is based on the tencentcloud Terraform Provider.
tencentcloud 1.81.183 published on Wednesday, Apr 16, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud