📣

TiDB Cloud Serverless is now
TiDB Cloud Starter
! Same experience, new name.
Try it out →

ticloud serverless create

Create a TiDB Cloud cluster:

ticloud serverless create [flags]

Examples

Create a TiDB Cloud cluster in interactive mode:

ticloud serverless create

Create a TiDB Cloud cluster in non-interactive mode:

ticloud serverless create --display-name <display-name> --region <region>

Create a TiDB Cloud Starter cluster with a spending limit in non-interactive mode:

ticloud serverless create --display-name <display-name> --region <region> --spending-limit-monthly <spending-limit-monthly>

Create a TiDB Cloud Essential cluster in non-interactive mode:

ticloud serverless create --display-name <display-name> --region <region> --max-rcu <maximum-rcu> --min-rcu <minimum-rcu>

Flags

In non-interactive mode, you need to manually enter the required flags. In interactive mode, you can just follow CLI prompts to fill them in.

FlagDescriptionRequiredNote
-n --display-name stringSpecifies the name of the cluster to be created.YesOnly works in non-interactive mode.
--spending-limit-monthly intSpecifies the maximum monthly spending limit in USD cents.NoOnly works in non-interactive mode.
-p, --project-id stringSpecifies the ID of the project, in which the cluster will be created. The default value is default project.NoOnly works in non-interactive mode.
-r, --region stringSpecifies the name of the cloud region. You can view all available regions using the ticloud serverless region command.YesOnly works in non-interactive mode.
--disable-public-endpointDisables the public endpoint. Use this option if you want to prevent public access to the cluster.NoOnly works in non-interactive mode.
--encryptionEnables enhanced encryption at rest.NoOnly works in non-interactive mode.
--max-rcu int32Sets the maximum Request Capacity Units (RCUs) for the TiDB Cloud Essential cluster, up to 100000.NoOnly works in non-interactive mode.
--min-rcu int32Sets the minimum Request Capacity Units (RCUs) for the TiDB Cloud Essential cluster, at least 2000.NoOnly works in non-interactive mode.
-h, --helpShows help information for this command.NoWorks in both non-interactive and interactive modes

Inherited flags

FlagDescriptionRequiredNote
--no-colorDisables color in output.NoOnly works in non-interactive mode. In interactive mode, disabling color might not work with some UI components.
-P, --profile stringSpecifies the active user profile used in this command.NoWorks in both non-interactive and interactive modes.
-D, --debugEnables debug mode.NoWorks in both non-interactive and interactive modes.

Feedback

If you have any questions or suggestions on the TiDB Cloud CLI, feel free to create an issue. Also, we welcome any contributions.

Was this page helpful?