Sign InTry Free

Terraform Integration Overview

Terraform is an infrastructure as code tool that lets you define both cloud and self-hosted resources in human-readable configuration files that you can version, reuse, and share.

TiDB Cloud Terraform Provider is a plugin that allows you to use Terraform to manage TiDB Cloud resources, such as clusters, backups, and restores.

If you are looking for a simple way to automate resource provisioning and your infrastructure workflow, you can try out TiDB Cloud Terraform Provider, which provides you with the following capacities:

  • Get your project information.
  • Get cluster specification information, such as supported cloud providers, regions, and node sizes.
  • Manage your TiDB cluster, including creating, scaling, pausing, and resuming a cluster.
  • Create and delete a backup for your cluster.
  • Create a restore task for your cluster.


Supported resources and data sources

Resources and Data sources are the two most important elements in the Terraform language.

TiDB Cloud supports the following resources and data sources:

  • Resources

    • tidbcloud_cluster
    • tidbcloud_backup
    • tidbcloud_restore
    • tidbcloud_import
  • Data sources

    • tidbcloud_projects
    • tidbcloud_cluster_specs
    • tidbcloud_clusters
    • tidbcloud_restores
    • tidbcloud_backups

To get all the available configurations for the resources and data sources, see this configuration documentation.

Next step

Was this page helpful?

Download PDFRequest docs changesAsk questions on Discord
One-stop & interactive experience of TiDB's capabilities WITHOUT registration.
TiDB Dedicated
TiDB Serverless
Get Demo
Get Started
© 2024 PingCAP. All Rights Reserved.
Privacy Policy.