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

volcenginecc.rdsmssql.Instance

volcenginecc logo volcenginecc
Viewing docs for volcenginecc v0.0.63
published on Thursday, Oct 15, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Cloud Database SQL Server Edition is a stable, reliable, and scalable online database service built on the world-class commercial database product Microsoft SQL Server. Creating an instance is the first step to using Cloud Database SQL Server Edition

    Example Usage

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

const rDSMsSQLInstanceDemo = new volcenginecc.rdsmssql.Instance("RDSMsSQLInstanceDemo", {
    nodeSpec: "rds.mssql.3il.x8.medium.s1",
    zoneId: "cn-beijing-a",
    subnetId: "subnet-1a0zgr5e7hslc8nvepxxxxx",
    dbEngineVersion: "SQLServer_2019_Std",
    instanceType: "Basic",
    storageSpace: 20,
    vpcId: "vpc-3nqt4kq87xn2893xxxxx",
    instanceName: "RDSMsSQLInstanceDemo",
    superAccountPassword: "********",
    serverCollation: "Chinese_PRC_CI_AS",
    timeZone: "China Standard Time",
    chargeInfo: {
        charge_type: "PostPaid",
    },
    projectName: "default",
    maintenanceTime: "18:00Z-21:59Z",
    allowListIds: ["acl-03f197e136c843b29e47de74e9xxxxx"],
    tags: [{
        key: "env",
        value: "test",
    }],
});

    import pulumi
import pulumi_volcenginecc as volcenginecc

r_dsms_sql_instance_demo = volcenginecc.rdsmssql.Instance("RDSMsSQLInstanceDemo",
    node_spec="rds.mssql.3il.x8.medium.s1",
    zone_id="cn-beijing-a",
    subnet_id="subnet-1a0zgr5e7hslc8nvepxxxxx",
    db_engine_version="SQLServer_2019_Std",
    instance_type="Basic",
    storage_space=20,
    vpc_id="vpc-3nqt4kq87xn2893xxxxx",
    instance_name="RDSMsSQLInstanceDemo",
    super_account_password="********",
    server_collation="Chinese_PRC_CI_AS",
    time_zone="China Standard Time",
    charge_info={
        "charge_type": "PostPaid",
    },
    project_name="default",
    maintenance_time="18:00Z-21:59Z",
    allow_list_ids=["acl-03f197e136c843b29e47de74e9xxxxx"],
    tags=[{
        "key": "env",
        "value": "test",
    }])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rdsmssql.NewInstance(ctx, "RDSMsSQLInstanceDemo", &rdsmssql.InstanceArgs{
			NodeSpec:             pulumi.String("rds.mssql.3il.x8.medium.s1"),
			ZoneId:               pulumi.String("cn-beijing-a"),
			SubnetId:             pulumi.String("subnet-1a0zgr5e7hslc8nvepxxxxx"),
			DbEngineVersion:      pulumi.String("SQLServer_2019_Std"),
			InstanceType:         pulumi.String("Basic"),
			StorageSpace:         pulumi.Int(20),
			VpcId:                pulumi.String("vpc-3nqt4kq87xn2893xxxxx"),
			InstanceName:         pulumi.String("RDSMsSQLInstanceDemo"),
			SuperAccountPassword: pulumi.String("********"),
			ServerCollation:      pulumi.String("Chinese_PRC_CI_AS"),
			TimeZone:             pulumi.String("China Standard Time"),
			ChargeInfo: &rdsmssql.InstanceChargeInfoArgs{
				Charge_type: "PostPaid",
			},
			ProjectName:     pulumi.String("default"),
			MaintenanceTime: pulumi.String("18:00Z-21:59Z"),
			AllowListIds: pulumi.StringArray{
				pulumi.String("acl-03f197e136c843b29e47de74e9xxxxx"),
			},
			Tags: rdsmssql.InstanceTagArray{
				&rdsmssql.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 rDSMsSQLInstanceDemo = new Volcenginecc.Rdsmssql.Instance("RDSMsSQLInstanceDemo", new()
    {
        NodeSpec = "rds.mssql.3il.x8.medium.s1",
        ZoneId = "cn-beijing-a",
        SubnetId = "subnet-1a0zgr5e7hslc8nvepxxxxx",
        DbEngineVersion = "SQLServer_2019_Std",
        InstanceType = "Basic",
        StorageSpace = 20,
        VpcId = "vpc-3nqt4kq87xn2893xxxxx",
        InstanceName = "RDSMsSQLInstanceDemo",
        SuperAccountPassword = "********",
        ServerCollation = "Chinese_PRC_CI_AS",
        TimeZone = "China Standard Time",
        ChargeInfo = new Volcenginecc.Rdsmssql.Inputs.InstanceChargeInfoArgs
        {
            Charge_type = "PostPaid",
        },
        ProjectName = "default",
        MaintenanceTime = "18:00Z-21:59Z",
        AllowListIds = new[]
        {
            "acl-03f197e136c843b29e47de74e9xxxxx",
        },
        Tags = new[]
        {
            new Volcenginecc.Rdsmssql.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.rdsmssql.Instance;
import com.volcengine.volcenginecc.rdsmssql.InstanceArgs;
import com.pulumi.volcenginecc.rdsmssql.inputs.InstanceChargeInfoArgs;
import com.pulumi.volcenginecc.rdsmssql.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 rDSMsSQLInstanceDemo = new Instance("rDSMsSQLInstanceDemo", InstanceArgs.builder()
            .nodeSpec("rds.mssql.3il.x8.medium.s1")
            .zoneId("cn-beijing-a")
            .subnetId("subnet-1a0zgr5e7hslc8nvepxxxxx")
            .dbEngineVersion("SQLServer_2019_Std")
            .instanceType("Basic")
            .storageSpace(20)
            .vpcId("vpc-3nqt4kq87xn2893xxxxx")
            .instanceName("RDSMsSQLInstanceDemo")
            .superAccountPassword("********")
            .serverCollation("Chinese_PRC_CI_AS")
            .timeZone("China Standard Time")
            .chargeInfo(InstanceChargeInfoArgs.builder()
                .charge_type("PostPaid")
                .build())
            .projectName("default")
            .maintenanceTime("18:00Z-21:59Z")
            .allowListIds("acl-03f197e136c843b29e47de74e9xxxxx")
            .tags(InstanceTagArgs.builder()
                .key("env")
                .value("test")
                .build())
            .build());

    }
}

    resources:
  rDSMsSQLInstanceDemo:
    type: volcenginecc:rdsmssql:Instance
    name: RDSMsSQLInstanceDemo
    properties:
      nodeSpec: rds.mssql.3il.x8.medium.s1
      zoneId: cn-beijing-a
      subnetId: subnet-1a0zgr5e7hslc8nvepxxxxx
      dbEngineVersion: SQLServer_2019_Std
      instanceType: Basic
      storageSpace: 20
      vpcId: vpc-3nqt4kq87xn2893xxxxx
      instanceName: RDSMsSQLInstanceDemo
      superAccountPassword: '********'
      serverCollation: Chinese_PRC_CI_AS
      timeZone: China Standard Time
      chargeInfo:
        charge_type: PostPaid
      projectName: default
      maintenanceTime: 18:00Z-21:59Z
      allowListIds:
        - acl-03f197e136c843b29e47de74e9xxxxx
      tags:
        - key: env
          value: test

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

resource "volcenginecc_rdsmssql_instance" "RDSMsSQLInstanceDemo" {
  node_spec              = "rds.mssql.3il.x8.medium.s1"
  zone_id                = "cn-beijing-a"
  subnet_id              = "subnet-1a0zgr5e7hslc8nvepxxxxx"
  db_engine_version      = "SQLServer_2019_Std"
  instance_type          = "Basic"
  storage_space          = 20
  vpc_id                 = "vpc-3nqt4kq87xn2893xxxxx"
  instance_name          = "RDSMsSQLInstanceDemo"
  super_account_password = "********"
  server_collation       = "Chinese_PRC_CI_AS"
  time_zone              = "China Standard Time"
  charge_info = {
    charge_type = "PostPaid"
  }
  project_name     = "default"
  maintenance_time = "18:00Z-21:59Z"
  allow_list_ids   = ["acl-03f197e136c843b29e47de74e9xxxxx"]
  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,
             node_spec: Optional[str] = None,
             zone_id: Optional[str] = None,
             vpc_id: Optional[str] = None,
             time_zone: Optional[str] = None,
             db_engine_version: Optional[str] = None,
             super_account_password: Optional[str] = None,
             instance_type: Optional[str] = None,
             subnet_id: Optional[str] = None,
             storage_space: Optional[int] = None,
             project_name: Optional[str] = None,
             advanced_features: Optional[str] = None,
             server_collation: Optional[str] = None,
             master_node_id: Optional[str] = None,
             maintenance_time: Optional[str] = None,
             instance_name: Optional[str] = None,
             tags: Optional[Sequence[InstanceTagArgs]] = None,
             tde_config: Optional[InstanceTdeConfigArgs] = None,
             cross_backup_policy: Optional[InstanceCrossBackupPolicyArgs] = None,
             charge_info: Optional[InstanceChargeInfoArgs] = None,
             allow_list_ids: Optional[Sequence[str]] = None)
    func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
    public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
    public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)

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


    resource "volcenginecc_rdsmssql_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 exampleinstanceResourceResourceFromRdsmssqlinstance = new Volcenginecc.Rdsmssql.Instance("exampleinstanceResourceResourceFromRdsmssqlinstance", new()
{
    NodeSpec = "string",
    ZoneId = "string",
    VpcId = "string",
    TimeZone = "string",
    DbEngineVersion = "string",
    SuperAccountPassword = "string",
    InstanceType = "string",
    SubnetId = "string",
    StorageSpace = 0,
    ProjectName = "string",
    AdvancedFeatures = "string",
    ServerCollation = "string",
    MasterNodeId = "string",
    MaintenanceTime = "string",
    InstanceName = "string",
    Tags = new[]
    {
        new Volcenginecc.Rdsmssql.Inputs.InstanceTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    TdeConfig = new Volcenginecc.Rdsmssql.Inputs.InstanceTdeConfigArgs
    {
        Certificate = "string",
        DbStatuses = new[]
        {
            new Volcenginecc.Rdsmssql.Inputs.InstanceTdeConfigDbStatusArgs
            {
                DbName = "string",
                Enable = false,
            },
        },
        Password = "string",
        PrivateKey = "string",
        TdeMode = "string",
        TdeStatus = "string",
    },
    CrossBackupPolicy = new Volcenginecc.Rdsmssql.Inputs.InstanceCrossBackupPolicyArgs
    {
        BackupEnabled = false,
        CrossBackupRegion = "string",
        Retention = 0,
    },
    ChargeInfo = new Volcenginecc.Rdsmssql.Inputs.InstanceChargeInfoArgs
    {
        AutoRenew = false,
        ChargeEndTime = "string",
        ChargeStartTime = "string",
        ChargeStatus = "string",
        ChargeType = "string",
        OverdueReclaimTime = "string",
        OverdueTime = "string",
        Period = 0,
        PeriodUnit = "string",
    },
    AllowListIds = new[]
    {
        "string",
    },
});

    example, err := rdsmssql.NewInstance(ctx, "exampleinstanceResourceResourceFromRdsmssqlinstance", &rdsmssql.InstanceArgs{
	NodeSpec:             pulumi.String("string"),
	ZoneId:               pulumi.String("string"),
	VpcId:                pulumi.String("string"),
	TimeZone:             pulumi.String("string"),
	DbEngineVersion:      pulumi.String("string"),
	SuperAccountPassword: pulumi.String("string"),
	InstanceType:         pulumi.String("string"),
	SubnetId:             pulumi.String("string"),
	StorageSpace:         pulumi.Int(0),
	ProjectName:          pulumi.String("string"),
	AdvancedFeatures:     pulumi.String("string"),
	ServerCollation:      pulumi.String("string"),
	MasterNodeId:         pulumi.String("string"),
	MaintenanceTime:      pulumi.String("string"),
	InstanceName:         pulumi.String("string"),
	Tags: rdsmssql.InstanceTagArray{
		&rdsmssql.InstanceTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	TdeConfig: &rdsmssql.InstanceTdeConfigArgs{
		Certificate: pulumi.String("string"),
		DbStatuses: rdsmssql.InstanceTdeConfigDbStatusArray{
			&rdsmssql.InstanceTdeConfigDbStatusArgs{
				DbName: pulumi.String("string"),
				Enable: pulumi.Bool(false),
			},
		},
		Password:   pulumi.String("string"),
		PrivateKey: pulumi.String("string"),
		TdeMode:    pulumi.String("string"),
		TdeStatus:  pulumi.String("string"),
	},
	CrossBackupPolicy: &rdsmssql.InstanceCrossBackupPolicyArgs{
		BackupEnabled:     pulumi.Bool(false),
		CrossBackupRegion: pulumi.String("string"),
		Retention:         pulumi.Int(0),
	},
	ChargeInfo: &rdsmssql.InstanceChargeInfoArgs{
		AutoRenew:          pulumi.Bool(false),
		ChargeEndTime:      pulumi.String("string"),
		ChargeStartTime:    pulumi.String("string"),
		ChargeStatus:       pulumi.String("string"),
		ChargeType:         pulumi.String("string"),
		OverdueReclaimTime: pulumi.String("string"),
		OverdueTime:        pulumi.String("string"),
		Period:             pulumi.Int(0),
		PeriodUnit:         pulumi.String("string"),
	},
	AllowListIds: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    resource "volcenginecc_rdsmssql_instance" "exampleinstanceResourceResourceFromRdsmssqlinstance" {
  lifecycle {
    create_before_destroy = true
  }
  node_spec              = "string"
  zone_id                = "string"
  vpc_id                 = "string"
  time_zone              = "string"
  db_engine_version      = "string"
  super_account_password = "string"
  instance_type          = "string"
  subnet_id              = "string"
  storage_space          = 0
  project_name           = "string"
  advanced_features      = "string"
  server_collation       = "string"
  master_node_id         = "string"
  maintenance_time       = "string"
  instance_name          = "string"
  tags {
    key   = "string"
    value = "string"
  }
  tde_config = {
    certificate = "string"
    db_statuses = [{
      db_name = "string"
      enable  = false
    }]
    password    = "string"
    private_key = "string"
    tde_mode    = "string"
    tde_status  = "string"
  }
  cross_backup_policy = {
    backup_enabled      = false
    cross_backup_region = "string"
    retention           = 0
  }
  charge_info = {
    auto_renew           = false
    charge_end_time      = "string"
    charge_start_time    = "string"
    charge_status        = "string"
    charge_type          = "string"
    overdue_reclaim_time = "string"
    overdue_time         = "string"
    period               = 0
    period_unit          = "string"
  }
  allow_list_ids = ["string"]
}

    var exampleinstanceResourceResourceFromRdsmssqlinstance = new com.volcengine.volcenginecc.rdsmssql.Instance("exampleinstanceResourceResourceFromRdsmssqlinstance", com.volcengine.volcenginecc.rdsmssql.InstanceArgs.builder()
    .nodeSpec("string")
    .zoneId("string")
    .vpcId("string")
    .timeZone("string")
    .dbEngineVersion("string")
    .superAccountPassword("string")
    .instanceType("string")
    .subnetId("string")
    .storageSpace(0)
    .projectName("string")
    .advancedFeatures("string")
    .serverCollation("string")
    .masterNodeId("string")
    .maintenanceTime("string")
    .instanceName("string")
    .tags(com.pulumi.volcenginecc.rdsmssql.inputs.InstanceTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .tdeConfig(InstanceTdeConfigArgs.builder()
        .certificate("string")
        .dbStatuses(InstanceTdeConfigDbStatusArgs.builder()
            .dbName("string")
            .enable(false)
            .build())
        .password("string")
        .privateKey("string")
        .tdeMode("string")
        .tdeStatus("string")
        .build())
    .crossBackupPolicy(InstanceCrossBackupPolicyArgs.builder()
        .backupEnabled(false)
        .crossBackupRegion("string")
        .retention(0)
        .build())
    .chargeInfo(com.pulumi.volcenginecc.rdsmssql.inputs.InstanceChargeInfoArgs.builder()
        .autoRenew(false)
        .chargeEndTime("string")
        .chargeStartTime("string")
        .chargeStatus("string")
        .chargeType("string")
        .overdueReclaimTime("string")
        .overdueTime("string")
        .period(0)
        .periodUnit("string")
        .build())
    .allowListIds("string")
    .build());

    exampleinstance_resource_resource_from_rdsmssqlinstance = volcenginecc.rdsmssql.Instance("exampleinstanceResourceResourceFromRdsmssqlinstance",
    node_spec="string",
    zone_id="string",
    vpc_id="string",
    time_zone="string",
    db_engine_version="string",
    super_account_password="string",
    instance_type="string",
    subnet_id="string",
    storage_space=0,
    project_name="string",
    advanced_features="string",
    server_collation="string",
    master_node_id="string",
    maintenance_time="string",
    instance_name="string",
    tags=[{
        "key": "string",
        "value": "string",
    }],
    tde_config={
        "certificate": "string",
        "db_statuses": [{
            "db_name": "string",
            "enable": False,
        }],
        "password": "string",
        "private_key": "string",
        "tde_mode": "string",
        "tde_status": "string",
    },
    cross_backup_policy={
        "backup_enabled": False,
        "cross_backup_region": "string",
        "retention": 0,
    },
    charge_info={
        "auto_renew": False,
        "charge_end_time": "string",
        "charge_start_time": "string",
        "charge_status": "string",
        "charge_type": "string",
        "overdue_reclaim_time": "string",
        "overdue_time": "string",
        "period": 0,
        "period_unit": "string",
    },
    allow_list_ids=["string"])

    const exampleinstanceResourceResourceFromRdsmssqlinstance = new volcenginecc.rdsmssql.Instance("exampleinstanceResourceResourceFromRdsmssqlinstance", {
    nodeSpec: "string",
    zoneId: "string",
    vpcId: "string",
    timeZone: "string",
    dbEngineVersion: "string",
    superAccountPassword: "string",
    instanceType: "string",
    subnetId: "string",
    storageSpace: 0,
    projectName: "string",
    advancedFeatures: "string",
    serverCollation: "string",
    masterNodeId: "string",
    maintenanceTime: "string",
    instanceName: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
    tdeConfig: {
        certificate: "string",
        dbStatuses: [{
            dbName: "string",
            enable: false,
        }],
        password: "string",
        privateKey: "string",
        tdeMode: "string",
        tdeStatus: "string",
    },
    crossBackupPolicy: {
        backupEnabled: false,
        crossBackupRegion: "string",
        retention: 0,
    },
    chargeInfo: {
        autoRenew: false,
        chargeEndTime: "string",
        chargeStartTime: "string",
        chargeStatus: "string",
        chargeType: "string",
        overdueReclaimTime: "string",
        overdueTime: "string",
        period: 0,
        periodUnit: "string",
    },
    allowListIds: ["string"],
});

    type: volcenginecc:rdsmssql:Instance
properties:
    advancedFeatures: string
    allowListIds:
        - string
    chargeInfo:
        autoRenew: false
        chargeEndTime: string
        chargeStartTime: string
        chargeStatus: string
        chargeType: string
        overdueReclaimTime: string
        overdueTime: string
        period: 0
        periodUnit: string
    crossBackupPolicy:
        backupEnabled: false
        crossBackupRegion: string
        retention: 0
    dbEngineVersion: string
    instanceName: string
    instanceType: string
    maintenanceTime: string
    masterNodeId: string
    nodeSpec: string
    projectName: string
    serverCollation: string
    storageSpace: 0
    subnetId: string
    superAccountPassword: string
    tags:
        - key: string
          value: string
    tdeConfig:
        certificate: string
        dbStatuses:
            - dbName: string
              enable: false
        password: string
        privateKey: string
        tdeMode: string
        tdeStatus: string
    timeZone: string
    vpcId: string
    zoneId: 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:

    DbEngineVersion string
    Compatible version. Values: SQLServer2019Std: SQL Server 2019 Standard Edition. SQLServer2019Ent: SQL Server 2019 Enterprise Edition. SQLServer2019Web: SQL Server 2019 Web Edition. SQLServer2022Std: SQL Server 2022 Standard Edition. SQLServer2022Ent: SQL Server 2022 Enterprise Edition. SQLServer2022Web: SQL Server 2022 Web Edition.
    InstanceType string
    Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.
    NodeSpec string
    Instance specification code.
    StorageSpace int
    Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
    SubnetId string
    Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.
    SuperAccountPassword string
    Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^&*()_+-=.
    TimeZone string
    Time zone.
    VpcId string
    VPC ID
    ZoneId string
    Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.
    AdvancedFeatures string
    Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
    AllowListIds List<string>
    Allowlist ID list permitted for access.
    ChargeInfo Volcengine.InstanceChargeInfo
    Payment method.
    CrossBackupPolicy Volcengine.InstanceCrossBackupPolicy
    Cross-region backup policy.
    InstanceName string
    Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.
    MaintenanceTime string
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.
    MasterNodeId string
    Primary node ID. This parameter is required when manually switching master and standby nodes.
    ProjectName string
    Project.
    ServerCollation string
    Instance collation. Default: ChinesePRCCIAS. Most native collations are supported. Available values: Latin1GeneralCIAS, Latin1GeneralCSAS, SQLLatin1GeneralCP1CIAS, SQLLatin1GeneralCP1CSAS, ChinesePRCCIAS, ChinesePRCCSAS, ChinesePRCBIN, JapaneseCIAS, JapaneseCSAS, ChineseTaiwanStrokeCIAS, ChineseTaiwanStrokeCSAS, ThaiCIAS, ChinesePRCCIAI, ChinesePRCBIN2, CyrillicGeneralCI_AS.
    Tags List<Volcengine.InstanceTag>
    Tag 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.
    TdeConfig Volcengine.InstanceTdeConfig
    Instance TDE configuration.
    DbEngineVersion string
    Compatible version. Values: SQLServer2019Std: SQL Server 2019 Standard Edition. SQLServer2019Ent: SQL Server 2019 Enterprise Edition. SQLServer2019Web: SQL Server 2019 Web Edition. SQLServer2022Std: SQL Server 2022 Standard Edition. SQLServer2022Ent: SQL Server 2022 Enterprise Edition. SQLServer2022Web: SQL Server 2022 Web Edition.
    InstanceType string
    Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.
    NodeSpec string
    Instance specification code.
    StorageSpace int
    Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
    SubnetId string
    Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.
    SuperAccountPassword string
    Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^&*()_+-=.
    TimeZone string
    Time zone.
    VpcId string
    VPC ID
    ZoneId string
    Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.
    AdvancedFeatures string
    Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
    AllowListIds []string
    Allowlist ID list permitted for access.
    ChargeInfo InstanceChargeInfoArgs
    Payment method.
    CrossBackupPolicy InstanceCrossBackupPolicyArgs
    Cross-region backup policy.
    InstanceName string
    Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.
    MaintenanceTime string
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.
    MasterNodeId string
    Primary node ID. This parameter is required when manually switching master and standby nodes.
    ProjectName string
    Project.
    ServerCollation string
    Instance collation. Default: ChinesePRCCIAS. Most native collations are supported. Available values: Latin1GeneralCIAS, Latin1GeneralCSAS, SQLLatin1GeneralCP1CIAS, SQLLatin1GeneralCP1CSAS, ChinesePRCCIAS, ChinesePRCCSAS, ChinesePRCBIN, JapaneseCIAS, JapaneseCSAS, ChineseTaiwanStrokeCIAS, ChineseTaiwanStrokeCSAS, ThaiCIAS, ChinesePRCCIAI, ChinesePRCBIN2, CyrillicGeneralCI_AS.
    Tags []InstanceTagArgs
    Tag 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.
    TdeConfig InstanceTdeConfigArgs
    Instance TDE configuration.
    db_engine_version string
    Compatible version. Values: SQLServer2019Std: SQL Server 2019 Standard Edition. SQLServer2019Ent: SQL Server 2019 Enterprise Edition. SQLServer2019Web: SQL Server 2019 Web Edition. SQLServer2022Std: SQL Server 2022 Standard Edition. SQLServer2022Ent: SQL Server 2022 Enterprise Edition. SQLServer2022Web: SQL Server 2022 Web Edition.
    instance_type string
    Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.
    node_spec string
    Instance specification code.
    storage_space number
    Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
    subnet_id string
    Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.
    super_account_password string
    Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^&*()_+-=.
    time_zone string
    Time zone.
    vpc_id string
    VPC ID
    zone_id string
    Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.
    advanced_features string
    Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
    allow_list_ids list(string)
    Allowlist ID list permitted for access.
    charge_info object
    Payment method.
    cross_backup_policy object
    Cross-region backup policy.
    instance_name string
    Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.
    maintenance_time string
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.
    master_node_id string
    Primary node ID. This parameter is required when manually switching master and standby nodes.
    project_name string
    Project.
    server_collation string
    Instance collation. Default: ChinesePRCCIAS. Most native collations are supported. Available values: Latin1GeneralCIAS, Latin1GeneralCSAS, SQLLatin1GeneralCP1CIAS, SQLLatin1GeneralCP1CSAS, ChinesePRCCIAS, ChinesePRCCSAS, ChinesePRCBIN, JapaneseCIAS, JapaneseCSAS, ChineseTaiwanStrokeCIAS, ChineseTaiwanStrokeCSAS, ThaiCIAS, ChinesePRCCIAI, ChinesePRCBIN2, CyrillicGeneralCI_AS.
    tags list(object)
    Tag 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.
    tde_config object
    Instance TDE configuration.
    dbEngineVersion String
    Compatible version. Values: SQLServer2019Std: SQL Server 2019 Standard Edition. SQLServer2019Ent: SQL Server 2019 Enterprise Edition. SQLServer2019Web: SQL Server 2019 Web Edition. SQLServer2022Std: SQL Server 2022 Standard Edition. SQLServer2022Ent: SQL Server 2022 Enterprise Edition. SQLServer2022Web: SQL Server 2022 Web Edition.
    instanceType String
    Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.
    nodeSpec String
    Instance specification code.
    storageSpace Integer
    Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
    subnetId String
    Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.
    superAccountPassword String
    Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^&*()_+-=.
    timeZone String
    Time zone.
    vpcId String
    VPC ID
    zoneId String
    Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.
    advancedFeatures String
    Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
    allowListIds List<String>
    Allowlist ID list permitted for access.
    chargeInfo InstanceChargeInfo
    Payment method.
    crossBackupPolicy InstanceCrossBackupPolicy
    Cross-region backup policy.
    instanceName String
    Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.
    maintenanceTime String
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.
    masterNodeId String
    Primary node ID. This parameter is required when manually switching master and standby nodes.
    projectName String
    Project.
    serverCollation String
    Instance collation. Default: ChinesePRCCIAS. Most native collations are supported. Available values: Latin1GeneralCIAS, Latin1GeneralCSAS, SQLLatin1GeneralCP1CIAS, SQLLatin1GeneralCP1CSAS, ChinesePRCCIAS, ChinesePRCCSAS, ChinesePRCBIN, JapaneseCIAS, JapaneseCSAS, ChineseTaiwanStrokeCIAS, ChineseTaiwanStrokeCSAS, ThaiCIAS, ChinesePRCCIAI, ChinesePRCBIN2, CyrillicGeneralCI_AS.
    tags List<InstanceTag>
    Tag 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.
    tdeConfig InstanceTdeConfig
    Instance TDE configuration.
    dbEngineVersion string
    Compatible version. Values: SQLServer2019Std: SQL Server 2019 Standard Edition. SQLServer2019Ent: SQL Server 2019 Enterprise Edition. SQLServer2019Web: SQL Server 2019 Web Edition. SQLServer2022Std: SQL Server 2022 Standard Edition. SQLServer2022Ent: SQL Server 2022 Enterprise Edition. SQLServer2022Web: SQL Server 2022 Web Edition.
    instanceType string
    Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.
    nodeSpec string
    Instance specification code.
    storageSpace number
    Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
    subnetId string
    Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.
    superAccountPassword string
    Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^&*()_+-=.
    timeZone string
    Time zone.
    vpcId string
    VPC ID
    zoneId string
    Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.
    advancedFeatures string
    Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
    allowListIds string[]
    Allowlist ID list permitted for access.
    chargeInfo InstanceChargeInfo
    Payment method.
    crossBackupPolicy InstanceCrossBackupPolicy
    Cross-region backup policy.
    instanceName string
    Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.
    maintenanceTime string
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.
    masterNodeId string
    Primary node ID. This parameter is required when manually switching master and standby nodes.
    projectName string
    Project.
    serverCollation string
    Instance collation. Default: ChinesePRCCIAS. Most native collations are supported. Available values: Latin1GeneralCIAS, Latin1GeneralCSAS, SQLLatin1GeneralCP1CIAS, SQLLatin1GeneralCP1CSAS, ChinesePRCCIAS, ChinesePRCCSAS, ChinesePRCBIN, JapaneseCIAS, JapaneseCSAS, ChineseTaiwanStrokeCIAS, ChineseTaiwanStrokeCSAS, ThaiCIAS, ChinesePRCCIAI, ChinesePRCBIN2, CyrillicGeneralCI_AS.
    tags InstanceTag[]
    Tag 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.
    tdeConfig InstanceTdeConfig
    Instance TDE configuration.
    db_engine_version str
    Compatible version. Values: SQLServer2019Std: SQL Server 2019 Standard Edition. SQLServer2019Ent: SQL Server 2019 Enterprise Edition. SQLServer2019Web: SQL Server 2019 Web Edition. SQLServer2022Std: SQL Server 2022 Standard Edition. SQLServer2022Ent: SQL Server 2022 Enterprise Edition. SQLServer2022Web: SQL Server 2022 Web Edition.
    instance_type str
    Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.
    node_spec str
    Instance specification code.
    storage_space int
    Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
    subnet_id str
    Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.
    super_account_password str
    Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^&*()_+-=.
    time_zone str
    Time zone.
    vpc_id str
    VPC ID
    zone_id str
    Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.
    advanced_features str
    Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
    allow_list_ids Sequence[str]
    Allowlist ID list permitted for access.
    charge_info InstanceChargeInfoArgs
    Payment method.
    cross_backup_policy InstanceCrossBackupPolicyArgs
    Cross-region backup policy.
    instance_name str
    Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.
    maintenance_time str
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.
    master_node_id str
    Primary node ID. This parameter is required when manually switching master and standby nodes.
    project_name str
    Project.
    server_collation str
    Instance collation. Default: ChinesePRCCIAS. Most native collations are supported. Available values: Latin1GeneralCIAS, Latin1GeneralCSAS, SQLLatin1GeneralCP1CIAS, SQLLatin1GeneralCP1CSAS, ChinesePRCCIAS, ChinesePRCCSAS, ChinesePRCBIN, JapaneseCIAS, JapaneseCSAS, ChineseTaiwanStrokeCIAS, ChineseTaiwanStrokeCSAS, ThaiCIAS, ChinesePRCCIAI, ChinesePRCBIN2, CyrillicGeneralCI_AS.
    tags Sequence[InstanceTagArgs]
    Tag 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.
    tde_config InstanceTdeConfigArgs
    Instance TDE configuration.
    dbEngineVersion String
    Compatible version. Values: SQLServer2019Std: SQL Server 2019 Standard Edition. SQLServer2019Ent: SQL Server 2019 Enterprise Edition. SQLServer2019Web: SQL Server 2019 Web Edition. SQLServer2022Std: SQL Server 2022 Standard Edition. SQLServer2022Ent: SQL Server 2022 Enterprise Edition. SQLServer2022Web: SQL Server 2022 Web Edition.
    instanceType String
    Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.
    nodeSpec String
    Instance specification code.
    storageSpace Number
    Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
    subnetId String
    Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.
    superAccountPassword String
    Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^&*()_+-=.
    timeZone String
    Time zone.
    vpcId String
    VPC ID
    zoneId String
    Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.
    advancedFeatures String
    Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
    allowListIds List<String>
    Allowlist ID list permitted for access.
    chargeInfo Property Map
    Payment method.
    crossBackupPolicy Property Map
    Cross-region backup policy.
    instanceName String
    Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.
    maintenanceTime String
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.
    masterNodeId String
    Primary node ID. This parameter is required when manually switching master and standby nodes.
    projectName String
    Project.
    serverCollation String
    Instance collation. Default: ChinesePRCCIAS. Most native collations are supported. Available values: Latin1GeneralCIAS, Latin1GeneralCSAS, SQLLatin1GeneralCP1CIAS, SQLLatin1GeneralCP1CSAS, ChinesePRCCIAS, ChinesePRCCSAS, ChinesePRCBIN, JapaneseCIAS, JapaneseCSAS, ChineseTaiwanStrokeCIAS, ChineseTaiwanStrokeCSAS, ThaiCIAS, ChinesePRCCIAI, ChinesePRCBIN2, CyrillicGeneralCI_AS.
    tags List<Property Map>
    Tag 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.
    tdeConfig Property Map
    Instance TDE configuration.

    Outputs

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

    AvailableCrossRegions List<string>
    List of cross-region backup destination regions.
    BackupUse double
    Used backup space for the instance, in GiB.
    ConnectionInfos List<Volcengine.InstanceConnectionInfo>
    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.
    CreatedTime string
    Creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    InnerVersion string
    Kernel version number.
    InstanceCategory string
    Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
    InstanceId string
    Instance ID.
    InstanceStatus string
    Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
    Memory int
    Memory size, in GiB.
    NodeDetailInfos List<Volcengine.InstanceNodeDetailInfo>
    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.
    Port string
    Port.
    PrimaryInstanceId string
    Primary instance ID. If this field is empty, this instance is the primary instance.
    ReadOnlyNumber int
    Number of read-only instances.
    SlowQueryEnable bool
    Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
    SlowQueryTime string
    Slow log threshold. Range: [1~10], unit: seconds (s).
    StorageType string
    Instance storage type.
    StorageUse double
    Used storage space for the instance. Unit: GiB.
    UpdatedTime string
    Update time.
    Vcpu int
    CPU size. For example: 1 means 1 core.
    AvailableCrossRegions []string
    List of cross-region backup destination regions.
    BackupUse float64
    Used backup space for the instance, in GiB.
    ConnectionInfos []InstanceConnectionInfo
    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.
    CreatedTime string
    Creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    InnerVersion string
    Kernel version number.
    InstanceCategory string
    Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
    InstanceId string
    Instance ID.
    InstanceStatus string
    Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
    Memory int
    Memory size, in GiB.
    NodeDetailInfos []InstanceNodeDetailInfo
    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.
    Port string
    Port.
    PrimaryInstanceId string
    Primary instance ID. If this field is empty, this instance is the primary instance.
    ReadOnlyNumber int
    Number of read-only instances.
    SlowQueryEnable bool
    Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
    SlowQueryTime string
    Slow log threshold. Range: [1~10], unit: seconds (s).
    StorageType string
    Instance storage type.
    StorageUse float64
    Used storage space for the instance. Unit: GiB.
    UpdatedTime string
    Update time.
    Vcpu int
    CPU size. For example: 1 means 1 core.
    available_cross_regions list(string)
    List of cross-region backup destination regions.
    backup_use number
    Used backup space for the instance, in GiB.
    connection_infos list(object)
    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.
    created_time string
    Creation time.
    id string
    The provider-assigned unique ID for this managed resource.
    inner_version string
    Kernel version number.
    instance_category string
    Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
    instance_id string
    Instance ID.
    instance_status string
    Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
    memory number
    Memory size, in GiB.
    node_detail_infos 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.
    port string
    Port.
    primary_instance_id string
    Primary instance ID. If this field is empty, this instance is the primary instance.
    read_only_number number
    Number of read-only instances.
    slow_query_enable bool
    Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
    slow_query_time string
    Slow log threshold. Range: [1~10], unit: seconds (s).
    storage_type string
    Instance storage type.
    storage_use number
    Used storage space for the instance. Unit: GiB.
    updated_time string
    Update time.
    vcpu number
    CPU size. For example: 1 means 1 core.
    availableCrossRegions List<String>
    List of cross-region backup destination regions.
    backupUse Double
    Used backup space for the instance, in GiB.
    connectionInfos List<InstanceConnectionInfo>
    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.
    createdTime String
    Creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    innerVersion String
    Kernel version number.
    instanceCategory String
    Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
    instanceId String
    Instance ID.
    instanceStatus String
    Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
    memory Integer
    Memory size, in GiB.
    nodeDetailInfos List<InstanceNodeDetailInfo>
    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.
    port String
    Port.
    primaryInstanceId String
    Primary instance ID. If this field is empty, this instance is the primary instance.
    readOnlyNumber Integer
    Number of read-only instances.
    slowQueryEnable Boolean
    Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
    slowQueryTime String
    Slow log threshold. Range: [1~10], unit: seconds (s).
    storageType String
    Instance storage type.
    storageUse Double
    Used storage space for the instance. Unit: GiB.
    updatedTime String
    Update time.
    vcpu Integer
    CPU size. For example: 1 means 1 core.
    availableCrossRegions string[]
    List of cross-region backup destination regions.
    backupUse number
    Used backup space for the instance, in GiB.
    connectionInfos InstanceConnectionInfo[]
    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.
    createdTime string
    Creation time.
    id string
    The provider-assigned unique ID for this managed resource.
    innerVersion string
    Kernel version number.
    instanceCategory string
    Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
    instanceId string
    Instance ID.
    instanceStatus string
    Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
    memory number
    Memory size, in GiB.
    nodeDetailInfos InstanceNodeDetailInfo[]
    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.
    port string
    Port.
    primaryInstanceId string
    Primary instance ID. If this field is empty, this instance is the primary instance.
    readOnlyNumber number
    Number of read-only instances.
    slowQueryEnable boolean
    Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
    slowQueryTime string
    Slow log threshold. Range: [1~10], unit: seconds (s).
    storageType string
    Instance storage type.
    storageUse number
    Used storage space for the instance. Unit: GiB.
    updatedTime string
    Update time.
    vcpu number
    CPU size. For example: 1 means 1 core.
    available_cross_regions Sequence[str]
    List of cross-region backup destination regions.
    backup_use float
    Used backup space for the instance, in GiB.
    connection_infos Sequence[InstanceConnectionInfo]
    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.
    created_time str
    Creation time.
    id str
    The provider-assigned unique ID for this managed resource.
    inner_version str
    Kernel version number.
    instance_category str
    Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
    instance_id str
    Instance ID.
    instance_status str
    Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
    memory int
    Memory size, in GiB.
    node_detail_infos Sequence[InstanceNodeDetailInfo]
    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.
    port str
    Port.
    primary_instance_id str
    Primary instance ID. If this field is empty, this instance is the primary instance.
    read_only_number int
    Number of read-only instances.
    slow_query_enable bool
    Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
    slow_query_time str
    Slow log threshold. Range: [1~10], unit: seconds (s).
    storage_type str
    Instance storage type.
    storage_use float
    Used storage space for the instance. Unit: GiB.
    updated_time str
    Update time.
    vcpu int
    CPU size. For example: 1 means 1 core.
    availableCrossRegions List<String>
    List of cross-region backup destination regions.
    backupUse Number
    Used backup space for the instance, in GiB.
    connectionInfos List<Property Map>
    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.
    createdTime String
    Creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    innerVersion String
    Kernel version number.
    instanceCategory String
    Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
    instanceId String
    Instance ID.
    instanceStatus String
    Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
    memory Number
    Memory size, in GiB.
    nodeDetailInfos 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.
    port String
    Port.
    primaryInstanceId String
    Primary instance ID. If this field is empty, this instance is the primary instance.
    readOnlyNumber Number
    Number of read-only instances.
    slowQueryEnable Boolean
    Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
    slowQueryTime String
    Slow log threshold. Range: [1~10], unit: seconds (s).
    storageType String
    Instance storage type.
    storageUse Number
    Used storage space for the instance. Unit: GiB.
    updatedTime String
    Update time.
    vcpu Number
    CPU size. For example: 1 means 1 core.

    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,
        advanced_features: Optional[str] = None,
        allow_list_ids: Optional[Sequence[str]] = None,
        available_cross_regions: Optional[Sequence[str]] = None,
        backup_use: Optional[float] = None,
        charge_info: Optional[InstanceChargeInfoArgs] = None,
        connection_infos: Optional[Sequence[InstanceConnectionInfoArgs]] = None,
        created_time: Optional[str] = None,
        cross_backup_policy: Optional[InstanceCrossBackupPolicyArgs] = None,
        db_engine_version: Optional[str] = None,
        inner_version: Optional[str] = None,
        instance_category: Optional[str] = None,
        instance_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        instance_status: Optional[str] = None,
        instance_type: Optional[str] = None,
        maintenance_time: Optional[str] = None,
        master_node_id: Optional[str] = None,
        memory: Optional[int] = None,
        node_detail_infos: Optional[Sequence[InstanceNodeDetailInfoArgs]] = None,
        node_spec: Optional[str] = None,
        port: Optional[str] = None,
        primary_instance_id: Optional[str] = None,
        project_name: Optional[str] = None,
        read_only_number: Optional[int] = None,
        server_collation: Optional[str] = None,
        slow_query_enable: Optional[bool] = None,
        slow_query_time: Optional[str] = None,
        storage_space: Optional[int] = None,
        storage_type: Optional[str] = None,
        storage_use: Optional[float] = None,
        subnet_id: Optional[str] = None,
        super_account_password: Optional[str] = None,
        tags: Optional[Sequence[InstanceTagArgs]] = None,
        tde_config: Optional[InstanceTdeConfigArgs] = 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) -> 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:rdsmssql:Instance    get:      id: ${id}
    import {
  to = volcenginecc_rdsmssql_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:
    AdvancedFeatures string
    Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
    AllowListIds List<string>
    Allowlist ID list permitted for access.
    AvailableCrossRegions List<string>
    List of cross-region backup destination regions.
    BackupUse double
    Used backup space for the instance, in GiB.
    ChargeInfo Volcengine.InstanceChargeInfo
    Payment method.
    ConnectionInfos List<Volcengine.InstanceConnectionInfo>
    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.
    CreatedTime string
    Creation time.
    CrossBackupPolicy Volcengine.InstanceCrossBackupPolicy
    Cross-region backup policy.
    DbEngineVersion string
    Compatible version. Values: SQLServer2019Std: SQL Server 2019 Standard Edition. SQLServer2019Ent: SQL Server 2019 Enterprise Edition. SQLServer2019Web: SQL Server 2019 Web Edition. SQLServer2022Std: SQL Server 2022 Standard Edition. SQLServer2022Ent: SQL Server 2022 Enterprise Edition. SQLServer2022Web: SQL Server 2022 Web Edition.
    InnerVersion string
    Kernel version number.
    InstanceCategory string
    Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
    InstanceId string
    Instance ID.
    InstanceName string
    Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.
    InstanceStatus string
    Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
    InstanceType string
    Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.
    MaintenanceTime string
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.
    MasterNodeId string
    Primary node ID. This parameter is required when manually switching master and standby nodes.
    Memory int
    Memory size, in GiB.
    NodeDetailInfos List<Volcengine.InstanceNodeDetailInfo>
    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.
    NodeSpec string
    Instance specification code.
    Port string
    Port.
    PrimaryInstanceId string
    Primary instance ID. If this field is empty, this instance is the primary instance.
    ProjectName string
    Project.
    ReadOnlyNumber int
    Number of read-only instances.
    ServerCollation string
    Instance collation. Default: ChinesePRCCIAS. Most native collations are supported. Available values: Latin1GeneralCIAS, Latin1GeneralCSAS, SQLLatin1GeneralCP1CIAS, SQLLatin1GeneralCP1CSAS, ChinesePRCCIAS, ChinesePRCCSAS, ChinesePRCBIN, JapaneseCIAS, JapaneseCSAS, ChineseTaiwanStrokeCIAS, ChineseTaiwanStrokeCSAS, ThaiCIAS, ChinesePRCCIAI, ChinesePRCBIN2, CyrillicGeneralCI_AS.
    SlowQueryEnable bool
    Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
    SlowQueryTime string
    Slow log threshold. Range: [1~10], unit: seconds (s).
    StorageSpace int
    Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
    StorageType string
    Instance storage type.
    StorageUse double
    Used storage space for the instance. Unit: GiB.
    SubnetId string
    Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.
    SuperAccountPassword string
    Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^&*()_+-=.
    Tags List<Volcengine.InstanceTag>
    Tag 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.
    TdeConfig Volcengine.InstanceTdeConfig
    Instance TDE configuration.
    TimeZone string
    Time zone.
    UpdatedTime string
    Update time.
    Vcpu int
    CPU size. For example: 1 means 1 core.
    VpcId string
    VPC ID
    ZoneId string
    Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.
    AdvancedFeatures string
    Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
    AllowListIds []string
    Allowlist ID list permitted for access.
    AvailableCrossRegions []string
    List of cross-region backup destination regions.
    BackupUse float64
    Used backup space for the instance, in GiB.
    ChargeInfo InstanceChargeInfoArgs
    Payment method.
    ConnectionInfos []InstanceConnectionInfoArgs
    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.
    CreatedTime string
    Creation time.
    CrossBackupPolicy InstanceCrossBackupPolicyArgs
    Cross-region backup policy.
    DbEngineVersion string
    Compatible version. Values: SQLServer2019Std: SQL Server 2019 Standard Edition. SQLServer2019Ent: SQL Server 2019 Enterprise Edition. SQLServer2019Web: SQL Server 2019 Web Edition. SQLServer2022Std: SQL Server 2022 Standard Edition. SQLServer2022Ent: SQL Server 2022 Enterprise Edition. SQLServer2022Web: SQL Server 2022 Web Edition.
    InnerVersion string
    Kernel version number.
    InstanceCategory string
    Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
    InstanceId string
    Instance ID.
    InstanceName string
    Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.
    InstanceStatus string
    Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
    InstanceType string
    Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.
    MaintenanceTime string
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.
    MasterNodeId string
    Primary node ID. This parameter is required when manually switching master and standby nodes.
    Memory int
    Memory size, in GiB.
    NodeDetailInfos []InstanceNodeDetailInfoArgs
    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.
    NodeSpec string
    Instance specification code.
    Port string
    Port.
    PrimaryInstanceId string
    Primary instance ID. If this field is empty, this instance is the primary instance.
    ProjectName string
    Project.
    ReadOnlyNumber int
    Number of read-only instances.
    ServerCollation string
    Instance collation. Default: ChinesePRCCIAS. Most native collations are supported. Available values: Latin1GeneralCIAS, Latin1GeneralCSAS, SQLLatin1GeneralCP1CIAS, SQLLatin1GeneralCP1CSAS, ChinesePRCCIAS, ChinesePRCCSAS, ChinesePRCBIN, JapaneseCIAS, JapaneseCSAS, ChineseTaiwanStrokeCIAS, ChineseTaiwanStrokeCSAS, ThaiCIAS, ChinesePRCCIAI, ChinesePRCBIN2, CyrillicGeneralCI_AS.
    SlowQueryEnable bool
    Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
    SlowQueryTime string
    Slow log threshold. Range: [1~10], unit: seconds (s).
    StorageSpace int
    Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
    StorageType string
    Instance storage type.
    StorageUse float64
    Used storage space for the instance. Unit: GiB.
    SubnetId string
    Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.
    SuperAccountPassword string
    Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^&*()_+-=.
    Tags []InstanceTagArgs
    Tag 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.
    TdeConfig InstanceTdeConfigArgs
    Instance TDE configuration.
    TimeZone string
    Time zone.
    UpdatedTime string
    Update time.
    Vcpu int
    CPU size. For example: 1 means 1 core.
    VpcId string
    VPC ID
    ZoneId string
    Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.
    advanced_features string
    Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
    allow_list_ids list(string)
    Allowlist ID list permitted for access.
    available_cross_regions list(string)
    List of cross-region backup destination regions.
    backup_use number
    Used backup space for the instance, in GiB.
    charge_info object
    Payment method.
    connection_infos list(object)
    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.
    created_time string
    Creation time.
    cross_backup_policy object
    Cross-region backup policy.
    db_engine_version string
    Compatible version. Values: SQLServer2019Std: SQL Server 2019 Standard Edition. SQLServer2019Ent: SQL Server 2019 Enterprise Edition. SQLServer2019Web: SQL Server 2019 Web Edition. SQLServer2022Std: SQL Server 2022 Standard Edition. SQLServer2022Ent: SQL Server 2022 Enterprise Edition. SQLServer2022Web: SQL Server 2022 Web Edition.
    inner_version string
    Kernel version number.
    instance_category string
    Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
    instance_id string
    Instance ID.
    instance_name string
    Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.
    instance_status string
    Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
    instance_type string
    Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.
    maintenance_time string
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.
    master_node_id string
    Primary node ID. This parameter is required when manually switching master and standby nodes.
    memory number
    Memory size, in GiB.
    node_detail_infos 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.
    node_spec string
    Instance specification code.
    port string
    Port.
    primary_instance_id string
    Primary instance ID. If this field is empty, this instance is the primary instance.
    project_name string
    Project.
    read_only_number number
    Number of read-only instances.
    server_collation string
    Instance collation. Default: ChinesePRCCIAS. Most native collations are supported. Available values: Latin1GeneralCIAS, Latin1GeneralCSAS, SQLLatin1GeneralCP1CIAS, SQLLatin1GeneralCP1CSAS, ChinesePRCCIAS, ChinesePRCCSAS, ChinesePRCBIN, JapaneseCIAS, JapaneseCSAS, ChineseTaiwanStrokeCIAS, ChineseTaiwanStrokeCSAS, ThaiCIAS, ChinesePRCCIAI, ChinesePRCBIN2, CyrillicGeneralCI_AS.
    slow_query_enable bool
    Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
    slow_query_time string
    Slow log threshold. Range: [1~10], unit: seconds (s).
    storage_space number
    Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
    storage_type string
    Instance storage type.
    storage_use number
    Used storage space for the instance. Unit: GiB.
    subnet_id string
    Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.
    super_account_password string
    Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^&*()_+-=.
    tags list(object)
    Tag 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.
    tde_config object
    Instance TDE configuration.
    time_zone string
    Time zone.
    updated_time string
    Update time.
    vcpu number
    CPU size. For example: 1 means 1 core.
    vpc_id string
    VPC ID
    zone_id string
    Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.
    advancedFeatures String
    Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
    allowListIds List<String>
    Allowlist ID list permitted for access.
    availableCrossRegions List<String>
    List of cross-region backup destination regions.
    backupUse Double
    Used backup space for the instance, in GiB.
    chargeInfo InstanceChargeInfo
    Payment method.
    connectionInfos List<InstanceConnectionInfo>
    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.
    createdTime String
    Creation time.
    crossBackupPolicy InstanceCrossBackupPolicy
    Cross-region backup policy.
    dbEngineVersion String
    Compatible version. Values: SQLServer2019Std: SQL Server 2019 Standard Edition. SQLServer2019Ent: SQL Server 2019 Enterprise Edition. SQLServer2019Web: SQL Server 2019 Web Edition. SQLServer2022Std: SQL Server 2022 Standard Edition. SQLServer2022Ent: SQL Server 2022 Enterprise Edition. SQLServer2022Web: SQL Server 2022 Web Edition.
    innerVersion String
    Kernel version number.
    instanceCategory String
    Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
    instanceId String
    Instance ID.
    instanceName String
    Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.
    instanceStatus String
    Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
    instanceType String
    Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.
    maintenanceTime String
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.
    masterNodeId String
    Primary node ID. This parameter is required when manually switching master and standby nodes.
    memory Integer
    Memory size, in GiB.
    nodeDetailInfos List<InstanceNodeDetailInfo>
    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.
    nodeSpec String
    Instance specification code.
    port String
    Port.
    primaryInstanceId String
    Primary instance ID. If this field is empty, this instance is the primary instance.
    projectName String
    Project.
    readOnlyNumber Integer
    Number of read-only instances.
    serverCollation String
    Instance collation. Default: ChinesePRCCIAS. Most native collations are supported. Available values: Latin1GeneralCIAS, Latin1GeneralCSAS, SQLLatin1GeneralCP1CIAS, SQLLatin1GeneralCP1CSAS, ChinesePRCCIAS, ChinesePRCCSAS, ChinesePRCBIN, JapaneseCIAS, JapaneseCSAS, ChineseTaiwanStrokeCIAS, ChineseTaiwanStrokeCSAS, ThaiCIAS, ChinesePRCCIAI, ChinesePRCBIN2, CyrillicGeneralCI_AS.
    slowQueryEnable Boolean
    Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
    slowQueryTime String
    Slow log threshold. Range: [1~10], unit: seconds (s).
    storageSpace Integer
    Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
    storageType String
    Instance storage type.
    storageUse Double
    Used storage space for the instance. Unit: GiB.
    subnetId String
    Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.
    superAccountPassword String
    Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^&*()_+-=.
    tags List<InstanceTag>
    Tag 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.
    tdeConfig InstanceTdeConfig
    Instance TDE configuration.
    timeZone String
    Time zone.
    updatedTime String
    Update time.
    vcpu Integer
    CPU size. For example: 1 means 1 core.
    vpcId String
    VPC ID
    zoneId String
    Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.
    advancedFeatures string
    Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
    allowListIds string[]
    Allowlist ID list permitted for access.
    availableCrossRegions string[]
    List of cross-region backup destination regions.
    backupUse number
    Used backup space for the instance, in GiB.
    chargeInfo InstanceChargeInfo
    Payment method.
    connectionInfos InstanceConnectionInfo[]
    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.
    createdTime string
    Creation time.
    crossBackupPolicy InstanceCrossBackupPolicy
    Cross-region backup policy.
    dbEngineVersion string
    Compatible version. Values: SQLServer2019Std: SQL Server 2019 Standard Edition. SQLServer2019Ent: SQL Server 2019 Enterprise Edition. SQLServer2019Web: SQL Server 2019 Web Edition. SQLServer2022Std: SQL Server 2022 Standard Edition. SQLServer2022Ent: SQL Server 2022 Enterprise Edition. SQLServer2022Web: SQL Server 2022 Web Edition.
    innerVersion string
    Kernel version number.
    instanceCategory string
    Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
    instanceId string
    Instance ID.
    instanceName string
    Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.
    instanceStatus string
    Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
    instanceType string
    Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.
    maintenanceTime string
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.
    masterNodeId string
    Primary node ID. This parameter is required when manually switching master and standby nodes.
    memory number
    Memory size, in GiB.
    nodeDetailInfos InstanceNodeDetailInfo[]
    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.
    nodeSpec string
    Instance specification code.
    port string
    Port.
    primaryInstanceId string
    Primary instance ID. If this field is empty, this instance is the primary instance.
    projectName string
    Project.
    readOnlyNumber number
    Number of read-only instances.
    serverCollation string
    Instance collation. Default: ChinesePRCCIAS. Most native collations are supported. Available values: Latin1GeneralCIAS, Latin1GeneralCSAS, SQLLatin1GeneralCP1CIAS, SQLLatin1GeneralCP1CSAS, ChinesePRCCIAS, ChinesePRCCSAS, ChinesePRCBIN, JapaneseCIAS, JapaneseCSAS, ChineseTaiwanStrokeCIAS, ChineseTaiwanStrokeCSAS, ThaiCIAS, ChinesePRCCIAI, ChinesePRCBIN2, CyrillicGeneralCI_AS.
    slowQueryEnable boolean
    Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
    slowQueryTime string
    Slow log threshold. Range: [1~10], unit: seconds (s).
    storageSpace number
    Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
    storageType string
    Instance storage type.
    storageUse number
    Used storage space for the instance. Unit: GiB.
    subnetId string
    Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.
    superAccountPassword string
    Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^&*()_+-=.
    tags InstanceTag[]
    Tag 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.
    tdeConfig InstanceTdeConfig
    Instance TDE configuration.
    timeZone string
    Time zone.
    updatedTime string
    Update time.
    vcpu number
    CPU size. For example: 1 means 1 core.
    vpcId string
    VPC ID
    zoneId string
    Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.
    advanced_features str
    Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
    allow_list_ids Sequence[str]
    Allowlist ID list permitted for access.
    available_cross_regions Sequence[str]
    List of cross-region backup destination regions.
    backup_use float
    Used backup space for the instance, in GiB.
    charge_info InstanceChargeInfoArgs
    Payment method.
    connection_infos Sequence[InstanceConnectionInfoArgs]
    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.
    created_time str
    Creation time.
    cross_backup_policy InstanceCrossBackupPolicyArgs
    Cross-region backup policy.
    db_engine_version str
    Compatible version. Values: SQLServer2019Std: SQL Server 2019 Standard Edition. SQLServer2019Ent: SQL Server 2019 Enterprise Edition. SQLServer2019Web: SQL Server 2019 Web Edition. SQLServer2022Std: SQL Server 2022 Standard Edition. SQLServer2022Ent: SQL Server 2022 Enterprise Edition. SQLServer2022Web: SQL Server 2022 Web Edition.
    inner_version str
    Kernel version number.
    instance_category str
    Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
    instance_id str
    Instance ID.
    instance_name str
    Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.
    instance_status str
    Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
    instance_type str
    Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.
    maintenance_time str
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.
    master_node_id str
    Primary node ID. This parameter is required when manually switching master and standby nodes.
    memory int
    Memory size, in GiB.
    node_detail_infos Sequence[InstanceNodeDetailInfoArgs]
    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.
    node_spec str
    Instance specification code.
    port str
    Port.
    primary_instance_id str
    Primary instance ID. If this field is empty, this instance is the primary instance.
    project_name str
    Project.
    read_only_number int
    Number of read-only instances.
    server_collation str
    Instance collation. Default: ChinesePRCCIAS. Most native collations are supported. Available values: Latin1GeneralCIAS, Latin1GeneralCSAS, SQLLatin1GeneralCP1CIAS, SQLLatin1GeneralCP1CSAS, ChinesePRCCIAS, ChinesePRCCSAS, ChinesePRCBIN, JapaneseCIAS, JapaneseCSAS, ChineseTaiwanStrokeCIAS, ChineseTaiwanStrokeCSAS, ThaiCIAS, ChinesePRCCIAI, ChinesePRCBIN2, CyrillicGeneralCI_AS.
    slow_query_enable bool
    Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
    slow_query_time str
    Slow log threshold. Range: [1~10], unit: seconds (s).
    storage_space int
    Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
    storage_type str
    Instance storage type.
    storage_use float
    Used storage space for the instance. Unit: GiB.
    subnet_id str
    Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.
    super_account_password str
    Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^&*()_+-=.
    tags Sequence[InstanceTagArgs]
    Tag 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.
    tde_config InstanceTdeConfigArgs
    Instance TDE configuration.
    time_zone str
    Time zone.
    updated_time str
    Update time.
    vcpu int
    CPU size. For example: 1 means 1 core.
    vpc_id str
    VPC ID
    zone_id str
    Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.
    advancedFeatures String
    Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
    allowListIds List<String>
    Allowlist ID list permitted for access.
    availableCrossRegions List<String>
    List of cross-region backup destination regions.
    backupUse Number
    Used backup space for the instance, in GiB.
    chargeInfo Property Map
    Payment method.
    connectionInfos List<Property Map>
    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.
    createdTime String
    Creation time.
    crossBackupPolicy Property Map
    Cross-region backup policy.
    dbEngineVersion String
    Compatible version. Values: SQLServer2019Std: SQL Server 2019 Standard Edition. SQLServer2019Ent: SQL Server 2019 Enterprise Edition. SQLServer2019Web: SQL Server 2019 Web Edition. SQLServer2022Std: SQL Server 2022 Standard Edition. SQLServer2022Ent: SQL Server 2022 Enterprise Edition. SQLServer2022Web: SQL Server 2022 Web Edition.
    innerVersion String
    Kernel version number.
    instanceCategory String
    Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
    instanceId String
    Instance ID.
    instanceName String
    Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.
    instanceStatus String
    Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
    instanceType String
    Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.
    maintenanceTime String
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.
    masterNodeId String
    Primary node ID. This parameter is required when manually switching master and standby nodes.
    memory Number
    Memory size, in GiB.
    nodeDetailInfos 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.
    nodeSpec String
    Instance specification code.
    port String
    Port.
    primaryInstanceId String
    Primary instance ID. If this field is empty, this instance is the primary instance.
    projectName String
    Project.
    readOnlyNumber Number
    Number of read-only instances.
    serverCollation String
    Instance collation. Default: ChinesePRCCIAS. Most native collations are supported. Available values: Latin1GeneralCIAS, Latin1GeneralCSAS, SQLLatin1GeneralCP1CIAS, SQLLatin1GeneralCP1CSAS, ChinesePRCCIAS, ChinesePRCCSAS, ChinesePRCBIN, JapaneseCIAS, JapaneseCSAS, ChineseTaiwanStrokeCIAS, ChineseTaiwanStrokeCSAS, ThaiCIAS, ChinesePRCCIAI, ChinesePRCBIN2, CyrillicGeneralCI_AS.
    slowQueryEnable Boolean
    Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
    slowQueryTime String
    Slow log threshold. Range: [1~10], unit: seconds (s).
    storageSpace Number
    Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
    storageType String
    Instance storage type.
    storageUse Number
    Used storage space for the instance. Unit: GiB.
    subnetId String
    Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.
    superAccountPassword String
    Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^&*()_+-=.
    tags List<Property Map>
    Tag 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.
    tdeConfig Property Map
    Instance TDE configuration.
    timeZone String
    Time zone.
    updatedTime String
    Update time.
    vcpu Number
    CPU size. For example: 1 means 1 core.
    vpcId String
    VPC ID
    zoneId String
    Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.

    Supporting Types

    InstanceChargeInfo, InstanceChargeInfoArgs

    AutoRenew bool
    Auto-renewal for prepaid scenarios. true: auto-renew (default). false: do not auto-renew.
    ChargeEndTime string
    Billing expiration time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    ChargeStartTime string
    Billing start time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    ChargeStatus string
    Payment status. Possible values: Normal: instance is normal. Overdue: instance is overdue. Unpaid: instance is awaiting payment.
    ChargeType string
    Billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription.
    OverdueReclaimTime string
    Estimated release time when service is suspended due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).
    OverdueTime string
    Shutdown time due to overdue payment, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    Period int
    Purchase duration for prepaid scenarios. Default: 1 month.
    PeriodUnit string
    Purchase cycle for prepaid scenarios. Month: monthly subscription (default). Year: annual subscription.
    AutoRenew bool
    Auto-renewal for prepaid scenarios. true: auto-renew (default). false: do not auto-renew.
    ChargeEndTime string
    Billing expiration time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    ChargeStartTime string
    Billing start time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    ChargeStatus string
    Payment status. Possible values: Normal: instance is normal. Overdue: instance is overdue. Unpaid: instance is awaiting payment.
    ChargeType string
    Billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription.
    OverdueReclaimTime string
    Estimated release time when service is suspended due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).
    OverdueTime string
    Shutdown time due to overdue payment, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    Period int
    Purchase duration for prepaid scenarios. Default: 1 month.
    PeriodUnit string
    Purchase cycle for prepaid scenarios. Month: monthly subscription (default). Year: annual subscription.
    auto_renew bool
    Auto-renewal for prepaid scenarios. true: auto-renew (default). false: do not auto-renew.
    charge_end_time string
    Billing expiration time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    charge_start_time string
    Billing start time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    charge_status string
    Payment status. Possible values: Normal: instance is normal. Overdue: instance is overdue. Unpaid: instance is awaiting payment.
    charge_type string
    Billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription.
    overdue_reclaim_time string
    Estimated release time when service is suspended due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).
    overdue_time string
    Shutdown time due to overdue payment, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    period number
    Purchase duration for prepaid scenarios. Default: 1 month.
    period_unit string
    Purchase cycle for prepaid scenarios. Month: monthly subscription (default). Year: annual subscription.
    autoRenew Boolean
    Auto-renewal for prepaid scenarios. true: auto-renew (default). false: do not auto-renew.
    chargeEndTime String
    Billing expiration time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    chargeStartTime String
    Billing start time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    chargeStatus String
    Payment status. Possible values: Normal: instance is normal. Overdue: instance is overdue. Unpaid: instance is awaiting payment.
    chargeType String
    Billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription.
    overdueReclaimTime String
    Estimated release time when service is suspended due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).
    overdueTime String
    Shutdown time due to overdue payment, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    period Integer
    Purchase duration for prepaid scenarios. Default: 1 month.
    periodUnit String
    Purchase cycle for prepaid scenarios. Month: monthly subscription (default). Year: annual subscription.
    autoRenew boolean
    Auto-renewal for prepaid scenarios. true: auto-renew (default). false: do not auto-renew.
    chargeEndTime string
    Billing expiration time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    chargeStartTime string
    Billing start time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    chargeStatus string
    Payment status. Possible values: Normal: instance is normal. Overdue: instance is overdue. Unpaid: instance is awaiting payment.
    chargeType string
    Billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription.
    overdueReclaimTime string
    Estimated release time when service is suspended due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).
    overdueTime string
    Shutdown time due to overdue payment, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    period number
    Purchase duration for prepaid scenarios. Default: 1 month.
    periodUnit string
    Purchase cycle for prepaid scenarios. Month: monthly subscription (default). Year: annual subscription.
    auto_renew bool
    Auto-renewal for prepaid scenarios. true: auto-renew (default). false: do not auto-renew.
    charge_end_time str
    Billing expiration time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    charge_start_time str
    Billing start time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    charge_status str
    Payment status. Possible values: Normal: instance is normal. Overdue: instance is overdue. Unpaid: instance is awaiting payment.
    charge_type str
    Billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription.
    overdue_reclaim_time str
    Estimated release time when service is suspended due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).
    overdue_time str
    Shutdown time due to overdue payment, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    period int
    Purchase duration for prepaid scenarios. Default: 1 month.
    period_unit str
    Purchase cycle for prepaid scenarios. Month: monthly subscription (default). Year: annual subscription.
    autoRenew Boolean
    Auto-renewal for prepaid scenarios. true: auto-renew (default). false: do not auto-renew.
    chargeEndTime String
    Billing expiration time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    chargeStartTime String
    Billing start time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    chargeStatus String
    Payment status. Possible values: Normal: instance is normal. Overdue: instance is overdue. Unpaid: instance is awaiting payment.
    chargeType String
    Billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription.
    overdueReclaimTime String
    Estimated release time when service is suspended due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).
    overdueTime String
    Shutdown time due to overdue payment, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    period Number
    Purchase duration for prepaid scenarios. Default: 1 month.
    periodUnit String
    Purchase cycle for prepaid scenarios. Month: monthly subscription (default). Year: annual subscription.

    InstanceConnectionInfo, InstanceConnectionInfoArgs

    Addresses List<Volcengine.InstanceConnectionInfoAddress>
    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.
    Description string
    Description.
    EndpointId string
    Terminal ID.
    EndpointName string
    Terminal name.
    EndpointType string
    Terminal type. Possible values: Primary: primary node terminal. ROCluster: read-only cluster terminal. RO: read-only node terminal.
    Addresses []InstanceConnectionInfoAddress
    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.
    Description string
    Description.
    EndpointId string
    Terminal ID.
    EndpointName string
    Terminal name.
    EndpointType string
    Terminal type. Possible values: Primary: primary node terminal. ROCluster: read-only cluster terminal. RO: read-only node terminal.
    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.
    description string
    Description.
    endpoint_id string
    Terminal ID.
    endpoint_name string
    Terminal name.
    endpoint_type string
    Terminal type. Possible values: Primary: primary node terminal. ROCluster: read-only cluster terminal. RO: read-only node terminal.
    addresses List<InstanceConnectionInfoAddress>
    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.
    description String
    Description.
    endpointId String
    Terminal ID.
    endpointName String
    Terminal name.
    endpointType String
    Terminal type. Possible values: Primary: primary node terminal. ROCluster: read-only cluster terminal. RO: read-only node terminal.
    addresses InstanceConnectionInfoAddress[]
    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.
    description string
    Description.
    endpointId string
    Terminal ID.
    endpointName string
    Terminal name.
    endpointType string
    Terminal type. Possible values: Primary: primary node terminal. ROCluster: read-only cluster terminal. RO: read-only node terminal.
    addresses Sequence[InstanceConnectionInfoAddress]
    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.
    description str
    Description.
    endpoint_id str
    Terminal ID.
    endpoint_name str
    Terminal name.
    endpoint_type str
    Terminal type. Possible values: Primary: primary node terminal. ROCluster: read-only cluster terminal. RO: read-only node terminal.
    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.
    description String
    Description.
    endpointId String
    Terminal ID.
    endpointName String
    Terminal name.
    endpointType String
    Terminal type. Possible values: Primary: primary node terminal. ROCluster: read-only cluster terminal. RO: read-only node terminal.

    InstanceConnectionInfoAddress, InstanceConnectionInfoAddressArgs

    DnsVisibility bool
    Indicates whether private network to public network resolution is enabled. Available values: true: enabled. false: disabled.
    Domain string
    Domain name.
    EipId string
    EIP ID, valid only for public addresses.
    IpAddress string
    IP address.
    NetworkType string
    Network address type. Possible values: Private: private network type. Public: public network type.
    Port string
    Port.
    SubnetId string
    Subnet ID, valid only for private network addresses.
    DnsVisibility bool
    Indicates whether private network to public network resolution is enabled. Available values: true: enabled. false: disabled.
    Domain string
    Domain name.
    EipId string
    EIP ID, valid only for public addresses.
    IpAddress string
    IP address.
    NetworkType string
    Network address type. Possible values: Private: private network type. Public: public network type.
    Port string
    Port.
    SubnetId string
    Subnet ID, valid only for private network addresses.
    dns_visibility bool
    Indicates whether private network to public network resolution is enabled. Available values: true: enabled. false: disabled.
    domain string
    Domain name.
    eip_id string
    EIP ID, valid only for public addresses.
    ip_address string
    IP address.
    network_type string
    Network address type. Possible values: Private: private network type. Public: public network type.
    port string
    Port.
    subnet_id string
    Subnet ID, valid only for private network addresses.
    dnsVisibility Boolean
    Indicates whether private network to public network resolution is enabled. Available values: true: enabled. false: disabled.
    domain String
    Domain name.
    eipId String
    EIP ID, valid only for public addresses.
    ipAddress String
    IP address.
    networkType String
    Network address type. Possible values: Private: private network type. Public: public network type.
    port String
    Port.
    subnetId String
    Subnet ID, valid only for private network addresses.
    dnsVisibility boolean
    Indicates whether private network to public network resolution is enabled. Available values: true: enabled. false: disabled.
    domain string
    Domain name.
    eipId string
    EIP ID, valid only for public addresses.
    ipAddress string
    IP address.
    networkType string
    Network address type. Possible values: Private: private network type. Public: public network type.
    port string
    Port.
    subnetId string
    Subnet ID, valid only for private network addresses.
    dns_visibility bool
    Indicates whether private network to public network resolution is enabled. Available values: true: enabled. false: disabled.
    domain str
    Domain name.
    eip_id str
    EIP ID, valid only for public addresses.
    ip_address str
    IP address.
    network_type str
    Network address type. Possible values: Private: private network type. Public: public network type.
    port str
    Port.
    subnet_id str
    Subnet ID, valid only for private network addresses.
    dnsVisibility Boolean
    Indicates whether private network to public network resolution is enabled. Available values: true: enabled. false: disabled.
    domain String
    Domain name.
    eipId String
    EIP ID, valid only for public addresses.
    ipAddress String
    IP address.
    networkType String
    Network address type. Possible values: Private: private network type. Public: public network type.
    port String
    Port.
    subnetId String
    Subnet ID, valid only for private network addresses.

    InstanceCrossBackupPolicy, InstanceCrossBackupPolicyArgs

    BackupEnabled bool
    Whether to enable cross-region backup. The values are as follows: true: Cross-region backup is enabled. false: Cross-region backup is disabled.
    CrossBackupRegion string
    ID of the cross-region backup destination region. This parameter is required when BackupEnabled is set to true.
    Retention int
    Number of days to retain cross-region backups. The valid range is 7–1825 days. The default value is 7.
    BackupEnabled bool
    Whether to enable cross-region backup. The values are as follows: true: Cross-region backup is enabled. false: Cross-region backup is disabled.
    CrossBackupRegion string
    ID of the cross-region backup destination region. This parameter is required when BackupEnabled is set to true.
    Retention int
    Number of days to retain cross-region backups. The valid range is 7–1825 days. The default value is 7.
    backup_enabled bool
    Whether to enable cross-region backup. The values are as follows: true: Cross-region backup is enabled. false: Cross-region backup is disabled.
    cross_backup_region string
    ID of the cross-region backup destination region. This parameter is required when BackupEnabled is set to true.
    retention number
    Number of days to retain cross-region backups. The valid range is 7–1825 days. The default value is 7.
    backupEnabled Boolean
    Whether to enable cross-region backup. The values are as follows: true: Cross-region backup is enabled. false: Cross-region backup is disabled.
    crossBackupRegion String
    ID of the cross-region backup destination region. This parameter is required when BackupEnabled is set to true.
    retention Integer
    Number of days to retain cross-region backups. The valid range is 7–1825 days. The default value is 7.
    backupEnabled boolean
    Whether to enable cross-region backup. The values are as follows: true: Cross-region backup is enabled. false: Cross-region backup is disabled.
    crossBackupRegion string
    ID of the cross-region backup destination region. This parameter is required when BackupEnabled is set to true.
    retention number
    Number of days to retain cross-region backups. The valid range is 7–1825 days. The default value is 7.
    backup_enabled bool
    Whether to enable cross-region backup. The values are as follows: true: Cross-region backup is enabled. false: Cross-region backup is disabled.
    cross_backup_region str
    ID of the cross-region backup destination region. This parameter is required when BackupEnabled is set to true.
    retention int
    Number of days to retain cross-region backups. The valid range is 7–1825 days. The default value is 7.
    backupEnabled Boolean
    Whether to enable cross-region backup. The values are as follows: true: Cross-region backup is enabled. false: Cross-region backup is disabled.
    crossBackupRegion String
    ID of the cross-region backup destination region. This parameter is required when BackupEnabled is set to true.
    retention Number
    Number of days to retain cross-region backups. The valid range is 7–1825 days. The default value is 7.

    InstanceNodeDetailInfo, InstanceNodeDetailInfoArgs

    CreateTime string
    Node creation time.
    HostName string
    Node hostname.
    InstanceId string
    Instance ID.
    Memory int
    Memory size, in GiB.
    NodeId string
    Node ID.
    NodeIp string
    Node IP.
    NodeSpec string
    Node specification.
    NodeStatus string
    Node status. Possible values: Running: running. Creating: creating. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: master/standby switching. Error: error.
    NodeType string
    Node type. Possible values: Primary: primary node terminal. ReadOnly: read-only node terminal. Secondary: standby node terminal.
    RegionId string
    Region ID.
    UpdateTime string
    Update time.
    Vcpu int
    vCPU count.
    ZoneId string
    Availability zone ID.
    CreateTime string
    Node creation time.
    HostName string
    Node hostname.
    InstanceId string
    Instance ID.
    Memory int
    Memory size, in GiB.
    NodeId string
    Node ID.
    NodeIp string
    Node IP.
    NodeSpec string
    Node specification.
    NodeStatus string
    Node status. Possible values: Running: running. Creating: creating. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: master/standby switching. Error: error.
    NodeType string
    Node type. Possible values: Primary: primary node terminal. ReadOnly: read-only node terminal. Secondary: standby node terminal.
    RegionId string
    Region ID.
    UpdateTime string
    Update time.
    Vcpu int
    vCPU count.
    ZoneId string
    Availability zone ID.
    create_time string
    Node creation time.
    host_name string
    Node hostname.
    instance_id string
    Instance ID.
    memory number
    Memory size, in GiB.
    node_id string
    Node ID.
    node_ip string
    Node IP.
    node_spec string
    Node specification.
    node_status string
    Node status. Possible values: Running: running. Creating: creating. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: master/standby switching. Error: error.
    node_type string
    Node type. Possible values: Primary: primary node terminal. ReadOnly: read-only node terminal. Secondary: standby node terminal.
    region_id string
    Region ID.
    update_time string
    Update time.
    vcpu number
    vCPU count.
    zone_id string
    Availability zone ID.
    createTime String
    Node creation time.
    hostName String
    Node hostname.
    instanceId String
    Instance ID.
    memory Integer
    Memory size, in GiB.
    nodeId String
    Node ID.
    nodeIp String
    Node IP.
    nodeSpec String
    Node specification.
    nodeStatus String
    Node status. Possible values: Running: running. Creating: creating. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: master/standby switching. Error: error.
    nodeType String
    Node type. Possible values: Primary: primary node terminal. ReadOnly: read-only node terminal. Secondary: standby node terminal.
    regionId String
    Region ID.
    updateTime String
    Update time.
    vcpu Integer
    vCPU count.
    zoneId String
    Availability zone ID.
    createTime string
    Node creation time.
    hostName string
    Node hostname.
    instanceId string
    Instance ID.
    memory number
    Memory size, in GiB.
    nodeId string
    Node ID.
    nodeIp string
    Node IP.
    nodeSpec string
    Node specification.
    nodeStatus string
    Node status. Possible values: Running: running. Creating: creating. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: master/standby switching. Error: error.
    nodeType string
    Node type. Possible values: Primary: primary node terminal. ReadOnly: read-only node terminal. Secondary: standby node terminal.
    regionId string
    Region ID.
    updateTime string
    Update time.
    vcpu number
    vCPU count.
    zoneId string
    Availability zone ID.
    create_time str
    Node creation time.
    host_name str
    Node hostname.
    instance_id str
    Instance ID.
    memory int
    Memory size, in GiB.
    node_id str
    Node ID.
    node_ip str
    Node IP.
    node_spec str
    Node specification.
    node_status str
    Node status. Possible values: Running: running. Creating: creating. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: master/standby switching. Error: error.
    node_type str
    Node type. Possible values: Primary: primary node terminal. ReadOnly: read-only node terminal. Secondary: standby node terminal.
    region_id str
    Region ID.
    update_time str
    Update time.
    vcpu int
    vCPU count.
    zone_id str
    Availability zone ID.
    createTime String
    Node creation time.
    hostName String
    Node hostname.
    instanceId String
    Instance ID.
    memory Number
    Memory size, in GiB.
    nodeId String
    Node ID.
    nodeIp String
    Node IP.
    nodeSpec String
    Node specification.
    nodeStatus String
    Node status. Possible values: Running: running. Creating: creating. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: master/standby switching. Error: error.
    nodeType String
    Node type. Possible values: Primary: primary node terminal. ReadOnly: read-only node terminal. Secondary: standby node terminal.
    regionId String
    Region ID.
    updateTime String
    Update time.
    vcpu Number
    vCPU count.
    zoneId String
    Availability zone ID.

    InstanceTag, InstanceTagArgs

    Key string
    Tag key for user tags.
    Value string
    User tag value.
    Key string
    Tag key for user tags.
    Value string
    User tag value.
    key string
    Tag key for user tags.
    value string
    User tag value.
    key String
    Tag key for user tags.
    value String
    User tag value.
    key string
    Tag key for user tags.
    value string
    User tag value.
    key str
    Tag key for user tags.
    value str
    User tag value.
    key String
    Tag key for user tags.
    value String
    User tag value.

    InstanceTdeConfig, InstanceTdeConfigArgs

    Certificate string
    Certificate file used for TDE encryption. You can enter a TOS path in the format \n\n:\n\n:\n\n. Valid only when TDEMode is set to User_Default.
    DbStatuses List<Volcengine.InstanceTdeConfigDbStatus>
    Database encryption status. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    Password string
    Password for the private key of the certificate used in TDE encryption. Valid only when TDEMode is set to UserDefault. The password must be 8–32 characters long and can only contain uppercase and lowercase letters, numbers, and special characters ~!@#$%^&()-*+=?. It must include at least three of the following: uppercase letters, lowercase letters, numbers, or special characters. Note: This is only valid when the TDEMode parameter is set to User_Default.
    PrivateKey string
    Private key for the certificate used in TDE encryption. You can enter a TOS path in the format \n\n:\n\n:\n\n. Valid only when TDEMode is set to User_Default.
    TdeMode string
    Instance TDE encryption certificate generation mode. MSSQLDefault: Encryption certificate generated by SQL Server. UserDefault: Custom certificate uploaded by the user.
    TdeStatus string
    Instance TDE status. Enable: The instance TDE status is enabled. Disable: The instance TDE status is disabled. Currently, only Enable is supported.
    Certificate string
    Certificate file used for TDE encryption. You can enter a TOS path in the format \n\n:\n\n:\n\n. Valid only when TDEMode is set to User_Default.
    DbStatuses []InstanceTdeConfigDbStatus
    Database encryption status. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    Password string
    Password for the private key of the certificate used in TDE encryption. Valid only when TDEMode is set to UserDefault. The password must be 8–32 characters long and can only contain uppercase and lowercase letters, numbers, and special characters ~!@#$%^&()-*+=?. It must include at least three of the following: uppercase letters, lowercase letters, numbers, or special characters. Note: This is only valid when the TDEMode parameter is set to User_Default.
    PrivateKey string
    Private key for the certificate used in TDE encryption. You can enter a TOS path in the format \n\n:\n\n:\n\n. Valid only when TDEMode is set to User_Default.
    TdeMode string
    Instance TDE encryption certificate generation mode. MSSQLDefault: Encryption certificate generated by SQL Server. UserDefault: Custom certificate uploaded by the user.
    TdeStatus string
    Instance TDE status. Enable: The instance TDE status is enabled. Disable: The instance TDE status is disabled. Currently, only Enable is supported.
    certificate string
    Certificate file used for TDE encryption. You can enter a TOS path in the format \n\n:\n\n:\n\n. Valid only when TDEMode is set to User_Default.
    db_statuses list(object)
    Database encryption status. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    password string
    Password for the private key of the certificate used in TDE encryption. Valid only when TDEMode is set to UserDefault. The password must be 8–32 characters long and can only contain uppercase and lowercase letters, numbers, and special characters ~!@#$%^&()-*+=?. It must include at least three of the following: uppercase letters, lowercase letters, numbers, or special characters. Note: This is only valid when the TDEMode parameter is set to User_Default.
    private_key string
    Private key for the certificate used in TDE encryption. You can enter a TOS path in the format \n\n:\n\n:\n\n. Valid only when TDEMode is set to User_Default.
    tde_mode string
    Instance TDE encryption certificate generation mode. MSSQLDefault: Encryption certificate generated by SQL Server. UserDefault: Custom certificate uploaded by the user.
    tde_status string
    Instance TDE status. Enable: The instance TDE status is enabled. Disable: The instance TDE status is disabled. Currently, only Enable is supported.
    certificate String
    Certificate file used for TDE encryption. You can enter a TOS path in the format \n\n:\n\n:\n\n. Valid only when TDEMode is set to User_Default.
    dbStatuses List<InstanceTdeConfigDbStatus>
    Database encryption status. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    password String
    Password for the private key of the certificate used in TDE encryption. Valid only when TDEMode is set to UserDefault. The password must be 8–32 characters long and can only contain uppercase and lowercase letters, numbers, and special characters ~!@#$%^&()-*+=?. It must include at least three of the following: uppercase letters, lowercase letters, numbers, or special characters. Note: This is only valid when the TDEMode parameter is set to User_Default.
    privateKey String
    Private key for the certificate used in TDE encryption. You can enter a TOS path in the format \n\n:\n\n:\n\n. Valid only when TDEMode is set to User_Default.
    tdeMode String
    Instance TDE encryption certificate generation mode. MSSQLDefault: Encryption certificate generated by SQL Server. UserDefault: Custom certificate uploaded by the user.
    tdeStatus String
    Instance TDE status. Enable: The instance TDE status is enabled. Disable: The instance TDE status is disabled. Currently, only Enable is supported.
    certificate string
    Certificate file used for TDE encryption. You can enter a TOS path in the format \n\n:\n\n:\n\n. Valid only when TDEMode is set to User_Default.
    dbStatuses InstanceTdeConfigDbStatus[]
    Database encryption status. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    password string
    Password for the private key of the certificate used in TDE encryption. Valid only when TDEMode is set to UserDefault. The password must be 8–32 characters long and can only contain uppercase and lowercase letters, numbers, and special characters ~!@#$%^&()-*+=?. It must include at least three of the following: uppercase letters, lowercase letters, numbers, or special characters. Note: This is only valid when the TDEMode parameter is set to User_Default.
    privateKey string
    Private key for the certificate used in TDE encryption. You can enter a TOS path in the format \n\n:\n\n:\n\n. Valid only when TDEMode is set to User_Default.
    tdeMode string
    Instance TDE encryption certificate generation mode. MSSQLDefault: Encryption certificate generated by SQL Server. UserDefault: Custom certificate uploaded by the user.
    tdeStatus string
    Instance TDE status. Enable: The instance TDE status is enabled. Disable: The instance TDE status is disabled. Currently, only Enable is supported.
    certificate str
    Certificate file used for TDE encryption. You can enter a TOS path in the format \n\n:\n\n:\n\n. Valid only when TDEMode is set to User_Default.
    db_statuses Sequence[InstanceTdeConfigDbStatus]
    Database encryption status. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    password str
    Password for the private key of the certificate used in TDE encryption. Valid only when TDEMode is set to UserDefault. The password must be 8–32 characters long and can only contain uppercase and lowercase letters, numbers, and special characters ~!@#$%^&()-*+=?. It must include at least three of the following: uppercase letters, lowercase letters, numbers, or special characters. Note: This is only valid when the TDEMode parameter is set to User_Default.
    private_key str
    Private key for the certificate used in TDE encryption. You can enter a TOS path in the format \n\n:\n\n:\n\n. Valid only when TDEMode is set to User_Default.
    tde_mode str
    Instance TDE encryption certificate generation mode. MSSQLDefault: Encryption certificate generated by SQL Server. UserDefault: Custom certificate uploaded by the user.
    tde_status str
    Instance TDE status. Enable: The instance TDE status is enabled. Disable: The instance TDE status is disabled. Currently, only Enable is supported.
    certificate String
    Certificate file used for TDE encryption. You can enter a TOS path in the format \n\n:\n\n:\n\n. Valid only when TDEMode is set to User_Default.
    dbStatuses List<Property Map>
    Database encryption status. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    password String
    Password for the private key of the certificate used in TDE encryption. Valid only when TDEMode is set to UserDefault. The password must be 8–32 characters long and can only contain uppercase and lowercase letters, numbers, and special characters ~!@#$%^&()-*+=?. It must include at least three of the following: uppercase letters, lowercase letters, numbers, or special characters. Note: This is only valid when the TDEMode parameter is set to User_Default.
    privateKey String
    Private key for the certificate used in TDE encryption. You can enter a TOS path in the format \n\n:\n\n:\n\n. Valid only when TDEMode is set to User_Default.
    tdeMode String
    Instance TDE encryption certificate generation mode. MSSQLDefault: Encryption certificate generated by SQL Server. UserDefault: Custom certificate uploaded by the user.
    tdeStatus String
    Instance TDE status. Enable: The instance TDE status is enabled. Disable: The instance TDE status is disabled. Currently, only Enable is supported.

    InstanceTdeConfigDbStatus, InstanceTdeConfigDbStatusArgs

    DbName string
    Database name.
    Enable bool
    Whether encryption is enabled. true: The database is encrypted. false: The database is decrypted.
    DbName string
    Database name.
    Enable bool
    Whether encryption is enabled. true: The database is encrypted. false: The database is decrypted.
    db_name string
    Database name.
    enable bool
    Whether encryption is enabled. true: The database is encrypted. false: The database is decrypted.
    dbName String
    Database name.
    enable Boolean
    Whether encryption is enabled. true: The database is encrypted. false: The database is decrypted.
    dbName string
    Database name.
    enable boolean
    Whether encryption is enabled. true: The database is encrypted. false: The database is decrypted.
    db_name str
    Database name.
    enable bool
    Whether encryption is enabled. true: The database is encrypted. false: The database is decrypted.
    dbName String
    Database name.
    enable Boolean
    Whether encryption is enabled. true: The database is encrypted. false: The database is decrypted.

    Import

    $ pulumi import volcenginecc:rdsmssql/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 volcenginecc
    Viewing docs for volcenginecc v0.0.63
    published on Thursday, Oct 15, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial