Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. rdsmysql
  6. Instance
Viewing docs for volcenginecc v0.0.47
published on Thursday, Jul 9, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.rdsmysql.Instance

volcenginecc logo
Viewing docs for volcenginecc v0.0.47
published on Thursday, Jul 9, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Volcano Engine Cloud Database MySQL Edition is an elastic and reliable online relational database service built on the open-source MySQL database. MySQL instances are deployed using cloud-native methods and local SSD storage, delivering high-performance read and write capabilities. The service is fully compatible with the MySQL engine and offers a complete suite of solutions, including instance management, backup and recovery, log management, monitoring and alerts, and data migration. This helps enterprises simplify complex database management and operations, allowing them to focus more time and resources on their core business.

    Example Usage

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

const rDSMySQLInstanceDemo = new volcenginecc.rdsmysql.Instance("RDSMySQLInstanceDemo", {
    deletionProtection: "Disabled",
    dbEngineVersion: "MySQL_5_7",
    nodes: [
        {
            zone_id: "cn-beijing-a",
            node_spec: "rds.mysql.c.s.1c2g",
            node_type: "Primary",
        },
        {
            zone_id: "cn-beijing-a",
            node_spec: "rds.mysql.c.s.1c2g",
            node_type: "Secondary",
        },
        {
            zone_id: "cn-beijing-a",
            node_spec: "rds.mysql.c.s.1c2g",
            node_type: "ReadOnly",
        },
    ],
    storageType: "CloudESSD_PL0",
    storageSpace: 100,
    instanceType: "DoubleNode",
    vpcId: "vpc-rrco37ovjq4gv0x58xxxxx",
    subnetId: "subnet-rrwqhg3qzxfkv0x57xxxxx",
    instanceName: "RDSMySQLInstanceDemo",
    superAccountName: "test_account",
    superAccountPassword: "***********",
    lowerCaseTableNames: "1",
    dbTimeZone: "UTC +08:00",
    chargeDetail: {
        charge_type: "PostPaid",
        auto_renew: false,
        number: 1,
    },
    allowListIds: [
        "acl-8cde5e16f44143788234ca4489xxxxx",
        "acl-31f6053bd6be4cff88c1b205d20xxxxx",
    ],
    port: 3306,
    maintenanceWindow: {
        day_kind: "Week",
        day_of_week: ["Monday"],
        maintenance_time: "18:00Z-21:59Z",
    },
    autoStorageScalingConfig: {
        enable_storage_auto_scale: true,
        storage_threshold: 10,
        storage_upper_bound: 3000,
    },
    projectName: "default",
    tags: [{
        key: "env",
        value: "test",
    }],
});

    import pulumi
import pulumi_volcenginecc as volcenginecc

r_ds_my_sql_instance_demo = volcenginecc.rdsmysql.Instance("RDSMySQLInstanceDemo",
    deletion_protection="Disabled",
    db_engine_version="MySQL_5_7",
    nodes=[
        {
            "zone_id": "cn-beijing-a",
            "node_spec": "rds.mysql.c.s.1c2g",
            "node_type": "Primary",
        },
        {
            "zone_id": "cn-beijing-a",
            "node_spec": "rds.mysql.c.s.1c2g",
            "node_type": "Secondary",
        },
        {
            "zone_id": "cn-beijing-a",
            "node_spec": "rds.mysql.c.s.1c2g",
            "node_type": "ReadOnly",
        },
    ],
    storage_type="CloudESSD_PL0",
    storage_space=100,
    instance_type="DoubleNode",
    vpc_id="vpc-rrco37ovjq4gv0x58xxxxx",
    subnet_id="subnet-rrwqhg3qzxfkv0x57xxxxx",
    instance_name="RDSMySQLInstanceDemo",
    super_account_name="test_account",
    super_account_password="***********",
    lower_case_table_names="1",
    db_time_zone="UTC +08:00",
    charge_detail={
        "charge_type": "PostPaid",
        "auto_renew": False,
        "number": 1,
    },
    allow_list_ids=[
        "acl-8cde5e16f44143788234ca4489xxxxx",
        "acl-31f6053bd6be4cff88c1b205d20xxxxx",
    ],
    port=3306,
    maintenance_window={
        "day_kind": "Week",
        "day_of_week": ["Monday"],
        "maintenance_time": "18:00Z-21:59Z",
    },
    auto_storage_scaling_config={
        "enable_storage_auto_scale": True,
        "storage_threshold": 10,
        "storage_upper_bound": 3000,
    },
    project_name="default",
    tags=[{
        "key": "env",
        "value": "test",
    }])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/rdsmysql"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rdsmysql.NewInstance(ctx, "RDSMySQLInstanceDemo", &rdsmysql.InstanceArgs{
			DeletionProtection: pulumi.String("Disabled"),
			DbEngineVersion:    pulumi.String("MySQL_5_7"),
			Nodes: rdsmysql.InstanceNodeArray{
				&rdsmysql.InstanceNodeArgs{
					Zone_id:   "cn-beijing-a",
					Node_spec: "rds.mysql.c.s.1c2g",
					Node_type: "Primary",
				},
				&rdsmysql.InstanceNodeArgs{
					Zone_id:   "cn-beijing-a",
					Node_spec: "rds.mysql.c.s.1c2g",
					Node_type: "Secondary",
				},
				&rdsmysql.InstanceNodeArgs{
					Zone_id:   "cn-beijing-a",
					Node_spec: "rds.mysql.c.s.1c2g",
					Node_type: "ReadOnly",
				},
			},
			StorageType:          pulumi.String("CloudESSD_PL0"),
			StorageSpace:         pulumi.Int(100),
			InstanceType:         pulumi.String("DoubleNode"),
			VpcId:                pulumi.String("vpc-rrco37ovjq4gv0x58xxxxx"),
			SubnetId:             pulumi.String("subnet-rrwqhg3qzxfkv0x57xxxxx"),
			InstanceName:         pulumi.String("RDSMySQLInstanceDemo"),
			SuperAccountName:     pulumi.String("test_account"),
			SuperAccountPassword: pulumi.String("***********"),
			LowerCaseTableNames:  pulumi.String("1"),
			DbTimeZone:           pulumi.String("UTC +08:00"),
			ChargeDetail: &rdsmysql.InstanceChargeDetailArgs{
				Charge_type: "PostPaid",
				Auto_renew:  false,
				Number:      pulumi.Int(1),
			},
			AllowListIds: pulumi.StringArray{
				pulumi.String("acl-8cde5e16f44143788234ca4489xxxxx"),
				pulumi.String("acl-31f6053bd6be4cff88c1b205d20xxxxx"),
			},
			Port: pulumi.Int(3306),
			MaintenanceWindow: &rdsmysql.InstanceMaintenanceWindowArgs{
				Day_kind: "Week",
				Day_of_week: []string{
					"Monday",
				},
				Maintenance_time: "18:00Z-21:59Z",
			},
			AutoStorageScalingConfig: &rdsmysql.InstanceAutoStorageScalingConfigArgs{
				Enable_storage_auto_scale: true,
				Storage_threshold:         10,
				Storage_upper_bound:       3000,
			},
			ProjectName: pulumi.String("default"),
			Tags: rdsmysql.InstanceTagArray{
				&rdsmysql.InstanceTagArgs{
					Key:   pulumi.String("env"),
					Value: pulumi.String("test"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var rDSMySQLInstanceDemo = new Volcenginecc.Rdsmysql.Instance("RDSMySQLInstanceDemo", new()
    {
        DeletionProtection = "Disabled",
        DbEngineVersion = "MySQL_5_7",
        Nodes = new[]
        {
            new Volcenginecc.Rdsmysql.Inputs.InstanceNodeArgs
            {
                Zone_id = "cn-beijing-a",
                Node_spec = "rds.mysql.c.s.1c2g",
                Node_type = "Primary",
            },
            new Volcenginecc.Rdsmysql.Inputs.InstanceNodeArgs
            {
                Zone_id = "cn-beijing-a",
                Node_spec = "rds.mysql.c.s.1c2g",
                Node_type = "Secondary",
            },
            new Volcenginecc.Rdsmysql.Inputs.InstanceNodeArgs
            {
                Zone_id = "cn-beijing-a",
                Node_spec = "rds.mysql.c.s.1c2g",
                Node_type = "ReadOnly",
            },
        },
        StorageType = "CloudESSD_PL0",
        StorageSpace = 100,
        InstanceType = "DoubleNode",
        VpcId = "vpc-rrco37ovjq4gv0x58xxxxx",
        SubnetId = "subnet-rrwqhg3qzxfkv0x57xxxxx",
        InstanceName = "RDSMySQLInstanceDemo",
        SuperAccountName = "test_account",
        SuperAccountPassword = "***********",
        LowerCaseTableNames = "1",
        DbTimeZone = "UTC +08:00",
        ChargeDetail = new Volcenginecc.Rdsmysql.Inputs.InstanceChargeDetailArgs
        {
            Charge_type = "PostPaid",
            Auto_renew = false,
            Number = 1,
        },
        AllowListIds = new[]
        {
            "acl-8cde5e16f44143788234ca4489xxxxx",
            "acl-31f6053bd6be4cff88c1b205d20xxxxx",
        },
        Port = 3306,
        MaintenanceWindow = new Volcenginecc.Rdsmysql.Inputs.InstanceMaintenanceWindowArgs
        {
            Day_kind = "Week",
            Day_of_week = new[]
            {
                "Monday",
            },
            Maintenance_time = "18:00Z-21:59Z",
        },
        AutoStorageScalingConfig = new Volcenginecc.Rdsmysql.Inputs.InstanceAutoStorageScalingConfigArgs
        {
            Enable_storage_auto_scale = true,
            Storage_threshold = 10,
            Storage_upper_bound = 3000,
        },
        ProjectName = "default",
        Tags = new[]
        {
            new Volcenginecc.Rdsmysql.Inputs.InstanceTagArgs
            {
                Key = "env",
                Value = "test",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.rdsmysql.Instance;
import com.volcengine.volcenginecc.rdsmysql.InstanceArgs;
import com.pulumi.volcenginecc.rdsmysql.inputs.InstanceNodeArgs;
import com.pulumi.volcenginecc.rdsmysql.inputs.InstanceChargeDetailArgs;
import com.pulumi.volcenginecc.rdsmysql.inputs.InstanceMaintenanceWindowArgs;
import com.pulumi.volcenginecc.rdsmysql.inputs.InstanceAutoStorageScalingConfigArgs;
import com.pulumi.volcenginecc.rdsmysql.inputs.InstanceTagArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var rDSMySQLInstanceDemo = new Instance("rDSMySQLInstanceDemo", InstanceArgs.builder()
            .deletionProtection("Disabled")
            .dbEngineVersion("MySQL_5_7")
            .nodes(            
                InstanceNodeArgs.builder()
                    .zone_id("cn-beijing-a")
                    .node_spec("rds.mysql.c.s.1c2g")
                    .node_type("Primary")
                    .build(),
                InstanceNodeArgs.builder()
                    .zone_id("cn-beijing-a")
                    .node_spec("rds.mysql.c.s.1c2g")
                    .node_type("Secondary")
                    .build(),
                InstanceNodeArgs.builder()
                    .zone_id("cn-beijing-a")
                    .node_spec("rds.mysql.c.s.1c2g")
                    .node_type("ReadOnly")
                    .build())
            .storageType("CloudESSD_PL0")
            .storageSpace(100)
            .instanceType("DoubleNode")
            .vpcId("vpc-rrco37ovjq4gv0x58xxxxx")
            .subnetId("subnet-rrwqhg3qzxfkv0x57xxxxx")
            .instanceName("RDSMySQLInstanceDemo")
            .superAccountName("test_account")
            .superAccountPassword("***********")
            .lowerCaseTableNames("1")
            .dbTimeZone("UTC +08:00")
            .chargeDetail(InstanceChargeDetailArgs.builder()
                .charge_type("PostPaid")
                .auto_renew(false)
                .number(1)
                .build())
            .allowListIds(            
                "acl-8cde5e16f44143788234ca4489xxxxx",
                "acl-31f6053bd6be4cff88c1b205d20xxxxx")
            .port(3306)
            .maintenanceWindow(InstanceMaintenanceWindowArgs.builder()
                .day_kind("Week")
                .day_of_week(Arrays.asList("Monday"))
                .maintenance_time("18:00Z-21:59Z")
                .build())
            .autoStorageScalingConfig(InstanceAutoStorageScalingConfigArgs.builder()
                .enable_storage_auto_scale(true)
                .storage_threshold(10)
                .storage_upper_bound(3000)
                .build())
            .projectName("default")
            .tags(InstanceTagArgs.builder()
                .key("env")
                .value("test")
                .build())
            .build());

    }
}

    resources:
  rDSMySQLInstanceDemo:
    type: volcenginecc:rdsmysql:Instance
    name: RDSMySQLInstanceDemo
    properties:
      deletionProtection: Disabled
      dbEngineVersion: MySQL_5_7
      nodes:
        - zone_id: cn-beijing-a
          node_spec: rds.mysql.c.s.1c2g
          node_type: Primary
        - zone_id: cn-beijing-a
          node_spec: rds.mysql.c.s.1c2g
          node_type: Secondary
        - zone_id: cn-beijing-a
          node_spec: rds.mysql.c.s.1c2g
          node_type: ReadOnly
      storageType: CloudESSD_PL0
      storageSpace: 100
      instanceType: DoubleNode
      vpcId: vpc-rrco37ovjq4gv0x58xxxxx
      subnetId: subnet-rrwqhg3qzxfkv0x57xxxxx
      instanceName: RDSMySQLInstanceDemo
      superAccountName: test_account
      superAccountPassword: '***********'
      lowerCaseTableNames: '1'
      dbTimeZone: UTC +08:00
      chargeDetail:
        charge_type: PostPaid
        auto_renew: false
        number: 1
      allowListIds:
        - acl-8cde5e16f44143788234ca4489xxxxx
        - acl-31f6053bd6be4cff88c1b205d20xxxxx
      port: 3306
      maintenanceWindow:
        day_kind: Week
        day_of_week:
          - Monday
        maintenance_time: 18:00Z-21:59Z
      autoStorageScalingConfig:
        enable_storage_auto_scale: true
        storage_threshold: 10
        storage_upper_bound: 3000
      projectName: default
      tags:
        - key: env
          value: test

    pulumi {
  required_providers {
    volcenginecc = {
      source = "pulumi/volcenginecc"
    }
  }
}

resource "volcenginecc_rdsmysql_instance" "RDSMySQLInstanceDemo" {
  deletion_protection = "Disabled"
  db_engine_version   = "MySQL_5_7"
  nodes {
    zone_id   = "cn-beijing-a"
    node_spec = "rds.mysql.c.s.1c2g"
    node_type = "Primary"
  }
  nodes {
    zone_id   = "cn-beijing-a"
    node_spec = "rds.mysql.c.s.1c2g"
    node_type = "Secondary"
  }
  nodes {
    zone_id   = "cn-beijing-a"
    node_spec = "rds.mysql.c.s.1c2g"
    node_type = "ReadOnly"
  }
  storage_type           = "CloudESSD_PL0"
  storage_space          = 100
  instance_type          = "DoubleNode"
  vpc_id                 = "vpc-rrco37ovjq4gv0x58xxxxx"
  subnet_id              = "subnet-rrwqhg3qzxfkv0x57xxxxx"
  instance_name          = "RDSMySQLInstanceDemo"
  super_account_name     = "test_account"
  super_account_password = "***********"
  lower_case_table_names = "1"
  db_time_zone           = "UTC +08:00"
  charge_detail = {
    charge_type = "PostPaid"
    auto_renew  = false
    number      = 1
  }
  allow_list_ids = ["acl-8cde5e16f44143788234ca4489xxxxx", "acl-31f6053bd6be4cff88c1b205d20xxxxx"]
  port           = 3306
  maintenance_window = {
    day_kind         = "Week"
    day_of_week      = ["Monday"]
    maintenance_time = "18:00Z-21:59Z"
  }
  auto_storage_scaling_config = {
    enable_storage_auto_scale = true
    storage_threshold         = 10
    storage_upper_bound       = 3000
  }
  project_name = "default"
  tags {
    key   = "env"
    value = "test"
  }
}

    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,
             nodes: Optional[Sequence[InstanceNodeArgs]] = None,
             vpc_id: Optional[str] = None,
             subnet_id: Optional[str] = None,
             storage_type: Optional[str] = None,
             charge_detail: Optional[InstanceChargeDetailArgs] = None,
             storage_space: Optional[int] = None,
             db_engine_version: Optional[str] = None,
             lower_case_table_names: Optional[str] = None,
             parameter_template_id: Optional[str] = None,
             deletion_protection: Optional[str] = None,
             engine_type: Optional[str] = None,
             global_read_only: Optional[bool] = None,
             instance_name: Optional[str] = None,
             instance_type: Optional[str] = None,
             allow_list_ids: Optional[Sequence[str]] = None,
             maintenance_window: Optional[InstanceMaintenanceWindowArgs] = None,
             node_spec: Optional[str] = None,
             db_param_group_id: Optional[str] = None,
             db_time_zone: Optional[str] = None,
             port: Optional[int] = None,
             private_ip_address: Optional[str] = None,
             project_name: Optional[str] = None,
             cpu_num: Optional[int] = None,
             backup_policy: Optional[InstanceBackupPolicyArgs] = None,
             auto_upgrade_minor_version: Optional[str] = None,
             super_account_name: Optional[str] = None,
             super_account_password: Optional[str] = None,
             sync_mode: Optional[str] = None,
             tags: Optional[Sequence[InstanceTagArgs]] = None,
             auto_storage_scaling_config: Optional[InstanceAutoStorageScalingConfigArgs] = 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: volcenginecc:rdsmysql:Instance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "volcenginecc_rdsmysql_instance" "name" {
    # resource properties
}

    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 exampleinstanceResourceResourceFromRdsmysqlinstance = new Volcenginecc.Rdsmysql.Instance("exampleinstanceResourceResourceFromRdsmysqlinstance", new()
{
    Nodes = new[]
    {
        new Volcenginecc.Rdsmysql.Inputs.InstanceNodeArgs
        {
            NodeSpec = "string",
            NodeType = "string",
            ZoneId = "string",
        },
    },
    VpcId = "string",
    SubnetId = "string",
    StorageType = "string",
    ChargeDetail = new Volcenginecc.Rdsmysql.Inputs.InstanceChargeDetailArgs
    {
        ChargeType = "string",
        AutoRenew = false,
        ChargeEndTime = "string",
        ChargeStartTime = "string",
        ChargeStatus = "string",
        Number = 0,
        OverdueReclaimTime = "string",
        OverdueTime = "string",
        Period = 0,
        PeriodUnit = "string",
        TempModifyEndTime = "string",
        TempModifyStartTime = "string",
    },
    StorageSpace = 0,
    DbEngineVersion = "string",
    LowerCaseTableNames = "string",
    ParameterTemplateId = "string",
    DeletionProtection = "string",
    EngineType = "string",
    GlobalReadOnly = false,
    InstanceName = "string",
    InstanceType = "string",
    AllowListIds = new[]
    {
        "string",
    },
    MaintenanceWindow = new Volcenginecc.Rdsmysql.Inputs.InstanceMaintenanceWindowArgs
    {
        DayKind = "string",
        DayOfWeeks = new[]
        {
            "string",
        },
        MaintenanceTime = "string",
    },
    NodeSpec = "string",
    DbParamGroupId = "string",
    DbTimeZone = "string",
    Port = 0,
    PrivateIpAddress = "string",
    ProjectName = "string",
    CpuNum = 0,
    BackupPolicy = new Volcenginecc.Rdsmysql.Inputs.InstanceBackupPolicyArgs
    {
        AvailableCrossRegions = new[]
        {
            "string",
        },
        BackupPolicyBase = new Volcenginecc.Rdsmysql.Inputs.InstanceBackupPolicyBackupPolicyBaseArgs
        {
            BinlogBackupAllRetention = false,
            BinlogBackupEnabled = false,
            BinlogBackupEncryptionEnabled = false,
            BinlogFileCountsEnable = false,
            BinlogLimitCount = 0,
            BinlogLocalRetentionHour = 0,
            BinlogSpaceLimitEnable = false,
            BinlogStoragePercentage = 0,
            DataBackupAllRetention = false,
            DataBackupEncryptionEnabled = false,
            DataBackupRetentionDay = 0,
            DataFullBackupPeriods = new[]
            {
                "string",
            },
            DataFullBackupStartUtcHour = 0,
            DataFullBackupTime = "string",
            DataIncrBackupPeriods = new[]
            {
                "string",
            },
            DataKeepDaysAfterReleased = 0,
            DataKeepPolicyAfterReleased = "string",
            HighFrequencySnapshotBackupEnable = false,
            HighFrequencySnapshotBackupSecondPeriod = 0,
            HourlyIncrBackupEnable = false,
            IncrBackupHourPeriod = 0,
            KeepCrossBackupEnableAfterReleased = false,
            LockDdlTime = 0,
            LockDdlTimeSecond = 0,
            LogBackupRetentionDay = 0,
            PublicDownloadEnable = false,
            RetentionPolicySynced = false,
        },
        CrossBackupPolicy = new Volcenginecc.Rdsmysql.Inputs.InstanceBackupPolicyCrossBackupPolicyArgs
        {
            BackupEnabled = false,
            CrossBackupAllRetention = false,
            CrossBackupRegion = "string",
            LogBackupEnabled = false,
            Retention = 0,
        },
    },
    AutoUpgradeMinorVersion = "string",
    SuperAccountName = "string",
    SuperAccountPassword = "string",
    SyncMode = "string",
    Tags = new[]
    {
        new Volcenginecc.Rdsmysql.Inputs.InstanceTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    AutoStorageScalingConfig = new Volcenginecc.Rdsmysql.Inputs.InstanceAutoStorageScalingConfigArgs
    {
        EnableStorageAutoScale = false,
        ScalingDetectNode = "string",
        StorageThreshold = 0,
        StorageUpperBound = 0,
    },
});

    example, err := rdsmysql.NewInstance(ctx, "exampleinstanceResourceResourceFromRdsmysqlinstance", &rdsmysql.InstanceArgs{
	Nodes: rdsmysql.InstanceNodeArray{
		&rdsmysql.InstanceNodeArgs{
			NodeSpec: pulumi.String("string"),
			NodeType: pulumi.String("string"),
			ZoneId:   pulumi.String("string"),
		},
	},
	VpcId:       pulumi.String("string"),
	SubnetId:    pulumi.String("string"),
	StorageType: pulumi.String("string"),
	ChargeDetail: &rdsmysql.InstanceChargeDetailArgs{
		ChargeType:          pulumi.String("string"),
		AutoRenew:           pulumi.Bool(false),
		ChargeEndTime:       pulumi.String("string"),
		ChargeStartTime:     pulumi.String("string"),
		ChargeStatus:        pulumi.String("string"),
		Number:              pulumi.Int(0),
		OverdueReclaimTime:  pulumi.String("string"),
		OverdueTime:         pulumi.String("string"),
		Period:              pulumi.Int(0),
		PeriodUnit:          pulumi.String("string"),
		TempModifyEndTime:   pulumi.String("string"),
		TempModifyStartTime: pulumi.String("string"),
	},
	StorageSpace:        pulumi.Int(0),
	DbEngineVersion:     pulumi.String("string"),
	LowerCaseTableNames: pulumi.String("string"),
	ParameterTemplateId: pulumi.String("string"),
	DeletionProtection:  pulumi.String("string"),
	EngineType:          pulumi.String("string"),
	GlobalReadOnly:      pulumi.Bool(false),
	InstanceName:        pulumi.String("string"),
	InstanceType:        pulumi.String("string"),
	AllowListIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	MaintenanceWindow: &rdsmysql.InstanceMaintenanceWindowArgs{
		DayKind: pulumi.String("string"),
		DayOfWeeks: pulumi.StringArray{
			pulumi.String("string"),
		},
		MaintenanceTime: pulumi.String("string"),
	},
	NodeSpec:         pulumi.String("string"),
	DbParamGroupId:   pulumi.String("string"),
	DbTimeZone:       pulumi.String("string"),
	Port:             pulumi.Int(0),
	PrivateIpAddress: pulumi.String("string"),
	ProjectName:      pulumi.String("string"),
	CpuNum:           pulumi.Int(0),
	BackupPolicy: &rdsmysql.InstanceBackupPolicyArgs{
		AvailableCrossRegions: pulumi.StringArray{
			pulumi.String("string"),
		},
		BackupPolicyBase: &rdsmysql.InstanceBackupPolicyBackupPolicyBaseArgs{
			BinlogBackupAllRetention:      pulumi.Bool(false),
			BinlogBackupEnabled:           pulumi.Bool(false),
			BinlogBackupEncryptionEnabled: pulumi.Bool(false),
			BinlogFileCountsEnable:        pulumi.Bool(false),
			BinlogLimitCount:              pulumi.Int(0),
			BinlogLocalRetentionHour:      pulumi.Int(0),
			BinlogSpaceLimitEnable:        pulumi.Bool(false),
			BinlogStoragePercentage:       pulumi.Int(0),
			DataBackupAllRetention:        pulumi.Bool(false),
			DataBackupEncryptionEnabled:   pulumi.Bool(false),
			DataBackupRetentionDay:        pulumi.Int(0),
			DataFullBackupPeriods: pulumi.StringArray{
				pulumi.String("string"),
			},
			DataFullBackupStartUtcHour: pulumi.Int(0),
			DataFullBackupTime:         pulumi.String("string"),
			DataIncrBackupPeriods: pulumi.StringArray{
				pulumi.String("string"),
			},
			DataKeepDaysAfterReleased:               pulumi.Int(0),
			DataKeepPolicyAfterReleased:             pulumi.String("string"),
			HighFrequencySnapshotBackupEnable:       pulumi.Bool(false),
			HighFrequencySnapshotBackupSecondPeriod: pulumi.Int(0),
			HourlyIncrBackupEnable:                  pulumi.Bool(false),
			IncrBackupHourPeriod:                    pulumi.Int(0),
			KeepCrossBackupEnableAfterReleased:      pulumi.Bool(false),
			LockDdlTime:                             pulumi.Int(0),
			LockDdlTimeSecond:                       pulumi.Int(0),
			LogBackupRetentionDay:                   pulumi.Int(0),
			PublicDownloadEnable:                    pulumi.Bool(false),
			RetentionPolicySynced:                   pulumi.Bool(false),
		},
		CrossBackupPolicy: &rdsmysql.InstanceBackupPolicyCrossBackupPolicyArgs{
			BackupEnabled:           pulumi.Bool(false),
			CrossBackupAllRetention: pulumi.Bool(false),
			CrossBackupRegion:       pulumi.String("string"),
			LogBackupEnabled:        pulumi.Bool(false),
			Retention:               pulumi.Int(0),
		},
	},
	AutoUpgradeMinorVersion: pulumi.String("string"),
	SuperAccountName:        pulumi.String("string"),
	SuperAccountPassword:    pulumi.String("string"),
	SyncMode:                pulumi.String("string"),
	Tags: rdsmysql.InstanceTagArray{
		&rdsmysql.InstanceTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	AutoStorageScalingConfig: &rdsmysql.InstanceAutoStorageScalingConfigArgs{
		EnableStorageAutoScale: pulumi.Bool(false),
		ScalingDetectNode:      pulumi.String("string"),
		StorageThreshold:       pulumi.Int(0),
		StorageUpperBound:      pulumi.Int(0),
	},
})

    resource "volcenginecc_rdsmysql_instance" "exampleinstanceResourceResourceFromRdsmysqlinstance" {
  nodes {
    node_spec = "string"
    node_type = "string"
    zone_id   = "string"
  }
  vpc_id       = "string"
  subnet_id    = "string"
  storage_type = "string"
  charge_detail = {
    charge_type            = "string"
    auto_renew             = false
    charge_end_time        = "string"
    charge_start_time      = "string"
    charge_status          = "string"
    number                 = 0
    overdue_reclaim_time   = "string"
    overdue_time           = "string"
    period                 = 0
    period_unit            = "string"
    temp_modify_end_time   = "string"
    temp_modify_start_time = "string"
  }
  storage_space          = 0
  db_engine_version      = "string"
  lower_case_table_names = "string"
  parameter_template_id  = "string"
  deletion_protection    = "string"
  engine_type            = "string"
  global_read_only       = false
  instance_name          = "string"
  instance_type          = "string"
  allow_list_ids         = ["string"]
  maintenance_window = {
    day_kind         = "string"
    day_of_weeks     = ["string"]
    maintenance_time = "string"
  }
  node_spec          = "string"
  db_param_group_id  = "string"
  db_time_zone       = "string"
  port               = 0
  private_ip_address = "string"
  project_name       = "string"
  cpu_num            = 0
  backup_policy = {
    available_cross_regions = ["string"]
    backup_policy_base = {
      binlog_backup_all_retention                  = false
      binlog_backup_enabled                        = false
      binlog_backup_encryption_enabled             = false
      binlog_file_counts_enable                    = false
      binlog_limit_count                           = 0
      binlog_local_retention_hour                  = 0
      binlog_space_limit_enable                    = false
      binlog_storage_percentage                    = 0
      data_backup_all_retention                    = false
      data_backup_encryption_enabled               = false
      data_backup_retention_day                    = 0
      data_full_backup_periods                     = ["string"]
      data_full_backup_start_utc_hour              = 0
      data_full_backup_time                        = "string"
      data_incr_backup_periods                     = ["string"]
      data_keep_days_after_released                = 0
      data_keep_policy_after_released              = "string"
      high_frequency_snapshot_backup_enable        = false
      high_frequency_snapshot_backup_second_period = 0
      hourly_incr_backup_enable                    = false
      incr_backup_hour_period                      = 0
      keep_cross_backup_enable_after_released      = false
      lock_ddl_time                                = 0
      lock_ddl_time_second                         = 0
      log_backup_retention_day                     = 0
      public_download_enable                       = false
      retention_policy_synced                      = false
    }
    cross_backup_policy = {
      backup_enabled             = false
      cross_backup_all_retention = false
      cross_backup_region        = "string"
      log_backup_enabled         = false
      retention                  = 0
    }
  }
  auto_upgrade_minor_version = "string"
  super_account_name         = "string"
  super_account_password     = "string"
  sync_mode                  = "string"
  tags {
    key   = "string"
    value = "string"
  }
  auto_storage_scaling_config = {
    enable_storage_auto_scale = false
    scaling_detect_node       = "string"
    storage_threshold         = 0
    storage_upper_bound       = 0
  }
}

    var exampleinstanceResourceResourceFromRdsmysqlinstance = new com.volcengine.volcenginecc.rdsmysql.Instance("exampleinstanceResourceResourceFromRdsmysqlinstance", com.volcengine.volcenginecc.rdsmysql.InstanceArgs.builder()
    .nodes(com.pulumi.volcenginecc.rdsmysql.inputs.InstanceNodeArgs.builder()
        .nodeSpec("string")
        .nodeType("string")
        .zoneId("string")
        .build())
    .vpcId("string")
    .subnetId("string")
    .storageType("string")
    .chargeDetail(com.pulumi.volcenginecc.rdsmysql.inputs.InstanceChargeDetailArgs.builder()
        .chargeType("string")
        .autoRenew(false)
        .chargeEndTime("string")
        .chargeStartTime("string")
        .chargeStatus("string")
        .number(0)
        .overdueReclaimTime("string")
        .overdueTime("string")
        .period(0)
        .periodUnit("string")
        .tempModifyEndTime("string")
        .tempModifyStartTime("string")
        .build())
    .storageSpace(0)
    .dbEngineVersion("string")
    .lowerCaseTableNames("string")
    .parameterTemplateId("string")
    .deletionProtection("string")
    .engineType("string")
    .globalReadOnly(false)
    .instanceName("string")
    .instanceType("string")
    .allowListIds("string")
    .maintenanceWindow(com.pulumi.volcenginecc.rdsmysql.inputs.InstanceMaintenanceWindowArgs.builder()
        .dayKind("string")
        .dayOfWeeks("string")
        .maintenanceTime("string")
        .build())
    .nodeSpec("string")
    .dbParamGroupId("string")
    .dbTimeZone("string")
    .port(0)
    .privateIpAddress("string")
    .projectName("string")
    .cpuNum(0)
    .backupPolicy(InstanceBackupPolicyArgs.builder()
        .availableCrossRegions("string")
        .backupPolicyBase(InstanceBackupPolicyBackupPolicyBaseArgs.builder()
            .binlogBackupAllRetention(false)
            .binlogBackupEnabled(false)
            .binlogBackupEncryptionEnabled(false)
            .binlogFileCountsEnable(false)
            .binlogLimitCount(0)
            .binlogLocalRetentionHour(0)
            .binlogSpaceLimitEnable(false)
            .binlogStoragePercentage(0)
            .dataBackupAllRetention(false)
            .dataBackupEncryptionEnabled(false)
            .dataBackupRetentionDay(0)
            .dataFullBackupPeriods("string")
            .dataFullBackupStartUtcHour(0)
            .dataFullBackupTime("string")
            .dataIncrBackupPeriods("string")
            .dataKeepDaysAfterReleased(0)
            .dataKeepPolicyAfterReleased("string")
            .highFrequencySnapshotBackupEnable(false)
            .highFrequencySnapshotBackupSecondPeriod(0)
            .hourlyIncrBackupEnable(false)
            .incrBackupHourPeriod(0)
            .keepCrossBackupEnableAfterReleased(false)
            .lockDdlTime(0)
            .lockDdlTimeSecond(0)
            .logBackupRetentionDay(0)
            .publicDownloadEnable(false)
            .retentionPolicySynced(false)
            .build())
        .crossBackupPolicy(InstanceBackupPolicyCrossBackupPolicyArgs.builder()
            .backupEnabled(false)
            .crossBackupAllRetention(false)
            .crossBackupRegion("string")
            .logBackupEnabled(false)
            .retention(0)
            .build())
        .build())
    .autoUpgradeMinorVersion("string")
    .superAccountName("string")
    .superAccountPassword("string")
    .syncMode("string")
    .tags(com.pulumi.volcenginecc.rdsmysql.inputs.InstanceTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .autoStorageScalingConfig(InstanceAutoStorageScalingConfigArgs.builder()
        .enableStorageAutoScale(false)
        .scalingDetectNode("string")
        .storageThreshold(0)
        .storageUpperBound(0)
        .build())
    .build());

    exampleinstance_resource_resource_from_rdsmysqlinstance = volcenginecc.rdsmysql.Instance("exampleinstanceResourceResourceFromRdsmysqlinstance",
    nodes=[{
        "node_spec": "string",
        "node_type": "string",
        "zone_id": "string",
    }],
    vpc_id="string",
    subnet_id="string",
    storage_type="string",
    charge_detail={
        "charge_type": "string",
        "auto_renew": False,
        "charge_end_time": "string",
        "charge_start_time": "string",
        "charge_status": "string",
        "number": 0,
        "overdue_reclaim_time": "string",
        "overdue_time": "string",
        "period": 0,
        "period_unit": "string",
        "temp_modify_end_time": "string",
        "temp_modify_start_time": "string",
    },
    storage_space=0,
    db_engine_version="string",
    lower_case_table_names="string",
    parameter_template_id="string",
    deletion_protection="string",
    engine_type="string",
    global_read_only=False,
    instance_name="string",
    instance_type="string",
    allow_list_ids=["string"],
    maintenance_window={
        "day_kind": "string",
        "day_of_weeks": ["string"],
        "maintenance_time": "string",
    },
    node_spec="string",
    db_param_group_id="string",
    db_time_zone="string",
    port=0,
    private_ip_address="string",
    project_name="string",
    cpu_num=0,
    backup_policy={
        "available_cross_regions": ["string"],
        "backup_policy_base": {
            "binlog_backup_all_retention": False,
            "binlog_backup_enabled": False,
            "binlog_backup_encryption_enabled": False,
            "binlog_file_counts_enable": False,
            "binlog_limit_count": 0,
            "binlog_local_retention_hour": 0,
            "binlog_space_limit_enable": False,
            "binlog_storage_percentage": 0,
            "data_backup_all_retention": False,
            "data_backup_encryption_enabled": False,
            "data_backup_retention_day": 0,
            "data_full_backup_periods": ["string"],
            "data_full_backup_start_utc_hour": 0,
            "data_full_backup_time": "string",
            "data_incr_backup_periods": ["string"],
            "data_keep_days_after_released": 0,
            "data_keep_policy_after_released": "string",
            "high_frequency_snapshot_backup_enable": False,
            "high_frequency_snapshot_backup_second_period": 0,
            "hourly_incr_backup_enable": False,
            "incr_backup_hour_period": 0,
            "keep_cross_backup_enable_after_released": False,
            "lock_ddl_time": 0,
            "lock_ddl_time_second": 0,
            "log_backup_retention_day": 0,
            "public_download_enable": False,
            "retention_policy_synced": False,
        },
        "cross_backup_policy": {
            "backup_enabled": False,
            "cross_backup_all_retention": False,
            "cross_backup_region": "string",
            "log_backup_enabled": False,
            "retention": 0,
        },
    },
    auto_upgrade_minor_version="string",
    super_account_name="string",
    super_account_password="string",
    sync_mode="string",
    tags=[{
        "key": "string",
        "value": "string",
    }],
    auto_storage_scaling_config={
        "enable_storage_auto_scale": False,
        "scaling_detect_node": "string",
        "storage_threshold": 0,
        "storage_upper_bound": 0,
    })

    const exampleinstanceResourceResourceFromRdsmysqlinstance = new volcenginecc.rdsmysql.Instance("exampleinstanceResourceResourceFromRdsmysqlinstance", {
    nodes: [{
        nodeSpec: "string",
        nodeType: "string",
        zoneId: "string",
    }],
    vpcId: "string",
    subnetId: "string",
    storageType: "string",
    chargeDetail: {
        chargeType: "string",
        autoRenew: false,
        chargeEndTime: "string",
        chargeStartTime: "string",
        chargeStatus: "string",
        number: 0,
        overdueReclaimTime: "string",
        overdueTime: "string",
        period: 0,
        periodUnit: "string",
        tempModifyEndTime: "string",
        tempModifyStartTime: "string",
    },
    storageSpace: 0,
    dbEngineVersion: "string",
    lowerCaseTableNames: "string",
    parameterTemplateId: "string",
    deletionProtection: "string",
    engineType: "string",
    globalReadOnly: false,
    instanceName: "string",
    instanceType: "string",
    allowListIds: ["string"],
    maintenanceWindow: {
        dayKind: "string",
        dayOfWeeks: ["string"],
        maintenanceTime: "string",
    },
    nodeSpec: "string",
    dbParamGroupId: "string",
    dbTimeZone: "string",
    port: 0,
    privateIpAddress: "string",
    projectName: "string",
    cpuNum: 0,
    backupPolicy: {
        availableCrossRegions: ["string"],
        backupPolicyBase: {
            binlogBackupAllRetention: false,
            binlogBackupEnabled: false,
            binlogBackupEncryptionEnabled: false,
            binlogFileCountsEnable: false,
            binlogLimitCount: 0,
            binlogLocalRetentionHour: 0,
            binlogSpaceLimitEnable: false,
            binlogStoragePercentage: 0,
            dataBackupAllRetention: false,
            dataBackupEncryptionEnabled: false,
            dataBackupRetentionDay: 0,
            dataFullBackupPeriods: ["string"],
            dataFullBackupStartUtcHour: 0,
            dataFullBackupTime: "string",
            dataIncrBackupPeriods: ["string"],
            dataKeepDaysAfterReleased: 0,
            dataKeepPolicyAfterReleased: "string",
            highFrequencySnapshotBackupEnable: false,
            highFrequencySnapshotBackupSecondPeriod: 0,
            hourlyIncrBackupEnable: false,
            incrBackupHourPeriod: 0,
            keepCrossBackupEnableAfterReleased: false,
            lockDdlTime: 0,
            lockDdlTimeSecond: 0,
            logBackupRetentionDay: 0,
            publicDownloadEnable: false,
            retentionPolicySynced: false,
        },
        crossBackupPolicy: {
            backupEnabled: false,
            crossBackupAllRetention: false,
            crossBackupRegion: "string",
            logBackupEnabled: false,
            retention: 0,
        },
    },
    autoUpgradeMinorVersion: "string",
    superAccountName: "string",
    superAccountPassword: "string",
    syncMode: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
    autoStorageScalingConfig: {
        enableStorageAutoScale: false,
        scalingDetectNode: "string",
        storageThreshold: 0,
        storageUpperBound: 0,
    },
});

    type: volcenginecc:rdsmysql:Instance
properties:
    allowListIds:
        - string
    autoStorageScalingConfig:
        enableStorageAutoScale: false
        scalingDetectNode: string
        storageThreshold: 0
        storageUpperBound: 0
    autoUpgradeMinorVersion: string
    backupPolicy:
        availableCrossRegions:
            - string
        backupPolicyBase:
            binlogBackupAllRetention: false
            binlogBackupEnabled: false
            binlogBackupEncryptionEnabled: false
            binlogFileCountsEnable: false
            binlogLimitCount: 0
            binlogLocalRetentionHour: 0
            binlogSpaceLimitEnable: false
            binlogStoragePercentage: 0
            dataBackupAllRetention: false
            dataBackupEncryptionEnabled: false
            dataBackupRetentionDay: 0
            dataFullBackupPeriods:
                - string
            dataFullBackupStartUtcHour: 0
            dataFullBackupTime: string
            dataIncrBackupPeriods:
                - string
            dataKeepDaysAfterReleased: 0
            dataKeepPolicyAfterReleased: string
            highFrequencySnapshotBackupEnable: false
            highFrequencySnapshotBackupSecondPeriod: 0
            hourlyIncrBackupEnable: false
            incrBackupHourPeriod: 0
            keepCrossBackupEnableAfterReleased: false
            lockDdlTime: 0
            lockDdlTimeSecond: 0
            logBackupRetentionDay: 0
            publicDownloadEnable: false
            retentionPolicySynced: false
        crossBackupPolicy:
            backupEnabled: false
            crossBackupAllRetention: false
            crossBackupRegion: string
            logBackupEnabled: false
            retention: 0
    chargeDetail:
        autoRenew: false
        chargeEndTime: string
        chargeStartTime: string
        chargeStatus: string
        chargeType: string
        number: 0
        overdueReclaimTime: string
        overdueTime: string
        period: 0
        periodUnit: string
        tempModifyEndTime: string
        tempModifyStartTime: string
    cpuNum: 0
    dbEngineVersion: string
    dbParamGroupId: string
    dbTimeZone: string
    deletionProtection: string
    engineType: string
    globalReadOnly: false
    instanceName: string
    instanceType: string
    lowerCaseTableNames: string
    maintenanceWindow:
        dayKind: string
        dayOfWeeks:
            - string
        maintenanceTime: string
    nodeSpec: string
    nodes:
        - nodeSpec: string
          nodeType: string
          zoneId: string
    parameterTemplateId: string
    port: 0
    privateIpAddress: string
    projectName: string
    storageSpace: 0
    storageType: string
    subnetId: string
    superAccountName: string
    superAccountPassword: string
    syncMode: string
    tags:
        - key: string
          value: string
    vpcId: 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:

    ChargeDetail Volcengine.InstanceChargeDetail
    Billing method
    DbEngineVersion string
    Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
    Nodes List<Volcengine.InstanceNode>
    Instance node information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    StorageSpace int
    Total storage space of the instance, in GB
    StorageType string
    Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
    SubnetId string
    Subnet ID.
    VpcId string
    VPC (Virtual Private Cloud) ID.
    AllowListIds List<string>
    Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
    AutoStorageScalingConfig Volcengine.InstanceAutoStorageScalingConfig
    Auto scaling configuration
    AutoUpgradeMinorVersion string
    Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
    BackupPolicy Volcengine.InstanceBackupPolicy
    Instance backup policy configuration.
    CpuNum int
    Number of CPU cores for the database proxy service of the instance
    DbParamGroupId string
    Parameter template ID. Default value is the default parameter template for the database engine version
    DbTimeZone string
    Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
    DeletionProtection string
    Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
    EngineType string
    Database engine type. Values: InnoDB: InnoDB engine. RocksDB: RocksDB engine.
    GlobalReadOnly bool
    Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
    InstanceName string
    Instance name.
    InstanceType string
    Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
    LowerCaseTableNames string
    Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
    MaintenanceWindow Volcengine.InstanceMaintenanceWindow
    Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
    NodeSpec string
    Node specifications.
    ParameterTemplateId string
    Parameter template ID.
    Port int
    Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
    PrivateIpAddress string
    Specify the default terminal IP address of the instance within the designated private network and subnet. Note: If not set, the default terminal IP address will be automatically assigned within the specified private network and subnet.
    ProjectName string
    Project.
    SuperAccountName string
    High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
    SuperAccountPassword string
    Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
    SyncMode string
    Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
    Tags List<Volcengine.InstanceTag>
    RDS MySQL instance tag information Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    ChargeDetail InstanceChargeDetailArgs
    Billing method
    DbEngineVersion string
    Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
    Nodes []InstanceNodeArgs
    Instance node information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    StorageSpace int
    Total storage space of the instance, in GB
    StorageType string
    Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
    SubnetId string
    Subnet ID.
    VpcId string
    VPC (Virtual Private Cloud) ID.
    AllowListIds []string
    Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
    AutoStorageScalingConfig InstanceAutoStorageScalingConfigArgs
    Auto scaling configuration
    AutoUpgradeMinorVersion string
    Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
    BackupPolicy InstanceBackupPolicyArgs
    Instance backup policy configuration.
    CpuNum int
    Number of CPU cores for the database proxy service of the instance
    DbParamGroupId string
    Parameter template ID. Default value is the default parameter template for the database engine version
    DbTimeZone string
    Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
    DeletionProtection string
    Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
    EngineType string
    Database engine type. Values: InnoDB: InnoDB engine. RocksDB: RocksDB engine.
    GlobalReadOnly bool
    Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
    InstanceName string
    Instance name.
    InstanceType string
    Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
    LowerCaseTableNames string
    Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
    MaintenanceWindow InstanceMaintenanceWindowArgs
    Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
    NodeSpec string
    Node specifications.
    ParameterTemplateId string
    Parameter template ID.
    Port int
    Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
    PrivateIpAddress string
    Specify the default terminal IP address of the instance within the designated private network and subnet. Note: If not set, the default terminal IP address will be automatically assigned within the specified private network and subnet.
    ProjectName string
    Project.
    SuperAccountName string
    High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
    SuperAccountPassword string
    Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
    SyncMode string
    Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
    Tags []InstanceTagArgs
    RDS MySQL instance tag information Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    charge_detail object
    Billing method
    db_engine_version string
    Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
    nodes list(object)
    Instance node information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    storage_space number
    Total storage space of the instance, in GB
    storage_type string
    Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
    subnet_id string
    Subnet ID.
    vpc_id string
    VPC (Virtual Private Cloud) ID.
    allow_list_ids list(string)
    Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
    auto_storage_scaling_config object
    Auto scaling configuration
    auto_upgrade_minor_version string
    Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
    backup_policy object
    Instance backup policy configuration.
    cpu_num number
    Number of CPU cores for the database proxy service of the instance
    db_param_group_id string
    Parameter template ID. Default value is the default parameter template for the database engine version
    db_time_zone string
    Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
    deletion_protection string
    Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
    engine_type string
    Database engine type. Values: InnoDB: InnoDB engine. RocksDB: RocksDB engine.
    global_read_only bool
    Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
    instance_name string
    Instance name.
    instance_type string
    Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
    lower_case_table_names string
    Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
    maintenance_window object
    Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
    node_spec string
    Node specifications.
    parameter_template_id string
    Parameter template ID.
    port number
    Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
    private_ip_address string
    Specify the default terminal IP address of the instance within the designated private network and subnet. Note: If not set, the default terminal IP address will be automatically assigned within the specified private network and subnet.
    project_name string
    Project.
    super_account_name string
    High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
    super_account_password string
    Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
    sync_mode string
    Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
    tags list(object)
    RDS MySQL instance tag information Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    chargeDetail InstanceChargeDetail
    Billing method
    dbEngineVersion String
    Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
    nodes List<InstanceNode>
    Instance node information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    storageSpace Integer
    Total storage space of the instance, in GB
    storageType String
    Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
    subnetId String
    Subnet ID.
    vpcId String
    VPC (Virtual Private Cloud) ID.
    allowListIds List<String>
    Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
    autoStorageScalingConfig InstanceAutoStorageScalingConfig
    Auto scaling configuration
    autoUpgradeMinorVersion String
    Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
    backupPolicy InstanceBackupPolicy
    Instance backup policy configuration.
    cpuNum Integer
    Number of CPU cores for the database proxy service of the instance
    dbParamGroupId String
    Parameter template ID. Default value is the default parameter template for the database engine version
    dbTimeZone String
    Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
    deletionProtection String
    Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
    engineType String
    Database engine type. Values: InnoDB: InnoDB engine. RocksDB: RocksDB engine.
    globalReadOnly Boolean
    Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
    instanceName String
    Instance name.
    instanceType String
    Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
    lowerCaseTableNames String
    Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
    maintenanceWindow InstanceMaintenanceWindow
    Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
    nodeSpec String
    Node specifications.
    parameterTemplateId String
    Parameter template ID.
    port Integer
    Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
    privateIpAddress String
    Specify the default terminal IP address of the instance within the designated private network and subnet. Note: If not set, the default terminal IP address will be automatically assigned within the specified private network and subnet.
    projectName String
    Project.
    superAccountName String
    High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
    superAccountPassword String
    Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
    syncMode String
    Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
    tags List<InstanceTag>
    RDS MySQL instance tag information Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    chargeDetail InstanceChargeDetail
    Billing method
    dbEngineVersion string
    Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
    nodes InstanceNode[]
    Instance node information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    storageSpace number
    Total storage space of the instance, in GB
    storageType string
    Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
    subnetId string
    Subnet ID.
    vpcId string
    VPC (Virtual Private Cloud) ID.
    allowListIds string[]
    Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
    autoStorageScalingConfig InstanceAutoStorageScalingConfig
    Auto scaling configuration
    autoUpgradeMinorVersion string
    Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
    backupPolicy InstanceBackupPolicy
    Instance backup policy configuration.
    cpuNum number
    Number of CPU cores for the database proxy service of the instance
    dbParamGroupId string
    Parameter template ID. Default value is the default parameter template for the database engine version
    dbTimeZone string
    Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
    deletionProtection string
    Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
    engineType string
    Database engine type. Values: InnoDB: InnoDB engine. RocksDB: RocksDB engine.
    globalReadOnly boolean
    Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
    instanceName string
    Instance name.
    instanceType string
    Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
    lowerCaseTableNames string
    Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
    maintenanceWindow InstanceMaintenanceWindow
    Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
    nodeSpec string
    Node specifications.
    parameterTemplateId string
    Parameter template ID.
    port number
    Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
    privateIpAddress string
    Specify the default terminal IP address of the instance within the designated private network and subnet. Note: If not set, the default terminal IP address will be automatically assigned within the specified private network and subnet.
    projectName string
    Project.
    superAccountName string
    High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
    superAccountPassword string
    Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
    syncMode string
    Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
    tags InstanceTag[]
    RDS MySQL instance tag information Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    charge_detail InstanceChargeDetailArgs
    Billing method
    db_engine_version str
    Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
    nodes Sequence[InstanceNodeArgs]
    Instance node information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    storage_space int
    Total storage space of the instance, in GB
    storage_type str
    Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
    subnet_id str
    Subnet ID.
    vpc_id str
    VPC (Virtual Private Cloud) ID.
    allow_list_ids Sequence[str]
    Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
    auto_storage_scaling_config InstanceAutoStorageScalingConfigArgs
    Auto scaling configuration
    auto_upgrade_minor_version str
    Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
    backup_policy InstanceBackupPolicyArgs
    Instance backup policy configuration.
    cpu_num int
    Number of CPU cores for the database proxy service of the instance
    db_param_group_id str
    Parameter template ID. Default value is the default parameter template for the database engine version
    db_time_zone str
    Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
    deletion_protection str
    Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
    engine_type str
    Database engine type. Values: InnoDB: InnoDB engine. RocksDB: RocksDB engine.
    global_read_only bool
    Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
    instance_name str
    Instance name.
    instance_type str
    Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
    lower_case_table_names str
    Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
    maintenance_window InstanceMaintenanceWindowArgs
    Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
    node_spec str
    Node specifications.
    parameter_template_id str
    Parameter template ID.
    port int
    Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
    private_ip_address str
    Specify the default terminal IP address of the instance within the designated private network and subnet. Note: If not set, the default terminal IP address will be automatically assigned within the specified private network and subnet.
    project_name str
    Project.
    super_account_name str
    High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
    super_account_password str
    Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
    sync_mode str
    Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
    tags Sequence[InstanceTagArgs]
    RDS MySQL instance tag information Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    chargeDetail Property Map
    Billing method
    dbEngineVersion String
    Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
    nodes List<Property Map>
    Instance node information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    storageSpace Number
    Total storage space of the instance, in GB
    storageType String
    Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
    subnetId String
    Subnet ID.
    vpcId String
    VPC (Virtual Private Cloud) ID.
    allowListIds List<String>
    Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
    autoStorageScalingConfig Property Map
    Auto scaling configuration
    autoUpgradeMinorVersion String
    Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
    backupPolicy Property Map
    Instance backup policy configuration.
    cpuNum Number
    Number of CPU cores for the database proxy service of the instance
    dbParamGroupId String
    Parameter template ID. Default value is the default parameter template for the database engine version
    dbTimeZone String
    Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
    deletionProtection String
    Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
    engineType String
    Database engine type. Values: InnoDB: InnoDB engine. RocksDB: RocksDB engine.
    globalReadOnly Boolean
    Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
    instanceName String
    Instance name.
    instanceType String
    Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
    lowerCaseTableNames String
    Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
    maintenanceWindow Property Map
    Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
    nodeSpec String
    Node specifications.
    parameterTemplateId String
    Parameter template ID.
    port Number
    Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
    privateIpAddress String
    Specify the default terminal IP address of the instance within the designated private network and subnet. Note: If not set, the default terminal IP address will be automatically assigned within the specified private network and subnet.
    projectName String
    Project.
    superAccountName String
    High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
    superAccountPassword String
    Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
    syncMode String
    Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
    tags List<Property Map>
    RDS MySQL instance tag information Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.

    Outputs

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

    AddressObjects List<Volcengine.InstanceAddressObject>
    Connection information for the default endpoint Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    AllowListVersion string
    Allowlist version
    BackupAuditLogSize int
    Space used by audit logs in backup.
    BackupBinLogSize int
    Space used by binlog logs in backup.
    BackupDataSize int
    Space used by data in backup.
    BackupErrorLogSize int
    Space used by error logs in backups.
    BackupFreeQuotaSize int
    Free backup storage space, in GB
    BackupLogSize int
    Space used by logs in backups.
    BackupSlowLogSize int
    Space used by slow logs in backups.
    BackupUse double
    Backup space used by the instance, in GB
    BasicBackupBinlogSize int
    Space used by Binlog logs in basic backups.
    BasicBackupDataSize int
    Space used by data in the base backup
    CreatedTime string
    Instance creation local time.
    CurrentKernelVersion string
    Instance kernel minor version.
    DisasterRecoveryInstances List<Volcengine.InstanceDisasterRecoveryInstance>
    Disaster recovery instance information for the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    DrDtsTaskId string
    ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
    DrDtsTaskName string
    Name of synchronization tasks between primary and disaster recovery instances.
    DrDtsTaskStatus string
    Status of synchronization tasks between primary and disaster recovery instances.
    DrSecondsBehindMaster int
    Latency between the disaster recovery instance and the primary instance.
    Endpoints List<Volcengine.InstanceEndpoint>
    Instance connection information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    HasDisasterRecoveryInstances bool
    Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
    HasGreenInstance bool
    Is the instance in blue-green deployment? Values: true: yes. false: no.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    Instance ID.
    InstanceStatus string
    Instance status.
    MasterInstanceId string
    Primary instance ID
    MasterInstanceName string
    Primary instance name.
    Memory int
    Memory size. Unit: GB.
    NodeCpuUsedPercentage double
    Average CPU usage of the primary node in the instance over the past minute.
    NodeMemoryUsedPercentage double
    Average memory usage of the primary node over the past minute
    NodeNumber string
    Number of nodes.
    NodeSpaceUsedPercentage double
    Average disk usage of the primary node over the past minute
    ProxyDetail Volcengine.InstanceProxyDetail
    proxy information
    StorageAuditLogSize int
    Space used by audit logs in instance storage
    StorageBinLogSize int
    Binlog space usage in the instance storage
    StorageDataSize int
    Space used by data in instance storage.
    StorageErrorLogSize int
    Space used by error logs in instance storage.
    StorageLogSize int
    Space used by logs in the instance storage
    StorageSlowLogSize int
    Space used by slow logs in instance storage
    StorageUse double
    Storage space used by the instance, in GB
    TimeZone string
    Time zone
    UpdatedTime string
    Instance updates local time.
    Vcpu int
    CPU size. For example: 1 means 1U.
    ZoneId string
    Availability zone of the instance's primary node.
    ZoneIds List<string>
    List of availability zones for each node in the instance.
    AddressObjects []InstanceAddressObject
    Connection information for the default endpoint Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    AllowListVersion string
    Allowlist version
    BackupAuditLogSize int
    Space used by audit logs in backup.
    BackupBinLogSize int
    Space used by binlog logs in backup.
    BackupDataSize int
    Space used by data in backup.
    BackupErrorLogSize int
    Space used by error logs in backups.
    BackupFreeQuotaSize int
    Free backup storage space, in GB
    BackupLogSize int
    Space used by logs in backups.
    BackupSlowLogSize int
    Space used by slow logs in backups.
    BackupUse float64
    Backup space used by the instance, in GB
    BasicBackupBinlogSize int
    Space used by Binlog logs in basic backups.
    BasicBackupDataSize int
    Space used by data in the base backup
    CreatedTime string
    Instance creation local time.
    CurrentKernelVersion string
    Instance kernel minor version.
    DisasterRecoveryInstances []InstanceDisasterRecoveryInstance
    Disaster recovery instance information for the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    DrDtsTaskId string
    ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
    DrDtsTaskName string
    Name of synchronization tasks between primary and disaster recovery instances.
    DrDtsTaskStatus string
    Status of synchronization tasks between primary and disaster recovery instances.
    DrSecondsBehindMaster int
    Latency between the disaster recovery instance and the primary instance.
    Endpoints []InstanceEndpoint
    Instance connection information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    HasDisasterRecoveryInstances bool
    Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
    HasGreenInstance bool
    Is the instance in blue-green deployment? Values: true: yes. false: no.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    Instance ID.
    InstanceStatus string
    Instance status.
    MasterInstanceId string
    Primary instance ID
    MasterInstanceName string
    Primary instance name.
    Memory int
    Memory size. Unit: GB.
    NodeCpuUsedPercentage float64
    Average CPU usage of the primary node in the instance over the past minute.
    NodeMemoryUsedPercentage float64
    Average memory usage of the primary node over the past minute
    NodeNumber string
    Number of nodes.
    NodeSpaceUsedPercentage float64
    Average disk usage of the primary node over the past minute
    ProxyDetail InstanceProxyDetail
    proxy information
    StorageAuditLogSize int
    Space used by audit logs in instance storage
    StorageBinLogSize int
    Binlog space usage in the instance storage
    StorageDataSize int
    Space used by data in instance storage.
    StorageErrorLogSize int
    Space used by error logs in instance storage.
    StorageLogSize int
    Space used by logs in the instance storage
    StorageSlowLogSize int
    Space used by slow logs in instance storage
    StorageUse float64
    Storage space used by the instance, in GB
    TimeZone string
    Time zone
    UpdatedTime string
    Instance updates local time.
    Vcpu int
    CPU size. For example: 1 means 1U.
    ZoneId string
    Availability zone of the instance's primary node.
    ZoneIds []string
    List of availability zones for each node in the instance.
    address_objects list(object)
    Connection information for the default endpoint Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    allow_list_version string
    Allowlist version
    backup_audit_log_size number
    Space used by audit logs in backup.
    backup_bin_log_size number
    Space used by binlog logs in backup.
    backup_data_size number
    Space used by data in backup.
    backup_error_log_size number
    Space used by error logs in backups.
    backup_free_quota_size number
    Free backup storage space, in GB
    backup_log_size number
    Space used by logs in backups.
    backup_slow_log_size number
    Space used by slow logs in backups.
    backup_use number
    Backup space used by the instance, in GB
    basic_backup_binlog_size number
    Space used by Binlog logs in basic backups.
    basic_backup_data_size number
    Space used by data in the base backup
    created_time string
    Instance creation local time.
    current_kernel_version string
    Instance kernel minor version.
    disaster_recovery_instances list(object)
    Disaster recovery instance information for the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    dr_dts_task_id string
    ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
    dr_dts_task_name string
    Name of synchronization tasks between primary and disaster recovery instances.
    dr_dts_task_status string
    Status of synchronization tasks between primary and disaster recovery instances.
    dr_seconds_behind_master number
    Latency between the disaster recovery instance and the primary instance.
    endpoints list(object)
    Instance connection information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    has_disaster_recovery_instances bool
    Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
    has_green_instance bool
    Is the instance in blue-green deployment? Values: true: yes. false: no.
    id string
    The provider-assigned unique ID for this managed resource.
    instance_id string
    Instance ID.
    instance_status string
    Instance status.
    master_instance_id string
    Primary instance ID
    master_instance_name string
    Primary instance name.
    memory number
    Memory size. Unit: GB.
    node_cpu_used_percentage number
    Average CPU usage of the primary node in the instance over the past minute.
    node_memory_used_percentage number
    Average memory usage of the primary node over the past minute
    node_number string
    Number of nodes.
    node_space_used_percentage number
    Average disk usage of the primary node over the past minute
    proxy_detail object
    proxy information
    storage_audit_log_size number
    Space used by audit logs in instance storage
    storage_bin_log_size number
    Binlog space usage in the instance storage
    storage_data_size number
    Space used by data in instance storage.
    storage_error_log_size number
    Space used by error logs in instance storage.
    storage_log_size number
    Space used by logs in the instance storage
    storage_slow_log_size number
    Space used by slow logs in instance storage
    storage_use number
    Storage space used by the instance, in GB
    time_zone string
    Time zone
    updated_time string
    Instance updates local time.
    vcpu number
    CPU size. For example: 1 means 1U.
    zone_id string
    Availability zone of the instance's primary node.
    zone_ids list(string)
    List of availability zones for each node in the instance.
    addressObjects List<InstanceAddressObject>
    Connection information for the default endpoint Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    allowListVersion String
    Allowlist version
    backupAuditLogSize Integer
    Space used by audit logs in backup.
    backupBinLogSize Integer
    Space used by binlog logs in backup.
    backupDataSize Integer
    Space used by data in backup.
    backupErrorLogSize Integer
    Space used by error logs in backups.
    backupFreeQuotaSize Integer
    Free backup storage space, in GB
    backupLogSize Integer
    Space used by logs in backups.
    backupSlowLogSize Integer
    Space used by slow logs in backups.
    backupUse Double
    Backup space used by the instance, in GB
    basicBackupBinlogSize Integer
    Space used by Binlog logs in basic backups.
    basicBackupDataSize Integer
    Space used by data in the base backup
    createdTime String
    Instance creation local time.
    currentKernelVersion String
    Instance kernel minor version.
    disasterRecoveryInstances List<InstanceDisasterRecoveryInstance>
    Disaster recovery instance information for the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    drDtsTaskId String
    ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
    drDtsTaskName String
    Name of synchronization tasks between primary and disaster recovery instances.
    drDtsTaskStatus String
    Status of synchronization tasks between primary and disaster recovery instances.
    drSecondsBehindMaster Integer
    Latency between the disaster recovery instance and the primary instance.
    endpoints List<InstanceEndpoint>
    Instance connection information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    hasDisasterRecoveryInstances Boolean
    Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
    hasGreenInstance Boolean
    Is the instance in blue-green deployment? Values: true: yes. false: no.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    Instance ID.
    instanceStatus String
    Instance status.
    masterInstanceId String
    Primary instance ID
    masterInstanceName String
    Primary instance name.
    memory Integer
    Memory size. Unit: GB.
    nodeCpuUsedPercentage Double
    Average CPU usage of the primary node in the instance over the past minute.
    nodeMemoryUsedPercentage Double
    Average memory usage of the primary node over the past minute
    nodeNumber String
    Number of nodes.
    nodeSpaceUsedPercentage Double
    Average disk usage of the primary node over the past minute
    proxyDetail InstanceProxyDetail
    proxy information
    storageAuditLogSize Integer
    Space used by audit logs in instance storage
    storageBinLogSize Integer
    Binlog space usage in the instance storage
    storageDataSize Integer
    Space used by data in instance storage.
    storageErrorLogSize Integer
    Space used by error logs in instance storage.
    storageLogSize Integer
    Space used by logs in the instance storage
    storageSlowLogSize Integer
    Space used by slow logs in instance storage
    storageUse Double
    Storage space used by the instance, in GB
    timeZone String
    Time zone
    updatedTime String
    Instance updates local time.
    vcpu Integer
    CPU size. For example: 1 means 1U.
    zoneId String
    Availability zone of the instance's primary node.
    zoneIds List<String>
    List of availability zones for each node in the instance.
    addressObjects InstanceAddressObject[]
    Connection information for the default endpoint Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    allowListVersion string
    Allowlist version
    backupAuditLogSize number
    Space used by audit logs in backup.
    backupBinLogSize number
    Space used by binlog logs in backup.
    backupDataSize number
    Space used by data in backup.
    backupErrorLogSize number
    Space used by error logs in backups.
    backupFreeQuotaSize number
    Free backup storage space, in GB
    backupLogSize number
    Space used by logs in backups.
    backupSlowLogSize number
    Space used by slow logs in backups.
    backupUse number
    Backup space used by the instance, in GB
    basicBackupBinlogSize number
    Space used by Binlog logs in basic backups.
    basicBackupDataSize number
    Space used by data in the base backup
    createdTime string
    Instance creation local time.
    currentKernelVersion string
    Instance kernel minor version.
    disasterRecoveryInstances InstanceDisasterRecoveryInstance[]
    Disaster recovery instance information for the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    drDtsTaskId string
    ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
    drDtsTaskName string
    Name of synchronization tasks between primary and disaster recovery instances.
    drDtsTaskStatus string
    Status of synchronization tasks between primary and disaster recovery instances.
    drSecondsBehindMaster number
    Latency between the disaster recovery instance and the primary instance.
    endpoints InstanceEndpoint[]
    Instance connection information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    hasDisasterRecoveryInstances boolean
    Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
    hasGreenInstance boolean
    Is the instance in blue-green deployment? Values: true: yes. false: no.
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId string
    Instance ID.
    instanceStatus string
    Instance status.
    masterInstanceId string
    Primary instance ID
    masterInstanceName string
    Primary instance name.
    memory number
    Memory size. Unit: GB.
    nodeCpuUsedPercentage number
    Average CPU usage of the primary node in the instance over the past minute.
    nodeMemoryUsedPercentage number
    Average memory usage of the primary node over the past minute
    nodeNumber string
    Number of nodes.
    nodeSpaceUsedPercentage number
    Average disk usage of the primary node over the past minute
    proxyDetail InstanceProxyDetail
    proxy information
    storageAuditLogSize number
    Space used by audit logs in instance storage
    storageBinLogSize number
    Binlog space usage in the instance storage
    storageDataSize number
    Space used by data in instance storage.
    storageErrorLogSize number
    Space used by error logs in instance storage.
    storageLogSize number
    Space used by logs in the instance storage
    storageSlowLogSize number
    Space used by slow logs in instance storage
    storageUse number
    Storage space used by the instance, in GB
    timeZone string
    Time zone
    updatedTime string
    Instance updates local time.
    vcpu number
    CPU size. For example: 1 means 1U.
    zoneId string
    Availability zone of the instance's primary node.
    zoneIds string[]
    List of availability zones for each node in the instance.
    address_objects Sequence[InstanceAddressObject]
    Connection information for the default endpoint Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    allow_list_version str
    Allowlist version
    backup_audit_log_size int
    Space used by audit logs in backup.
    backup_bin_log_size int
    Space used by binlog logs in backup.
    backup_data_size int
    Space used by data in backup.
    backup_error_log_size int
    Space used by error logs in backups.
    backup_free_quota_size int
    Free backup storage space, in GB
    backup_log_size int
    Space used by logs in backups.
    backup_slow_log_size int
    Space used by slow logs in backups.
    backup_use float
    Backup space used by the instance, in GB
    basic_backup_binlog_size int
    Space used by Binlog logs in basic backups.
    basic_backup_data_size int
    Space used by data in the base backup
    created_time str
    Instance creation local time.
    current_kernel_version str
    Instance kernel minor version.
    disaster_recovery_instances Sequence[InstanceDisasterRecoveryInstance]
    Disaster recovery instance information for the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    dr_dts_task_id str
    ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
    dr_dts_task_name str
    Name of synchronization tasks between primary and disaster recovery instances.
    dr_dts_task_status str
    Status of synchronization tasks between primary and disaster recovery instances.
    dr_seconds_behind_master int
    Latency between the disaster recovery instance and the primary instance.
    endpoints Sequence[InstanceEndpoint]
    Instance connection information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    has_disaster_recovery_instances bool
    Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
    has_green_instance bool
    Is the instance in blue-green deployment? Values: true: yes. false: no.
    id str
    The provider-assigned unique ID for this managed resource.
    instance_id str
    Instance ID.
    instance_status str
    Instance status.
    master_instance_id str
    Primary instance ID
    master_instance_name str
    Primary instance name.
    memory int
    Memory size. Unit: GB.
    node_cpu_used_percentage float
    Average CPU usage of the primary node in the instance over the past minute.
    node_memory_used_percentage float
    Average memory usage of the primary node over the past minute
    node_number str
    Number of nodes.
    node_space_used_percentage float
    Average disk usage of the primary node over the past minute
    proxy_detail InstanceProxyDetail
    proxy information
    storage_audit_log_size int
    Space used by audit logs in instance storage
    storage_bin_log_size int
    Binlog space usage in the instance storage
    storage_data_size int
    Space used by data in instance storage.
    storage_error_log_size int
    Space used by error logs in instance storage.
    storage_log_size int
    Space used by logs in the instance storage
    storage_slow_log_size int
    Space used by slow logs in instance storage
    storage_use float
    Storage space used by the instance, in GB
    time_zone str
    Time zone
    updated_time str
    Instance updates local time.
    vcpu int
    CPU size. For example: 1 means 1U.
    zone_id str
    Availability zone of the instance's primary node.
    zone_ids Sequence[str]
    List of availability zones for each node in the instance.
    addressObjects List<Property Map>
    Connection information for the default endpoint Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    allowListVersion String
    Allowlist version
    backupAuditLogSize Number
    Space used by audit logs in backup.
    backupBinLogSize Number
    Space used by binlog logs in backup.
    backupDataSize Number
    Space used by data in backup.
    backupErrorLogSize Number
    Space used by error logs in backups.
    backupFreeQuotaSize Number
    Free backup storage space, in GB
    backupLogSize Number
    Space used by logs in backups.
    backupSlowLogSize Number
    Space used by slow logs in backups.
    backupUse Number
    Backup space used by the instance, in GB
    basicBackupBinlogSize Number
    Space used by Binlog logs in basic backups.
    basicBackupDataSize Number
    Space used by data in the base backup
    createdTime String
    Instance creation local time.
    currentKernelVersion String
    Instance kernel minor version.
    disasterRecoveryInstances List<Property Map>
    Disaster recovery instance information for the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    drDtsTaskId String
    ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
    drDtsTaskName String
    Name of synchronization tasks between primary and disaster recovery instances.
    drDtsTaskStatus String
    Status of synchronization tasks between primary and disaster recovery instances.
    drSecondsBehindMaster Number
    Latency between the disaster recovery instance and the primary instance.
    endpoints List<Property Map>
    Instance connection information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    hasDisasterRecoveryInstances Boolean
    Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
    hasGreenInstance Boolean
    Is the instance in blue-green deployment? Values: true: yes. false: no.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    Instance ID.
    instanceStatus String
    Instance status.
    masterInstanceId String
    Primary instance ID
    masterInstanceName String
    Primary instance name.
    memory Number
    Memory size. Unit: GB.
    nodeCpuUsedPercentage Number
    Average CPU usage of the primary node in the instance over the past minute.
    nodeMemoryUsedPercentage Number
    Average memory usage of the primary node over the past minute
    nodeNumber String
    Number of nodes.
    nodeSpaceUsedPercentage Number
    Average disk usage of the primary node over the past minute
    proxyDetail Property Map
    proxy information
    storageAuditLogSize Number
    Space used by audit logs in instance storage
    storageBinLogSize Number
    Binlog space usage in the instance storage
    storageDataSize Number
    Space used by data in instance storage.
    storageErrorLogSize Number
    Space used by error logs in instance storage.
    storageLogSize Number
    Space used by logs in the instance storage
    storageSlowLogSize Number
    Space used by slow logs in instance storage
    storageUse Number
    Storage space used by the instance, in GB
    timeZone String
    Time zone
    updatedTime String
    Instance updates local time.
    vcpu Number
    CPU size. For example: 1 means 1U.
    zoneId String
    Availability zone of the instance's primary node.
    zoneIds List<String>
    List of availability zones for each node in 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,
        address_objects: Optional[Sequence[InstanceAddressObjectArgs]] = None,
        allow_list_ids: Optional[Sequence[str]] = None,
        allow_list_version: Optional[str] = None,
        auto_storage_scaling_config: Optional[InstanceAutoStorageScalingConfigArgs] = None,
        auto_upgrade_minor_version: Optional[str] = None,
        backup_audit_log_size: Optional[int] = None,
        backup_bin_log_size: Optional[int] = None,
        backup_data_size: Optional[int] = None,
        backup_error_log_size: Optional[int] = None,
        backup_free_quota_size: Optional[int] = None,
        backup_log_size: Optional[int] = None,
        backup_policy: Optional[InstanceBackupPolicyArgs] = None,
        backup_slow_log_size: Optional[int] = None,
        backup_use: Optional[float] = None,
        basic_backup_binlog_size: Optional[int] = None,
        basic_backup_data_size: Optional[int] = None,
        charge_detail: Optional[InstanceChargeDetailArgs] = None,
        cpu_num: Optional[int] = None,
        created_time: Optional[str] = None,
        current_kernel_version: Optional[str] = None,
        db_engine_version: Optional[str] = None,
        db_param_group_id: Optional[str] = None,
        db_time_zone: Optional[str] = None,
        deletion_protection: Optional[str] = None,
        disaster_recovery_instances: Optional[Sequence[InstanceDisasterRecoveryInstanceArgs]] = None,
        dr_dts_task_id: Optional[str] = None,
        dr_dts_task_name: Optional[str] = None,
        dr_dts_task_status: Optional[str] = None,
        dr_seconds_behind_master: Optional[int] = None,
        endpoints: Optional[Sequence[InstanceEndpointArgs]] = None,
        engine_type: Optional[str] = None,
        global_read_only: Optional[bool] = None,
        has_disaster_recovery_instances: Optional[bool] = None,
        has_green_instance: Optional[bool] = None,
        instance_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        instance_status: Optional[str] = None,
        instance_type: Optional[str] = None,
        lower_case_table_names: Optional[str] = None,
        maintenance_window: Optional[InstanceMaintenanceWindowArgs] = None,
        master_instance_id: Optional[str] = None,
        master_instance_name: Optional[str] = None,
        memory: Optional[int] = None,
        node_cpu_used_percentage: Optional[float] = None,
        node_memory_used_percentage: Optional[float] = None,
        node_number: Optional[str] = None,
        node_space_used_percentage: Optional[float] = None,
        node_spec: Optional[str] = None,
        nodes: Optional[Sequence[InstanceNodeArgs]] = None,
        parameter_template_id: Optional[str] = None,
        port: Optional[int] = None,
        private_ip_address: Optional[str] = None,
        project_name: Optional[str] = None,
        proxy_detail: Optional[InstanceProxyDetailArgs] = None,
        storage_audit_log_size: Optional[int] = None,
        storage_bin_log_size: Optional[int] = None,
        storage_data_size: Optional[int] = None,
        storage_error_log_size: Optional[int] = None,
        storage_log_size: Optional[int] = None,
        storage_slow_log_size: Optional[int] = None,
        storage_space: Optional[int] = None,
        storage_type: Optional[str] = None,
        storage_use: Optional[float] = None,
        subnet_id: Optional[str] = None,
        super_account_name: Optional[str] = None,
        super_account_password: Optional[str] = None,
        sync_mode: Optional[str] = None,
        tags: Optional[Sequence[InstanceTagArgs]] = None,
        time_zone: Optional[str] = None,
        updated_time: Optional[str] = None,
        vcpu: Optional[int] = None,
        vpc_id: Optional[str] = None,
        zone_id: Optional[str] = None,
        zone_ids: Optional[Sequence[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: volcenginecc:rdsmysql:Instance    get:      id: ${id}
    import {
  to = volcenginecc_rdsmysql_instance.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AddressObjects List<Volcengine.InstanceAddressObject>
    Connection information for the default endpoint Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    AllowListIds List<string>
    Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
    AllowListVersion string
    Allowlist version
    AutoStorageScalingConfig Volcengine.InstanceAutoStorageScalingConfig
    Auto scaling configuration
    AutoUpgradeMinorVersion string
    Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
    BackupAuditLogSize int
    Space used by audit logs in backup.
    BackupBinLogSize int
    Space used by binlog logs in backup.
    BackupDataSize int
    Space used by data in backup.
    BackupErrorLogSize int
    Space used by error logs in backups.
    BackupFreeQuotaSize int
    Free backup storage space, in GB
    BackupLogSize int
    Space used by logs in backups.
    BackupPolicy Volcengine.InstanceBackupPolicy
    Instance backup policy configuration.
    BackupSlowLogSize int
    Space used by slow logs in backups.
    BackupUse double
    Backup space used by the instance, in GB
    BasicBackupBinlogSize int
    Space used by Binlog logs in basic backups.
    BasicBackupDataSize int
    Space used by data in the base backup
    ChargeDetail Volcengine.InstanceChargeDetail
    Billing method
    CpuNum int
    Number of CPU cores for the database proxy service of the instance
    CreatedTime string
    Instance creation local time.
    CurrentKernelVersion string
    Instance kernel minor version.
    DbEngineVersion string
    Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
    DbParamGroupId string
    Parameter template ID. Default value is the default parameter template for the database engine version
    DbTimeZone string
    Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
    DeletionProtection string
    Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
    DisasterRecoveryInstances List<Volcengine.InstanceDisasterRecoveryInstance>
    Disaster recovery instance information for the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    DrDtsTaskId string
    ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
    DrDtsTaskName string
    Name of synchronization tasks between primary and disaster recovery instances.
    DrDtsTaskStatus string
    Status of synchronization tasks between primary and disaster recovery instances.
    DrSecondsBehindMaster int
    Latency between the disaster recovery instance and the primary instance.
    Endpoints List<Volcengine.InstanceEndpoint>
    Instance connection information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    EngineType string
    Database engine type. Values: InnoDB: InnoDB engine. RocksDB: RocksDB engine.
    GlobalReadOnly bool
    Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
    HasDisasterRecoveryInstances bool
    Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
    HasGreenInstance bool
    Is the instance in blue-green deployment? Values: true: yes. false: no.
    InstanceId string
    Instance ID.
    InstanceName string
    Instance name.
    InstanceStatus string
    Instance status.
    InstanceType string
    Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
    LowerCaseTableNames string
    Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
    MaintenanceWindow Volcengine.InstanceMaintenanceWindow
    Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
    MasterInstanceId string
    Primary instance ID
    MasterInstanceName string
    Primary instance name.
    Memory int
    Memory size. Unit: GB.
    NodeCpuUsedPercentage double
    Average CPU usage of the primary node in the instance over the past minute.
    NodeMemoryUsedPercentage double
    Average memory usage of the primary node over the past minute
    NodeNumber string
    Number of nodes.
    NodeSpaceUsedPercentage double
    Average disk usage of the primary node over the past minute
    NodeSpec string
    Node specifications.
    Nodes List<Volcengine.InstanceNode>
    Instance node information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    ParameterTemplateId string
    Parameter template ID.
    Port int
    Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
    PrivateIpAddress string
    Specify the default terminal IP address of the instance within the designated private network and subnet. Note: If not set, the default terminal IP address will be automatically assigned within the specified private network and subnet.
    ProjectName string
    Project.
    ProxyDetail Volcengine.InstanceProxyDetail
    proxy information
    StorageAuditLogSize int
    Space used by audit logs in instance storage
    StorageBinLogSize int
    Binlog space usage in the instance storage
    StorageDataSize int
    Space used by data in instance storage.
    StorageErrorLogSize int
    Space used by error logs in instance storage.
    StorageLogSize int
    Space used by logs in the instance storage
    StorageSlowLogSize int
    Space used by slow logs in instance storage
    StorageSpace int
    Total storage space of the instance, in GB
    StorageType string
    Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
    StorageUse double
    Storage space used by the instance, in GB
    SubnetId string
    Subnet ID.
    SuperAccountName string
    High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
    SuperAccountPassword string
    Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
    SyncMode string
    Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
    Tags List<Volcengine.InstanceTag>
    RDS MySQL instance tag information Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    TimeZone string
    Time zone
    UpdatedTime string
    Instance updates local time.
    Vcpu int
    CPU size. For example: 1 means 1U.
    VpcId string
    VPC (Virtual Private Cloud) ID.
    ZoneId string
    Availability zone of the instance's primary node.
    ZoneIds List<string>
    List of availability zones for each node in the instance.
    AddressObjects []InstanceAddressObjectArgs
    Connection information for the default endpoint Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    AllowListIds []string
    Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
    AllowListVersion string
    Allowlist version
    AutoStorageScalingConfig InstanceAutoStorageScalingConfigArgs
    Auto scaling configuration
    AutoUpgradeMinorVersion string
    Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
    BackupAuditLogSize int
    Space used by audit logs in backup.
    BackupBinLogSize int
    Space used by binlog logs in backup.
    BackupDataSize int
    Space used by data in backup.
    BackupErrorLogSize int
    Space used by error logs in backups.
    BackupFreeQuotaSize int
    Free backup storage space, in GB
    BackupLogSize int
    Space used by logs in backups.
    BackupPolicy InstanceBackupPolicyArgs
    Instance backup policy configuration.
    BackupSlowLogSize int
    Space used by slow logs in backups.
    BackupUse float64
    Backup space used by the instance, in GB
    BasicBackupBinlogSize int
    Space used by Binlog logs in basic backups.
    BasicBackupDataSize int
    Space used by data in the base backup
    ChargeDetail InstanceChargeDetailArgs
    Billing method
    CpuNum int
    Number of CPU cores for the database proxy service of the instance
    CreatedTime string
    Instance creation local time.
    CurrentKernelVersion string
    Instance kernel minor version.
    DbEngineVersion string
    Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
    DbParamGroupId string
    Parameter template ID. Default value is the default parameter template for the database engine version
    DbTimeZone string
    Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
    DeletionProtection string
    Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
    DisasterRecoveryInstances []InstanceDisasterRecoveryInstanceArgs
    Disaster recovery instance information for the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    DrDtsTaskId string
    ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
    DrDtsTaskName string
    Name of synchronization tasks between primary and disaster recovery instances.
    DrDtsTaskStatus string
    Status of synchronization tasks between primary and disaster recovery instances.
    DrSecondsBehindMaster int
    Latency between the disaster recovery instance and the primary instance.
    Endpoints []InstanceEndpointArgs
    Instance connection information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    EngineType string
    Database engine type. Values: InnoDB: InnoDB engine. RocksDB: RocksDB engine.
    GlobalReadOnly bool
    Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
    HasDisasterRecoveryInstances bool
    Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
    HasGreenInstance bool
    Is the instance in blue-green deployment? Values: true: yes. false: no.
    InstanceId string
    Instance ID.
    InstanceName string
    Instance name.
    InstanceStatus string
    Instance status.
    InstanceType string
    Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
    LowerCaseTableNames string
    Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
    MaintenanceWindow InstanceMaintenanceWindowArgs
    Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
    MasterInstanceId string
    Primary instance ID
    MasterInstanceName string
    Primary instance name.
    Memory int
    Memory size. Unit: GB.
    NodeCpuUsedPercentage float64
    Average CPU usage of the primary node in the instance over the past minute.
    NodeMemoryUsedPercentage float64
    Average memory usage of the primary node over the past minute
    NodeNumber string
    Number of nodes.
    NodeSpaceUsedPercentage float64
    Average disk usage of the primary node over the past minute
    NodeSpec string
    Node specifications.
    Nodes []InstanceNodeArgs
    Instance node information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    ParameterTemplateId string
    Parameter template ID.
    Port int
    Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
    PrivateIpAddress string
    Specify the default terminal IP address of the instance within the designated private network and subnet. Note: If not set, the default terminal IP address will be automatically assigned within the specified private network and subnet.
    ProjectName string
    Project.
    ProxyDetail InstanceProxyDetailArgs
    proxy information
    StorageAuditLogSize int
    Space used by audit logs in instance storage
    StorageBinLogSize int
    Binlog space usage in the instance storage
    StorageDataSize int
    Space used by data in instance storage.
    StorageErrorLogSize int
    Space used by error logs in instance storage.
    StorageLogSize int
    Space used by logs in the instance storage
    StorageSlowLogSize int
    Space used by slow logs in instance storage
    StorageSpace int
    Total storage space of the instance, in GB
    StorageType string
    Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
    StorageUse float64
    Storage space used by the instance, in GB
    SubnetId string
    Subnet ID.
    SuperAccountName string
    High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
    SuperAccountPassword string
    Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
    SyncMode string
    Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
    Tags []InstanceTagArgs
    RDS MySQL instance tag information Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    TimeZone string
    Time zone
    UpdatedTime string
    Instance updates local time.
    Vcpu int
    CPU size. For example: 1 means 1U.
    VpcId string
    VPC (Virtual Private Cloud) ID.
    ZoneId string
    Availability zone of the instance's primary node.
    ZoneIds []string
    List of availability zones for each node in the instance.
    address_objects list(object)
    Connection information for the default endpoint Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    allow_list_ids list(string)
    Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
    allow_list_version string
    Allowlist version
    auto_storage_scaling_config object
    Auto scaling configuration
    auto_upgrade_minor_version string
    Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
    backup_audit_log_size number
    Space used by audit logs in backup.
    backup_bin_log_size number
    Space used by binlog logs in backup.
    backup_data_size number
    Space used by data in backup.
    backup_error_log_size number
    Space used by error logs in backups.
    backup_free_quota_size number
    Free backup storage space, in GB
    backup_log_size number
    Space used by logs in backups.
    backup_policy object
    Instance backup policy configuration.
    backup_slow_log_size number
    Space used by slow logs in backups.
    backup_use number
    Backup space used by the instance, in GB
    basic_backup_binlog_size number
    Space used by Binlog logs in basic backups.
    basic_backup_data_size number
    Space used by data in the base backup
    charge_detail object
    Billing method
    cpu_num number
    Number of CPU cores for the database proxy service of the instance
    created_time string
    Instance creation local time.
    current_kernel_version string
    Instance kernel minor version.
    db_engine_version string
    Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
    db_param_group_id string
    Parameter template ID. Default value is the default parameter template for the database engine version
    db_time_zone string
    Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
    deletion_protection string
    Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
    disaster_recovery_instances list(object)
    Disaster recovery instance information for the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    dr_dts_task_id string
    ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
    dr_dts_task_name string
    Name of synchronization tasks between primary and disaster recovery instances.
    dr_dts_task_status string
    Status of synchronization tasks between primary and disaster recovery instances.
    dr_seconds_behind_master number
    Latency between the disaster recovery instance and the primary instance.
    endpoints list(object)
    Instance connection information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    engine_type string
    Database engine type. Values: InnoDB: InnoDB engine. RocksDB: RocksDB engine.
    global_read_only bool
    Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
    has_disaster_recovery_instances bool
    Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
    has_green_instance bool
    Is the instance in blue-green deployment? Values: true: yes. false: no.
    instance_id string
    Instance ID.
    instance_name string
    Instance name.
    instance_status string
    Instance status.
    instance_type string
    Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
    lower_case_table_names string
    Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
    maintenance_window object
    Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
    master_instance_id string
    Primary instance ID
    master_instance_name string
    Primary instance name.
    memory number
    Memory size. Unit: GB.
    node_cpu_used_percentage number
    Average CPU usage of the primary node in the instance over the past minute.
    node_memory_used_percentage number
    Average memory usage of the primary node over the past minute
    node_number string
    Number of nodes.
    node_space_used_percentage number
    Average disk usage of the primary node over the past minute
    node_spec string
    Node specifications.
    nodes list(object)
    Instance node information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    parameter_template_id string
    Parameter template ID.
    port number
    Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
    private_ip_address string
    Specify the default terminal IP address of the instance within the designated private network and subnet. Note: If not set, the default terminal IP address will be automatically assigned within the specified private network and subnet.
    project_name string
    Project.
    proxy_detail object
    proxy information
    storage_audit_log_size number
    Space used by audit logs in instance storage
    storage_bin_log_size number
    Binlog space usage in the instance storage
    storage_data_size number
    Space used by data in instance storage.
    storage_error_log_size number
    Space used by error logs in instance storage.
    storage_log_size number
    Space used by logs in the instance storage
    storage_slow_log_size number
    Space used by slow logs in instance storage
    storage_space number
    Total storage space of the instance, in GB
    storage_type string
    Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
    storage_use number
    Storage space used by the instance, in GB
    subnet_id string
    Subnet ID.
    super_account_name string
    High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
    super_account_password string
    Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
    sync_mode string
    Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
    tags list(object)
    RDS MySQL instance tag information Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    time_zone string
    Time zone
    updated_time string
    Instance updates local time.
    vcpu number
    CPU size. For example: 1 means 1U.
    vpc_id string
    VPC (Virtual Private Cloud) ID.
    zone_id string
    Availability zone of the instance's primary node.
    zone_ids list(string)
    List of availability zones for each node in the instance.
    addressObjects List<InstanceAddressObject>
    Connection information for the default endpoint Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    allowListIds List<String>
    Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
    allowListVersion String
    Allowlist version
    autoStorageScalingConfig InstanceAutoStorageScalingConfig
    Auto scaling configuration
    autoUpgradeMinorVersion String
    Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
    backupAuditLogSize Integer
    Space used by audit logs in backup.
    backupBinLogSize Integer
    Space used by binlog logs in backup.
    backupDataSize Integer
    Space used by data in backup.
    backupErrorLogSize Integer
    Space used by error logs in backups.
    backupFreeQuotaSize Integer
    Free backup storage space, in GB
    backupLogSize Integer
    Space used by logs in backups.
    backupPolicy InstanceBackupPolicy
    Instance backup policy configuration.
    backupSlowLogSize Integer
    Space used by slow logs in backups.
    backupUse Double
    Backup space used by the instance, in GB
    basicBackupBinlogSize Integer
    Space used by Binlog logs in basic backups.
    basicBackupDataSize Integer
    Space used by data in the base backup
    chargeDetail InstanceChargeDetail
    Billing method
    cpuNum Integer
    Number of CPU cores for the database proxy service of the instance
    createdTime String
    Instance creation local time.
    currentKernelVersion String
    Instance kernel minor version.
    dbEngineVersion String
    Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
    dbParamGroupId String
    Parameter template ID. Default value is the default parameter template for the database engine version
    dbTimeZone String
    Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
    deletionProtection String
    Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
    disasterRecoveryInstances List<InstanceDisasterRecoveryInstance>
    Disaster recovery instance information for the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    drDtsTaskId String
    ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
    drDtsTaskName String
    Name of synchronization tasks between primary and disaster recovery instances.
    drDtsTaskStatus String
    Status of synchronization tasks between primary and disaster recovery instances.
    drSecondsBehindMaster Integer
    Latency between the disaster recovery instance and the primary instance.
    endpoints List<InstanceEndpoint>
    Instance connection information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    engineType String
    Database engine type. Values: InnoDB: InnoDB engine. RocksDB: RocksDB engine.
    globalReadOnly Boolean
    Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
    hasDisasterRecoveryInstances Boolean
    Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
    hasGreenInstance Boolean
    Is the instance in blue-green deployment? Values: true: yes. false: no.
    instanceId String
    Instance ID.
    instanceName String
    Instance name.
    instanceStatus String
    Instance status.
    instanceType String
    Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
    lowerCaseTableNames String
    Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
    maintenanceWindow InstanceMaintenanceWindow
    Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
    masterInstanceId String
    Primary instance ID
    masterInstanceName String
    Primary instance name.
    memory Integer
    Memory size. Unit: GB.
    nodeCpuUsedPercentage Double
    Average CPU usage of the primary node in the instance over the past minute.
    nodeMemoryUsedPercentage Double
    Average memory usage of the primary node over the past minute
    nodeNumber String
    Number of nodes.
    nodeSpaceUsedPercentage Double
    Average disk usage of the primary node over the past minute
    nodeSpec String
    Node specifications.
    nodes List<InstanceNode>
    Instance node information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    parameterTemplateId String
    Parameter template ID.
    port Integer
    Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
    privateIpAddress String
    Specify the default terminal IP address of the instance within the designated private network and subnet. Note: If not set, the default terminal IP address will be automatically assigned within the specified private network and subnet.
    projectName String
    Project.
    proxyDetail InstanceProxyDetail
    proxy information
    storageAuditLogSize Integer
    Space used by audit logs in instance storage
    storageBinLogSize Integer
    Binlog space usage in the instance storage
    storageDataSize Integer
    Space used by data in instance storage.
    storageErrorLogSize Integer
    Space used by error logs in instance storage.
    storageLogSize Integer
    Space used by logs in the instance storage
    storageSlowLogSize Integer
    Space used by slow logs in instance storage
    storageSpace Integer
    Total storage space of the instance, in GB
    storageType String
    Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
    storageUse Double
    Storage space used by the instance, in GB
    subnetId String
    Subnet ID.
    superAccountName String
    High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
    superAccountPassword String
    Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
    syncMode String
    Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
    tags List<InstanceTag>
    RDS MySQL instance tag information Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    timeZone String
    Time zone
    updatedTime String
    Instance updates local time.
    vcpu Integer
    CPU size. For example: 1 means 1U.
    vpcId String
    VPC (Virtual Private Cloud) ID.
    zoneId String
    Availability zone of the instance's primary node.
    zoneIds List<String>
    List of availability zones for each node in the instance.
    addressObjects InstanceAddressObject[]
    Connection information for the default endpoint Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    allowListIds string[]
    Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
    allowListVersion string
    Allowlist version
    autoStorageScalingConfig InstanceAutoStorageScalingConfig
    Auto scaling configuration
    autoUpgradeMinorVersion string
    Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
    backupAuditLogSize number
    Space used by audit logs in backup.
    backupBinLogSize number
    Space used by binlog logs in backup.
    backupDataSize number
    Space used by data in backup.
    backupErrorLogSize number
    Space used by error logs in backups.
    backupFreeQuotaSize number
    Free backup storage space, in GB
    backupLogSize number
    Space used by logs in backups.
    backupPolicy InstanceBackupPolicy
    Instance backup policy configuration.
    backupSlowLogSize number
    Space used by slow logs in backups.
    backupUse number
    Backup space used by the instance, in GB
    basicBackupBinlogSize number
    Space used by Binlog logs in basic backups.
    basicBackupDataSize number
    Space used by data in the base backup
    chargeDetail InstanceChargeDetail
    Billing method
    cpuNum number
    Number of CPU cores for the database proxy service of the instance
    createdTime string
    Instance creation local time.
    currentKernelVersion string
    Instance kernel minor version.
    dbEngineVersion string
    Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
    dbParamGroupId string
    Parameter template ID. Default value is the default parameter template for the database engine version
    dbTimeZone string
    Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
    deletionProtection string
    Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
    disasterRecoveryInstances InstanceDisasterRecoveryInstance[]
    Disaster recovery instance information for the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    drDtsTaskId string
    ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
    drDtsTaskName string
    Name of synchronization tasks between primary and disaster recovery instances.
    drDtsTaskStatus string
    Status of synchronization tasks between primary and disaster recovery instances.
    drSecondsBehindMaster number
    Latency between the disaster recovery instance and the primary instance.
    endpoints InstanceEndpoint[]
    Instance connection information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    engineType string
    Database engine type. Values: InnoDB: InnoDB engine. RocksDB: RocksDB engine.
    globalReadOnly boolean
    Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
    hasDisasterRecoveryInstances boolean
    Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
    hasGreenInstance boolean
    Is the instance in blue-green deployment? Values: true: yes. false: no.
    instanceId string
    Instance ID.
    instanceName string
    Instance name.
    instanceStatus string
    Instance status.
    instanceType string
    Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
    lowerCaseTableNames string
    Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
    maintenanceWindow InstanceMaintenanceWindow
    Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
    masterInstanceId string
    Primary instance ID
    masterInstanceName string
    Primary instance name.
    memory number
    Memory size. Unit: GB.
    nodeCpuUsedPercentage number
    Average CPU usage of the primary node in the instance over the past minute.
    nodeMemoryUsedPercentage number
    Average memory usage of the primary node over the past minute
    nodeNumber string
    Number of nodes.
    nodeSpaceUsedPercentage number
    Average disk usage of the primary node over the past minute
    nodeSpec string
    Node specifications.
    nodes InstanceNode[]
    Instance node information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    parameterTemplateId string
    Parameter template ID.
    port number
    Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
    privateIpAddress string
    Specify the default terminal IP address of the instance within the designated private network and subnet. Note: If not set, the default terminal IP address will be automatically assigned within the specified private network and subnet.
    projectName string
    Project.
    proxyDetail InstanceProxyDetail
    proxy information
    storageAuditLogSize number
    Space used by audit logs in instance storage
    storageBinLogSize number
    Binlog space usage in the instance storage
    storageDataSize number
    Space used by data in instance storage.
    storageErrorLogSize number
    Space used by error logs in instance storage.
    storageLogSize number
    Space used by logs in the instance storage
    storageSlowLogSize number
    Space used by slow logs in instance storage
    storageSpace number
    Total storage space of the instance, in GB
    storageType string
    Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
    storageUse number
    Storage space used by the instance, in GB
    subnetId string
    Subnet ID.
    superAccountName string
    High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
    superAccountPassword string
    Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
    syncMode string
    Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
    tags InstanceTag[]
    RDS MySQL instance tag information Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    timeZone string
    Time zone
    updatedTime string
    Instance updates local time.
    vcpu number
    CPU size. For example: 1 means 1U.
    vpcId string
    VPC (Virtual Private Cloud) ID.
    zoneId string
    Availability zone of the instance's primary node.
    zoneIds string[]
    List of availability zones for each node in the instance.
    address_objects Sequence[InstanceAddressObjectArgs]
    Connection information for the default endpoint Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    allow_list_ids Sequence[str]
    Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
    allow_list_version str
    Allowlist version
    auto_storage_scaling_config InstanceAutoStorageScalingConfigArgs
    Auto scaling configuration
    auto_upgrade_minor_version str
    Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
    backup_audit_log_size int
    Space used by audit logs in backup.
    backup_bin_log_size int
    Space used by binlog logs in backup.
    backup_data_size int
    Space used by data in backup.
    backup_error_log_size int
    Space used by error logs in backups.
    backup_free_quota_size int
    Free backup storage space, in GB
    backup_log_size int
    Space used by logs in backups.
    backup_policy InstanceBackupPolicyArgs
    Instance backup policy configuration.
    backup_slow_log_size int
    Space used by slow logs in backups.
    backup_use float
    Backup space used by the instance, in GB
    basic_backup_binlog_size int
    Space used by Binlog logs in basic backups.
    basic_backup_data_size int
    Space used by data in the base backup
    charge_detail InstanceChargeDetailArgs
    Billing method
    cpu_num int
    Number of CPU cores for the database proxy service of the instance
    created_time str
    Instance creation local time.
    current_kernel_version str
    Instance kernel minor version.
    db_engine_version str
    Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
    db_param_group_id str
    Parameter template ID. Default value is the default parameter template for the database engine version
    db_time_zone str
    Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
    deletion_protection str
    Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
    disaster_recovery_instances Sequence[InstanceDisasterRecoveryInstanceArgs]
    Disaster recovery instance information for the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    dr_dts_task_id str
    ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
    dr_dts_task_name str
    Name of synchronization tasks between primary and disaster recovery instances.
    dr_dts_task_status str
    Status of synchronization tasks between primary and disaster recovery instances.
    dr_seconds_behind_master int
    Latency between the disaster recovery instance and the primary instance.
    endpoints Sequence[InstanceEndpointArgs]
    Instance connection information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    engine_type str
    Database engine type. Values: InnoDB: InnoDB engine. RocksDB: RocksDB engine.
    global_read_only bool
    Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
    has_disaster_recovery_instances bool
    Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
    has_green_instance bool
    Is the instance in blue-green deployment? Values: true: yes. false: no.
    instance_id str
    Instance ID.
    instance_name str
    Instance name.
    instance_status str
    Instance status.
    instance_type str
    Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
    lower_case_table_names str
    Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
    maintenance_window InstanceMaintenanceWindowArgs
    Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
    master_instance_id str
    Primary instance ID
    master_instance_name str
    Primary instance name.
    memory int
    Memory size. Unit: GB.
    node_cpu_used_percentage float
    Average CPU usage of the primary node in the instance over the past minute.
    node_memory_used_percentage float
    Average memory usage of the primary node over the past minute
    node_number str
    Number of nodes.
    node_space_used_percentage float
    Average disk usage of the primary node over the past minute
    node_spec str
    Node specifications.
    nodes Sequence[InstanceNodeArgs]
    Instance node information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    parameter_template_id str
    Parameter template ID.
    port int
    Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
    private_ip_address str
    Specify the default terminal IP address of the instance within the designated private network and subnet. Note: If not set, the default terminal IP address will be automatically assigned within the specified private network and subnet.
    project_name str
    Project.
    proxy_detail InstanceProxyDetailArgs
    proxy information
    storage_audit_log_size int
    Space used by audit logs in instance storage
    storage_bin_log_size int
    Binlog space usage in the instance storage
    storage_data_size int
    Space used by data in instance storage.
    storage_error_log_size int
    Space used by error logs in instance storage.
    storage_log_size int
    Space used by logs in the instance storage
    storage_slow_log_size int
    Space used by slow logs in instance storage
    storage_space int
    Total storage space of the instance, in GB
    storage_type str
    Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
    storage_use float
    Storage space used by the instance, in GB
    subnet_id str
    Subnet ID.
    super_account_name str
    High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
    super_account_password str
    Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
    sync_mode str
    Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
    tags Sequence[InstanceTagArgs]
    RDS MySQL instance tag information Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    time_zone str
    Time zone
    updated_time str
    Instance updates local time.
    vcpu int
    CPU size. For example: 1 means 1U.
    vpc_id str
    VPC (Virtual Private Cloud) ID.
    zone_id str
    Availability zone of the instance's primary node.
    zone_ids Sequence[str]
    List of availability zones for each node in the instance.
    addressObjects List<Property Map>
    Connection information for the default endpoint Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    allowListIds List<String>
    Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
    allowListVersion String
    Allowlist version
    autoStorageScalingConfig Property Map
    Auto scaling configuration
    autoUpgradeMinorVersion String
    Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
    backupAuditLogSize Number
    Space used by audit logs in backup.
    backupBinLogSize Number
    Space used by binlog logs in backup.
    backupDataSize Number
    Space used by data in backup.
    backupErrorLogSize Number
    Space used by error logs in backups.
    backupFreeQuotaSize Number
    Free backup storage space, in GB
    backupLogSize Number
    Space used by logs in backups.
    backupPolicy Property Map
    Instance backup policy configuration.
    backupSlowLogSize Number
    Space used by slow logs in backups.
    backupUse Number
    Backup space used by the instance, in GB
    basicBackupBinlogSize Number
    Space used by Binlog logs in basic backups.
    basicBackupDataSize Number
    Space used by data in the base backup
    chargeDetail Property Map
    Billing method
    cpuNum Number
    Number of CPU cores for the database proxy service of the instance
    createdTime String
    Instance creation local time.
    currentKernelVersion String
    Instance kernel minor version.
    dbEngineVersion String
    Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
    dbParamGroupId String
    Parameter template ID. Default value is the default parameter template for the database engine version
    dbTimeZone String
    Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
    deletionProtection String
    Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
    disasterRecoveryInstances List<Property Map>
    Disaster recovery instance information for the instance. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    drDtsTaskId String
    ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
    drDtsTaskName String
    Name of synchronization tasks between primary and disaster recovery instances.
    drDtsTaskStatus String
    Status of synchronization tasks between primary and disaster recovery instances.
    drSecondsBehindMaster Number
    Latency between the disaster recovery instance and the primary instance.
    endpoints List<Property Map>
    Instance connection information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    engineType String
    Database engine type. Values: InnoDB: InnoDB engine. RocksDB: RocksDB engine.
    globalReadOnly Boolean
    Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
    hasDisasterRecoveryInstances Boolean
    Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
    hasGreenInstance Boolean
    Is the instance in blue-green deployment? Values: true: yes. false: no.
    instanceId String
    Instance ID.
    instanceName String
    Instance name.
    instanceStatus String
    Instance status.
    instanceType String
    Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
    lowerCaseTableNames String
    Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
    maintenanceWindow Property Map
    Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
    masterInstanceId String
    Primary instance ID
    masterInstanceName String
    Primary instance name.
    memory Number
    Memory size. Unit: GB.
    nodeCpuUsedPercentage Number
    Average CPU usage of the primary node in the instance over the past minute.
    nodeMemoryUsedPercentage Number
    Average memory usage of the primary node over the past minute
    nodeNumber String
    Number of nodes.
    nodeSpaceUsedPercentage Number
    Average disk usage of the primary node over the past minute
    nodeSpec String
    Node specifications.
    nodes List<Property Map>
    Instance node information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    parameterTemplateId String
    Parameter template ID.
    port Number
    Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
    privateIpAddress String
    Specify the default terminal IP address of the instance within the designated private network and subnet. Note: If not set, the default terminal IP address will be automatically assigned within the specified private network and subnet.
    projectName String
    Project.
    proxyDetail Property Map
    proxy information
    storageAuditLogSize Number
    Space used by audit logs in instance storage
    storageBinLogSize Number
    Binlog space usage in the instance storage
    storageDataSize Number
    Space used by data in instance storage.
    storageErrorLogSize Number
    Space used by error logs in instance storage.
    storageLogSize Number
    Space used by logs in the instance storage
    storageSlowLogSize Number
    Space used by slow logs in instance storage
    storageSpace Number
    Total storage space of the instance, in GB
    storageType String
    Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
    storageUse Number
    Storage space used by the instance, in GB
    subnetId String
    Subnet ID.
    superAccountName String
    High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
    superAccountPassword String
    Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
    syncMode String
    Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
    tags List<Property Map>
    RDS MySQL instance tag information Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    timeZone String
    Time zone
    updatedTime String
    Instance updates local time.
    vcpu Number
    CPU size. For example: 1 means 1U.
    vpcId String
    VPC (Virtual Private Cloud) ID.
    zoneId String
    Availability zone of the instance's primary node.
    zoneIds List<String>
    List of availability zones for each node in the instance.

    Supporting Types

    InstanceAddressObject, InstanceAddressObjectArgs

    DnsVisibility bool
    false: private network resolution (default). true: private and public network resolution.
    Domain string
    Connection domain name
    EipId string
    EIP ID, valid only for Public addresses.
    InternetProtocol string
    IP protocol version. Value: IPv4.
    IpAddress string
    IP address.
    NetworkType string
    Network address type. Values: Private: private address. Public: public address
    Port string
    Port
    SubnetId string
    Subnet ID, valid only for Private addresses
    DnsVisibility bool
    false: private network resolution (default). true: private and public network resolution.
    Domain string
    Connection domain name
    EipId string
    EIP ID, valid only for Public addresses.
    InternetProtocol string
    IP protocol version. Value: IPv4.
    IpAddress string
    IP address.
    NetworkType string
    Network address type. Values: Private: private address. Public: public address
    Port string
    Port
    SubnetId string
    Subnet ID, valid only for Private addresses
    dns_visibility bool
    false: private network resolution (default). true: private and public network resolution.
    domain string
    Connection domain name
    eip_id string
    EIP ID, valid only for Public addresses.
    internet_protocol string
    IP protocol version. Value: IPv4.
    ip_address string
    IP address.
    network_type string
    Network address type. Values: Private: private address. Public: public address
    port string
    Port
    subnet_id string
    Subnet ID, valid only for Private addresses
    dnsVisibility Boolean
    false: private network resolution (default). true: private and public network resolution.
    domain String
    Connection domain name
    eipId String
    EIP ID, valid only for Public addresses.
    internetProtocol String
    IP protocol version. Value: IPv4.
    ipAddress String
    IP address.
    networkType String
    Network address type. Values: Private: private address. Public: public address
    port String
    Port
    subnetId String
    Subnet ID, valid only for Private addresses
    dnsVisibility boolean
    false: private network resolution (default). true: private and public network resolution.
    domain string
    Connection domain name
    eipId string
    EIP ID, valid only for Public addresses.
    internetProtocol string
    IP protocol version. Value: IPv4.
    ipAddress string
    IP address.
    networkType string
    Network address type. Values: Private: private address. Public: public address
    port string
    Port
    subnetId string
    Subnet ID, valid only for Private addresses
    dns_visibility bool
    false: private network resolution (default). true: private and public network resolution.
    domain str
    Connection domain name
    eip_id str
    EIP ID, valid only for Public addresses.
    internet_protocol str
    IP protocol version. Value: IPv4.
    ip_address str
    IP address.
    network_type str
    Network address type. Values: Private: private address. Public: public address
    port str
    Port
    subnet_id str
    Subnet ID, valid only for Private addresses
    dnsVisibility Boolean
    false: private network resolution (default). true: private and public network resolution.
    domain String
    Connection domain name
    eipId String
    EIP ID, valid only for Public addresses.
    internetProtocol String
    IP protocol version. Value: IPv4.
    ipAddress String
    IP address.
    networkType String
    Network address type. Values: Private: private address. Public: public address
    port String
    Port
    subnetId String
    Subnet ID, valid only for Private addresses

    InstanceAutoStorageScalingConfig, InstanceAutoStorageScalingConfigArgs

    EnableStorageAutoScale bool
    Whether to enable automatic scaling for the instance. Values: true: Yes. false: No.
    ScalingDetectNode string
    Node range for automatic scaling detection. Values: MasterNode: primary node. MasterSlaveNodes: primary and secondary nodes. AllNodes: all nodes. Note: When used as a request parameter, the default is MasterNode. For multi-node instances, MasterSlaveNodes and AllNodes have the same effect. For single-node instances, MasterNode, MasterSlaveNodes, and AllNodes have the same effect.
    StorageThreshold int
    Percentage of available storage space that triggers automatic scaling. Value range: 10–50, default: 10, unit: %
    StorageUpperBound int
    Maximum storage space for automatic expansion. The minimum value is instance storage space + 20 GB; the maximum value is the upper limit of the storage space range for the primary node specification, in GB. See details about selectable storage space ranges for different specifications.
    EnableStorageAutoScale bool
    Whether to enable automatic scaling for the instance. Values: true: Yes. false: No.
    ScalingDetectNode string
    Node range for automatic scaling detection. Values: MasterNode: primary node. MasterSlaveNodes: primary and secondary nodes. AllNodes: all nodes. Note: When used as a request parameter, the default is MasterNode. For multi-node instances, MasterSlaveNodes and AllNodes have the same effect. For single-node instances, MasterNode, MasterSlaveNodes, and AllNodes have the same effect.
    StorageThreshold int
    Percentage of available storage space that triggers automatic scaling. Value range: 10–50, default: 10, unit: %
    StorageUpperBound int
    Maximum storage space for automatic expansion. The minimum value is instance storage space + 20 GB; the maximum value is the upper limit of the storage space range for the primary node specification, in GB. See details about selectable storage space ranges for different specifications.
    enable_storage_auto_scale bool
    Whether to enable automatic scaling for the instance. Values: true: Yes. false: No.
    scaling_detect_node string
    Node range for automatic scaling detection. Values: MasterNode: primary node. MasterSlaveNodes: primary and secondary nodes. AllNodes: all nodes. Note: When used as a request parameter, the default is MasterNode. For multi-node instances, MasterSlaveNodes and AllNodes have the same effect. For single-node instances, MasterNode, MasterSlaveNodes, and AllNodes have the same effect.
    storage_threshold number
    Percentage of available storage space that triggers automatic scaling. Value range: 10–50, default: 10, unit: %
    storage_upper_bound number
    Maximum storage space for automatic expansion. The minimum value is instance storage space + 20 GB; the maximum value is the upper limit of the storage space range for the primary node specification, in GB. See details about selectable storage space ranges for different specifications.
    enableStorageAutoScale Boolean
    Whether to enable automatic scaling for the instance. Values: true: Yes. false: No.
    scalingDetectNode String
    Node range for automatic scaling detection. Values: MasterNode: primary node. MasterSlaveNodes: primary and secondary nodes. AllNodes: all nodes. Note: When used as a request parameter, the default is MasterNode. For multi-node instances, MasterSlaveNodes and AllNodes have the same effect. For single-node instances, MasterNode, MasterSlaveNodes, and AllNodes have the same effect.
    storageThreshold Integer
    Percentage of available storage space that triggers automatic scaling. Value range: 10–50, default: 10, unit: %
    storageUpperBound Integer
    Maximum storage space for automatic expansion. The minimum value is instance storage space + 20 GB; the maximum value is the upper limit of the storage space range for the primary node specification, in GB. See details about selectable storage space ranges for different specifications.
    enableStorageAutoScale boolean
    Whether to enable automatic scaling for the instance. Values: true: Yes. false: No.
    scalingDetectNode string
    Node range for automatic scaling detection. Values: MasterNode: primary node. MasterSlaveNodes: primary and secondary nodes. AllNodes: all nodes. Note: When used as a request parameter, the default is MasterNode. For multi-node instances, MasterSlaveNodes and AllNodes have the same effect. For single-node instances, MasterNode, MasterSlaveNodes, and AllNodes have the same effect.
    storageThreshold number
    Percentage of available storage space that triggers automatic scaling. Value range: 10–50, default: 10, unit: %
    storageUpperBound number
    Maximum storage space for automatic expansion. The minimum value is instance storage space + 20 GB; the maximum value is the upper limit of the storage space range for the primary node specification, in GB. See details about selectable storage space ranges for different specifications.
    enable_storage_auto_scale bool
    Whether to enable automatic scaling for the instance. Values: true: Yes. false: No.
    scaling_detect_node str
    Node range for automatic scaling detection. Values: MasterNode: primary node. MasterSlaveNodes: primary and secondary nodes. AllNodes: all nodes. Note: When used as a request parameter, the default is MasterNode. For multi-node instances, MasterSlaveNodes and AllNodes have the same effect. For single-node instances, MasterNode, MasterSlaveNodes, and AllNodes have the same effect.
    storage_threshold int
    Percentage of available storage space that triggers automatic scaling. Value range: 10–50, default: 10, unit: %
    storage_upper_bound int
    Maximum storage space for automatic expansion. The minimum value is instance storage space + 20 GB; the maximum value is the upper limit of the storage space range for the primary node specification, in GB. See details about selectable storage space ranges for different specifications.
    enableStorageAutoScale Boolean
    Whether to enable automatic scaling for the instance. Values: true: Yes. false: No.
    scalingDetectNode String
    Node range for automatic scaling detection. Values: MasterNode: primary node. MasterSlaveNodes: primary and secondary nodes. AllNodes: all nodes. Note: When used as a request parameter, the default is MasterNode. For multi-node instances, MasterSlaveNodes and AllNodes have the same effect. For single-node instances, MasterNode, MasterSlaveNodes, and AllNodes have the same effect.
    storageThreshold Number
    Percentage of available storage space that triggers automatic scaling. Value range: 10–50, default: 10, unit: %
    storageUpperBound Number
    Maximum storage space for automatic expansion. The minimum value is instance storage space + 20 GB; the maximum value is the upper limit of the storage space range for the primary node specification, in GB. See details about selectable storage space ranges for different specifications.

    InstanceBackupPolicy, InstanceBackupPolicyArgs

    AvailableCrossRegions List<string>
    List of destination regions available for cross-region backup.
    BackupPolicyBase Volcengine.InstanceBackupPolicyBackupPolicyBase
    Basic backup policy.
    CrossBackupPolicy Volcengine.InstanceBackupPolicyCrossBackupPolicy
    Cross-region backup policy.
    AvailableCrossRegions []string
    List of destination regions available for cross-region backup.
    BackupPolicyBase InstanceBackupPolicyBackupPolicyBase
    Basic backup policy.
    CrossBackupPolicy InstanceBackupPolicyCrossBackupPolicy
    Cross-region backup policy.
    available_cross_regions list(string)
    List of destination regions available for cross-region backup.
    backup_policy_base object
    Basic backup policy.
    cross_backup_policy object
    Cross-region backup policy.
    availableCrossRegions List<String>
    List of destination regions available for cross-region backup.
    backupPolicyBase InstanceBackupPolicyBackupPolicyBase
    Basic backup policy.
    crossBackupPolicy InstanceBackupPolicyCrossBackupPolicy
    Cross-region backup policy.
    availableCrossRegions string[]
    List of destination regions available for cross-region backup.
    backupPolicyBase InstanceBackupPolicyBackupPolicyBase
    Basic backup policy.
    crossBackupPolicy InstanceBackupPolicyCrossBackupPolicy
    Cross-region backup policy.
    available_cross_regions Sequence[str]
    List of destination regions available for cross-region backup.
    backup_policy_base InstanceBackupPolicyBackupPolicyBase
    Basic backup policy.
    cross_backup_policy InstanceBackupPolicyCrossBackupPolicy
    Cross-region backup policy.
    availableCrossRegions List<String>
    List of destination regions available for cross-region backup.
    backupPolicyBase Property Map
    Basic backup policy.
    crossBackupPolicy Property Map
    Cross-region backup policy.

    InstanceBackupPolicyBackupPolicyBase, InstanceBackupPolicyBackupPolicyBaseArgs

    BinlogBackupAllRetention bool
    Retain all log backups before releasing the instance. Values: true: yes. false: no.
    BinlogBackupEnabled bool
    Enable log backup feature. Values: true: yes. false: no.
    BinlogBackupEncryptionEnabled bool
    Whether to enable encryption for log backups. Values: true: Yes. false: No.
    BinlogFileCountsEnable bool
    Enable local Binlog retention limit. Values: true: enabled. false: disabled.
    BinlogLimitCount int
    Number of local Binlog files to retain, values range from 6 to 1000. Files exceeding the retention count are automatically deleted.
    BinlogLocalRetentionHour int
    Local Binlog retention period. Value: 0–168. Unit: hours. Local logs exceeding the retention period are automatically deleted. When set to 0, local logs are not deleted automatically.
    BinlogSpaceLimitEnable bool
    Enable automatic Binlog cleanup when storage is excessive. When total instance storage usage exceeds 80% or available space is less than 5 GiB, the system automatically deletes the oldest local Binlog files until usage drops below 80% and available space exceeds 5 GiB. true: enabled. false: disabled.
    BinlogStoragePercentage int
    Maximum storage space usage. Can be set to 20%–50%. When exceeded, the earliest Binlog files are automatically deleted until usage falls below this threshold. Note: Local Binlog space usage = local Binlog size / total available (purchased) instance space.
    DataBackupAllRetention bool
    Retain all data backups before releasing the instance. Values: true: yes. false: no.
    DataBackupEncryptionEnabled bool
    Enable encryption for data backups of local disk instances. Values: true: yes. false: no. Note: This feature is not supported for cloud disk instances.
    DataBackupRetentionDay int
    Number of days to retain data backups. Valid values: 7–3650 days. Default: 7 days.
    DataFullBackupPeriods List<string>
    Full backup cycle. Values: Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.
    DataFullBackupStartUtcHour int
    Start time of the full backup task time window (UTC). The time window is 1 hour. Note: Both DataFullBackupStartUTCHour and DataFullBackupTime can be used to specify the full backup time period for the instance. DataFullBackupStartUTCHour has higher priority. If both fields are returned, DataFullBackupStartUTCHour takes precedence.
    DataFullBackupTime string
    Time window for executing backup tasks, with a duration of 1 hour. Format: HH:mmZ-HH:mmZ (UTC). Note: Both DataFullBackupStartUTCHour and DataFullBackupTime can be used to specify the full backup time period for the instance. DataFullBackupStartUTCHour has higher priority. If both fields are returned, DataFullBackupStartUTCHour takes precedence.
    DataIncrBackupPeriods List<string>
    Incremental backup cycle for local disk instances. Values: Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday. Note: When high-frequency incremental backup is enabled (that is, when HourlyIncrBackupEnable is set to true), this field is not returned.
    DataKeepDaysAfterReleased int
    Number of days to retain data after instance release.
    DataKeepPolicyAfterReleased string
    Policy for retaining instance backups after the instance is released. Values: Last: retain the last backup (default). All: retain all backups of the instance.
    HighFrequencySnapshotBackupEnable bool
    Whether high-frequency incremental snapshot backup is enabled for cloud disk instances. Values: true: Yes. false: No. Note: For local disk instances, this field returns false.
    HighFrequencySnapshotBackupSecondPeriod int
    Frequency of high-frequency incremental snapshot backups for cloud disk instances, in seconds. Values: 3600: every 1 hour. 7200: every 2 hours. 10800: every 3 hours. 14400: every 4 hours. 19200: every 6 hours. 28800: every 8 hours. 38400: every 12 hours. Note: If the instance is a local disk instance or the high-frequency incremental snapshot backup feature for the cloud disk instance is not enabled, this field returns 0.
    HourlyIncrBackupEnable bool
    Whether to enable high-frequency backup for local disk instances. Values: true: Yes. false: No.
    IncrBackupHourPeriod int
    Frequency of high-frequency incremental backups for local disk instances. Values: 0: no high-frequency incremental backup. In this case, HourlyIncrBackupEnable is false. 2: incremental backup every 2 hours. 4: incremental backup every 4 hours. 6: incremental backup every 6 hours. 12: incremental backup every 12 hours.
    KeepCrossBackupEnableAfterReleased bool
    Whether to retain cross-region backups. Values: true: Yes. false: No. Note: This feature is not supported for cloud disk instances.
    LockDdlTime int
    Maximum DDL wait time. Default value is 30, minimum is 10, maximum is 1440, in minutes.
    LockDdlTimeSecond int
    Maximum DDL wait time. Default value: 1800. Minimum: 1. Maximum: 86400. Unit: seconds. Note: The backup process will block DDL. If the blocking time exceeds the specified value, the backup will stop automatically. Only MySQL 8.0 instances support this setting.
    LogBackupRetentionDay int
    Binlog backup retention period. Value range: 7–3650 days. Default retention is 7 days. Note: This parameter is not returned when RetentionPolicySynced is set to true.
    PublicDownloadEnable bool
    Whether to allow downloading instance backup data from a public network environment. Values: true: Yes. false: No.
    RetentionPolicySynced bool
    Whether the retention policy for log backups is the same as that for data backups. Values: true: Yes. false: No.
    BinlogBackupAllRetention bool
    Retain all log backups before releasing the instance. Values: true: yes. false: no.
    BinlogBackupEnabled bool
    Enable log backup feature. Values: true: yes. false: no.
    BinlogBackupEncryptionEnabled bool
    Whether to enable encryption for log backups. Values: true: Yes. false: No.
    BinlogFileCountsEnable bool
    Enable local Binlog retention limit. Values: true: enabled. false: disabled.
    BinlogLimitCount int
    Number of local Binlog files to retain, values range from 6 to 1000. Files exceeding the retention count are automatically deleted.
    BinlogLocalRetentionHour int
    Local Binlog retention period. Value: 0–168. Unit: hours. Local logs exceeding the retention period are automatically deleted. When set to 0, local logs are not deleted automatically.
    BinlogSpaceLimitEnable bool
    Enable automatic Binlog cleanup when storage is excessive. When total instance storage usage exceeds 80% or available space is less than 5 GiB, the system automatically deletes the oldest local Binlog files until usage drops below 80% and available space exceeds 5 GiB. true: enabled. false: disabled.
    BinlogStoragePercentage int
    Maximum storage space usage. Can be set to 20%–50%. When exceeded, the earliest Binlog files are automatically deleted until usage falls below this threshold. Note: Local Binlog space usage = local Binlog size / total available (purchased) instance space.
    DataBackupAllRetention bool
    Retain all data backups before releasing the instance. Values: true: yes. false: no.
    DataBackupEncryptionEnabled bool
    Enable encryption for data backups of local disk instances. Values: true: yes. false: no. Note: This feature is not supported for cloud disk instances.
    DataBackupRetentionDay int
    Number of days to retain data backups. Valid values: 7–3650 days. Default: 7 days.
    DataFullBackupPeriods []string
    Full backup cycle. Values: Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.
    DataFullBackupStartUtcHour int
    Start time of the full backup task time window (UTC). The time window is 1 hour. Note: Both DataFullBackupStartUTCHour and DataFullBackupTime can be used to specify the full backup time period for the instance. DataFullBackupStartUTCHour has higher priority. If both fields are returned, DataFullBackupStartUTCHour takes precedence.
    DataFullBackupTime string
    Time window for executing backup tasks, with a duration of 1 hour. Format: HH:mmZ-HH:mmZ (UTC). Note: Both DataFullBackupStartUTCHour and DataFullBackupTime can be used to specify the full backup time period for the instance. DataFullBackupStartUTCHour has higher priority. If both fields are returned, DataFullBackupStartUTCHour takes precedence.
    DataIncrBackupPeriods []string
    Incremental backup cycle for local disk instances. Values: Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday. Note: When high-frequency incremental backup is enabled (that is, when HourlyIncrBackupEnable is set to true), this field is not returned.
    DataKeepDaysAfterReleased int
    Number of days to retain data after instance release.
    DataKeepPolicyAfterReleased string
    Policy for retaining instance backups after the instance is released. Values: Last: retain the last backup (default). All: retain all backups of the instance.
    HighFrequencySnapshotBackupEnable bool
    Whether high-frequency incremental snapshot backup is enabled for cloud disk instances. Values: true: Yes. false: No. Note: For local disk instances, this field returns false.
    HighFrequencySnapshotBackupSecondPeriod int
    Frequency of high-frequency incremental snapshot backups for cloud disk instances, in seconds. Values: 3600: every 1 hour. 7200: every 2 hours. 10800: every 3 hours. 14400: every 4 hours. 19200: every 6 hours. 28800: every 8 hours. 38400: every 12 hours. Note: If the instance is a local disk instance or the high-frequency incremental snapshot backup feature for the cloud disk instance is not enabled, this field returns 0.
    HourlyIncrBackupEnable bool
    Whether to enable high-frequency backup for local disk instances. Values: true: Yes. false: No.
    IncrBackupHourPeriod int
    Frequency of high-frequency incremental backups for local disk instances. Values: 0: no high-frequency incremental backup. In this case, HourlyIncrBackupEnable is false. 2: incremental backup every 2 hours. 4: incremental backup every 4 hours. 6: incremental backup every 6 hours. 12: incremental backup every 12 hours.
    KeepCrossBackupEnableAfterReleased bool
    Whether to retain cross-region backups. Values: true: Yes. false: No. Note: This feature is not supported for cloud disk instances.
    LockDdlTime int
    Maximum DDL wait time. Default value is 30, minimum is 10, maximum is 1440, in minutes.
    LockDdlTimeSecond int
    Maximum DDL wait time. Default value: 1800. Minimum: 1. Maximum: 86400. Unit: seconds. Note: The backup process will block DDL. If the blocking time exceeds the specified value, the backup will stop automatically. Only MySQL 8.0 instances support this setting.
    LogBackupRetentionDay int
    Binlog backup retention period. Value range: 7–3650 days. Default retention is 7 days. Note: This parameter is not returned when RetentionPolicySynced is set to true.
    PublicDownloadEnable bool
    Whether to allow downloading instance backup data from a public network environment. Values: true: Yes. false: No.
    RetentionPolicySynced bool
    Whether the retention policy for log backups is the same as that for data backups. Values: true: Yes. false: No.
    binlog_backup_all_retention bool
    Retain all log backups before releasing the instance. Values: true: yes. false: no.
    binlog_backup_enabled bool
    Enable log backup feature. Values: true: yes. false: no.
    binlog_backup_encryption_enabled bool
    Whether to enable encryption for log backups. Values: true: Yes. false: No.
    binlog_file_counts_enable bool
    Enable local Binlog retention limit. Values: true: enabled. false: disabled.
    binlog_limit_count number
    Number of local Binlog files to retain, values range from 6 to 1000. Files exceeding the retention count are automatically deleted.
    binlog_local_retention_hour number
    Local Binlog retention period. Value: 0–168. Unit: hours. Local logs exceeding the retention period are automatically deleted. When set to 0, local logs are not deleted automatically.
    binlog_space_limit_enable bool
    Enable automatic Binlog cleanup when storage is excessive. When total instance storage usage exceeds 80% or available space is less than 5 GiB, the system automatically deletes the oldest local Binlog files until usage drops below 80% and available space exceeds 5 GiB. true: enabled. false: disabled.
    binlog_storage_percentage number
    Maximum storage space usage. Can be set to 20%–50%. When exceeded, the earliest Binlog files are automatically deleted until usage falls below this threshold. Note: Local Binlog space usage = local Binlog size / total available (purchased) instance space.
    data_backup_all_retention bool
    Retain all data backups before releasing the instance. Values: true: yes. false: no.
    data_backup_encryption_enabled bool
    Enable encryption for data backups of local disk instances. Values: true: yes. false: no. Note: This feature is not supported for cloud disk instances.
    data_backup_retention_day number
    Number of days to retain data backups. Valid values: 7–3650 days. Default: 7 days.
    data_full_backup_periods list(string)
    Full backup cycle. Values: Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.
    data_full_backup_start_utc_hour number
    Start time of the full backup task time window (UTC). The time window is 1 hour. Note: Both DataFullBackupStartUTCHour and DataFullBackupTime can be used to specify the full backup time period for the instance. DataFullBackupStartUTCHour has higher priority. If both fields are returned, DataFullBackupStartUTCHour takes precedence.
    data_full_backup_time string
    Time window for executing backup tasks, with a duration of 1 hour. Format: HH:mmZ-HH:mmZ (UTC). Note: Both DataFullBackupStartUTCHour and DataFullBackupTime can be used to specify the full backup time period for the instance. DataFullBackupStartUTCHour has higher priority. If both fields are returned, DataFullBackupStartUTCHour takes precedence.
    data_incr_backup_periods list(string)
    Incremental backup cycle for local disk instances. Values: Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday. Note: When high-frequency incremental backup is enabled (that is, when HourlyIncrBackupEnable is set to true), this field is not returned.
    data_keep_days_after_released number
    Number of days to retain data after instance release.
    data_keep_policy_after_released string
    Policy for retaining instance backups after the instance is released. Values: Last: retain the last backup (default). All: retain all backups of the instance.
    high_frequency_snapshot_backup_enable bool
    Whether high-frequency incremental snapshot backup is enabled for cloud disk instances. Values: true: Yes. false: No. Note: For local disk instances, this field returns false.
    high_frequency_snapshot_backup_second_period number
    Frequency of high-frequency incremental snapshot backups for cloud disk instances, in seconds. Values: 3600: every 1 hour. 7200: every 2 hours. 10800: every 3 hours. 14400: every 4 hours. 19200: every 6 hours. 28800: every 8 hours. 38400: every 12 hours. Note: If the instance is a local disk instance or the high-frequency incremental snapshot backup feature for the cloud disk instance is not enabled, this field returns 0.
    hourly_incr_backup_enable bool
    Whether to enable high-frequency backup for local disk instances. Values: true: Yes. false: No.
    incr_backup_hour_period number
    Frequency of high-frequency incremental backups for local disk instances. Values: 0: no high-frequency incremental backup. In this case, HourlyIncrBackupEnable is false. 2: incremental backup every 2 hours. 4: incremental backup every 4 hours. 6: incremental backup every 6 hours. 12: incremental backup every 12 hours.
    keep_cross_backup_enable_after_released bool
    Whether to retain cross-region backups. Values: true: Yes. false: No. Note: This feature is not supported for cloud disk instances.
    lock_ddl_time number
    Maximum DDL wait time. Default value is 30, minimum is 10, maximum is 1440, in minutes.
    lock_ddl_time_second number
    Maximum DDL wait time. Default value: 1800. Minimum: 1. Maximum: 86400. Unit: seconds. Note: The backup process will block DDL. If the blocking time exceeds the specified value, the backup will stop automatically. Only MySQL 8.0 instances support this setting.
    log_backup_retention_day number
    Binlog backup retention period. Value range: 7–3650 days. Default retention is 7 days. Note: This parameter is not returned when RetentionPolicySynced is set to true.
    public_download_enable bool
    Whether to allow downloading instance backup data from a public network environment. Values: true: Yes. false: No.
    retention_policy_synced bool
    Whether the retention policy for log backups is the same as that for data backups. Values: true: Yes. false: No.
    binlogBackupAllRetention Boolean
    Retain all log backups before releasing the instance. Values: true: yes. false: no.
    binlogBackupEnabled Boolean
    Enable log backup feature. Values: true: yes. false: no.
    binlogBackupEncryptionEnabled Boolean
    Whether to enable encryption for log backups. Values: true: Yes. false: No.
    binlogFileCountsEnable Boolean
    Enable local Binlog retention limit. Values: true: enabled. false: disabled.
    binlogLimitCount Integer
    Number of local Binlog files to retain, values range from 6 to 1000. Files exceeding the retention count are automatically deleted.
    binlogLocalRetentionHour Integer
    Local Binlog retention period. Value: 0–168. Unit: hours. Local logs exceeding the retention period are automatically deleted. When set to 0, local logs are not deleted automatically.
    binlogSpaceLimitEnable Boolean
    Enable automatic Binlog cleanup when storage is excessive. When total instance storage usage exceeds 80% or available space is less than 5 GiB, the system automatically deletes the oldest local Binlog files until usage drops below 80% and available space exceeds 5 GiB. true: enabled. false: disabled.
    binlogStoragePercentage Integer
    Maximum storage space usage. Can be set to 20%–50%. When exceeded, the earliest Binlog files are automatically deleted until usage falls below this threshold. Note: Local Binlog space usage = local Binlog size / total available (purchased) instance space.
    dataBackupAllRetention Boolean
    Retain all data backups before releasing the instance. Values: true: yes. false: no.
    dataBackupEncryptionEnabled Boolean
    Enable encryption for data backups of local disk instances. Values: true: yes. false: no. Note: This feature is not supported for cloud disk instances.
    dataBackupRetentionDay Integer
    Number of days to retain data backups. Valid values: 7–3650 days. Default: 7 days.
    dataFullBackupPeriods List<String>
    Full backup cycle. Values: Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.
    dataFullBackupStartUtcHour Integer
    Start time of the full backup task time window (UTC). The time window is 1 hour. Note: Both DataFullBackupStartUTCHour and DataFullBackupTime can be used to specify the full backup time period for the instance. DataFullBackupStartUTCHour has higher priority. If both fields are returned, DataFullBackupStartUTCHour takes precedence.
    dataFullBackupTime String
    Time window for executing backup tasks, with a duration of 1 hour. Format: HH:mmZ-HH:mmZ (UTC). Note: Both DataFullBackupStartUTCHour and DataFullBackupTime can be used to specify the full backup time period for the instance. DataFullBackupStartUTCHour has higher priority. If both fields are returned, DataFullBackupStartUTCHour takes precedence.
    dataIncrBackupPeriods List<String>
    Incremental backup cycle for local disk instances. Values: Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday. Note: When high-frequency incremental backup is enabled (that is, when HourlyIncrBackupEnable is set to true), this field is not returned.
    dataKeepDaysAfterReleased Integer
    Number of days to retain data after instance release.
    dataKeepPolicyAfterReleased String
    Policy for retaining instance backups after the instance is released. Values: Last: retain the last backup (default). All: retain all backups of the instance.
    highFrequencySnapshotBackupEnable Boolean
    Whether high-frequency incremental snapshot backup is enabled for cloud disk instances. Values: true: Yes. false: No. Note: For local disk instances, this field returns false.
    highFrequencySnapshotBackupSecondPeriod Integer
    Frequency of high-frequency incremental snapshot backups for cloud disk instances, in seconds. Values: 3600: every 1 hour. 7200: every 2 hours. 10800: every 3 hours. 14400: every 4 hours. 19200: every 6 hours. 28800: every 8 hours. 38400: every 12 hours. Note: If the instance is a local disk instance or the high-frequency incremental snapshot backup feature for the cloud disk instance is not enabled, this field returns 0.
    hourlyIncrBackupEnable Boolean
    Whether to enable high-frequency backup for local disk instances. Values: true: Yes. false: No.
    incrBackupHourPeriod Integer
    Frequency of high-frequency incremental backups for local disk instances. Values: 0: no high-frequency incremental backup. In this case, HourlyIncrBackupEnable is false. 2: incremental backup every 2 hours. 4: incremental backup every 4 hours. 6: incremental backup every 6 hours. 12: incremental backup every 12 hours.
    keepCrossBackupEnableAfterReleased Boolean
    Whether to retain cross-region backups. Values: true: Yes. false: No. Note: This feature is not supported for cloud disk instances.
    lockDdlTime Integer
    Maximum DDL wait time. Default value is 30, minimum is 10, maximum is 1440, in minutes.
    lockDdlTimeSecond Integer
    Maximum DDL wait time. Default value: 1800. Minimum: 1. Maximum: 86400. Unit: seconds. Note: The backup process will block DDL. If the blocking time exceeds the specified value, the backup will stop automatically. Only MySQL 8.0 instances support this setting.
    logBackupRetentionDay Integer
    Binlog backup retention period. Value range: 7–3650 days. Default retention is 7 days. Note: This parameter is not returned when RetentionPolicySynced is set to true.
    publicDownloadEnable Boolean
    Whether to allow downloading instance backup data from a public network environment. Values: true: Yes. false: No.
    retentionPolicySynced Boolean
    Whether the retention policy for log backups is the same as that for data backups. Values: true: Yes. false: No.
    binlogBackupAllRetention boolean
    Retain all log backups before releasing the instance. Values: true: yes. false: no.
    binlogBackupEnabled boolean
    Enable log backup feature. Values: true: yes. false: no.
    binlogBackupEncryptionEnabled boolean
    Whether to enable encryption for log backups. Values: true: Yes. false: No.
    binlogFileCountsEnable boolean
    Enable local Binlog retention limit. Values: true: enabled. false: disabled.
    binlogLimitCount number
    Number of local Binlog files to retain, values range from 6 to 1000. Files exceeding the retention count are automatically deleted.
    binlogLocalRetentionHour number
    Local Binlog retention period. Value: 0–168. Unit: hours. Local logs exceeding the retention period are automatically deleted. When set to 0, local logs are not deleted automatically.
    binlogSpaceLimitEnable boolean
    Enable automatic Binlog cleanup when storage is excessive. When total instance storage usage exceeds 80% or available space is less than 5 GiB, the system automatically deletes the oldest local Binlog files until usage drops below 80% and available space exceeds 5 GiB. true: enabled. false: disabled.
    binlogStoragePercentage number
    Maximum storage space usage. Can be set to 20%–50%. When exceeded, the earliest Binlog files are automatically deleted until usage falls below this threshold. Note: Local Binlog space usage = local Binlog size / total available (purchased) instance space.
    dataBackupAllRetention boolean
    Retain all data backups before releasing the instance. Values: true: yes. false: no.
    dataBackupEncryptionEnabled boolean
    Enable encryption for data backups of local disk instances. Values: true: yes. false: no. Note: This feature is not supported for cloud disk instances.
    dataBackupRetentionDay number
    Number of days to retain data backups. Valid values: 7–3650 days. Default: 7 days.
    dataFullBackupPeriods string[]
    Full backup cycle. Values: Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.
    dataFullBackupStartUtcHour number
    Start time of the full backup task time window (UTC). The time window is 1 hour. Note: Both DataFullBackupStartUTCHour and DataFullBackupTime can be used to specify the full backup time period for the instance. DataFullBackupStartUTCHour has higher priority. If both fields are returned, DataFullBackupStartUTCHour takes precedence.
    dataFullBackupTime string
    Time window for executing backup tasks, with a duration of 1 hour. Format: HH:mmZ-HH:mmZ (UTC). Note: Both DataFullBackupStartUTCHour and DataFullBackupTime can be used to specify the full backup time period for the instance. DataFullBackupStartUTCHour has higher priority. If both fields are returned, DataFullBackupStartUTCHour takes precedence.
    dataIncrBackupPeriods string[]
    Incremental backup cycle for local disk instances. Values: Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday. Note: When high-frequency incremental backup is enabled (that is, when HourlyIncrBackupEnable is set to true), this field is not returned.
    dataKeepDaysAfterReleased number
    Number of days to retain data after instance release.
    dataKeepPolicyAfterReleased string
    Policy for retaining instance backups after the instance is released. Values: Last: retain the last backup (default). All: retain all backups of the instance.
    highFrequencySnapshotBackupEnable boolean
    Whether high-frequency incremental snapshot backup is enabled for cloud disk instances. Values: true: Yes. false: No. Note: For local disk instances, this field returns false.
    highFrequencySnapshotBackupSecondPeriod number
    Frequency of high-frequency incremental snapshot backups for cloud disk instances, in seconds. Values: 3600: every 1 hour. 7200: every 2 hours. 10800: every 3 hours. 14400: every 4 hours. 19200: every 6 hours. 28800: every 8 hours. 38400: every 12 hours. Note: If the instance is a local disk instance or the high-frequency incremental snapshot backup feature for the cloud disk instance is not enabled, this field returns 0.
    hourlyIncrBackupEnable boolean
    Whether to enable high-frequency backup for local disk instances. Values: true: Yes. false: No.
    incrBackupHourPeriod number
    Frequency of high-frequency incremental backups for local disk instances. Values: 0: no high-frequency incremental backup. In this case, HourlyIncrBackupEnable is false. 2: incremental backup every 2 hours. 4: incremental backup every 4 hours. 6: incremental backup every 6 hours. 12: incremental backup every 12 hours.
    keepCrossBackupEnableAfterReleased boolean
    Whether to retain cross-region backups. Values: true: Yes. false: No. Note: This feature is not supported for cloud disk instances.
    lockDdlTime number
    Maximum DDL wait time. Default value is 30, minimum is 10, maximum is 1440, in minutes.
    lockDdlTimeSecond number
    Maximum DDL wait time. Default value: 1800. Minimum: 1. Maximum: 86400. Unit: seconds. Note: The backup process will block DDL. If the blocking time exceeds the specified value, the backup will stop automatically. Only MySQL 8.0 instances support this setting.
    logBackupRetentionDay number
    Binlog backup retention period. Value range: 7–3650 days. Default retention is 7 days. Note: This parameter is not returned when RetentionPolicySynced is set to true.
    publicDownloadEnable boolean
    Whether to allow downloading instance backup data from a public network environment. Values: true: Yes. false: No.
    retentionPolicySynced boolean
    Whether the retention policy for log backups is the same as that for data backups. Values: true: Yes. false: No.
    binlog_backup_all_retention bool
    Retain all log backups before releasing the instance. Values: true: yes. false: no.
    binlog_backup_enabled bool
    Enable log backup feature. Values: true: yes. false: no.
    binlog_backup_encryption_enabled bool
    Whether to enable encryption for log backups. Values: true: Yes. false: No.
    binlog_file_counts_enable bool
    Enable local Binlog retention limit. Values: true: enabled. false: disabled.
    binlog_limit_count int
    Number of local Binlog files to retain, values range from 6 to 1000. Files exceeding the retention count are automatically deleted.
    binlog_local_retention_hour int
    Local Binlog retention period. Value: 0–168. Unit: hours. Local logs exceeding the retention period are automatically deleted. When set to 0, local logs are not deleted automatically.
    binlog_space_limit_enable bool
    Enable automatic Binlog cleanup when storage is excessive. When total instance storage usage exceeds 80% or available space is less than 5 GiB, the system automatically deletes the oldest local Binlog files until usage drops below 80% and available space exceeds 5 GiB. true: enabled. false: disabled.
    binlog_storage_percentage int
    Maximum storage space usage. Can be set to 20%–50%. When exceeded, the earliest Binlog files are automatically deleted until usage falls below this threshold. Note: Local Binlog space usage = local Binlog size / total available (purchased) instance space.
    data_backup_all_retention bool
    Retain all data backups before releasing the instance. Values: true: yes. false: no.
    data_backup_encryption_enabled bool
    Enable encryption for data backups of local disk instances. Values: true: yes. false: no. Note: This feature is not supported for cloud disk instances.
    data_backup_retention_day int
    Number of days to retain data backups. Valid values: 7–3650 days. Default: 7 days.
    data_full_backup_periods Sequence[str]
    Full backup cycle. Values: Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.
    data_full_backup_start_utc_hour int
    Start time of the full backup task time window (UTC). The time window is 1 hour. Note: Both DataFullBackupStartUTCHour and DataFullBackupTime can be used to specify the full backup time period for the instance. DataFullBackupStartUTCHour has higher priority. If both fields are returned, DataFullBackupStartUTCHour takes precedence.
    data_full_backup_time str
    Time window for executing backup tasks, with a duration of 1 hour. Format: HH:mmZ-HH:mmZ (UTC). Note: Both DataFullBackupStartUTCHour and DataFullBackupTime can be used to specify the full backup time period for the instance. DataFullBackupStartUTCHour has higher priority. If both fields are returned, DataFullBackupStartUTCHour takes precedence.
    data_incr_backup_periods Sequence[str]
    Incremental backup cycle for local disk instances. Values: Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday. Note: When high-frequency incremental backup is enabled (that is, when HourlyIncrBackupEnable is set to true), this field is not returned.
    data_keep_days_after_released int
    Number of days to retain data after instance release.
    data_keep_policy_after_released str
    Policy for retaining instance backups after the instance is released. Values: Last: retain the last backup (default). All: retain all backups of the instance.
    high_frequency_snapshot_backup_enable bool
    Whether high-frequency incremental snapshot backup is enabled for cloud disk instances. Values: true: Yes. false: No. Note: For local disk instances, this field returns false.
    high_frequency_snapshot_backup_second_period int
    Frequency of high-frequency incremental snapshot backups for cloud disk instances, in seconds. Values: 3600: every 1 hour. 7200: every 2 hours. 10800: every 3 hours. 14400: every 4 hours. 19200: every 6 hours. 28800: every 8 hours. 38400: every 12 hours. Note: If the instance is a local disk instance or the high-frequency incremental snapshot backup feature for the cloud disk instance is not enabled, this field returns 0.
    hourly_incr_backup_enable bool
    Whether to enable high-frequency backup for local disk instances. Values: true: Yes. false: No.
    incr_backup_hour_period int
    Frequency of high-frequency incremental backups for local disk instances. Values: 0: no high-frequency incremental backup. In this case, HourlyIncrBackupEnable is false. 2: incremental backup every 2 hours. 4: incremental backup every 4 hours. 6: incremental backup every 6 hours. 12: incremental backup every 12 hours.
    keep_cross_backup_enable_after_released bool
    Whether to retain cross-region backups. Values: true: Yes. false: No. Note: This feature is not supported for cloud disk instances.
    lock_ddl_time int
    Maximum DDL wait time. Default value is 30, minimum is 10, maximum is 1440, in minutes.
    lock_ddl_time_second int
    Maximum DDL wait time. Default value: 1800. Minimum: 1. Maximum: 86400. Unit: seconds. Note: The backup process will block DDL. If the blocking time exceeds the specified value, the backup will stop automatically. Only MySQL 8.0 instances support this setting.
    log_backup_retention_day int
    Binlog backup retention period. Value range: 7–3650 days. Default retention is 7 days. Note: This parameter is not returned when RetentionPolicySynced is set to true.
    public_download_enable bool
    Whether to allow downloading instance backup data from a public network environment. Values: true: Yes. false: No.
    retention_policy_synced bool
    Whether the retention policy for log backups is the same as that for data backups. Values: true: Yes. false: No.
    binlogBackupAllRetention Boolean
    Retain all log backups before releasing the instance. Values: true: yes. false: no.
    binlogBackupEnabled Boolean
    Enable log backup feature. Values: true: yes. false: no.
    binlogBackupEncryptionEnabled Boolean
    Whether to enable encryption for log backups. Values: true: Yes. false: No.
    binlogFileCountsEnable Boolean
    Enable local Binlog retention limit. Values: true: enabled. false: disabled.
    binlogLimitCount Number
    Number of local Binlog files to retain, values range from 6 to 1000. Files exceeding the retention count are automatically deleted.
    binlogLocalRetentionHour Number
    Local Binlog retention period. Value: 0–168. Unit: hours. Local logs exceeding the retention period are automatically deleted. When set to 0, local logs are not deleted automatically.
    binlogSpaceLimitEnable Boolean
    Enable automatic Binlog cleanup when storage is excessive. When total instance storage usage exceeds 80% or available space is less than 5 GiB, the system automatically deletes the oldest local Binlog files until usage drops below 80% and available space exceeds 5 GiB. true: enabled. false: disabled.
    binlogStoragePercentage Number
    Maximum storage space usage. Can be set to 20%–50%. When exceeded, the earliest Binlog files are automatically deleted until usage falls below this threshold. Note: Local Binlog space usage = local Binlog size / total available (purchased) instance space.
    dataBackupAllRetention Boolean
    Retain all data backups before releasing the instance. Values: true: yes. false: no.
    dataBackupEncryptionEnabled Boolean
    Enable encryption for data backups of local disk instances. Values: true: yes. false: no. Note: This feature is not supported for cloud disk instances.
    dataBackupRetentionDay Number
    Number of days to retain data backups. Valid values: 7–3650 days. Default: 7 days.
    dataFullBackupPeriods List<String>
    Full backup cycle. Values: Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.
    dataFullBackupStartUtcHour Number
    Start time of the full backup task time window (UTC). The time window is 1 hour. Note: Both DataFullBackupStartUTCHour and DataFullBackupTime can be used to specify the full backup time period for the instance. DataFullBackupStartUTCHour has higher priority. If both fields are returned, DataFullBackupStartUTCHour takes precedence.
    dataFullBackupTime String
    Time window for executing backup tasks, with a duration of 1 hour. Format: HH:mmZ-HH:mmZ (UTC). Note: Both DataFullBackupStartUTCHour and DataFullBackupTime can be used to specify the full backup time period for the instance. DataFullBackupStartUTCHour has higher priority. If both fields are returned, DataFullBackupStartUTCHour takes precedence.
    dataIncrBackupPeriods List<String>
    Incremental backup cycle for local disk instances. Values: Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday. Note: When high-frequency incremental backup is enabled (that is, when HourlyIncrBackupEnable is set to true), this field is not returned.
    dataKeepDaysAfterReleased Number
    Number of days to retain data after instance release.
    dataKeepPolicyAfterReleased String
    Policy for retaining instance backups after the instance is released. Values: Last: retain the last backup (default). All: retain all backups of the instance.
    highFrequencySnapshotBackupEnable Boolean
    Whether high-frequency incremental snapshot backup is enabled for cloud disk instances. Values: true: Yes. false: No. Note: For local disk instances, this field returns false.
    highFrequencySnapshotBackupSecondPeriod Number
    Frequency of high-frequency incremental snapshot backups for cloud disk instances, in seconds. Values: 3600: every 1 hour. 7200: every 2 hours. 10800: every 3 hours. 14400: every 4 hours. 19200: every 6 hours. 28800: every 8 hours. 38400: every 12 hours. Note: If the instance is a local disk instance or the high-frequency incremental snapshot backup feature for the cloud disk instance is not enabled, this field returns 0.
    hourlyIncrBackupEnable Boolean
    Whether to enable high-frequency backup for local disk instances. Values: true: Yes. false: No.
    incrBackupHourPeriod Number
    Frequency of high-frequency incremental backups for local disk instances. Values: 0: no high-frequency incremental backup. In this case, HourlyIncrBackupEnable is false. 2: incremental backup every 2 hours. 4: incremental backup every 4 hours. 6: incremental backup every 6 hours. 12: incremental backup every 12 hours.
    keepCrossBackupEnableAfterReleased Boolean
    Whether to retain cross-region backups. Values: true: Yes. false: No. Note: This feature is not supported for cloud disk instances.
    lockDdlTime Number
    Maximum DDL wait time. Default value is 30, minimum is 10, maximum is 1440, in minutes.
    lockDdlTimeSecond Number
    Maximum DDL wait time. Default value: 1800. Minimum: 1. Maximum: 86400. Unit: seconds. Note: The backup process will block DDL. If the blocking time exceeds the specified value, the backup will stop automatically. Only MySQL 8.0 instances support this setting.
    logBackupRetentionDay Number
    Binlog backup retention period. Value range: 7–3650 days. Default retention is 7 days. Note: This parameter is not returned when RetentionPolicySynced is set to true.
    publicDownloadEnable Boolean
    Whether to allow downloading instance backup data from a public network environment. Values: true: Yes. false: No.
    retentionPolicySynced Boolean
    Whether the retention policy for log backups is the same as that for data backups. Values: true: Yes. false: No.

    InstanceBackupPolicyCrossBackupPolicy, InstanceBackupPolicyCrossBackupPolicyArgs

    BackupEnabled bool
    Enable cross-region backup. true: enabled. false: disabled. Default value (unspecified).
    CrossBackupAllRetention bool
    Retain cross-region backups long-term before instance release. Values: true: yes. false: no.
    CrossBackupRegion string
    Destination region ID for cross-region backups. This parameter is required when BackupEnabled is true.
    LogBackupEnabled bool
    Whether to enable cross-region log backup. true: Enable. false: Disable (default). Note: Cross-region log backup can only be enabled when cross-region backup is enabled.
    Retention int
    Cross-region backup retention days. Value range: 7–3650. Default: 7. Unit: days. Note: When CrossBackupAllRetention is set to true, this field does not need to be set.
    BackupEnabled bool
    Enable cross-region backup. true: enabled. false: disabled. Default value (unspecified).
    CrossBackupAllRetention bool
    Retain cross-region backups long-term before instance release. Values: true: yes. false: no.
    CrossBackupRegion string
    Destination region ID for cross-region backups. This parameter is required when BackupEnabled is true.
    LogBackupEnabled bool
    Whether to enable cross-region log backup. true: Enable. false: Disable (default). Note: Cross-region log backup can only be enabled when cross-region backup is enabled.
    Retention int
    Cross-region backup retention days. Value range: 7–3650. Default: 7. Unit: days. Note: When CrossBackupAllRetention is set to true, this field does not need to be set.
    backup_enabled bool
    Enable cross-region backup. true: enabled. false: disabled. Default value (unspecified).
    cross_backup_all_retention bool
    Retain cross-region backups long-term before instance release. Values: true: yes. false: no.
    cross_backup_region string
    Destination region ID for cross-region backups. This parameter is required when BackupEnabled is true.
    log_backup_enabled bool
    Whether to enable cross-region log backup. true: Enable. false: Disable (default). Note: Cross-region log backup can only be enabled when cross-region backup is enabled.
    retention number
    Cross-region backup retention days. Value range: 7–3650. Default: 7. Unit: days. Note: When CrossBackupAllRetention is set to true, this field does not need to be set.
    backupEnabled Boolean
    Enable cross-region backup. true: enabled. false: disabled. Default value (unspecified).
    crossBackupAllRetention Boolean
    Retain cross-region backups long-term before instance release. Values: true: yes. false: no.
    crossBackupRegion String
    Destination region ID for cross-region backups. This parameter is required when BackupEnabled is true.
    logBackupEnabled Boolean
    Whether to enable cross-region log backup. true: Enable. false: Disable (default). Note: Cross-region log backup can only be enabled when cross-region backup is enabled.
    retention Integer
    Cross-region backup retention days. Value range: 7–3650. Default: 7. Unit: days. Note: When CrossBackupAllRetention is set to true, this field does not need to be set.
    backupEnabled boolean
    Enable cross-region backup. true: enabled. false: disabled. Default value (unspecified).
    crossBackupAllRetention boolean
    Retain cross-region backups long-term before instance release. Values: true: yes. false: no.
    crossBackupRegion string
    Destination region ID for cross-region backups. This parameter is required when BackupEnabled is true.
    logBackupEnabled boolean
    Whether to enable cross-region log backup. true: Enable. false: Disable (default). Note: Cross-region log backup can only be enabled when cross-region backup is enabled.
    retention number
    Cross-region backup retention days. Value range: 7–3650. Default: 7. Unit: days. Note: When CrossBackupAllRetention is set to true, this field does not need to be set.
    backup_enabled bool
    Enable cross-region backup. true: enabled. false: disabled. Default value (unspecified).
    cross_backup_all_retention bool
    Retain cross-region backups long-term before instance release. Values: true: yes. false: no.
    cross_backup_region str
    Destination region ID for cross-region backups. This parameter is required when BackupEnabled is true.
    log_backup_enabled bool
    Whether to enable cross-region log backup. true: Enable. false: Disable (default). Note: Cross-region log backup can only be enabled when cross-region backup is enabled.
    retention int
    Cross-region backup retention days. Value range: 7–3650. Default: 7. Unit: days. Note: When CrossBackupAllRetention is set to true, this field does not need to be set.
    backupEnabled Boolean
    Enable cross-region backup. true: enabled. false: disabled. Default value (unspecified).
    crossBackupAllRetention Boolean
    Retain cross-region backups long-term before instance release. Values: true: yes. false: no.
    crossBackupRegion String
    Destination region ID for cross-region backups. This parameter is required when BackupEnabled is true.
    logBackupEnabled Boolean
    Whether to enable cross-region log backup. true: Enable. false: Disable (default). Note: Cross-region log backup can only be enabled when cross-region backup is enabled.
    retention Number
    Cross-region backup retention days. Value range: 7–3650. Default: 7. Unit: days. Note: When CrossBackupAllRetention is set to true, this field does not need to be set.

    InstanceChargeDetail, InstanceChargeDetailArgs

    ChargeType string
    Billing type. Options: PrePaid: subscription. PostPaid: pay-as-you-go
    AutoRenew bool
    Enable auto-renewal for prepaid scenarios. Values: true: auto-renewal. false: do not auto-renew
    ChargeEndTime string
    Billing end time for subscription instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    ChargeStartTime string
    Billing start time for the instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
    ChargeStatus string
    Instance billing status. Values: Normal: normal. Overdue: overdue. Unpaid: pending payment.
    Number int
    Number of instances to purchase. Value range: 1–50. Default: 1
    OverdueReclaimTime string
    Estimated release time after the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription), in UTC. Format: yyyy-MM-ddTHH:mm:ss.sssZ
    OverdueTime string
    Time when the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription) (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    Period int
    Purchase duration in prepaid scenarios.
    PeriodUnit string
    Purchase cycle in prepaid scenarios. Month: monthly purchase cycle (default). Year: yearly purchase cycle.
    TempModifyEndTime string
    Restore time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    TempModifyStartTime string
    Start time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
    ChargeType string
    Billing type. Options: PrePaid: subscription. PostPaid: pay-as-you-go
    AutoRenew bool
    Enable auto-renewal for prepaid scenarios. Values: true: auto-renewal. false: do not auto-renew
    ChargeEndTime string
    Billing end time for subscription instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    ChargeStartTime string
    Billing start time for the instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
    ChargeStatus string
    Instance billing status. Values: Normal: normal. Overdue: overdue. Unpaid: pending payment.
    Number int
    Number of instances to purchase. Value range: 1–50. Default: 1
    OverdueReclaimTime string
    Estimated release time after the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription), in UTC. Format: yyyy-MM-ddTHH:mm:ss.sssZ
    OverdueTime string
    Time when the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription) (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    Period int
    Purchase duration in prepaid scenarios.
    PeriodUnit string
    Purchase cycle in prepaid scenarios. Month: monthly purchase cycle (default). Year: yearly purchase cycle.
    TempModifyEndTime string
    Restore time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    TempModifyStartTime string
    Start time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
    charge_type string
    Billing type. Options: PrePaid: subscription. PostPaid: pay-as-you-go
    auto_renew bool
    Enable auto-renewal for prepaid scenarios. Values: true: auto-renewal. false: do not auto-renew
    charge_end_time string
    Billing end time for subscription instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    charge_start_time string
    Billing start time for the instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
    charge_status string
    Instance billing status. Values: Normal: normal. Overdue: overdue. Unpaid: pending payment.
    number number
    Number of instances to purchase. Value range: 1–50. Default: 1
    overdue_reclaim_time string
    Estimated release time after the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription), in UTC. Format: yyyy-MM-ddTHH:mm:ss.sssZ
    overdue_time string
    Time when the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription) (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    period number
    Purchase duration in prepaid scenarios.
    period_unit string
    Purchase cycle in prepaid scenarios. Month: monthly purchase cycle (default). Year: yearly purchase cycle.
    temp_modify_end_time string
    Restore time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    temp_modify_start_time string
    Start time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
    chargeType String
    Billing type. Options: PrePaid: subscription. PostPaid: pay-as-you-go
    autoRenew Boolean
    Enable auto-renewal for prepaid scenarios. Values: true: auto-renewal. false: do not auto-renew
    chargeEndTime String
    Billing end time for subscription instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    chargeStartTime String
    Billing start time for the instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
    chargeStatus String
    Instance billing status. Values: Normal: normal. Overdue: overdue. Unpaid: pending payment.
    number Integer
    Number of instances to purchase. Value range: 1–50. Default: 1
    overdueReclaimTime String
    Estimated release time after the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription), in UTC. Format: yyyy-MM-ddTHH:mm:ss.sssZ
    overdueTime String
    Time when the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription) (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    period Integer
    Purchase duration in prepaid scenarios.
    periodUnit String
    Purchase cycle in prepaid scenarios. Month: monthly purchase cycle (default). Year: yearly purchase cycle.
    tempModifyEndTime String
    Restore time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    tempModifyStartTime String
    Start time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
    chargeType string
    Billing type. Options: PrePaid: subscription. PostPaid: pay-as-you-go
    autoRenew boolean
    Enable auto-renewal for prepaid scenarios. Values: true: auto-renewal. false: do not auto-renew
    chargeEndTime string
    Billing end time for subscription instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    chargeStartTime string
    Billing start time for the instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
    chargeStatus string
    Instance billing status. Values: Normal: normal. Overdue: overdue. Unpaid: pending payment.
    number number
    Number of instances to purchase. Value range: 1–50. Default: 1
    overdueReclaimTime string
    Estimated release time after the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription), in UTC. Format: yyyy-MM-ddTHH:mm:ss.sssZ
    overdueTime string
    Time when the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription) (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    period number
    Purchase duration in prepaid scenarios.
    periodUnit string
    Purchase cycle in prepaid scenarios. Month: monthly purchase cycle (default). Year: yearly purchase cycle.
    tempModifyEndTime string
    Restore time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    tempModifyStartTime string
    Start time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
    charge_type str
    Billing type. Options: PrePaid: subscription. PostPaid: pay-as-you-go
    auto_renew bool
    Enable auto-renewal for prepaid scenarios. Values: true: auto-renewal. false: do not auto-renew
    charge_end_time str
    Billing end time for subscription instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    charge_start_time str
    Billing start time for the instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
    charge_status str
    Instance billing status. Values: Normal: normal. Overdue: overdue. Unpaid: pending payment.
    number int
    Number of instances to purchase. Value range: 1–50. Default: 1
    overdue_reclaim_time str
    Estimated release time after the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription), in UTC. Format: yyyy-MM-ddTHH:mm:ss.sssZ
    overdue_time str
    Time when the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription) (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    period int
    Purchase duration in prepaid scenarios.
    period_unit str
    Purchase cycle in prepaid scenarios. Month: monthly purchase cycle (default). Year: yearly purchase cycle.
    temp_modify_end_time str
    Restore time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    temp_modify_start_time str
    Start time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
    chargeType String
    Billing type. Options: PrePaid: subscription. PostPaid: pay-as-you-go
    autoRenew Boolean
    Enable auto-renewal for prepaid scenarios. Values: true: auto-renewal. false: do not auto-renew
    chargeEndTime String
    Billing end time for subscription instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    chargeStartTime String
    Billing start time for the instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
    chargeStatus String
    Instance billing status. Values: Normal: normal. Overdue: overdue. Unpaid: pending payment.
    number Number
    Number of instances to purchase. Value range: 1–50. Default: 1
    overdueReclaimTime String
    Estimated release time after the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription), in UTC. Format: yyyy-MM-ddTHH:mm:ss.sssZ
    overdueTime String
    Time when the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription) (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    period Number
    Purchase duration in prepaid scenarios.
    periodUnit String
    Purchase cycle in prepaid scenarios. Month: monthly purchase cycle (default). Year: yearly purchase cycle.
    tempModifyEndTime String
    Restore time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    tempModifyStartTime String
    Start time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ

    InstanceDisasterRecoveryInstance, InstanceDisasterRecoveryInstanceArgs

    DtsTaskId string
    ID of synchronization tasks between primary and disaster recovery instances.
    DtsTaskName string
    Name of the synchronization task between the primary instance and the disaster recovery instance
    DtsTaskStatus string
    Status of synchronization tasks between the primary instance and the disaster recovery instance
    InstanceId string
    Disaster recovery instance ID.
    InstanceName string
    Name of disaster recovery instance.
    SecondsBehindMaster int
    Latency between the disaster recovery instance and the primary instance.
    DtsTaskId string
    ID of synchronization tasks between primary and disaster recovery instances.
    DtsTaskName string
    Name of the synchronization task between the primary instance and the disaster recovery instance
    DtsTaskStatus string
    Status of synchronization tasks between the primary instance and the disaster recovery instance
    InstanceId string
    Disaster recovery instance ID.
    InstanceName string
    Name of disaster recovery instance.
    SecondsBehindMaster int
    Latency between the disaster recovery instance and the primary instance.
    dts_task_id string
    ID of synchronization tasks between primary and disaster recovery instances.
    dts_task_name string
    Name of the synchronization task between the primary instance and the disaster recovery instance
    dts_task_status string
    Status of synchronization tasks between the primary instance and the disaster recovery instance
    instance_id string
    Disaster recovery instance ID.
    instance_name string
    Name of disaster recovery instance.
    seconds_behind_master number
    Latency between the disaster recovery instance and the primary instance.
    dtsTaskId String
    ID of synchronization tasks between primary and disaster recovery instances.
    dtsTaskName String
    Name of the synchronization task between the primary instance and the disaster recovery instance
    dtsTaskStatus String
    Status of synchronization tasks between the primary instance and the disaster recovery instance
    instanceId String
    Disaster recovery instance ID.
    instanceName String
    Name of disaster recovery instance.
    secondsBehindMaster Integer
    Latency between the disaster recovery instance and the primary instance.
    dtsTaskId string
    ID of synchronization tasks between primary and disaster recovery instances.
    dtsTaskName string
    Name of the synchronization task between the primary instance and the disaster recovery instance
    dtsTaskStatus string
    Status of synchronization tasks between the primary instance and the disaster recovery instance
    instanceId string
    Disaster recovery instance ID.
    instanceName string
    Name of disaster recovery instance.
    secondsBehindMaster number
    Latency between the disaster recovery instance and the primary instance.
    dts_task_id str
    ID of synchronization tasks between primary and disaster recovery instances.
    dts_task_name str
    Name of the synchronization task between the primary instance and the disaster recovery instance
    dts_task_status str
    Status of synchronization tasks between the primary instance and the disaster recovery instance
    instance_id str
    Disaster recovery instance ID.
    instance_name str
    Name of disaster recovery instance.
    seconds_behind_master int
    Latency between the disaster recovery instance and the primary instance.
    dtsTaskId String
    ID of synchronization tasks between primary and disaster recovery instances.
    dtsTaskName String
    Name of the synchronization task between the primary instance and the disaster recovery instance
    dtsTaskStatus String
    Status of synchronization tasks between the primary instance and the disaster recovery instance
    instanceId String
    Disaster recovery instance ID.
    instanceName String
    Name of disaster recovery instance.
    secondsBehindMaster Number
    Latency between the disaster recovery instance and the primary instance.

    InstanceEndpoint, InstanceEndpointArgs

    Addresses List<Volcengine.InstanceEndpointAddress>
    Address list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    AutoAddNewNodes string
    When the endpoint type is read/write or read-only, you can set whether new nodes join automatically. Values: Enable: auto join. Disable: do not auto join (default)
    ConnectionInfoTags List<string>
    Connection endpoint tag.
    ConnectionMode string
    Connection endpoint type. Values: Proxy: proxy endpoint. Direct: direct endpoint
    ConnectionPoolType string
    Connection pool type for proxy terminal. Values: Transaction: Transaction-level connection pool. Default value. Direct: Direct mode.
    CustomRouteStrategies List<Volcengine.InstanceEndpointCustomRouteStrategy>
    Custom routing and forwarding rules for connected terminals. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    Description string
    Description of the connection endpoint
    EnableConnectionPersistent bool
    Enable connection keep-alive. Options: true: yes. false: no
    EnableReadOnly string
    Is global read-only enabled? Values: Enable: enabled. Disable: not enabled.
    EnableReadWriteSplitting string
    Whether to enable read/write separation. Values: Enable: Enabled. Disable: Not enabled.
    EndpointId string
    Instance connection endpoint ID.
    EndpointName string
    Instance connection endpoint name.
    EndpointType string
    Endpoint type. Value: Custom, custom endpoint.
    IdleConnectionReclaim bool
    Whether the idle connection recycling feature is enabled. true: Enabled. false: Not enabled.
    ImplicitTransSplit bool
    Whether to enable transaction separation. Values: true: Yes. false: No.
    MasterNodeRouting bool
    Whether to enable primary node routing. Values: true: Yes. false: No.
    MasterProtectorTimeout int
    Overload protection timeout. Value range: integer between 60 and 7200, in seconds.
    MultiStatementsMode string
    Multi-Statements mode for proxy endpoints. Values: Strict: strict mode (default). Loose: loose mode
    OverloadProtection bool
    Overload protection enabled. Values: true: yes. false: no
    ReadOnlyNodeDistributionType string
    Read weight allocation mode. This parameter is required when read/write splitting is enabled (set to true). For request parameters in the CreateDBEndpoint and ModifyDBEndpoint APIs, valid values are: LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling. For response parameters in the DescribeDBInstanceDetail API, valid values are: Default: automatic allocation based on specification weights. Custom: custom weight allocation. RoundRobin: round-robin scheduling. LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling.
    ReadOnlyNodeMaxDelayTime int
    Read-only node latency threshold. Value range: 1~3600, default is 30, unit: seconds.
    ReadOnlyNodeWeights List<Volcengine.InstanceEndpointReadOnlyNodeWeight>
    List of nodes configured for the connection endpoint and their corresponding read-only weights. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    ReadWriteMode string
    Read/write mode: ReadWrite: read/write. ReadOnly: read-only
    Addresses []InstanceEndpointAddress
    Address list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    AutoAddNewNodes string
    When the endpoint type is read/write or read-only, you can set whether new nodes join automatically. Values: Enable: auto join. Disable: do not auto join (default)
    ConnectionInfoTags []string
    Connection endpoint tag.
    ConnectionMode string
    Connection endpoint type. Values: Proxy: proxy endpoint. Direct: direct endpoint
    ConnectionPoolType string
    Connection pool type for proxy terminal. Values: Transaction: Transaction-level connection pool. Default value. Direct: Direct mode.
    CustomRouteStrategies []InstanceEndpointCustomRouteStrategy
    Custom routing and forwarding rules for connected terminals. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    Description string
    Description of the connection endpoint
    EnableConnectionPersistent bool
    Enable connection keep-alive. Options: true: yes. false: no
    EnableReadOnly string
    Is global read-only enabled? Values: Enable: enabled. Disable: not enabled.
    EnableReadWriteSplitting string
    Whether to enable read/write separation. Values: Enable: Enabled. Disable: Not enabled.
    EndpointId string
    Instance connection endpoint ID.
    EndpointName string
    Instance connection endpoint name.
    EndpointType string
    Endpoint type. Value: Custom, custom endpoint.
    IdleConnectionReclaim bool
    Whether the idle connection recycling feature is enabled. true: Enabled. false: Not enabled.
    ImplicitTransSplit bool
    Whether to enable transaction separation. Values: true: Yes. false: No.
    MasterNodeRouting bool
    Whether to enable primary node routing. Values: true: Yes. false: No.
    MasterProtectorTimeout int
    Overload protection timeout. Value range: integer between 60 and 7200, in seconds.
    MultiStatementsMode string
    Multi-Statements mode for proxy endpoints. Values: Strict: strict mode (default). Loose: loose mode
    OverloadProtection bool
    Overload protection enabled. Values: true: yes. false: no
    ReadOnlyNodeDistributionType string
    Read weight allocation mode. This parameter is required when read/write splitting is enabled (set to true). For request parameters in the CreateDBEndpoint and ModifyDBEndpoint APIs, valid values are: LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling. For response parameters in the DescribeDBInstanceDetail API, valid values are: Default: automatic allocation based on specification weights. Custom: custom weight allocation. RoundRobin: round-robin scheduling. LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling.
    ReadOnlyNodeMaxDelayTime int
    Read-only node latency threshold. Value range: 1~3600, default is 30, unit: seconds.
    ReadOnlyNodeWeights []InstanceEndpointReadOnlyNodeWeight
    List of nodes configured for the connection endpoint and their corresponding read-only weights. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    ReadWriteMode string
    Read/write mode: ReadWrite: read/write. ReadOnly: read-only
    addresses list(object)
    Address list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    auto_add_new_nodes string
    When the endpoint type is read/write or read-only, you can set whether new nodes join automatically. Values: Enable: auto join. Disable: do not auto join (default)
    connection_info_tags list(string)
    Connection endpoint tag.
    connection_mode string
    Connection endpoint type. Values: Proxy: proxy endpoint. Direct: direct endpoint
    connection_pool_type string
    Connection pool type for proxy terminal. Values: Transaction: Transaction-level connection pool. Default value. Direct: Direct mode.
    custom_route_strategies list(object)
    Custom routing and forwarding rules for connected terminals. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    description string
    Description of the connection endpoint
    enable_connection_persistent bool
    Enable connection keep-alive. Options: true: yes. false: no
    enable_read_only string
    Is global read-only enabled? Values: Enable: enabled. Disable: not enabled.
    enable_read_write_splitting string
    Whether to enable read/write separation. Values: Enable: Enabled. Disable: Not enabled.
    endpoint_id string
    Instance connection endpoint ID.
    endpoint_name string
    Instance connection endpoint name.
    endpoint_type string
    Endpoint type. Value: Custom, custom endpoint.
    idle_connection_reclaim bool
    Whether the idle connection recycling feature is enabled. true: Enabled. false: Not enabled.
    implicit_trans_split bool
    Whether to enable transaction separation. Values: true: Yes. false: No.
    master_node_routing bool
    Whether to enable primary node routing. Values: true: Yes. false: No.
    master_protector_timeout number
    Overload protection timeout. Value range: integer between 60 and 7200, in seconds.
    multi_statements_mode string
    Multi-Statements mode for proxy endpoints. Values: Strict: strict mode (default). Loose: loose mode
    overload_protection bool
    Overload protection enabled. Values: true: yes. false: no
    read_only_node_distribution_type string
    Read weight allocation mode. This parameter is required when read/write splitting is enabled (set to true). For request parameters in the CreateDBEndpoint and ModifyDBEndpoint APIs, valid values are: LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling. For response parameters in the DescribeDBInstanceDetail API, valid values are: Default: automatic allocation based on specification weights. Custom: custom weight allocation. RoundRobin: round-robin scheduling. LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling.
    read_only_node_max_delay_time number
    Read-only node latency threshold. Value range: 1~3600, default is 30, unit: seconds.
    read_only_node_weights list(object)
    List of nodes configured for the connection endpoint and their corresponding read-only weights. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    read_write_mode string
    Read/write mode: ReadWrite: read/write. ReadOnly: read-only
    addresses List<InstanceEndpointAddress>
    Address list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    autoAddNewNodes String
    When the endpoint type is read/write or read-only, you can set whether new nodes join automatically. Values: Enable: auto join. Disable: do not auto join (default)
    connectionInfoTags List<String>
    Connection endpoint tag.
    connectionMode String
    Connection endpoint type. Values: Proxy: proxy endpoint. Direct: direct endpoint
    connectionPoolType String
    Connection pool type for proxy terminal. Values: Transaction: Transaction-level connection pool. Default value. Direct: Direct mode.
    customRouteStrategies List<InstanceEndpointCustomRouteStrategy>
    Custom routing and forwarding rules for connected terminals. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    description String
    Description of the connection endpoint
    enableConnectionPersistent Boolean
    Enable connection keep-alive. Options: true: yes. false: no
    enableReadOnly String
    Is global read-only enabled? Values: Enable: enabled. Disable: not enabled.
    enableReadWriteSplitting String
    Whether to enable read/write separation. Values: Enable: Enabled. Disable: Not enabled.
    endpointId String
    Instance connection endpoint ID.
    endpointName String
    Instance connection endpoint name.
    endpointType String
    Endpoint type. Value: Custom, custom endpoint.
    idleConnectionReclaim Boolean
    Whether the idle connection recycling feature is enabled. true: Enabled. false: Not enabled.
    implicitTransSplit Boolean
    Whether to enable transaction separation. Values: true: Yes. false: No.
    masterNodeRouting Boolean
    Whether to enable primary node routing. Values: true: Yes. false: No.
    masterProtectorTimeout Integer
    Overload protection timeout. Value range: integer between 60 and 7200, in seconds.
    multiStatementsMode String
    Multi-Statements mode for proxy endpoints. Values: Strict: strict mode (default). Loose: loose mode
    overloadProtection Boolean
    Overload protection enabled. Values: true: yes. false: no
    readOnlyNodeDistributionType String
    Read weight allocation mode. This parameter is required when read/write splitting is enabled (set to true). For request parameters in the CreateDBEndpoint and ModifyDBEndpoint APIs, valid values are: LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling. For response parameters in the DescribeDBInstanceDetail API, valid values are: Default: automatic allocation based on specification weights. Custom: custom weight allocation. RoundRobin: round-robin scheduling. LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling.
    readOnlyNodeMaxDelayTime Integer
    Read-only node latency threshold. Value range: 1~3600, default is 30, unit: seconds.
    readOnlyNodeWeights List<InstanceEndpointReadOnlyNodeWeight>
    List of nodes configured for the connection endpoint and their corresponding read-only weights. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    readWriteMode String
    Read/write mode: ReadWrite: read/write. ReadOnly: read-only
    addresses InstanceEndpointAddress[]
    Address list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    autoAddNewNodes string
    When the endpoint type is read/write or read-only, you can set whether new nodes join automatically. Values: Enable: auto join. Disable: do not auto join (default)
    connectionInfoTags string[]
    Connection endpoint tag.
    connectionMode string
    Connection endpoint type. Values: Proxy: proxy endpoint. Direct: direct endpoint
    connectionPoolType string
    Connection pool type for proxy terminal. Values: Transaction: Transaction-level connection pool. Default value. Direct: Direct mode.
    customRouteStrategies InstanceEndpointCustomRouteStrategy[]
    Custom routing and forwarding rules for connected terminals. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    description string
    Description of the connection endpoint
    enableConnectionPersistent boolean
    Enable connection keep-alive. Options: true: yes. false: no
    enableReadOnly string
    Is global read-only enabled? Values: Enable: enabled. Disable: not enabled.
    enableReadWriteSplitting string
    Whether to enable read/write separation. Values: Enable: Enabled. Disable: Not enabled.
    endpointId string
    Instance connection endpoint ID.
    endpointName string
    Instance connection endpoint name.
    endpointType string
    Endpoint type. Value: Custom, custom endpoint.
    idleConnectionReclaim boolean
    Whether the idle connection recycling feature is enabled. true: Enabled. false: Not enabled.
    implicitTransSplit boolean
    Whether to enable transaction separation. Values: true: Yes. false: No.
    masterNodeRouting boolean
    Whether to enable primary node routing. Values: true: Yes. false: No.
    masterProtectorTimeout number
    Overload protection timeout. Value range: integer between 60 and 7200, in seconds.
    multiStatementsMode string
    Multi-Statements mode for proxy endpoints. Values: Strict: strict mode (default). Loose: loose mode
    overloadProtection boolean
    Overload protection enabled. Values: true: yes. false: no
    readOnlyNodeDistributionType string
    Read weight allocation mode. This parameter is required when read/write splitting is enabled (set to true). For request parameters in the CreateDBEndpoint and ModifyDBEndpoint APIs, valid values are: LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling. For response parameters in the DescribeDBInstanceDetail API, valid values are: Default: automatic allocation based on specification weights. Custom: custom weight allocation. RoundRobin: round-robin scheduling. LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling.
    readOnlyNodeMaxDelayTime number
    Read-only node latency threshold. Value range: 1~3600, default is 30, unit: seconds.
    readOnlyNodeWeights InstanceEndpointReadOnlyNodeWeight[]
    List of nodes configured for the connection endpoint and their corresponding read-only weights. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    readWriteMode string
    Read/write mode: ReadWrite: read/write. ReadOnly: read-only
    addresses Sequence[InstanceEndpointAddress]
    Address list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    auto_add_new_nodes str
    When the endpoint type is read/write or read-only, you can set whether new nodes join automatically. Values: Enable: auto join. Disable: do not auto join (default)
    connection_info_tags Sequence[str]
    Connection endpoint tag.
    connection_mode str
    Connection endpoint type. Values: Proxy: proxy endpoint. Direct: direct endpoint
    connection_pool_type str
    Connection pool type for proxy terminal. Values: Transaction: Transaction-level connection pool. Default value. Direct: Direct mode.
    custom_route_strategies Sequence[InstanceEndpointCustomRouteStrategy]
    Custom routing and forwarding rules for connected terminals. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    description str
    Description of the connection endpoint
    enable_connection_persistent bool
    Enable connection keep-alive. Options: true: yes. false: no
    enable_read_only str
    Is global read-only enabled? Values: Enable: enabled. Disable: not enabled.
    enable_read_write_splitting str
    Whether to enable read/write separation. Values: Enable: Enabled. Disable: Not enabled.
    endpoint_id str
    Instance connection endpoint ID.
    endpoint_name str
    Instance connection endpoint name.
    endpoint_type str
    Endpoint type. Value: Custom, custom endpoint.
    idle_connection_reclaim bool
    Whether the idle connection recycling feature is enabled. true: Enabled. false: Not enabled.
    implicit_trans_split bool
    Whether to enable transaction separation. Values: true: Yes. false: No.
    master_node_routing bool
    Whether to enable primary node routing. Values: true: Yes. false: No.
    master_protector_timeout int
    Overload protection timeout. Value range: integer between 60 and 7200, in seconds.
    multi_statements_mode str
    Multi-Statements mode for proxy endpoints. Values: Strict: strict mode (default). Loose: loose mode
    overload_protection bool
    Overload protection enabled. Values: true: yes. false: no
    read_only_node_distribution_type str
    Read weight allocation mode. This parameter is required when read/write splitting is enabled (set to true). For request parameters in the CreateDBEndpoint and ModifyDBEndpoint APIs, valid values are: LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling. For response parameters in the DescribeDBInstanceDetail API, valid values are: Default: automatic allocation based on specification weights. Custom: custom weight allocation. RoundRobin: round-robin scheduling. LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling.
    read_only_node_max_delay_time int
    Read-only node latency threshold. Value range: 1~3600, default is 30, unit: seconds.
    read_only_node_weights Sequence[InstanceEndpointReadOnlyNodeWeight]
    List of nodes configured for the connection endpoint and their corresponding read-only weights. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    read_write_mode str
    Read/write mode: ReadWrite: read/write. ReadOnly: read-only
    addresses List<Property Map>
    Address list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    autoAddNewNodes String
    When the endpoint type is read/write or read-only, you can set whether new nodes join automatically. Values: Enable: auto join. Disable: do not auto join (default)
    connectionInfoTags List<String>
    Connection endpoint tag.
    connectionMode String
    Connection endpoint type. Values: Proxy: proxy endpoint. Direct: direct endpoint
    connectionPoolType String
    Connection pool type for proxy terminal. Values: Transaction: Transaction-level connection pool. Default value. Direct: Direct mode.
    customRouteStrategies List<Property Map>
    Custom routing and forwarding rules for connected terminals. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    description String
    Description of the connection endpoint
    enableConnectionPersistent Boolean
    Enable connection keep-alive. Options: true: yes. false: no
    enableReadOnly String
    Is global read-only enabled? Values: Enable: enabled. Disable: not enabled.
    enableReadWriteSplitting String
    Whether to enable read/write separation. Values: Enable: Enabled. Disable: Not enabled.
    endpointId String
    Instance connection endpoint ID.
    endpointName String
    Instance connection endpoint name.
    endpointType String
    Endpoint type. Value: Custom, custom endpoint.
    idleConnectionReclaim Boolean
    Whether the idle connection recycling feature is enabled. true: Enabled. false: Not enabled.
    implicitTransSplit Boolean
    Whether to enable transaction separation. Values: true: Yes. false: No.
    masterNodeRouting Boolean
    Whether to enable primary node routing. Values: true: Yes. false: No.
    masterProtectorTimeout Number
    Overload protection timeout. Value range: integer between 60 and 7200, in seconds.
    multiStatementsMode String
    Multi-Statements mode for proxy endpoints. Values: Strict: strict mode (default). Loose: loose mode
    overloadProtection Boolean
    Overload protection enabled. Values: true: yes. false: no
    readOnlyNodeDistributionType String
    Read weight allocation mode. This parameter is required when read/write splitting is enabled (set to true). For request parameters in the CreateDBEndpoint and ModifyDBEndpoint APIs, valid values are: LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling. For response parameters in the DescribeDBInstanceDetail API, valid values are: Default: automatic allocation based on specification weights. Custom: custom weight allocation. RoundRobin: round-robin scheduling. LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling.
    readOnlyNodeMaxDelayTime Number
    Read-only node latency threshold. Value range: 1~3600, default is 30, unit: seconds.
    readOnlyNodeWeights List<Property Map>
    List of nodes configured for the connection endpoint and their corresponding read-only weights. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    readWriteMode String
    Read/write mode: ReadWrite: read/write. ReadOnly: read-only

    InstanceEndpointAddress, InstanceEndpointAddressArgs

    DnsVisibility bool
    false: Private network resolution (default). true: Private and public network resolution.
    Domain string
    Connection domain name.
    EipId string
    EIP ID, valid only for Public addresses.
    EipLocked bool
    Whether the EIP used by the connected terminal is suspended due to overdue payment. Values: true: Yes. false: No.
    InternetProtocol string
    IP protocol version. Value: IPv4.
    IpAddress string
    IP address.
    NetworkType string
    Network address type. Values: Private: private address. Public: public address.
    Port string
    Port.
    SubnetId string
    Subnet ID, valid only for Private addresses.
    DnsVisibility bool
    false: Private network resolution (default). true: Private and public network resolution.
    Domain string
    Connection domain name.
    EipId string
    EIP ID, valid only for Public addresses.
    EipLocked bool
    Whether the EIP used by the connected terminal is suspended due to overdue payment. Values: true: Yes. false: No.
    InternetProtocol string
    IP protocol version. Value: IPv4.
    IpAddress string
    IP address.
    NetworkType string
    Network address type. Values: Private: private address. Public: public address.
    Port string
    Port.
    SubnetId string
    Subnet ID, valid only for Private addresses.
    dns_visibility bool
    false: Private network resolution (default). true: Private and public network resolution.
    domain string
    Connection domain name.
    eip_id string
    EIP ID, valid only for Public addresses.
    eip_locked bool
    Whether the EIP used by the connected terminal is suspended due to overdue payment. Values: true: Yes. false: No.
    internet_protocol string
    IP protocol version. Value: IPv4.
    ip_address string
    IP address.
    network_type string
    Network address type. Values: Private: private address. Public: public address.
    port string
    Port.
    subnet_id string
    Subnet ID, valid only for Private addresses.
    dnsVisibility Boolean
    false: Private network resolution (default). true: Private and public network resolution.
    domain String
    Connection domain name.
    eipId String
    EIP ID, valid only for Public addresses.
    eipLocked Boolean
    Whether the EIP used by the connected terminal is suspended due to overdue payment. Values: true: Yes. false: No.
    internetProtocol String
    IP protocol version. Value: IPv4.
    ipAddress String
    IP address.
    networkType String
    Network address type. Values: Private: private address. Public: public address.
    port String
    Port.
    subnetId String
    Subnet ID, valid only for Private addresses.
    dnsVisibility boolean
    false: Private network resolution (default). true: Private and public network resolution.
    domain string
    Connection domain name.
    eipId string
    EIP ID, valid only for Public addresses.
    eipLocked boolean
    Whether the EIP used by the connected terminal is suspended due to overdue payment. Values: true: Yes. false: No.
    internetProtocol string
    IP protocol version. Value: IPv4.
    ipAddress string
    IP address.
    networkType string
    Network address type. Values: Private: private address. Public: public address.
    port string
    Port.
    subnetId string
    Subnet ID, valid only for Private addresses.
    dns_visibility bool
    false: Private network resolution (default). true: Private and public network resolution.
    domain str
    Connection domain name.
    eip_id str
    EIP ID, valid only for Public addresses.
    eip_locked bool
    Whether the EIP used by the connected terminal is suspended due to overdue payment. Values: true: Yes. false: No.
    internet_protocol str
    IP protocol version. Value: IPv4.
    ip_address str
    IP address.
    network_type str
    Network address type. Values: Private: private address. Public: public address.
    port str
    Port.
    subnet_id str
    Subnet ID, valid only for Private addresses.
    dnsVisibility Boolean
    false: Private network resolution (default). true: Private and public network resolution.
    domain String
    Connection domain name.
    eipId String
    EIP ID, valid only for Public addresses.
    eipLocked Boolean
    Whether the EIP used by the connected terminal is suspended due to overdue payment. Values: true: Yes. false: No.
    internetProtocol String
    IP protocol version. Value: IPv4.
    ipAddress String
    IP address.
    networkType String
    Network address type. Values: Private: private address. Public: public address.
    port String
    Port.
    subnetId String
    Subnet ID, valid only for Private addresses.

    InstanceEndpointCustomRouteStrategy, InstanceEndpointCustomRouteStrategyArgs

    NodeType string
    SQL forwarding rule target. Values: Primary: primary node. Secondary: secondary node. ReadOnly: read-only node. Note: For dual-node instances, you can select the primary node or read-only node. For multi-node instances, you can select the primary node or secondary node.
    SqlKeyword string
    Forwarding rule keywords. SQL keyword setting rules are as follows: Each rule can contain up to 20 keywords. Maximum length is 64 characters. Can include English letters, numbers, underscores (_), @, #, :=, and Chinese characters.
    NodeType string
    SQL forwarding rule target. Values: Primary: primary node. Secondary: secondary node. ReadOnly: read-only node. Note: For dual-node instances, you can select the primary node or read-only node. For multi-node instances, you can select the primary node or secondary node.
    SqlKeyword string
    Forwarding rule keywords. SQL keyword setting rules are as follows: Each rule can contain up to 20 keywords. Maximum length is 64 characters. Can include English letters, numbers, underscores (_), @, #, :=, and Chinese characters.
    node_type string
    SQL forwarding rule target. Values: Primary: primary node. Secondary: secondary node. ReadOnly: read-only node. Note: For dual-node instances, you can select the primary node or read-only node. For multi-node instances, you can select the primary node or secondary node.
    sql_keyword string
    Forwarding rule keywords. SQL keyword setting rules are as follows: Each rule can contain up to 20 keywords. Maximum length is 64 characters. Can include English letters, numbers, underscores (_), @, #, :=, and Chinese characters.
    nodeType String
    SQL forwarding rule target. Values: Primary: primary node. Secondary: secondary node. ReadOnly: read-only node. Note: For dual-node instances, you can select the primary node or read-only node. For multi-node instances, you can select the primary node or secondary node.
    sqlKeyword String
    Forwarding rule keywords. SQL keyword setting rules are as follows: Each rule can contain up to 20 keywords. Maximum length is 64 characters. Can include English letters, numbers, underscores (_), @, #, :=, and Chinese characters.
    nodeType string
    SQL forwarding rule target. Values: Primary: primary node. Secondary: secondary node. ReadOnly: read-only node. Note: For dual-node instances, you can select the primary node or read-only node. For multi-node instances, you can select the primary node or secondary node.
    sqlKeyword string
    Forwarding rule keywords. SQL keyword setting rules are as follows: Each rule can contain up to 20 keywords. Maximum length is 64 characters. Can include English letters, numbers, underscores (_), @, #, :=, and Chinese characters.
    node_type str
    SQL forwarding rule target. Values: Primary: primary node. Secondary: secondary node. ReadOnly: read-only node. Note: For dual-node instances, you can select the primary node or read-only node. For multi-node instances, you can select the primary node or secondary node.
    sql_keyword str
    Forwarding rule keywords. SQL keyword setting rules are as follows: Each rule can contain up to 20 keywords. Maximum length is 64 characters. Can include English letters, numbers, underscores (_), @, #, :=, and Chinese characters.
    nodeType String
    SQL forwarding rule target. Values: Primary: primary node. Secondary: secondary node. ReadOnly: read-only node. Note: For dual-node instances, you can select the primary node or read-only node. For multi-node instances, you can select the primary node or secondary node.
    sqlKeyword String
    Forwarding rule keywords. SQL keyword setting rules are as follows: Each rule can contain up to 20 keywords. Maximum length is 64 characters. Can include English letters, numbers, underscores (_), @, #, :=, and Chinese characters.

    InstanceEndpointReadOnlyNodeWeight, InstanceEndpointReadOnlyNodeWeightArgs

    NodeId string
    Read-only nodes require NodeId. Primary nodes do not require it
    NodeType string
    Node type. Primary: primary node. ReadOnly: read-only node
    Weight int
    Node read weight, increments of 100, maximum value is 10000.
    NodeId string
    Read-only nodes require NodeId. Primary nodes do not require it
    NodeType string
    Node type. Primary: primary node. ReadOnly: read-only node
    Weight int
    Node read weight, increments of 100, maximum value is 10000.
    node_id string
    Read-only nodes require NodeId. Primary nodes do not require it
    node_type string
    Node type. Primary: primary node. ReadOnly: read-only node
    weight number
    Node read weight, increments of 100, maximum value is 10000.
    nodeId String
    Read-only nodes require NodeId. Primary nodes do not require it
    nodeType String
    Node type. Primary: primary node. ReadOnly: read-only node
    weight Integer
    Node read weight, increments of 100, maximum value is 10000.
    nodeId string
    Read-only nodes require NodeId. Primary nodes do not require it
    nodeType string
    Node type. Primary: primary node. ReadOnly: read-only node
    weight number
    Node read weight, increments of 100, maximum value is 10000.
    node_id str
    Read-only nodes require NodeId. Primary nodes do not require it
    node_type str
    Node type. Primary: primary node. ReadOnly: read-only node
    weight int
    Node read weight, increments of 100, maximum value is 10000.
    nodeId String
    Read-only nodes require NodeId. Primary nodes do not require it
    nodeType String
    Node type. Primary: primary node. ReadOnly: read-only node
    weight Number
    Node read weight, increments of 100, maximum value is 10000.

    InstanceMaintenanceWindow, InstanceMaintenanceWindowArgs

    DayKind string
    Maintenance cycle granularity. Value: Week.
    DayOfWeeks List<string>
    Specify the days of the week when the maintenance window is active. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.
    MaintenanceTime string
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC). Note: Specifies the time period during which maintenance can be performed.
    DayKind string
    Maintenance cycle granularity. Value: Week.
    DayOfWeeks []string
    Specify the days of the week when the maintenance window is active. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.
    MaintenanceTime string
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC). Note: Specifies the time period during which maintenance can be performed.
    day_kind string
    Maintenance cycle granularity. Value: Week.
    day_of_weeks list(string)
    Specify the days of the week when the maintenance window is active. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.
    maintenance_time string
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC). Note: Specifies the time period during which maintenance can be performed.
    dayKind String
    Maintenance cycle granularity. Value: Week.
    dayOfWeeks List<String>
    Specify the days of the week when the maintenance window is active. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.
    maintenanceTime String
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC). Note: Specifies the time period during which maintenance can be performed.
    dayKind string
    Maintenance cycle granularity. Value: Week.
    dayOfWeeks string[]
    Specify the days of the week when the maintenance window is active. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.
    maintenanceTime string
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC). Note: Specifies the time period during which maintenance can be performed.
    day_kind str
    Maintenance cycle granularity. Value: Week.
    day_of_weeks Sequence[str]
    Specify the days of the week when the maintenance window is active. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.
    maintenance_time str
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC). Note: Specifies the time period during which maintenance can be performed.
    dayKind String
    Maintenance cycle granularity. Value: Week.
    dayOfWeeks List<String>
    Specify the days of the week when the maintenance window is active. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.
    maintenanceTime String
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC). Note: Specifies the time period during which maintenance can be performed.

    InstanceNode, InstanceNodeArgs

    NodeSpec string
    Node specification.
    NodeType string
    Node type. Values: Primary: primary node. Secondary: secondary node. ReadOnly: read-only node.
    ZoneId string
    Availability zone ID
    NodeSpec string
    Node specification.
    NodeType string
    Node type. Values: Primary: primary node. Secondary: secondary node. ReadOnly: read-only node.
    ZoneId string
    Availability zone ID
    node_spec string
    Node specification.
    node_type string
    Node type. Values: Primary: primary node. Secondary: secondary node. ReadOnly: read-only node.
    zone_id string
    Availability zone ID
    nodeSpec String
    Node specification.
    nodeType String
    Node type. Values: Primary: primary node. Secondary: secondary node. ReadOnly: read-only node.
    zoneId String
    Availability zone ID
    nodeSpec string
    Node specification.
    nodeType string
    Node type. Values: Primary: primary node. Secondary: secondary node. ReadOnly: read-only node.
    zoneId string
    Availability zone ID
    node_spec str
    Node specification.
    node_type str
    Node type. Values: Primary: primary node. Secondary: secondary node. ReadOnly: read-only node.
    zone_id str
    Availability zone ID
    nodeSpec String
    Node specification.
    nodeType String
    Node type. Values: Primary: primary node. Secondary: secondary node. ReadOnly: read-only node.
    zoneId String
    Availability zone ID

    InstanceProxyDetail, InstanceProxyDetailArgs

    DbProxyStatus string
    Status of the instance database proxy feature. Values: Creating: proxy enabling. Running: proxy running. Shutdown: proxy disabled. Deleting: proxy disabling
    ProxyResourceInfo Volcengine.InstanceProxyDetailProxyResourceInfo
    Resource information for the instance's database proxy service
    DbProxyStatus string
    Status of the instance database proxy feature. Values: Creating: proxy enabling. Running: proxy running. Shutdown: proxy disabled. Deleting: proxy disabling
    ProxyResourceInfo InstanceProxyDetailProxyResourceInfo
    Resource information for the instance's database proxy service
    db_proxy_status string
    Status of the instance database proxy feature. Values: Creating: proxy enabling. Running: proxy running. Shutdown: proxy disabled. Deleting: proxy disabling
    proxy_resource_info object
    Resource information for the instance's database proxy service
    dbProxyStatus String
    Status of the instance database proxy feature. Values: Creating: proxy enabling. Running: proxy running. Shutdown: proxy disabled. Deleting: proxy disabling
    proxyResourceInfo InstanceProxyDetailProxyResourceInfo
    Resource information for the instance's database proxy service
    dbProxyStatus string
    Status of the instance database proxy feature. Values: Creating: proxy enabling. Running: proxy running. Shutdown: proxy disabled. Deleting: proxy disabling
    proxyResourceInfo InstanceProxyDetailProxyResourceInfo
    Resource information for the instance's database proxy service
    db_proxy_status str
    Status of the instance database proxy feature. Values: Creating: proxy enabling. Running: proxy running. Shutdown: proxy disabled. Deleting: proxy disabling
    proxy_resource_info InstanceProxyDetailProxyResourceInfo
    Resource information for the instance's database proxy service
    dbProxyStatus String
    Status of the instance database proxy feature. Values: Creating: proxy enabling. Running: proxy running. Shutdown: proxy disabled. Deleting: proxy disabling
    proxyResourceInfo Property Map
    Resource information for the instance's database proxy service

    InstanceProxyDetailProxyResourceInfo, InstanceProxyDetailProxyResourceInfoArgs

    CurrentProxyCpuNum int
    Current number of cores for the instance database proxy service
    MaxProxyCpuNum int
    Maximum number of cores configurable for database proxy service.
    MinProxyCpuNum int
    Minimum number of CPU cores configurable for the database proxy service
    CurrentProxyCpuNum int
    Current number of cores for the instance database proxy service
    MaxProxyCpuNum int
    Maximum number of cores configurable for database proxy service.
    MinProxyCpuNum int
    Minimum number of CPU cores configurable for the database proxy service
    current_proxy_cpu_num number
    Current number of cores for the instance database proxy service
    max_proxy_cpu_num number
    Maximum number of cores configurable for database proxy service.
    min_proxy_cpu_num number
    Minimum number of CPU cores configurable for the database proxy service
    currentProxyCpuNum Integer
    Current number of cores for the instance database proxy service
    maxProxyCpuNum Integer
    Maximum number of cores configurable for database proxy service.
    minProxyCpuNum Integer
    Minimum number of CPU cores configurable for the database proxy service
    currentProxyCpuNum number
    Current number of cores for the instance database proxy service
    maxProxyCpuNum number
    Maximum number of cores configurable for database proxy service.
    minProxyCpuNum number
    Minimum number of CPU cores configurable for the database proxy service
    current_proxy_cpu_num int
    Current number of cores for the instance database proxy service
    max_proxy_cpu_num int
    Maximum number of cores configurable for database proxy service.
    min_proxy_cpu_num int
    Minimum number of CPU cores configurable for the database proxy service
    currentProxyCpuNum Number
    Current number of cores for the instance database proxy service
    maxProxyCpuNum Number
    Maximum number of cores configurable for database proxy service.
    minProxyCpuNum Number
    Minimum number of CPU cores configurable for the database proxy service

    InstanceTag, InstanceTagArgs

    Key string
    Tag key
    Value string
    Tag value.
    Key string
    Tag key
    Value string
    Tag value.
    key string
    Tag key
    value string
    Tag value.
    key String
    Tag key
    value String
    Tag value.
    key string
    Tag key
    value string
    Tag value.
    key str
    Tag key
    value str
    Tag value.
    key String
    Tag key
    value String
    Tag value.

    Import

    $ pulumi import volcenginecc:rdsmysql/instance:Instance example "instance_id"

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

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.47
    published on Thursday, Jul 9, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial