1 つの S3 oplog 構成の更新

ブール値

必須

MongoDB Ops Manager で S3 互換ストレージを使用するためのサービス利用規約に同意したかどうかを示すフラグ。S3 互換ストレージ ストアを作成するには、これを true に設定する必要があります。

これをfalseに設定すると、MongoDB Ops Manager はエラーを返します。 エラーには、 MongoDB Ops Managerが S3 互換ストレージストアを作成できないことが記載されています。

ブール値

任意

このデータ ストアにバックアップ ジョブを割り当てられるかどうかを示すフラグ。

string

条件付き

Amazon Web Services アクセス キー ID で指定された S3互換ストレージ バケットにアクセスできる s3BucketName。

"s3AuthMethod" : "IAM_ROLE"の場合は、 awsAccessKeyを含める必要はありません。

string

条件付き

<s3BucketName> で指定された S3 互換のストレージバケットにアクセスできる Amazon Web Services シークレットアクセスキー。

"s3AuthMethod" : "IAM_ROLE"の場合は、 awsSecretKeyを含める必要はありません。

配列

任意

関連付けられている S3 互換ストレージ バケットに適用される有効な証明機関証明書のリスト。

string

任意

認証局PEMファイルを識別する名前。

string

任意

証明機関チェーンを構成する証明機関PEMファイルの内容。

ブール値

必須

S3互換ストレージに接続する際に、HTTP proxy を使用するかどうかを示します。S3互換のストレージ oplog ストアを作成または更新するためのすべてのリクエストには、必ずこのフィールドを含める必要があります。MongoDB Ops Manager で HTTP proxy を使用するように設定していない場合でも。

ブール値

任意

この S 3互換ストレージ oplog ストアのユーザー名とパスワードが認証情報ツールを使用して暗号化されているかどうかを示すフラグ。

文字列の配列

任意

がどの MongoDB Ops ManagerS ストアに割り当てることができる バックアップジョブ3oplog を管理するためのタグの配列。

これらのタグを設定すると、この S 3互換ストレージ oplog ストアが処理できるバックアップ ジョブが制限されます。 省略した場合、この S 3互換ストレージ oplog ストアは、ジョブをフィルタリングするためにラベルを使用しないプロジェクトのバックアップジョブのみを処理できます。

オブジェクト

任意

任意。 このストアの OIDC 認証設定。oidc オブジェクトは次のフィールドを受け入れます。

• enabled: ブール値。このストアの OIDC 認証を有効化します。

• method: string.callback、azure、gcp、k8sのいずれか。

• tokenUri: string.IdP エンドポイントとなる接続されたデバイス。method が callback の場合は必須です。

• clientId: string.IdP に登録されているクライアント ID。method が callback の場合は必須です。method が azure の場合は任意です。

• clientSecret: string.IdP に登録されたクライアント シークレット。method が callback の場合は必須です。既存のストアを編集してこのフィールドを省略するか、前の GET リクエストによって返された抽出値を提出すると、MongoDB Ops Manager は既存のシークレットを保持します。

• scope: string.IdP からリクエストされた OAuth2 スコープ。method が callback の場合にのみ使用。

• tokenResource: string.ワークロードアイデンティトークンのオーディエンスまたはリソース識別子。method が azure または gcp の場合は必須です。この値は、ターゲット MongoDB 配置の oidcIdentityProviders 設定にある、この IdP に設定された audience と一致する必要があります。

callback、azure、gcp、k8s メソッドでは、必要なフィールドが全て同じとは限りません。azure、gcp、k8s メソッドでは clientSecret は必要ありません。

oidc.enabled が true の場合は、ストアの uri フィールドにホストと接続オプションのみを提供します。MongoDB Ops Manager は、URI に埋め込まれたユーザー名またはパスワードを無視します。

保存 (する)の認証メカニズムを OIDC から別の認証メカニズムに切り替えるには、oidc オブジェクトを省略する代わりにリクエストで oidc: {enabled: false} を提出します。

このストアを更新し、リクエストから oidc オブジェクトを除外すると、MongoDB Ops Manager は既存の OIDC 設定を削除します。既存の設定を維持するには、すべての更新リクエストに現在の oidc オブジェクトを含めてください。

clientSecret は唯一の例外です。oidc オブジェクトから clientSecret を省略するか、前の GET リクエストによって返された抽出値を送信すると、MongoDB Ops Manager は既存のシークレットを保持します。シークレットを変更するには、新しいプレーンテキスト値を送信します。

ブール値

必須

このエンドポイントのスタイルを示すフラグ。

• true: パス形式のURLエンドポイントとなる接続されたデバイス。例: s3.amazonaws.com/<bucket>。

• false: 仮想ホスト スタイルのURLエンドポイントとなる接続されたデバイス例: <bucket>.s3.amazonaws.com。

S3 互換のストレージバケットURL規則を確認するには、 AWS S3 ドキュメントを参照してください。

string

任意

s3bucketNameで指定された S3 互換ストレージ バケットへのアクセスを許可するために使用されるメソッド。

MongoDB Ops Manager は、次の値を受け入れます。

• KEYS または None: MongoDB Ops Manager は、awsAccessKey と awsSecretKey を使用して、s3BucketName で指定された S3 互換のストレージ バケットへのアクセスを認可します。

• IAM_ROLE: Ops Manager uses an AWS IAM role to authorize access to S3-compatible storage bucket specified in s3BucketName. awsAccessKey and awsSecretKey fields are ignored. To learn more, see the AWS documentation

string

必須

URL。この S3 互換ストレージ バケットにアクセスするために使用される URLです。

string

必須

S 3互換ストレージ oplog ストアをホストする S 3互換ストレージ バケットの名前。

数値

必須

この S 3互換ストレージ oplog ストアへの最大接続数を示す正の整数。

string

条件付き

S3 互換ストレージ バケットが存在するリージョン。

このフィールドは、お使いの S3互換ストレージ保存 (する)の s3BucketEndpoint がリージョンスコープをサポートしていない場合にのみ使用します。AWS S3 バケットでは、このフィールドを使用しないでください。

ブール値

必須

この S3 互換ストレージoplogストアが サーバー側暗号化を有効にしているかどうかを示すフラグ。

string

必須

この S 3互換ストレージ oplog ストアにアクセスできる<hostname:port>形式のホストのカンマ区切りリスト。

ブール値

任意

この S 3互換ストレージ oplog ストアがTLSを使用して暗号化された接続のみを受け入れるかどうかを示すフラグ。

string

任意

この oplog ストアに使用される書込み保証 (write concern)。

MongoDB Ops Manager は、次の値を受け入れます。

• ACKNOWLEDGED

• W2

• JOURNALED

• MAJORITY

MongoDB の書込み (write) 確認応答レベルの詳細については、「 書込み保証 (write concern) 」を参照してください。