プロジェクトの Atlas Stream Processing インスタンスを更新します。
パブリック プレビュー: MongoDB Atlas Admin APIから自動的に生成される Atlas APIサブコマンドは、Admin APIの完全なカバレッジを提供し、現在パブリック プレビュー段階です（フィードバックでフィードバックを提供してくださいフォーラム/930808-Atlas-cli）。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントのドキュメント リンクから確認できます。
Atlas Streams Processing インスタンスを更新する前に、まずそのインスタンスに関連付けられているすべてのプロセスを停止する必要があります。 このコマンドを使用するには、プロジェクト オーナーのユーザー アカウントまたは API キーで認証する必要があります。
構文
atlas streams instances update <name> [options]
Arguments
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
name | string | true | Atlas Stream Processing インスタンスの名前。 作成後は、インスタンスの名前を変更することはできません。 名前には、ASCII 文字、数字、ハイフンを含めることができます。 |
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-h, --help | false | 更新のヘルプ | |
-o, --output | string | false | 出力形式。 有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。 完全な出力を表示するには、 -o JSONオプションを使用します。 |
--projectId | string | false | 使用するプロジェクトを識別する 16 進数の string。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。 |
--provider | string | true | プロビジョニングされた Atlas Stream Processingインスタンスに適用されるクラウド サービス プロバイダー。有効な値はAmazon Web ServicesまたはAzureです。 この値のデフォルトは "Amazon Web Services" です。 |
-r, --region | string | true | Atlas Stream Processingインスタンスの物理的なロケーションを識別する、人間に判読可能なラベル。リージョンがソースまたはシンクから遠い場合、ネットワークレイテンシとパフォーマンスに影響を与える可能性があります。Amazon Web Servicesの場合、リージョン名は次の形式である必要があります :VIRINIA_US。 有効な値のリストについては、 https://www.mongodb.com/ja-jp/docs/atlas/ 参照/amazon-aws/#std- labels-aws-stream-processing-regions . を参照してください。Azureの場合、リージョン名は次の形式である必要があります :eastus。有効な値のリストについては、 https://www.mongodb.com/ja-jp/docs/atlas/ 参照/Microsoft-azure/#std-la更新- azure-stream-processing-regions を参照してください。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.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