ClusterForUpdate Class

Represents a cluster for update.

Variables are only populated by the server, and will be ignored when sending a request.

Constructor

ClusterForUpdate(*, tags: Dict[str, str] | None = None, administrator_login_password: str | None = None, postgresql_version: str | None = None, citus_version: str | None = None, enable_shards_on_coordinator: bool | None = None, enable_ha: bool | None = None, preferred_primary_zone: str | None = None, coordinator_server_edition: str | None = None, coordinator_storage_quota_in_mb: int | None = None, coordinator_v_cores: int | None = None, coordinator_enable_public_ip_access: bool | None = None, node_server_edition: str | None = None, node_count: int | None = None, node_storage_quota_in_mb: int | None = None, node_v_cores: int | None = None, maintenance_window: _models.MaintenanceWindow | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
tags	dict[str, str] Application-specific metadata in the form of key-value pairs. Default value: None
administrator_login_password	str The password of the administrator login. Each cluster is created with pre-defined administrative role called 'citus'. Default value: None
postgresql_version	str The major PostgreSQL version on all cluster servers. Default value: None
citus_version	str The Citus extension version on all cluster servers. Default value: None
enable_shards_on_coordinator	bool If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed. Default value: None
enable_ha	bool If high availability (HA) is enabled or not for the cluster. Default value: None
preferred_primary_zone	str Preferred primary availability zone (AZ) for all cluster servers. Default value: None
coordinator_server_edition	str The edition of the coordinator (default: GeneralPurpose). Default value: None
coordinator_storage_quota_in_mb	int The storage of the coordinator in MB. Default value: None
coordinator_v_cores	int The vCores count of the coordinator (max: 96). Default value: None
coordinator_enable_public_ip_access	bool If public access is enabled on coordinator. Default value: None
node_server_edition	str The edition of a node (default: MemoryOptimized). Default value: None
node_count	int Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Default value: None
node_storage_quota_in_mb	int The storage in MB on each worker node. Default value: None
node_v_cores	int The compute in vCores on each worker node (max: 104). Default value: None
maintenance_window	MaintenanceWindow Maintenance window of a cluster. Default value: None

Variables

Name	Description
tags	dict[str, str] Application-specific metadata in the form of key-value pairs.
administrator_login_password	str The password of the administrator login. Each cluster is created with pre-defined administrative role called 'citus'.
postgresql_version	str The major PostgreSQL version on all cluster servers.
citus_version	str The Citus extension version on all cluster servers.
enable_shards_on_coordinator	bool If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed.
enable_ha	bool If high availability (HA) is enabled or not for the cluster.
preferred_primary_zone	str Preferred primary availability zone (AZ) for all cluster servers.
coordinator_server_edition	str The edition of the coordinator (default: GeneralPurpose).
coordinator_storage_quota_in_mb	int The storage of the coordinator in MB.
coordinator_v_cores	int The vCores count of the coordinator (max: 96).
coordinator_enable_public_ip_access	bool If public access is enabled on coordinator.
node_server_edition	str The edition of a node (default: MemoryOptimized).
node_count	int Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1.
node_storage_quota_in_mb	int The storage in MB on each worker node.
node_v_cores	int The compute in vCores on each worker node (max: 104).
node_enable_public_ip_access	bool If public access is enabled on worker nodes.
maintenance_window	MaintenanceWindow Maintenance window of a cluster.