Docs Menu
Docs Home
/ /
Atlas Command Line Interface
/ / /

atlas privateEndpoints gcp watch

Watch the specified GCP private endpoint to detect changes in the endpoint's state.

This command checks the endpoint's state periodically until the endpoint reaches an AVAILABLE or FAILED state. Once the endpoint reaches the expected state, the command prints "GCP Private endpoint changes completed." If you run the command in the terminal, it blocks the terminal session until the resource becomes available or fails. You can interrupt the command's polling at any time with CTRL-C.

atlas privateEndpoints gcp watch <privateEndpointId> [options]
Name
Type
Required
Description

privateEndpointId

string

true

Unique 22-character alphanumeric string that identifies the private endpoint.

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.

Name
Type
Required
Description

-P, --profile

string

false

Human-readable label that identifies 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. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file.

atlas privateEndpoint gcp watch vpce-abcdefg0123456789

Back

list

On this page