Creates an Atlas Ephemeral cluster and returns its connection and claim details.
The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
An Ephemeral cluster is a temporary Free cluster that you can create and connect to without an Atlas account. Atlas pauses the cluster 2 days after creation and deletes it 7 days after creation unless you claim it to an Atlas account.
Claiming an Ephemeral cluster converts it into a standard Free cluster with no expiration date and moves it into a new or existing Atlas organization. Until you claim the cluster, you can read and write its data but can't perform administrative operations, such as scaling the cluster, adding database users, or changing network access.
Atlas deploys all Ephemeral clusters to AWS us-east-1 and allows connections from any IP address (0.0.0.0/0). To learn more about Ephemeral clusters, see Create an Atlas Ephemeral Cluster in the MongoDB Atlas documentation.
This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createephemeralcluster.
For more information and examples, see the referenced API documentation linked above.
Syntax
atlas api ephemeralClusters createEphemeralCluster [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--file | string | false | path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. |
-h, --help | false | help for createEphemeralCluster | |
-o, --output | string | false | preferred api format, can be ["json", go-template] This value defaults to "json". |
--outputFile | string | false | file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) |
--version | string | false | API version to use when calling the Atlas API endpoints [options: "preview"]. If not set by the user, defaults to the latest version or the profile's api_version config value if set. This value defaults to "preview". |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |