published on Thursday, Nov 19, 2026 by Volcengine
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:
- Auto
Scaling Volcengine.Instance Auto Scaling - Auto Scaling
- Vpc
Id string - VPC ID Used at Creation
- Zones
List<Volcengine.
Instance Zone> - 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 Volcengine.Policy Instance Automated Backup Policy - Automatic Backup Policy
- Display
Name string - Cluster Display Name
- Encryption
Config Volcengine.Instance Encryption Config - Data Encryption Configuration
- High
Availability stringType - High Availability Type
- Project
Name string - Volcano Engine Project Name
- Region
Id string - Deployment Region
- Service
Plan string - Service Plan
-
List<Volcengine.
Instance Tag> - 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 InstanceAuto Scaling Args - Auto Scaling
- Vpc
Id string - VPC ID Used at Creation
- Zones
[]Instance
Zone Args - 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 InstancePolicy Automated Backup Policy Args - Automatic Backup Policy
- Display
Name string - Cluster Display Name
- Encryption
Config InstanceEncryption Config Args - Data Encryption Configuration
- High
Availability stringType - High Availability Type
- Project
Name string - Volcano Engine Project Name
- Region
Id string - Deployment Region
- Service
Plan string - Service Plan
-
[]Instance
Tag Args - 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_ objectpolicy - Automatic Backup Policy
- display_
name string - Cluster Display Name
- encryption_
config object - Data Encryption Configuration
- high_
availability_ stringtype - High Availability Type
- project_
name string - Volcano Engine Project Name
- region_
id string - Deployment Region
- service_
plan string - Service Plan
- 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.
- auto
Scaling InstanceAuto Scaling - Auto Scaling
- vpc
Id String - VPC ID Used at Creation
- zones
List<Instance
Zone> - 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 InstancePolicy Automated Backup Policy - Automatic Backup Policy
- display
Name String - Cluster Display Name
- encryption
Config InstanceEncryption Config - Data Encryption Configuration
- high
Availability StringType - High Availability Type
- project
Name String - Volcano Engine Project Name
- region
Id String - Deployment Region
- service
Plan String - Service Plan
-
List<Instance
Tag> - 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 InstanceAuto Scaling - Auto Scaling
- vpc
Id string - VPC ID Used at Creation
- zones
Instance
Zone[] - 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 InstancePolicy Automated Backup Policy - Automatic Backup Policy
- display
Name string - Cluster Display Name
- encryption
Config InstanceEncryption Config - Data Encryption Configuration
- high
Availability stringType - High Availability Type
- project
Name string - Volcano Engine Project Name
- region
Id string - Deployment Region
- service
Plan string - Service Plan
-
Instance
Tag[] - 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 InstanceAuto Scaling Args - Auto Scaling
- vpc_
id str - VPC ID Used at Creation
- zones
Sequence[Instance
Zone Args] - 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_ Instancepolicy Automated Backup Policy Args - Automatic Backup Policy
- display_
name str - Cluster Display Name
- encryption_
config InstanceEncryption Config Args - Data Encryption Configuration
- high_
availability_ strtype - High Availability Type
- project_
name str - Volcano Engine Project Name
- region_
id str - Deployment Region
- service_
plan str - Service Plan
-
Sequence[Instance
Tag Args] - 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 Property Map - Auto Scaling
- vpc
Id 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.
- automated
Backup Property MapPolicy - Automatic Backup Policy
- display
Name String - Cluster Display Name
- encryption
Config Property Map - Data Encryption Configuration
- high
Availability StringType - High Availability Type
- project
Name String - Volcano Engine Project Name
- region
Id String - Deployment Region
- service
Plan String - Service Plan
- 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.
Instance Annotation> - 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 Volcengine.Config Instance Audit Log Config - Audit Log Configuration
- Backups
List<Volcengine.
Instance Backup> - 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
Volcengine.
Instance Endpoints - Connection Endpoint
- Id string
- The provider-assigned unique ID for this managed resource.
- Labels
List<Volcengine.
Instance Label> - 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 Volcengine.Instance Spending Limit - 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
[]Instance
Annotation - 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 InstanceConfig Audit Log Config - Audit Log Configuration
- Backups
[]Instance
Backup - 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
Instance
Endpoints - Connection Endpoint
- Id string
- The provider-assigned unique ID for this managed resource.
- Labels
[]Instance
Label - 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 InstanceSpending Limit - 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(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_ objectconfig - 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<Instance
Annotation> - 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 InstanceConfig Audit Log Config - Audit Log Configuration
- backups
List<Instance
Backup> - 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
Instance
Endpoints - Connection Endpoint
- id String
- The provider-assigned unique ID for this managed resource.
- labels
List<Instance
Label> - 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 InstanceSpending Limit - 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
Instance
Annotation[] - 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 InstanceConfig Audit Log Config - Audit Log Configuration
- backups
Instance
Backup[] - 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
Instance
Endpoints - Connection Endpoint
- id string
- The provider-assigned unique ID for this managed resource.
- labels
Instance
Label[] - 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 InstanceSpending Limit - 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
Sequence[Instance
Annotation] - 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_ Instanceconfig Audit Log Config - Audit Log Configuration
- backups
Sequence[Instance
Backup] - 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
Instance
Endpoints - Connection Endpoint
- id str
- The provider-assigned unique ID for this managed resource.
- labels
Sequence[Instance
Label] - 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 InstanceSpending Limit - 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.
- audit
Log Property MapConfig - 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.
- cluster
Id String - Cluster ID
- create
Time 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}
- spending
Limit Property Map - Spending Limit Configuration
- state String
- Cluster Status
- update
Time String - Last Updated Time (ISO8601)
- user
Prefix 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) -> Instancefunc 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.
- Annotations
List<Volcengine.
Instance Annotation> - 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 Volcengine.Config Instance Audit Log Config - Audit Log Configuration
- Auto
Scaling Volcengine.Instance Auto Scaling - Auto Scaling
- Automated
Backup Volcengine.Policy Instance Automated Backup Policy - Automatic Backup Policy
- Backups
List<Volcengine.
Instance Backup> - 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 Volcengine.Instance Encryption Config - Data Encryption Configuration
- Endpoints
Volcengine.
Instance Endpoints - Connection Endpoint
- High
Availability stringType - High Availability Type
- Labels
List<Volcengine.
Instance Label> - 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 Volcengine.Instance Spending Limit - Spending Limit Configuration
- State string
- Cluster Status
-
List<Volcengine.
Instance Tag> - 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<Volcengine.
Instance Zone> - 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
[]Instance
Annotation Args - 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 InstanceConfig Audit Log Config Args - Audit Log Configuration
- Auto
Scaling InstanceAuto Scaling Args - Auto Scaling
- Automated
Backup InstancePolicy Automated Backup Policy Args - Automatic Backup Policy
- Backups
[]Instance
Backup Args - 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 InstanceEncryption Config Args - Data Encryption Configuration
- Endpoints
Instance
Endpoints Args - Connection Endpoint
- High
Availability stringType - High Availability Type
- Labels
[]Instance
Label Args - 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 InstanceSpending Limit Args - Spending Limit Configuration
- State string
- Cluster Status
-
[]Instance
Tag Args - 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
[]Instance
Zone Args - 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_ objectconfig - Audit Log Configuration
- auto_
scaling object - Auto Scaling
- automated_
backup_ objectpolicy - 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_ stringtype - 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
- 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<Instance
Annotation> - 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 InstanceConfig Audit Log Config - Audit Log Configuration
- auto
Scaling InstanceAuto Scaling - Auto Scaling
- automated
Backup InstancePolicy Automated Backup Policy - Automatic Backup Policy
- backups
List<Instance
Backup> - 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 InstanceEncryption Config - Data Encryption Configuration
- endpoints
Instance
Endpoints - Connection Endpoint
- high
Availability StringType - High Availability Type
- labels
List<Instance
Label> - 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 InstanceSpending Limit - Spending Limit Configuration
- state String
- Cluster Status
-
List<Instance
Tag> - 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<Instance
Zone> - 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
Instance
Annotation[] - 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 InstanceConfig Audit Log Config - Audit Log Configuration
- auto
Scaling InstanceAuto Scaling - Auto Scaling
- automated
Backup InstancePolicy Automated Backup Policy - Automatic Backup Policy
- backups
Instance
Backup[] - 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 InstanceEncryption Config - Data Encryption Configuration
- endpoints
Instance
Endpoints - Connection Endpoint
- high
Availability stringType - High Availability Type
- labels
Instance
Label[] - 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 InstanceSpending Limit - Spending Limit Configuration
- state string
- Cluster Status
-
Instance
Tag[] - 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
Instance
Zone[] - 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[Instance
Annotation Args] - 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_ Instanceconfig Audit Log Config Args - Audit Log Configuration
- auto_
scaling InstanceAuto Scaling Args - Auto Scaling
- automated_
backup_ Instancepolicy Automated Backup Policy Args - Automatic Backup Policy
- backups
Sequence[Instance
Backup Args] - 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 InstanceEncryption Config Args - Data Encryption Configuration
- endpoints
Instance
Endpoints Args - Connection Endpoint
- high_
availability_ strtype - High Availability Type
- labels
Sequence[Instance
Label Args] - 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 InstanceSpending Limit Args - Spending Limit Configuration
- state str
- Cluster Status
-
Sequence[Instance
Tag Args] - 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[Instance
Zone Args] - 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.
- audit
Log Property MapConfig - Audit Log Configuration
- auto
Scaling Property Map - Auto Scaling
- automated
Backup Property MapPolicy - 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.
- cluster
Id String - Cluster ID
- create
Time String - Creation Time (ISO8601)
- display
Name String - Cluster Display Name
- encryption
Config Property Map - Data Encryption Configuration
- endpoints Property Map
- Connection Endpoint
- high
Availability StringType - 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}
- project
Name String - Volcano Engine Project Name
- region
Id String - Deployment Region
- service
Plan String - Service Plan
- spending
Limit Property Map - Spending Limit Configuration
- state String
- Cluster Status
- 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.
- 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<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
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
InstanceAutomatedBackupPolicy, InstanceAutomatedBackupPolicyArgs
- Retention
Days int - Retention Days
- Start
Time string - Backup Start Time (UTC HH:mm)
- Retention
Days int - Retention Days
- Start
Time string - Backup Start Time (UTC HH:mm)
- retention_
days number - Retention Days
- start_
time string - Backup Start Time (UTC HH:mm)
- retention
Days Integer - Retention Days
- start
Time String - Backup Start Time (UTC HH:mm)
- retention
Days number - Retention Days
- start
Time string - Backup Start Time (UTC HH:mm)
- retention_
days int - Retention Days
- start_
time str - Backup Start Time (UTC HH:mm)
- retention
Days Number - Retention Days
- start
Time String - Backup Start Time (UTC HH:mm)
InstanceBackup, InstanceBackupArgs
- 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
- 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
- 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
- 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
- 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
- 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
- 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
InstanceEncryptionConfig, InstanceEncryptionConfigArgs
- Enhanced
Encryption boolEnabled - Enable Enhanced Encryption
- Enhanced
Encryption boolEnabled - Enable Enhanced Encryption
- enhanced_
encryption_ boolenabled - Enable Enhanced Encryption
- enhanced
Encryption BooleanEnabled - Enable Enhanced Encryption
- enhanced
Encryption booleanEnabled - Enable Enhanced Encryption
- enhanced_
encryption_ boolenabled - Enable Enhanced Encryption
- enhanced
Encryption BooleanEnabled - Enable Enhanced Encryption
InstanceEndpoints, InstanceEndpointsArgs
- Private
Endpoint Volcengine.Instance Endpoints Private Endpoint - Private Endpoint
- Public
Endpoint Volcengine.Instance Endpoints Public Endpoint - Public Endpoint
- Private
Endpoint InstanceEndpoints Private Endpoint - Private Endpoint
- Public
Endpoint InstanceEndpoints Public Endpoint - Public Endpoint
- private_
endpoint object - Private Endpoint
- public_
endpoint object - Public Endpoint
- private
Endpoint InstanceEndpoints Private Endpoint - Private Endpoint
- public
Endpoint InstanceEndpoints Public Endpoint - Public Endpoint
- private
Endpoint InstanceEndpoints Private Endpoint - Private Endpoint
- public
Endpoint InstanceEndpoints Public Endpoint - Public Endpoint
- private_
endpoint InstanceEndpoints Private Endpoint - Private Endpoint
- public_
endpoint InstanceEndpoints Public Endpoint - Public Endpoint
- private
Endpoint Property Map - Private Endpoint
- public
Endpoint Property Map - Public Endpoint
InstanceEndpointsPrivateEndpoint, InstanceEndpointsPrivateEndpointArgs
-
List<Volcengine.
Instance Endpoints Private Endpoint Authorized Network> - 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
- Security
Group intCount - Number of Security Groups Associated with Default Private Endpoint (not returned if query fails)
- Service
Name string - Private Service Name
- Vpc
Endpoint stringId - Default Private Endpoint ID
- Vpc
Endpoint stringName - Cloud Real Name of Default Private Endpoint (not returned if query fails)
-
[]Instance
Endpoints Private Endpoint Authorized Network - 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
- Security
Group intCount - Number of Security Groups Associated with Default Private Endpoint (not returned if query fails)
- Service
Name string - Private Service Name
- Vpc
Endpoint stringId - Default Private Endpoint ID
- Vpc
Endpoint stringName - Cloud Real Name of Default Private Endpoint (not returned if query fails)
- 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_ numbercount - Number of Security Groups Associated with Default Private Endpoint (not returned if query fails)
- service_
name string - Private Service Name
- vpc_
endpoint_ stringid - Default Private Endpoint ID
- vpc_
endpoint_ stringname - Cloud Real Name of Default Private Endpoint (not returned if query fails)
-
List<Instance
Endpoints Private Endpoint Authorized Network> - 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
- security
Group IntegerCount - Number of Security Groups Associated with Default Private Endpoint (not returned if query fails)
- service
Name String - Private Service Name
- vpc
Endpoint StringId - Default Private Endpoint ID
- vpc
Endpoint StringName - Cloud Real Name of Default Private Endpoint (not returned if query fails)
-
Instance
Endpoints Private Endpoint Authorized Network[] - 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
- security
Group numberCount - Number of Security Groups Associated with Default Private Endpoint (not returned if query fails)
- service
Name string - Private Service Name
- vpc
Endpoint stringId - Default Private Endpoint ID
- vpc
Endpoint stringName - Cloud Real Name of Default Private Endpoint (not returned if query fails)
-
Sequence[Instance
Endpoints Private Endpoint Authorized Network] - 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_ intcount - Number of Security Groups Associated with Default Private Endpoint (not returned if query fails)
- service_
name str - Private Service Name
- vpc_
endpoint_ strid - Default Private Endpoint ID
- vpc_
endpoint_ strname - Cloud Real Name of Default Private Endpoint (not returned if query fails)
- 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
- security
Group NumberCount - Number of Security Groups Associated with Default Private Endpoint (not returned if query fails)
- service
Name String - Private Service Name
- vpc
Endpoint StringId - Default Private Endpoint ID
- vpc
Endpoint StringName - Cloud Real Name of Default Private Endpoint (not returned if query fails)
InstanceEndpointsPrivateEndpointAuthorizedNetwork, InstanceEndpointsPrivateEndpointAuthorizedNetworkArgs
- Display
Name string - Descriptive Name
- Security
Group stringCount - Number of Security Groups Associated with Endpoint (not returned if query fails)
- Vpc
Endpoint stringId - VPC Endpoint ID。
- Vpc
Endpoint stringName - Cloud Real Name of VPC Endpoint (not returned if query fails)
- Display
Name string - Descriptive Name
- Security
Group stringCount - Number of Security Groups Associated with Endpoint (not returned if query fails)
- Vpc
Endpoint stringId - VPC Endpoint ID。
- Vpc
Endpoint stringName - Cloud Real Name of VPC Endpoint (not returned if query fails)
- display_
name string - Descriptive Name
- security_
group_ stringcount - Number of Security Groups Associated with Endpoint (not returned if query fails)
- vpc_
endpoint_ stringid - VPC Endpoint ID。
- vpc_
endpoint_ stringname - Cloud Real Name of VPC Endpoint (not returned if query fails)
- display
Name String - Descriptive Name
- security
Group StringCount - Number of Security Groups Associated with Endpoint (not returned if query fails)
- vpc
Endpoint StringId - VPC Endpoint ID。
- vpc
Endpoint StringName - Cloud Real Name of VPC Endpoint (not returned if query fails)
- display
Name string - Descriptive Name
- security
Group stringCount - Number of Security Groups Associated with Endpoint (not returned if query fails)
- vpc
Endpoint stringId - VPC Endpoint ID。
- vpc
Endpoint stringName - Cloud Real Name of VPC Endpoint (not returned if query fails)
- display_
name str - Descriptive Name
- security_
group_ strcount - Number of Security Groups Associated with Endpoint (not returned if query fails)
- vpc_
endpoint_ strid - VPC Endpoint ID。
- vpc_
endpoint_ strname - Cloud Real Name of VPC Endpoint (not returned if query fails)
- display
Name String - Descriptive Name
- security
Group StringCount - Number of Security Groups Associated with Endpoint (not returned if query fails)
- vpc
Endpoint StringId - VPC Endpoint ID。
- vpc
Endpoint StringName - Cloud Real Name of VPC Endpoint (not returned if query fails)
InstanceEndpointsPublicEndpoint, InstanceEndpointsPublicEndpointArgs
-
List<Volcengine.
Instance Endpoints Public Endpoint Authorized Network> - 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
-
[]Instance
Endpoints Public Endpoint Authorized Network - 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
- 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
-
List<Instance
Endpoints Public Endpoint Authorized Network> - 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
-
Instance
Endpoints Public Endpoint Authorized Network[] - 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
-
Sequence[Instance
Endpoints Public Endpoint Authorized Network] - 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
- 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
- Display
Name string - Authorized Network Name
- End
Ip stringAddress - End IP
- Start
Ip stringAddress - Start IP
- Display
Name string - Authorized Network Name
- End
Ip stringAddress - End IP
- Start
Ip stringAddress - Start IP
- display_
name string - Authorized Network Name
- end_
ip_ stringaddress - End IP
- start_
ip_ stringaddress - Start IP
- display
Name String - Authorized Network Name
- end
Ip StringAddress - End IP
- start
Ip StringAddress - Start IP
- display
Name string - Authorized Network Name
- end
Ip stringAddress - End IP
- start
Ip stringAddress - Start IP
- display_
name str - Authorized Network Name
- end_
ip_ straddress - End IP
- start_
ip_ straddress - Start IP
- display
Name String - Authorized Network Name
- end
Ip StringAddress - End IP
- start
Ip StringAddress - Start IP
InstanceLabel, InstanceLabelArgs
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
InstanceZone, InstanceZoneArgs
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
volcengineccTerraform Provider.
published on Thursday, Nov 19, 2026 by Volcengine