Cluster カスタム リソース

string

リージョン停止時によりプライマリを復旧するために再構成が必要な場合は、トポロジーの再構成と一緒にこのフィールドを送信して、新たなリージョン停止時に耐性のあるトポロジーをリクエスト。複製された書込み（過半数がコミットされた書込みであっても）が新しい プライマリノードに複製されていない場合、選挙可能なノードの過半数が停止時間に強制再構成を行うと、データが失われるリスクがあります。 MongoDB Atlas のドキュメントに詳しい情報が記載されています。このリスクを伴う操作を続行するには、acceptDataRisksAndForceReplicaSetReconfig を現在の日付に設定します。このパラメータは、UTCの ISO 8601 タイムスタンプ形式で値を表します。

false

オブジェクト

高度な構成の詳細のサブセットを構成する設定のグループ。

false

ブール値

クラスターがバックアップを実行できるかどうかを示すフラグ。true に設定されている場合、クラスターはバックアップを実行できます。true NVMe クラスターの場合、この値を に設定する必要があります。バックアップは、専有クラスターには クラウドバックアップ を使用し、テナント クラスターには 共有クラスター バックアップ を使用します。false に設定されている場合は、クラスターはバックアップを使用しません。

false

オブジェクト

このクラスターの MongoDB Connector for Business Intelligence を構成するために必要な設定。

false

string

クラスターを構成するノードの構成。

false

string

シャーディングされたクラスターを作成または更新するための コンフィギュレーションサーバー マネジメント モード 。ATLAS_MANAGED として構成されている場合、Atlas は最適なパフォーマンスと節約のためにクラスターのコンフィギュレーションサーバータイプを自動的に切り替える場合があります。FIXED_TO_DEDICATED として構成されている場合、クラスターは常に専用のコンフィギュレーションサーバーを使用します。

false

string

シャーディングされたクラスターのコンフィギュレーションサーバーのタイプを説明します。

false

string

ディスク ウォーミング モードの選択。

false

string

カスタマーキーを管理して、クラスターの保管時の暗号化の追加レイヤーを提供するクラウド サービス プロバイダー。保管時の暗号化のためのカスタマーキーマネジメントを有効にするには、クラスターの replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize 設定が M10 以上、かつ "backupEnabled" : false または完全に省略されている必要があります。

false

ブール値

新しいグローバルクラスターを作成するときに、シャーディング管理モードを構成するには、このフィールドを に設定します。 false に設定されている場合、マネジメント モードは Atlas マネージド シャーディングに設定されます。このモードはグローバルクラスターのシャーディングを完全に管理し、シームレスな配置エクスペリエンスを提供するように構築されています。 true に設定されている場合、マネジメント モードは自己管理型シャーディングに設定されます。このモードは、シャードの管理をユーザーに委ね、高度で柔軟な配置エクスペリエンスを提供するように構築されています。 この設定は、クラスターが配置されると変更できません。

false

[]オブジェクト

クラスターにタグを付けて分類する、長さが 1 から 255 文字の間のキーと値のペアのコレクション。 MongoDB Cloud コンソールはラベルを表示しません。クラスター labels は非推奨であり、将来のリリースで削除される予定です。代わりに リソース タグ を使用することを強くお勧めています。

false

オブジェクト

MongoDB クラスターのアクセスレベルと有効期限が付与された従業員。

false

string

MongoDB クラスターのメジャー バージョン。バイナリ メジャー バージョンに設定します。作成時: 利用可能な MongoDB のバージョンから選択するか、MongoDB Cloud プラットフォームで現在推奨されているデフォルトを未指定のままにします。推奨バージョンは、最新の長期サポートバージョンです。デフォルトは、全リリース サイクルを通じて最新のリリース バージョンであることを保証するものではありません。特定のプロジェクトで利用可能なバージョンについては、リンクされたドキュメントを参照するか、project LTS versions endpoint の API エンドポイントを使用してください。更新時: 一度に 1 メジャー バージョンを つだけ上げてください。クラスターが現在の MongoDB バージョンより 1 つ下の MongoDB機能の互換性バージョンに固定されている場合、MongoDB バージョンはそれ以前のメジャー バージョンにダウングレードできます。

false

string

クラスターを識別する人間が判読できるラベル。

false

ブール値

クラスターが一時停止しているかどうかを示すフラグ。

false

ブール値

クラスターが継続的なクラウドバックアップを使用するかどうかを示すフラグ。

false

ブール値

ログリダクションを有効または無効にします。この設定により、 または は、ログに記録される前に特定のログイベントに付随するメッセージから任意のドキュメントフィールドの内容をリダクションするように構成されます。これにより、データベースに保存されている機密性が高い可能性のあるデータをプログラムが 診断ログに書き込むことを防止します。エラー コードや操作コード、行番号、ソースファイル名などのメタデータは、引き続きログに表示されます。規制要件へのコンプライアンスに、 を 保存時の暗号化mongod mongosredactClientLogDataおよびTLS /SSL （トランスポート暗号化） と組み合わせて使用することが役立ちます。注: クラスターでこの設定を変更すると、クラスターが更新された後すぐにローリング再起動がトリガーされます。

false

string

クラスターのレプリカセットスケーリングモードを構成するには、このフィールドを に設定します。デフォルトでは 、Atlas は WORKLOAD_TYPE の下でスケーリングされます。このモードでは、Atlas は分析ノードを運用ノードと並行して増やすできます。 SEQUENTIAL として構成すると、Atlas はすべてのノードを順次スケーリングします。このモードは、定常状態のワークロードとレイテンシの影響を受けやすいセカンダリ読み取りを実行するアプリケーションを対象としています。 NODE_TYPE に設定すると、Atlas は選択可能なノードを読み取り専用ノードと分析ノードと並行してスケーリングします。このモードは、頻繁にクラスター層をスケーリングすることを必要とする大規模で動的ワークロードを対象としています。これは最速のスケーリング戦略ですが、大量のセカンダリ読み取りを実行するとワークロードのレイテンシに影響可能性があります。

false

[]オブジェクト

クラスター リージョンを構成する設定のリスト。 この配列には、各シャードのノード構成を表すシャードごとに 1 つのオブジェクトが含まれます。 レプリカセットの場合、ノード構成を表すオブジェクトは 1 つだけです。

false

ブール値

クラスターがバックアップを保持しているかどうかを示すフラグ。

false

string

MongoDB Atlas クラスターが使用するルート認証局。 MongoDB Cloud は Internet Security Research Group をサポートしています。

false

[]オブジェクト

クラスターにタグを付けて分類する、長さが 1 から 255 文字のキーと値のペアを含むリスト。

false

ブール値

クラスターで終了保護が有効になっているかどうかを示すフラグ。 true に設定されていると、MongoDB Cloud はクラスターを削除しません。 false に設定されていると、MongoDB Cloud はクラスターを削除します。

false

ブール値

Atlas の高速 クロスリージョン 最初の同期中に、低速の標準スナップショット コピーの代わりに、AWS 時間ベースのスナップショット コピーを使用するかどうかを示すフラグ。このフラグは、AWS ノードを含むクラスターにのみ関連します。

false

string

クラスターが MongoDB バージョンを管理する方法。値が CONTINUOUS の場合、mongoDBMajorVersion を指定しないでください。

false

オブジェクト

このクラスターがリソーススケーリングを取り扱う方法を決定するオプション。

false

オブジェクト

リージョン内の読み取り専用ノードの現在のハードウェア仕様。

false

オブジェクト

このクラスターがリソーススケーリングを取り扱う方法を決定するオプション。

false

string

MongoDB Cloud がマルチテナント クラスターをプロビジョニングしたクラウド サービス プロバイダー。リソースは、providerName が TENANT で、かつ electableSpecs.instanceSize が M0、M2、または M5 の場合、このパラメータを返します。代わりに、M2 または M5 の instanceSize を使用すると Flex クラスターが作成されます。 M2 または M5 の instanceSize のサポートは、2026 年 1 月に終了します。このような構成には、Flex Cluster の作成 API を使用することをお勧めします。

false

オブジェクト

リージョンに配置されるすべての選択可能なノードのハードウェア仕様。選挙可能なノードはプライマリになることができ、ローカル読み取りを有効にできます。このオプションを指定しない場合、MongoDB Cloud はリージョンに選択可能なノードを配置しません。

false

integer

予備選挙が行われると、このリージョンに優先順位が与えられます。regionConfigs readOnlySpecsanalyticsSpecs0regionConfigspriority776に 、 、またはその両方がある場合は、この値を に設定します。複数の オブジェクト（クラスターがマルチリージョンまたはマルチクラウドである場合）には、降順の優先順位が必要です。最高の は です。例: 3 つのリージョンがある場合、優先順位はそれぞれ 、 、5 になります。選択可能なノードをサポートするためにさらに 2 つのリージョンを追加した場合、それらのリージョンの優先順位はそれぞれ4 と3 になります。

false

string

MongoDB Cloud がホストをプロビジョニングするクラウド サービス プロバイダー。専有クラスターを AWS、GCP、AZURE、または TENANT に設定します。

false

オブジェクト

リージョン内の読み取り専用ノードの現在のハードウェア仕様。

false

string

MongoDB クラスター ノードの物理的なロケーション選択したリージョンは、データベースにアクセスするクライアントのネットワークレイテンシに影響する可能性があります。リージョン名は、単一リージョン クラスターのレスポンスではのみ返されます。 MongoDB Cloud が専有クラスターを配置すると、そのプロバイダーとリージョンに VPC または VPC 接続が存在するかどうかを確認します。変換できない場合、MongoDB Cloud は配置の一部としてそれらを作成します。これにより、VPC にクラスレス ドメイン間ルーティング（CIDR）ブロックが割り当てられます。新しい VPC ピアリング接続を 1 つのクラスレス ドメイン間ルーティング（CIDR）ブロックとリージョンに制限するには、最初に接続を作成します。接続が開始された後にクラスターを配置します。 GCP クラスターと マルチリージョンクラスターでは、リージョンごとに 1 つの VPC ピアリング接続が必要です。 MongoDB ノードは、ピアリングされた VPC と通信するために、ノードと同じリージョンに存在するピアリング接続のみを使用できます。

false

integer

Azure がプロビジョニングしたクラスターに接続されたストレージに必要なターゲットスループット。次の場合は、このパラメーターを変更します。

• set replicationSpecs[n].regionConfigs[m].providerName : Azure を設定します。

• replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize を設定 : M40 以上（Mxx_NVME 階層は含まない）

1 秒あたりの最大入出力操作数（IOPS）は、選択した .instanceSize と .diskSizeGB によって異なります。このパラメータはデフォルトで、クラスター階層の標準 IOPS 値になります。この値を変更すると、クラスターのコストに影響します。

false

数値

インスタンスデータ ボリュームのストレージキャパシティー（ギガバイト単位）。この数を増やすと、キャパシティーが追加されます。この値は、すべてのシャードとノードタイプで等しくなければなりません。この値は、M0/M2/M5 クラスターでは構成できません。 replicationSpecsを設定する場合、MongoDB Cloud ではこのパラメータが必要になります。最小（10 GB）より小さいディスク サイズを指定する場合、このパラメータはデフォルトで最小ディスク サイズ値になります。ストレージ料金の計算は、デフォルト値を選択するかカスタム値を選択するかによって異なります。ディスクストレージの最大値は、選択したクラスターの最大 RAM の 50 倍を超えることはできません。より多くのストレージ容量が必要な場合は、クラスターを上位階層にアップグレードすることを検討してください。

false

string

AWS に接続するストレージのタイプ。

• STANDARD ボリュームタイプは、選択したボリューム サイズのデフォルトの入出力操作数（IOPS）を超えることはできません。

• PROVISIONED ボリュームタイプは、選択したボリュームサイズに許容される IOPS の範囲内に収まる必要があります。 NVMe クラスターの場合、この値を （PROVISIONED）に設定する必要があります。

false

string

このシャード内のこのリージョンのインスタンスサイズのハードウェア仕様。各インスタンスサイズには、デフォルトのストレージとメモリキャパシティーがあります。単一シャード内の選択可能なノードと読み取り専用ノード（「ベース ノード」と呼ばれる）では、同じインスタンスサイズを使用する必要があります。分析ノードは、シャード内の基本ノードとは独立して増やすできます。基本ノードと分析ノードはどちらも、他のシャードの同等のノードとは独立して増やすできます。

false

integer

リージョンに配置する MongoDB クラウド の指定されたタイプのノードの数。

false

integer

Azure がプロビジョニングしたクラスターに接続されたストレージに必要なターゲットスループット。次の場合は、このパラメーターを変更します。

• set replicationSpecs[n].regionConfigs[m].providerName : Azure を設定します。

• replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize を設定 : M40 以上（Mxx_NVME 階層は含まない）

1 秒あたりの最大入出力操作数（IOPS）は、選択した .instanceSize と .diskSizeGB によって異なります。このパラメータはデフォルトで、クラスター階層の標準 IOPS 値になります。この値を変更すると、クラスターのコストに影響します。

false

数値

インスタンスデータ ボリュームのストレージキャパシティー（ギガバイト単位）。この数を増やすと、キャパシティーが追加されます。この値は、すべてのシャードとノードタイプで等しくなければなりません。この値は、M0/M2/M5 クラスターでは構成できません。 replicationSpecsを設定する場合、MongoDB Cloud ではこのパラメータが必要になります。最小（10 GB）より小さいディスク サイズを指定する場合、このパラメータはデフォルトで最小ディスク サイズ値になります。ストレージ料金の計算は、デフォルト値を選択するかカスタム値を選択するかによって異なります。ディスクストレージの最大値は、選択したクラスターの最大 RAM の 50 倍を超えることはできません。より多くのストレージ容量が必要な場合は、クラスターを上位階層にアップグレードすることを検討してください。

false

string

AWS に接続するストレージのタイプ。

• STANDARD ボリュームタイプは、選択したボリューム サイズのデフォルトの入出力操作数（IOPS）を超えることはできません。

• PROVISIONED ボリュームタイプは、選択したボリュームサイズに許容される IOPS の範囲内に収まる必要があります。 NVMe クラスターの場合、この値を （PROVISIONED）に設定する必要があります。

false

string

true テナントインスタンスのサイズ。これは、非推奨のプロバイダー タイプやインスタンスサイズの下位互換性をサポートするために存在します。

false

string

この M0/M2/M5 階層クラスター内のインスタンスのハードウェア仕様。

false

integer

リージョンに配置する MongoDB クラウド の指定されたタイプのノードの数。

false

integer

Azure がプロビジョニングしたクラスターに接続されたストレージに必要なターゲットスループット。次の場合は、このパラメーターを変更します。

• set replicationSpecs[n].regionConfigs[m].providerName : Azure を設定します。

• replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize を設定 : M40 以上（Mxx_NVME 階層は含まない）

1 秒あたりの最大入出力操作数（IOPS）は、選択した .instanceSize と .diskSizeGB によって異なります。このパラメータはデフォルトで、クラスター階層の標準 IOPS 値になります。この値を変更すると、クラスターのコストに影響します。

false

数値

インスタンスデータ ボリュームのストレージキャパシティー（ギガバイト単位）。この数を増やすと、キャパシティーが追加されます。この値は、すべてのシャードとノードタイプで等しくなければなりません。この値は、M0/M2/M5 クラスターでは構成できません。 replicationSpecsを設定する場合、MongoDB Cloud ではこのパラメータが必要になります。最小（10 GB）より小さいディスク サイズを指定する場合、このパラメータはデフォルトで最小ディスク サイズ値になります。ストレージ料金の計算は、デフォルト値を選択するかカスタム値を選択するかによって異なります。ディスクストレージの最大値は、選択したクラスターの最大 RAM の 50 倍を超えることはできません。より多くのストレージ容量が必要な場合は、クラスターを上位階層にアップグレードすることを検討してください。

false

string

AWS に接続するストレージのタイプ。

• STANDARD ボリュームタイプは、選択したボリューム サイズのデフォルトの入出力操作数（IOPS）を超えることはできません。

• PROVISIONED ボリュームタイプは、選択したボリュームサイズに許容される IOPS の範囲内に収まる必要があります。 NVMe クラスターの場合、この値を （PROVISIONED）に設定する必要があります。

false

string

このシャード内のこのリージョンのインスタンスサイズのハードウェア仕様。各インスタンスサイズには、デフォルトのストレージとメモリキャパシティーがあります。単一シャード内の選択可能なノードと読み取り専用ノード（「ベース ノード」と呼ばれる）では、同じインスタンスサイズを使用する必要があります。分析ノードは、シャード内の基本ノードとは独立して増やすできます。基本ノードと分析ノードはどちらも、他のシャードの同等のノードとは独立して増やすできます。

false

integer

リージョンに配置する MongoDB クラウド の指定されたタイプのノードの数。

false

string

条件のステータスは、True、False、Unknown のいずれか 1 つです。

true

string

条件のタイプ。

true

string

条件があるステータスから別のステータスに最後に移行した時刻。形式: 日時

false

string

移行に関する詳細を示す、人間が判読可能な message。

false

integer

observedGeneration は、 を表します。条件が基づいて設定されたメタデータ. 生成。

false

string

条件の最後の移行の reason。

false

オブジェクト

高度な構成の詳細のサブセットを構成する設定のグループ。

false

string

シャーディングされたクラスターを作成または更新するための コンフィギュレーションサーバー マネジメント モード 。ATLAS_MANAGED として構成されている場合、Atlas は最適なパフォーマンスと節約のためにクラスターのコンフィギュレーションサーバータイプを自動的に切り替える場合があります。FIXED_TO_DEDICATED として構成されている場合、クラスターは常に専用のコンフィギュレーションサーバーを使用します。

false

string

シャーディングされたクラスターのコンフィギュレーションサーバーのタイプを説明します。

false

オブジェクト

MongoDBデータベースを点均一リソース ロケールのコレクション。

false

string

MongoDB Cloud がこのクラスターを作成した日時。このパラメータは、UTC 内の ISO 8601形式で値を表します。

false

[]オブジェクト

実際のクラスターの状態を表す設定のリスト。これは読み取り専用で、常に応答内に返されます。これは現在のクラスター構成を反映しています。システム管理による変更により、replicationSpecs と異なる場合があります。

false

string

クラスターの機能の互換性バージョン。これは、FCV が固定されているかどうかに関係なく、常に表示されます。

false

string

機能の互換性バージョンの有効期限。 FCV が固定されている場合にのみ表示されます。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

false

ブール値

新しいグローバルクラスターを作成するときに、シャーディング管理モードを構成するには、このフィールドを に設定します。 false に設定されている場合、マネジメント モードは Atlas マネージド シャーディングに設定されます。このモードはグローバルクラスターのシャーディングを完全に管理し、シームレスな配置エクスペリエンスを提供するように構築されています。 true に設定されている場合、マネジメント モードは自己管理型シャーディングに設定されます。このモードは、シャードの管理をユーザーに委ね、高度で柔軟な配置エクスペリエンスを提供するように構築されています。 この設定は、クラスターが配置されると変更できません。

false

string

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。

false

string

クラスターを識別するユニークな 24 桁の 16 進数の文字列。

false

string

クラスターのロールの内部分類。可能な値は: NONE（通常のユーザー クラスター）、SYSTEM_CLUSTER（バックアップ用のシステム クラスター）、INTERNAL_SHADOW_CLUSTER（テスト用の内部使用シャットダウン クラスター）。

false

オブジェクト

MongoDB クラスターのアクセスレベルと有効期限が付与された従業員。

false

string

クラスターが実行する MongoDB のバージョン。

false

ブール値

ログリダクションを有効または無効にします。この設定により、 または は、ログに記録される前に特定のログイベントに付随するメッセージから任意のドキュメントフィールドの内容をリダクションするように構成されます。これにより、データベースに保存されている機密性が高い可能性のあるデータをプログラムが 診断ログに書き込むことを防止します。エラー コードや操作コード、行番号、ソースファイル名などのメタデータは、引き続きログに表示されます。規制要件へのコンプライアンスに、 を 保存時の暗号化mongod mongosredactClientLogDataおよびTLS /SSL （トランスポート暗号化） と組み合わせて使用することが役立ちます。注: クラスターでこの設定を変更すると、クラスターが更新された後すぐにローリング再起動がトリガーされます。

false

string

クラスターのレプリカセットスケーリングモードを構成するには、このフィールドを に設定します。デフォルトでは 、Atlas は WORKLOAD_TYPE の下でスケーリングされます。このモードでは、Atlas は分析ノードを運用ノードと並行して増やすできます。 SEQUENTIAL として構成すると、Atlas はすべてのノードを順次スケーリングします。このモードは、定常状態のワークロードとレイテンシの影響を受けやすいセカンダリ読み取りを実行するアプリケーションを対象としています。 NODE_TYPE に設定すると、Atlas は選択可能なノードを読み取り専用ノードと分析ノードと並行してスケーリングします。このモードは、頻繁にクラスター層をスケーリングすることを必要とする大規模で動的ワークロードを対象としています。これは最速のスケーリング戦略ですが、大量のセカンダリ読み取りを実行するとワークロードのレイテンシに影響可能性があります。

false

ブール値

クラスターがバックアップを保持しているかどうかを示すフラグ。

false

string

Atlas コントロール プレーンによってこのクラスターで実行されている現在のアクティビティを示す、人間が判読可能なラベル。 CREATING 状態と DELETING 状態を除き、 が進行中のアクティビティを示す 状態であっても、クラスターは常に使用可能であり、 プライマリノードが存在する必要があります。

• IDLE: Atlas はこのクラスターに変更を加えず、UI または API を介してリクエストされたすべての変更が適用されたと想定できます。

• CREATING: 初めてプロビジョニングされたクラスターは、接続の準備が整うまで状態 CREATING を返します。接続を試みる前に、IPアクセス リストと DB ユーザーが構成されていることを確認します。

• UPDATING: UI、API、AutoScaling、またはその他のスケジュールされたアクティビティからリクエストされた変更が実行されています。

• DELETING: クラスターは削除プロセス中であり、すぐに削除される予定です。

• REPAIRING: クラスター内の 1 つ以上のノードが Atlas コントロール プレーンによって使用可能に返されています。他のノードは、通常どおりサービスを提供し続ける必要があります。

false

map[string]string

Amazon Web Services （AWS）PrivateLink でホストされる AWS ホスト型クラスターを使用するプライベートエンドポイント対応接続文字列各キーはAmazon Web Services (AWS)インターフェイスエンドポイントを識別します。各値は、キーが名前を付けるインターフェイスエンドポイントを介して MongoDB Cloud に接続するために使用する関連する mongodb://接続文字列を識別します。

false

map[string]string

Amazon Web Services （AWS）PrivateLink でホストされる AWS ホスト型クラスターを使用するプライベートエンドポイント対応接続文字列各キーはAmazon Web Services (AWS)インターフェイスエンドポイントを識別します。各値は、キーが名前を付けるインターフェイスエンドポイントを介して Atlas に接続するために使用する関連する mongodb://接続文字列を識別します。クラスターが 最適化された接続文字列を使用する場合、awsPrivateLinkSrv には最適化された接続文字列が含まれます。クラスターに最適化されていない（レガシー）接続文字列がある場合、最適化された接続接続文字列が存在していても、awsPrivateLinkSrv には最適化されていない接続文字列が含まれます。

false

string

このクラスターに接続するために構成した各インターフェース仮想プライベートクラウド（VPC）エンドポイントのネットワークピアリング接続文字列。この接続文字列ではmongodb+srv://プロトコルを使用します。リソースは、このクラスターへのネットワークピアリング接続がユーザーが作成すると、このパラメーターを返します。このプロトコルは、アプリケーションにドメインネームシステム（DNS）のホストシードリストを検索するように指示します。このリストは、クラスター内のノードと同期します。接続文字列がこの 均等リソース識別子（URI）形式 を使用している場合、ノードが変更された場合にシードリストを追加したり、URI を変更したりする必要はありません。ドライバーがサポートしている場合は、この URI形式を使用します。変換できない場合は connectionStrings.private を使用します。 Amazon Web Services （AWS）クラスターの場合、このリソースはカスタム DNS を有効にしている場合にのみこのパラメーターを返します。

false

[]オブジェクト

プライベートエンドポイント経由でこのクラスターに接続するために使用できるプライベートエンドポイント対応接続文字列のリスト。このパラメーターは、このクラスターのノードを配置したすべてのリージョンにプライベートエンドポイントを配置した場合にのみ を返します。

false

string

このクラスターに接続するために構成した各インターフェース仮想プライベートクラウド（VPC ）エンドポイントのネットワークピアリング接続文字列。この接続文字列ではmongodb+srv:// プロトコルを使用します。リソースは、このクラスターへのネットワークピアリング接続が誰かが作成したときに、このパラメータを返します。このプロトコルは、アプリケーションにドメインネームシステム（ ）のホストシードリストを検索するように指示します。このリストは、クラスター内のノードと同期します。接続文字列がこのDNS Uniform Resource Identifier（URI ）形式 を使用している場合、ノードが変更された場合にシードリストを追加したり、Uniform Resource Identifier（URI ）を変更したりする必要はありません。ドライバーがサポートしている場合は、この Uniform Resource Identifier（URI ）形式を使用します。変換できない場合はconnectionStrings.private を使用します。 Amazon Web Services ()AWS クラスターの場合、このパラメーターはカスタム DNS を有効にしている場合にのみ返します。

false

string

このクラスターに接続するために使用できるパブリック接続文字列。この接続文字列はmongodb://プロトコルを使用します。

false

string

このクラスターに接続するために使用できるパブリック接続文字列。この接続文字列はmongodb+srv://プロトコルを使用します。

false

string

プライベートエンドポイントを認識する接続文字列。mongodb://プロトコルを使用し、プライベートエンドポイントを介して MongoDB Cloud に接続します。

false

[]オブジェクト

connectionStrings.privateEndpoint[n].connectionString または connectionStrings.privateEndpoint[n].srvConnectionString を使用するときに MongoDB Cloud に接続するプライベート endpoints を含むリスト。

false

string

プライベートエンドポイントを認識する接続文字列。mongodb+srv://プロトコルを使用し、プライベートエンドポイントを介して MongoDB Cloud に接続します。 mongodb+srvプロトコルは、ドメインネームシステム（DNS）内のホストのシードリストを検索するようにドライバーに指示します。このリストは、クラスター内のノードと同期します。接続文字列がこの Uniform Resource Identifier（URI）形式 を使用している場合、ノードが変更された場合にシードリストを追加したり、Uniform Resource Identifier（URI）を変更したりする必要はありません。アプリケーションがこの Uniform Resource Identifier（URI）形式をサポートしている場合は、使用します。変換できない場合は connectionStrings.privateEndpoint[n].connectionString を使用します。

false

string

シャーディングされたクラスター用に最適化されたプライベートエンドポイント対応の接続文字列。 mongodb+srv://プロトコルを使用してプライベートエンドポイント経由で MongoDB クラウドに接続します。接続文字列がこの 均等リソース識別子（URI）形式を使用している場合、ノードが変更された場合に 均等リソース識別子 （URI）を変更する必要はありません。アプリケーションと Atlas クラスターがサポートしている場合は、この Uniform Resource Identifier（URI）形式を使用します。一致しない場合は、 を使用して connectionStrings.privateEndpoint[n].srvConnectionString のドキュメントを参照してください。

false

string

MongoDB アプリケーションが接続するプロセス type。レプリカセットには MONGOD を使用し、シャーディングされたクラスターには MONGOS を使用します。

false

オブジェクト

このクラスターがリソーススケーリングを取り扱う方法を決定するオプション。

false

オブジェクト

リージョン内の読み取り専用ノードの現在のハードウェア仕様。

false

オブジェクト

このクラスターがリソーススケーリングを取り扱う方法を決定するオプション。

false

string

MongoDB Cloud がマルチテナント クラスターをプロビジョニングしたクラウド サービス プロバイダー。リソースは、providerName が TENANT で、かつ electableSpecs.instanceSize が M0、M2、または M5 の場合、このパラメータを返します。代わりに、M2 または M5 の instanceSize を使用すると Flex クラスターが作成されます。 M2 または M5 の instanceSize のサポートは、2026 年 1 月に終了します。このような構成には、Flex Cluster の作成 API を使用することをお勧めします。

false

オブジェクト

リージョン内の読み取り専用ノードの現在のハードウェア仕様。

false

オブジェクト

リージョン内の読み取り専用ノードの現在のハードウェア仕様。

false

オブジェクト

リージョン内の読み取り専用ノードの現在のハードウェア仕様。

false

オブジェクト

リージョンに配置されるすべての選択可能なノードのハードウェア仕様。選挙可能なノードはプライマリになることができ、ローカル読み取りを有効にできます。このオプションを指定しない場合、MongoDB Cloud はリージョンに選択可能なノードを配置しません。

false

integer

予備選挙が行われると、このリージョンに優先順位が与えられます。regionConfigs readOnlySpecsanalyticsSpecs0regionConfigspriority776に 、 、またはその両方がある場合は、この値を に設定します。複数の オブジェクト（クラスターがマルチリージョンまたはマルチクラウドである場合）には、降順の優先順位が必要です。最高の は です。例: 3 つのリージョンがある場合、優先順位はそれぞれ 、 、5 になります。選択可能なノードをサポートするためにさらに 2 つのリージョンを追加した場合、それらのリージョンの優先順位はそれぞれ4 と3 になります。

false

string

MongoDB Cloud がホストをプロビジョニングするクラウド サービス プロバイダー。専有クラスターを AWS、GCP、AZURE、または TENANT に設定します。

false

オブジェクト

リージョン内の読み取り専用ノードの現在のハードウェア仕様。

false

string

MongoDB クラスター ノードの物理的なロケーション選択したリージョンは、データベースにアクセスするクライアントのネットワークレイテンシに影響する可能性があります。リージョン名は、単一リージョン クラスターのレスポンスではのみ返されます。 MongoDB Cloud が専有クラスターを配置すると、そのプロバイダーとリージョンに VPC または VPC 接続が存在するかどうかを確認します。変換できない場合、MongoDB Cloud は配置の一部としてそれらを作成します。これにより、VPC にクラスレス ドメイン間ルーティング（CIDR）ブロックが割り当てられます。新しい VPC ピアリング接続を 1 つのクラスレス ドメイン間ルーティング（CIDR）ブロックとリージョンに制限するには、最初に接続を作成します。接続が開始された後にクラスターを配置します。 GCP クラスターと マルチリージョンクラスターでは、リージョンごとに 1 つの VPC ピアリング接続が必要です。 MongoDB ノードは、ピアリングされた VPC と通信するために、ノードと同じリージョンに存在するピアリング接続のみを使用できます。

false

integer

Azure がプロビジョニングしたクラスターに接続されたストレージに必要なターゲットスループット。次の場合は、このパラメーターを変更します。

• set replicationSpecs[n].regionConfigs[m].providerName : Azure を設定します。

• replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize を設定 : M40 以上（Mxx_NVME 階層は含まない）

1 秒あたりの最大入出力操作数（IOPS）は、選択した .instanceSize と .diskSizeGB によって異なります。このパラメータはデフォルトで、クラスター階層の標準 IOPS 値になります。この値を変更すると、クラスターのコストに影響します。

false

数値

インスタンスデータ ボリュームのストレージキャパシティー（ギガバイト単位）。この数を増やすと、キャパシティーが追加されます。この値は、すべてのシャードとノードタイプで等しくなければなりません。この値は、M0/M2/M5 クラスターでは構成できません。 replicationSpecsを設定する場合、MongoDB Cloud ではこのパラメータが必要になります。最小（10 GB）より小さいディスク サイズを指定する場合、このパラメータはデフォルトで最小ディスク サイズ値になります。ストレージ料金の計算は、デフォルト値を選択するかカスタム値を選択するかによって異なります。ディスクストレージの最大値は、選択したクラスターの最大 RAM の 50 倍を超えることはできません。より多くのストレージ容量が必要な場合は、クラスターを上位階層にアップグレードすることを検討してください。

false

string

AWS に接続するストレージのタイプ。

• STANDARD ボリュームタイプは、選択したボリューム サイズのデフォルトの入出力操作数（IOPS）を超えることはできません。

• PROVISIONED ボリュームタイプは、選択したボリュームサイズに許容される IOPS の範囲内に収まる必要があります。 NVMe クラスターの場合、この値を （PROVISIONED）に設定する必要があります。

false

string

このシャード内のこのリージョンのインスタンスサイズのハードウェア仕様。各インスタンスサイズには、デフォルトのストレージとメモリキャパシティーがあります。単一シャード内の選択可能なノードと読み取り専用ノード（「ベース ノード」と呼ばれる）では、同じインスタンスサイズを使用する必要があります。分析ノードは、シャード内の基本ノードとは独立して増やすできます。基本ノードと分析ノードはどちらも、他のシャードの同等のノードとは独立して増やすできます。

false

integer

リージョンに配置する MongoDB クラウド の指定されたタイプのノードの数。

false

integer

Azure がプロビジョニングしたクラスターに接続されたストレージに必要なターゲットスループット。次の場合は、このパラメーターを変更します。

• set replicationSpecs[n].regionConfigs[m].providerName : Azure を設定します。

• replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize を設定 : M40 以上（Mxx_NVME 階層は含まない）

1 秒あたりの最大入出力操作数（IOPS）は、選択した .instanceSize と .diskSizeGB によって異なります。このパラメータはデフォルトで、クラスター階層の標準 IOPS 値になります。この値を変更すると、クラスターのコストに影響します。

false

数値

インスタンスデータ ボリュームのストレージキャパシティー（ギガバイト単位）。この数を増やすと、キャパシティーが追加されます。この値は、すべてのシャードとノードタイプで等しくなければなりません。この値は、M0/M2/M5 クラスターでは構成できません。 replicationSpecsを設定する場合、MongoDB Cloud ではこのパラメータが必要になります。最小（10 GB）より小さいディスク サイズを指定する場合、このパラメータはデフォルトで最小ディスク サイズ値になります。ストレージ料金の計算は、デフォルト値を選択するかカスタム値を選択するかによって異なります。ディスクストレージの最大値は、選択したクラスターの最大 RAM の 50 倍を超えることはできません。より多くのストレージ容量が必要な場合は、クラスターを上位階層にアップグレードすることを検討してください。

false

string

AWS に接続するストレージのタイプ。

• STANDARD ボリュームタイプは、選択したボリューム サイズのデフォルトの入出力操作数（IOPS）を超えることはできません。

• PROVISIONED ボリュームタイプは、選択したボリュームサイズに許容される IOPS の範囲内に収まる必要があります。 NVMe クラスターの場合、この値を （PROVISIONED）に設定する必要があります。

false

string

このシャード内のこのリージョンのインスタンスサイズのハードウェア仕様。各インスタンスサイズには、デフォルトのストレージとメモリキャパシティーがあります。単一シャード内の選択可能なノードと読み取り専用ノード（「ベース ノード」と呼ばれる）では、同じインスタンスサイズを使用する必要があります。分析ノードは、シャード内の基本ノードとは独立して増やすできます。基本ノードと分析ノードはどちらも、他のシャードの同等のノードとは独立して増やすできます。

false

integer

リージョンに配置する MongoDB クラウド の指定されたタイプのノードの数。

false

integer

Azure がプロビジョニングしたクラスターに接続されたストレージに必要なターゲットスループット。次の場合は、このパラメーターを変更します。

• set replicationSpecs[n].regionConfigs[m].providerName : Azure を設定します。

• replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize を設定 : M40 以上（Mxx_NVME 階層は含まない）

1 秒あたりの最大入出力操作数（IOPS）は、選択した .instanceSize と .diskSizeGB によって異なります。このパラメータはデフォルトで、クラスター階層の標準 IOPS 値になります。この値を変更すると、クラスターのコストに影響します。

false

数値

インスタンスデータ ボリュームのストレージキャパシティー（ギガバイト単位）。この数を増やすと、キャパシティーが追加されます。この値は、すべてのシャードとノードタイプで等しくなければなりません。この値は、M0/M2/M5 クラスターでは構成できません。 replicationSpecsを設定する場合、MongoDB Cloud ではこのパラメータが必要になります。最小（10 GB）より小さいディスク サイズを指定する場合、このパラメータはデフォルトで最小ディスク サイズ値になります。ストレージ料金の計算は、デフォルト値を選択するかカスタム値を選択するかによって異なります。ディスクストレージの最大値は、選択したクラスターの最大 RAM の 50 倍を超えることはできません。より多くのストレージ容量が必要な場合は、クラスターを上位階層にアップグレードすることを検討してください。

false

string

AWS に接続するストレージのタイプ。

• STANDARD ボリュームタイプは、選択したボリューム サイズのデフォルトの入出力操作数（IOPS）を超えることはできません。

• PROVISIONED ボリュームタイプは、選択したボリュームサイズに許容される IOPS の範囲内に収まる必要があります。 NVMe クラスターの場合、この値を （PROVISIONED）に設定する必要があります。

false

string

このシャード内のこのリージョンのインスタンスサイズのハードウェア仕様。各インスタンスサイズには、デフォルトのストレージとメモリキャパシティーがあります。単一シャード内の選択可能なノードと読み取り専用ノード（「ベース ノード」と呼ばれる）では、同じインスタンスサイズを使用する必要があります。分析ノードは、シャード内の基本ノードとは独立して増やすできます。基本ノードと分析ノードはどちらも、他のシャードの同等のノードとは独立して増やすできます。

false

integer

リージョンに配置する MongoDB クラウド の指定されたタイプのノードの数。

false

integer

Azure がプロビジョニングしたクラスターに接続されたストレージに必要なターゲットスループット。次の場合は、このパラメーターを変更します。

• set replicationSpecs[n].regionConfigs[m].providerName : Azure を設定します。

• replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize を設定 : M40 以上（Mxx_NVME 階層は含まない）

1 秒あたりの最大入出力操作数（IOPS）は、選択した .instanceSize と .diskSizeGB によって異なります。このパラメータはデフォルトで、クラスター階層の標準 IOPS 値になります。この値を変更すると、クラスターのコストに影響します。

false

数値

インスタンスデータ ボリュームのストレージキャパシティー（ギガバイト単位）。この数を増やすと、キャパシティーが追加されます。この値は、すべてのシャードとノードタイプで等しくなければなりません。この値は、M0/M2/M5 クラスターでは構成できません。 replicationSpecsを設定する場合、MongoDB Cloud ではこのパラメータが必要になります。最小（10 GB）より小さいディスク サイズを指定する場合、このパラメータはデフォルトで最小ディスク サイズ値になります。ストレージ料金の計算は、デフォルト値を選択するかカスタム値を選択するかによって異なります。ディスクストレージの最大値は、選択したクラスターの最大 RAM の 50 倍を超えることはできません。より多くのストレージ容量が必要な場合は、クラスターを上位階層にアップグレードすることを検討してください。

false

string

AWS に接続するストレージのタイプ。

• STANDARD ボリュームタイプは、選択したボリューム サイズのデフォルトの入出力操作数（IOPS）を超えることはできません。

• PROVISIONED ボリュームタイプは、選択したボリュームサイズに許容される IOPS の範囲内に収まる必要があります。 NVMe クラスターの場合、この値を （PROVISIONED）に設定する必要があります。

false

string

このシャード内のこのリージョンのインスタンスサイズのハードウェア仕様。各インスタンスサイズには、デフォルトのストレージとメモリキャパシティーがあります。単一シャード内の選択可能なノードと読み取り専用ノード（「ベース ノード」と呼ばれる）では、同じインスタンスサイズを使用する必要があります。分析ノードは、シャード内の基本ノードとは独立して増やすできます。基本ノードと分析ノードはどちらも、他のシャードの同等のノードとは独立して増やすできます。

false

integer

リージョンに配置する MongoDB クラウド の指定されたタイプのノードの数。

false

integer

Azure がプロビジョニングしたクラスターに接続されたストレージに必要なターゲットスループット。次の場合は、このパラメーターを変更します。

• set replicationSpecs[n].regionConfigs[m].providerName : Azure を設定します。

• replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize を設定 : M40 以上（Mxx_NVME 階層は含まない）

1 秒あたりの最大入出力操作数（IOPS）は、選択した .instanceSize と .diskSizeGB によって異なります。このパラメータはデフォルトで、クラスター階層の標準 IOPS 値になります。この値を変更すると、クラスターのコストに影響します。

false

数値

インスタンスデータ ボリュームのストレージキャパシティー（ギガバイト単位）。この数を増やすと、キャパシティーが追加されます。この値は、すべてのシャードとノードタイプで等しくなければなりません。この値は、M0/M2/M5 クラスターでは構成できません。 replicationSpecsを設定する場合、MongoDB Cloud ではこのパラメータが必要になります。最小（10 GB）より小さいディスク サイズを指定する場合、このパラメータはデフォルトで最小ディスク サイズ値になります。ストレージ料金の計算は、デフォルト値を選択するかカスタム値を選択するかによって異なります。ディスクストレージの最大値は、選択したクラスターの最大 RAM の 50 倍を超えることはできません。より多くのストレージ容量が必要な場合は、クラスターを上位階層にアップグレードすることを検討してください。

false

string

AWS に接続するストレージのタイプ。

• STANDARD ボリュームタイプは、選択したボリューム サイズのデフォルトの入出力操作数（IOPS）を超えることはできません。

• PROVISIONED ボリュームタイプは、選択したボリュームサイズに許容される IOPS の範囲内に収まる必要があります。 NVMe クラスターの場合、この値を （PROVISIONED）に設定する必要があります。

false

string

true テナントインスタンスのサイズ。これは、非推奨のプロバイダー タイプやインスタンスサイズの下位互換性をサポートするために存在します。

false

string

この M0/M2/M5 階層クラスター内のインスタンスのハードウェア仕様。

false

integer

リージョンに配置する MongoDB クラウド の指定されたタイプのノードの数。

false

integer

Azure がプロビジョニングしたクラスターに接続されたストレージに必要なターゲットスループット。次の場合は、このパラメーターを変更します。

• set replicationSpecs[n].regionConfigs[m].providerName : Azure を設定します。

• replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize を設定 : M40 以上（Mxx_NVME 階層は含まない）

1 秒あたりの最大入出力操作数（IOPS）は、選択した .instanceSize と .diskSizeGB によって異なります。このパラメータはデフォルトで、クラスター階層の標準 IOPS 値になります。この値を変更すると、クラスターのコストに影響します。

false

数値

インスタンスデータ ボリュームのストレージキャパシティー（ギガバイト単位）。この数を増やすと、キャパシティーが追加されます。この値は、すべてのシャードとノードタイプで等しくなければなりません。この値は、M0/M2/M5 クラスターでは構成できません。 replicationSpecsを設定する場合、MongoDB Cloud ではこのパラメータが必要になります。最小（10 GB）より小さいディスク サイズを指定する場合、このパラメータはデフォルトで最小ディスク サイズ値になります。ストレージ料金の計算は、デフォルト値を選択するかカスタム値を選択するかによって異なります。ディスクストレージの最大値は、選択したクラスターの最大 RAM の 50 倍を超えることはできません。より多くのストレージ容量が必要な場合は、クラスターを上位階層にアップグレードすることを検討してください。

false

string

AWS に接続するストレージのタイプ。

• STANDARD ボリュームタイプは、選択したボリューム サイズのデフォルトの入出力操作数（IOPS）を超えることはできません。

• PROVISIONED ボリュームタイプは、選択したボリュームサイズに許容される IOPS の範囲内に収まる必要があります。 NVMe クラスターの場合、この値を （PROVISIONED）に設定する必要があります。

false

string

このシャード内のこのリージョンのインスタンスサイズのハードウェア仕様。各インスタンスサイズには、デフォルトのストレージとメモリキャパシティーがあります。単一シャード内の選択可能なノードと読み取り専用ノード（「ベース ノード」と呼ばれる）では、同じインスタンスサイズを使用する必要があります。分析ノードは、シャード内の基本ノードとは独立して増やすできます。基本ノードと分析ノードはどちらも、他のシャードの同等のノードとは独立して増やすできます。

false

integer

リージョンに配置する MongoDB クラウド の指定されたタイプのノードの数。

false