Resource naming conventions

Naming rules for e6data workspaces, clusters, and catalogs - allowed characters, length limits, and how names are normalized.

These rules govern the names you can give e6data resources, whether you create them in the Console or through the Management API.

Workspace

Length: 1–18 characters.
Allowed: lowercase letters (a–z), digits (0–9), and hyphens (-).
Must start and end with a letter or digit - no leading or trailing hyphen.
Not allowed: uppercase letters, underscores, dots, or other special characters.

Valid

Invalid

my-workspace, prod-1, dev

My-WS (uppercase), my_ws (underscore), -prod (leading hyphen), prod.v1 (dot)

Cluster

Length: 3–30 characters.
Allowed: letters (upper or lower case), digits (0–9), and hyphens (-).
Must start with a letter and end with a letter or digit.
Case-sensitive: Prod-1 and prod-1 are different names.
Not allowed: underscores, dots, or other special characters.
The cluster name is the routing key in every connection and cannot be changed after creation.

Valid

Invalid

my-cluster, Prod-QS-1, qs123

qs (too short), my_cluster (underscore), my.cluster (dot)

Catalog

Length: 1–253 characters.
Allowed: the display name is permissive - mixed case, letters, digits, hyphens, and dots.
Normalized internally: e6data stores a normalized version of the name alongside the display name. Underscores, spaces, and other non-allowed characters become hyphens; the name is lowercased; consecutive hyphens collapse to one; and leading or trailing hyphens are trimmed. Dots are preserved in both names.

Display name

Stored as

My_Catalog

my-catalog

My Glue Catalog

my-glue-catalog

PROD_CATALOG

prod-catalog

catalog.v1

Quick reference

Resource

Length

Uppercase

Digits

Hyphen -

Underscore _

Dot .

Workspace

1–18

❌

✅

✅ (not first or last)

❌

Cluster

3–30

✅

✅ (not first or last)

❌

Catalog

1–253

✅

Converted to -

✅

General guidelines

Names can't contain spaces, except catalog names, where spaces are converted to hyphens in the normalized name.
Names are case-sensitive where mixed case is allowed (clusters and catalogs).
Reserved system prefixes can't be used in names you provide.
For the broadest compatibility, prefer lowercase letters and hyphens wherever a resource allows it.