Skip to content

Latest commit

 

History

History
56 lines (43 loc) · 1.87 KB

backup.md

File metadata and controls

56 lines (43 loc) · 1.87 KB
Raw
page_title subcategory description
tidbcloud_backup Resource - terraform-provider-tidbcloud
backup resource

tidbcloud_backup (Resource)

backup resource

Example Usage

terraform {
  required_providers {
    tidbcloud = {
      source = "tidbcloud/tidbcloud"
    }
  }
}

provider "tidbcloud" {
  public_key  = "fake_public_key"
  private_key = "fake_private_key"
}

resource "tidbcloud_backup" "example" {
  project_id  = "fake_id"
  cluster_id  = "fake_id"
  name        = "example"
  description = "create by terraform"
}

Schema

Required

  • cluster_id (String) The ID of your cluster that you want to take a manual backup.
  • name (String) Specify the name for a manual backup. It is recommended that you use a unique name, so that it is easy to distinguish the backup when you query the backups.
  • project_id (String) The ID of the project. You can get the project ID from tidbcloud_projects datasource.

Optional

  • description (String) The description of the backup. It helps you add additional information to the backup. Allows up to 256 characters.

Read-Only

  • create_timestamp (String) The creation time of the backup in UTC. The time format follows the ISO8601 standard, which is YYYY-MM-DD (year-month-day) + T +HH:MM:SS (hour-minutes-seconds) + Z. For example, 2020-01-01T00:00:00Z.
  • id (String) The ID of the backup. It is generated by TiDB Cloud.
  • size (String) The bytes of the backup.
  • status (String) Enum: PENDING/RUNNING/FAILED/SUCCESS.The status of backup.
  • type (String) Enum: MANUAL/AUTO.The type of backup. TiDB Cloud only supports manual and auto backup. For more information, see TiDB Cloud Documentation.