Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

atlas streams connections describe

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Examples

Return the details for the specified Atlas Stream Processing connection.

To use this command, you must authenticate with a user account or an API key with the Project Owner role.

Command Syntax
atlas streams connections describe <streamConnectionName> [options]
Name
Type
Required
Description
streamConnectionName
string
true
Name of the Atlas Stream Processing connection.
Name
Type
Required
Description
-h, --help
false
help for describe
-i, --instance
string
true
Name of your Atlas Stream Processing instance.
-o, --output
string
false
Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.
--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
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.
# retrieves stream connection 'ExampleConnection' in instance 'ExampleInstance':
atlas streams connection describe ExampleConnection --instance ExampleInstance

Back

delete