Cluster

Creates a cluster within an instance. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

Properties

Link copied to clipboard

Configuration for this cluster.

Link copied to clipboard
val clusterId: Output<String>

Required. The ID to be used when referring to the new cluster within its instance, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster.

Link copied to clipboard

Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.

Link copied to clipboard

Immutable. The encryption configuration for CMEK-protected clusters.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val instanceId: Output<String>
Link copied to clipboard
val location: Output<String>

Immutable. The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form projects/{project}/locations/{zone}.

Link copied to clipboard
val name: Output<String>

The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/a-z*.

Link copied to clipboard
val project: Output<String>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val serveNodes: Output<Int>

The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.

Link copied to clipboard
val state: Output<String>

The current state of the cluster.

Link copied to clipboard
val urn: Output<String>