修改项目的指定 Data Federation 数据库的详细信息。
公共预览版： Atlas API子命令从MongoDB Atlas Admin API自动生成，提供对 Admin API的全面覆盖，目前处于公共预览阶段（请通过以下网址提供反馈：https://反馈.mongodb.com/forum/930808-Atlas-cli）。Admin API功能有自己的发布生命周期，您可以通过提供的API端点文档链接进行检查。
要使用此命令，您必须使用具有项目所有者角色的用户帐户或 API 密钥进行身份验证。
语法
atlas dataFederation update <name> [options]
参数
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
名称 | 字符串 | true | Data Federation数据库的名称。 |
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--awsRoleId | 字符串 | false | Atlas Data Federation 用于访问数据存储的角色的 Amazon 资源名称 (ARN)。 与 --文件 互斥。 |
--awsTestS3Bucket | 字符串 | false | Atlas Data Federation 用于验证所提供角色的 Amazon S3 数据存储桶的名称。 与 --文件 互斥。 |
-f, --file | 字符串 | false | 定义数据联合设置的可选JSON配置文件的路径。注意： JSON文件中不支持的字段将被忽略。要学习；了解有关Atlas CLI的数据联合配置文件的更多信息，请参阅 https://dochub.mongodb.org/core/atlas-cli-json-data-federation-config。 与 --地区、--awsRoleId、--awsTestS3Bucket 互斥。 |
-h，--help | false | 更新帮助 | |
-o, --output | 字符串 | false | 输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出，请使用 -o json 选项。 |
--projectId | 字符串 | false | 标识要使用的项目的十六进制字符串。 此选项会覆盖配置文件或环境变量中的设置。 |
--region | 字符串 | false | Atlas Data Federation 将客户端连接路由到以进行数据处理的地区的名称。 与 --文件 互斥。 |
继承选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-P, --profile | 字符串 | false | 要从您的配置文件中使用的配置文件的名称。要学习；了解Atlas CLI配置文件，请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
输出
如果命令成功，CLI 将返回类似于以下示例的输出。 括号中的值代表您的价值观。
Pipeline <Name> updated.
示例
# update data lake pipeline: atlas dataFederation update DataFederation1