Skip to content

postgres_branch.md

Latest commit

 

History

History
58 lines (42 loc) · 1.65 KB

postgres_branch.md

File metadata and controls

58 lines (42 loc) · 1.65 KB
page_title planetscale_postgres_branch Data Source - terraform-provider-planetscale
subcategory
description PostgresBranch DataSource

planetscale_postgres_branch (Data Source)

PostgresBranch DataSource

Example Usage

data "planetscale_postgres_branch" "my_postgresbranch" {
  database     = "...my_database..."
  id           = "...my_id..."
  organization = "...my_organization..."
}

Schema

Required

  • 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.

Read-Only

  • actor (Attributes) (see below for nested schema)
  • cluster_size (String) The SKU representing the branch's cluster size
  • html_url (String) Planetscale app URL for the branch
  • name (String) The name of the branch
  • 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 (Attributes) (see below for nested schema)
  • replicas (Number) The number of replicas for the branch
  • state (String) The current state of the branch
  • url (String) Planetscale API URL for the branch

Nested Schema for actor

Read-Only:

  • id (String) The ID of the actor

Nested Schema for region_data

Read-Only:

  • id (String) The ID of the region