- 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 base de datos de federación de datos especificada para su proyecto.
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 dataFederation update <name> [options]
Arguments
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
Nombre | string | true | Nombre de la base de datos de la federación de datos. |
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--awsRoleId | string | false | Nombre de recurso de Amazon (ARN) del rol que utiliza Atlas Data Federation para acceder a los almacenes de datos. Mutuamente excluyente con --file. |
--awsTestS3Bucket | string | false | Nombre de un depósito de datos de Amazon S3 que Atlas Data Federation utiliza para validar la función proporcionada. Mutuamente excluyente con --file. |
-f, --file | string | false | Ruta a un archivo de configuración JSON opcional que define la configuración de federación de datos. Nota: Los campos no compatibles del archivo JSON se ignoran. Para obtener más información sobre los archivos de configuración de federación de datos para la CLI de Atlas, consulte https://dochub.mongodb.org/core/atlas-cli-json-data-federation-config. Mutuamente excluyente con --region, --awsRoleId, --awsTestS3Bucket. |
-h, --ayuda | false | ayuda para actualizar | |
-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. |
--region | string | false | Nombre de la región a la que Atlas Data Federation enruta las conexiones de cliente para el procesamiento de datos. Mutuamente excluyente con --file. |
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.
Pipeline <Name> updated.
Ejemplos
# update data lake pipeline: atlas dataFederation update DataFederation1