Module cluster (2.16.0)

User friendly container for Google Cloud Bigtable Cluster.

Classes

Cluster

Cluster(
    cluster_id,
    instance,
    location_id=None,
    serve_nodes=None,
    default_storage_type=None,
    kms_key_name=None,
    _state=None,
    min_serve_nodes=None,
    max_serve_nodes=None,
    cpu_utilization_percent=None,
)

Representation of a Google Cloud Bigtable Cluster.

We can use a Cluster to:

reload itself
create itself
update itself
delete itself
disable_autoscaling itself

Parameters

Name	Description
`cluster_id`	`str` The ID of the cluster.
`instance`	`Instance` The instance where the cluster resides.
`location_id`	`str` (Creation Only) The location where this cluster's nodes and storage reside . For best performance, clients should be located as close as possible to this cluster. For list of supported locations refer to https://cloud.google.com/bigtable/docs/locations
`serve_nodes`	`int` (Optional) The number of nodes in the cluster for manual scaling. If any of the autoscaling configuration are specified, then the autoscaling configuration will take precedent.
`default_storage_type`	`int` (Optional) The type of storage Possible values are represented by the following constants: :data:`google.cloud.bigtable.enums.StorageType.SSD`. :data:`google.cloud.bigtable.enums.StorageType.HDD`, Defaults to :data:`google.cloud.bigtable.enums.StorageType.UNSPECIFIED`.
`kms_key_name`	`str` (Optional, Creation Only) The name of the KMS customer managed encryption key (CMEK) to use for at-rest encryption of data in this cluster. If omitted, Google's default encryption will be used. If specified, the requirements for this key are: 1) The Cloud Bigtable service account associated with the project that contains the cluster must be granted the `cloudkms.cryptoKeyEncrypterDecrypter` role on the CMEK. 2) Only regional keys can be used and the region of the CMEK key must match the region of the cluster. 3) All clusters within an instance must use the same CMEK key.
`_state`	`int` (`OutputOnly`) The current state of the cluster. Possible values are represented by the following constants: :data:`google.cloud.bigtable.enums.Cluster.State.NOT_KNOWN`. :data:`google.cloud.bigtable.enums.Cluster.State.READY`. :data:`google.cloud.bigtable.enums.Cluster.State.CREATING`. :data:`google.cloud.bigtable.enums.Cluster.State.RESIZING`. :data:`google.cloud.bigtable.enums.Cluster.State.DISABLED`.
`min_serve_nodes`	`int` (Optional) The minimum number of nodes to be set in the cluster for autoscaling. Must be 1 or greater. If specified, this configuration takes precedence over `serve_nodes`. If specified, then `max_serve_nodes` and `cpu_utilization_percent` must be specified too.
`max_serve_nodes`	`int` (Optional) The maximum number of nodes to be set in the cluster for autoscaling. If specified, this configuration takes precedence over `serve_nodes`. If specified, then `min_serve_nodes` and `cpu_utilization_percent` must be specified too.