- 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.
Modify the details of the specified connection within your Atlas Stream Processing instance.
To use this command, you must authenticate with a user account or an API key with the Project Owner role.
Syntax
atlas streams connections update <connectionName> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
connectionName | string | true | 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 update | |
-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> updated.
Examples
# update an Atlas Stream Processing connection: atlas streams connection update kafkaprod --instance test01 -f kafkaConfig.json