atlas deployments pause
On this page
Public Preview. The
atlas deployments command and subsequent related commands are available as a Public Preview. The feature and corresponding documentation may change at any time in the Public Preview stage. To ask questions and provide feedback, see the Atlas CLI Local Development Community Forum.Pause a deployment.
Syntax
Command Syntax
atlas deployments pause <deploymentName> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
deploymentName | string | true | Name of the deployment. |
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for pause | |
--projectId | string | false | Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. |
--type | string | false | Type of deployment. Valid values are ATLAS or LOCAL. |
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. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
Pausing deployment '<Name>'.