1. Registry
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. tidb
  6. getBranch
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

    Data Source schema for Volcengine::TiDB::Branch

    Using getBranch

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getBranch(args: GetBranchArgs, opts?: InvokeOptions): Promise<GetBranchResult>
    function getBranchOutput(args: GetBranchOutputArgs, opts?: InvokeOutputOptions): Output<GetBranchResult>
    def get_branch(id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetBranchResult
    def get_branch_output(id: pulumi.Input[Optional[str]] = None,
                   opts: Optional[InvokeOutputOptions] = None) -> Output[GetBranchResult]
    func LookupBranch(ctx *Context, args *LookupBranchArgs, opts ...InvokeOption) (*LookupBranchResult, error)
    func LookupBranchOutput(ctx *Context, args *LookupBranchOutputArgs, opts ...InvokeOption) LookupBranchResultOutput

    > Note: This function is named LookupBranch in the Go SDK.

    public static class GetBranch 
    {
        public static Task<GetBranchResult> InvokeAsync(GetBranchArgs args, InvokeOptions? opts = null)
        public static Output<GetBranchResult> Invoke(GetBranchInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetBranchResult> Invoke(GetBranchInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetBranchResult> getBranch(GetBranchArgs args, InvokeOptions options)
    public static Output<GetBranchResult> getBranch(GetBranchArgs args, InvokeOptions options)
    public static Output<GetBranchResult> getBranch(GetBranchArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: volcenginecc:tidb/getBranch:getBranch
      arguments:
        # arguments dictionary
    data "volcenginecc_tidb_get_branch" "name" {
        # arguments
    }

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getBranch Result

    The following output properties are available:

    Annotations List<Volcengine.GetBranchAnnotation>
    Annotation
    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.GetBranchEndpoints
    Branch endpoint configuration
    HasSetPwd bool
    Root password set
    Id string
    Uniquely identifies the resource.
    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.GetBranchUsages
    Branch resource usage
    UserPrefix string
    Default username prefix
    Annotations []GetBranchAnnotation
    Annotation
    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 GetBranchEndpoints
    Branch endpoint configuration
    HasSetPwd bool
    Root password set
    Id string
    Uniquely identifies the resource.
    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 GetBranchUsages
    Branch resource usage
    UserPrefix string
    Default username prefix
    annotations list(object)
    Annotation
    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
    id string
    Uniquely identifies the resource.
    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<GetBranchAnnotation>
    Annotation
    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 GetBranchEndpoints
    Branch endpoint configuration
    hasSetPwd Boolean
    Root password set
    id String
    Uniquely identifies the resource.
    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 GetBranchUsages
    Branch resource usage
    userPrefix String
    Default username prefix
    annotations GetBranchAnnotation[]
    Annotation
    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 GetBranchEndpoints
    Branch endpoint configuration
    hasSetPwd boolean
    Root password set
    id string
    Uniquely identifies the resource.
    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 GetBranchUsages
    Branch resource usage
    userPrefix string
    Default username prefix
    annotations Sequence[GetBranchAnnotation]
    Annotation
    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 GetBranchEndpoints
    Branch endpoint configuration
    has_set_pwd bool
    Root password set
    id str
    Uniquely identifies the resource.
    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 GetBranchUsages
    Branch resource usage
    user_prefix str
    Default username prefix
    annotations List<Property Map>
    Annotation
    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
    id String
    Uniquely identifies the resource.
    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

    GetBranchAnnotation

    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

    GetBranchEndpoints

    private_endpoint object
    Private endpoint
    public_endpoint object
    Public endpoint

    GetBranchEndpointsPrivateEndpoint

    Alicloud Volcengine.GetBranchEndpointsPrivateEndpointAlicloud
    Alicloud private endpoint
    AuthorizedNetworks List<Volcengine.GetBranchEndpointsPrivateEndpointAuthorizedNetwork>
    Private endpoint authorized network list
    Aws Volcengine.GetBranchEndpointsPrivateEndpointAws
    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 GetBranchEndpointsPrivateEndpointAlicloud
    Alicloud private endpoint
    AuthorizedNetworks []GetBranchEndpointsPrivateEndpointAuthorizedNetwork
    Private endpoint authorized network list
    Aws GetBranchEndpointsPrivateEndpointAws
    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
    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 GetBranchEndpointsPrivateEndpointAlicloud
    Alicloud private endpoint
    authorizedNetworks List<GetBranchEndpointsPrivateEndpointAuthorizedNetwork>
    Private endpoint authorized network list
    aws GetBranchEndpointsPrivateEndpointAws
    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 GetBranchEndpointsPrivateEndpointAlicloud
    Alicloud private endpoint
    authorizedNetworks GetBranchEndpointsPrivateEndpointAuthorizedNetwork[]
    Private endpoint authorized network list
    aws GetBranchEndpointsPrivateEndpointAws
    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 GetBranchEndpointsPrivateEndpointAlicloud
    Alicloud private endpoint
    authorized_networks Sequence[GetBranchEndpointsPrivateEndpointAuthorizedNetwork]
    Private endpoint authorized network list
    aws GetBranchEndpointsPrivateEndpointAws
    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
    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

    GetBranchEndpointsPrivateEndpointAlicloud

    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

    GetBranchEndpointsPrivateEndpointAuthorizedNetwork

    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

    GetBranchEndpointsPrivateEndpointAws

    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

    GetBranchEndpointsPublicEndpoint

    AuthorizedNetworks List<Volcengine.GetBranchEndpointsPublicEndpointAuthorizedNetwork>
    IP Allowlist
    Disabled bool
    Disable public network access
    Host string
    Public hostname
    Port int
    Public port
    AuthorizedNetworks []GetBranchEndpointsPublicEndpointAuthorizedNetwork
    IP Allowlist
    Disabled bool
    Disable public network access
    Host string
    Public hostname
    Port int
    Public port
    authorized_networks list(object)
    IP Allowlist
    disabled bool
    Disable public network access
    host string
    Public hostname
    port number
    Public port
    authorizedNetworks List<GetBranchEndpointsPublicEndpointAuthorizedNetwork>
    IP Allowlist
    disabled Boolean
    Disable public network access
    host String
    Public hostname
    port Integer
    Public port
    authorizedNetworks GetBranchEndpointsPublicEndpointAuthorizedNetwork[]
    IP Allowlist
    disabled boolean
    Disable public network access
    host string
    Public hostname
    port number
    Public port
    authorized_networks Sequence[GetBranchEndpointsPublicEndpointAuthorizedNetwork]
    IP Allowlist
    disabled bool
    Disable public network access
    host str
    Public hostname
    port int
    Public port
    authorizedNetworks List<Property Map>
    IP Allowlist
    disabled Boolean
    Disable public network access
    host String
    Public hostname
    port Number
    Public port

    GetBranchEndpointsPublicEndpointAuthorizedNetwork

    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

    GetBranchUsages

    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)

    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