1. Registry
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. tidb
  6. Instance
Viewing docs for volcenginecc v0.0.66
published on Thursday, Nov 19, 2026 by Volcengine
volcenginecc logo volcenginecc
Viewing docs for volcenginecc v0.0.66
published on Thursday, Nov 19, 2026 by Volcengine

    TiDB Instance (Cluster)

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as volcenginecc from "@volcengine/pulumi-volcenginecc";
    
    const example = new volcenginecc.tidb.Instance("example", {
        displayName: "ccapi-tidb-instance-full",
        autoScaling: {
            min_rcu: 2000,
            max_rcu: 4000,
        },
        encryptionConfig: {
            enhanced_encryption_enabled: true,
        },
        projectName: "default",
        highAvailabilityType: "REGIONAL",
        regionId: "cn-beijing",
        servicePlan: "Essential",
        vpcId: "vpc-xxx",
        zones: [{
            zone_id: "zone-xxx",
            subnet_id: "subnet-xxxx",
        }],
        automatedBackupPolicy: {
            start_time: "01:00",
            retention_days: 1,
        },
        tags: [
            {
                key: "env",
                value: "full",
            },
            {
                key: "team",
                value: "ccapi",
            },
        ],
    });
    
    import pulumi
    import pulumi_volcenginecc as volcenginecc
    
    example = volcenginecc.tidb.Instance("example",
        display_name="ccapi-tidb-instance-full",
        auto_scaling={
            "min_rcu": 2000,
            "max_rcu": 4000,
        },
        encryption_config={
            "enhanced_encryption_enabled": True,
        },
        project_name="default",
        high_availability_type="REGIONAL",
        region_id="cn-beijing",
        service_plan="Essential",
        vpc_id="vpc-xxx",
        zones=[{
            "zone_id": "zone-xxx",
            "subnet_id": "subnet-xxxx",
        }],
        automated_backup_policy={
            "start_time": "01:00",
            "retention_days": 1,
        },
        tags=[
            {
                "key": "env",
                "value": "full",
            },
            {
                "key": "team",
                "value": "ccapi",
            },
        ])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/tidb"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := tidb.NewInstance(ctx, "example", &tidb.InstanceArgs{
    			DisplayName: pulumi.String("ccapi-tidb-instance-full"),
    			AutoScaling: &tidb.InstanceAutoScalingArgs{
    				Min_rcu: 2000,
    				Max_rcu: 4000,
    			},
    			EncryptionConfig: &tidb.InstanceEncryptionConfigArgs{
    				Enhanced_encryption_enabled: true,
    			},
    			ProjectName:          pulumi.String("default"),
    			HighAvailabilityType: pulumi.String("REGIONAL"),
    			RegionId:             pulumi.String("cn-beijing"),
    			ServicePlan:          pulumi.String("Essential"),
    			VpcId:                pulumi.String("vpc-xxx"),
    			Zones: tidb.InstanceZoneArray{
    				&tidb.InstanceZoneArgs{
    					Zone_id:   "zone-xxx",
    					Subnet_id: "subnet-xxxx",
    				},
    			},
    			AutomatedBackupPolicy: &tidb.InstanceAutomatedBackupPolicyArgs{
    				Start_time:     "01:00",
    				Retention_days: 1,
    			},
    			Tags: tidb.InstanceTagArray{
    				&tidb.InstanceTagArgs{
    					Key:   pulumi.String("env"),
    					Value: pulumi.String("full"),
    				},
    				&tidb.InstanceTagArgs{
    					Key:   pulumi.String("team"),
    					Value: pulumi.String("ccapi"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcenginecc = Volcengine.Pulumi.Volcenginecc;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Volcenginecc.Tidb.Instance("example", new()
        {
            DisplayName = "ccapi-tidb-instance-full",
            AutoScaling = new Volcenginecc.Tidb.Inputs.InstanceAutoScalingArgs
            {
                Min_rcu = 2000,
                Max_rcu = 4000,
            },
            EncryptionConfig = new Volcenginecc.Tidb.Inputs.InstanceEncryptionConfigArgs
            {
                Enhanced_encryption_enabled = true,
            },
            ProjectName = "default",
            HighAvailabilityType = "REGIONAL",
            RegionId = "cn-beijing",
            ServicePlan = "Essential",
            VpcId = "vpc-xxx",
            Zones = new[]
            {
                new Volcenginecc.Tidb.Inputs.InstanceZoneArgs
                {
                    Zone_id = "zone-xxx",
                    Subnet_id = "subnet-xxxx",
                },
            },
            AutomatedBackupPolicy = new Volcenginecc.Tidb.Inputs.InstanceAutomatedBackupPolicyArgs
            {
                Start_time = "01:00",
                Retention_days = 1,
            },
            Tags = new[]
            {
                new Volcenginecc.Tidb.Inputs.InstanceTagArgs
                {
                    Key = "env",
                    Value = "full",
                },
                new Volcenginecc.Tidb.Inputs.InstanceTagArgs
                {
                    Key = "team",
                    Value = "ccapi",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.volcengine.volcenginecc.tidb.Instance;
    import com.volcengine.volcenginecc.tidb.InstanceArgs;
    import com.pulumi.volcenginecc.tidb.inputs.InstanceAutoScalingArgs;
    import com.pulumi.volcenginecc.tidb.inputs.InstanceEncryptionConfigArgs;
    import com.pulumi.volcenginecc.tidb.inputs.InstanceZoneArgs;
    import com.pulumi.volcenginecc.tidb.inputs.InstanceAutomatedBackupPolicyArgs;
    import com.pulumi.volcenginecc.tidb.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 example = new Instance("example", InstanceArgs.builder()
                .displayName("ccapi-tidb-instance-full")
                .autoScaling(InstanceAutoScalingArgs.builder()
                    .min_rcu(2000)
                    .max_rcu(4000)
                    .build())
                .encryptionConfig(InstanceEncryptionConfigArgs.builder()
                    .enhanced_encryption_enabled(true)
                    .build())
                .projectName("default")
                .highAvailabilityType("REGIONAL")
                .regionId("cn-beijing")
                .servicePlan("Essential")
                .vpcId("vpc-xxx")
                .zones(InstanceZoneArgs.builder()
                    .zone_id("zone-xxx")
                    .subnet_id("subnet-xxxx")
                    .build())
                .automatedBackupPolicy(InstanceAutomatedBackupPolicyArgs.builder()
                    .start_time("01:00")
                    .retention_days(1)
                    .build())
                .tags(            
                    InstanceTagArgs.builder()
                        .key("env")
                        .value("full")
                        .build(),
                    InstanceTagArgs.builder()
                        .key("team")
                        .value("ccapi")
                        .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: volcenginecc:tidb:Instance
        properties:
          displayName: ccapi-tidb-instance-full
          autoScaling:
            min_rcu: 2000
            max_rcu: 4000
          encryptionConfig:
            enhanced_encryption_enabled: true
          projectName: default
          highAvailabilityType: REGIONAL
          regionId: cn-beijing
          servicePlan: Essential
          vpcId: vpc-xxx
          zones:
            - zone_id: zone-xxx
              subnet_id: subnet-xxxx
          automatedBackupPolicy:
            start_time: 01:00
            retention_days: 1
          tags:
            - key: env
              value: full
            - key: team
              value: ccapi
    
    pulumi {
      required_providers {
        volcenginecc = {
          source = "pulumi/volcenginecc"
        }
      }
    }
    
    resource "volcenginecc_tidb_instance" "example" {
      display_name = "ccapi-tidb-instance-full"
      auto_scaling = {
        min_rcu = 2000
        max_rcu = 4000
      }
      encryption_config = {
        enhanced_encryption_enabled = true
      }
      project_name           = "default"
      high_availability_type = "REGIONAL"
      region_id              = "cn-beijing"
      service_plan           = "Essential"
      vpc_id                 = "vpc-xxx"
      zones {
        zone_id   = "zone-xxx"
        subnet_id = "subnet-xxxx"
      }
      automated_backup_policy = {
        start_time     = "01:00"
        retention_days = 1
      }
      tags {
        key   = "env"
        value = "full"
      }
      tags {
        key   = "team"
        value = "ccapi"
      }
    }
    

    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,
                 auto_scaling: Optional[InstanceAutoScalingArgs] = None,
                 vpc_id: Optional[str] = None,
                 zones: Optional[Sequence[InstanceZoneArgs]] = None,
                 automated_backup_policy: Optional[InstanceAutomatedBackupPolicyArgs] = None,
                 display_name: Optional[str] = None,
                 encryption_config: Optional[InstanceEncryptionConfigArgs] = None,
                 high_availability_type: Optional[str] = None,
                 project_name: Optional[str] = None,
                 region_id: Optional[str] = None,
                 service_plan: Optional[str] = None,
                 tags: Optional[Sequence[InstanceTagArgs]] = None)
    func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
    public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
    public Instance(String name, InstanceArgs args)
    public Instance(String name, InstanceArgs args, CustomResourceOptions options)
    
    type: volcenginecc:tidb:Instance
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "volcenginecc_tidb_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 exampleinstanceResourceResourceFromTidbinstance = new Volcenginecc.Tidb.Instance("exampleinstanceResourceResourceFromTidbinstance", new()
    {
        AutoScaling = new Volcenginecc.Tidb.Inputs.InstanceAutoScalingArgs
        {
            MaxRcu = 0,
            MinRcu = 0,
        },
        VpcId = "string",
        Zones = new[]
        {
            new Volcenginecc.Tidb.Inputs.InstanceZoneArgs
            {
                SubnetId = "string",
                ZoneId = "string",
            },
        },
        AutomatedBackupPolicy = new Volcenginecc.Tidb.Inputs.InstanceAutomatedBackupPolicyArgs
        {
            RetentionDays = 0,
            StartTime = "string",
        },
        DisplayName = "string",
        EncryptionConfig = new Volcenginecc.Tidb.Inputs.InstanceEncryptionConfigArgs
        {
            EnhancedEncryptionEnabled = false,
        },
        HighAvailabilityType = "string",
        ProjectName = "string",
        RegionId = "string",
        ServicePlan = "string",
        Tags = new[]
        {
            new Volcenginecc.Tidb.Inputs.InstanceTagArgs
            {
                Key = "string",
                Value = "string",
            },
        },
    });
    
    example, err := tidb.NewInstance(ctx, "exampleinstanceResourceResourceFromTidbinstance", &tidb.InstanceArgs{
    	AutoScaling: &tidb.InstanceAutoScalingArgs{
    		MaxRcu: pulumi.Int(0),
    		MinRcu: pulumi.Int(0),
    	},
    	VpcId: pulumi.String("string"),
    	Zones: tidb.InstanceZoneArray{
    		&tidb.InstanceZoneArgs{
    			SubnetId: pulumi.String("string"),
    			ZoneId:   pulumi.String("string"),
    		},
    	},
    	AutomatedBackupPolicy: &tidb.InstanceAutomatedBackupPolicyArgs{
    		RetentionDays: pulumi.Int(0),
    		StartTime:     pulumi.String("string"),
    	},
    	DisplayName: pulumi.String("string"),
    	EncryptionConfig: &tidb.InstanceEncryptionConfigArgs{
    		EnhancedEncryptionEnabled: pulumi.Bool(false),
    	},
    	HighAvailabilityType: pulumi.String("string"),
    	ProjectName:          pulumi.String("string"),
    	RegionId:             pulumi.String("string"),
    	ServicePlan:          pulumi.String("string"),
    	Tags: tidb.InstanceTagArray{
    		&tidb.InstanceTagArgs{
    			Key:   pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    })
    
    resource "volcenginecc_tidb_instance" "exampleinstanceResourceResourceFromTidbinstance" {
      lifecycle {
        create_before_destroy = true
      }
      auto_scaling = {
        max_rcu = 0
        min_rcu = 0
      }
      vpc_id = "string"
      zones {
        subnet_id = "string"
        zone_id   = "string"
      }
      automated_backup_policy = {
        retention_days = 0
        start_time     = "string"
      }
      display_name = "string"
      encryption_config = {
        enhanced_encryption_enabled = false
      }
      high_availability_type = "string"
      project_name           = "string"
      region_id              = "string"
      service_plan           = "string"
      tags {
        key   = "string"
        value = "string"
      }
    }
    
    var exampleinstanceResourceResourceFromTidbinstance = new com.volcengine.volcenginecc.tidb.Instance("exampleinstanceResourceResourceFromTidbinstance", com.volcengine.volcenginecc.tidb.InstanceArgs.builder()
        .autoScaling(InstanceAutoScalingArgs.builder()
            .maxRcu(0)
            .minRcu(0)
            .build())
        .vpcId("string")
        .zones(InstanceZoneArgs.builder()
            .subnetId("string")
            .zoneId("string")
            .build())
        .automatedBackupPolicy(InstanceAutomatedBackupPolicyArgs.builder()
            .retentionDays(0)
            .startTime("string")
            .build())
        .displayName("string")
        .encryptionConfig(InstanceEncryptionConfigArgs.builder()
            .enhancedEncryptionEnabled(false)
            .build())
        .highAvailabilityType("string")
        .projectName("string")
        .regionId("string")
        .servicePlan("string")
        .tags(com.pulumi.volcenginecc.tidb.inputs.InstanceTagArgs.builder()
            .key("string")
            .value("string")
            .build())
        .build());
    
    exampleinstance_resource_resource_from_tidbinstance = volcenginecc.tidb.Instance("exampleinstanceResourceResourceFromTidbinstance",
        auto_scaling={
            "max_rcu": 0,
            "min_rcu": 0,
        },
        vpc_id="string",
        zones=[{
            "subnet_id": "string",
            "zone_id": "string",
        }],
        automated_backup_policy={
            "retention_days": 0,
            "start_time": "string",
        },
        display_name="string",
        encryption_config={
            "enhanced_encryption_enabled": False,
        },
        high_availability_type="string",
        project_name="string",
        region_id="string",
        service_plan="string",
        tags=[{
            "key": "string",
            "value": "string",
        }])
    
    const exampleinstanceResourceResourceFromTidbinstance = new volcenginecc.tidb.Instance("exampleinstanceResourceResourceFromTidbinstance", {
        autoScaling: {
            maxRcu: 0,
            minRcu: 0,
        },
        vpcId: "string",
        zones: [{
            subnetId: "string",
            zoneId: "string",
        }],
        automatedBackupPolicy: {
            retentionDays: 0,
            startTime: "string",
        },
        displayName: "string",
        encryptionConfig: {
            enhancedEncryptionEnabled: false,
        },
        highAvailabilityType: "string",
        projectName: "string",
        regionId: "string",
        servicePlan: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    type: volcenginecc:tidb:Instance
    properties:
        autoScaling:
            maxRcu: 0
            minRcu: 0
        automatedBackupPolicy:
            retentionDays: 0
            startTime: string
        displayName: string
        encryptionConfig:
            enhancedEncryptionEnabled: false
        highAvailabilityType: string
        projectName: string
        regionId: string
        servicePlan: string
        tags:
            - key: string
              value: string
        vpcId: string
        zones:
            - subnetId: 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:

    AutoScaling Volcengine.InstanceAutoScaling
    Auto Scaling
    VpcId string
    VPC ID Used at Creation
    Zones List<Volcengine.InstanceZone>
    Availability Zones and Subnets Used at Creation 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.
    AutomatedBackupPolicy Volcengine.InstanceAutomatedBackupPolicy
    Automatic Backup Policy
    DisplayName string
    Cluster Display Name
    EncryptionConfig Volcengine.InstanceEncryptionConfig
    Data Encryption Configuration
    HighAvailabilityType string
    High Availability Type
    ProjectName string
    Volcano Engine Project Name
    RegionId string
    Deployment Region
    ServicePlan string
    Service Plan
    Tags List<Volcengine.InstanceTag>
    Instance Tags 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.
    AutoScaling InstanceAutoScalingArgs
    Auto Scaling
    VpcId string
    VPC ID Used at Creation
    Zones []InstanceZoneArgs
    Availability Zones and Subnets Used at Creation 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.
    AutomatedBackupPolicy InstanceAutomatedBackupPolicyArgs
    Automatic Backup Policy
    DisplayName string
    Cluster Display Name
    EncryptionConfig InstanceEncryptionConfigArgs
    Data Encryption Configuration
    HighAvailabilityType string
    High Availability Type
    ProjectName string
    Volcano Engine Project Name
    RegionId string
    Deployment Region
    ServicePlan string
    Service Plan
    Tags []InstanceTagArgs
    Instance Tags Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    auto_scaling object
    Auto Scaling
    vpc_id string
    VPC ID Used at Creation
    zones list(object)
    Availability Zones and Subnets Used at Creation 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.
    automated_backup_policy object
    Automatic Backup Policy
    display_name string
    Cluster Display Name
    encryption_config object
    Data Encryption Configuration
    high_availability_type string
    High Availability Type
    project_name string
    Volcano Engine Project Name
    region_id string
    Deployment Region
    service_plan string
    Service Plan
    tags list(object)
    Instance Tags 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.
    autoScaling InstanceAutoScaling
    Auto Scaling
    vpcId String
    VPC ID Used at Creation
    zones List<InstanceZone>
    Availability Zones and Subnets Used at Creation 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.
    automatedBackupPolicy InstanceAutomatedBackupPolicy
    Automatic Backup Policy
    displayName String
    Cluster Display Name
    encryptionConfig InstanceEncryptionConfig
    Data Encryption Configuration
    highAvailabilityType String
    High Availability Type
    projectName String
    Volcano Engine Project Name
    regionId String
    Deployment Region
    servicePlan String
    Service Plan
    tags List<InstanceTag>
    Instance Tags 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.
    autoScaling InstanceAutoScaling
    Auto Scaling
    vpcId string
    VPC ID Used at Creation
    zones InstanceZone[]
    Availability Zones and Subnets Used at Creation 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.
    automatedBackupPolicy InstanceAutomatedBackupPolicy
    Automatic Backup Policy
    displayName string
    Cluster Display Name
    encryptionConfig InstanceEncryptionConfig
    Data Encryption Configuration
    highAvailabilityType string
    High Availability Type
    projectName string
    Volcano Engine Project Name
    regionId string
    Deployment Region
    servicePlan string
    Service Plan
    tags InstanceTag[]
    Instance Tags Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    auto_scaling InstanceAutoScalingArgs
    Auto Scaling
    vpc_id str
    VPC ID Used at Creation
    zones Sequence[InstanceZoneArgs]
    Availability Zones and Subnets Used at Creation 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.
    automated_backup_policy InstanceAutomatedBackupPolicyArgs
    Automatic Backup Policy
    display_name str
    Cluster Display Name
    encryption_config InstanceEncryptionConfigArgs
    Data Encryption Configuration
    high_availability_type str
    High Availability Type
    project_name str
    Volcano Engine Project Name
    region_id str
    Deployment Region
    service_plan str
    Service Plan
    tags Sequence[InstanceTagArgs]
    Instance Tags 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.
    autoScaling Property Map
    Auto Scaling
    vpcId String
    VPC ID Used at Creation
    zones List<Property Map>
    Availability Zones and Subnets Used at Creation 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.
    automatedBackupPolicy Property Map
    Automatic Backup Policy
    displayName String
    Cluster Display Name
    encryptionConfig Property Map
    Data Encryption Configuration
    highAvailabilityType String
    High Availability Type
    projectName String
    Volcano Engine Project Name
    regionId String
    Deployment Region
    servicePlan String
    Service Plan
    tags List<Property Map>
    Instance Tags Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.

    Outputs

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

    Annotations List<Volcengine.InstanceAnnotation>
    Annotation 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.
    AuditLogConfig Volcengine.InstanceAuditLogConfig
    Audit Log Configuration
    Backups List<Volcengine.InstanceBackup>
    Cluster Backup 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.
    ClusterId string
    Cluster ID
    CreateTime string
    Creation Time (ISO8601)
    Endpoints Volcengine.InstanceEndpoints
    Connection Endpoint
    Id string
    The provider-assigned unique ID for this managed resource.
    Labels List<Volcengine.InstanceLabel>
    Tags 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.
    Name string
    Resource Name: clusters/{clusterId}
    SpendingLimit Volcengine.InstanceSpendingLimit
    Spending Limit Configuration
    State string
    Cluster Status
    UpdateTime string
    Last Updated Time (ISO8601)
    UserPrefix string
    Default Username Prefix
    Version string
    TiDB Version
    Annotations []InstanceAnnotation
    Annotation 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.
    AuditLogConfig InstanceAuditLogConfig
    Audit Log Configuration
    Backups []InstanceBackup
    Cluster Backup 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.
    ClusterId string
    Cluster ID
    CreateTime string
    Creation Time (ISO8601)
    Endpoints InstanceEndpoints
    Connection Endpoint
    Id string
    The provider-assigned unique ID for this managed resource.
    Labels []InstanceLabel
    Tags 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.
    Name string
    Resource Name: clusters/{clusterId}
    SpendingLimit InstanceSpendingLimit
    Spending Limit Configuration
    State string
    Cluster Status
    UpdateTime string
    Last Updated Time (ISO8601)
    UserPrefix string
    Default Username Prefix
    Version string
    TiDB Version
    annotations list(object)
    Annotation 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.
    audit_log_config object
    Audit Log Configuration
    backups list(object)
    Cluster Backup 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.
    cluster_id string
    Cluster ID
    create_time string
    Creation Time (ISO8601)
    endpoints object
    Connection Endpoint
    id string
    The provider-assigned unique ID for this managed resource.
    labels list(object)
    Tags 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.
    name string
    Resource Name: clusters/{clusterId}
    spending_limit object
    Spending Limit Configuration
    state string
    Cluster Status
    update_time string
    Last Updated Time (ISO8601)
    user_prefix string
    Default Username Prefix
    version string
    TiDB Version
    annotations List<InstanceAnnotation>
    Annotation 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.
    auditLogConfig InstanceAuditLogConfig
    Audit Log Configuration
    backups List<InstanceBackup>
    Cluster Backup 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.
    clusterId String
    Cluster ID
    createTime String
    Creation Time (ISO8601)
    endpoints InstanceEndpoints
    Connection Endpoint
    id String
    The provider-assigned unique ID for this managed resource.
    labels List<InstanceLabel>
    Tags 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.
    name String
    Resource Name: clusters/{clusterId}
    spendingLimit InstanceSpendingLimit
    Spending Limit Configuration
    state String
    Cluster Status
    updateTime String
    Last Updated Time (ISO8601)
    userPrefix String
    Default Username Prefix
    version String
    TiDB Version
    annotations InstanceAnnotation[]
    Annotation 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.
    auditLogConfig InstanceAuditLogConfig
    Audit Log Configuration
    backups InstanceBackup[]
    Cluster Backup 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.
    clusterId string
    Cluster ID
    createTime string
    Creation Time (ISO8601)
    endpoints InstanceEndpoints
    Connection Endpoint
    id string
    The provider-assigned unique ID for this managed resource.
    labels InstanceLabel[]
    Tags 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.
    name string
    Resource Name: clusters/{clusterId}
    spendingLimit InstanceSpendingLimit
    Spending Limit Configuration
    state string
    Cluster Status
    updateTime string
    Last Updated Time (ISO8601)
    userPrefix string
    Default Username Prefix
    version string
    TiDB Version
    annotations Sequence[InstanceAnnotation]
    Annotation 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.
    audit_log_config InstanceAuditLogConfig
    Audit Log Configuration
    backups Sequence[InstanceBackup]
    Cluster Backup 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.
    cluster_id str
    Cluster ID
    create_time str
    Creation Time (ISO8601)
    endpoints InstanceEndpoints
    Connection Endpoint
    id str
    The provider-assigned unique ID for this managed resource.
    labels Sequence[InstanceLabel]
    Tags 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.
    name str
    Resource Name: clusters/{clusterId}
    spending_limit InstanceSpendingLimit
    Spending Limit Configuration
    state str
    Cluster Status
    update_time str
    Last Updated Time (ISO8601)
    user_prefix str
    Default Username Prefix
    version str
    TiDB Version
    annotations List<Property Map>
    Annotation 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.
    auditLogConfig Property Map
    Audit Log Configuration
    backups List<Property Map>
    Cluster Backup 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.
    clusterId String
    Cluster ID
    createTime String
    Creation Time (ISO8601)
    endpoints Property Map
    Connection Endpoint
    id String
    The provider-assigned unique ID for this managed resource.
    labels List<Property Map>
    Tags 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.
    name String
    Resource Name: clusters/{clusterId}
    spendingLimit Property Map
    Spending Limit Configuration
    state String
    Cluster Status
    updateTime String
    Last Updated Time (ISO8601)
    userPrefix String
    Default Username Prefix
    version String
    TiDB Version

    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,
            annotations: Optional[Sequence[InstanceAnnotationArgs]] = None,
            audit_log_config: Optional[InstanceAuditLogConfigArgs] = None,
            auto_scaling: Optional[InstanceAutoScalingArgs] = None,
            automated_backup_policy: Optional[InstanceAutomatedBackupPolicyArgs] = None,
            backups: Optional[Sequence[InstanceBackupArgs]] = None,
            cluster_id: Optional[str] = None,
            create_time: Optional[str] = None,
            display_name: Optional[str] = None,
            encryption_config: Optional[InstanceEncryptionConfigArgs] = None,
            endpoints: Optional[InstanceEndpointsArgs] = None,
            high_availability_type: Optional[str] = None,
            labels: Optional[Sequence[InstanceLabelArgs]] = None,
            name: Optional[str] = None,
            project_name: Optional[str] = None,
            region_id: Optional[str] = None,
            service_plan: Optional[str] = None,
            spending_limit: Optional[InstanceSpendingLimitArgs] = None,
            state: Optional[str] = None,
            tags: Optional[Sequence[InstanceTagArgs]] = None,
            update_time: Optional[str] = None,
            user_prefix: Optional[str] = None,
            version: Optional[str] = None,
            vpc_id: Optional[str] = None,
            zones: Optional[Sequence[InstanceZoneArgs]] = 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:  existingInstance:    type: volcenginecc:tidb:Instance    get:      id: ${id}
    import {
      to = volcenginecc_tidb_instance.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    state InstanceState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    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 resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state InstanceState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    state InstanceState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    state InstanceState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    options CustomResourceOptions
    Bag of options to control resource's behavior.
    The following state arguments are supported:
    Annotations List<Volcengine.InstanceAnnotation>
    Annotation 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.
    AuditLogConfig Volcengine.InstanceAuditLogConfig
    Audit Log Configuration
    AutoScaling Volcengine.InstanceAutoScaling
    Auto Scaling
    AutomatedBackupPolicy Volcengine.InstanceAutomatedBackupPolicy
    Automatic Backup Policy
    Backups List<Volcengine.InstanceBackup>
    Cluster Backup 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.
    ClusterId string
    Cluster ID
    CreateTime string
    Creation Time (ISO8601)
    DisplayName string
    Cluster Display Name
    EncryptionConfig Volcengine.InstanceEncryptionConfig
    Data Encryption Configuration
    Endpoints Volcengine.InstanceEndpoints
    Connection Endpoint
    HighAvailabilityType string
    High Availability Type
    Labels List<Volcengine.InstanceLabel>
    Tags 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.
    Name string
    Resource Name: clusters/{clusterId}
    ProjectName string
    Volcano Engine Project Name
    RegionId string
    Deployment Region
    ServicePlan string
    Service Plan
    SpendingLimit Volcengine.InstanceSpendingLimit
    Spending Limit Configuration
    State string
    Cluster Status
    Tags List<Volcengine.InstanceTag>
    Instance Tags 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.
    UpdateTime string
    Last Updated Time (ISO8601)
    UserPrefix string
    Default Username Prefix
    Version string
    TiDB Version
    VpcId string
    VPC ID Used at Creation
    Zones List<Volcengine.InstanceZone>
    Availability Zones and Subnets Used at Creation 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.
    Annotations []InstanceAnnotationArgs
    Annotation 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.
    AuditLogConfig InstanceAuditLogConfigArgs
    Audit Log Configuration
    AutoScaling InstanceAutoScalingArgs
    Auto Scaling
    AutomatedBackupPolicy InstanceAutomatedBackupPolicyArgs
    Automatic Backup Policy
    Backups []InstanceBackupArgs
    Cluster Backup 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.
    ClusterId string
    Cluster ID
    CreateTime string
    Creation Time (ISO8601)
    DisplayName string
    Cluster Display Name
    EncryptionConfig InstanceEncryptionConfigArgs
    Data Encryption Configuration
    Endpoints InstanceEndpointsArgs
    Connection Endpoint
    HighAvailabilityType string
    High Availability Type
    Labels []InstanceLabelArgs
    Tags 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.
    Name string
    Resource Name: clusters/{clusterId}
    ProjectName string
    Volcano Engine Project Name
    RegionId string
    Deployment Region
    ServicePlan string
    Service Plan
    SpendingLimit InstanceSpendingLimitArgs
    Spending Limit Configuration
    State string
    Cluster Status
    Tags []InstanceTagArgs
    Instance Tags 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.
    UpdateTime string
    Last Updated Time (ISO8601)
    UserPrefix string
    Default Username Prefix
    Version string
    TiDB Version
    VpcId string
    VPC ID Used at Creation
    Zones []InstanceZoneArgs
    Availability Zones and Subnets Used at Creation 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.
    annotations list(object)
    Annotation 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.
    audit_log_config object
    Audit Log Configuration
    auto_scaling object
    Auto Scaling
    automated_backup_policy object
    Automatic Backup Policy
    backups list(object)
    Cluster Backup 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.
    cluster_id string
    Cluster ID
    create_time string
    Creation Time (ISO8601)
    display_name string
    Cluster Display Name
    encryption_config object
    Data Encryption Configuration
    endpoints object
    Connection Endpoint
    high_availability_type string
    High Availability Type
    labels list(object)
    Tags 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.
    name string
    Resource Name: clusters/{clusterId}
    project_name string
    Volcano Engine Project Name
    region_id string
    Deployment Region
    service_plan string
    Service Plan
    spending_limit object
    Spending Limit Configuration
    state string
    Cluster Status
    tags list(object)
    Instance Tags 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.
    update_time string
    Last Updated Time (ISO8601)
    user_prefix string
    Default Username Prefix
    version string
    TiDB Version
    vpc_id string
    VPC ID Used at Creation
    zones list(object)
    Availability Zones and Subnets Used at Creation 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.
    annotations List<InstanceAnnotation>
    Annotation 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.
    auditLogConfig InstanceAuditLogConfig
    Audit Log Configuration
    autoScaling InstanceAutoScaling
    Auto Scaling
    automatedBackupPolicy InstanceAutomatedBackupPolicy
    Automatic Backup Policy
    backups List<InstanceBackup>
    Cluster Backup 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.
    clusterId String
    Cluster ID
    createTime String
    Creation Time (ISO8601)
    displayName String
    Cluster Display Name
    encryptionConfig InstanceEncryptionConfig
    Data Encryption Configuration
    endpoints InstanceEndpoints
    Connection Endpoint
    highAvailabilityType String
    High Availability Type
    labels List<InstanceLabel>
    Tags 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.
    name String
    Resource Name: clusters/{clusterId}
    projectName String
    Volcano Engine Project Name
    regionId String
    Deployment Region
    servicePlan String
    Service Plan
    spendingLimit InstanceSpendingLimit
    Spending Limit Configuration
    state String
    Cluster Status
    tags List<InstanceTag>
    Instance Tags 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.
    updateTime String
    Last Updated Time (ISO8601)
    userPrefix String
    Default Username Prefix
    version String
    TiDB Version
    vpcId String
    VPC ID Used at Creation
    zones List<InstanceZone>
    Availability Zones and Subnets Used at Creation 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.
    annotations InstanceAnnotation[]
    Annotation 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.
    auditLogConfig InstanceAuditLogConfig
    Audit Log Configuration
    autoScaling InstanceAutoScaling
    Auto Scaling
    automatedBackupPolicy InstanceAutomatedBackupPolicy
    Automatic Backup Policy
    backups InstanceBackup[]
    Cluster Backup 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.
    clusterId string
    Cluster ID
    createTime string
    Creation Time (ISO8601)
    displayName string
    Cluster Display Name
    encryptionConfig InstanceEncryptionConfig
    Data Encryption Configuration
    endpoints InstanceEndpoints
    Connection Endpoint
    highAvailabilityType string
    High Availability Type
    labels InstanceLabel[]
    Tags 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.
    name string
    Resource Name: clusters/{clusterId}
    projectName string
    Volcano Engine Project Name
    regionId string
    Deployment Region
    servicePlan string
    Service Plan
    spendingLimit InstanceSpendingLimit
    Spending Limit Configuration
    state string
    Cluster Status
    tags InstanceTag[]
    Instance Tags 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.
    updateTime string
    Last Updated Time (ISO8601)
    userPrefix string
    Default Username Prefix
    version string
    TiDB Version
    vpcId string
    VPC ID Used at Creation
    zones InstanceZone[]
    Availability Zones and Subnets Used at Creation 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.
    annotations Sequence[InstanceAnnotationArgs]
    Annotation 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.
    audit_log_config InstanceAuditLogConfigArgs
    Audit Log Configuration
    auto_scaling InstanceAutoScalingArgs
    Auto Scaling
    automated_backup_policy InstanceAutomatedBackupPolicyArgs
    Automatic Backup Policy
    backups Sequence[InstanceBackupArgs]
    Cluster Backup 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.
    cluster_id str
    Cluster ID
    create_time str
    Creation Time (ISO8601)
    display_name str
    Cluster Display Name
    encryption_config InstanceEncryptionConfigArgs
    Data Encryption Configuration
    endpoints InstanceEndpointsArgs
    Connection Endpoint
    high_availability_type str
    High Availability Type
    labels Sequence[InstanceLabelArgs]
    Tags 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.
    name str
    Resource Name: clusters/{clusterId}
    project_name str
    Volcano Engine Project Name
    region_id str
    Deployment Region
    service_plan str
    Service Plan
    spending_limit InstanceSpendingLimitArgs
    Spending Limit Configuration
    state str
    Cluster Status
    tags Sequence[InstanceTagArgs]
    Instance Tags 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.
    update_time str
    Last Updated Time (ISO8601)
    user_prefix str
    Default Username Prefix
    version str
    TiDB Version
    vpc_id str
    VPC ID Used at Creation
    zones Sequence[InstanceZoneArgs]
    Availability Zones and Subnets Used at Creation 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.
    annotations List<Property Map>
    Annotation 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.
    auditLogConfig Property Map
    Audit Log Configuration
    autoScaling Property Map
    Auto Scaling
    automatedBackupPolicy Property Map
    Automatic Backup Policy
    backups List<Property Map>
    Cluster Backup 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.
    clusterId String
    Cluster ID
    createTime String
    Creation Time (ISO8601)
    displayName String
    Cluster Display Name
    encryptionConfig Property Map
    Data Encryption Configuration
    endpoints Property Map
    Connection Endpoint
    highAvailabilityType String
    High Availability Type
    labels List<Property Map>
    Tags 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.
    name String
    Resource Name: clusters/{clusterId}
    projectName String
    Volcano Engine Project Name
    regionId String
    Deployment Region
    servicePlan String
    Service Plan
    spendingLimit Property Map
    Spending Limit Configuration
    state String
    Cluster Status
    tags List<Property Map>
    Instance Tags 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.
    updateTime String
    Last Updated Time (ISO8601)
    userPrefix String
    Default Username Prefix
    version String
    TiDB Version
    vpcId String
    VPC ID Used at Creation
    zones List<Property Map>
    Availability Zones and Subnets Used at Creation 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.

    Supporting Types

    InstanceAnnotation, InstanceAnnotationArgs

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

    InstanceAuditLogConfig, InstanceAuditLogConfigArgs

    Enabled bool
    Enable Audit Log
    Unredacted bool
    Retain Non-Masked Content
    Enabled bool
    Enable Audit Log
    Unredacted bool
    Retain Non-Masked Content
    enabled bool
    Enable Audit Log
    unredacted bool
    Retain Non-Masked Content
    enabled Boolean
    Enable Audit Log
    unredacted Boolean
    Retain Non-Masked Content
    enabled boolean
    Enable Audit Log
    unredacted boolean
    Retain Non-Masked Content
    enabled bool
    Enable Audit Log
    unredacted bool
    Retain Non-Masked Content
    enabled Boolean
    Enable Audit Log
    unredacted Boolean
    Retain Non-Masked Content

    InstanceAutoScaling, InstanceAutoScalingArgs

    MaxRcu int
    Max RCU
    MinRcu int
    Min RCU
    MaxRcu int
    Max RCU
    MinRcu int
    Min RCU
    max_rcu number
    Max RCU
    min_rcu number
    Min RCU
    maxRcu Integer
    Max RCU
    minRcu Integer
    Min RCU
    maxRcu number
    Max RCU
    minRcu number
    Min RCU
    max_rcu int
    Max RCU
    min_rcu int
    Min RCU
    maxRcu Number
    Max RCU
    minRcu Number
    Min RCU

    InstanceAutomatedBackupPolicy, InstanceAutomatedBackupPolicyArgs

    RetentionDays int
    Retention Days
    StartTime string
    Backup Start Time (UTC HH:mm)
    RetentionDays int
    Retention Days
    StartTime string
    Backup Start Time (UTC HH:mm)
    retention_days number
    Retention Days
    start_time string
    Backup Start Time (UTC HH:mm)
    retentionDays Integer
    Retention Days
    startTime String
    Backup Start Time (UTC HH:mm)
    retentionDays number
    Retention Days
    startTime string
    Backup Start Time (UTC HH:mm)
    retention_days int
    Retention Days
    start_time str
    Backup Start Time (UTC HH:mm)
    retentionDays Number
    Retention Days
    startTime String
    Backup Start Time (UTC HH:mm)

    InstanceBackup, InstanceBackupArgs

    BackupId string
    Backup ID
    BackupTime string
    Backup Time
    ClusterId string
    Cluster ID
    CreateTime string
    Creation Time
    ExpireTime string
    Expiration Time
    Name string
    Backup Name
    State string
    Backup Status
    Type string
    Backup Type
    BackupId string
    Backup ID
    BackupTime string
    Backup Time
    ClusterId string
    Cluster ID
    CreateTime string
    Creation Time
    ExpireTime string
    Expiration Time
    Name string
    Backup Name
    State string
    Backup Status
    Type string
    Backup Type
    backup_id string
    Backup ID
    backup_time string
    Backup Time
    cluster_id string
    Cluster ID
    create_time string
    Creation Time
    expire_time string
    Expiration Time
    name string
    Backup Name
    state string
    Backup Status
    type string
    Backup Type
    backupId String
    Backup ID
    backupTime String
    Backup Time
    clusterId String
    Cluster ID
    createTime String
    Creation Time
    expireTime String
    Expiration Time
    name String
    Backup Name
    state String
    Backup Status
    type String
    Backup Type
    backupId string
    Backup ID
    backupTime string
    Backup Time
    clusterId string
    Cluster ID
    createTime string
    Creation Time
    expireTime string
    Expiration Time
    name string
    Backup Name
    state string
    Backup Status
    type string
    Backup Type
    backup_id str
    Backup ID
    backup_time str
    Backup Time
    cluster_id str
    Cluster ID
    create_time str
    Creation Time
    expire_time str
    Expiration Time
    name str
    Backup Name
    state str
    Backup Status
    type str
    Backup Type
    backupId String
    Backup ID
    backupTime String
    Backup Time
    clusterId String
    Cluster ID
    createTime String
    Creation Time
    expireTime String
    Expiration Time
    name String
    Backup Name
    state String
    Backup Status
    type String
    Backup Type

    InstanceEncryptionConfig, InstanceEncryptionConfigArgs

    EnhancedEncryptionEnabled bool
    Enable Enhanced Encryption
    EnhancedEncryptionEnabled bool
    Enable Enhanced Encryption
    enhanced_encryption_enabled bool
    Enable Enhanced Encryption
    enhancedEncryptionEnabled Boolean
    Enable Enhanced Encryption
    enhancedEncryptionEnabled boolean
    Enable Enhanced Encryption
    enhanced_encryption_enabled bool
    Enable Enhanced Encryption
    enhancedEncryptionEnabled Boolean
    Enable Enhanced Encryption

    InstanceEndpoints, InstanceEndpointsArgs

    private_endpoint object
    Private Endpoint
    public_endpoint object
    Public Endpoint

    InstanceEndpointsPrivateEndpoint, InstanceEndpointsPrivateEndpointArgs

    AuthorizedNetworks List<Volcengine.InstanceEndpointsPrivateEndpointAuthorizedNetwork>
    Private VPC Endpoint ID Allowlist 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.
    Disabled bool
    Disable Private Access
    Host string
    Private Hostname
    Port int
    Private Port
    SecurityGroupCount int
    Number of Security Groups Associated with Default Private Endpoint (not returned if query fails)
    ServiceName string
    Private Service Name
    VpcEndpointId string
    Default Private Endpoint ID
    VpcEndpointName string
    Cloud Real Name of Default Private Endpoint (not returned if query fails)
    AuthorizedNetworks []InstanceEndpointsPrivateEndpointAuthorizedNetwork
    Private VPC Endpoint ID Allowlist 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.
    Disabled bool
    Disable Private Access
    Host string
    Private Hostname
    Port int
    Private Port
    SecurityGroupCount int
    Number of Security Groups Associated with Default Private Endpoint (not returned if query fails)
    ServiceName string
    Private Service Name
    VpcEndpointId string
    Default Private Endpoint ID
    VpcEndpointName string
    Cloud Real Name of Default Private Endpoint (not returned if query fails)
    authorized_networks list(object)
    Private VPC Endpoint ID Allowlist 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.
    disabled bool
    Disable Private Access
    host string
    Private Hostname
    port number
    Private Port
    security_group_count number
    Number of Security Groups Associated with Default Private Endpoint (not returned if query fails)
    service_name string
    Private Service Name
    vpc_endpoint_id string
    Default Private Endpoint ID
    vpc_endpoint_name string
    Cloud Real Name of Default Private Endpoint (not returned if query fails)
    authorizedNetworks List<InstanceEndpointsPrivateEndpointAuthorizedNetwork>
    Private VPC Endpoint ID Allowlist 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.
    disabled Boolean
    Disable Private Access
    host String
    Private Hostname
    port Integer
    Private Port
    securityGroupCount Integer
    Number of Security Groups Associated with Default Private Endpoint (not returned if query fails)
    serviceName String
    Private Service Name
    vpcEndpointId String
    Default Private Endpoint ID
    vpcEndpointName String
    Cloud Real Name of Default Private Endpoint (not returned if query fails)
    authorizedNetworks InstanceEndpointsPrivateEndpointAuthorizedNetwork[]
    Private VPC Endpoint ID Allowlist 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.
    disabled boolean
    Disable Private Access
    host string
    Private Hostname
    port number
    Private Port
    securityGroupCount number
    Number of Security Groups Associated with Default Private Endpoint (not returned if query fails)
    serviceName string
    Private Service Name
    vpcEndpointId string
    Default Private Endpoint ID
    vpcEndpointName string
    Cloud Real Name of Default Private Endpoint (not returned if query fails)
    authorized_networks Sequence[InstanceEndpointsPrivateEndpointAuthorizedNetwork]
    Private VPC Endpoint ID Allowlist 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.
    disabled bool
    Disable Private Access
    host str
    Private Hostname
    port int
    Private Port
    security_group_count int
    Number of Security Groups Associated with Default Private Endpoint (not returned if query fails)
    service_name str
    Private Service Name
    vpc_endpoint_id str
    Default Private Endpoint ID
    vpc_endpoint_name str
    Cloud Real Name of Default Private Endpoint (not returned if query fails)
    authorizedNetworks List<Property Map>
    Private VPC Endpoint ID Allowlist 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.
    disabled Boolean
    Disable Private Access
    host String
    Private Hostname
    port Number
    Private Port
    securityGroupCount Number
    Number of Security Groups Associated with Default Private Endpoint (not returned if query fails)
    serviceName String
    Private Service Name
    vpcEndpointId String
    Default Private Endpoint ID
    vpcEndpointName String
    Cloud Real Name of Default Private Endpoint (not returned if query fails)

    InstanceEndpointsPrivateEndpointAuthorizedNetwork, InstanceEndpointsPrivateEndpointAuthorizedNetworkArgs

    DisplayName string
    Descriptive Name
    SecurityGroupCount string
    Number of Security Groups Associated with Endpoint (not returned if query fails)
    VpcEndpointId string
    VPC Endpoint ID。
    VpcEndpointName string
    Cloud Real Name of VPC Endpoint (not returned if query fails)
    DisplayName string
    Descriptive Name
    SecurityGroupCount string
    Number of Security Groups Associated with Endpoint (not returned if query fails)
    VpcEndpointId string
    VPC Endpoint ID。
    VpcEndpointName string
    Cloud Real Name of VPC Endpoint (not returned if query fails)
    display_name string
    Descriptive Name
    security_group_count string
    Number of Security Groups Associated with Endpoint (not returned if query fails)
    vpc_endpoint_id string
    VPC Endpoint ID。
    vpc_endpoint_name string
    Cloud Real Name of VPC Endpoint (not returned if query fails)
    displayName String
    Descriptive Name
    securityGroupCount String
    Number of Security Groups Associated with Endpoint (not returned if query fails)
    vpcEndpointId String
    VPC Endpoint ID。
    vpcEndpointName String
    Cloud Real Name of VPC Endpoint (not returned if query fails)
    displayName string
    Descriptive Name
    securityGroupCount string
    Number of Security Groups Associated with Endpoint (not returned if query fails)
    vpcEndpointId string
    VPC Endpoint ID。
    vpcEndpointName string
    Cloud Real Name of VPC Endpoint (not returned if query fails)
    display_name str
    Descriptive Name
    security_group_count str
    Number of Security Groups Associated with Endpoint (not returned if query fails)
    vpc_endpoint_id str
    VPC Endpoint ID。
    vpc_endpoint_name str
    Cloud Real Name of VPC Endpoint (not returned if query fails)
    displayName String
    Descriptive Name
    securityGroupCount String
    Number of Security Groups Associated with Endpoint (not returned if query fails)
    vpcEndpointId String
    VPC Endpoint ID。
    vpcEndpointName String
    Cloud Real Name of VPC Endpoint (not returned if query fails)

    InstanceEndpointsPublicEndpoint, InstanceEndpointsPublicEndpointArgs

    AuthorizedNetworks List<Volcengine.InstanceEndpointsPublicEndpointAuthorizedNetwork>
    IP Allowlist 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.
    Disabled bool
    Disable Public Access
    Host string
    Public Hostname
    Port int
    Public Port
    AuthorizedNetworks []InstanceEndpointsPublicEndpointAuthorizedNetwork
    IP Allowlist 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.
    Disabled bool
    Disable Public Access
    Host string
    Public Hostname
    Port int
    Public Port
    authorized_networks list(object)
    IP Allowlist 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.
    disabled bool
    Disable Public Access
    host string
    Public Hostname
    port number
    Public Port
    authorizedNetworks List<InstanceEndpointsPublicEndpointAuthorizedNetwork>
    IP Allowlist 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.
    disabled Boolean
    Disable Public Access
    host String
    Public Hostname
    port Integer
    Public Port
    authorizedNetworks InstanceEndpointsPublicEndpointAuthorizedNetwork[]
    IP Allowlist 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.
    disabled boolean
    Disable Public Access
    host string
    Public Hostname
    port number
    Public Port
    authorized_networks Sequence[InstanceEndpointsPublicEndpointAuthorizedNetwork]
    IP Allowlist 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.
    disabled bool
    Disable Public Access
    host str
    Public Hostname
    port int
    Public Port
    authorizedNetworks List<Property Map>
    IP Allowlist 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.
    disabled Boolean
    Disable Public Access
    host String
    Public Hostname
    port Number
    Public Port

    InstanceEndpointsPublicEndpointAuthorizedNetwork, InstanceEndpointsPublicEndpointAuthorizedNetworkArgs

    DisplayName string
    Authorized Network Name
    EndIpAddress string
    End IP
    StartIpAddress string
    Start IP
    DisplayName string
    Authorized Network Name
    EndIpAddress string
    End IP
    StartIpAddress string
    Start IP
    display_name string
    Authorized Network Name
    end_ip_address string
    End IP
    start_ip_address string
    Start IP
    displayName String
    Authorized Network Name
    endIpAddress String
    End IP
    startIpAddress String
    Start IP
    displayName string
    Authorized Network Name
    endIpAddress string
    End IP
    startIpAddress string
    Start IP
    display_name str
    Authorized Network Name
    end_ip_address str
    End IP
    start_ip_address str
    Start IP
    displayName String
    Authorized Network Name
    endIpAddress String
    End IP
    startIpAddress String
    Start IP

    InstanceLabel, InstanceLabelArgs

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

    InstanceSpendingLimit, InstanceSpendingLimitArgs

    Monthly int
    Monthly Spending Limit
    Monthly int
    Monthly Spending Limit
    monthly number
    Monthly Spending Limit
    monthly Integer
    Monthly Spending Limit
    monthly number
    Monthly Spending Limit
    monthly int
    Monthly Spending Limit
    monthly Number
    Monthly Spending Limit

    InstanceTag, InstanceTagArgs

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

    InstanceZone, InstanceZoneArgs

    SubnetId string
    Subnet ID
    ZoneId string
    Availability Zone ID
    SubnetId string
    Subnet ID
    ZoneId string
    Availability Zone ID
    subnet_id string
    Subnet ID
    zone_id string
    Availability Zone ID
    subnetId String
    Subnet ID
    zoneId String
    Availability Zone ID
    subnetId string
    Subnet ID
    zoneId string
    Availability Zone ID
    subnet_id str
    Subnet ID
    zone_id str
    Availability Zone ID
    subnetId String
    Subnet ID
    zoneId String
    Availability Zone ID

    Import

    $ pulumi import volcenginecc:tidb/instance:Instance example "cluster_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.66
    published on Thursday, Nov 19, 2026 by Volcengine

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial