Atlas backups exports buckets create
Atlas既存のAmazon Web Services S3 バケットを使用して、 バックアップのエクスポート先を作成します。
このコマンドを使用するには、プロジェクト オーナーのユーザー アカウントまたは API キーで認証する必要があります。
構文
コマンド構文
atlas backups exports buckets create <bucketName> [options]
Arguments
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
bucketName | string | true | 指定されたロール ID がアクセスを許可されている既存の S3 バケットの名前。 |
オプション
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
--cloudProvider | string | true | Atlas が S3 バケットにアクセスできるクラウド サービスのプロバイダーの名前。 AtlasはAmazon Web Servicesのみをサポートしています。 |
-h, --help | false | 作成用ヘルプ | |
--iamRoleId | string | true | Atlas がバケットのクラウドプロバイダー アクセス ロールに割り当てる一意の識別子。 クラウドプロバイダー アクセス ロールの設定と取得の詳細については、次を参照してください: https://docub.mongodb.org/core/set-up-unified-aws-access |
-o, --output | string | false | 出力形式。 有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。 完全な出力を表示するには、 -o JSONオプションを使用します。 |
--projectId | string | false | 使用するプロジェクトを識別する 16 進数の string。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |
出力
コマンドが成功すると、CLI は次のサンプルのような出力を返します。 括弧内の値は 値を表します。
Export destination created using '<BucketName>'.
例
# The following command creates an export destination for Atlas backups using the existing AWS S3 bucket named test-bucket: atlas backup export buckets create test-bucket --cloudProvider AWS --iamRoleId 12345678f901a234dbdb00ca