1. Packages
  2. Planetscale Provider
  3. API Docs
  4. VitessBranch
planetscale 1.0.0-rc1 published on Friday, Jan 30, 2026 by planetscale
planetscale logo
planetscale 1.0.0-rc1 published on Friday, Jan 30, 2026 by planetscale

    VitessBranch Resource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as planetscale from "@pulumi/planetscale";
    
    const myVitessbranch = new planetscale.VitessBranch("my_vitessbranch", {
        organization: "my-organization",
        database: "ru00w3vqvfr9",
        name: "my-branch",
    });
    
    import pulumi
    import pulumi_planetscale as planetscale
    
    my_vitessbranch = planetscale.VitessBranch("my_vitessbranch",
        organization="my-organization",
        database="ru00w3vqvfr9",
        name="my-branch")
    
    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.NewVitessBranch(ctx, "my_vitessbranch", &planetscale.VitessBranchArgs{
    			Organization: pulumi.String("my-organization"),
    			Database:     pulumi.String("ru00w3vqvfr9"),
    			Name:         pulumi.String("my-branch"),
    		})
    		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 = new Planetscale.VitessBranch("my_vitessbranch", new()
        {
            Organization = "my-organization",
            Database = "ru00w3vqvfr9",
            Name = "my-branch",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.planetscale.VitessBranch;
    import com.pulumi.planetscale.VitessBranchArgs;
    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) {
            var myVitessbranch = new VitessBranch("myVitessbranch", VitessBranchArgs.builder()
                .organization("my-organization")
                .database("ru00w3vqvfr9")
                .name("my-branch")
                .build());
    
        }
    }
    
    resources:
      myVitessbranch:
        type: planetscale:VitessBranch
        name: my_vitessbranch
        properties:
          organization: my-organization
          database: ru00w3vqvfr9
          name: my-branch
    

    Create VitessBranch Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new VitessBranch(name: string, args: VitessBranchArgs, opts?: CustomResourceOptions);
    @overload
    def VitessBranch(resource_name: str,
                     args: VitessBranchArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def VitessBranch(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     database: Optional[str] = None,
                     organization: Optional[str] = None,
                     backup_id: Optional[str] = None,
                     name: Optional[str] = None,
                     parent_branch: Optional[str] = None,
                     region: Optional[str] = None,
                     seed_data: Optional[str] = None)
    func NewVitessBranch(ctx *Context, name string, args VitessBranchArgs, opts ...ResourceOption) (*VitessBranch, error)
    public VitessBranch(string name, VitessBranchArgs args, CustomResourceOptions? opts = null)
    public VitessBranch(String name, VitessBranchArgs args)
    public VitessBranch(String name, VitessBranchArgs args, CustomResourceOptions options)
    
    type: planetscale:VitessBranch
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args VitessBranchArgs
    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 VitessBranchArgs
    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 VitessBranchArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VitessBranchArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VitessBranchArgs
    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 vitessBranchResource = new Planetscale.VitessBranch("vitessBranchResource", new()
    {
        Database = "string",
        Organization = "string",
        BackupId = "string",
        Name = "string",
        ParentBranch = "string",
        Region = "string",
        SeedData = "string",
    });
    
    example, err := planetscale.NewVitessBranch(ctx, "vitessBranchResource", &planetscale.VitessBranchArgs{
    	Database:     pulumi.String("string"),
    	Organization: pulumi.String("string"),
    	BackupId:     pulumi.String("string"),
    	Name:         pulumi.String("string"),
    	ParentBranch: pulumi.String("string"),
    	Region:       pulumi.String("string"),
    	SeedData:     pulumi.String("string"),
    })
    
    var vitessBranchResource = new VitessBranch("vitessBranchResource", VitessBranchArgs.builder()
        .database("string")
        .organization("string")
        .backupId("string")
        .name("string")
        .parentBranch("string")
        .region("string")
        .seedData("string")
        .build());
    
    vitess_branch_resource = planetscale.VitessBranch("vitessBranchResource",
        database="string",
        organization="string",
        backup_id="string",
        name="string",
        parent_branch="string",
        region="string",
        seed_data="string")
    
    const vitessBranchResource = new planetscale.VitessBranch("vitessBranchResource", {
        database: "string",
        organization: "string",
        backupId: "string",
        name: "string",
        parentBranch: "string",
        region: "string",
        seedData: "string",
    });
    
    type: planetscale:VitessBranch
    properties:
        backupId: string
        database: string
        name: string
        organization: string
        parentBranch: string
        region: string
        seedData: string
    

    VitessBranch 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 VitessBranch resource accepts the following input properties:

    Database string
    The name of the database the branch belongs to
    Organization string
    The name of the organization the branch belongs to
    BackupId string
    If provided, restores the backup's schema and data to the new branch. Must have restore_production_branch_backup(s) or restore_backup(s) access to do this. Requires replacement if changed.
    Name string
    The name of the branch to create
    ParentBranch string
    The name of the parent branch. Defaults to the database's default branch if not provided. Requires replacement if changed.
    Region string
    The region to create the branch in. If not provided, the branch will be created in the default region for its database. Requires replacement if changed.
    SeedData string
    If provided, restores the last successful backup's schema and data to the new branch. Must have restore_production_branch_backup(s) or restore_backup(s) access to do this, in addition to Data Branching™ being enabled for the branch. must be "lastsuccessfulbackup"; Requires replacement if changed.
    Database string
    The name of the database the branch belongs to
    Organization string
    The name of the organization the branch belongs to
    BackupId string
    If provided, restores the backup's schema and data to the new branch. Must have restore_production_branch_backup(s) or restore_backup(s) access to do this. Requires replacement if changed.
    Name string
    The name of the branch to create
    ParentBranch string
    The name of the parent branch. Defaults to the database's default branch if not provided. Requires replacement if changed.
    Region string
    The region to create the branch in. If not provided, the branch will be created in the default region for its database. Requires replacement if changed.
    SeedData string
    If provided, restores the last successful backup's schema and data to the new branch. Must have restore_production_branch_backup(s) or restore_backup(s) access to do this, in addition to Data Branching™ being enabled for the branch. must be "lastsuccessfulbackup"; Requires replacement if changed.
    database String
    The name of the database the branch belongs to
    organization String
    The name of the organization the branch belongs to
    backupId String
    If provided, restores the backup's schema and data to the new branch. Must have restore_production_branch_backup(s) or restore_backup(s) access to do this. Requires replacement if changed.
    name String
    The name of the branch to create
    parentBranch String
    The name of the parent branch. Defaults to the database's default branch if not provided. Requires replacement if changed.
    region String
    The region to create the branch in. If not provided, the branch will be created in the default region for its database. Requires replacement if changed.
    seedData String
    If provided, restores the last successful backup's schema and data to the new branch. Must have restore_production_branch_backup(s) or restore_backup(s) access to do this, in addition to Data Branching™ being enabled for the branch. must be "lastsuccessfulbackup"; Requires replacement if changed.
    database string
    The name of the database the branch belongs to
    organization string
    The name of the organization the branch belongs to
    backupId string
    If provided, restores the backup's schema and data to the new branch. Must have restore_production_branch_backup(s) or restore_backup(s) access to do this. Requires replacement if changed.
    name string
    The name of the branch to create
    parentBranch string
    The name of the parent branch. Defaults to the database's default branch if not provided. Requires replacement if changed.
    region string
    The region to create the branch in. If not provided, the branch will be created in the default region for its database. Requires replacement if changed.
    seedData string
    If provided, restores the last successful backup's schema and data to the new branch. Must have restore_production_branch_backup(s) or restore_backup(s) access to do this, in addition to Data Branching™ being enabled for the branch. must be "lastsuccessfulbackup"; Requires replacement if changed.
    database str
    The name of the database the branch belongs to
    organization str
    The name of the organization the branch belongs to
    backup_id str
    If provided, restores the backup's schema and data to the new branch. Must have restore_production_branch_backup(s) or restore_backup(s) access to do this. Requires replacement if changed.
    name str
    The name of the branch to create
    parent_branch str
    The name of the parent branch. Defaults to the database's default branch if not provided. Requires replacement if changed.
    region str
    The region to create the branch in. If not provided, the branch will be created in the default region for its database. Requires replacement if changed.
    seed_data str
    If provided, restores the last successful backup's schema and data to the new branch. Must have restore_production_branch_backup(s) or restore_backup(s) access to do this, in addition to Data Branching™ being enabled for the branch. must be "lastsuccessfulbackup"; Requires replacement if changed.
    database String
    The name of the database the branch belongs to
    organization String
    The name of the organization the branch belongs to
    backupId String
    If provided, restores the backup's schema and data to the new branch. Must have restore_production_branch_backup(s) or restore_backup(s) access to do this. Requires replacement if changed.
    name String
    The name of the branch to create
    parentBranch String
    The name of the parent branch. Defaults to the database's default branch if not provided. Requires replacement if changed.
    region String
    The region to create the branch in. If not provided, the branch will be created in the default region for its database. Requires replacement if changed.
    seedData String
    If provided, restores the last successful backup's schema and data to the new branch. Must have restore_production_branch_backup(s) or restore_backup(s) access to do this, in addition to Data Branching™ being enabled for the branch. must be "lastsuccessfulbackup"; Requires replacement if changed.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VitessBranch resource produces the following output properties:

    Actor VitessBranchActor
    ClusterName string
    The SKU representing the branch's cluster size
    HtmlUrl string
    Planetscale app URL for the branch
    Id string
    The provider-assigned unique ID for this managed resource.
    MysqlAddress string
    The MySQL address for the branch
    MysqlEdgeAddress string
    The address of the MySQL provider for the branch
    Ready bool
    Whether or not the branch is ready to serve queries
    RegionData VitessBranchRegionData
    State string
    The current state of the branch
    Url string
    Planetscale API URL for the branch
    Actor VitessBranchActor
    ClusterName string
    The SKU representing the branch's cluster size
    HtmlUrl string
    Planetscale app URL for the branch
    Id string
    The provider-assigned unique ID for this managed resource.
    MysqlAddress string
    The MySQL address for the branch
    MysqlEdgeAddress string
    The address of the MySQL provider for the branch
    Ready bool
    Whether or not the branch is ready to serve queries
    RegionData VitessBranchRegionData
    State string
    The current state of the branch
    Url string
    Planetscale API URL for the branch
    actor VitessBranchActor
    clusterName String
    The SKU representing the branch's cluster size
    htmlUrl String
    Planetscale app URL for the branch
    id String
    The provider-assigned unique ID for this managed resource.
    mysqlAddress String
    The MySQL address for the branch
    mysqlEdgeAddress String
    The address of the MySQL provider for the branch
    ready Boolean
    Whether or not the branch is ready to serve queries
    regionData VitessBranchRegionData
    state String
    The current state of the branch
    url String
    Planetscale API URL for the branch
    actor VitessBranchActor
    clusterName string
    The SKU representing the branch's cluster size
    htmlUrl string
    Planetscale app URL for the branch
    id string
    The provider-assigned unique ID for this managed resource.
    mysqlAddress string
    The MySQL address for the branch
    mysqlEdgeAddress string
    The address of the MySQL provider for the branch
    ready boolean
    Whether or not the branch is ready to serve queries
    regionData VitessBranchRegionData
    state string
    The current state of the branch
    url string
    Planetscale API URL for the branch
    actor VitessBranchActor
    cluster_name str
    The SKU representing the branch's cluster size
    html_url str
    Planetscale app URL for the branch
    id str
    The provider-assigned unique ID for this managed resource.
    mysql_address str
    The MySQL address for the branch
    mysql_edge_address str
    The address of the MySQL provider for the branch
    ready bool
    Whether or not the branch is ready to serve queries
    region_data VitessBranchRegionData
    state str
    The current state of the branch
    url str
    Planetscale API URL for the branch
    actor Property Map
    clusterName String
    The SKU representing the branch's cluster size
    htmlUrl String
    Planetscale app URL for the branch
    id String
    The provider-assigned unique ID for this managed resource.
    mysqlAddress String
    The MySQL address for the branch
    mysqlEdgeAddress String
    The address of the MySQL provider for the branch
    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

    Look up Existing VitessBranch Resource

    Get an existing VitessBranch 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?: VitessBranchState, opts?: CustomResourceOptions): VitessBranch
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            actor: Optional[VitessBranchActorArgs] = None,
            backup_id: Optional[str] = None,
            cluster_name: Optional[str] = None,
            database: Optional[str] = None,
            html_url: Optional[str] = None,
            mysql_address: Optional[str] = None,
            mysql_edge_address: Optional[str] = None,
            name: Optional[str] = None,
            organization: Optional[str] = None,
            parent_branch: Optional[str] = None,
            ready: Optional[bool] = None,
            region: Optional[str] = None,
            region_data: Optional[VitessBranchRegionDataArgs] = None,
            seed_data: Optional[str] = None,
            state: Optional[str] = None,
            url: Optional[str] = None) -> VitessBranch
    func GetVitessBranch(ctx *Context, name string, id IDInput, state *VitessBranchState, opts ...ResourceOption) (*VitessBranch, error)
    public static VitessBranch Get(string name, Input<string> id, VitessBranchState? state, CustomResourceOptions? opts = null)
    public static VitessBranch get(String name, Output<String> id, VitessBranchState state, CustomResourceOptions options)
    resources:  _:    type: planetscale:VitessBranch    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Actor VitessBranchActor
    BackupId string
    If provided, restores the backup's schema and data to the new branch. Must have restore_production_branch_backup(s) or restore_backup(s) access to do this. Requires replacement if changed.
    ClusterName string
    The SKU representing the branch's cluster size
    Database string
    The name of the database the branch belongs to
    HtmlUrl string
    Planetscale app URL for 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 to create
    Organization string
    The name of the organization the branch belongs to
    ParentBranch string
    The name of the parent branch. Defaults to the database's default branch if not provided. Requires replacement if changed.
    Ready bool
    Whether or not the branch is ready to serve queries
    Region string
    The region to create the branch in. If not provided, the branch will be created in the default region for its database. Requires replacement if changed.
    RegionData VitessBranchRegionData
    SeedData string
    If provided, restores the last successful backup's schema and data to the new branch. Must have restore_production_branch_backup(s) or restore_backup(s) access to do this, in addition to Data Branching™ being enabled for the branch. must be "lastsuccessfulbackup"; Requires replacement if changed.
    State string
    The current state of the branch
    Url string
    Planetscale API URL for the branch
    Actor VitessBranchActorArgs
    BackupId string
    If provided, restores the backup's schema and data to the new branch. Must have restore_production_branch_backup(s) or restore_backup(s) access to do this. Requires replacement if changed.
    ClusterName string
    The SKU representing the branch's cluster size
    Database string
    The name of the database the branch belongs to
    HtmlUrl string
    Planetscale app URL for 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 to create
    Organization string
    The name of the organization the branch belongs to
    ParentBranch string
    The name of the parent branch. Defaults to the database's default branch if not provided. Requires replacement if changed.
    Ready bool
    Whether or not the branch is ready to serve queries
    Region string
    The region to create the branch in. If not provided, the branch will be created in the default region for its database. Requires replacement if changed.
    RegionData VitessBranchRegionDataArgs
    SeedData string
    If provided, restores the last successful backup's schema and data to the new branch. Must have restore_production_branch_backup(s) or restore_backup(s) access to do this, in addition to Data Branching™ being enabled for the branch. must be "lastsuccessfulbackup"; Requires replacement if changed.
    State string
    The current state of the branch
    Url string
    Planetscale API URL for the branch
    actor VitessBranchActor
    backupId String
    If provided, restores the backup's schema and data to the new branch. Must have restore_production_branch_backup(s) or restore_backup(s) access to do this. Requires replacement if changed.
    clusterName String
    The SKU representing the branch's cluster size
    database String
    The name of the database the branch belongs to
    htmlUrl String
    Planetscale app URL for 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 to create
    organization String
    The name of the organization the branch belongs to
    parentBranch String
    The name of the parent branch. Defaults to the database's default branch if not provided. Requires replacement if changed.
    ready Boolean
    Whether or not the branch is ready to serve queries
    region String
    The region to create the branch in. If not provided, the branch will be created in the default region for its database. Requires replacement if changed.
    regionData VitessBranchRegionData
    seedData String
    If provided, restores the last successful backup's schema and data to the new branch. Must have restore_production_branch_backup(s) or restore_backup(s) access to do this, in addition to Data Branching™ being enabled for the branch. must be "lastsuccessfulbackup"; Requires replacement if changed.
    state String
    The current state of the branch
    url String
    Planetscale API URL for the branch
    actor VitessBranchActor
    backupId string
    If provided, restores the backup's schema and data to the new branch. Must have restore_production_branch_backup(s) or restore_backup(s) access to do this. Requires replacement if changed.
    clusterName string
    The SKU representing the branch's cluster size
    database string
    The name of the database the branch belongs to
    htmlUrl string
    Planetscale app URL for 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 to create
    organization string
    The name of the organization the branch belongs to
    parentBranch string
    The name of the parent branch. Defaults to the database's default branch if not provided. Requires replacement if changed.
    ready boolean
    Whether or not the branch is ready to serve queries
    region string
    The region to create the branch in. If not provided, the branch will be created in the default region for its database. Requires replacement if changed.
    regionData VitessBranchRegionData
    seedData string
    If provided, restores the last successful backup's schema and data to the new branch. Must have restore_production_branch_backup(s) or restore_backup(s) access to do this, in addition to Data Branching™ being enabled for the branch. must be "lastsuccessfulbackup"; Requires replacement if changed.
    state string
    The current state of the branch
    url string
    Planetscale API URL for the branch
    actor VitessBranchActorArgs
    backup_id str
    If provided, restores the backup's schema and data to the new branch. Must have restore_production_branch_backup(s) or restore_backup(s) access to do this. Requires replacement if changed.
    cluster_name str
    The SKU representing the branch's cluster size
    database str
    The name of the database the branch belongs to
    html_url str
    Planetscale app URL for 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 to create
    organization str
    The name of the organization the branch belongs to
    parent_branch str
    The name of the parent branch. Defaults to the database's default branch if not provided. Requires replacement if changed.
    ready bool
    Whether or not the branch is ready to serve queries
    region str
    The region to create the branch in. If not provided, the branch will be created in the default region for its database. Requires replacement if changed.
    region_data VitessBranchRegionDataArgs
    seed_data str
    If provided, restores the last successful backup's schema and data to the new branch. Must have restore_production_branch_backup(s) or restore_backup(s) access to do this, in addition to Data Branching™ being enabled for the branch. must be "lastsuccessfulbackup"; Requires replacement if changed.
    state str
    The current state of the branch
    url str
    Planetscale API URL for the branch
    actor Property Map
    backupId String
    If provided, restores the backup's schema and data to the new branch. Must have restore_production_branch_backup(s) or restore_backup(s) access to do this. Requires replacement if changed.
    clusterName String
    The SKU representing the branch's cluster size
    database String
    The name of the database the branch belongs to
    htmlUrl String
    Planetscale app URL for 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 to create
    organization String
    The name of the organization the branch belongs to
    parentBranch String
    The name of the parent branch. Defaults to the database's default branch if not provided. Requires replacement if changed.
    ready Boolean
    Whether or not the branch is ready to serve queries
    region String
    The region to create the branch in. If not provided, the branch will be created in the default region for its database. Requires replacement if changed.
    regionData Property Map
    seedData String
    If provided, restores the last successful backup's schema and data to the new branch. Must have restore_production_branch_backup(s) or restore_backup(s) access to do this, in addition to Data Branching™ being enabled for the branch. must be "lastsuccessfulbackup"; Requires replacement if changed.
    state String
    The current state of the branch
    url String
    Planetscale API URL for the branch

    Supporting Types

    VitessBranchActor, VitessBranchActorArgs

    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

    VitessBranchRegionData, VitessBranchRegionDataArgs

    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

    Import

    In Terraform v1.5.0 and later, the import block can be used with the id attribute, for example:

    terraform

    import {

    to = planetscale_vitess_branch.my_planetscale_vitess_branch

    id = jsonencode({

    database = "..."
    
    id = "..."
    
    organization = "..."
    

    })

    }

    The pulumi import command can be used, for example:

    $ pulumi import planetscale:index/vitessBranch:VitessBranch my_planetscale_vitess_branch '{"database": "...", "id": "...", "organization": "..."}'
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    planetscale planetscale/terraform-provider-planetscale
    License
    Notes
    This Pulumi package is based on the planetscale Terraform Provider.
    planetscale logo
    planetscale 1.0.0-rc1 published on Friday, Jan 30, 2026 by planetscale
      Meet Neo: Your AI Platform Teammate