Contact UsGet started
© 2025 Direct Cursus Technology L.L.C.

yandex_ytsaurus_cluster (Resource)

Written by
Updated at September 11, 2025

Example usage

//
// Create a new YTsaurus cluster
//
resource "yandex_ytsaurus_cluster" "my_cluster" {
  name = "my-cluster"
  description = "my_cluster description"

  zone_id			 = "ru-central1-a"
  subnet_id			 = "my_subnet_id"
  security_group_ids = ["my_security_group_id"]

  spec = {
	storage = {
	  hdd = {
	  	size_gb = 100
		count 	= 3
	  }

	  ssd = {
	  	size_gb = 100
		type 	= "network-ssd"
		count 	= 3
	  }
	}

	compute = [{
	  preset = "c8-m32"
	  disks = [{
	  	type 	= "network-ssd"
		size_gb = 50
	  }]
	  scale_policy = {
	  	fixed = {
		  size = 3
		}
	  }
	}]

	tablet = {
      preset = "c8-m16"
	  count = 3
	}

	proxy = {
	  http = {
	  	count = 1
	  }
      
	  rpc = {
	  	count = 1
	  }
	}
  }
}

Schema

Required

  • subnet_id (String) ID of the subnet where the cluster resides.
  • zone_id (String) ID of the availability zone where the cluster resides.

Optional

  • cluster_id (String) ID of the cluster to return.
  • description (String) Description of the cluster.
  • folder_id (String) ID of the folder that the cluster belongs to.
  • id (String) ID of the cluster to return.
  • labels (Map of String) Cluster labels as key:value pairs.
  • name (String) Name of the cluster.
    The name is unique within the folder.
  • security_group_ids (List of String) Network interfaces security groups.
  • spec (Attributes) Cluster specification. (see below for nested schema)
  • timeouts (Attributes) (see below for nested schema)

Read-Only

  • created_at (String) Time when the cluster was created.
  • created_by (String) User who created the cluster.
  • endpoints (Attributes) Endpoints of the cluster. (see below for nested schema)
  • health (String) Health of the cluster.
  • status (String) Status of the cluster.
  • updated_at (String) Time when the cluster was last updated.
  • updated_by (String) User who last updated the cluster.

Nested Schema for spec

Optional:

  • compute (Attributes List) package: yandex.cloud.ytsaurus.v1
    filename: yandex/cloud/ytsaurus/v1/cluster.proto (see below for nested schema)
  • odin (Attributes) package: yandex.cloud.ytsaurus.v1
    filename: yandex/cloud/ytsaurus/v1/cluster.proto (see below for nested schema)
  • proxy (Attributes) package: yandex.cloud.ytsaurus.v1
    filename: yandex/cloud/ytsaurus/v1/cluster.proto (see below for nested schema)
  • storage (Attributes) package: yandex.cloud.ytsaurus.v1
    filename: yandex/cloud/ytsaurus/v1/cluster.proto (see below for nested schema)
  • tablet (Attributes) package: yandex.cloud.ytsaurus.v1
    filename: yandex/cloud/ytsaurus/v1/cluster.proto (see below for nested schema)

Nested Schema for spec.compute

Optional:

  • disks (Attributes List) package: yandex.cloud.ytsaurus.v1
    filename: yandex/cloud/ytsaurus/v1/cluster.proto (see below for nested schema)
  • name (String) Name for exec pool.
  • preset (String) package: yandex.cloud.ytsaurus.v1
    filename: yandex/cloud/ytsaurus/v1/cluster.proto
  • scale_policy (Attributes) package: yandex.cloud.ytsaurus.v1
    filename: yandex/cloud/ytsaurus/v1/cluster.proto (see below for nested schema)

Nested Schema for spec.compute.disks

Optional:

  • locations (List of String) ID of the availability zone where the cluster resides.
  • size_gb (Number) ID of the folder that the cluster belongs to.
  • type (String) ID of the cluster. Generated at creation time.

Nested Schema for spec.compute.scale_policy

Optional:

  • auto (Attributes) package: yandex.cloud.ytsaurus.v1
    filename: yandex/cloud/ytsaurus/v1/cluster.proto (see below for nested schema)
  • fixed (Attributes) package: yandex.cloud.ytsaurus.v1
    filename: yandex/cloud/ytsaurus/v1/cluster.proto (see below for nested schema)

Nested Schema for spec.compute.scale_policy.auto

Optional:

  • max_size (Number) package: yandex.cloud.ytsaurus.v1
    filename: yandex/cloud/ytsaurus/v1/cluster.proto
  • min_size (Number) package: yandex.cloud.ytsaurus.v1
    filename: yandex/cloud/ytsaurus/v1/cluster.proto

Nested Schema for spec.compute.scale_policy.fixed

Optional:

  • size (Number) ID of the cluster. Generated at creation time.

Nested Schema for spec.odin

Optional:

  • checks_ttl (String) package: yandex.cloud.ytsaurus.v1
    filename: yandex/cloud/ytsaurus/v1/cluster.proto

Nested Schema for spec.proxy

Optional:

  • http (Attributes) package: yandex.cloud.ytsaurus.v1
    filename: yandex/cloud/ytsaurus/v1/cluster.proto (see below for nested schema)
  • rpc (Attributes) package: yandex.cloud.ytsaurus.v1
    filename: yandex/cloud/ytsaurus/v1/cluster.proto (see below for nested schema)

Nested Schema for spec.proxy.http

Optional:

  • count (Number) package: yandex.cloud.ytsaurus.v1
    filename: yandex/cloud/ytsaurus/v1/cluster.proto

Nested Schema for spec.proxy.rpc

Optional:

  • count (Number) package: yandex.cloud.ytsaurus.v1
    filename: yandex/cloud/ytsaurus/v1/cluster.proto

Nested Schema for spec.storage

Optional:

  • hdd (Attributes) package: yandex.cloud.ytsaurus.v1
    filename: yandex/cloud/ytsaurus/v1/cluster.proto (see below for nested schema)
  • ssd (Attributes) package: yandex.cloud.ytsaurus.v1
    filename: yandex/cloud/ytsaurus/v1/cluster.proto (see below for nested schema)

Nested Schema for spec.storage.hdd

Optional:

  • count (Number) ID of the folder that the cluster belongs to.
  • size_gb (Number) ID of the cluster. Generated at creation time.

Nested Schema for spec.storage.ssd

Optional:

  • count (Number) package: yandex.cloud.ytsaurus.v1
    filename: yandex/cloud/ytsaurus/v1/cluster.proto
  • size_gb (Number) package: yandex.cloud.ytsaurus.v1
    filename: yandex/cloud/ytsaurus/v1/cluster.proto
  • type (String) package: yandex.cloud.ytsaurus.v1
    filename: yandex/cloud/ytsaurus/v1/cluster.proto

Nested Schema for spec.tablet

Optional:

  • count (Number) package: yandex.cloud.ytsaurus.v1
    filename: yandex/cloud/ytsaurus/v1/cluster.proto
  • preset (String) package: yandex.cloud.ytsaurus.v1
    filename: yandex/cloud/ytsaurus/v1/cluster.proto

Nested Schema for timeouts

Optional:

  • create (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
  • delete (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
  • read (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
  • update (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

Nested Schema for endpoints

Read-Only:

  • external_http_proxy_balancer (String) package: yandex.cloud.ytsaurus.v1
    filename: yandex/cloud/ytsaurus/v1/cluster.proto
  • internal_http_proxy_alias (String) package: yandex.cloud.ytsaurus.v1
    filename: yandex/cloud/ytsaurus/v1/cluster.proto
  • internal_rpc_proxy_alias (String) package: yandex.cloud.ytsaurus.v1
    filename: yandex/cloud/ytsaurus/v1/cluster.proto
  • ui (String) package: yandex.cloud.ytsaurus.v1
    filename: yandex/cloud/ytsaurus/v1/cluster.proto

Import

The resource can be imported by using their resource ID. For getting the resource ID you can use Yandex Cloud Web Console or YC CLI.

terraform import yandex_ytsaurus_cluster.my_cluster some_cluster_id
Previous
ytsaurus_cluster
Next
message_queue