dcloud rds instances createCreate a database instance
Synopsis
dcloud rds instances create --identifier identifier --instance-class instanceClass [flags]Flags
--region-idOptionalstring
Region to create in (default: the X-EWS-Region header, else de1). fi1 (Helsinki, Finland) needs the organization setting "allow EU outside Germany".
Constraints: 1-32 chars
--identifierRequiredstring
Name of the database, unique within the organization
Constraints: 3-48 chars, /^[a-z][a-z0-9-]*[a-z0-9]$/
--instance-classRequiredstring
Instance type of every node, from server-types (e.g. performance-2; the provider’s own names are still accepted, deprecated); a cluster needs one with at least 8 GiB of memory
Constraints: 1-32 chars
--engine-versionOptionalstring
PostgreSQL major (e.g. 17, installed at its current pinned minor) or one of its pinned minors (e.g. 17.11); omitted: PostgreSQL 17
Constraints: max 16 chars, /^(18|17|16|15|18\.7|17\.12|17\.11|16\.16|15\.20)$/
--topologyOptionalenum
single: one node (the default); cluster: three nodes with automatic failover
One of:
single,clusterDefault:
"single"--db-nameOptionalstring
Name of the database created inside the server; appdb when omitted
Constraints: 1-63 chars, /^[a-z][a-z0-9_]*$/
Default:
"appdb"--master-usernameOptionalstring
Name of the master role, whose password is filed in Secrets; admin when omitted
Constraints: 1-63 chars, /^[a-z][a-z0-9_]*$/
Default:
"admin"--allocated-storage-gibOptionalnumber
Size of each node's data volume in GiB; 20 when omitted
Constraints: integer, 10-4000
Default:
20--max-allocated-storage-gibOptionalnumber
Autoscaling ceiling in GiB, not below allocatedStorageGib; null or omitted leaves automatic growth off
Constraints: integer, 10-10000
May be null.
--backup-retention-daysOptionalnumber
Days backups are kept for restores; 0 turns scheduled backups off; 7 when omitted
Constraints: integer, 0-35
Default:
7--tagsOptionalmap of string
Tags (key → value) for the database; its nodes' volumes inherit them
Constraints: key=value
--kms-key-idOptionalstring
KMS key that wraps every node volume's key (needs kms:Encrypt on it); omitted: the platform key
Constraints: uuid
--publicly-accessibleOptionalboolean (--publicly-accessible / --no-publicly-accessible)
Whether the database answers on the internet; off by default: reachable only from its VPC
Default:
false--deletion-protectionOptionalboolean (--deletion-protection / --no-deletion-protection)
Refuse delete until it is switched off again; off by default
Default:
false--require-tlsOptionalboolean (--require-tls / --no-require-tls)
Refuse clients that do not use TLS, on both ports; on by default
Default:
true--replication-modeOptionalenum
Cluster only. sync (the default for a cluster): a commit waits for one standby, so a failover loses nothing acknowledged; async: lower commit latency
One of:
async,sync--zone-placementOptionalenum
Cluster only, fixed after creation. spread (the default for a cluster): members round-robin over the region's zones; single: all in availabilityZoneId
One of:
spread,single--logical-replicationOptionalboolean (--logical-replication / --no-logical-replication)
wal_level = logical from the first start, for CDC and publications; off by default
Default:
false--availability-zone-idOptionalstring
Zone of a single node or of a single-placement cluster, e.g. de1b; omitted: the region's default zone
Constraints: /^[a-z]+[0-9]+[a-z]$/
--vpc-idOptionalstring
VPC the database joins; omitted: the organization's default VPC for the region
Constraints: uuid
--subnet-idOptionalstring
Subnet of that VPC to place the database in; omitted: the VPC's whole range
Constraints: uuid
--capacity-fallbackOptionalobject
What a create may fall back to when the provider is out of stock
Constraints: JSON
--on-stock-outOptionalenum
When the type is sold out where it goes and no fallback applies: fail at once (default), or wait as waiting-for-capacity (nothing built or billed) until it is back
One of:
fail,wait--capacity-max-wait-hoursOptionalnumber
With onStockOut wait: give up after this many hours (1–168, default 24)
Constraints: integer, 1-168
Example
dcloud rds instances create --identifier example --instance-class exampleGenerated from the API description, the same one the API checks requests against and the CLI is built from.