Atlas Streams 实例更新
更新项目的 Atlas Stream Processing 实例。
在更新 Atlas Streams Processing 实例之前,必须先停止与其关联的所有进程。 要使用此命令,您必须使用具有项目所有者角色的用户帐户或 API 密钥进行身份验证。
语法
命令语法
atlas streams instances update <name> [options]
参数
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
名称 | 字符串 | true | Atlas Stream Processing 实例的名称。 创建后,您无法更改实例的名称。 名称可以包含 ASCII 字母、数字和连字符。 |
选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
-h,--help | false | 更新帮助 | |
-o, --output | 字符串 | false | 输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出,请使用 -o json 选项。 |
--projectId | 字符串 | false | 标识要使用的项目的十六进制字符串。 此选项会覆盖配置文件或环境变量中的设置。 |
--provider | 字符串 | true | 应用于已预配的 Atlas Stream Processing 实例的云服务提供商。 此值默认为“Amazon Web Services”。 |
-r, --region | 字符串 | true | 人类可读标签,用于标识 Atlas Stream Processing 实例的物理位置。 如果该地区距离源或接收器较远,则可能会影响网络延迟和性能。 |
继承选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
-P, --profile | 字符串 | false | 要从配置文件中使用的配置文件的名称。 要了解 Atlas CLI 的配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
输出
如果命令成功,CLI 将返回类似于以下示例的输出。 括号中的值代表您的价值观。
Atlas Streams Processor Instance '<Name>' successfully updated.
示例
# Modify the Atlas Stream Processing instance configuration with the name MyInstance: atlas streams instance update MyInstance --provider AWS --region VIRGINIA_USA