AtlasDeployment カスタム リソース

オブジェクト

AtlasDeployment のバックアップスケジュールへの参照。

false

オブジェクト

Atlas API の秘密キーと公開キーを含むシークレットの名前。

false

オブジェクト

高度な構成（v1.5）配置API https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api/clusters/

false

オブジェクト

externalProjectRef は親 AtlasプロジェクトID を保持します。"projectRef"フィールドと排他関係にあります。

false

オブジェクト

Flex クラスター API の構成。https://www.mongodb.com/ja-jp/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters

false

オブジェクト

ProcessArgs を使用すると、 高度な構成オプション を変更できます。

false

オブジェクト

projectRef は親の AtlasProjectリソースへの参照です。"externalProjectRef"フィールドと排他関係にあります。

false

オブジェクト

サーバーレス配置 API の構成。https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api/serverless-instances/DEPRECATED: サーバーレスインスタンスは廃止予定です。https://docub.mongodb.org/core/atlas-Flex-migration を参照してください詳細については、「 」を参照してください。

false

ブール値

upgradeToDedicatedに設定されている場合、Flex から専有クラスターへの移行がトリガーされます。ユーザー MUST は新しい専有クラスター構成を提供します。このフラグは、クラスターがすでに専有されている場合は無視されます。

false

string

Atlas に表示される高度な配置の名前。Atlas で配置が作成された後は、その名前を変更することはできません。ASCII 文字、数字、ハイフンのみを含めることができます。検証:

• auto == oldSelf: 配置の作成後に名前を変更できません

true

ブール値

配置でバックアップにクラウドバックアップが使用されるかどうかを示すフラグ。M10``+ 配置にのみ適用されます。

false

オブジェクト

この配置での Atlas 用の BI Connector の構成。Atlas 用の MongoDB Business Intelligence Connector（BI Connector）は、M10 以上の配置でのみ使用できます。

false

列挙

作成する配置のタイプ。replicationSpecs が設定されている場合、またはグローバル配置が配置されている場合は、パラメータが必要です。列挙: REPLICASET、SHARDED、GEOSHARDED

false

列挙

シャーディングされたクラスターを作成または更新するための コンフィギュレーションサーバー マネジメント モード 。列挙: ATLAS_MANAGED、FIXED_TO_DEDICATED

false

[]オブジェクト

ゾーンを地理的リージョンにマッピングするグローバルクラスター パラメーターが格納されたリスト。

false

integer

ホストのルート ボリュームのキャパシティー（ギガバイト単位）。この数値を増やして、キャパシティーを追加します。最大値は 4096（4 TB）です。この値は正の整数である必要があります。replicationSpecs が設定されている場合は パラメータが必要です。最小: 0 最大: 4096

false

列挙

保管時の暗号化を提供するクラウド サービス プロバイダー。列挙: AWS、GCP、AZURE、NONE

false

[]オブジェクト

配置にタグを付けて分類するキーと値のペアのコレクション。各キーと値の最大長は 255 文字です。DEPRECATED: クラスター labels は非推奨であり、将来のリリースで削除される予定です。代わりに リソース タグ を使用することを強くお勧めています。

false

[]オブジェクト

作成する指定されたグローバルクラスターにマネージド名前空間を作成するための情報を含むリスト。

false

string

MongoDB クラスターのメジャー バージョン。バイナリ メジャー バージョンに設定します。

false

string

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

false

ブール値

配置を一時停止するかどうかを示すフラグ。

false

ブール値

配置で継続的なクラウドバックアップを使用することを示すフラグ。

false

[]オブジェクト

配置リージョンの構成。

false

string

MongoDB Atlas クラスターが使用するルート認証局。

false

[]オブジェクト

検索インデックスを記述するフィールドを持つ SearchIndex オブジェクトの配列。

false

[]オブジェクト

クラスターの検索するノードの設定。現在は、最大で 1 つの検索するノード構成を定義できます。

false

[]オブジェクト

リソースタグ付け 用のキーと値のペア。

false

ブール値

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

false

string

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

false

string

このグローバルクラスターで管理する、人間が判読できるラベル collection。

true

string

このグローバルクラスターで管理する、人間が判読可能なデータベースのラベル。

true

string

コレクションをシャードに分割するために使用されるデータベース パラメーター。グローバルクラスターには複合シャードキーが必要です。この複合シャードキーは、ロケーション パラメーターとユーザーが選択したカスタムキーを組み合わせたものです。

false

ブール値

指定されたコレクションのカスタムシャードキーを誰かがハッシュされたかどうかを示すフラグ。この値が false に設定されている場合、MongoDB クラウドは範囲シャーディングを使用します。

false

ブール値

誰かがカスタムシャードキーをハッシュされたかどうかを示すフラグ。このパラメーターが false を返す場合、このクラスターは範囲シャーディングを使用します。

false

integer

空のコレクションをハッシュされたシャードキーでシャーディングときに最初に作成するチャンクの最小数。最大値は 8192 です。

false

ブール値

MongoDB クラウドが、空のコレクションや存在しないコレクションの初期チャンクを作成して配布するかどうかを示すフラグ。MongoDB クラウドは、コレクションに定義されたゾーンとゾーン範囲に基づいてデータを配布します。

false

オブジェクト

リージョンに配置された分析ノードのハードウェア仕様。

false

オブジェクト

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

false

列挙

マルチテナント配置のホストするがプロビジョニングされるクラウドサービスプロバイダー。この設定は "providerName" : "TENANT" および "providerSetting.``instanceSizeName``" の場合にのみ機能します。: M2 または M5。それ以外の場合は、"providerName" 値と等しくなければなりません。列挙: AWS、GCP、AZURE

false

オブジェクト

リージョンに配置されたノードのハードウェア仕様。

false

integer

プライマリ選挙が行われると、このリージョンに優先順位が与えられます。regionConfigs に readOnlySpecs、analyticsSpecs、またはその両方がある場合は、この値を 0 に設定します。複数の regionConfigs オブジェクト（クラスターがマルチリージョンまたはマルチクラウドである場合）には、降順の優先順位が必要です。最高の priority は 7 です

false

列挙

Enum: AWS, GCP, AZURE, TENANT, SERVERLESS

false

オブジェクト

リージョンに配置された読み取り専用ノードのハードウェア仕様。

false

string

MongoDB 配置の物理的なロケーション。選択したリージョンは、データベースにアクセスするクライアントのネットワークレイテンシに影響する可能性があります。

false

string

1 つ以上の Atlas Search インデックスを持つコレクションを含むデータベースを識別する、人間が判読できるラベル。

true

string

1 つ以上の Atlas Search インデックスを含むコレクションを識別する、人間が判読できるラベル。

true

string

このインデックスを識別する、人間が判読できるラベル。 配置に対して一意である必要があります。

true

列挙

インデックスのタイプ 。列挙: 検索する、vectorSearch

true

オブジェクト

Atlas searchインデックス構成。

false

オブジェクト

Atlasベクトル検索インデックス構成。

false

string

このクラスターに対して設定された読み取り操作に対して MongoDB から要求される確認応答のデフォルトレベルを示す String。

false

string

このクラスターに対して設定された書き込み (write) 操作に対して MongoDB から要求される確認応答のデフォルトレベルを示す String。

false

ブール値

すべてのインデックスエントリが 1024 バイトを超えるドキュメントを挿入または更新するときに、操作を失敗させエラーを返すかどうかを示すフラグ。これが false に設定されている場合、 mongod はこの制限を超えるドキュメントを書込みますが、インデックスは作成しません。

false

ブール値

JavaScript をサーバー側で実行する操作の実行をクラスターが許可しているかどうかを示すフラグ。

false

string

着信接続に対してクラスターが受け入れる最小の TLS バージョンを示す String。TLS 1.0 または 1.1 を使用するクラスターでは、最小の TLSプロトコルバージョンとして TLS 1.2 を設定することを検討する必要があります。

false

ブール値

結果を返すためにコレクションスキャンが必要なクエリについて、クラスターで実行が無効化されているかどうかを示すフラグ。

false

string

クラスターのoplogの最小保持ウィンドウ（単位は時間）。null 値の場合、MongoDB クラウドが計算するデフォルトの最小oplog windowをクラスターが使用することを示します。

false

integer

クラスターのoplogのストレージ制限をメガバイト単位で示す数値。null 値の場合、Atlas が計算するデフォルトのoplogサイズをクラスターが使用することを示します。形式: int64

false

integer

スキーマ情報の収集時にサンプルするデータベースあたりのドキュメント数を示す数値。形式: int64

false

integer

mongosqld プロセスがデータをサンプルしてリレーショナルスキーマを作成する間隔を秒単位で示す数値。形式: int64

false

string

Atlas に表示されるサーバーレス配置の名前。Atlas で配置が作成された後は、その名前を変更することはできません。ASCII 文字、数字、ハイフンのみを含めることができます。

true

オブジェクト

MongoDB が実行されるプロビジョニングされたホストするの構成。利用可能なオプションは、クラウドサービス プロバイダーに固有です。

true

オブジェクト

serverlessBackupOptions

false

[]オブジェクト

サーバーレスインスタンスのプライベートエンドポイント構成が格納されたリスト。DEPRECATED: サーバーレス プライベートエンドポイントは廃止予定です。https://docub.mongodb.org/core/atlas-Flex-migration詳細については、「 」を参照してください。

false

[]オブジェクト

リソースタグ付け 用のキーと値のペア。

false

ブール値

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

false

列挙

Atlas がホストするホストをプロビジョニングするクラウドサービスプロバイダー。列挙: AWS、GCP、AZURE、TENANT、SERVERLESS

true

オブジェクト

配置を増やすことができるインスタンスサイズの範囲。DEPRECATED: このフィールドの値は効果がありません。

false

列挙

マルチテナント配置のホストするがプロビジョニングされるクラウドサービスプロバイダー。この設定は "providerSetting.``providerName`` の場合にのみ機能します。: "TENANT" および "providerSetting.``instanceSizeName``: M2 または M5。列挙: AWS、GCP、AZURE

false

integer

AWSストレージのディスク IOPS 設定。クラウドサービス プロバイダーとして AWS を選択した場合にのみ を設定します。DEPRECATED: このフィールドの値は効果がありません。形式: int64

false

string

クラウドサービス プロバイダーとしてAzureを選択した場合の、ディスクのタイプ。DEPRECATED: このフィールドの値は効果がありません。

false

ブール値

Amazon EBS暗号化機能が、ボリューム内の保管中のデータと、ボリュームと配置の間を移動するデータの両方について、ホストのルートボリュームを暗号化するかどうかを示すフラグ。DEPRECATED: このフィールドの値は効果がありません。

false

string

Atlas にはさまざまな配置階層があり、それぞれにデフォルトのストレージキャパシティーと RAM サイズがあります。選択した配置は、配置階層内のすべてのデータを保持するホストに使用されます。DEPRECATED: このフィールドの値は効果がありません。

false

string

MongoDB 配置の物理的なロケーション。選択したリージョンは、データベースにアクセスするクライアントのネットワークレイテンシに影響する可能性があります。

false

列挙

AWSストレージのディスク IOPS 設定。クラウドサービス プロバイダーとして AWS を選択した場合にのみ を設定します。DEPRECATED: このフィールドの値は効果がありません。列挙: STANDARD、PROVISIONED

false

[]オブジェクト

条件は、Atlas カスタム リソースの現在の状態を示すステータスのリストです

true

オブジェクト

ConnectionStrings は、アプリケーションがこのクラスターに接続するために使用する接続文字列のセットです。

false

オブジェクト

ゾーンを地理的リージョンにマッピングするためのキーと値のペアが格納されたリスト。これらのペアは、ISO3166-1a2 ロケーション コードと、可能な場合は ISO 3166-2 下位分類コードを、一意の 24- 16進数文字列にマッピングします。カスタムゾーン。

false

[]オブジェクト

グローバルクラスターの名前空間が格納されたリスト。このクラスターは MongoDB Atlas が管理します。

false

string

MongoDBVersion は、クラスターが実行する MongoDB のバージョンです（ ）。形式。

false

string

MongoURIUpdated は、接続文字列が最後に更新されたときの UTC の ISO 8601 の日付と時刻形式のタイムスタンプです。他の値を更新すると、接続文字列が変更されます。

false

integer

ObservedGeneration は、Atlas 演算子が認識しているリソース仕様の生成を示します。Atlas 演算子は、このフィールドを「メタデータ.generate 」の値に更新します。が、リソースの調整を開始するとすぐに 表示されます。形式: int64

false

[]オブジェクト

MongoDB クラウドが指定された MongoDBデータベースでデータを複製する方法を説明する詳細。この配列には、各シャードのノード構成を表すシャードごとに 1 つのオブジェクトが含まれます。レプリカセットの場合、ノード構成を表すオブジェクトは 1 つだけです。

false

[]オブジェクト

SearchIndexes には、プロジェクトに対して構成された検索インデックスのステータスのリストが含まれています。

false

[]オブジェクト

ServerlessPrivateEndpoints には、サーバーレス配置用に構成されたプライベートエンドポイントのリストが含まれています。

false

string

StateName クラスターの現在の状態である。可能な状態は次のとおりです。IDLE、CREATING、UPDATING、DELETING、DELETED、REPAIRING

false

string

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

true

string

Atlas カスタム リソース条件のタイプ。

true

string

条件があるステータスから別のステータスに最後に移行した時刻。ISO 8601形式で表されます。形式: 日時

false

string

移行に関する詳細を提供する message。

false

string

条件の最後の移行の reason。

false

string

このクラスターに接続するために構成した各インターフェース VPC エンドポイントとなる接続されたデバイスの、ネットワークピアリングエンドポイント対応 mongodb:// 接続文字列。Atlas は、このクラスターへのネットワークピアリング接続を作成した場合にのみこのパラメーターを返します。

false

[]オブジェクト

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

false

string

このクラスターに接続するように構成した各インターフェース VPC エンドポイントとなる接続されたデバイス対応のピアリング mongodb+srv:// 接続文字列。Atlas は、このクラスターへのネットワークピアリング接続を作成した場合にのみこのパラメーターを返します。ドライバーがサポートしている場合は、この URI形式を使用します。そうでない場合は、connectionStrings.private を使用します。

false

string

このクラスターのパブリック mongodb://接続文字列。

false

string

このクラスターの公開 mongodb+srv://接続文字列。

false

string

このプライベートエンドポイントのプライベートエンドポイントを認識する mongodb://接続文字列。

false

[]オブジェクト

connectionStrings.``privateEndpoint``[n].`` connectionString`` または connectionStrings.``privateEndpoint``[n].``srvConnectionString`` を使用する場合に Atlas に接続するプライベートエンドポイント。

false

string

このプライベートエンドポイントのプライベートエンドポイントを認識する mongodb+srv://接続文字列。

false

string

シャーディングされたクラスター用に最適化されたプライベートエンドポイント対応の接続文字列。 mongodb+srv://プロトコルを使用してプライベートエンドポイント経由で MongoDB クラウドに接続します。

false

string

Atlas から返される接続文字列を使用して接続する MongoDB プロセスのタイプ:レプリカセットの場合は MONGOD、シャーディングされたクラスターの場合は MONGOS

false

string

このグローバルクラスターで管理する、人間が判読できるラベル collection。

true

string

このグローバルクラスターで管理する、人間が判読可能なデータベースのラベル。

true

string

コレクションをシャードに分割するために使用されるデータベース パラメーター。グローバルクラスターには複合シャードキーが必要です。この複合シャードキーは、ロケーション パラメーターとユーザーが選択したカスタムキーを組み合わせたものです。

false

string

失敗したマネージド名前空間のエラー メッセージ。

false

ブール値

指定されたコレクションのカスタムシャードキーを誰かがハッシュされたかどうかを示すフラグ。この値が false に設定されている場合、MongoDB Atlas は 範囲シャーディングを使用します。

false

ブール値

誰かがカスタムシャードキーをハッシュされたかどうかを示すフラグ。このパラメーターが false を返す場合、このクラスターは範囲シャーディングを使用します。

false

integer

空のコレクションをハッシュされたシャードキーでシャーディングするときに最初に作成するチャンクの最小数。

false

ブール値

MongoDB クラウドが、空のコレクションや存在しないコレクションの初期チャンクを作成して配布するかどうかを示すフラグ。MongoDB Atlas は、コレクションに定義されたゾーンとゾーン範囲に基づいてデータを配布します。

false

string

マネージド名前空間のステータス。

false

string

ID は、サーバーレス PrivateLink サービスの識別子です。

false

string

CloudProviderEndpointID は、クラウドプロバイダーエンドポイントとなる接続されたデバイスの識別子です。

false

string

EndpointServiceName は、AWS 内の PrivateLink エンドポイントとなる接続されたデバイス サービスの名前です。エンドポイントとなる接続されたデバイスの作成中に null を返します。

false

string

ErrorMessage は、サーバーレス PrivateLink Service が作成または接続に失敗した場合のエラー メッセージです。

false

string

名前は、サーバーレス PrivateLink サービスの name です。一意である必要があります。

false

string

PrivateEndpointIPAddress は、このプライベートエンドポイント サービスに誰かが追加されたAzure VNet 内のプライベートエンドポイントの IPv4 アドレスです。

false

string

PrivateLinkServiceResourceID は、MongoDB クラウドが管理するAzure Private Link Serviceを識別するルート相対パスです。MongoDB クラウドは、エンドポイントとなる接続されたデバイスサービスの作成中に null を返します。

false

string

ProviderName は、 クラウドプロバイダーを識別する、人間が判読できるラベルです。値には AWS または AZURE が含まれます。

false

string

AWSサーバーレス PrivateLink 接続のステータス。

false