Delete an Atlas Stream Processing instance.
The command prompts you to confirm the operation when you run the command without the --force option.
Before deleting an Atlas Streams Processing instance, you must first stop all processes associated with it. To use this command, you must authenticate with a user account, a service account, or an API key with the Project Owner role.
Syntax
atlas streams instances delete <name> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
name | string | true | Name of the Atlas Streams instance. |
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 | |
--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 Streams processor instance '<Name>' deleted
Examples
# Remove an Atlas Stream Processing instance after prompting for a confirmation: atlas streams instance delete myProcessorInstance
# Remove an Atlas Stream Processing instance named myProcessorInstance without requiring confirmation: atlas streams instance delete myProcessorInstance --force