Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. vedb_mysql
  5. Instance
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

volcengine.vedb_mysql.Instance

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

    Example Usage

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

const fooZones = volcengine.ecs.Zones({});
const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
    vpcName: "acc-test-vpc",
    cidrBlock: "172.16.0.0/16",
});
const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
    subnetName: "acc-test-subnet",
    cidrBlock: "172.16.0.0/24",
    zoneId: fooZones.then(fooZones => fooZones.zones?.[2]?.id),
    vpcId: fooVpc.id,
});
const fooInstance = new volcengine.vedb_mysql.Instance("fooInstance", {
    chargeType: "PostPaid",
    storageChargeType: "PostPaid",
    dbEngineVersion: "MySQL_8_0",
    dbMinorVersion: "3.0",
    nodeNumber: 2,
    nodeSpec: "vedb.mysql.x4.large",
    subnetId: fooSubnet.id,
    instanceName: "tf-test",
    projectName: "default",
    tags: [{
        key: "tftest",
        value: "tftest",
    }],
});

    import pulumi
import pulumi_volcengine as volcengine

foo_zones = volcengine.ecs.zones()
foo_vpc = volcengine.vpc.Vpc("fooVpc",
    vpc_name="acc-test-vpc",
    cidr_block="172.16.0.0/16")
foo_subnet = volcengine.vpc.Subnet("fooSubnet",
    subnet_name="acc-test-subnet",
    cidr_block="172.16.0.0/24",
    zone_id=foo_zones.zones[2].id,
    vpc_id=foo_vpc.id)
foo_instance = volcengine.vedb_mysql.Instance("fooInstance",
    charge_type="PostPaid",
    storage_charge_type="PostPaid",
    db_engine_version="MySQL_8_0",
    db_minor_version="3.0",
    node_number=2,
    node_spec="vedb.mysql.x4.large",
    subnet_id=foo_subnet.id,
    instance_name="tf-test",
    project_name="default",
    tags=[volcengine.vedb_mysql.InstanceTagArgs(
        key="tftest",
        value="tftest",
    )])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/ecs"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vedb_mysql"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vpc"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		fooZones, err := ecs.Zones(ctx, nil, nil)
		if err != nil {
			return err
		}
		fooVpc, err := vpc.NewVpc(ctx, "fooVpc", &vpc.VpcArgs{
			VpcName:   pulumi.String("acc-test-vpc"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		fooSubnet, err := vpc.NewSubnet(ctx, "fooSubnet", &vpc.SubnetArgs{
			SubnetName: pulumi.String("acc-test-subnet"),
			CidrBlock:  pulumi.String("172.16.0.0/24"),
			ZoneId:     pulumi.String(fooZones.Zones[2].Id),
			VpcId:      fooVpc.ID(),
		})
		if err != nil {
			return err
		}
		_, err = vedb_mysql.NewInstance(ctx, "fooInstance", &vedb_mysql.InstanceArgs{
			ChargeType:        pulumi.String("PostPaid"),
			StorageChargeType: pulumi.String("PostPaid"),
			DbEngineVersion:   pulumi.String("MySQL_8_0"),
			DbMinorVersion:    pulumi.String("3.0"),
			NodeNumber:        pulumi.Int(2),
			NodeSpec:          pulumi.String("vedb.mysql.x4.large"),
			SubnetId:          fooSubnet.ID(),
			InstanceName:      pulumi.String("tf-test"),
			ProjectName:       pulumi.String("default"),
			Tags: vedb_mysql.InstanceTagArray{
				&vedb_mysql.InstanceTagArgs{
					Key:   pulumi.String("tftest"),
					Value: pulumi.String("tftest"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var fooZones = Volcengine.Ecs.Zones.Invoke();

    var fooVpc = new Volcengine.Vpc.Vpc("fooVpc", new()
    {
        VpcName = "acc-test-vpc",
        CidrBlock = "172.16.0.0/16",
    });

    var fooSubnet = new Volcengine.Vpc.Subnet("fooSubnet", new()
    {
        SubnetName = "acc-test-subnet",
        CidrBlock = "172.16.0.0/24",
        ZoneId = fooZones.Apply(zonesResult => zonesResult.Zones[2]?.Id),
        VpcId = fooVpc.Id,
    });

    var fooInstance = new Volcengine.Vedb_mysql.Instance("fooInstance", new()
    {
        ChargeType = "PostPaid",
        StorageChargeType = "PostPaid",
        DbEngineVersion = "MySQL_8_0",
        DbMinorVersion = "3.0",
        NodeNumber = 2,
        NodeSpec = "vedb.mysql.x4.large",
        SubnetId = fooSubnet.Id,
        InstanceName = "tf-test",
        ProjectName = "default",
        Tags = new[]
        {
            new Volcengine.Vedb_mysql.Inputs.InstanceTagArgs
            {
                Key = "tftest",
                Value = "tftest",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.ecs.EcsFunctions;
import com.pulumi.volcengine.ecs.inputs.ZonesArgs;
import com.pulumi.volcengine.vpc.Vpc;
import com.pulumi.volcengine.vpc.VpcArgs;
import com.pulumi.volcengine.vpc.Subnet;
import com.pulumi.volcengine.vpc.SubnetArgs;
import com.pulumi.volcengine.vedb_mysql.Instance;
import com.pulumi.volcengine.vedb_mysql.InstanceArgs;
import com.pulumi.volcengine.vedb_mysql.inputs.InstanceTagArgs;
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 fooZones = EcsFunctions.Zones();

        var fooVpc = new Vpc("fooVpc", VpcArgs.builder()        
            .vpcName("acc-test-vpc")
            .cidrBlock("172.16.0.0/16")
            .build());

        var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()        
            .subnetName("acc-test-subnet")
            .cidrBlock("172.16.0.0/24")
            .zoneId(fooZones.applyValue(zonesResult -> zonesResult.zones()[2].id()))
            .vpcId(fooVpc.id())
            .build());

        var fooInstance = new Instance("fooInstance", InstanceArgs.builder()        
            .chargeType("PostPaid")
            .storageChargeType("PostPaid")
            .dbEngineVersion("MySQL_8_0")
            .dbMinorVersion("3.0")
            .nodeNumber(2)
            .nodeSpec("vedb.mysql.x4.large")
            .subnetId(fooSubnet.id())
            .instanceName("tf-test")
            .projectName("default")
            .tags(InstanceTagArgs.builder()
                .key("tftest")
                .value("tftest")
                .build())
            .build());

    }
}

    resources:
  fooVpc:
    type: volcengine:vpc:Vpc
    properties:
      vpcName: acc-test-vpc
      cidrBlock: 172.16.0.0/16
  fooSubnet:
    type: volcengine:vpc:Subnet
    properties:
      subnetName: acc-test-subnet
      cidrBlock: 172.16.0.0/24
      zoneId: ${fooZones.zones[2].id}
      vpcId: ${fooVpc.id}
  fooInstance:
    type: volcengine:vedb_mysql:Instance
    properties:
      chargeType: PostPaid
      storageChargeType: PostPaid
      dbEngineVersion: MySQL_8_0
      dbMinorVersion: '3.0'
      nodeNumber: 2
      nodeSpec: vedb.mysql.x4.large
      subnetId: ${fooSubnet.id}
      instanceName: tf-test
      projectName: default
      tags:
        - key: tftest
          value: tftest
variables:
  fooZones:
    fn::invoke:
      Function: volcengine:ecs:Zones
      Arguments: {}

    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,
             node_number: Optional[int] = None,
             charge_type: Optional[str] = None,
             db_engine_version: Optional[str] = None,
             subnet_id: Optional[str] = None,
             node_spec: Optional[str] = None,
             db_time_zone: Optional[str] = None,
             lower_case_table_names: Optional[str] = None,
             instance_name: Optional[str] = None,
             auto_renew: Optional[bool] = None,
             period: Optional[int] = None,
             period_unit: Optional[str] = None,
             port: Optional[int] = None,
             pre_paid_storage_in_gb: Optional[int] = None,
             project_name: Optional[str] = None,
             storage_charge_type: Optional[str] = None,
             db_minor_version: Optional[str] = None,
             tags: Optional[Sequence[InstanceTagArgs]] = 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: volcengine:vedb_mysql:Instance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleinstanceResourceResourceFromVedb_mysqlinstance = new Volcengine.Vedb_mysql.Instance("exampleinstanceResourceResourceFromVedb_mysqlinstance", new()
{
    NodeNumber = 0,
    ChargeType = "string",
    DbEngineVersion = "string",
    SubnetId = "string",
    NodeSpec = "string",
    DbTimeZone = "string",
    LowerCaseTableNames = "string",
    InstanceName = "string",
    AutoRenew = false,
    Period = 0,
    PeriodUnit = "string",
    Port = 0,
    PrePaidStorageInGb = 0,
    ProjectName = "string",
    StorageChargeType = "string",
    DbMinorVersion = "string",
    Tags = new[]
    {
        new Volcengine.Vedb_mysql.Inputs.InstanceTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
});

    example, err := vedb_mysql.NewInstance(ctx, "exampleinstanceResourceResourceFromVedb_mysqlinstance", &vedb_mysql.InstanceArgs{
	NodeNumber:          pulumi.Int(0),
	ChargeType:          pulumi.String("string"),
	DbEngineVersion:     pulumi.String("string"),
	SubnetId:            pulumi.String("string"),
	NodeSpec:            pulumi.String("string"),
	DbTimeZone:          pulumi.String("string"),
	LowerCaseTableNames: pulumi.String("string"),
	InstanceName:        pulumi.String("string"),
	AutoRenew:           pulumi.Bool(false),
	Period:              pulumi.Int(0),
	PeriodUnit:          pulumi.String("string"),
	Port:                pulumi.Int(0),
	PrePaidStorageInGb:  pulumi.Int(0),
	ProjectName:         pulumi.String("string"),
	StorageChargeType:   pulumi.String("string"),
	DbMinorVersion:      pulumi.String("string"),
	Tags: vedb_mysql.InstanceTagArray{
		&vedb_mysql.InstanceTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
})

    var exampleinstanceResourceResourceFromVedb_mysqlinstance = new Instance("exampleinstanceResourceResourceFromVedb_mysqlinstance", InstanceArgs.builder()
    .nodeNumber(0)
    .chargeType("string")
    .dbEngineVersion("string")
    .subnetId("string")
    .nodeSpec("string")
    .dbTimeZone("string")
    .lowerCaseTableNames("string")
    .instanceName("string")
    .autoRenew(false)
    .period(0)
    .periodUnit("string")
    .port(0)
    .prePaidStorageInGb(0)
    .projectName("string")
    .storageChargeType("string")
    .dbMinorVersion("string")
    .tags(InstanceTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .build());

    exampleinstance_resource_resource_from_vedb_mysqlinstance = volcengine.vedb_mysql.Instance("exampleinstanceResourceResourceFromVedb_mysqlinstance",
    node_number=0,
    charge_type="string",
    db_engine_version="string",
    subnet_id="string",
    node_spec="string",
    db_time_zone="string",
    lower_case_table_names="string",
    instance_name="string",
    auto_renew=False,
    period=0,
    period_unit="string",
    port=0,
    pre_paid_storage_in_gb=0,
    project_name="string",
    storage_charge_type="string",
    db_minor_version="string",
    tags=[{
        "key": "string",
        "value": "string",
    }])

    const exampleinstanceResourceResourceFromVedb_mysqlinstance = new volcengine.vedb_mysql.Instance("exampleinstanceResourceResourceFromVedb_mysqlinstance", {
    nodeNumber: 0,
    chargeType: "string",
    dbEngineVersion: "string",
    subnetId: "string",
    nodeSpec: "string",
    dbTimeZone: "string",
    lowerCaseTableNames: "string",
    instanceName: "string",
    autoRenew: false,
    period: 0,
    periodUnit: "string",
    port: 0,
    prePaidStorageInGb: 0,
    projectName: "string",
    storageChargeType: "string",
    dbMinorVersion: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
});

    type: volcengine:vedb_mysql:Instance
properties:
    autoRenew: false
    chargeType: string
    dbEngineVersion: string
    dbMinorVersion: string
    dbTimeZone: string
    instanceName: string
    lowerCaseTableNames: string
    nodeNumber: 0
    nodeSpec: string
    period: 0
    periodUnit: string
    port: 0
    prePaidStorageInGb: 0
    projectName: string
    storageChargeType: string
    subnetId: string
    tags:
        - key: string
          value: string

    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:

    ChargeType string
    Calculate the billing type. When calculating the billing type during instance creation, the possible values are as follows: PostPaid: Pay-as-you-go (postpaid). PrePaid: Monthly or yearly subscription (prepaid).
    DbEngineVersion string
    Database engine version, with a fixed value of MySQL_8_0.
    NodeNumber int
    Number of instance nodes. The value range is from 2 to 16.
    NodeSpec string
    Node specification code of an instance.
    SubnetId string
    Subnet ID of the veDB Mysql instance.
    AutoRenew bool
    Whether to automatically renew under the prepaid scenario. Values: true: Automatically renew. false: Do not automatically renew. Description: When the value of ChargeType (billing type) is PrePaid (monthly/yearly package), this parameter is required.
    DbMinorVersion string
    veDB MySQL minor version. For detailed instructions on version numbers, please refer to Version Number Management. 3.0 (default): veDB MySQL stable version, 100% compatible with MySQL 8.0. 3.1: Natively supports HTAP application scenarios and accelerates complex queries. 3.2: Natively supports HTAP application scenarios and accelerates complex queries. In addition, it has built-in cold data archiving capabilities. It can archive data with low-frequency access to object storage TOS to reduce storage costs.
    DbTimeZone string
    Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    InstanceName string
    Instance name. Naming rules: It cannot start with a number or a hyphen (-). It can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-). The length must be within 1 to 128 characters. Description If the instance name is not filled in, the instance ID will be used as the instance name. When creating instances in batches, if an instance name is passed in, a serial number will be automatically added after the instance name.
    LowerCaseTableNames string
    Whether table names are case-sensitive. The default value is 1. Value range: 0: Table names are case-sensitive. The backend stores them according to the actual table name. 1: (default) Table names are not case-sensitive. The backend stores them by converting table names to lowercase letters. Description: This rule cannot be modified after creating an instance. Please set it reasonably according to business requirements.
    Period int
    Purchase duration in prepaid scenarios. Description: When the value of ChargeType (computing billing type) is PrePaid (monthly/yearly package), this parameter is required.
    PeriodUnit string
    Purchase cycle in prepaid scenarios. Month: Monthly package. Year: Annual package. Description: When the value of ChargeType (computing billing type) is PrePaid (monthly or annual package), this parameter is required.
    Port int
    Specify the private network port number for the connection terminal created by default for the instance. The default value is 3306, and the value range is 1000 to 65534. Note: This configuration item is only effective for the primary node terminal, default terminal, and HTAP cluster terminal. That is, after the instance is created successfully, for the newly created custom terminal, the port number is still 3306 by default. After the instance is created successfully, you can also modify the port number at any time. Currently, only modification through the console is supported.
    PrePaidStorageInGb int
    Storage size in prepaid scenarios. Description: When the value of StorageChargeType (storage billing type) is PrePaid (monthly/yearly prepaid), this parameter is required.
    ProjectName string
    Project name of the instance. When this parameter is left blank, the newly created instance is added to the default project by default.
    StorageChargeType string
    Storage billing type. When this parameter is not passed, the storage billing type defaults to be the same as the computing billing type. The values are as follows: PostPaid: Pay-as-you-go (postpaid). PrePaid: Monthly or yearly subscription (prepaid). Note When the computing billing type is PostPaid, the storage billing type can only be PostPaid. When the computing billing type is PrePaid, the storage billing type can be PrePaid or PostPaid.
    Tags List<InstanceTag>
    Tags.
    ChargeType string
    Calculate the billing type. When calculating the billing type during instance creation, the possible values are as follows: PostPaid: Pay-as-you-go (postpaid). PrePaid: Monthly or yearly subscription (prepaid).
    DbEngineVersion string
    Database engine version, with a fixed value of MySQL_8_0.
    NodeNumber int
    Number of instance nodes. The value range is from 2 to 16.
    NodeSpec string
    Node specification code of an instance.
    SubnetId string
    Subnet ID of the veDB Mysql instance.
    AutoRenew bool
    Whether to automatically renew under the prepaid scenario. Values: true: Automatically renew. false: Do not automatically renew. Description: When the value of ChargeType (billing type) is PrePaid (monthly/yearly package), this parameter is required.
    DbMinorVersion string
    veDB MySQL minor version. For detailed instructions on version numbers, please refer to Version Number Management. 3.0 (default): veDB MySQL stable version, 100% compatible with MySQL 8.0. 3.1: Natively supports HTAP application scenarios and accelerates complex queries. 3.2: Natively supports HTAP application scenarios and accelerates complex queries. In addition, it has built-in cold data archiving capabilities. It can archive data with low-frequency access to object storage TOS to reduce storage costs.
    DbTimeZone string
    Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    InstanceName string
    Instance name. Naming rules: It cannot start with a number or a hyphen (-). It can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-). The length must be within 1 to 128 characters. Description If the instance name is not filled in, the instance ID will be used as the instance name. When creating instances in batches, if an instance name is passed in, a serial number will be automatically added after the instance name.
    LowerCaseTableNames string
    Whether table names are case-sensitive. The default value is 1. Value range: 0: Table names are case-sensitive. The backend stores them according to the actual table name. 1: (default) Table names are not case-sensitive. The backend stores them by converting table names to lowercase letters. Description: This rule cannot be modified after creating an instance. Please set it reasonably according to business requirements.
    Period int
    Purchase duration in prepaid scenarios. Description: When the value of ChargeType (computing billing type) is PrePaid (monthly/yearly package), this parameter is required.
    PeriodUnit string
    Purchase cycle in prepaid scenarios. Month: Monthly package. Year: Annual package. Description: When the value of ChargeType (computing billing type) is PrePaid (monthly or annual package), this parameter is required.
    Port int
    Specify the private network port number for the connection terminal created by default for the instance. The default value is 3306, and the value range is 1000 to 65534. Note: This configuration item is only effective for the primary node terminal, default terminal, and HTAP cluster terminal. That is, after the instance is created successfully, for the newly created custom terminal, the port number is still 3306 by default. After the instance is created successfully, you can also modify the port number at any time. Currently, only modification through the console is supported.
    PrePaidStorageInGb int
    Storage size in prepaid scenarios. Description: When the value of StorageChargeType (storage billing type) is PrePaid (monthly/yearly prepaid), this parameter is required.
    ProjectName string
    Project name of the instance. When this parameter is left blank, the newly created instance is added to the default project by default.
    StorageChargeType string
    Storage billing type. When this parameter is not passed, the storage billing type defaults to be the same as the computing billing type. The values are as follows: PostPaid: Pay-as-you-go (postpaid). PrePaid: Monthly or yearly subscription (prepaid). Note When the computing billing type is PostPaid, the storage billing type can only be PostPaid. When the computing billing type is PrePaid, the storage billing type can be PrePaid or PostPaid.
    Tags []InstanceTagArgs
    Tags.
    chargeType String
    Calculate the billing type. When calculating the billing type during instance creation, the possible values are as follows: PostPaid: Pay-as-you-go (postpaid). PrePaid: Monthly or yearly subscription (prepaid).
    dbEngineVersion String
    Database engine version, with a fixed value of MySQL_8_0.
    nodeNumber Integer
    Number of instance nodes. The value range is from 2 to 16.
    nodeSpec String
    Node specification code of an instance.
    subnetId String
    Subnet ID of the veDB Mysql instance.
    autoRenew Boolean
    Whether to automatically renew under the prepaid scenario. Values: true: Automatically renew. false: Do not automatically renew. Description: When the value of ChargeType (billing type) is PrePaid (monthly/yearly package), this parameter is required.
    dbMinorVersion String
    veDB MySQL minor version. For detailed instructions on version numbers, please refer to Version Number Management. 3.0 (default): veDB MySQL stable version, 100% compatible with MySQL 8.0. 3.1: Natively supports HTAP application scenarios and accelerates complex queries. 3.2: Natively supports HTAP application scenarios and accelerates complex queries. In addition, it has built-in cold data archiving capabilities. It can archive data with low-frequency access to object storage TOS to reduce storage costs.
    dbTimeZone String
    Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    instanceName String
    Instance name. Naming rules: It cannot start with a number or a hyphen (-). It can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-). The length must be within 1 to 128 characters. Description If the instance name is not filled in, the instance ID will be used as the instance name. When creating instances in batches, if an instance name is passed in, a serial number will be automatically added after the instance name.
    lowerCaseTableNames String
    Whether table names are case-sensitive. The default value is 1. Value range: 0: Table names are case-sensitive. The backend stores them according to the actual table name. 1: (default) Table names are not case-sensitive. The backend stores them by converting table names to lowercase letters. Description: This rule cannot be modified after creating an instance. Please set it reasonably according to business requirements.
    period Integer
    Purchase duration in prepaid scenarios. Description: When the value of ChargeType (computing billing type) is PrePaid (monthly/yearly package), this parameter is required.
    periodUnit String
    Purchase cycle in prepaid scenarios. Month: Monthly package. Year: Annual package. Description: When the value of ChargeType (computing billing type) is PrePaid (monthly or annual package), this parameter is required.
    port Integer
    Specify the private network port number for the connection terminal created by default for the instance. The default value is 3306, and the value range is 1000 to 65534. Note: This configuration item is only effective for the primary node terminal, default terminal, and HTAP cluster terminal. That is, after the instance is created successfully, for the newly created custom terminal, the port number is still 3306 by default. After the instance is created successfully, you can also modify the port number at any time. Currently, only modification through the console is supported.
    prePaidStorageInGb Integer
    Storage size in prepaid scenarios. Description: When the value of StorageChargeType (storage billing type) is PrePaid (monthly/yearly prepaid), this parameter is required.
    projectName String
    Project name of the instance. When this parameter is left blank, the newly created instance is added to the default project by default.
    storageChargeType String
    Storage billing type. When this parameter is not passed, the storage billing type defaults to be the same as the computing billing type. The values are as follows: PostPaid: Pay-as-you-go (postpaid). PrePaid: Monthly or yearly subscription (prepaid). Note When the computing billing type is PostPaid, the storage billing type can only be PostPaid. When the computing billing type is PrePaid, the storage billing type can be PrePaid or PostPaid.
    tags List<InstanceTag>
    Tags.
    chargeType string
    Calculate the billing type. When calculating the billing type during instance creation, the possible values are as follows: PostPaid: Pay-as-you-go (postpaid). PrePaid: Monthly or yearly subscription (prepaid).
    dbEngineVersion string
    Database engine version, with a fixed value of MySQL_8_0.
    nodeNumber number
    Number of instance nodes. The value range is from 2 to 16.
    nodeSpec string
    Node specification code of an instance.
    subnetId string
    Subnet ID of the veDB Mysql instance.
    autoRenew boolean
    Whether to automatically renew under the prepaid scenario. Values: true: Automatically renew. false: Do not automatically renew. Description: When the value of ChargeType (billing type) is PrePaid (monthly/yearly package), this parameter is required.
    dbMinorVersion string
    veDB MySQL minor version. For detailed instructions on version numbers, please refer to Version Number Management. 3.0 (default): veDB MySQL stable version, 100% compatible with MySQL 8.0. 3.1: Natively supports HTAP application scenarios and accelerates complex queries. 3.2: Natively supports HTAP application scenarios and accelerates complex queries. In addition, it has built-in cold data archiving capabilities. It can archive data with low-frequency access to object storage TOS to reduce storage costs.
    dbTimeZone string
    Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    instanceName string
    Instance name. Naming rules: It cannot start with a number or a hyphen (-). It can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-). The length must be within 1 to 128 characters. Description If the instance name is not filled in, the instance ID will be used as the instance name. When creating instances in batches, if an instance name is passed in, a serial number will be automatically added after the instance name.
    lowerCaseTableNames string
    Whether table names are case-sensitive. The default value is 1. Value range: 0: Table names are case-sensitive. The backend stores them according to the actual table name. 1: (default) Table names are not case-sensitive. The backend stores them by converting table names to lowercase letters. Description: This rule cannot be modified after creating an instance. Please set it reasonably according to business requirements.
    period number
    Purchase duration in prepaid scenarios. Description: When the value of ChargeType (computing billing type) is PrePaid (monthly/yearly package), this parameter is required.
    periodUnit string
    Purchase cycle in prepaid scenarios. Month: Monthly package. Year: Annual package. Description: When the value of ChargeType (computing billing type) is PrePaid (monthly or annual package), this parameter is required.
    port number
    Specify the private network port number for the connection terminal created by default for the instance. The default value is 3306, and the value range is 1000 to 65534. Note: This configuration item is only effective for the primary node terminal, default terminal, and HTAP cluster terminal. That is, after the instance is created successfully, for the newly created custom terminal, the port number is still 3306 by default. After the instance is created successfully, you can also modify the port number at any time. Currently, only modification through the console is supported.
    prePaidStorageInGb number
    Storage size in prepaid scenarios. Description: When the value of StorageChargeType (storage billing type) is PrePaid (monthly/yearly prepaid), this parameter is required.
    projectName string
    Project name of the instance. When this parameter is left blank, the newly created instance is added to the default project by default.
    storageChargeType string
    Storage billing type. When this parameter is not passed, the storage billing type defaults to be the same as the computing billing type. The values are as follows: PostPaid: Pay-as-you-go (postpaid). PrePaid: Monthly or yearly subscription (prepaid). Note When the computing billing type is PostPaid, the storage billing type can only be PostPaid. When the computing billing type is PrePaid, the storage billing type can be PrePaid or PostPaid.
    tags InstanceTag[]
    Tags.
    charge_type str
    Calculate the billing type. When calculating the billing type during instance creation, the possible values are as follows: PostPaid: Pay-as-you-go (postpaid). PrePaid: Monthly or yearly subscription (prepaid).
    db_engine_version str
    Database engine version, with a fixed value of MySQL_8_0.
    node_number int
    Number of instance nodes. The value range is from 2 to 16.
    node_spec str
    Node specification code of an instance.
    subnet_id str
    Subnet ID of the veDB Mysql instance.
    auto_renew bool
    Whether to automatically renew under the prepaid scenario. Values: true: Automatically renew. false: Do not automatically renew. Description: When the value of ChargeType (billing type) is PrePaid (monthly/yearly package), this parameter is required.
    db_minor_version str
    veDB MySQL minor version. For detailed instructions on version numbers, please refer to Version Number Management. 3.0 (default): veDB MySQL stable version, 100% compatible with MySQL 8.0. 3.1: Natively supports HTAP application scenarios and accelerates complex queries. 3.2: Natively supports HTAP application scenarios and accelerates complex queries. In addition, it has built-in cold data archiving capabilities. It can archive data with low-frequency access to object storage TOS to reduce storage costs.
    db_time_zone str
    Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    instance_name str
    Instance name. Naming rules: It cannot start with a number or a hyphen (-). It can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-). The length must be within 1 to 128 characters. Description If the instance name is not filled in, the instance ID will be used as the instance name. When creating instances in batches, if an instance name is passed in, a serial number will be automatically added after the instance name.
    lower_case_table_names str
    Whether table names are case-sensitive. The default value is 1. Value range: 0: Table names are case-sensitive. The backend stores them according to the actual table name. 1: (default) Table names are not case-sensitive. The backend stores them by converting table names to lowercase letters. Description: This rule cannot be modified after creating an instance. Please set it reasonably according to business requirements.
    period int
    Purchase duration in prepaid scenarios. Description: When the value of ChargeType (computing billing type) is PrePaid (monthly/yearly package), this parameter is required.
    period_unit str
    Purchase cycle in prepaid scenarios. Month: Monthly package. Year: Annual package. Description: When the value of ChargeType (computing billing type) is PrePaid (monthly or annual package), this parameter is required.
    port int
    Specify the private network port number for the connection terminal created by default for the instance. The default value is 3306, and the value range is 1000 to 65534. Note: This configuration item is only effective for the primary node terminal, default terminal, and HTAP cluster terminal. That is, after the instance is created successfully, for the newly created custom terminal, the port number is still 3306 by default. After the instance is created successfully, you can also modify the port number at any time. Currently, only modification through the console is supported.
    pre_paid_storage_in_gb int
    Storage size in prepaid scenarios. Description: When the value of StorageChargeType (storage billing type) is PrePaid (monthly/yearly prepaid), this parameter is required.
    project_name str
    Project name of the instance. When this parameter is left blank, the newly created instance is added to the default project by default.
    storage_charge_type str
    Storage billing type. When this parameter is not passed, the storage billing type defaults to be the same as the computing billing type. The values are as follows: PostPaid: Pay-as-you-go (postpaid). PrePaid: Monthly or yearly subscription (prepaid). Note When the computing billing type is PostPaid, the storage billing type can only be PostPaid. When the computing billing type is PrePaid, the storage billing type can be PrePaid or PostPaid.
    tags Sequence[InstanceTagArgs]
    Tags.
    chargeType String
    Calculate the billing type. When calculating the billing type during instance creation, the possible values are as follows: PostPaid: Pay-as-you-go (postpaid). PrePaid: Monthly or yearly subscription (prepaid).
    dbEngineVersion String
    Database engine version, with a fixed value of MySQL_8_0.
    nodeNumber Number
    Number of instance nodes. The value range is from 2 to 16.
    nodeSpec String
    Node specification code of an instance.
    subnetId String
    Subnet ID of the veDB Mysql instance.
    autoRenew Boolean
    Whether to automatically renew under the prepaid scenario. Values: true: Automatically renew. false: Do not automatically renew. Description: When the value of ChargeType (billing type) is PrePaid (monthly/yearly package), this parameter is required.
    dbMinorVersion String
    veDB MySQL minor version. For detailed instructions on version numbers, please refer to Version Number Management. 3.0 (default): veDB MySQL stable version, 100% compatible with MySQL 8.0. 3.1: Natively supports HTAP application scenarios and accelerates complex queries. 3.2: Natively supports HTAP application scenarios and accelerates complex queries. In addition, it has built-in cold data archiving capabilities. It can archive data with low-frequency access to object storage TOS to reduce storage costs.
    dbTimeZone String
    Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    instanceName String
    Instance name. Naming rules: It cannot start with a number or a hyphen (-). It can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-). The length must be within 1 to 128 characters. Description If the instance name is not filled in, the instance ID will be used as the instance name. When creating instances in batches, if an instance name is passed in, a serial number will be automatically added after the instance name.
    lowerCaseTableNames String
    Whether table names are case-sensitive. The default value is 1. Value range: 0: Table names are case-sensitive. The backend stores them according to the actual table name. 1: (default) Table names are not case-sensitive. The backend stores them by converting table names to lowercase letters. Description: This rule cannot be modified after creating an instance. Please set it reasonably according to business requirements.
    period Number
    Purchase duration in prepaid scenarios. Description: When the value of ChargeType (computing billing type) is PrePaid (monthly/yearly package), this parameter is required.
    periodUnit String
    Purchase cycle in prepaid scenarios. Month: Monthly package. Year: Annual package. Description: When the value of ChargeType (computing billing type) is PrePaid (monthly or annual package), this parameter is required.
    port Number
    Specify the private network port number for the connection terminal created by default for the instance. The default value is 3306, and the value range is 1000 to 65534. Note: This configuration item is only effective for the primary node terminal, default terminal, and HTAP cluster terminal. That is, after the instance is created successfully, for the newly created custom terminal, the port number is still 3306 by default. After the instance is created successfully, you can also modify the port number at any time. Currently, only modification through the console is supported.
    prePaidStorageInGb Number
    Storage size in prepaid scenarios. Description: When the value of StorageChargeType (storage billing type) is PrePaid (monthly/yearly prepaid), this parameter is required.
    projectName String
    Project name of the instance. When this parameter is left blank, the newly created instance is added to the default project by default.
    storageChargeType String
    Storage billing type. When this parameter is not passed, the storage billing type defaults to be the same as the computing billing type. The values are as follows: PostPaid: Pay-as-you-go (postpaid). PrePaid: Monthly or yearly subscription (prepaid). Note When the computing billing type is PostPaid, the storage billing type can only be PostPaid. When the computing billing type is PrePaid, the storage billing type can be PrePaid or PostPaid.
    tags List<Property Map>
    Tags.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    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,
        auto_renew: Optional[bool] = None,
        charge_type: Optional[str] = None,
        db_engine_version: Optional[str] = None,
        db_minor_version: Optional[str] = None,
        db_time_zone: Optional[str] = None,
        instance_name: Optional[str] = None,
        lower_case_table_names: Optional[str] = None,
        node_number: Optional[int] = None,
        node_spec: Optional[str] = None,
        period: Optional[int] = None,
        period_unit: Optional[str] = None,
        port: Optional[int] = None,
        pre_paid_storage_in_gb: Optional[int] = None,
        project_name: Optional[str] = None,
        storage_charge_type: Optional[str] = None,
        subnet_id: Optional[str] = None,
        tags: Optional[Sequence[InstanceTagArgs]] = 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: volcengine:vedb_mysql:Instance    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AutoRenew bool
    Whether to automatically renew under the prepaid scenario. Values: true: Automatically renew. false: Do not automatically renew. Description: When the value of ChargeType (billing type) is PrePaid (monthly/yearly package), this parameter is required.
    ChargeType string
    Calculate the billing type. When calculating the billing type during instance creation, the possible values are as follows: PostPaid: Pay-as-you-go (postpaid). PrePaid: Monthly or yearly subscription (prepaid).
    DbEngineVersion string
    Database engine version, with a fixed value of MySQL_8_0.
    DbMinorVersion string
    veDB MySQL minor version. For detailed instructions on version numbers, please refer to Version Number Management. 3.0 (default): veDB MySQL stable version, 100% compatible with MySQL 8.0. 3.1: Natively supports HTAP application scenarios and accelerates complex queries. 3.2: Natively supports HTAP application scenarios and accelerates complex queries. In addition, it has built-in cold data archiving capabilities. It can archive data with low-frequency access to object storage TOS to reduce storage costs.
    DbTimeZone string
    Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    InstanceName string
    Instance name. Naming rules: It cannot start with a number or a hyphen (-). It can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-). The length must be within 1 to 128 characters. Description If the instance name is not filled in, the instance ID will be used as the instance name. When creating instances in batches, if an instance name is passed in, a serial number will be automatically added after the instance name.
    LowerCaseTableNames string
    Whether table names are case-sensitive. The default value is 1. Value range: 0: Table names are case-sensitive. The backend stores them according to the actual table name. 1: (default) Table names are not case-sensitive. The backend stores them by converting table names to lowercase letters. Description: This rule cannot be modified after creating an instance. Please set it reasonably according to business requirements.
    NodeNumber int
    Number of instance nodes. The value range is from 2 to 16.
    NodeSpec string
    Node specification code of an instance.
    Period int
    Purchase duration in prepaid scenarios. Description: When the value of ChargeType (computing billing type) is PrePaid (monthly/yearly package), this parameter is required.
    PeriodUnit string
    Purchase cycle in prepaid scenarios. Month: Monthly package. Year: Annual package. Description: When the value of ChargeType (computing billing type) is PrePaid (monthly or annual package), this parameter is required.
    Port int
    Specify the private network port number for the connection terminal created by default for the instance. The default value is 3306, and the value range is 1000 to 65534. Note: This configuration item is only effective for the primary node terminal, default terminal, and HTAP cluster terminal. That is, after the instance is created successfully, for the newly created custom terminal, the port number is still 3306 by default. After the instance is created successfully, you can also modify the port number at any time. Currently, only modification through the console is supported.
    PrePaidStorageInGb int
    Storage size in prepaid scenarios. Description: When the value of StorageChargeType (storage billing type) is PrePaid (monthly/yearly prepaid), this parameter is required.
    ProjectName string
    Project name of the instance. When this parameter is left blank, the newly created instance is added to the default project by default.
    StorageChargeType string
    Storage billing type. When this parameter is not passed, the storage billing type defaults to be the same as the computing billing type. The values are as follows: PostPaid: Pay-as-you-go (postpaid). PrePaid: Monthly or yearly subscription (prepaid). Note When the computing billing type is PostPaid, the storage billing type can only be PostPaid. When the computing billing type is PrePaid, the storage billing type can be PrePaid or PostPaid.
    SubnetId string
    Subnet ID of the veDB Mysql instance.
    Tags List<InstanceTag>
    Tags.
    AutoRenew bool
    Whether to automatically renew under the prepaid scenario. Values: true: Automatically renew. false: Do not automatically renew. Description: When the value of ChargeType (billing type) is PrePaid (monthly/yearly package), this parameter is required.
    ChargeType string
    Calculate the billing type. When calculating the billing type during instance creation, the possible values are as follows: PostPaid: Pay-as-you-go (postpaid). PrePaid: Monthly or yearly subscription (prepaid).
    DbEngineVersion string
    Database engine version, with a fixed value of MySQL_8_0.
    DbMinorVersion string
    veDB MySQL minor version. For detailed instructions on version numbers, please refer to Version Number Management. 3.0 (default): veDB MySQL stable version, 100% compatible with MySQL 8.0. 3.1: Natively supports HTAP application scenarios and accelerates complex queries. 3.2: Natively supports HTAP application scenarios and accelerates complex queries. In addition, it has built-in cold data archiving capabilities. It can archive data with low-frequency access to object storage TOS to reduce storage costs.
    DbTimeZone string
    Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    InstanceName string
    Instance name. Naming rules: It cannot start with a number or a hyphen (-). It can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-). The length must be within 1 to 128 characters. Description If the instance name is not filled in, the instance ID will be used as the instance name. When creating instances in batches, if an instance name is passed in, a serial number will be automatically added after the instance name.
    LowerCaseTableNames string
    Whether table names are case-sensitive. The default value is 1. Value range: 0: Table names are case-sensitive. The backend stores them according to the actual table name. 1: (default) Table names are not case-sensitive. The backend stores them by converting table names to lowercase letters. Description: This rule cannot be modified after creating an instance. Please set it reasonably according to business requirements.
    NodeNumber int
    Number of instance nodes. The value range is from 2 to 16.
    NodeSpec string
    Node specification code of an instance.
    Period int
    Purchase duration in prepaid scenarios. Description: When the value of ChargeType (computing billing type) is PrePaid (monthly/yearly package), this parameter is required.
    PeriodUnit string
    Purchase cycle in prepaid scenarios. Month: Monthly package. Year: Annual package. Description: When the value of ChargeType (computing billing type) is PrePaid (monthly or annual package), this parameter is required.
    Port int
    Specify the private network port number for the connection terminal created by default for the instance. The default value is 3306, and the value range is 1000 to 65534. Note: This configuration item is only effective for the primary node terminal, default terminal, and HTAP cluster terminal. That is, after the instance is created successfully, for the newly created custom terminal, the port number is still 3306 by default. After the instance is created successfully, you can also modify the port number at any time. Currently, only modification through the console is supported.
    PrePaidStorageInGb int
    Storage size in prepaid scenarios. Description: When the value of StorageChargeType (storage billing type) is PrePaid (monthly/yearly prepaid), this parameter is required.
    ProjectName string
    Project name of the instance. When this parameter is left blank, the newly created instance is added to the default project by default.
    StorageChargeType string
    Storage billing type. When this parameter is not passed, the storage billing type defaults to be the same as the computing billing type. The values are as follows: PostPaid: Pay-as-you-go (postpaid). PrePaid: Monthly or yearly subscription (prepaid). Note When the computing billing type is PostPaid, the storage billing type can only be PostPaid. When the computing billing type is PrePaid, the storage billing type can be PrePaid or PostPaid.
    SubnetId string
    Subnet ID of the veDB Mysql instance.
    Tags []InstanceTagArgs
    Tags.
    autoRenew Boolean
    Whether to automatically renew under the prepaid scenario. Values: true: Automatically renew. false: Do not automatically renew. Description: When the value of ChargeType (billing type) is PrePaid (monthly/yearly package), this parameter is required.
    chargeType String
    Calculate the billing type. When calculating the billing type during instance creation, the possible values are as follows: PostPaid: Pay-as-you-go (postpaid). PrePaid: Monthly or yearly subscription (prepaid).
    dbEngineVersion String
    Database engine version, with a fixed value of MySQL_8_0.
    dbMinorVersion String
    veDB MySQL minor version. For detailed instructions on version numbers, please refer to Version Number Management. 3.0 (default): veDB MySQL stable version, 100% compatible with MySQL 8.0. 3.1: Natively supports HTAP application scenarios and accelerates complex queries. 3.2: Natively supports HTAP application scenarios and accelerates complex queries. In addition, it has built-in cold data archiving capabilities. It can archive data with low-frequency access to object storage TOS to reduce storage costs.
    dbTimeZone String
    Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    instanceName String
    Instance name. Naming rules: It cannot start with a number or a hyphen (-). It can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-). The length must be within 1 to 128 characters. Description If the instance name is not filled in, the instance ID will be used as the instance name. When creating instances in batches, if an instance name is passed in, a serial number will be automatically added after the instance name.
    lowerCaseTableNames String
    Whether table names are case-sensitive. The default value is 1. Value range: 0: Table names are case-sensitive. The backend stores them according to the actual table name. 1: (default) Table names are not case-sensitive. The backend stores them by converting table names to lowercase letters. Description: This rule cannot be modified after creating an instance. Please set it reasonably according to business requirements.
    nodeNumber Integer
    Number of instance nodes. The value range is from 2 to 16.
    nodeSpec String
    Node specification code of an instance.
    period Integer
    Purchase duration in prepaid scenarios. Description: When the value of ChargeType (computing billing type) is PrePaid (monthly/yearly package), this parameter is required.
    periodUnit String
    Purchase cycle in prepaid scenarios. Month: Monthly package. Year: Annual package. Description: When the value of ChargeType (computing billing type) is PrePaid (monthly or annual package), this parameter is required.
    port Integer
    Specify the private network port number for the connection terminal created by default for the instance. The default value is 3306, and the value range is 1000 to 65534. Note: This configuration item is only effective for the primary node terminal, default terminal, and HTAP cluster terminal. That is, after the instance is created successfully, for the newly created custom terminal, the port number is still 3306 by default. After the instance is created successfully, you can also modify the port number at any time. Currently, only modification through the console is supported.
    prePaidStorageInGb Integer
    Storage size in prepaid scenarios. Description: When the value of StorageChargeType (storage billing type) is PrePaid (monthly/yearly prepaid), this parameter is required.
    projectName String
    Project name of the instance. When this parameter is left blank, the newly created instance is added to the default project by default.
    storageChargeType String
    Storage billing type. When this parameter is not passed, the storage billing type defaults to be the same as the computing billing type. The values are as follows: PostPaid: Pay-as-you-go (postpaid). PrePaid: Monthly or yearly subscription (prepaid). Note When the computing billing type is PostPaid, the storage billing type can only be PostPaid. When the computing billing type is PrePaid, the storage billing type can be PrePaid or PostPaid.
    subnetId String
    Subnet ID of the veDB Mysql instance.
    tags List<InstanceTag>
    Tags.
    autoRenew boolean
    Whether to automatically renew under the prepaid scenario. Values: true: Automatically renew. false: Do not automatically renew. Description: When the value of ChargeType (billing type) is PrePaid (monthly/yearly package), this parameter is required.
    chargeType string
    Calculate the billing type. When calculating the billing type during instance creation, the possible values are as follows: PostPaid: Pay-as-you-go (postpaid). PrePaid: Monthly or yearly subscription (prepaid).
    dbEngineVersion string
    Database engine version, with a fixed value of MySQL_8_0.
    dbMinorVersion string
    veDB MySQL minor version. For detailed instructions on version numbers, please refer to Version Number Management. 3.0 (default): veDB MySQL stable version, 100% compatible with MySQL 8.0. 3.1: Natively supports HTAP application scenarios and accelerates complex queries. 3.2: Natively supports HTAP application scenarios and accelerates complex queries. In addition, it has built-in cold data archiving capabilities. It can archive data with low-frequency access to object storage TOS to reduce storage costs.
    dbTimeZone string
    Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    instanceName string
    Instance name. Naming rules: It cannot start with a number or a hyphen (-). It can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-). The length must be within 1 to 128 characters. Description If the instance name is not filled in, the instance ID will be used as the instance name. When creating instances in batches, if an instance name is passed in, a serial number will be automatically added after the instance name.
    lowerCaseTableNames string
    Whether table names are case-sensitive. The default value is 1. Value range: 0: Table names are case-sensitive. The backend stores them according to the actual table name. 1: (default) Table names are not case-sensitive. The backend stores them by converting table names to lowercase letters. Description: This rule cannot be modified after creating an instance. Please set it reasonably according to business requirements.
    nodeNumber number
    Number of instance nodes. The value range is from 2 to 16.
    nodeSpec string
    Node specification code of an instance.
    period number
    Purchase duration in prepaid scenarios. Description: When the value of ChargeType (computing billing type) is PrePaid (monthly/yearly package), this parameter is required.
    periodUnit string
    Purchase cycle in prepaid scenarios. Month: Monthly package. Year: Annual package. Description: When the value of ChargeType (computing billing type) is PrePaid (monthly or annual package), this parameter is required.
    port number
    Specify the private network port number for the connection terminal created by default for the instance. The default value is 3306, and the value range is 1000 to 65534. Note: This configuration item is only effective for the primary node terminal, default terminal, and HTAP cluster terminal. That is, after the instance is created successfully, for the newly created custom terminal, the port number is still 3306 by default. After the instance is created successfully, you can also modify the port number at any time. Currently, only modification through the console is supported.
    prePaidStorageInGb number
    Storage size in prepaid scenarios. Description: When the value of StorageChargeType (storage billing type) is PrePaid (monthly/yearly prepaid), this parameter is required.
    projectName string
    Project name of the instance. When this parameter is left blank, the newly created instance is added to the default project by default.
    storageChargeType string
    Storage billing type. When this parameter is not passed, the storage billing type defaults to be the same as the computing billing type. The values are as follows: PostPaid: Pay-as-you-go (postpaid). PrePaid: Monthly or yearly subscription (prepaid). Note When the computing billing type is PostPaid, the storage billing type can only be PostPaid. When the computing billing type is PrePaid, the storage billing type can be PrePaid or PostPaid.
    subnetId string
    Subnet ID of the veDB Mysql instance.
    tags InstanceTag[]
    Tags.
    auto_renew bool
    Whether to automatically renew under the prepaid scenario. Values: true: Automatically renew. false: Do not automatically renew. Description: When the value of ChargeType (billing type) is PrePaid (monthly/yearly package), this parameter is required.
    charge_type str
    Calculate the billing type. When calculating the billing type during instance creation, the possible values are as follows: PostPaid: Pay-as-you-go (postpaid). PrePaid: Monthly or yearly subscription (prepaid).
    db_engine_version str
    Database engine version, with a fixed value of MySQL_8_0.
    db_minor_version str
    veDB MySQL minor version. For detailed instructions on version numbers, please refer to Version Number Management. 3.0 (default): veDB MySQL stable version, 100% compatible with MySQL 8.0. 3.1: Natively supports HTAP application scenarios and accelerates complex queries. 3.2: Natively supports HTAP application scenarios and accelerates complex queries. In addition, it has built-in cold data archiving capabilities. It can archive data with low-frequency access to object storage TOS to reduce storage costs.
    db_time_zone str
    Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    instance_name str
    Instance name. Naming rules: It cannot start with a number or a hyphen (-). It can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-). The length must be within 1 to 128 characters. Description If the instance name is not filled in, the instance ID will be used as the instance name. When creating instances in batches, if an instance name is passed in, a serial number will be automatically added after the instance name.
    lower_case_table_names str
    Whether table names are case-sensitive. The default value is 1. Value range: 0: Table names are case-sensitive. The backend stores them according to the actual table name. 1: (default) Table names are not case-sensitive. The backend stores them by converting table names to lowercase letters. Description: This rule cannot be modified after creating an instance. Please set it reasonably according to business requirements.
    node_number int
    Number of instance nodes. The value range is from 2 to 16.
    node_spec str
    Node specification code of an instance.
    period int
    Purchase duration in prepaid scenarios. Description: When the value of ChargeType (computing billing type) is PrePaid (monthly/yearly package), this parameter is required.
    period_unit str
    Purchase cycle in prepaid scenarios. Month: Monthly package. Year: Annual package. Description: When the value of ChargeType (computing billing type) is PrePaid (monthly or annual package), this parameter is required.
    port int
    Specify the private network port number for the connection terminal created by default for the instance. The default value is 3306, and the value range is 1000 to 65534. Note: This configuration item is only effective for the primary node terminal, default terminal, and HTAP cluster terminal. That is, after the instance is created successfully, for the newly created custom terminal, the port number is still 3306 by default. After the instance is created successfully, you can also modify the port number at any time. Currently, only modification through the console is supported.
    pre_paid_storage_in_gb int
    Storage size in prepaid scenarios. Description: When the value of StorageChargeType (storage billing type) is PrePaid (monthly/yearly prepaid), this parameter is required.
    project_name str
    Project name of the instance. When this parameter is left blank, the newly created instance is added to the default project by default.
    storage_charge_type str
    Storage billing type. When this parameter is not passed, the storage billing type defaults to be the same as the computing billing type. The values are as follows: PostPaid: Pay-as-you-go (postpaid). PrePaid: Monthly or yearly subscription (prepaid). Note When the computing billing type is PostPaid, the storage billing type can only be PostPaid. When the computing billing type is PrePaid, the storage billing type can be PrePaid or PostPaid.
    subnet_id str
    Subnet ID of the veDB Mysql instance.
    tags Sequence[InstanceTagArgs]
    Tags.
    autoRenew Boolean
    Whether to automatically renew under the prepaid scenario. Values: true: Automatically renew. false: Do not automatically renew. Description: When the value of ChargeType (billing type) is PrePaid (monthly/yearly package), this parameter is required.
    chargeType String
    Calculate the billing type. When calculating the billing type during instance creation, the possible values are as follows: PostPaid: Pay-as-you-go (postpaid). PrePaid: Monthly or yearly subscription (prepaid).
    dbEngineVersion String
    Database engine version, with a fixed value of MySQL_8_0.
    dbMinorVersion String
    veDB MySQL minor version. For detailed instructions on version numbers, please refer to Version Number Management. 3.0 (default): veDB MySQL stable version, 100% compatible with MySQL 8.0. 3.1: Natively supports HTAP application scenarios and accelerates complex queries. 3.2: Natively supports HTAP application scenarios and accelerates complex queries. In addition, it has built-in cold data archiving capabilities. It can archive data with low-frequency access to object storage TOS to reduce storage costs.
    dbTimeZone String
    Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    instanceName String
    Instance name. Naming rules: It cannot start with a number or a hyphen (-). It can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-). The length must be within 1 to 128 characters. Description If the instance name is not filled in, the instance ID will be used as the instance name. When creating instances in batches, if an instance name is passed in, a serial number will be automatically added after the instance name.
    lowerCaseTableNames String
    Whether table names are case-sensitive. The default value is 1. Value range: 0: Table names are case-sensitive. The backend stores them according to the actual table name. 1: (default) Table names are not case-sensitive. The backend stores them by converting table names to lowercase letters. Description: This rule cannot be modified after creating an instance. Please set it reasonably according to business requirements.
    nodeNumber Number
    Number of instance nodes. The value range is from 2 to 16.
    nodeSpec String
    Node specification code of an instance.
    period Number
    Purchase duration in prepaid scenarios. Description: When the value of ChargeType (computing billing type) is PrePaid (monthly/yearly package), this parameter is required.
    periodUnit String
    Purchase cycle in prepaid scenarios. Month: Monthly package. Year: Annual package. Description: When the value of ChargeType (computing billing type) is PrePaid (monthly or annual package), this parameter is required.
    port Number
    Specify the private network port number for the connection terminal created by default for the instance. The default value is 3306, and the value range is 1000 to 65534. Note: This configuration item is only effective for the primary node terminal, default terminal, and HTAP cluster terminal. That is, after the instance is created successfully, for the newly created custom terminal, the port number is still 3306 by default. After the instance is created successfully, you can also modify the port number at any time. Currently, only modification through the console is supported.
    prePaidStorageInGb Number
    Storage size in prepaid scenarios. Description: When the value of StorageChargeType (storage billing type) is PrePaid (monthly/yearly prepaid), this parameter is required.
    projectName String
    Project name of the instance. When this parameter is left blank, the newly created instance is added to the default project by default.
    storageChargeType String
    Storage billing type. When this parameter is not passed, the storage billing type defaults to be the same as the computing billing type. The values are as follows: PostPaid: Pay-as-you-go (postpaid). PrePaid: Monthly or yearly subscription (prepaid). Note When the computing billing type is PostPaid, the storage billing type can only be PostPaid. When the computing billing type is PrePaid, the storage billing type can be PrePaid or PostPaid.
    subnetId String
    Subnet ID of the veDB Mysql instance.
    tags List<Property Map>
    Tags.

    Supporting Types

    InstanceTag, InstanceTagArgs

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    Import

    VedbMysqlInstance can be imported using the id, e.g.

    $ pulumi import volcengine:vedb_mysql/instance:Instance default resource_id

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

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
    volcengine/pulumi-volcengine