published on Thursday, Nov 19, 2026 by Volcengine
published on Thursday, Nov 19, 2026 by Volcengine
Branch resources under the TiDB cluster, corresponding to the branches object
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as volcenginecc from "@volcengine/pulumi-volcenginecc";
const example = new volcenginecc.tidb.Branch("example", {
clusterId: "cluster_id-xxx",
displayName: "ccapi-tidb-branch-full",
parentId: "parent_id",
parentTimestamp: "YYYY-MM-DD'T'hh:mm:ss'Z'",
password: "Example@Test1234",
});
import pulumi
import pulumi_volcenginecc as volcenginecc
example = volcenginecc.tidb.Branch("example",
cluster_id="cluster_id-xxx",
display_name="ccapi-tidb-branch-full",
parent_id="parent_id",
parent_timestamp="YYYY-MM-DD'T'hh:mm:ss'Z'",
password="Example@Test1234")
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.NewBranch(ctx, "example", &tidb.BranchArgs{
ClusterId: pulumi.String("cluster_id-xxx"),
DisplayName: pulumi.String("ccapi-tidb-branch-full"),
ParentId: pulumi.String("parent_id"),
ParentTimestamp: pulumi.String("YYYY-MM-DD'T'hh:mm:ss'Z'"),
Password: pulumi.String("Example@Test1234"),
})
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.Branch("example", new()
{
ClusterId = "cluster_id-xxx",
DisplayName = "ccapi-tidb-branch-full",
ParentId = "parent_id",
ParentTimestamp = "YYYY-MM-DD'T'hh:mm:ss'Z'",
Password = "Example@Test1234",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.tidb.Branch;
import com.volcengine.volcenginecc.tidb.BranchArgs;
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 Branch("example", BranchArgs.builder()
.clusterId("cluster_id-xxx")
.displayName("ccapi-tidb-branch-full")
.parentId("parent_id")
.parentTimestamp("YYYY-MM-DD'T'hh:mm:ss'Z'")
.password("Example@Test1234")
.build());
}
}
resources:
example:
type: volcenginecc:tidb:Branch
properties:
clusterId: cluster_id-xxx
displayName: ccapi-tidb-branch-full
parentId: parent_id
parentTimestamp: YYYY-MM-DD'T'hh:mm:ss'Z'
password: Example@Test1234
pulumi {
required_providers {
volcenginecc = {
source = "pulumi/volcenginecc"
}
}
}
resource "volcenginecc_tidb_branch" "example" {
cluster_id = "cluster_id-xxx"
display_name = "ccapi-tidb-branch-full"
parent_id = "parent_id"
parent_timestamp = "YYYY-MM-DD'T'hh:mm:ss'Z'"
password = "Example@Test1234"
}
Create Branch Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Branch(name: string, args: BranchArgs, opts?: CustomResourceOptions);@overload
def Branch(resource_name: str,
args: BranchArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Branch(resource_name: str,
opts: Optional[ResourceOptions] = None,
cluster_id: Optional[str] = None,
display_name: Optional[str] = None,
parent_id: Optional[str] = None,
parent_timestamp: Optional[str] = None,
password: Optional[str] = None,
reset_branch: Optional[bool] = None)func NewBranch(ctx *Context, name string, args BranchArgs, opts ...ResourceOption) (*Branch, error)public Branch(string name, BranchArgs args, CustomResourceOptions? opts = null)
public Branch(String name, BranchArgs args)
public Branch(String name, BranchArgs args, CustomResourceOptions options)
type: volcenginecc:tidb:Branch
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "volcenginecc_tidb_branch" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args BranchArgs
- 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 BranchArgs
- 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 BranchArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BranchArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BranchArgs
- 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 branchResource = new Volcenginecc.Tidb.Branch("branchResource", new()
{
ClusterId = "string",
DisplayName = "string",
ParentId = "string",
ParentTimestamp = "string",
Password = "string",
ResetBranch = false,
});
example, err := tidb.NewBranch(ctx, "branchResource", &tidb.BranchArgs{
ClusterId: pulumi.String("string"),
DisplayName: pulumi.String("string"),
ParentId: pulumi.String("string"),
ParentTimestamp: pulumi.String("string"),
Password: pulumi.String("string"),
ResetBranch: pulumi.Bool(false),
})
resource "volcenginecc_tidb_branch" "branchResource" {
lifecycle {
create_before_destroy = true
}
cluster_id = "string"
display_name = "string"
parent_id = "string"
parent_timestamp = "string"
password = "string"
reset_branch = false
}
var branchResource = new Branch("branchResource", BranchArgs.builder()
.clusterId("string")
.displayName("string")
.parentId("string")
.parentTimestamp("string")
.password("string")
.resetBranch(false)
.build());
branch_resource = volcenginecc.tidb.Branch("branchResource",
cluster_id="string",
display_name="string",
parent_id="string",
parent_timestamp="string",
password="string",
reset_branch=False)
const branchResource = new volcenginecc.tidb.Branch("branchResource", {
clusterId: "string",
displayName: "string",
parentId: "string",
parentTimestamp: "string",
password: "string",
resetBranch: false,
});
type: volcenginecc:tidb:Branch
properties:
clusterId: string
displayName: string
parentId: string
parentTimestamp: string
password: string
resetBranch: false
Branch 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 Branch resource accepts the following input properties:
- Cluster
Id string - Cluster ID
- Display
Name string - Branch display name
- Parent
Id string - Parent branch ID
- Parent
Timestamp string - Timestamp of derivation from the parent branch
- Password string
- Branch root password, only for setting or changing the password (not returned after writing)
- Reset
Branch bool - Reset branch. Resetting briefly changes the branch status before returning to READY; only used to trigger actions (no return value)
- Cluster
Id string - Cluster ID
- Display
Name string - Branch display name
- Parent
Id string - Parent branch ID
- Parent
Timestamp string - Timestamp of derivation from the parent branch
- Password string
- Branch root password, only for setting or changing the password (not returned after writing)
- Reset
Branch bool - Reset branch. Resetting briefly changes the branch status before returning to READY; only used to trigger actions (no return value)
- cluster_
id string - Cluster ID
- display_
name string - Branch display name
- parent_
id string - Parent branch ID
- parent_
timestamp string - Timestamp of derivation from the parent branch
- password string
- Branch root password, only for setting or changing the password (not returned after writing)
- reset_
branch bool - Reset branch. Resetting briefly changes the branch status before returning to READY; only used to trigger actions (no return value)
- cluster
Id String - Cluster ID
- display
Name String - Branch display name
- parent
Id String - Parent branch ID
- parent
Timestamp String - Timestamp of derivation from the parent branch
- password String
- Branch root password, only for setting or changing the password (not returned after writing)
- reset
Branch Boolean - Reset branch. Resetting briefly changes the branch status before returning to READY; only used to trigger actions (no return value)
- cluster
Id string - Cluster ID
- display
Name string - Branch display name
- parent
Id string - Parent branch ID
- parent
Timestamp string - Timestamp of derivation from the parent branch
- password string
- Branch root password, only for setting or changing the password (not returned after writing)
- reset
Branch boolean - Reset branch. Resetting briefly changes the branch status before returning to READY; only used to trigger actions (no return value)
- cluster_
id str - Cluster ID
- display_
name str - Branch display name
- parent_
id str - Parent branch ID
- parent_
timestamp str - Timestamp of derivation from the parent branch
- password str
- Branch root password, only for setting or changing the password (not returned after writing)
- reset_
branch bool - Reset branch. Resetting briefly changes the branch status before returning to READY; only used to trigger actions (no return value)
- cluster
Id String - Cluster ID
- display
Name String - Branch display name
- parent
Id String - Parent branch ID
- parent
Timestamp String - Timestamp of derivation from the parent branch
- password String
- Branch root password, only for setting or changing the password (not returned after writing)
- reset
Branch Boolean - Reset branch. Resetting briefly changes the branch status before returning to READY; only used to trigger actions (no return value)
Outputs
All input properties are implicitly available as output properties. Additionally, the Branch resource produces the following output properties:
- Annotations
List<Volcengine.
Branch 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.
- Branch
Id string - Branch ID, assigned by the creation API
- Create
Time string - Creation time
- Created
By string - Creator identifier
- Endpoints
Volcengine.
Branch Endpoints - Branch endpoint configuration
- Has
Set boolPwd - Root password set
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Branch resource name
- Parent
Display stringName - Parent branch display name
- Project
Name string - Name of the project to which the IP address pool belongs
- State string
- Branch status (e.g., CREATING, READY)
- Update
Time string - Update time
- Usages
Volcengine.
Branch Usages - Branch resource usage
- User
Prefix string - Default username prefix
- Annotations
[]Branch
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.
- Branch
Id string - Branch ID, assigned by the creation API
- Create
Time string - Creation time
- Created
By string - Creator identifier
- Endpoints
Branch
Endpoints - Branch endpoint configuration
- Has
Set boolPwd - Root password set
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Branch resource name
- Parent
Display stringName - Parent branch display name
- Project
Name string - Name of the project to which the IP address pool belongs
- State string
- Branch status (e.g., CREATING, READY)
- Update
Time string - Update time
- Usages
Branch
Usages - Branch resource usage
- User
Prefix string - Default username prefix
- 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.
- branch_
id string - Branch ID, assigned by the creation API
- create_
time string - Creation time
- created_
by string - Creator identifier
- endpoints object
- Branch endpoint configuration
- has_
set_ boolpwd - Root password set
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- Branch resource name
- parent_
display_ stringname - Parent branch display name
- project_
name string - Name of the project to which the IP address pool belongs
- state string
- Branch status (e.g., CREATING, READY)
- update_
time string - Update time
- usages object
- Branch resource usage
- user_
prefix string - Default username prefix
- annotations
List<Branch
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.
- branch
Id String - Branch ID, assigned by the creation API
- create
Time String - Creation time
- created
By String - Creator identifier
- endpoints
Branch
Endpoints - Branch endpoint configuration
- has
Set BooleanPwd - Root password set
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- Branch resource name
- parent
Display StringName - Parent branch display name
- project
Name String - Name of the project to which the IP address pool belongs
- state String
- Branch status (e.g., CREATING, READY)
- update
Time String - Update time
- usages
Branch
Usages - Branch resource usage
- user
Prefix String - Default username prefix
- annotations
Branch
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.
- branch
Id string - Branch ID, assigned by the creation API
- create
Time string - Creation time
- created
By string - Creator identifier
- endpoints
Branch
Endpoints - Branch endpoint configuration
- has
Set booleanPwd - Root password set
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- Branch resource name
- parent
Display stringName - Parent branch display name
- project
Name string - Name of the project to which the IP address pool belongs
- state string
- Branch status (e.g., CREATING, READY)
- update
Time string - Update time
- usages
Branch
Usages - Branch resource usage
- user
Prefix string - Default username prefix
- annotations
Sequence[Branch
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.
- branch_
id str - Branch ID, assigned by the creation API
- create_
time str - Creation time
- created_
by str - Creator identifier
- endpoints
Branch
Endpoints - Branch endpoint configuration
- has_
set_ boolpwd - Root password set
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- Branch resource name
- parent_
display_ strname - Parent branch display name
- project_
name str - Name of the project to which the IP address pool belongs
- state str
- Branch status (e.g., CREATING, READY)
- update_
time str - Update time
- usages
Branch
Usages - Branch resource usage
- user_
prefix str - Default username prefix
- 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.
- branch
Id String - Branch ID, assigned by the creation API
- create
Time String - Creation time
- created
By String - Creator identifier
- endpoints Property Map
- Branch endpoint configuration
- has
Set BooleanPwd - Root password set
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- Branch resource name
- parent
Display StringName - Parent branch display name
- project
Name String - Name of the project to which the IP address pool belongs
- state String
- Branch status (e.g., CREATING, READY)
- update
Time String - Update time
- usages Property Map
- Branch resource usage
- user
Prefix String - Default username prefix
Look up Existing Branch Resource
Get an existing Branch 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?: BranchState, opts?: CustomResourceOptions): Branch@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
annotations: Optional[Sequence[BranchAnnotationArgs]] = None,
branch_id: Optional[str] = None,
cluster_id: Optional[str] = None,
create_time: Optional[str] = None,
created_by: Optional[str] = None,
display_name: Optional[str] = None,
endpoints: Optional[BranchEndpointsArgs] = None,
has_set_pwd: Optional[bool] = None,
name: Optional[str] = None,
parent_display_name: Optional[str] = None,
parent_id: Optional[str] = None,
parent_timestamp: Optional[str] = None,
password: Optional[str] = None,
project_name: Optional[str] = None,
reset_branch: Optional[bool] = None,
state: Optional[str] = None,
update_time: Optional[str] = None,
usages: Optional[BranchUsagesArgs] = None,
user_prefix: Optional[str] = None) -> Branchfunc GetBranch(ctx *Context, name string, id IDInput, state *BranchState, opts ...ResourceOption) (*Branch, error)public static Branch Get(string name, Input<string> id, BranchState? state, CustomResourceOptions? opts = null)public static Branch get(String name, Output<String> id, BranchState state, CustomResourceOptions options)resources: existingBranch: type: volcenginecc:tidb:Branch get: id: ${id}import {
to = volcenginecc_tidb_branch.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 BranchState
- 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 BranchState
- 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 BranchState
- 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 BranchState
- 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.
Branch 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.
- Branch
Id string - Branch ID, assigned by the creation API
- Cluster
Id string - Cluster ID
- Create
Time string - Creation time
- Created
By string - Creator identifier
- Display
Name string - Branch display name
- Endpoints
Volcengine.
Branch Endpoints - Branch endpoint configuration
- Has
Set boolPwd - Root password set
- Name string
- Branch resource name
- Parent
Display stringName - Parent branch display name
- Parent
Id string - Parent branch ID
- Parent
Timestamp string - Timestamp of derivation from the parent branch
- Password string
- Branch root password, only for setting or changing the password (not returned after writing)
- Project
Name string - Name of the project to which the IP address pool belongs
- Reset
Branch bool - Reset branch. Resetting briefly changes the branch status before returning to READY; only used to trigger actions (no return value)
- State string
- Branch status (e.g., CREATING, READY)
- Update
Time string - Update time
- Usages
Volcengine.
Branch Usages - Branch resource usage
- User
Prefix string - Default username prefix
- Annotations
[]Branch
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.
- Branch
Id string - Branch ID, assigned by the creation API
- Cluster
Id string - Cluster ID
- Create
Time string - Creation time
- Created
By string - Creator identifier
- Display
Name string - Branch display name
- Endpoints
Branch
Endpoints Args - Branch endpoint configuration
- Has
Set boolPwd - Root password set
- Name string
- Branch resource name
- Parent
Display stringName - Parent branch display name
- Parent
Id string - Parent branch ID
- Parent
Timestamp string - Timestamp of derivation from the parent branch
- Password string
- Branch root password, only for setting or changing the password (not returned after writing)
- Project
Name string - Name of the project to which the IP address pool belongs
- Reset
Branch bool - Reset branch. Resetting briefly changes the branch status before returning to READY; only used to trigger actions (no return value)
- State string
- Branch status (e.g., CREATING, READY)
- Update
Time string - Update time
- Usages
Branch
Usages Args - Branch resource usage
- User
Prefix string - Default username prefix
- 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.
- branch_
id string - Branch ID, assigned by the creation API
- cluster_
id string - Cluster ID
- create_
time string - Creation time
- created_
by string - Creator identifier
- display_
name string - Branch display name
- endpoints object
- Branch endpoint configuration
- has_
set_ boolpwd - Root password set
- name string
- Branch resource name
- parent_
display_ stringname - Parent branch display name
- parent_
id string - Parent branch ID
- parent_
timestamp string - Timestamp of derivation from the parent branch
- password string
- Branch root password, only for setting or changing the password (not returned after writing)
- project_
name string - Name of the project to which the IP address pool belongs
- reset_
branch bool - Reset branch. Resetting briefly changes the branch status before returning to READY; only used to trigger actions (no return value)
- state string
- Branch status (e.g., CREATING, READY)
- update_
time string - Update time
- usages object
- Branch resource usage
- user_
prefix string - Default username prefix
- annotations
List<Branch
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.
- branch
Id String - Branch ID, assigned by the creation API
- cluster
Id String - Cluster ID
- create
Time String - Creation time
- created
By String - Creator identifier
- display
Name String - Branch display name
- endpoints
Branch
Endpoints - Branch endpoint configuration
- has
Set BooleanPwd - Root password set
- name String
- Branch resource name
- parent
Display StringName - Parent branch display name
- parent
Id String - Parent branch ID
- parent
Timestamp String - Timestamp of derivation from the parent branch
- password String
- Branch root password, only for setting or changing the password (not returned after writing)
- project
Name String - Name of the project to which the IP address pool belongs
- reset
Branch Boolean - Reset branch. Resetting briefly changes the branch status before returning to READY; only used to trigger actions (no return value)
- state String
- Branch status (e.g., CREATING, READY)
- update
Time String - Update time
- usages
Branch
Usages - Branch resource usage
- user
Prefix String - Default username prefix
- annotations
Branch
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.
- branch
Id string - Branch ID, assigned by the creation API
- cluster
Id string - Cluster ID
- create
Time string - Creation time
- created
By string - Creator identifier
- display
Name string - Branch display name
- endpoints
Branch
Endpoints - Branch endpoint configuration
- has
Set booleanPwd - Root password set
- name string
- Branch resource name
- parent
Display stringName - Parent branch display name
- parent
Id string - Parent branch ID
- parent
Timestamp string - Timestamp of derivation from the parent branch
- password string
- Branch root password, only for setting or changing the password (not returned after writing)
- project
Name string - Name of the project to which the IP address pool belongs
- reset
Branch boolean - Reset branch. Resetting briefly changes the branch status before returning to READY; only used to trigger actions (no return value)
- state string
- Branch status (e.g., CREATING, READY)
- update
Time string - Update time
- usages
Branch
Usages - Branch resource usage
- user
Prefix string - Default username prefix
- annotations
Sequence[Branch
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.
- branch_
id str - Branch ID, assigned by the creation API
- cluster_
id str - Cluster ID
- create_
time str - Creation time
- created_
by str - Creator identifier
- display_
name str - Branch display name
- endpoints
Branch
Endpoints Args - Branch endpoint configuration
- has_
set_ boolpwd - Root password set
- name str
- Branch resource name
- parent_
display_ strname - Parent branch display name
- parent_
id str - Parent branch ID
- parent_
timestamp str - Timestamp of derivation from the parent branch
- password str
- Branch root password, only for setting or changing the password (not returned after writing)
- project_
name str - Name of the project to which the IP address pool belongs
- reset_
branch bool - Reset branch. Resetting briefly changes the branch status before returning to READY; only used to trigger actions (no return value)
- state str
- Branch status (e.g., CREATING, READY)
- update_
time str - Update time
- usages
Branch
Usages Args - Branch resource usage
- user_
prefix str - Default username prefix
- 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.
- branch
Id String - Branch ID, assigned by the creation API
- cluster
Id String - Cluster ID
- create
Time String - Creation time
- created
By String - Creator identifier
- display
Name String - Branch display name
- endpoints Property Map
- Branch endpoint configuration
- has
Set BooleanPwd - Root password set
- name String
- Branch resource name
- parent
Display StringName - Parent branch display name
- parent
Id String - Parent branch ID
- parent
Timestamp String - Timestamp of derivation from the parent branch
- password String
- Branch root password, only for setting or changing the password (not returned after writing)
- project
Name String - Name of the project to which the IP address pool belongs
- reset
Branch Boolean - Reset branch. Resetting briefly changes the branch status before returning to READY; only used to trigger actions (no return value)
- state String
- Branch status (e.g., CREATING, READY)
- update
Time String - Update time
- usages Property Map
- Branch resource usage
- user
Prefix String - Default username prefix
Supporting Types
BranchAnnotation, BranchAnnotationArgs
BranchEndpoints, BranchEndpointsArgs
- Private
Endpoint Volcengine.Branch Endpoints Private Endpoint - Private endpoint
- Public
Endpoint Volcengine.Branch Endpoints Public Endpoint - Public endpoint
- Private
Endpoint BranchEndpoints Private Endpoint - Private endpoint
- Public
Endpoint BranchEndpoints Public Endpoint - Public endpoint
- private_
endpoint object - Private endpoint
- public_
endpoint object - Public endpoint
- private
Endpoint BranchEndpoints Private Endpoint - Private endpoint
- public
Endpoint BranchEndpoints Public Endpoint - Public endpoint
- private
Endpoint BranchEndpoints Private Endpoint - Private endpoint
- public
Endpoint BranchEndpoints Public Endpoint - Public endpoint
- private_
endpoint BranchEndpoints Private Endpoint - Private endpoint
- public_
endpoint BranchEndpoints Public Endpoint - Public endpoint
- private
Endpoint Property Map - Private endpoint
- public
Endpoint Property Map - Public endpoint
BranchEndpointsPrivateEndpoint, BranchEndpointsPrivateEndpointArgs
- Alicloud
Volcengine.
Branch Endpoints Private Endpoint Alicloud - Alicloud private endpoint
-
List<Volcengine.
Branch Endpoints Private Endpoint Authorized Network> - Private endpoint authorized network 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.
- Aws
Volcengine.
Branch Endpoints Private Endpoint Aws - AWS private endpoint
- Disabled bool
- Disable private network access
- Host string
- Private hostname
- Port int
- Private port
- Security
Group intCount - Security group count
- Service
Name string - Private endpoint service name
- Vpc
Endpoint stringId - VPC endpoint ID
- Vpc
Endpoint stringName - VPC endpoint name
- Alicloud
Branch
Endpoints Private Endpoint Alicloud - Alicloud private endpoint
-
[]Branch
Endpoints Private Endpoint Authorized Network - Private endpoint authorized network 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.
- Aws
Branch
Endpoints Private Endpoint Aws - AWS private endpoint
- Disabled bool
- Disable private network access
- Host string
- Private hostname
- Port int
- Private port
- Security
Group intCount - Security group count
- Service
Name string - Private endpoint service name
- Vpc
Endpoint stringId - VPC endpoint ID
- Vpc
Endpoint stringName - VPC endpoint name
- alicloud object
- Alicloud private endpoint
- list(object)
- Private endpoint authorized network 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.
- aws object
- AWS private endpoint
- disabled bool
- Disable private network access
- host string
- Private hostname
- port number
- Private port
- security_
group_ numbercount - Security group count
- service_
name string - Private endpoint service name
- vpc_
endpoint_ stringid - VPC endpoint ID
- vpc_
endpoint_ stringname - VPC endpoint name
- alicloud
Branch
Endpoints Private Endpoint Alicloud - Alicloud private endpoint
-
List<Branch
Endpoints Private Endpoint Authorized Network> - Private endpoint authorized network 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.
- aws
Branch
Endpoints Private Endpoint Aws - AWS private endpoint
- disabled Boolean
- Disable private network access
- host String
- Private hostname
- port Integer
- Private port
- security
Group IntegerCount - Security group count
- service
Name String - Private endpoint service name
- vpc
Endpoint StringId - VPC endpoint ID
- vpc
Endpoint StringName - VPC endpoint name
- alicloud
Branch
Endpoints Private Endpoint Alicloud - Alicloud private endpoint
-
Branch
Endpoints Private Endpoint Authorized Network[] - Private endpoint authorized network 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.
- aws
Branch
Endpoints Private Endpoint Aws - AWS private endpoint
- disabled boolean
- Disable private network access
- host string
- Private hostname
- port number
- Private port
- security
Group numberCount - Security group count
- service
Name string - Private endpoint service name
- vpc
Endpoint stringId - VPC endpoint ID
- vpc
Endpoint stringName - VPC endpoint name
- alicloud
Branch
Endpoints Private Endpoint Alicloud - Alicloud private endpoint
-
Sequence[Branch
Endpoints Private Endpoint Authorized Network] - Private endpoint authorized network 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.
- aws
Branch
Endpoints Private Endpoint Aws - AWS private endpoint
- disabled bool
- Disable private network access
- host str
- Private hostname
- port int
- Private port
- security_
group_ intcount - Security group count
- service_
name str - Private endpoint service name
- vpc_
endpoint_ strid - VPC endpoint ID
- vpc_
endpoint_ strname - VPC endpoint name
- alicloud Property Map
- Alicloud private endpoint
- List<Property Map>
- Private endpoint authorized network 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.
- aws Property Map
- AWS private endpoint
- disabled Boolean
- Disable private network access
- host String
- Private hostname
- port Number
- Private port
- security
Group NumberCount - Security group count
- service
Name String - Private endpoint service name
- vpc
Endpoint StringId - VPC endpoint ID
- vpc
Endpoint StringName - VPC endpoint name
BranchEndpointsPrivateEndpointAlicloud, BranchEndpointsPrivateEndpointAlicloudArgs
- Availability
Zones List<string> - Availability zone list
- Service
Name string - Private service name
- Availability
Zones []string - Availability zone list
- Service
Name string - Private service name
- availability_
zones list(string) - Availability zone list
- service_
name string - Private service name
- availability
Zones List<String> - Availability zone list
- service
Name String - Private service name
- availability
Zones string[] - Availability zone list
- service
Name string - Private service name
- availability_
zones Sequence[str] - Availability zone list
- service_
name str - Private service name
- availability
Zones List<String> - Availability zone list
- service
Name String - Private service name
BranchEndpointsPrivateEndpointAuthorizedNetwork, BranchEndpointsPrivateEndpointAuthorizedNetworkArgs
- Display
Name string - Authorized network name
- Security
Group intCount - Security group count
- Vpc
Endpoint stringId - VPC endpoint ID
- Vpc
Endpoint stringName - VPC endpoint name
- Display
Name string - Authorized network name
- Security
Group intCount - Security group count
- Vpc
Endpoint stringId - VPC endpoint ID
- Vpc
Endpoint stringName - VPC endpoint name
- display_
name string - Authorized network name
- security_
group_ numbercount - Security group count
- vpc_
endpoint_ stringid - VPC endpoint ID
- vpc_
endpoint_ stringname - VPC endpoint name
- display
Name String - Authorized network name
- security
Group IntegerCount - Security group count
- vpc
Endpoint StringId - VPC endpoint ID
- vpc
Endpoint StringName - VPC endpoint name
- display
Name string - Authorized network name
- security
Group numberCount - Security group count
- vpc
Endpoint stringId - VPC endpoint ID
- vpc
Endpoint stringName - VPC endpoint name
- display_
name str - Authorized network name
- security_
group_ intcount - Security group count
- vpc_
endpoint_ strid - VPC endpoint ID
- vpc_
endpoint_ strname - VPC endpoint name
- display
Name String - Authorized network name
- security
Group NumberCount - Security group count
- vpc
Endpoint StringId - VPC endpoint ID
- vpc
Endpoint StringName - VPC endpoint name
BranchEndpointsPrivateEndpointAws, BranchEndpointsPrivateEndpointAwsArgs
- Availability
Zones List<string> - Availability zone list
- Service
Name string - VPC endpoint service name
- Availability
Zones []string - Availability zone list
- Service
Name string - VPC endpoint service name
- availability_
zones list(string) - Availability zone list
- service_
name string - VPC endpoint service name
- availability
Zones List<String> - Availability zone list
- service
Name String - VPC endpoint service name
- availability
Zones string[] - Availability zone list
- service
Name string - VPC endpoint service name
- availability_
zones Sequence[str] - Availability zone list
- service_
name str - VPC endpoint service name
- availability
Zones List<String> - Availability zone list
- service
Name String - VPC endpoint service name
BranchEndpointsPublicEndpoint, BranchEndpointsPublicEndpointArgs
-
List<Volcengine.
Branch 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 network access
- Host string
- Public hostname
- Port int
- Public port
-
[]Branch
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 network 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 network access
- host string
- Public hostname
- port number
- Public port
-
List<Branch
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 network access
- host String
- Public hostname
- port Integer
- Public port
-
Branch
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 network access
- host string
- Public hostname
- port number
- Public port
-
Sequence[Branch
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 network 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 network access
- host String
- Public hostname
- port Number
- Public port
BranchEndpointsPublicEndpointAuthorizedNetwork, BranchEndpointsPublicEndpointAuthorizedNetworkArgs
- 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
BranchUsages, BranchUsagesArgs
- Column
Storage string - Column storage usage (int64 string)
- Request
Unit string - Request unit usage (int64 string)
- Row
Storage string - Row storage usage (int64 string)
- Column
Storage string - Column storage usage (int64 string)
- Request
Unit string - Request unit usage (int64 string)
- Row
Storage string - Row storage usage (int64 string)
- column_
storage string - Column storage usage (int64 string)
- request_
unit string - Request unit usage (int64 string)
- row_
storage string - Row storage usage (int64 string)
- column
Storage String - Column storage usage (int64 string)
- request
Unit String - Request unit usage (int64 string)
- row
Storage String - Row storage usage (int64 string)
- column
Storage string - Column storage usage (int64 string)
- request
Unit string - Request unit usage (int64 string)
- row
Storage string - Row storage usage (int64 string)
- column_
storage str - Column storage usage (int64 string)
- request_
unit str - Request unit usage (int64 string)
- row_
storage str - Row storage usage (int64 string)
- column
Storage String - Column storage usage (int64 string)
- request
Unit String - Request unit usage (int64 string)
- row
Storage String - Row storage usage (int64 string)
Import
$ pulumi import volcenginecc:tidb/branch:Branch example "cluster_id|branch_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