Viewing docs for volcenginecc v0.0.66
published on Thursday, Nov 19, 2026 by Volcengine
published on Thursday, Nov 19, 2026 by Volcengine
Viewing docs for volcenginecc v0.0.66
published on Thursday, Nov 19, 2026 by Volcengine
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 dictionarydata "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.
Get Branch Annotation> - 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
Volcengine.
Get Branch Endpoints - Branch endpoint configuration
- Has
Set boolPwd - Root password set
- Id string
- Uniquely identifies the resource.
- 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.
Get Branch Usages - Branch resource usage
- User
Prefix string - Default username prefix
- Annotations
[]Get
Branch Annotation - 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
Get
Branch Endpoints - Branch endpoint configuration
- Has
Set boolPwd - Root password set
- Id string
- Uniquely identifies the resource.
- 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
Get
Branch Usages - Branch resource usage
- User
Prefix 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_ boolpwd - Root password set
- id string
- Uniquely identifies the resource.
- 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<Get
Branch Annotation> - 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
Get
Branch Endpoints - Branch endpoint configuration
- has
Set BooleanPwd - Root password set
- id String
- Uniquely identifies the resource.
- 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
Get
Branch Usages - Branch resource usage
- user
Prefix String - Default username prefix
- annotations
Get
Branch Annotation[] - 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
Get
Branch Endpoints - Branch endpoint configuration
- has
Set booleanPwd - Root password set
- id string
- Uniquely identifies the resource.
- 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
Get
Branch Usages - Branch resource usage
- user
Prefix string - Default username prefix
- annotations
Sequence[Get
Branch Annotation] - 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
Get
Branch Endpoints - Branch endpoint configuration
- has_
set_ boolpwd - Root password set
- id str
- Uniquely identifies the resource.
- 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
Get
Branch Usages - Branch resource usage
- user_
prefix str - Default username prefix
- annotations List<Property Map>
- 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 Property Map
- Branch endpoint configuration
- has
Set BooleanPwd - Root password set
- id String
- Uniquely identifies the resource.
- 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
GetBranchAnnotation
GetBranchEndpoints
- Private
Endpoint Volcengine.Get Branch Endpoints Private Endpoint - Private endpoint
- Public
Endpoint Volcengine.Get Branch Endpoints Public Endpoint - Public endpoint
- Private
Endpoint GetBranch Endpoints Private Endpoint - Private endpoint
- Public
Endpoint GetBranch Endpoints Public Endpoint - Public endpoint
- private_
endpoint object - Private endpoint
- public_
endpoint object - Public endpoint
- private
Endpoint GetBranch Endpoints Private Endpoint - Private endpoint
- public
Endpoint GetBranch Endpoints Public Endpoint - Public endpoint
- private
Endpoint GetBranch Endpoints Private Endpoint - Private endpoint
- public
Endpoint GetBranch Endpoints Public Endpoint - Public endpoint
- private_
endpoint GetBranch Endpoints Private Endpoint - Private endpoint
- public_
endpoint GetBranch Endpoints Public Endpoint - Public endpoint
- private
Endpoint Property Map - Private endpoint
- public
Endpoint Property Map - Public endpoint
GetBranchEndpointsPrivateEndpoint
- Alicloud
Volcengine.
Get Branch Endpoints Private Endpoint Alicloud - Alicloud private endpoint
-
List<Volcengine.
Get Branch Endpoints Private Endpoint Authorized Network> - Private endpoint authorized network list
- Aws
Volcengine.
Get 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
Get
Branch Endpoints Private Endpoint Alicloud - Alicloud private endpoint
-
[]Get
Branch Endpoints Private Endpoint Authorized Network - Private endpoint authorized network list
- Aws
Get
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
- 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
Get
Branch Endpoints Private Endpoint Alicloud - Alicloud private endpoint
-
List<Get
Branch Endpoints Private Endpoint Authorized Network> - Private endpoint authorized network list
- aws
Get
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
Get
Branch Endpoints Private Endpoint Alicloud - Alicloud private endpoint
-
Get
Branch Endpoints Private Endpoint Authorized Network[] - Private endpoint authorized network list
- aws
Get
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
Get
Branch Endpoints Private Endpoint Alicloud - Alicloud private endpoint
-
Sequence[Get
Branch Endpoints Private Endpoint Authorized Network] - Private endpoint authorized network list
- aws
Get
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
- 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
GetBranchEndpointsPrivateEndpointAlicloud
- 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
GetBranchEndpointsPrivateEndpointAuthorizedNetwork
- 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
GetBranchEndpointsPrivateEndpointAws
- 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
GetBranchEndpointsPublicEndpoint
-
List<Volcengine.
Get Branch Endpoints Public Endpoint Authorized Network> - IP Allowlist
- Disabled bool
- Disable public network access
- Host string
- Public hostname
- Port int
- Public port
-
[]Get
Branch Endpoints Public Endpoint Authorized Network - IP Allowlist
- Disabled bool
- Disable public network access
- Host string
- Public hostname
- Port int
- Public port
- list(object)
- IP Allowlist
- disabled bool
- Disable public network access
- host string
- Public hostname
- port number
- Public port
-
List<Get
Branch Endpoints Public Endpoint Authorized Network> - IP Allowlist
- disabled Boolean
- Disable public network access
- host String
- Public hostname
- port Integer
- Public port
-
Get
Branch Endpoints Public Endpoint Authorized Network[] - IP Allowlist
- disabled boolean
- Disable public network access
- host string
- Public hostname
- port number
- Public port
-
Sequence[Get
Branch Endpoints Public Endpoint Authorized Network] - IP Allowlist
- disabled bool
- Disable public network access
- host str
- Public hostname
- port int
- Public port
- List<Property Map>
- IP Allowlist
- disabled Boolean
- Disable public network access
- host String
- Public hostname
- port Number
- Public port
GetBranchEndpointsPublicEndpointAuthorizedNetwork
- 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
GetBranchUsages
- 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)
Package Details
- Repository
- volcenginecc volcengine/pulumi-volcenginecc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
volcengineccTerraform Provider.
Viewing docs for volcenginecc v0.0.66
published on Thursday, Nov 19, 2026 by Volcengine
published on Thursday, Nov 19, 2026 by Volcengine