planetscalepostgresbranch_backup (Data Source)

June 3, 2026 ยท View on GitHub

PostgresBranchBackup DataSource

Example Usage

data "planetscale_postgres_branch_backup" "my_postgresbranchbackup" {
  branch       = "...my_branch..."
  database     = "...my_database..."
  id           = "...my_id..."
  organization = "...my_organization..."
}

Schema

Required

  • branch (String) The name of the branch
  • database (String) The name of the database the branch belongs to
  • id (String) The ID of the backup
  • organization (String) The name of the organization the branch belongs to

Read-Only

  • actor (Attributes) (see below for nested schema)
  • backup_policy (Attributes) (see below for nested schema)
  • completed_at (String) When the backup completed
  • database_branch (Attributes) (see below for nested schema)
  • deleted_at (String) When the backup was deleted
  • estimated_storage_cost (Number) The estimated storage cost of the backup
  • expires_at (String) When the backup expires
  • name (String) The name of the backup
  • protected (Boolean) Whether or not the backup is protected from deletion
  • pvc_size (Number) Size of the PVC used for the backup
  • size (Number) The size of the backup in bytes
  • started_at (String) When the backup started
  • state (String) The current state of the backup

Nested Schema for actor

Read-Only:

  • id (String) The ID of the actor

Nested Schema for backup_policy

Read-Only:

  • id (String) The ID of the backup policy

Nested Schema for database_branch

Read-Only:

  • id (String) The ID for the resource
  • name (String) The name for the resource