atlas streams connections create
Creates a connection for an Atlas Stream Processing instance.
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
To use this command, you must authenticate with a user account or an API key with the Project Owner role.
Syntax
atlas streams connections create [connectionName] [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
connectionName | string | false | Name of the connection |
Options
Name | Type | Required | Description |
|---|---|---|---|
-f, --file | string | true | Path to a JSON configuration file that defines an Atlas Stream Processing connection. Note: Unsupported fields in the JSON file are ignored. |
-h, --help | false | help for create | |
-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. |
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.
Connection <Name> created.
Examples
# create a new connection for Atlas Stream Processing: atlas streams connection create kafkaprod -i test01 -f kafkaConfig.json
# create a new connection using the name from a cluster configuration file atlas streams connection create -i test01 -f clusterConfig.json