yandex_ytsaurus_cluster (Data Source)
Written by
Updated at December 12, 2025
- Example usage
- Schema
- Optional
- Read-Only
- Nested Schema for timeouts
- Nested Schema for cidr_blocks_whitelist
- Nested Schema for endpoints
- Nested Schema for spec
- Nested Schema for spec.client_logging
- Nested Schema for spec.compute
- Nested Schema for spec.compute.disks
- Nested Schema for spec.compute.scale_policy
- Nested Schema for spec.compute.scale_policy.auto
- Nested Schema for spec.compute.scale_policy.fixed
- Nested Schema for spec.cron
- Nested Schema for spec.cron.clear_tmp
- Nested Schema for spec.odin
- Nested Schema for spec.proxy
- Nested Schema for spec.proxy.http
- Nested Schema for spec.proxy.rpc
- Nested Schema for spec.storage
- Nested Schema for spec.storage.hdd
- Nested Schema for spec.storage.ssd
- Nested Schema for spec.tablet
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
cidr_blocks_whitelist(Attributes) CIDRs whitelist. (see below for nested schema)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 askey:valuepairs.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 cidr_blocks_whitelist
Read-Only:
v4_cidr_blocks(List of String) IPv4 CIDR blocks.
Nested Schema for endpoints
Read-Only:
external_http_proxy_balancer(String) package: yandex.cloud.ytsaurus.v1
filename: yandex/cloud/ytsaurus/v1/cluster.protointernal_http_proxy_alias(String) package: yandex.cloud.ytsaurus.v1
filename: yandex/cloud/ytsaurus/v1/cluster.protointernal_rpc_proxy_alias(String) package: yandex.cloud.ytsaurus.v1
filename: yandex/cloud/ytsaurus/v1/cluster.protoui(String) package: yandex.cloud.ytsaurus.v1
filename: yandex/cloud/ytsaurus/v1/cluster.proto
Nested Schema for spec
Read-Only:
client_logging(Attributes) Client Cloud logging configuration. (see below for nested schema)compute(Attributes List) package: yandex.cloud.ytsaurus.v1
filename: yandex/cloud/ytsaurus/v1/cluster.proto (see below for nested schema)cron(Attributes) Cluster regular processing settings. (see below for nested schema)flavor(String) package: yandex.cloud.ytsaurus.v1
filename: yandex/cloud/ytsaurus/v1/cluster.protoodin(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.client_logging
Optional:
folder_id(String) ID of cloud logging folder. Used default loging group.service_account_id(String) ID of Service account used for write logs.
Read-Only:
audit_logs_enabled(Boolean) Enable audit logs.log_group_id(String) ID of cloud logging group.
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.protoscale_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) package: yandex.cloud.ytsaurus.v1
filename: yandex/cloud/ytsaurus/v1/cluster.protosize_gb(Number) package: yandex.cloud.ytsaurus.v1
filename: yandex/cloud/ytsaurus/v1/cluster.prototype(String) package: yandex.cloud.ytsaurus.v1
filename: yandex/cloud/ytsaurus/v1/cluster.proto
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.protomin_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) package: yandex.cloud.ytsaurus.v1
filename: yandex/cloud/ytsaurus/v1/cluster.proto
Nested Schema for spec.cron
Read-Only:
clear_tmp(Attributes) Cluster regular tmp-account cleaning settings. (see below for nested schema)
Nested Schema for spec.cron.clear_tmp
Read-Only:
account_usage_ratio_save_per_owner(Number) Per account max space usage ratio.account_usage_ratio_save_total(Number) Total max space usage ratio.interval(String) Script starting interval.max_dir_node_count(Number) Max nodes in every directory.
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) package: yandex.cloud.ytsaurus.v1
filename: yandex/cloud/ytsaurus/v1/cluster.protosize_gb(Number) package: yandex.cloud.ytsaurus.v1
filename: yandex/cloud/ytsaurus/v1/cluster.proto
Nested Schema for spec.storage.ssd
Read-Only:
count(Number) package: yandex.cloud.ytsaurus.v1
filename: yandex/cloud/ytsaurus/v1/cluster.protosize_gb(Number) package: yandex.cloud.ytsaurus.v1
filename: yandex/cloud/ytsaurus/v1/cluster.prototype(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.protopreset(String) package: yandex.cloud.ytsaurus.v1
filename: yandex/cloud/ytsaurus/v1/cluster.proto