プロジェクトの Atlas Stream Processing インスタンスを更新します。
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 | Human-readable label that identifies the physical location of your Atlas Stream Processing instance. The region can affect network latency and performance if it is far from your source or sink. For AWS, region name must be in the following format: VIRGINIA_USA. For a list of valid values, see https://www.mongodb.com/ja-jp/docs/atlas/reference/amazon-aws/#stream-processing-workspaces. For Azure, region name must be in the following format: eastus. For a list of valid values, see https://www.mongodb.com/ja-jp/docs/atlas/reference/microsoft-azure/#stream-processing-workspaces. For GCP, region name must be in the following format: us-central1. For a list of valid values, see https://www.mongodb.com/ja-jp/docs/atlas/reference/google-gcp/#stream-processing-workspaces. |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-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