ClickHouse Managed Postgres Terraform リファレンス

ClickHouse Managed Postgres サービスは、ClickHouse Terraform プロバイダーの clickhouse_postgres_service リソースを使用して作成および管理できます。このページでは、このリソースと補助的なデータソースについて、プロバイダーの設定と設定例を説明します。

ClickHouse プロバイダーを Terraform の設定に追加します。

terraform {
  required_providers {
    clickhouse = {
      source  = "ClickHouse/clickhouse"
      version = ">= 3.21.0"
    }
  }
}

provider "clickhouse" {
  organization_id = var.organization_id
  token_key       = var.token_key
  token_secret    = var.token_secret
}

プロバイダーで使用するための API キーを作成する手順については、API キーの管理 を参照してください。

clickhouse_postgres_service リソースでは、以下の引数を使用できます。

以下の属性は読み取り専用で、作成後に ClickHouse Cloud によって設定されます: id、state、created_at、is_primary、hostname、port、および username。connection_string 属性はありません。接続 URI は、たとえば postgres://${username}:${password}@${hostname}:${port}/postgres?sslmode=require のように、hostname、port、username、および宣言したパスワードから構築してください。

resource "clickhouse_postgres_service" "example" {
  name           = "my-postgres"
  cloud_provider = "aws"
  region         = "us-east-1"
  size           = "m6gd.large"
  password       = var.postgres_password

  # High-availability mode — number of standby replicas:
  #   "none"  – primary only, no standby (default)
  #   "async" – 1 standby, asynchronous replication
  #   "sync"  – 2 standbys, synchronous replication
  ha_type = "async"

  tags = {
    environment = "production"
    team        = "data"
  }
}

標準のサービスでは、password または password_wo を宣言する必要があります。値は 12 文字以上で、少なくとも小文字 1 文字、大文字 1 文字、数字 1 文字を含める必要があります。password_wo (password_wo_version と併用) は同じパスワード規則を適用しますが、state には保存されません。ローテーションするには、password_wo_version を変更してください。API は認証情報を返さないため、Terraform がパスワードを書き込む唯一の手段であり続ける必要があります。Terraform の外部 (コンソールまたは API) でローテーションされたパスワードは検出されず、次回 Terraform によって実行されるローテーションで、宣言された値があらためて適用されます。

ha_type 引数は、スタンバイ レプリカの数を制御します。

ha_type は作成後も変更可能で、変更すると HA の切り替えが発生します。詳しくは 高可用性 を参照してください。

ストリーミング読み取りレプリカを作成するには、read_replica_of にプライマリサービスの id を設定します。レプリカはプライマリの cloud_provider、region、postgres_version、およびスーパーユーザーを継承するため、これら (および password) は指定しないでください。

resource "clickhouse_postgres_service" "replica" {
  name            = "my-postgres-replica"
  size            = "m6gd.large"
  read_replica_of = clickhouse_postgres_service.example.id
}

詳細は、読み取りレプリカを参照してください。

別のサービスのバックアップを特定時点に復元してサービスを作成するには、restore_to_point_in_time を設定します。cloud_provider、region、postgres_version は元のサービスから引き継がれるため指定不要です。size と ha_type も指定できません:

resource "clickhouse_postgres_service" "restored" {
  name = "my-postgres-restored"

  restore_to_point_in_time = {
    source_id      = clickhouse_postgres_service.example.id
    restore_target = "2026-06-01T12:00:00Z"
  }
}

このブロック全体は作成時にのみ指定できます。source_id または restore_target を変更するか、ブロックを削除すると、サービスは削除されて再作成されます。詳しくは バックアップと復元 を参照してください。

既存のサービスを参照できる補助的なデータソースが3つあります:

# A single service by ID.
data "clickhouse_postgres_service" "example" {
  id = clickhouse_postgres_service.example.id
}

# All ClickHouse Managed Postgres services in the organization.
data "clickhouse_postgres_services" "all" {}

# The CA certificates for a service, for TLS connections.
data "clickhouse_postgres_service_ca_certificates" "certs" {
  service_id = clickhouse_postgres_service.example.id
}

既存の ClickHouse Managed Postgres サービスは、service ID を使って Terraform state にインポートできます。

terraform import clickhouse_postgres_service.example xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

インポート時にはパスワードは復元されません。これは、API がその値を返さないためです。インポート後、最初の apply で、サービスのパスワードは設定で宣言した password または password_wo に切り替えられます。

以下の項目は、リソース スキーマに意図的に含まれていません。

• 運用コマンド (restart、promote、switchover) 。
• IP許可リスト、プライベート エンドポイント、バックアップ設定、メンテナンス ウィンドウ、顧客管理暗号化キー、BYOC。
• ライフサイクル タイムアウトは設定できません。timeouts {} ブロックはありません。