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

    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:

    ClusterId string
    Cluster ID
    DisplayName string
    Branch display name
    ParentId string
    Parent branch ID
    ParentTimestamp string
    Timestamp of derivation from the parent branch
    Password string
    Branch root password, only for setting or changing the password (not returned after writing)
    ResetBranch bool
    Reset branch. Resetting briefly changes the branch status before returning to READY; only used to trigger actions (no return value)
    ClusterId string
    Cluster ID
    DisplayName string
    Branch display name
    ParentId string
    Parent branch ID
    ParentTimestamp string
    Timestamp of derivation from the parent branch
    Password string
    Branch root password, only for setting or changing the password (not returned after writing)
    ResetBranch 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)
    clusterId String
    Cluster ID
    displayName String
    Branch display name
    parentId String
    Parent branch ID
    parentTimestamp String
    Timestamp of derivation from the parent branch
    password String
    Branch root password, only for setting or changing the password (not returned after writing)
    resetBranch Boolean
    Reset branch. Resetting briefly changes the branch status before returning to READY; only used to trigger actions (no return value)
    clusterId string
    Cluster ID
    displayName string
    Branch display name
    parentId string
    Parent branch ID
    parentTimestamp string
    Timestamp of derivation from the parent branch
    password string
    Branch root password, only for setting or changing the password (not returned after writing)
    resetBranch 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)
    clusterId String
    Cluster ID
    displayName String
    Branch display name
    parentId String
    Parent branch ID
    parentTimestamp String
    Timestamp of derivation from the parent branch
    password String
    Branch root password, only for setting or changing the password (not returned after writing)
    resetBranch 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.BranchAnnotation>
    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.
    BranchId string
    Branch ID, assigned by the creation API
    CreateTime string
    Creation time
    CreatedBy string
    Creator identifier
    Endpoints Volcengine.BranchEndpoints
    Branch endpoint configuration
    HasSetPwd bool
    Root password set
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Branch resource name
    ParentDisplayName string
    Parent branch display name
    ProjectName string
    Name of the project to which the IP address pool belongs
    State string
    Branch status (e.g., CREATING, READY)
    UpdateTime string
    Update time
    Usages Volcengine.BranchUsages
    Branch resource usage
    UserPrefix string
    Default username prefix
    Annotations []BranchAnnotation
    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.
    BranchId string
    Branch ID, assigned by the creation API
    CreateTime string
    Creation time
    CreatedBy string
    Creator identifier
    Endpoints BranchEndpoints
    Branch endpoint configuration
    HasSetPwd bool
    Root password set
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Branch resource name
    ParentDisplayName string
    Parent branch display name
    ProjectName string
    Name of the project to which the IP address pool belongs
    State string
    Branch status (e.g., CREATING, READY)
    UpdateTime string
    Update time
    Usages BranchUsages
    Branch resource usage
    UserPrefix 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_pwd bool
    Root password set
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Branch resource name
    parent_display_name string
    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<BranchAnnotation>
    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.
    branchId String
    Branch ID, assigned by the creation API
    createTime String
    Creation time
    createdBy String
    Creator identifier
    endpoints BranchEndpoints
    Branch endpoint configuration
    hasSetPwd Boolean
    Root password set
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Branch resource name
    parentDisplayName String
    Parent branch display name
    projectName String
    Name of the project to which the IP address pool belongs
    state String
    Branch status (e.g., CREATING, READY)
    updateTime String
    Update time
    usages BranchUsages
    Branch resource usage
    userPrefix String
    Default username prefix
    annotations BranchAnnotation[]
    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.
    branchId string
    Branch ID, assigned by the creation API
    createTime string
    Creation time
    createdBy string
    Creator identifier
    endpoints BranchEndpoints
    Branch endpoint configuration
    hasSetPwd boolean
    Root password set
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Branch resource name
    parentDisplayName string
    Parent branch display name
    projectName string
    Name of the project to which the IP address pool belongs
    state string
    Branch status (e.g., CREATING, READY)
    updateTime string
    Update time
    usages BranchUsages
    Branch resource usage
    userPrefix string
    Default username prefix
    annotations Sequence[BranchAnnotation]
    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 BranchEndpoints
    Branch endpoint configuration
    has_set_pwd bool
    Root password set
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Branch resource name
    parent_display_name str
    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 BranchUsages
    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.
    branchId String
    Branch ID, assigned by the creation API
    createTime String
    Creation time
    createdBy String
    Creator identifier
    endpoints Property Map
    Branch endpoint configuration
    hasSetPwd Boolean
    Root password set
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Branch resource name
    parentDisplayName String
    Parent branch display name
    projectName String
    Name of the project to which the IP address pool belongs
    state String
    Branch status (e.g., CREATING, READY)
    updateTime String
    Update time
    usages Property Map
    Branch resource usage
    userPrefix 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) -> Branch
    func 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.
    The following state arguments are supported:
    Annotations List<Volcengine.BranchAnnotation>
    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.
    BranchId string
    Branch ID, assigned by the creation API
    ClusterId string
    Cluster ID
    CreateTime string
    Creation time
    CreatedBy string
    Creator identifier
    DisplayName string
    Branch display name
    Endpoints Volcengine.BranchEndpoints
    Branch endpoint configuration
    HasSetPwd bool
    Root password set
    Name string
    Branch resource name
    ParentDisplayName string
    Parent branch display name
    ParentId string
    Parent branch ID
    ParentTimestamp string
    Timestamp of derivation from the parent branch
    Password string
    Branch root password, only for setting or changing the password (not returned after writing)
    ProjectName string
    Name of the project to which the IP address pool belongs
    ResetBranch 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)
    UpdateTime string
    Update time
    Usages Volcengine.BranchUsages
    Branch resource usage
    UserPrefix string
    Default username prefix
    Annotations []BranchAnnotationArgs
    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.
    BranchId string
    Branch ID, assigned by the creation API
    ClusterId string
    Cluster ID
    CreateTime string
    Creation time
    CreatedBy string
    Creator identifier
    DisplayName string
    Branch display name
    Endpoints BranchEndpointsArgs
    Branch endpoint configuration
    HasSetPwd bool
    Root password set
    Name string
    Branch resource name
    ParentDisplayName string
    Parent branch display name
    ParentId string
    Parent branch ID
    ParentTimestamp string
    Timestamp of derivation from the parent branch
    Password string
    Branch root password, only for setting or changing the password (not returned after writing)
    ProjectName string
    Name of the project to which the IP address pool belongs
    ResetBranch 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)
    UpdateTime string
    Update time
    Usages BranchUsagesArgs
    Branch resource usage
    UserPrefix 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_pwd bool
    Root password set
    name string
    Branch resource name
    parent_display_name string
    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<BranchAnnotation>
    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.
    branchId String
    Branch ID, assigned by the creation API
    clusterId String
    Cluster ID
    createTime String
    Creation time
    createdBy String
    Creator identifier
    displayName String
    Branch display name
    endpoints BranchEndpoints
    Branch endpoint configuration
    hasSetPwd Boolean
    Root password set
    name String
    Branch resource name
    parentDisplayName String
    Parent branch display name
    parentId String
    Parent branch ID
    parentTimestamp String
    Timestamp of derivation from the parent branch
    password String
    Branch root password, only for setting or changing the password (not returned after writing)
    projectName String
    Name of the project to which the IP address pool belongs
    resetBranch 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)
    updateTime String
    Update time
    usages BranchUsages
    Branch resource usage
    userPrefix String
    Default username prefix
    annotations BranchAnnotation[]
    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.
    branchId string
    Branch ID, assigned by the creation API
    clusterId string
    Cluster ID
    createTime string
    Creation time
    createdBy string
    Creator identifier
    displayName string
    Branch display name
    endpoints BranchEndpoints
    Branch endpoint configuration
    hasSetPwd boolean
    Root password set
    name string
    Branch resource name
    parentDisplayName string
    Parent branch display name
    parentId string
    Parent branch ID
    parentTimestamp string
    Timestamp of derivation from the parent branch
    password string
    Branch root password, only for setting or changing the password (not returned after writing)
    projectName string
    Name of the project to which the IP address pool belongs
    resetBranch 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)
    updateTime string
    Update time
    usages BranchUsages
    Branch resource usage
    userPrefix string
    Default username prefix
    annotations Sequence[BranchAnnotationArgs]
    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 BranchEndpointsArgs
    Branch endpoint configuration
    has_set_pwd bool
    Root password set
    name str
    Branch resource name
    parent_display_name str
    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 BranchUsagesArgs
    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.
    branchId String
    Branch ID, assigned by the creation API
    clusterId String
    Cluster ID
    createTime String
    Creation time
    createdBy String
    Creator identifier
    displayName String
    Branch display name
    endpoints Property Map
    Branch endpoint configuration
    hasSetPwd Boolean
    Root password set
    name String
    Branch resource name
    parentDisplayName String
    Parent branch display name
    parentId String
    Parent branch ID
    parentTimestamp String
    Timestamp of derivation from the parent branch
    password String
    Branch root password, only for setting or changing the password (not returned after writing)
    projectName String
    Name of the project to which the IP address pool belongs
    resetBranch 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)
    updateTime String
    Update time
    usages Property Map
    Branch resource usage
    userPrefix String
    Default username prefix

    Supporting Types

    BranchAnnotation, BranchAnnotationArgs

    Key string
    Annotation key
    Value string
    Annotation value
    Key string
    Annotation key
    Value string
    Annotation value
    key string
    Annotation key
    value string
    Annotation value
    key String
    Annotation key
    value String
    Annotation value
    key string
    Annotation key
    value string
    Annotation value
    key str
    Annotation key
    value str
    Annotation value
    key String
    Annotation key
    value String
    Annotation value

    BranchEndpoints, BranchEndpointsArgs

    private_endpoint object
    Private endpoint
    public_endpoint object
    Public endpoint

    BranchEndpointsPrivateEndpoint, BranchEndpointsPrivateEndpointArgs

    Alicloud Volcengine.BranchEndpointsPrivateEndpointAlicloud
    Alicloud private endpoint
    AuthorizedNetworks List<Volcengine.BranchEndpointsPrivateEndpointAuthorizedNetwork>
    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.BranchEndpointsPrivateEndpointAws
    AWS private endpoint
    Disabled bool
    Disable private network access
    Host string
    Private hostname
    Port int
    Private port
    SecurityGroupCount int
    Security group count
    ServiceName string
    Private endpoint service name
    VpcEndpointId string
    VPC endpoint ID
    VpcEndpointName string
    VPC endpoint name
    Alicloud BranchEndpointsPrivateEndpointAlicloud
    Alicloud private endpoint
    AuthorizedNetworks []BranchEndpointsPrivateEndpointAuthorizedNetwork
    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 BranchEndpointsPrivateEndpointAws
    AWS private endpoint
    Disabled bool
    Disable private network access
    Host string
    Private hostname
    Port int
    Private port
    SecurityGroupCount int
    Security group count
    ServiceName string
    Private endpoint service name
    VpcEndpointId string
    VPC endpoint ID
    VpcEndpointName string
    VPC endpoint name
    alicloud object
    Alicloud private endpoint
    authorized_networks 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_count number
    Security group count
    service_name string
    Private endpoint service name
    vpc_endpoint_id string
    VPC endpoint ID
    vpc_endpoint_name string
    VPC endpoint name
    alicloud BranchEndpointsPrivateEndpointAlicloud
    Alicloud private endpoint
    authorizedNetworks List<BranchEndpointsPrivateEndpointAuthorizedNetwork>
    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 BranchEndpointsPrivateEndpointAws
    AWS private endpoint
    disabled Boolean
    Disable private network access
    host String
    Private hostname
    port Integer
    Private port
    securityGroupCount Integer
    Security group count
    serviceName String
    Private endpoint service name
    vpcEndpointId String
    VPC endpoint ID
    vpcEndpointName String
    VPC endpoint name
    alicloud BranchEndpointsPrivateEndpointAlicloud
    Alicloud private endpoint
    authorizedNetworks BranchEndpointsPrivateEndpointAuthorizedNetwork[]
    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 BranchEndpointsPrivateEndpointAws
    AWS private endpoint
    disabled boolean
    Disable private network access
    host string
    Private hostname
    port number
    Private port
    securityGroupCount number
    Security group count
    serviceName string
    Private endpoint service name
    vpcEndpointId string
    VPC endpoint ID
    vpcEndpointName string
    VPC endpoint name
    alicloud BranchEndpointsPrivateEndpointAlicloud
    Alicloud private endpoint
    authorized_networks Sequence[BranchEndpointsPrivateEndpointAuthorizedNetwork]
    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 BranchEndpointsPrivateEndpointAws
    AWS private endpoint
    disabled bool
    Disable private network access
    host str
    Private hostname
    port int
    Private port
    security_group_count int
    Security group count
    service_name str
    Private endpoint service name
    vpc_endpoint_id str
    VPC endpoint ID
    vpc_endpoint_name str
    VPC endpoint name
    alicloud Property Map
    Alicloud private endpoint
    authorizedNetworks 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
    securityGroupCount Number
    Security group count
    serviceName String
    Private endpoint service name
    vpcEndpointId String
    VPC endpoint ID
    vpcEndpointName String
    VPC endpoint name

    BranchEndpointsPrivateEndpointAlicloud, BranchEndpointsPrivateEndpointAlicloudArgs

    AvailabilityZones List<string>
    Availability zone list
    ServiceName string
    Private service name
    AvailabilityZones []string
    Availability zone list
    ServiceName string
    Private service name
    availability_zones list(string)
    Availability zone list
    service_name string
    Private service name
    availabilityZones List<String>
    Availability zone list
    serviceName String
    Private service name
    availabilityZones string[]
    Availability zone list
    serviceName string
    Private service name
    availability_zones Sequence[str]
    Availability zone list
    service_name str
    Private service name
    availabilityZones List<String>
    Availability zone list
    serviceName String
    Private service name

    BranchEndpointsPrivateEndpointAuthorizedNetwork, BranchEndpointsPrivateEndpointAuthorizedNetworkArgs

    DisplayName string
    Authorized network name
    SecurityGroupCount int
    Security group count
    VpcEndpointId string
    VPC endpoint ID
    VpcEndpointName string
    VPC endpoint name
    DisplayName string
    Authorized network name
    SecurityGroupCount int
    Security group count
    VpcEndpointId string
    VPC endpoint ID
    VpcEndpointName string
    VPC endpoint name
    display_name string
    Authorized network name
    security_group_count number
    Security group count
    vpc_endpoint_id string
    VPC endpoint ID
    vpc_endpoint_name string
    VPC endpoint name
    displayName String
    Authorized network name
    securityGroupCount Integer
    Security group count
    vpcEndpointId String
    VPC endpoint ID
    vpcEndpointName String
    VPC endpoint name
    displayName string
    Authorized network name
    securityGroupCount number
    Security group count
    vpcEndpointId string
    VPC endpoint ID
    vpcEndpointName string
    VPC endpoint name
    display_name str
    Authorized network name
    security_group_count int
    Security group count
    vpc_endpoint_id str
    VPC endpoint ID
    vpc_endpoint_name str
    VPC endpoint name
    displayName String
    Authorized network name
    securityGroupCount Number
    Security group count
    vpcEndpointId String
    VPC endpoint ID
    vpcEndpointName String
    VPC endpoint name

    BranchEndpointsPrivateEndpointAws, BranchEndpointsPrivateEndpointAwsArgs

    AvailabilityZones List<string>
    Availability zone list
    ServiceName string
    VPC endpoint service name
    AvailabilityZones []string
    Availability zone list
    ServiceName string
    VPC endpoint service name
    availability_zones list(string)
    Availability zone list
    service_name string
    VPC endpoint service name
    availabilityZones List<String>
    Availability zone list
    serviceName String
    VPC endpoint service name
    availabilityZones string[]
    Availability zone list
    serviceName string
    VPC endpoint service name
    availability_zones Sequence[str]
    Availability zone list
    service_name str
    VPC endpoint service name
    availabilityZones List<String>
    Availability zone list
    serviceName String
    VPC endpoint service name

    BranchEndpointsPublicEndpoint, BranchEndpointsPublicEndpointArgs

    AuthorizedNetworks List<Volcengine.BranchEndpointsPublicEndpointAuthorizedNetwork>
    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
    AuthorizedNetworks []BranchEndpointsPublicEndpointAuthorizedNetwork
    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
    authorized_networks list(object)
    IP Allowlist Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    disabled bool
    Disable public network access
    host string
    Public hostname
    port number
    Public port
    authorizedNetworks List<BranchEndpointsPublicEndpointAuthorizedNetwork>
    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
    authorizedNetworks BranchEndpointsPublicEndpointAuthorizedNetwork[]
    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
    authorized_networks Sequence[BranchEndpointsPublicEndpointAuthorizedNetwork]
    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
    authorizedNetworks List<Property Map>
    IP Allowlist Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    disabled Boolean
    Disable public network access
    host String
    Public hostname
    port Number
    Public port

    BranchEndpointsPublicEndpointAuthorizedNetwork, BranchEndpointsPublicEndpointAuthorizedNetworkArgs

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

    BranchUsages, BranchUsagesArgs

    ColumnStorage string
    Column storage usage (int64 string)
    RequestUnit string
    Request unit usage (int64 string)
    RowStorage string
    Row storage usage (int64 string)
    ColumnStorage string
    Column storage usage (int64 string)
    RequestUnit string
    Request unit usage (int64 string)
    RowStorage 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)
    columnStorage String
    Column storage usage (int64 string)
    requestUnit String
    Request unit usage (int64 string)
    rowStorage String
    Row storage usage (int64 string)
    columnStorage string
    Column storage usage (int64 string)
    requestUnit string
    Request unit usage (int64 string)
    rowStorage 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)
    columnStorage String
    Column storage usage (int64 string)
    requestUnit String
    Request unit usage (int64 string)
    rowStorage 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 volcenginecc Terraform Provider.
    volcenginecc logo volcenginecc
    Viewing docs for volcenginecc v0.0.66
    published on Thursday, Nov 19, 2026 by Volcengine

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial