Viewing docs for planetscale 1.20.0
published on Thursday, Nov 12, 2026 by planetscale
published on Thursday, Nov 12, 2026 by planetscale
planetscale
Viewing docs for planetscale 1.20.0
published on Thursday, Nov 12, 2026 by planetscale
published on Thursday, Nov 12, 2026 by 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...'
Example coming soon!
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?: InvokeOutputOptions): 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: pulumi.Input[Optional[str]] = None,
id: pulumi.Input[Optional[str]] = None,
organization: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOutputOptions] = 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 Output<GetVitessBranchResult> Invoke(GetVitessBranchInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetVitessBranchResult> getVitessBranch(GetVitessBranchArgs args, InvokeOptions options)
public static Output<GetVitessBranchResult> getVitessBranch(GetVitessBranchArgs args, InvokeOptions options)
public static Output<GetVitessBranchResult> getVitessBranch(GetVitessBranchArgs args, InvokeOutputOptions options)
fn::invoke:
function: planetscale:index/getVitessBranch:getVitessBranch
arguments:
# arguments dictionarydata "planetscale_get_vitess_branch" "name" {
# arguments
}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 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
Get
Vitess Branch Actor - Cluster
Size string - The SKU representing the branch's cluster size
- Database string
- Database name slug from
list_databases. Example:app-db. - Deletion
Protected bool - Whether deletion protection is enabled for the branch
- Html
Url string - Planetscale app URL for the branch
- Id string
- The ID of the branch
- Keyspace
Count double - The number of keyspaces in the branch
- Mysql
Address string - The MySQL address for the branch
- Mysql
Edge stringAddress - 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. - Parameters
Dictionary<string, Immutable
Dictionary<string, string>> - VTGate parameter overrides, nested under the
vtgatenamespace. Values are strings in the API's format: byte sizes as plain integers and durations such as30s. - Parent
Branch 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
- Region
Data GetVitess Branch Region Data - Safe
Migrations bool - Whether or not the branch has safe migrations enabled
- State string
- The current state of the branch
- Url string
- Planetscale API URL for the branch
- Vtgate
Autoscaling bool - Whether VTGate autoscaling is enabled
- Vtgate
Count double - The number of vtgate instances in the branch
- Vtgate
Max doubleCount - The maximum number of VTGate instances when autoscaling is enabled
- Vtgate
Size string - The public SKU representing the VTGate size
- Vtgate
Target doubleCpu Utilization - The target CPU utilization for VTGate autoscaling
- Actor
Get
Vitess Branch Actor - Cluster
Size string - The SKU representing the branch's cluster size
- Database string
- Database name slug from
list_databases. Example:app-db. - Deletion
Protected bool - Whether deletion protection is enabled for the branch
- Html
Url string - Planetscale app URL for the branch
- Id string
- The ID of the branch
- Keyspace
Count float64 - The number of keyspaces in the branch
- Mysql
Address string - The MySQL address for the branch
- Mysql
Edge stringAddress - 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. - Parameters map[string]map[string]string
- VTGate parameter overrides, nested under the
vtgatenamespace. Values are strings in the API's format: byte sizes as plain integers and durations such as30s. - Parent
Branch 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
- Region
Data GetVitess Branch Region Data - Safe
Migrations bool - Whether or not the branch has safe migrations enabled
- State string
- The current state of the branch
- Url string
- Planetscale API URL for the branch
- Vtgate
Autoscaling bool - Whether VTGate autoscaling is enabled
- Vtgate
Count float64 - The number of vtgate instances in the branch
- Vtgate
Max float64Count - The maximum number of VTGate instances when autoscaling is enabled
- Vtgate
Size string - The public SKU representing the VTGate size
- Vtgate
Target float64Cpu Utilization - The target CPU utilization for VTGate autoscaling
- actor object
- cluster_
size string - The SKU representing the branch's cluster size
- database string
- Database name slug from
list_databases. Example:app-db. - deletion_
protected bool - Whether deletion protection is enabled for the branch
- html_
url string - Planetscale app URL for the branch
- id string
- The ID of the branch
- keyspace_
count number - The number of keyspaces in the branch
- mysql_
address string - The MySQL address for the branch
- mysql_
edge_ stringaddress - 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. - parameters map(map(string))
- VTGate parameter overrides, nested under the
vtgatenamespace. Values are strings in the API's format: byte sizes as plain integers and durations such as30s. - parent_
branch 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
- region_
data object - safe_
migrations bool - Whether or not the branch has safe migrations enabled
- state string
- The current state of the branch
- url string
- Planetscale API URL for the branch
- vtgate_
autoscaling bool - Whether VTGate autoscaling is enabled
- vtgate_
count number - The number of vtgate instances in the branch
- vtgate_
max_ numbercount - The maximum number of VTGate instances when autoscaling is enabled
- vtgate_
size string - The public SKU representing the VTGate size
- vtgate_
target_ numbercpu_ utilization - The target CPU utilization for VTGate autoscaling
- actor
Get
Vitess Branch Actor - cluster
Size String - The SKU representing the branch's cluster size
- database String
- Database name slug from
list_databases. Example:app-db. - deletion
Protected Boolean - Whether deletion protection is enabled for the branch
- html
Url String - Planetscale app URL for the branch
- id String
- The ID of the branch
- keyspace
Count Double - The number of keyspaces in the branch
- mysql
Address String - The MySQL address for the branch
- mysql
Edge StringAddress - 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. - parameters Map<String,Map<String,String>>
- VTGate parameter overrides, nested under the
vtgatenamespace. Values are strings in the API's format: byte sizes as plain integers and durations such as30s. - parent
Branch 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
- region
Data GetVitess Branch Region Data - safe
Migrations Boolean - Whether or not the branch has safe migrations enabled
- state String
- The current state of the branch
- url String
- Planetscale API URL for the branch
- vtgate
Autoscaling Boolean - Whether VTGate autoscaling is enabled
- vtgate
Count Double - The number of vtgate instances in the branch
- vtgate
Max DoubleCount - The maximum number of VTGate instances when autoscaling is enabled
- vtgate
Size String - The public SKU representing the VTGate size
- vtgate
Target DoubleCpu Utilization - The target CPU utilization for VTGate autoscaling
- actor
Get
Vitess Branch Actor - cluster
Size string - The SKU representing the branch's cluster size
- database string
- Database name slug from
list_databases. Example:app-db. - deletion
Protected boolean - Whether deletion protection is enabled for the branch
- html
Url string - Planetscale app URL for the branch
- id string
- The ID of the branch
- keyspace
Count number - The number of keyspaces in the branch
- mysql
Address string - The MySQL address for the branch
- mysql
Edge stringAddress - 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. - parameters {[key: string]: {[key: string]: string}}
- VTGate parameter overrides, nested under the
vtgatenamespace. Values are strings in the API's format: byte sizes as plain integers and durations such as30s. - parent
Branch 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
- region
Data GetVitess Branch Region Data - safe
Migrations boolean - Whether or not the branch has safe migrations enabled
- state string
- The current state of the branch
- url string
- Planetscale API URL for the branch
- vtgate
Autoscaling boolean - Whether VTGate autoscaling is enabled
- vtgate
Count number - The number of vtgate instances in the branch
- vtgate
Max numberCount - The maximum number of VTGate instances when autoscaling is enabled
- vtgate
Size string - The public SKU representing the VTGate size
- vtgate
Target numberCpu Utilization - The target CPU utilization for VTGate autoscaling
- actor
Get
Vitess Branch Actor - cluster_
size str - The SKU representing the branch's cluster size
- database str
- Database name slug from
list_databases. Example:app-db. - deletion_
protected bool - Whether deletion protection is enabled for the branch
- html_
url str - Planetscale app URL for the branch
- id str
- The ID of the branch
- keyspace_
count float - The number of keyspaces in the branch
- mysql_
address str - The MySQL address for the branch
- mysql_
edge_ straddress - 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. - parameters Mapping[str, Mapping[str, str]]
- VTGate parameter overrides, nested under the
vtgatenamespace. Values are strings in the API's format: byte sizes as plain integers and durations such as30s. - 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 GetVitess Branch Region Data - safe_
migrations bool - Whether or not the branch has safe migrations enabled
- state str
- The current state of the branch
- url str
- Planetscale API URL for the branch
- vtgate_
autoscaling bool - Whether VTGate autoscaling is enabled
- vtgate_
count float - The number of vtgate instances in the branch
- vtgate_
max_ floatcount - The maximum number of VTGate instances when autoscaling is enabled
- vtgate_
size str - The public SKU representing the VTGate size
- vtgate_
target_ floatcpu_ utilization - The target CPU utilization for VTGate autoscaling
- actor Property Map
- cluster
Size String - The SKU representing the branch's cluster size
- database String
- Database name slug from
list_databases. Example:app-db. - deletion
Protected Boolean - Whether deletion protection is enabled for the branch
- html
Url String - Planetscale app URL for the branch
- id String
- The ID of the branch
- keyspace
Count Number - The number of keyspaces in the branch
- mysql
Address String - The MySQL address for the branch
- mysql
Edge StringAddress - 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. - parameters Map<Map<String>>
- VTGate parameter overrides, nested under the
vtgatenamespace. Values are strings in the API's format: byte sizes as plain integers and durations such as30s. - parent
Branch 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
- region
Data Property Map - safe
Migrations Boolean - Whether or not the branch has safe migrations enabled
- state String
- The current state of the branch
- url String
- Planetscale API URL for the branch
- vtgate
Autoscaling Boolean - Whether VTGate autoscaling is enabled
- vtgate
Count Number - The number of vtgate instances in the branch
- vtgate
Max NumberCount - The maximum number of VTGate instances when autoscaling is enabled
- vtgate
Size String - The public SKU representing the VTGate size
- vtgate
Target NumberCpu Utilization - The target CPU utilization for VTGate autoscaling
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 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
- Mysql
Supported bool - Whether the region supports MySQL/Vitess databases
- Postgresql
Supported bool - Whether the region supports PostgreSQL databases
- Id string
- The ID of the region
- Mysql
Supported bool - Whether the region supports MySQL/Vitess databases
- Postgresql
Supported bool - Whether the region supports PostgreSQL databases
- id string
- The ID of the region
- mysql_
supported bool - Whether the region supports MySQL/Vitess databases
- postgresql_
supported bool - Whether the region supports PostgreSQL databases
- id String
- The ID of the region
- mysql
Supported Boolean - Whether the region supports MySQL/Vitess databases
- postgresql
Supported Boolean - Whether the region supports PostgreSQL databases
- id string
- The ID of the region
- mysql
Supported boolean - Whether the region supports MySQL/Vitess databases
- postgresql
Supported boolean - Whether the region supports PostgreSQL databases
- id str
- The ID of the region
- mysql_
supported bool - Whether the region supports MySQL/Vitess databases
- postgresql_
supported bool - Whether the region supports PostgreSQL databases
- id String
- The ID of the region
- mysql
Supported Boolean - Whether the region supports MySQL/Vitess databases
- postgresql
Supported Boolean - Whether the region supports PostgreSQL databases
Package Details
- Repository
- planetscale planetscale/terraform-provider-planetscale
- License
- Notes
- This Pulumi package is based on the
planetscaleTerraform Provider.
planetscale
Viewing docs for planetscale 1.20.0
published on Thursday, Nov 12, 2026 by planetscale
published on Thursday, Nov 12, 2026 by planetscale