Atlas クラスター作成
プロジェクト用のクラスターを作成します。
すぐに開始するには、クラスター、クラウドプロバイダー、およびリージョンの名前を指定して、最新の MongoDB サーバー バージョンで 3 つのノードのレプリカセットを配置します。 配置を完全に制御したり、マルチクラウド クラスターを作成したりするには、 --file フラグを使用して JSON 構成ファイル を提供します。
このコマンドを使用するには、プロジェクト オーナーのユーザー アカウントまたは API キーで認証する必要があります。
構文
atlas clusters create [name] [options]
Arguments
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
name | string | false | クラスターの名前。 クラスターが作成された後は、クラスター名は変更できません。 クラスター名には、ASCII 文字、数字、ハイフンを含めることができます。 --file オプションを使用しない場合は、クラスター名引数を指定する必要があります。 |
オプション
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
--backup | false | 配置の継続的なクラウドバックアップを有効にするフラグ。 このオプションは M10 未満のクラスターでは 使用できません 。 | |
--biConnector | false | 配置上で Atlas 用 BI Connector を有効にするフラグ。 --file と相互に排他的。 | |
--diskSizeGB | float | false | ホストのルート ボリュームの容量(ギガバイト単位)。 --file と相互に排他的。 この値のデフォルトは 2 です。 |
--enable終了Protection | false | クラスターの終了保護を有効にします。 終了保護が有効になっているクラスターを削除することはできません。 | |
-f, --file | string | false | クラスター設定を定義する任意の JSON 構成ファイルへのパス。 Atlas CLI のクラスター構成ファイルの詳細については、 https://docub.mongodb.org/core/cluster-config-file-atlascli を参照してください。 --tier、-provider、-members、-region、-diskSizeGB、--mdbVersion、-biConnector、--type、--shards、-map と相互に排他的です。 |
-h, --help | false | 作成用ヘルプ | |
--mdbVersion | string | false | クラスターのメジャー MongoDB バージョン。 --file と相互に排他的。 この値のデフォルトは " 7.0 " です。 |
-m, --メンバー | 整数 | false | レプリカセット内のノードの数。 --file と相互に排他的。 この値のデフォルトは 3 です。 |
-o, --output | string | false | 出力形式。 有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。 完全な出力を表示するには、 -o JSONオプションを使用します。 |
--projectId | string | false | 使用するプロジェクトを識別する 16 進数の string。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。 |
--provider | string | false | クラウド サービス プロバイダーの名前。 有効な値はAmazon Web Services 、 Azure 、またはGCPです。 --file オプションを使用しない場合は、プロバイダー オプションを指定する必要があります。 --file と相互に排他的。 |
-r, --region | string | false | MongoDB クラスターの物理的なロケーション。 --file オプションを使用しない場合は、リージョン オプションを指定する必要があります。 サポートされているAmazon Web Services リージョンの完全なリストについては、 https://docub.mongodb.org/core/aws-atlas を参照してください。 。サポートされている Azure リージョンの完全なリストについては、 https://docub.mongodb.org/core/azure-atlas を参照してください。 。サポートされている GCP リージョンの完全なリストについては、 https://docub.mongodb.org/core/gcp-atlas を参照してください。 --file と相互に排他的。 |
-s, --shards | 整数 | false | クラスター内のシャードの数。 --file と相互に排他的。 この値のデフォルトは 1 です。 |
--tag | key=value | false | クラスターにタグを付けて分類する、長さが 1 から 255 文字のキーと値のペアを含むリスト。 --file と相互に排他的。 |
--tier | string | false | クラスター内の各データを保持するサーバーの階層。 クラスター階層の詳細については、 https://docub.mongodb.org/core/cluster-tier-atlas を参照してください。 --file と相互に排他的。 この値のデフォルトは「M2」です。 |
--type | string | false | 作成するクラスターのタイプ。 有効な値は REPLICASET または シャード です。 --file と相互に排他的。 この値のデフォルトは "REPLICASET" です。 |
-w, --watch | false | コマンドの実行が完了するまで監視するか、監視がタイムアウトするまで監視するかを示すフラグ。 監視がタイムアウトする時間を設定するには --watchTimeout オプションを使用します。 | |
--watchTimeout | 整数 | false | 監視がタイムアウトするまでの時間(秒単位)。 監視がタイムアウトすると、CLI は コマンドの監視を終了します。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |
出力
コマンドが成功すると、CLI は次のサンプルのような出力を返します。 括弧内の値は 値を表します。
Cluster '<Name>' is being created.
例
# Deploy a free cluster named myCluster for the project with the ID 5e2211c17a3e5a48f5497de3: atlas cluster create myCluster --projectId 5e2211c17a3e5a48f5497de3 --provider AWS --region US_EAST_1 --tier M0
# Deploy a free cluster named myCluster for the project with the ID 5e2211c17a3e5a48f5497de3 and tag "env=dev": atlas cluster create myCluster --projectId 5e2211c17a3e5a48f5497de3 --provider AWS --region US_EAST_1 --tier M0 --tag env=dev
# Deploy a three-member replica set named myRS in AWS for the project with the ID 5e2211c17a3e5a48f5497de3: atlas cluster create myRS --projectId 5e2211c17a3e5a48f5497de3 --provider AWS --region US_EAST_1 --members 3 --tier M10 --mdbVersion 5.0 --diskSizeGB 10
# Deploy a three-member replica set named myRS in AZURE for the project with the ID 5e2211c17a3e5a48f5497de3: atlas cluster create myRS --projectId 5e2211c17a3e5a48f5497de3 --provider AZURE --region US_EAST_2 --members 3 --tier M10 --mdbVersion 5.0 --diskSizeGB 10
# Deploy a three-member replica set named myRS in GCP for the project with the ID 5e2211c17a3e5a48f5497de3: atlas cluster create myRS --projectId 5e2211c17a3e5a48f5497de3 --provider GCP --region EASTERN_US --members 3 --tier M10 --mdbVersion 5.0 --diskSizeGB 10
# Deploy a cluster or a multi-cloud cluster from a JSON configuration file named myfile.json for the project with the ID 5e2211c17a3e5a48f5497de3: atlas cluster create --projectId <projectId> --file myfile.json