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

yandex_ytsaurus_cluster (Data Source)

Written by
Updated at September 11, 2025

Example usage

//
// Get information about existing YTsaurus cluster.
//
data "yandex_ytsaurus_cluster" "my_cluster" {
  cluster_id = "some_cluster_id"
}

Schema

Optional

  • cluster_id (String) ID of the cluster to return.
  • folder_id (String) ID of the folder that the cluster belongs to.
  • id (String) ID of the cluster to return.
  • 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.
  • description (String) Description of the cluster.
  • endpoints (Attributes) Endpoints of the cluster. (see below for nested schema)
  • health (String) Health of the cluster.
  • 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)
  • status (String) Status of the cluster.
  • subnet_id (String) ID of the subnet where the cluster resides.
  • updated_at (String) Time when the cluster was last updated.
  • updated_by (String) User who last updated the cluster.
  • zone_id (String) ID of the availability zone where the cluster resides.

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

Nested Schema for spec

Read-Only:

  • 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

Read-Only:

  • 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

Read-Only:

  • 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

Read-Only:

  • 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

Read-Only:

  • 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

Read-Only:

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

Nested Schema for spec.odin

Read-Only:

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

Nested Schema for spec.proxy

Read-Only:

  • 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

Read-Only:

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

Nested Schema for spec.proxy.rpc

Read-Only:

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

Nested Schema for spec.storage

Read-Only:

  • 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

Read-Only:

  • 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

Read-Only:

  • 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

Read-Only:

  • 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
Previous
ydb_topic
Next
ytsaurus_cluster