- Esta versión de la documentación está archivada y ya no se admite. Ver la Documentación actual para aprender cómo actualizar su versión de Atlas CLI.
Modifique los detalles de la conexión especificada dentro de su instancia de Atlas Stream Processing.
Vista previa pública: El subcomando atlas api, generado automáticamente desde la API de administración de MongoDB Atlas, ofrece cobertura completa de la API de administración y se encuentra actualmente en vista previa pública (envíe sus comentarios en https://feedback.mongodb.com/forums/930808-atlas-cli). Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puede consultar a través del enlace de documentación del punto final de la API.
Para usar este comando, debes autenticarte con una cuenta de usuario o una clave de API con el rol de Propietario de Proyecto.
Sintaxis
atlas streams connections update <connectionName> [options]
Arguments
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
nombreDeConexión | string | true | Nombre de la conexión. |
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-f, --file | string | true | Ruta a un archivo de configuración JSON que define una conexión de Atlas Stream Processing. Nota: Los campos no compatibles del archivo JSON se ignoran. |
-h, --ayuda | false | ayuda para actualizar | |
-i, --instance | string | true | Nombre de su instancia de Atlas Stream Processing. |
-o, --output | string | false | Formato de salida. Los valores válidos son json, json-path, go-template o go-template-file. Para ver la salida completa, use la opción -o json. |
--projectId | string | false | Cadena hexadecimal que identifica el proyecto que se utilizará. Esta opción anula la configuración del archivo de configuración o la variable de entorno. |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil que se usará en el archivo de configuración. Para obtener más información sobre los perfiles de la CLI de Atlas, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Salida
Si el comando se ejecuta correctamente, la CLI devuelve un resultado similar al siguiente ejemplo. Los valores entre paréntesis representan sus valores.
Connection <Name> updated.
Ejemplos
# update an Atlas Stream Processing connection: atlas streams connection update kafkaprod --instance test01 -f kafkaConfig.json