1. Packages
  2. Planetscale Provider
  3. API Docs
  4. getVitessBranch
Viewing docs for planetscale 1.0.0
published on Monday, Mar 2, 2026 by planetscale
Schema (JSON)
planetscale/terraform-provider-planetscale

planetscale.getVitessBranch

Viewing docs for planetscale 1.0.0
published on Monday, Mar 2, 2026 by planetscale
Schema (JSON)
planetscale/terraform-provider-planetscale

    VitessBranch DataSource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as planetscale from "@pulumi/planetscale";

const myVitessbranch = planetscale.getVitessBranch({
    database: "...my_database...",
    id: "...my_id...",
    organization: "...my_organization...",
});

    import pulumi
import pulumi_planetscale as planetscale

my_vitessbranch = planetscale.get_vitess_branch(database="...my_database...",
    id="...my_id...",
    organization="...my_organization...")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/planetscale/planetscale"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := planetscale.LookupVitessBranch(ctx, &planetscale.LookupVitessBranchArgs{
			Database:     "...my_database...",
			Id:           "...my_id...",
			Organization: "...my_organization...",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Planetscale = Pulumi.Planetscale;

return await Deployment.RunAsync(() => 
{
    var myVitessbranch = Planetscale.GetVitessBranch.Invoke(new()
    {
        Database = "...my_database...",
        Id = "...my_id...",
        Organization = "...my_organization...",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.planetscale.PlanetscaleFunctions;
import com.pulumi.planetscale.inputs.GetVitessBranchArgs;
import java.util.List;
import java.util.ArrayList;
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) {
        final var myVitessbranch = PlanetscaleFunctions.getVitessBranch(GetVitessBranchArgs.builder()
            .database("...my_database...")
            .id("...my_id...")
            .organization("...my_organization...")
            .build());

    }
}

    variables:
  myVitessbranch:
    fn::invoke:
      function: planetscale:getVitessBranch
      arguments:
        database: '...my_database...'
        id: '...my_id...'
        organization: '...my_organization...'

    Using getVitessBranch

    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 getVitessBranch(args: GetVitessBranchArgs, opts?: InvokeOptions): Promise<GetVitessBranchResult>
function getVitessBranchOutput(args: GetVitessBranchOutputArgs, opts?: InvokeOptions): Output<GetVitessBranchResult>
    def get_vitess_branch(database: Optional[str] = None,
                      id: Optional[str] = None,
                      organization: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetVitessBranchResult
def get_vitess_branch_output(database: Optional[pulumi.Input[str]] = None,
                      id: Optional[pulumi.Input[str]] = None,
                      organization: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetVitessBranchResult]
    func LookupVitessBranch(ctx *Context, args *LookupVitessBranchArgs, opts ...InvokeOption) (*LookupVitessBranchResult, error)
func LookupVitessBranchOutput(ctx *Context, args *LookupVitessBranchOutputArgs, opts ...InvokeOption) LookupVitessBranchResultOutput

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

    public static class GetVitessBranch 
{
    public static Task<GetVitessBranchResult> InvokeAsync(GetVitessBranchArgs args, InvokeOptions? opts = null)
    public static Output<GetVitessBranchResult> Invoke(GetVitessBranchInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVitessBranchResult> getVitessBranch(GetVitessBranchArgs args, InvokeOptions options)
public static Output<GetVitessBranchResult> getVitessBranch(GetVitessBranchArgs args, InvokeOptions options)

    fn::invoke:
  function: planetscale:index/getVitessBranch:getVitessBranch
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Database string
    Database name slug from list_databases. Example: app-db.
    Id string
    The ID of the branch
    Organization string
    Organization name slug from list_organizations. Example: acme.
    Database string
    Database name slug from list_databases. Example: app-db.
    Id string
    The ID of the branch
    Organization string
    Organization name slug from list_organizations. Example: acme.
    database String
    Database name slug from list_databases. Example: app-db.
    id String
    The ID of the branch
    organization String
    Organization name slug from list_organizations. Example: acme.
    database string
    Database name slug from list_databases. Example: app-db.
    id string
    The ID of the branch
    organization string
    Organization name slug from list_organizations. Example: acme.
    database str
    Database name slug from list_databases. Example: app-db.
    id str
    The ID of the branch
    organization str
    Organization name slug from list_organizations. Example: acme.
    database String
    Database name slug from list_databases. Example: app-db.
    id String
    The ID of the branch
    organization String
    Organization name slug from list_organizations. Example: acme.

    getVitessBranch Result

    The following output properties are available:

    Actor GetVitessBranchActor
    ClusterSize string
    The SKU representing the branch's cluster size
    Database string
    Database name slug from list_databases. Example: app-db.
    HtmlUrl string
    Planetscale app URL for the branch
    Id string
    The ID of the branch
    MysqlAddress string
    The MySQL address for the branch
    MysqlEdgeAddress string
    The address of the MySQL provider for the branch
    Name string
    The name of the branch
    Organization string
    Organization name slug from list_organizations. Example: acme.
    ParentBranch string
    The name of the parent branch from which the branch was created
    Ready bool
    Whether or not the branch is ready to serve queries
    RegionData GetVitessBranchRegionData
    State string
    The current state of the branch
    Url string
    Planetscale API URL for the branch
    Actor GetVitessBranchActor
    ClusterSize string
    The SKU representing the branch's cluster size
    Database string
    Database name slug from list_databases. Example: app-db.
    HtmlUrl string
    Planetscale app URL for the branch
    Id string
    The ID of the branch
    MysqlAddress string
    The MySQL address for the branch
    MysqlEdgeAddress string
    The address of the MySQL provider for the branch
    Name string
    The name of the branch
    Organization string
    Organization name slug from list_organizations. Example: acme.
    ParentBranch string
    The name of the parent branch from which the branch was created
    Ready bool
    Whether or not the branch is ready to serve queries
    RegionData GetVitessBranchRegionData
    State string
    The current state of the branch
    Url string
    Planetscale API URL for the branch
    actor GetVitessBranchActor
    clusterSize String
    The SKU representing the branch's cluster size
    database String
    Database name slug from list_databases. Example: app-db.
    htmlUrl String
    Planetscale app URL for the branch
    id String
    The ID of the branch
    mysqlAddress String
    The MySQL address for the branch
    mysqlEdgeAddress String
    The address of the MySQL provider for the branch
    name String
    The name of the branch
    organization String
    Organization name slug from list_organizations. Example: acme.
    parentBranch String
    The name of the parent branch from which the branch was created
    ready Boolean
    Whether or not the branch is ready to serve queries
    regionData GetVitessBranchRegionData
    state String
    The current state of the branch
    url String
    Planetscale API URL for the branch
    actor GetVitessBranchActor
    clusterSize string
    The SKU representing the branch's cluster size
    database string
    Database name slug from list_databases. Example: app-db.
    htmlUrl string
    Planetscale app URL for the branch
    id string
    The ID of the branch
    mysqlAddress string
    The MySQL address for the branch
    mysqlEdgeAddress string
    The address of the MySQL provider for the branch
    name string
    The name of the branch
    organization string
    Organization name slug from list_organizations. Example: acme.
    parentBranch string
    The name of the parent branch from which the branch was created
    ready boolean
    Whether or not the branch is ready to serve queries
    regionData GetVitessBranchRegionData
    state string
    The current state of the branch
    url string
    Planetscale API URL for the branch
    actor GetVitessBranchActor
    cluster_size str
    The SKU representing the branch's cluster size
    database str
    Database name slug from list_databases. Example: app-db.
    html_url str
    Planetscale app URL for the branch
    id str
    The ID of the branch
    mysql_address str
    The MySQL address for the branch
    mysql_edge_address str
    The address of the MySQL provider for the branch
    name str
    The name of the branch
    organization str
    Organization name slug from list_organizations. Example: acme.
    parent_branch str
    The name of the parent branch from which the branch was created
    ready bool
    Whether or not the branch is ready to serve queries
    region_data GetVitessBranchRegionData
    state str
    The current state of the branch
    url str
    Planetscale API URL for the branch
    actor Property Map
    clusterSize String
    The SKU representing the branch's cluster size
    database String
    Database name slug from list_databases. Example: app-db.
    htmlUrl String
    Planetscale app URL for the branch
    id String
    The ID of the branch
    mysqlAddress String
    The MySQL address for the branch
    mysqlEdgeAddress String
    The address of the MySQL provider for the branch
    name String
    The name of the branch
    organization String
    Organization name slug from list_organizations. Example: acme.
    parentBranch String
    The name of the parent branch from which the branch was created
    ready Boolean
    Whether or not the branch is ready to serve queries
    regionData Property Map
    state String
    The current state of the branch
    url String
    Planetscale API URL for the branch

    Supporting Types

    GetVitessBranchActor

    Id string
    The ID of the actor
    Id string
    The ID of the actor
    id String
    The ID of the actor
    id string
    The ID of the actor
    id str
    The ID of the actor
    id String
    The ID of the actor

    GetVitessBranchRegionData

    Id string
    The ID of the region
    Id string
    The ID of the region
    id String
    The ID of the region
    id string
    The ID of the region
    id str
    The ID of the region
    id String
    The ID of the region

    Package Details

    Repository
    planetscale planetscale/terraform-provider-planetscale
    License
    Notes
    This Pulumi package is based on the planetscale Terraform Provider.
    Viewing docs for planetscale 1.0.0
    published on Monday, Mar 2, 2026 by planetscale
    Schema (JSON)
    planetscale/terraform-provider-planetscale
      Try Pulumi Cloud free. Your team will thank you.