Watch the specified cluster in your project until it becomes available.
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
This command checks the cluster's status periodically until it reaches an IDLE state. Once the cluster reaches the expected state, the command prints "Cluster available." If you run the command in the terminal, it blocks the terminal session until the resource state changes to IDLE. You can interrupt the command's polling at any time with CTRL-C.
To use this command, you must authenticate with a user account or an API key with the Project Read Only role.
atlas clusters watch <clusterName> [options]Name
Type
Required
Description
clusterName
string
true
Name of the cluster to watch.
Name
Type
Required
Description
-h, --help
false
help for watch
--projectId
string
false
Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
# Watch for the cluster named myCluster to become available for the project with ID 5e2211c17a3e5a48f5497de3:atlas clusters watch myCluster --projectId 5e2211c17a3e5a48f5497de3RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4