import * as pulumi from "@pulumi/pulumi"; import * as inputs from "./types/input"; import * as outputs from "./types/output"; export declare class VitessBranch extends pulumi.CustomResource { /** * Get an existing VitessBranch resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: VitessBranchState, opts?: pulumi.CustomResourceOptions): VitessBranch; /** * Returns true if the given object is an instance of VitessBranch. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is VitessBranch; readonly actor: pulumi.Output; /** * 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. */ readonly backupId: pulumi.Output; /** * The SKU representing the branch's cluster size */ readonly clusterSize: pulumi.Output; /** * Database name slug from `list_databases`. Example: `app-db`. */ readonly database: pulumi.Output; /** * Planetscale app URL for the branch */ readonly htmlUrl: pulumi.Output; /** * The MySQL address for the branch */ readonly mysqlAddress: pulumi.Output; /** * The address of the MySQL provider for the branch */ readonly mysqlEdgeAddress: pulumi.Output; /** * The name of the branch to create */ readonly name: pulumi.Output; /** * Organization name slug from `list_organizations`. Example: `acme`. */ readonly organization: pulumi.Output; /** * The name of the parent branch. Defaults to the database's default branch if not provided. Requires replacement if changed. */ readonly parentBranch: pulumi.Output; /** * Whether or not the branch is ready to serve queries */ readonly ready: pulumi.Output; /** * 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. */ readonly region: pulumi.Output; readonly regionData: pulumi.Output; /** * 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 "last_successful_backup"; Requires replacement if changed. */ readonly seedData: pulumi.Output; /** * The current state of the branch */ readonly state: pulumi.Output; /** * Planetscale API URL for the branch */ readonly url: pulumi.Output; /** * Create a VitessBranch resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: VitessBranchArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering VitessBranch resources. */ export interface VitessBranchState { actor?: pulumi.Input; /** * 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. */ backupId?: pulumi.Input; /** * The SKU representing the branch's cluster size */ clusterSize?: pulumi.Input; /** * Database name slug from `list_databases`. Example: `app-db`. */ database?: pulumi.Input; /** * Planetscale app URL for the branch */ htmlUrl?: pulumi.Input; /** * The MySQL address for the branch */ mysqlAddress?: pulumi.Input; /** * The address of the MySQL provider for the branch */ mysqlEdgeAddress?: pulumi.Input; /** * The name of the branch to create */ name?: pulumi.Input; /** * Organization name slug from `list_organizations`. Example: `acme`. */ organization?: pulumi.Input; /** * The name of the parent branch. Defaults to the database's default branch if not provided. Requires replacement if changed. */ parentBranch?: pulumi.Input; /** * Whether or not the branch is ready to serve queries */ ready?: pulumi.Input; /** * 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?: pulumi.Input; regionData?: pulumi.Input; /** * 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 "last_successful_backup"; Requires replacement if changed. */ seedData?: pulumi.Input; /** * The current state of the branch */ state?: pulumi.Input; /** * Planetscale API URL for the branch */ url?: pulumi.Input; } /** * The set of arguments for constructing a VitessBranch resource. */ export interface VitessBranchArgs { /** * 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. */ backupId?: pulumi.Input; /** * Database name slug from `list_databases`. Example: `app-db`. */ database: pulumi.Input; /** * The name of the branch to create */ name?: pulumi.Input; /** * Organization name slug from `list_organizations`. Example: `acme`. */ organization: pulumi.Input; /** * The name of the parent branch. Defaults to the database's default branch if not provided. Requires replacement if changed. */ parentBranch?: pulumi.Input; /** * 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?: pulumi.Input; /** * 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 "last_successful_backup"; Requires replacement if changed. */ seedData?: pulumi.Input; }