Important
New database features are no longer connected to engine versions; features are now enabled independently during scheduled update windows, and “major” and “minor” releases no longer exist in Helios. Please visit the release notes to view the latest features available in your database clusters.
CREATE WORKSPACE GROUP
On this page
The CREATE WORKSPACE GROUP command creates a new cluster group.
Syntax
CREATE WORKSPACE GROUP [ IF NOT EXISTS ] '<group_name>'
IN REGION { ID '<region_ID>' | '<region_name>' }
[ WITH PASSWORD '<password>' ]
[ EXPIRES AT '<expiry_time>' ]
[ WITH FIREWALL RANGES '<ip_range>',... ]
[ WITH BACKUP BUCKET KMS KEY ID '<backup_key_ID>' ]
[ WITH DATA BUCKET KMS KEY ID '<data_key_ID>' ]
[ WITH SMART DR ]
[ ALLOW ALL TRAFFIC ]
[ WITH UPDATE WINDOW '<day>:<hour>' ]Arguments
-
group_: Name of the cluster group.name -
region_,ID region_: The ID or name of the region in which the cluster group is created.name -
password: The admin password for the cluster group.The password must contain the following: -
At least 8 characters
-
At least one uppercase character
-
At least one lowercase character
-
At least one number or special character
-
-
expiry_: The timestamp or the time interval at which the cluster group automatically expires (terminates).time -
ip_: A list of allowed IP addresses or CIDR block.range -
backup_: The KMS key ID associated with the backup bucket.key_ ID -
data_: The KMS key ID associated with the data bucket.key_ ID -
day:hour: The day of the week (0-6 starting on a Sunday) and the hours of the day (0-23 UTC) when the updates are applied to the cluster group.
Remarks
-
Specify the
IF NOT EXISTSclause to create a new cluster group only when a cluster group with the specified name does not exist already.If a cluster group with the specified name already exists and the IF NOT EXISTSclause is not specified, theCREATE WORKSPACE GROUPcommand returns an error. -
If the
WITH BACKUP BUCKET KMS KEY IDclause is specified, it enables Customer-Managed Encryption Keys (CMEK) encryption for the backup bucket of the cluster group.This feature is only supported in cluster groups deployed in AWS. -
If the
WITH DATA BUCKET KMS KEY IDclause is specified, it enables Customer-Managed Encryption Keys (CMEK) encryption for the data bucket and Amazon Elastic Block Store (EBS) volumes of the cluster group.This feature is only supported in cluster groups deployed in AWS. -
Specify the
WITH SMART DRclause to enable Smart Disaster Recovery (DR): SmartDR for the cluster group. -
Specify the
ALLOW ALL TRAFFICclause to allow access to the cluster group from any IP address.
Examples
-
The following command creates a cluster group in the specified region:
CREATE WORKSPACE GROUP 's2-group' IN REGION 'US East 2 (Ohio)'; -
The following command creates a cluster group with additional configurations:
CREATE WORKSPACE GROUP IF NOT EXISTS 's2-group'IN REGION ID '93b61160-0000-1000-9000-977b8e2e3ee5'WITH FIREWALL RANGES '0.0.0.0/0'WITH SMART DR;
Last modified: