Create Cluster
create-clusterProvisions a new dedicated RawTree cluster in an organization with specified replicas and vertical autoscaling, optionally using customer-owned S3 storage.
Instructions
Purpose: Provision a new RawTree dedicated cluster in an organization.
Returns: The newly created cluster, including its ID, lifecycle status, and initial resources. Provisioning continues asynchronously after the request is accepted; use get-cluster to check progress.
Behavior: The cluster starts at minimumSize and can vertically autoscale per replica up to maximumSize. The replica count remains fixed. s3Storage is optional: omit it to use RawTree-managed storage. When provided, it configures customer-owned data and backup destinations through a customer IAM role. Destination paths are optional; the buckets, roleArn, and externalId are required inside s3Storage. databaseS3Access is also optional and independent from s3Storage: provide it when databases may later use dedicated customer-owned buckets, even if the cluster keeps RawTree-managed default storage. It contains the External ID and the immutable database bucket tag; each customer database bucket must carry rawtree.com/cluster=. When both settings are supplied, their External ID values must match. The role ARN and bucket destinations for an individual database are supplied later in create-database.s3Storage.
Auth: The RawTree API requires a user access token with organization admin access. Authorization is enforced by the API.
Safety: You MUST first call list-cluster-sizes, then confirm the exact organization, name, replica count, minimum per-replica size, maximum per-replica size, vertical autoscaling behavior, and idle timeout with the user. If idleTimeoutMinutes is omitted, explain that the server default will apply. For one replica, warn that the cluster has no redundancy. If s3Storage is provided, first call verify-cluster-s3-access with the identical configuration and confirm the data and backup buckets, optional paths, role ARN, and External ID. Never reuse a successful verification after changing any s3Storage field. If databaseS3Access is provided, confirm that its External ID and immutable bucket tag are intentional and that customer database buckets will be tagged as required; this metadata does not verify or create future database buckets.
Reliability: This operation is not idempotent. If the response is ambiguous, call list-clusters to reconcile by organization and name before retrying.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | URL-friendly cluster name using letters, numbers, '_' or '-'. | |
| replicas | Yes | Number of cluster replicas. | |
| s3Storage | No | Optional customer-owned S3 configuration. Omit to use RawTree-managed storage. Verify the identical configuration with verify-cluster-s3-access before creation. | |
| maximumSize | Yes | Maximum vertical autoscaling size returned by list-cluster-sizes. Must be at or above minimumSize in the returned catalog. | |
| minimumSize | Yes | Initial and minimum vertical autoscaling size returned by list-cluster-sizes. | |
| organization | Yes | Organization in which to create the cluster. | |
| databaseS3Access | No | Optional independent per-database S3 capability. It may be supplied without s3Storage. Apply the databaseBucketTag to each customer-owned database bucket; if s3Storage is also supplied, externalId must match. | |
| idleTimeoutMinutes | No | Minutes of inactivity before automatically pausing. Use 0 to disable idling. Omit to use the server default. |