import * as pulumi from "@pulumi/pulumi"; import * as inputs from "./types/input"; import * as outputs from "./types/output"; export declare class PostgresBranch extends pulumi.CustomResource { /** * Get an existing PostgresBranch 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?: PostgresBranchState, opts?: pulumi.CustomResourceOptions): PostgresBranch; /** * Returns true if the given object is an instance of PostgresBranch. 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 PostgresBranch; 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 size of the cluster. Available sizes can be found using the 'List cluster sizes' endpoint. */ 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; /** * For PostgreSQL databases, the PostgreSQL major version to use for the branch. Defaults to the major version of the parent branch if it exists or the database's default branch major version. Ignored for branches restored from backups. Requires replacement if changed. */ readonly majorVersion: 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; /** * The number of replicas for the branch */ readonly replicas: pulumi.Output; /** * Restore from a point-in-time recovery timestamp (e.g. 2023-01-01T00:00:00Z). Available only for PostgreSQL databases. Requires replacement if changed. */ readonly restorePoint: pulumi.Output; /** * The current state of the branch */ readonly state: pulumi.Output; /** * Planetscale API URL for the branch */ readonly url: pulumi.Output; /** * Create a PostgresBranch 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: PostgresBranchArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering PostgresBranch resources. */ export interface PostgresBranchState { 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 size of the cluster. Available sizes can be found using the 'List cluster sizes' endpoint. */ clusterSize?: pulumi.Input; /** * Database name slug from `list_databases`. Example: `app-db`. */ database?: pulumi.Input; /** * Planetscale app URL for the branch */ htmlUrl?: pulumi.Input; /** * For PostgreSQL databases, the PostgreSQL major version to use for the branch. Defaults to the major version of the parent branch if it exists or the database's default branch major version. Ignored for branches restored from backups. Requires replacement if changed. */ majorVersion?: 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; /** * The number of replicas for the branch */ replicas?: pulumi.Input; /** * Restore from a point-in-time recovery timestamp (e.g. 2023-01-01T00:00:00Z). Available only for PostgreSQL databases. Requires replacement if changed. */ restorePoint?: 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 PostgresBranch resource. */ export interface PostgresBranchArgs { /** * 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 size of the cluster. Available sizes can be found using the 'List cluster sizes' endpoint. */ clusterSize?: pulumi.Input; /** * Database name slug from `list_databases`. Example: `app-db`. */ database: pulumi.Input; /** * For PostgreSQL databases, the PostgreSQL major version to use for the branch. Defaults to the major version of the parent branch if it exists or the database's default branch major version. Ignored for branches restored from backups. Requires replacement if changed. */ majorVersion?: 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; /** * Restore from a point-in-time recovery timestamp (e.g. 2023-01-01T00:00:00Z). Available only for PostgreSQL databases. Requires replacement if changed. */ restorePoint?: pulumi.Input; }