- This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of the Atlas CLI.
Remove the specified Atlas Stream Processing connection from your project.
The command prompts you to confirm the operation when you run the command without the --force option.
Before deleting an Atlas Streams Processing connection, you must first stop all processes associated with it. To use this command, you must authenticate with a user account or an API key with the Project Owner role.
Syntax
atlas streams connections delete <connectionName> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
connectionName | string | true | Name of the connection |
Options
Name | Type | Required | Description |
|---|---|---|---|
--force | false | Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. | |
-h, --help | false | help for delete | |
-i, --instance | string | true | Name of your Atlas Stream Processing instance. |
--projectId | string | false | Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. |
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.
Atlas Stream Processing connection '<Name>' deleted
Examples
# deletes connection 'ExampleConnection' from instance 'ExampleInstance': atlas streams connection delete ExampleConnection --instance ExampleInstance
# deletes connection 'ExampleConnection' from instance 'ExampleInstance' without requiring confirmation: atlas streams connection delete ExampleConnection --instance ExampleInstance --force