singlestoredb.management.workspace.WorkspaceManager.create_workspace_group

WorkspaceManager.create_workspace_group(name: str, region: str | Region, firewall_ranges: List[str], admin_password: str | None = None, backup_bucket_kms_key_id: str | None = None, data_bucket_kms_key_id: str | None = None, expires_at: str | None = None, smart_dr: bool | None = None, allow_all_traffic: bool | None = None, update_window: Dict[str, int] | None = None) → WorkspaceGroup

Create a new workspace group.

Parameters:

  • name (str) – Name of the workspace group

  • region (str or Region) – ID of the region where the workspace group should be created

  • firewall_ranges (list[str]) – List of allowed CIDR ranges. An empty list indicates that all inbound requests are allowed.

  • admin_password (str, optional) – Admin password for the workspace group. If no password is supplied, a password will be generated and retured in the response.

  • backup_bucket_kms_key_id (str, optional) – Specifies the KMS key ID associated with the backup bucket. If specified, enables Customer-Managed Encryption Keys (CMEK) encryption for the backup bucket of the workspace group. This feature is only supported in workspace groups deployed in AWS.

  • data_bucket_kms_key_id (str, optional) – Specifies the KMS key ID associated with the data bucket. If specified, enables Customer-Managed Encryption Keys (CMEK) encryption for the data bucket and Amazon Elastic Block Store (EBS) volumes of the workspace group. This feature is only supported in workspace groups deployed in AWS.

  • expires_at (str, optional) – The timestamp of when the workspace group will expire. If the expiration time is not specified, the workspace group will have no expiration time. At expiration, the workspace group is terminated and all the data is lost. Expiration time can be specified as a timestamp or duration. Example: “2021-01-02T15:04:05Z07:00”, “2021-01-02”, “3h30m”

  • smart_dr (bool, optional) – Enables Smart Disaster Recovery (SmartDR) for the workspace group. SmartDR is a disaster recovery solution that ensures seamless and continuous replication of data from the primary region to a secondary region

  • allow_all_traffic (bool, optional) – Allow all traffic to the workspace group

  • update_window (Dict[str, int], optional) – Specify the day and hour of an update window: dict(day=0-6, hour=0-23)

Return type:

WorkspaceGroup