singlestoredb.management.workspace.WorkspaceGroup

class singlestoredb.management.workspace.WorkspaceGroup(name: str, id: str, created_at: str | datetime, region: Region | None, firewall_ranges: List[str], terminated_at: str | datetime | None, allow_all_traffic: bool | None, deployment_type: str | None = None, expires_at: str | datetime | None = None, high_availability_two_zones: bool | None = None, opt_in_preview_feature: bool | None = None, outbound_allow_list: str | None = None, project_id: str | None = None, project_name: str | None = None, smart_dr_status: str | None = None, state: str | None = None, update_window: Dict[str, Any] | None = None, provider: str | None = None, region_name: str | None = None)

SingleStoreDB workspace group definition.

Deprecated since version Use: singlestoredb.management.cluster.Cluster. It has no container resource: what this class held – region, firewall ranges, Stage, the workspaces inside it – belongs to the cluster itself, and ClusterManager.create_cluster() replaces the two-step create-group-then-create-workspace dance. Grouping is expressed by a Project instead, which is an organizational unit rather than a deployment parent.

This object is not instantiated directly. It is used in the results of API calls on the WorkspaceManager. Workspace groups are created using WorkspaceManager.create_workspace_group(), or existing workspace groups are accessed by either WorkspaceManager.workspace_groups or by calling WorkspaceManager.get_workspace_group().

See also

WorkspaceManager.create_workspace_group(), WorkspaceManager.get_workspace_group(), WorkspaceManager.workspace_groups

__init__(name: str, id: str, created_at: str | datetime, region: Region | None, firewall_ranges: List[str], terminated_at: str | datetime | None, allow_all_traffic: bool | None, deployment_type: str | None = None, expires_at: str | datetime | None = None, high_availability_two_zones: bool | None = None, opt_in_preview_feature: bool | None = None, outbound_allow_list: str | None = None, project_id: str | None = None, project_name: str | None = None, smart_dr_status: str | None = None, state: str | None = None, update_window: Dict[str, Any] | None = None, provider: str | None = None, region_name: str | None = None)

Methods

__init__(name, id, created_at, region, ...)
create_workspace(name[, size, auto_suspend, ...])	Create a new workspace.
from_dict(obj, manager)	Construct a WorkspaceGroup from a dictionary of values.
refresh()	Update the object to the current state.
terminate([force, wait_on_terminated, ...])	Terminate the workspace group.
update([name, firewall_ranges, ...])	Update the workspace group definition.

Attributes

organization
stage	Stage manager.
stages	Stage manager.
workspaces	Return a list of available workspaces.
name	Name of the workspace group
id	Unique ID of the workspace group
created_at	Timestamp of when the workspace group was created
region	Region of the workspace group (see Region)
firewall_ranges	List of allowed incoming IP addresses / ranges
terminated_at	Timestamp of when the workspace group was terminated
allow_all_traffic	Should all traffic be allowed?
deployment_type	Deployment type of the workspace group (PRODUCTION | NON-PRODUCTION)
expires_at	Timestamp of when the workspace group will expire
high_availability_two_zones	Whether high availability across two zones is enabled
opt_in_preview_feature	Whether preview features are opted in
outbound_allow_list	Account ID for outbound connections
project_id	Project ID associated with the workspace group
project_name	Project name associated with the workspace group
smart_dr_status	SmartDR status of the workspace group (ACTIVE | STANDBY)
state	State of the workspace group (ACTIVE | PENDING | FAILED | TERMINATED)
update_window	dict(day=0-6, hour=0-23)
provider	Cloud provider as returned by the API (raw)
region_name	Cloud provider region name as returned by the API (raw)