📣
TiDB Cloud Serverless が
Starter
に変わりました！このページは自動翻訳されたものです。
原文はこちらからご覧ください。
TiDB Cloud
TiDB Self-Managed
Learning Center
お問い合わせ

tidbcloud_serverless_clusterリソースを使用する

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

また、 tidbcloud_projectsデータ ソースを使用して必要な情報を取得する方法も学習します。

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

  • TiDB Cloud Starter クラスターを作成します。
  • TiDB Cloud Starter クラスターを変更します。
  • TiDB Cloud Starter クラスターをインポートします。
  • TiDB Cloud Starter クラスターを削除します。

前提条件

tidbcloud_projectsデータソースを使用してプロジェクト ID を取得する

各TiDBクラスタはプロジェクトに属します。TiDB TiDB Cloud Starterクラスタを作成する前に、クラスタを作成するプロジェクトのIDを取得する必要があります。1 project_id指定されていない場合は、デフォルトのプロジェクトが使用されます。

利用可能なすべてのプロジェクトに関する情報を取得するには、次のようにtidbcloud_projectsデータ ソースを使用します。

  1. TiDB Cloud Terraform プロバイダーを入手するで作成したmain.tfファイルに、次のようにdataとoutputブロックを追加します。

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

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

data "tidbcloud_projects" "example_project" {
  page      = 1
  page_size = 10
}

output "projects" {
  value = data.tidbcloud_projects.example_project.items
}

    • dataブロックを使用して、データ ソース タイプやデータ ソース名など、 TiDB Cloudのデータ ソースを定義します。

      • プロジェクト データ ソースを使用するには、データ ソース タイプをtidbcloud_projectsに設定します。
      • データソース名は必要に応じて定義できます。例： "example_project" 。
      • tidbcloud_projectsデータ ソースの場合、 pageおよびpage_size属性を使用して、チェックするプロジェクトの最大数を制限できます。

    • outputブロックを使用して、出力に表示されるデータ ソース情報を定義し、他の Terraform 構成が使用できるように情報を公開します。

      outputブロックはプログラミング言語の戻り値と同様の動作をします。詳細はTerraformドキュメント参照してください。

    リソースとデータ ソースに使用可能なすべての構成を取得するには、 Terraform プロバイダーの構成ドキュメント参照してください。

  2. 設定を適用するには、コマンドterraform applyを実行してください。続行するには、確認プロンプトでyesと入力してください。

    プロンプトをスキップするには、 terraform apply --auto-approve使用します。

    $ terraform apply --auto-approve

Changes to Outputs:
  + projects = [
      + {
          + cluster_count    = 0
          + create_timestamp = "1649154426"
          + id               = "1372813089191000000"
          + name             = "test1"
          + org_id           = "1372813089189000000"
          + user_count       = 1
        },
      + {
          + cluster_count    = 1
          + create_timestamp = "1640602740"
          + id               = "1372813089189000000"
          + name             = "default project"
          + org_id           = "1372813089189000000"
          + user_count       = 1
        },
    ]

You can apply this plan to save these new output values to the Terraform state, without changing any real infrastructure.

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

Outputs:

projects = tolist([
  {
    "cluster_count" = 0
    "create_timestamp" = "1649154426"
    "id" = "1372813089100000000"
    "name" = "test1"
    "org_id" = "1372813089100000000"
    "user_count" = 1
  },
  {
    "cluster_count" = 1
    "create_timestamp" = "1640602740"
    "id" = "1372813089100000001"
    "name" = "default project"
    "org_id" = "1372813089100000000"
    "user_count" = 1
  },
])

これで、出力から利用可能なすべてのプロジェクトを取得できます。必要なプロジェクトIDを1つコピーしてください。

TiDB Cloud Starter クラスターを作成する

tidbcloud_serverless_clusterリソースを使用して、 TiDB Cloud Starter クラスターを作成できます。

  1. クラスターのディレクトリを作成してそこに入ります。

  2. cluster.tfファイルを作成します。

    以下はcluster.tfファイルの例です。

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

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

resource "tidbcloud_serverless_cluster" "example" {
  project_id = "1372813089454000000"
  display_name = "test-tf"
  spending_limit = {
    monthly = 1
  }
  region = {
    name = "regions/aws-us-east-1"
  }
}

    resourceブロックを使用して、リソース タイプ、リソース名、リソースの詳細など、 TiDB Cloudのリソースを定義します。

    • tidbcloud_serverless_clusterリソースを使用するには、リソース タイプをtidbcloud_serverless_clusterに設定します。
    • リソース名は必要に応じて定義できます。例： example 。
    • リソースの詳細については、プロジェクト ID とtidbcloud_serverless_cluster仕様に応じて設定できます。

  3. 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_cluster.example will be created
    + resource "tidbcloud_serverless_cluster" "example" {
        + annotations             = (known after apply)
        + automated_backup_policy = (known after apply)
        + cluster_id              = (known after apply)
        + create_time             = (known after apply)
        + created_by              = (known after apply)
        + display_name            = "test-tf"
        + encryption_config       = (known after apply)
        + endpoints               = (known after apply)
        + labels                  = (known after apply)
        + project_id              = "1372813089454000000"
        + region                  = {
            + cloud_provider = (known after apply)
            + display_name   = (known after apply)
            + name           = "regions/aws-us-east-1"
            + region_id      = (known after apply)
        }
        + spending_limit          = {
            + monthly = 1
        }
        + state                   = (known after apply)
        + update_time             = (known after apply)
        + user_prefix             = (known after apply)
        + version                 = (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後の対応する値が取得されることを示します。

  4. 計画の内容がすべて問題ない場合は、「 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_cluster.example: Creating...
tidbcloud_serverless_cluster.example: Still creating... [10s elapsed]

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

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

    $ terraform state show tidbcloud_serverless_cluster.example

# tidbcloud_serverless_cluster.example:
resource "tidbcloud_serverless_cluster" "example" {
    annotations             = {
        "tidb.cloud/available-features" = "DISABLE_PUBLIC_LB,DELEGATE_USER"
        "tidb.cloud/has-set-password"   = "false"
    }
    automated_backup_policy = {
        retention_days = 14
        start_time     = "07:00"
    }
    cluster_id              = "10145794214536000000"
    create_time             = "2025-06-16T07:04:41Z"
    created_by              = "apikey-S2000000"
    display_name            = "test-tf"
    encryption_config       = {
        enhanced_encryption_enabled = false
    }
    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
        }
    }
    labels                  = {
        "tidb.cloud/organization" = "1372813089187000000"
        "tidb.cloud/project"      = "1372813089454000000"
    }
    project_id              = "1372813089454000000"
    region                  = {
        cloud_provider = "aws"
        display_name   = "N. Virginia (us-east-1)"
        name           = "regions/aws-us-east-1"
        region_id      = "us-east-1"
    }
    spending_limit          = {
        monthly = 1
    }
    state                   = "ACTIVE"
    update_time             = "2025-06-16T07:04:48Z"
    user_prefix             = "KhSDGqQ3P000000"
    version                 = "v7.5.2"
}

TiDB Cloud Starter クラスターを変更する

TiDB Cloud Starterクラスタでは、Terraformを使用してリソースを管理できます。変更可能な引数は次のとおりです。

  • display_name : クラスターの表示名。
  • spending_limit : クラスターの使用制限。
  • endpoints.public.disabled : パブリックエンドポイントを無効にするかどうか。
  • automated_backup_policy.start_time : 自動バックアップが開始される時点の UTC 時刻 ( HH:mm形式)。

TiDB Cloud Starterクラスターを変更するには、 tidbcloud_serverless_clusterのリソースの構成を変更し、 terraform applyコマンドを使用して変更を適用します。例えば、 display_nameとspending_limit次のように変更できます。

resource "tidbcloud_serverless_cluster" "example" {
  project_id = "1372813089454000000"
  display_name = "test-tf-modified"
  spending_limit = {
    monthly = 2
  }
  region = {
    name = "regions/aws-us-east-1"
  }
}

次に、 terraform applyコマンドを実行して変更を適用します。

$ terraform apply

tidbcloud_serverless_cluster.example: Refreshing state...

Terraform used the selected providers to generate the following execution plan. Resource actions are indicated with the following symbols:
  ~ update in-place

Terraform will perform the following actions:

  # tidbcloud_serverless_cluster.example will be updated in-place
  ~ resource "tidbcloud_serverless_cluster" "example" {
      ~ annotations             = {
          - "tidb.cloud/available-features" = "DISABLE_PUBLIC_LB,DELEGATE_USER"
          - "tidb.cloud/has-set-password"   = "false"
        } -> (known after apply)
      ~ display_name            = "test-tf" -> "test-tf-modified"
      ~ labels                  = {
          - "tidb.cloud/organization" = "1372813089187041280"
          - "tidb.cloud/project"      = "1372813089454543324"
        } -> (known after apply)
      ~ spending_limit          = {
          ~ monthly = 1 -> 2
        }
      ~ state                   = "ACTIVE" -> (known after apply)
      ~ update_time             = "2025-06-16T07:04:57Z" -> (known after apply)
      ~ version                 = "v7.5.2" -> (known after apply)
        # (9 unchanged attributes hidden)
    }

Plan: 0 to add, 1 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: yes

tidbcloud_serverless_cluster.example: Modifying...
tidbcloud_serverless_cluster.example: Modifications complete after 8s

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

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

$ terraform state show tidbcloud_serverless_cluster.example
# tidbcloud_serverless_cluster.example:
resource "tidbcloud_serverless_cluster" "example" {
    annotations             = {
        "tidb.cloud/available-features" = "DISABLE_PUBLIC_LB,DELEGATE_USER"
        "tidb.cloud/has-set-password"   = "false"
    }
    automated_backup_policy = {
        retention_days = 14
        start_time     = "07:00"
    }
    cluster_id              = "10145794214536000000"
    create_time             = "2025-06-16T07:04:41Z"
    created_by              = "apikey-S2000000"
    display_name            = "test-tf-modified"
    encryption_config       = {
        enhanced_encryption_enabled = false
    }
    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
        }
    }
    labels                  = {
        "tidb.cloud/organization" = "1372813089187000000"
        "tidb.cloud/project"      = "1372813089454000000"
    }
    project_id              = "1372813089454000000"
    region                  = {
        cloud_provider = "aws"
        display_name   = "N. Virginia (us-east-1)"
        name           = "regions/aws-us-east-1"
        region_id      = "us-east-1"
    }
    spending_limit          = {
        monthly = 2
    }
    state                   = "ACTIVE"
    update_time             = "2025-06-16T07:04:57Z"
    user_prefix             = "KhSDGqQ3P000000"
    version                 = "v7.5.2"
}

TiDB Cloud Starter クラスターをインポートする

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

  1. 新しいtidbcloud_serverless_clusterリソースのインポート ブロックを追加します。

    次のインポート ブロックを.tfファイルに追加し、 example目的のリソース名に置き換え、 ${id}クラスター ID に置き換えます。

    import {
  to = tidbcloud_serverless_cluster.example
  id = "${id}"
}

  2. 新しい構成ファイルを生成します。

    インポート ブロックに従って、新しいtidbcloud_serverless_clusterリソースの新しい構成ファイルを生成します。

    terraform plan -generate-config-out=generated.tf

    上記のコマンドでは、既存の.tf名を指定しないでください。指定した場合、Terraform はエラーを返します。

  3. 生成された構成を確認して適用します。

    生成された構成ファイルを確認し、ニーズを満たしていることを確認してください。必要に応じて、このファイルの内容を任意の場所に移動することもできます。

    次に、 terraform apply実行してインフラストラクチャをインポートします。適用後、出力例は次のようになります。

    tidbcloud_serverless_cluster.example: Importing... 
tidbcloud_serverless_cluster.example: Import complete 

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

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

TiDB Cloud Starter クラスターを削除する

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

$ terraform apply
tidbcloud_serverless_cluster.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_cluster.example will be destroyed
  # (because tidbcloud_serverless_cluster.example is not in configuration)
  - resource "tidbcloud_serverless_cluster" "example" {
      - annotations             = {
          - "tidb.cloud/available-features" = "DISABLE_PUBLIC_LB,DELEGATE_USER"
          - "tidb.cloud/has-set-password"   = "false"
        } -> null
      - automated_backup_policy = {
          - retention_days = 14 -> null
          - start_time     = "07:00" -> null
        } -> null
      - cluster_id              = "10145794214536000000" -> null
      - create_time             = "2025-06-16T07:04:41Z" -> null
      - created_by              = "apikey-S2000000" -> null
      - display_name            = "test-tf-modified" -> null
      - encryption_config       = {
          - enhanced_encryption_enabled = false -> null
        } -> 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
      - labels                  = {
          - "tidb.cloud/organization" = "1372813089187000000"
          - "tidb.cloud/project"      = "1372813089454000000"
        } -> null
      - project_id              = "1372813089454000000" -> null
      - region                  = {
          - cloud_provider = "aws" -> null
          - display_name   = "N. Virginia (us-east-1)" -> null
          - name           = "regions/aws-us-east-1" -> null
          - region_id      = "us-east-1" -> null
        } -> null
      - spending_limit          = {
          - monthly = 2 -> null
        } -> null
      - state                   = "ACTIVE" -> null
      - update_time             = "2025-06-16T07:04:57Z" -> null
      - user_prefix             = "KhSDGqQ3P000000" -> null
      - version                 = "v7.5.2" -> 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_cluster.example: Destroying...
tidbcloud_serverless_cluster.example: Destruction complete after 1s

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

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

$ terraform show

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