atlas dataFederation update
プロジェクトに指定されたData Federationデータベースの詳細を変更します。
このコマンドを使用するには、プロジェクト オーナーのユーザー アカウントまたは API キーで認証する必要があります。
構文
atlas dataFederation update <name> [options]
Arguments
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
name | string | true | Data Federationデータベースの名前。 |
オプション
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
--awsRoleId | string | false | Atlas Data Federation がデータ ストアにアクセスするために使用するロールの Amazon リソース名(ARN)。 --file と相互に排他的。 |
--awsTestS3Bucket | string | false | Atlas Data Federation が提供されたロールを検証するために使用する Amazon S3 データ バケットの名前。 --file と相互に排他的。 |
-f, --file | string | false | JSONData Federationの設定を定義する任意の 構成ファイルへのパス。Data Federationの 構成ファイルの詳細については、Atlas CLI https://docub.mongodb.org/core/atlas-cli-json-data-federation-config を参照してください。 --region、-awsRoleId、--awsTestS3bucket と相互に排他的です。 |
-h, --help | false | 更新のヘルプ | |
-o, --output | string | false | 出力形式。 有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。 完全な出力を表示するには、 -o JSONオプションを使用します。 |
--projectId | string | false | 使用するプロジェクトを識別する 16 進数の string。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。 |
--region | string | false | Atlas Data Federation がデータ処理のためにクライアント接続をルーティングするリージョンの名前。 --file と相互に排他的。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |
出力
コマンドが成功すると、CLI は次のサンプルのような出力を返します。 括弧内の値は 値を表します。
Pipeline <Name> updated.
例
# update data lake pipeline: atlas dataFederation update DataFederation1