`tidbcloud_serverless_branch`リソースを使用する

このドキュメントでは、 tidbcloud_serverless_branchリソースを使用してTiDB Cloud Starter またはTiDB Cloud Essential ブランチ管理する方法について説明します。

tidbcloud_serverless_branchリソースの機能は次のとおりです。

TiDB Cloud Starter またはTiDB Cloud Essential ブランチを作成します。
TiDB Cloud Starter またはTiDB Cloud Essential ブランチをインポートします。
TiDB Cloud Starter またはTiDB Cloud Essential ブランチを削除します。

注記：
tidbcloud_serverless_branchリソースは変更できません。サーバーレスブランチリソースの設定を変更する場合は、既存のリソースを削除して新しいリソースを作成する必要があります。

前提条件

TiDB Cloud Starter またはTiDB Cloud Essential ブランチを作成する

tidbcloud_serverless_branchリソースを使用して、 TiDB Cloud Starter またはTiDB Cloud Essential ブランチを作成できます。

次の例は、TiDB Cloud Starter またはTiDB Cloud Essential ブランチを作成する方法を示しています。

ブランチ用のディレクトリを作成してそこに入ります。
branch.tfファイルを作成します。
```
terraform {
  required_providers {
    tidbcloud = {
      source = "tidbcloud/tidbcloud"
    }
  }
}

provider "tidbcloud" {
  public_key = "your_public_key"
  private_key = "your_private_key"
}

resource "tidbcloud_serverless_branch" "example" {
  cluster_id   = 10581524018573000000
  display_name = "example"
  parent_id = 10581524018573000000
}
```
resourceブロックを使用して、リソースタイプ、リソース名、リソースの詳細など、 TiDB Cloudのリソースを定義します。
- サーバーレスブランチリソースを使用するには、リソースタイプをtidbcloud_serverless_branchに設定します。
- リソース名は必要に応じて定義できます。例： example 。
- リソースの詳細については、サーバーレスブランチの仕様情報に従って設定できます。
- サーバーレスブランチの仕様情報を取得するには、 tidbcloud_serverless_branch (リソース)参照してください。

terraform applyコマンドを実行します。リソースを適用する場合はterraform apply --auto-approveの使用は推奨されません。

$ terraform apply

Terraform used the selected providers to generate the following execution plan. Resource actions are indicated with the following symbols:
  + create

Terraform will perform the following actions:

  # tidbcloud_serverless_branch.example will be created
  + resource "tidbcloud_serverless_branch" "example" {
      + annotations         = (known after apply)
      + branch_id           = (known after apply)
      + cluster_id          = "10581524018573000000"
      + create_time         = (known after apply)
      + created_by          = (known after apply)
      + display_name        = "example"
      + endpoints           = (known after apply)
      + parent_display_name = (known after apply)
      + parent_id           = "10581524018573000000"
      + parent_timestamp    = (known after apply)
      + state               = (known after apply)
      + update_time         = (known after apply)
      + user_prefix         = (known after apply)
    }

Plan: 1 to add, 0 to change, 0 to destroy.

Do you want to perform these actions?
  Terraform will perform the actions described above.
  Only 'yes' will be accepted to approve.

  Enter a value:

上記の結果では、Terraform によって実行プランが生成され、Terraform が実行するアクションが記述されています。

構成と状態の違いを確認できます。
applyの結果も確認できます。新しいリソースが追加されますが、リソースは変更または破棄されません。
known after apply apply後の対応する値が取得されることを示します。

計画の内容がすべて問題ない場合は、「 yesと入力して続行します。

Do you want to perform these actions?
  Terraform will perform the actions described above.
  Only 'yes' will be accepted to approve.

  Enter a value: yes

tidbcloud_serverless_branch.example: Creating...
tidbcloud_serverless_branch.example: Still creating... [10s elapsed]
tidbcloud_serverless_branch.example: Creation complete after 10s

Apply complete! Resources: 1 added, 0 changed, 0 destroyed.

リソースの状態を確認するには、コマンドterraform showまたはterraform state show tidbcloud_serverless_branch.${resource-name}使用します。コマンド 1 は、すべてのリソースとデータソースの状態を表示します。

$ terraform state show tidbcloud_serverless_branch.example 
# tidbcloud_serverless_branch.example:
resource "tidbcloud_serverless_branch" "example" {
    annotations         = {
        "tidb.cloud/has-set-password" = "false"
    }
    branch_id           = "bran-qt3fij6jufcf5pluot5h000000"
    cluster_id          = "10581524018573000000"
    create_time         = "2025-06-16T07:55:51Z"
    created_by          = "apikey-S2000000"
    display_name        = "example"
    endpoints           = {
        private = {
            aws  = {
                availability_zone = [
                    "use1-az6",
                ]
                service_name      = "com.amazonaws.vpce.us-east-1.vpce-svc-0062ecf0683000000"
            }
            host = "gateway01-privatelink.us-east-1.prod.aws.tidbcloud.com"
            port = 4000
        }
        public  = {
            disabled = false
            host     = "gateway01.us-east-1.prod.aws.tidbcloud.com"
            port     = 4000
        }
    }
    parent_display_name = "test-tf"
    parent_id           = "10581524018573000000"
    parent_timestamp    = "2025-06-16T07:55:51Z"
    state               = "ACTIVE"
    update_time         = "2025-06-16T07:56:49Z"
    user_prefix         = "4ER5SbndR000000"
}

TiDB Cloud Starter またはTiDB Cloud Essential ブランチをインポートする

Terraform によって管理されていないTiDB Cloud Starter またはTiDB Cloud Essential ブランチの場合は、インポートすることで Terraform の管理下に置くことができます。

次のように、Terraform によって作成されていないTiDB Cloud Starter またはTiDB Cloud Essential ブランチをインポートします。

新しいtidbcloud_serverless_branchリソースのインポートブロックを追加します。
次のインポートブロックを.tfファイルに追加し、 example目的のリソース名に置き換え、 ${id} cluster_id,branch_idの形式に置き換えます。
```
import {
  to = tidbcloud_serverless_branch.example
  id = "${id}"
}
```
新しい構成ファイルを生成します。
インポートブロックに従って、新しいtidbcloud_serverless_branchリソースの新しい構成ファイルを生成します。
```
terraform plan -generate-config-out=generated.tf
```
上記のコマンドでは、既存の.tf名を指定しないでください。指定した場合、Terraform はエラーを返します。
生成された構成を確認して適用します。
生成された構成ファイルを確認し、ニーズを満たしていることを確認してください。必要に応じて、このファイルの内容を任意の場所に移動することもできます。
次に、 terraform apply実行してインフラストラクチャをインポートします。適用後、出力例は次のようになります。
```
tidbcloud_serverless_branch.example: Importing... 
tidbcloud_serverless_branch.example: Import complete 

Apply complete! Resources: 1 imported, 0 added, 0 changed, 0 destroyed.
```

これで、インポートしたブランチを Terraform で管理できるようになりました。

TiDB Cloud Starter またはTiDB Cloud Essential ブランチを削除する

TiDB Cloud Starter またはTiDB Cloud Essential ブランチを削除するには、 tidbcloud_serverless_branchリソースの構成を削除してから、 terraform applyコマンドを使用してリソースを破棄します。

$ terraform apply
tidbcloud_serverless_branch.example: Refreshing state...

Terraform used the selected providers to generate the following execution plan. Resource actions are indicated with the following symbols:
  - destroy

Terraform will perform the following actions:

  # tidbcloud_serverless_branch.example will be destroyed
  # (because tidbcloud_serverless_branch.example is not in configuration)
  - resource "tidbcloud_serverless_branch" "example" {
      - annotations         = {
          - "tidb.cloud/has-set-password" = "false"
        } -> null
      - branch_id           = "bran-qt3fij6jufcf5pluot5h000000" -> null
      - cluster_id          = "10581524018573000000" -> null
      - create_time         = "2025-06-16T07:55:51Z" -> null
      - created_by          = "apikey-S2000000" -> null
      - display_name        = "example" -> null
      - endpoints           = {
          - private = {
              - aws  = {
                  - availability_zone = [
                      - "use1-az6",
                    ] -> null
                  - service_name      = "com.amazonaws.vpce.us-east-1.vpce-svc-0062ecf0683000000" -> null
                } -> null
              - host = "gateway01-privatelink.us-east-1.prod.aws.tidbcloud.com" -> null
              - port = 4000 -> null
            } -> null
          - public  = {
              - disabled = false -> null
              - host     = "gateway01.us-east-1.prod.aws.tidbcloud.com" -> null
              - port     = 4000 -> null
            } -> null
        } -> null
      - parent_display_name = "test-tf" -> null
      - parent_id           = "10581524018573000000" -> null
      - parent_timestamp    = "2025-06-16T07:55:51Z" -> null
      - state               = "ACTIVE" -> null
      - update_time         = "2025-06-16T07:56:49Z" -> null
      - user_prefix         = "4ER5SbndR000000" -> null
    }

Plan: 0 to add, 0 to change, 1 to destroy.

Do you want to perform these actions?
  Terraform will perform the actions described above.
  Only 'yes' will be accepted to approve.

  Enter a value: yes

tidbcloud_serverless_branch.example: Destroying...
tidbcloud_serverless_branch.example: Destruction complete after 1s

Apply complete! Resources: 0 added, 0 changed, 1 destroyed.

ここで、 terraform showコマンドを実行すると、リソースがクリアされているため、管理対象リソースは表示されません。

$ terraform show

tidbcloud_serverless_branchリソースを使用する

前提条件

TiDB Cloud Starter またはTiDB Cloud Essential ブランチを作成する

TiDB Cloud Starter またはTiDB Cloud Essential ブランチをインポートする

TiDB Cloud Starter またはTiDB Cloud Essential ブランチを削除する

このページは役に立ちましたか？

`tidbcloud_serverless_branch`リソースを使用する