Discuss with expertTry it for free
© 2026 Direct Cursus Technology L.L.C.

Managed Service for MongoDB API, REST: Cluster.Update

Written by
Updated at June 1, 2026

Updates the specified MongoDB cluster.

HTTP request

PATCH https://mdb.api.cloud.yandex.net/managed-mongodb/v1/clusters/{clusterId}

Path parameters

Field

Description

clusterId

string

Required field. ID of the MongoDB Cluster resource to update.
To get the MongoDB cluster ID use a ClusterService.List request.

The maximum string length in characters is 50.

Body parameters

{
  "updateMask": "string",
  "description": "string",
  "labels": "object",
  "configSpec": {
    "version": "string",
    "featureCompatibilityVersion": "string",
    // Includes only one of the fields `mongodbSpec_3_6`, `mongodbSpec_4_0`, `mongodbSpec_4_2`, `mongodbSpec_4_4`, `mongodbSpec_5_0`, `mongodbSpec_6_0`, `mongodbSpec_4_4Enterprise`, `mongodbSpec_5_0Enterprise`, `mongodbSpec_6_0Enterprise`
    "mongodbSpec_3_6": {
      "mongod": {
        "config": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              },
              "collectionConfig": {
                "blockCompressor": "string"
              }
            },
            "journal": {
              "enabled": "boolean",
              "commitInterval": "string"
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string"
          },
          "net": {
            "maxIncomingConnections": "string"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongocfg": {
        "config": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              }
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string"
          },
          "net": {
            "maxIncomingConnections": "string"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongos": {
        "config": {
          "net": {
            "maxIncomingConnections": "string"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongoinfra": {
        "configMongos": {
          "net": {
            "maxIncomingConnections": "string"
          }
        },
        "configMongocfg": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              }
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string"
          },
          "net": {
            "maxIncomingConnections": "string"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      }
    },
    "mongodbSpec_4_0": {
      "mongod": {
        "config": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              },
              "collectionConfig": {
                "blockCompressor": "string"
              }
            },
            "journal": {
              "commitInterval": "string"
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string"
          },
          "net": {
            "maxIncomingConnections": "string"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongocfg": {
        "config": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              }
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string"
          },
          "net": {
            "maxIncomingConnections": "string"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongos": {
        "config": {
          "net": {
            "maxIncomingConnections": "string"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongoinfra": {
        "configMongos": {
          "net": {
            "maxIncomingConnections": "string"
          }
        },
        "configMongocfg": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              }
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string"
          },
          "net": {
            "maxIncomingConnections": "string"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      }
    },
    "mongodbSpec_4_2": {
      "mongod": {
        "config": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              },
              "collectionConfig": {
                "blockCompressor": "string"
              },
              "indexConfig": {
                "prefixCompression": "boolean"
              }
            },
            "journal": {
              "commitInterval": "string"
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string",
            "slowOpSampleRate": "number"
          },
          "net": {
            "maxIncomingConnections": "string",
            "compression": {
              "compressors": [
                "string"
              ]
            }
          },
          "setParameter": {
            "enableFlowControl": "boolean"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongocfg": {
        "config": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              }
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string"
          },
          "net": {
            "maxIncomingConnections": "string"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongos": {
        "config": {
          "net": {
            "maxIncomingConnections": "string",
            "compression": {
              "compressors": [
                "string"
              ]
            }
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongoinfra": {
        "configMongos": {
          "net": {
            "maxIncomingConnections": "string",
            "compression": {
              "compressors": [
                "string"
              ]
            }
          }
        },
        "configMongocfg": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              }
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string"
          },
          "net": {
            "maxIncomingConnections": "string"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      }
    },
    "mongodbSpec_4_4": {
      "mongod": {
        "config": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              },
              "collectionConfig": {
                "blockCompressor": "string"
              },
              "indexConfig": {
                "prefixCompression": "boolean"
              }
            },
            "journal": {
              "commitInterval": "string"
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string",
            "slowOpSampleRate": "number"
          },
          "net": {
            "maxIncomingConnections": "string",
            "compression": {
              "compressors": [
                "string"
              ]
            }
          },
          "setParameter": {
            "enableFlowControl": "boolean"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongocfg": {
        "config": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              }
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string"
          },
          "net": {
            "maxIncomingConnections": "string"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongos": {
        "config": {
          "net": {
            "maxIncomingConnections": "string",
            "compression": {
              "compressors": [
                "string"
              ]
            }
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongoinfra": {
        "configMongos": {
          "net": {
            "maxIncomingConnections": "string",
            "compression": {
              "compressors": [
                "string"
              ]
            }
          }
        },
        "configMongocfg": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              }
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string"
          },
          "net": {
            "maxIncomingConnections": "string"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      }
    },
    "mongodbSpec_5_0": {
      "mongod": {
        "config": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              },
              "collectionConfig": {
                "blockCompressor": "string"
              },
              "indexConfig": {
                "prefixCompression": "boolean"
              }
            },
            "journal": {
              "commitInterval": "string"
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string",
            "slowOpSampleRate": "number"
          },
          "net": {
            "maxIncomingConnections": "string",
            "compression": {
              "compressors": [
                "string"
              ]
            }
          },
          "setParameter": {
            "enableFlowControl": "boolean",
            "minSnapshotHistoryWindowInSeconds": "string"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongocfg": {
        "config": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              }
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string"
          },
          "net": {
            "maxIncomingConnections": "string"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongos": {
        "config": {
          "net": {
            "maxIncomingConnections": "string",
            "compression": {
              "compressors": [
                "string"
              ]
            }
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongoinfra": {
        "configMongos": {
          "net": {
            "maxIncomingConnections": "string",
            "compression": {
              "compressors": [
                "string"
              ]
            }
          }
        },
        "configMongocfg": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              }
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string"
          },
          "net": {
            "maxIncomingConnections": "string"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      }
    },
    "mongodbSpec_6_0": {
      "mongod": {
        "config": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              },
              "collectionConfig": {
                "blockCompressor": "string"
              },
              "indexConfig": {
                "prefixCompression": "boolean"
              }
            },
            "journal": {
              "commitInterval": "string"
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string",
            "slowOpSampleRate": "number"
          },
          "net": {
            "maxIncomingConnections": "string",
            "compression": {
              "compressors": [
                "string"
              ]
            }
          },
          "setParameter": {
            "enableFlowControl": "boolean",
            "minSnapshotHistoryWindowInSeconds": "string"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongocfg": {
        "config": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              }
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string"
          },
          "net": {
            "maxIncomingConnections": "string"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongos": {
        "config": {
          "net": {
            "maxIncomingConnections": "string",
            "compression": {
              "compressors": [
                "string"
              ]
            }
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongoinfra": {
        "configMongos": {
          "net": {
            "maxIncomingConnections": "string",
            "compression": {
              "compressors": [
                "string"
              ]
            }
          }
        },
        "configMongocfg": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              }
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string"
          },
          "net": {
            "maxIncomingConnections": "string"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      }
    },
    "mongodbSpec_4_4Enterprise": {
      "mongod": {
        "config": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              },
              "collectionConfig": {
                "blockCompressor": "string"
              },
              "indexConfig": {
                "prefixCompression": "boolean"
              }
            },
            "journal": {
              "commitInterval": "string"
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string",
            "slowOpSampleRate": "number"
          },
          "net": {
            "maxIncomingConnections": "string",
            "compression": {
              "compressors": [
                "string"
              ]
            }
          },
          "security": {
            "enableEncryption": "boolean",
            "kmip": {
              "serverName": "string",
              "port": "string",
              "serverCa": "string",
              "clientCertificate": "string",
              "keyIdentifier": "string"
            }
          },
          "auditLog": {
            "filter": "string"
          },
          "setParameter": {
            "auditAuthorizationSuccess": "boolean",
            "enableFlowControl": "boolean"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongocfg": {
        "config": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              }
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string"
          },
          "net": {
            "maxIncomingConnections": "string"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongos": {
        "config": {
          "net": {
            "maxIncomingConnections": "string",
            "compression": {
              "compressors": [
                "string"
              ]
            }
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongoinfra": {
        "configMongos": {
          "net": {
            "maxIncomingConnections": "string",
            "compression": {
              "compressors": [
                "string"
              ]
            }
          }
        },
        "configMongocfg": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              }
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string"
          },
          "net": {
            "maxIncomingConnections": "string"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      }
    },
    "mongodbSpec_5_0Enterprise": {
      "mongod": {
        "config": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              },
              "collectionConfig": {
                "blockCompressor": "string"
              },
              "indexConfig": {
                "prefixCompression": "boolean"
              }
            },
            "journal": {
              "commitInterval": "string"
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string",
            "slowOpSampleRate": "number"
          },
          "net": {
            "maxIncomingConnections": "string",
            "compression": {
              "compressors": [
                "string"
              ]
            }
          },
          "security": {
            "enableEncryption": "boolean",
            "kmip": {
              "serverName": "string",
              "port": "string",
              "serverCa": "string",
              "clientCertificate": "string",
              "keyIdentifier": "string"
            }
          },
          "auditLog": {
            "filter": "string",
            "runtimeConfiguration": "boolean"
          },
          "setParameter": {
            "auditAuthorizationSuccess": "boolean",
            "enableFlowControl": "boolean",
            "minSnapshotHistoryWindowInSeconds": "string"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongocfg": {
        "config": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              }
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string"
          },
          "net": {
            "maxIncomingConnections": "string"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongos": {
        "config": {
          "net": {
            "maxIncomingConnections": "string",
            "compression": {
              "compressors": [
                "string"
              ]
            }
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongoinfra": {
        "configMongos": {
          "net": {
            "maxIncomingConnections": "string",
            "compression": {
              "compressors": [
                "string"
              ]
            }
          }
        },
        "configMongocfg": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              }
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string"
          },
          "net": {
            "maxIncomingConnections": "string"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      }
    },
    "mongodbSpec_6_0Enterprise": {
      "mongod": {
        "config": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              },
              "collectionConfig": {
                "blockCompressor": "string"
              },
              "indexConfig": {
                "prefixCompression": "boolean"
              }
            },
            "journal": {
              "commitInterval": "string"
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string",
            "slowOpSampleRate": "number"
          },
          "net": {
            "maxIncomingConnections": "string",
            "compression": {
              "compressors": [
                "string"
              ]
            }
          },
          "security": {
            "enableEncryption": "boolean",
            "kmip": {
              "serverName": "string",
              "port": "string",
              "serverCa": "string",
              "clientCertificate": "string",
              "keyIdentifier": "string"
            }
          },
          "auditLog": {
            "filter": "string",
            "runtimeConfiguration": "boolean"
          },
          "setParameter": {
            "auditAuthorizationSuccess": "boolean",
            "enableFlowControl": "boolean",
            "minSnapshotHistoryWindowInSeconds": "string"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongocfg": {
        "config": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              }
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string"
          },
          "net": {
            "maxIncomingConnections": "string"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongos": {
        "config": {
          "net": {
            "maxIncomingConnections": "string",
            "compression": {
              "compressors": [
                "string"
              ]
            }
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongoinfra": {
        "configMongos": {
          "net": {
            "maxIncomingConnections": "string",
            "compression": {
              "compressors": [
                "string"
              ]
            }
          }
        },
        "configMongocfg": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              }
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string"
          },
          "net": {
            "maxIncomingConnections": "string"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      }
    },
    // end of the list of possible fields
    "backupWindowStart": {
      "hours": "integer",
      "minutes": "integer",
      "seconds": "integer",
      "nanos": "integer"
    },
    "backupRetainPeriodDays": "string",
    "performanceDiagnostics": {
      "profilingEnabled": "boolean"
    },
    "access": {
      "dataLens": "boolean",
      "webSql": "boolean",
      "dataTransfer": "boolean"
    },
    "mongodb": {
      "mongod": {
        "config": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number",
                "cacheSize": "number"
              },
              "collectionConfig": {
                "blockCompressor": "string"
              },
              "indexConfig": {
                "prefixCompression": "boolean"
              }
            },
            "journal": {
              "commitInterval": "string"
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string",
            "slowOpSampleRate": "number"
          },
          "net": {
            "maxIncomingConnections": "string",
            "compression": {
              "compressors": [
                "string"
              ]
            }
          },
          "security": {
            "enableEncryption": "boolean",
            "kmip": {
              "serverName": "string",
              "port": "string",
              "serverCa": "string",
              "clientCertificate": "string",
              "keyIdentifier": "string"
            }
          },
          "auditLog": {
            "filter": "string",
            "runtimeConfiguration": "boolean"
          },
          "setParameter": {
            "auditAuthorizationSuccess": "boolean",
            "enableFlowControl": "boolean",
            "minSnapshotHistoryWindowInSeconds": "string",
            "flowControlTargetLagSeconds": "string",
            "flowControlWarnThresholdSeconds": "string",
            "migrateCloneInsertionBatchDelayMs": "string",
            "migrateCloneInsertionBatchSize": "string",
            "orphanCleanupDelaySecs": "string",
            "persistedChunkCacheUpdateMaxBatchSize": "string",
            "rangeDeleterBatchDelayMs": "string",
            "rangeDeleterBatchSize": "string",
            "mirrorReads": {
              "samplingRate": "number",
              "maxTimeMs": "string"
            },
            "redactClientLogData": "boolean"
          },
          "oplog": {
            "maxSizePercent": "string",
            "minRetentionHours": "number"
          },
          "chainingAllowed": "boolean"
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongocfg": {
        "config": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number",
                "cacheSize": "number"
              }
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string"
          },
          "net": {
            "maxIncomingConnections": "string"
          },
          "setParameter": {
            "enableFlowControl": "boolean",
            "auditAuthorizationSuccess": "boolean",
            "redactClientLogData": "boolean"
          },
          "auditLog": {
            "filter": "string"
          },
          "oplog": {
            "maxSizePercent": "string",
            "minRetentionHours": "number"
          },
          "chainingAllowed": "boolean"
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongos": {
        "config": {
          "net": {
            "maxIncomingConnections": "string",
            "compression": {
              "compressors": [
                "string"
              ]
            }
          },
          "setParameter": {
            "auditAuthorizationSuccess": "boolean",
            "readHedgingMode": "string",
            "shardingTaskExecutorPoolMaxSize": "string",
            "shardingTaskExecutorPoolMaxConnecting": "string",
            "shardingTaskExecutorPoolMinSize": "string",
            "shardingTaskExecutorPoolReplicaSetMatching": "string",
            "shardingTaskExecutorPoolHostTimeoutMs": "string",
            "shardingTaskExecutorPoolRefreshRequirementMs": "string",
            "shardingTaskExecutorPoolRefreshTimeoutMs": "string",
            "warmMinConnectionsInShardingTaskExecutorPoolOnStartup": "boolean",
            "warmMinConnectionsInShardingTaskExecutorPoolOnStartupWaitMs": "string",
            "shardingTaskExecutorPoolMaxSizeForConfigServers": "string",
            "shardingTaskExecutorPoolMinSizeForConfigServers": "string",
            "redactClientLogData": "boolean"
          },
          "auditLog": {
            "filter": "string"
          },
          "chunkSize": "string"
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      },
      "mongoinfra": {
        "configMongos": {
          "net": {
            "maxIncomingConnections": "string",
            "compression": {
              "compressors": [
                "string"
              ]
            }
          },
          "setParameter": {
            "auditAuthorizationSuccess": "boolean",
            "readHedgingMode": "string",
            "shardingTaskExecutorPoolMaxSize": "string",
            "shardingTaskExecutorPoolMaxConnecting": "string",
            "shardingTaskExecutorPoolMinSize": "string",
            "shardingTaskExecutorPoolReplicaSetMatching": "string",
            "shardingTaskExecutorPoolHostTimeoutMs": "string",
            "shardingTaskExecutorPoolRefreshRequirementMs": "string",
            "shardingTaskExecutorPoolRefreshTimeoutMs": "string",
            "warmMinConnectionsInShardingTaskExecutorPoolOnStartup": "boolean",
            "warmMinConnectionsInShardingTaskExecutorPoolOnStartupWaitMs": "string",
            "shardingTaskExecutorPoolMaxSizeForConfigServers": "string",
            "shardingTaskExecutorPoolMinSizeForConfigServers": "string",
            "redactClientLogData": "boolean"
          },
          "auditLog": {
            "filter": "string"
          },
          "chunkSize": "string"
        },
        "configMongocfg": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number",
                "cacheSize": "number"
              }
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "string"
          },
          "net": {
            "maxIncomingConnections": "string"
          },
          "setParameter": {
            "enableFlowControl": "boolean",
            "auditAuthorizationSuccess": "boolean",
            "redactClientLogData": "boolean"
          },
          "auditLog": {
            "filter": "string"
          },
          "oplog": {
            "maxSizePercent": "string",
            "minRetentionHours": "number"
          },
          "chainingAllowed": "boolean"
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "string",
          "emergencyUsageThreshold": "string",
          "diskSizeLimit": "string"
        }
      }
    },
    "autocompactConfig": {
      "enabled": "boolean",
      "targetFreeSpace": "string",
      "bloatPercent": "number",
      "compactionType": "string"
    }
  },
  "name": "string",
  "maintenanceWindow": {
    // Includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
    "anytime": "object",
    "weeklyMaintenanceWindow": {
      "day": "string",
      "hour": "string"
    }
    // end of the list of possible fields
  },
  "securityGroupIds": [
    "string"
  ],
  "deletionProtection": "boolean",
  "networkId": "string"
}

Field

Description

updateMask

string (field-mask)

A comma-separated names off ALL fields to be updated.
Only the specified fields will be changed. The others will be left untouched.
If the field is specified in updateMask and no value for that field was sent in the request,
the field's value will be reset to the default. The default value for most fields is null or 0.

If updateMask is not sent in the request, all fields' values will be updated.
Fields specified in the request will be updated to provided values.
The rest of the fields will be reset to the default.

description

string

New description of the MongoDB cluster.

The maximum string length in characters is 256.

labels

object (map<string, string>)

Custom labels for the MongoDB cluster as key:value pairs. Maximum 64 per resource.
For example, "project": "mvp" or "source": "dictionary".
The new set of labels will completely replace the old ones. To add a label, request the current
set with the ClusterService.Get method, then send an ClusterService.Update request with the new label added to the set.

The maximum string length in characters for each value is 63. The maximum string length in characters for each key is 63. Each key must match the regular expression ^[a-z][-_./\@0-9a-z]*$. Each value must match the regular expression [-_./\@0-9a-z]*$. No more than 64 per resource.

configSpec

ConfigSpec

New configuration and resources for hosts in the cluster.

name

string

New name for the cluster.

The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.

maintenanceWindow

MaintenanceWindow

New maintenance window settings for the cluster.

securityGroupIds[]

string

User security groups

deletionProtection

boolean

Deletion Protection inhibits deletion of the cluster

networkId

string

ID of the network to move the cluster to.

The maximum string length in characters is 150.

ConfigSpec

Field

Description

version

string

Version of MongoDB used in the cluster. Possible values: 3.6, 4.0, 4.2, 4.4, 4.4-enterprise, 5.0, 5.0-enterprise, 6.0, 6.0-enterprise.

featureCompatibilityVersion

string

MongoDB feature compatibility version. See usage details in MongoDB documentation.
Possible values:

  • 3.6 - persist data compatibility for version 3.6. After setting this option the data will not be compatible with 3.4 or older.
  • 4.0 - persist data compatibility for version 4.0. After setting this option the data will not be compatible with 3.6 or older.
  • 4.2 - persist data compatibility for version 4.2. After setting this option the data will not be compatible with 4.0 or older.
  • 4.4 - persist data compatibility for version 4.4. After setting this option the data will not be compatible with 4.2 or older.
  • 5.0 - persist data compatibility for version 5.0. After setting this option the data will not be compatible with 4.4 or older.
  • 6.0 - persist data compatibility for version 6.0. After setting this option the data will not be compatible with 5.0 or older.

mongodbSpec_3_6

MongodbSpec3_6

Configuration and resource allocation for a MongoDB 3.6 cluster.

Includes only one of the fields mongodbSpec_3_6, mongodbSpec_4_0, mongodbSpec_4_2, mongodbSpec_4_4, mongodbSpec_5_0, mongodbSpec_6_0, mongodbSpec_4_4Enterprise, mongodbSpec_5_0Enterprise, mongodbSpec_6_0Enterprise.

mongodbSpec_4_0

MongodbSpec4_0

Configuration and resource allocation for a MongoDB 4.0 cluster.

Includes only one of the fields mongodbSpec_3_6, mongodbSpec_4_0, mongodbSpec_4_2, mongodbSpec_4_4, mongodbSpec_5_0, mongodbSpec_6_0, mongodbSpec_4_4Enterprise, mongodbSpec_5_0Enterprise, mongodbSpec_6_0Enterprise.

mongodbSpec_4_2

MongodbSpec4_2

Configuration and resource allocation for a MongoDB 4.2 cluster.

Includes only one of the fields mongodbSpec_3_6, mongodbSpec_4_0, mongodbSpec_4_2, mongodbSpec_4_4, mongodbSpec_5_0, mongodbSpec_6_0, mongodbSpec_4_4Enterprise, mongodbSpec_5_0Enterprise, mongodbSpec_6_0Enterprise.

mongodbSpec_4_4

MongodbSpec4_4

Configuration and resource allocation for a MongoDB 4.4 cluster.

Includes only one of the fields mongodbSpec_3_6, mongodbSpec_4_0, mongodbSpec_4_2, mongodbSpec_4_4, mongodbSpec_5_0, mongodbSpec_6_0, mongodbSpec_4_4Enterprise, mongodbSpec_5_0Enterprise, mongodbSpec_6_0Enterprise.

mongodbSpec_5_0

MongodbSpec5_0

Configuration and resource allocation for a MongoDB 5.0 cluster.

Includes only one of the fields mongodbSpec_3_6, mongodbSpec_4_0, mongodbSpec_4_2, mongodbSpec_4_4, mongodbSpec_5_0, mongodbSpec_6_0, mongodbSpec_4_4Enterprise, mongodbSpec_5_0Enterprise, mongodbSpec_6_0Enterprise.

mongodbSpec_6_0

MongodbSpec6_0

Configuration and resource allocation for a MongoDB 6.0 cluster.

Includes only one of the fields mongodbSpec_3_6, mongodbSpec_4_0, mongodbSpec_4_2, mongodbSpec_4_4, mongodbSpec_5_0, mongodbSpec_6_0, mongodbSpec_4_4Enterprise, mongodbSpec_5_0Enterprise, mongodbSpec_6_0Enterprise.

mongodbSpec_4_4Enterprise

MongodbSpec4_4Enterprise

Configuration and resource allocation for a MongoDB 4.4 Enterprise cluster.

Includes only one of the fields mongodbSpec_3_6, mongodbSpec_4_0, mongodbSpec_4_2, mongodbSpec_4_4, mongodbSpec_5_0, mongodbSpec_6_0, mongodbSpec_4_4Enterprise, mongodbSpec_5_0Enterprise, mongodbSpec_6_0Enterprise.

mongodbSpec_5_0Enterprise

MongodbSpec5_0Enterprise

Configuration and resource allocation for a MongoDB 5.0 Enterprise cluster.

Includes only one of the fields mongodbSpec_3_6, mongodbSpec_4_0, mongodbSpec_4_2, mongodbSpec_4_4, mongodbSpec_5_0, mongodbSpec_6_0, mongodbSpec_4_4Enterprise, mongodbSpec_5_0Enterprise, mongodbSpec_6_0Enterprise.

mongodbSpec_6_0Enterprise

MongodbSpec6_0Enterprise

Configuration and resource allocation for a MongoDB 6.0 Enterprise cluster.

Includes only one of the fields mongodbSpec_3_6, mongodbSpec_4_0, mongodbSpec_4_2, mongodbSpec_4_4, mongodbSpec_5_0, mongodbSpec_6_0, mongodbSpec_4_4Enterprise, mongodbSpec_5_0Enterprise, mongodbSpec_6_0Enterprise.

backupWindowStart

TimeOfDay

Time to start the daily backup, in the UTC timezone.

backupRetainPeriodDays

string (int64)

Retain period of automatically created backup in days

Acceptable values are 7 to 35, inclusive.

performanceDiagnostics

PerformanceDiagnosticsConfig

Performance Diagnosics configuration

access

Access

Access policy to DB

mongodb

MongodbSpec

Configuration and resource allocation for a MongoDB 7.0 Enterprise cluster.

autocompactConfig

AutoCompactConfig

AutoCompact config

MongodbSpec3_6

Field

Description

mongod

Mongod

Configuration and resource allocation for mongod 3.6 hosts.

mongocfg

MongoCfg

Configuration and resource allocation for mongocfg 3.6 hosts.

mongos

Mongos

Configuration and resource allocation for mongos 3.6 hosts.

mongoinfra

MongoInfra

Configuration and resource allocation for mongoinfra (mongos+mongocfg) 3.6 hosts.

Mongod

Field

Description

config

MongodConfig3_6

Configuration for mongod 3.6 hosts.

resources

Resources

Resources allocated to each mongod host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongodConfig3_6

Configuration of a mongod daemon. Supported options are a limited subset of all
options described in MongoDB documentation.

Field

Description

storage

Storage

storage section of mongod configuration.

operationProfiling

OperationProfiling

operationProfiling section of mongod configuration.

net

Network

net section of mongod configuration.

Storage

Field

Description

wiredTiger

WiredTiger

Configuration of the WiredTiger storage engine.

journal

Journal

Configuration of the MongoDB journal.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engineConfig

EngineConfig

Engine configuration for WiredTiger.

collectionConfig

CollectionConfig

Collection configuration for WiredTiger.

EngineConfig

Field

Description

cacheSizeGb

number (double)

The maximum size of the internal cache that WiredTiger will use for all data.

CollectionConfig

Field

Description

blockCompressor

enum (Compressor)

Default type of compression to use for collection data.

  • NONE: No compression.
  • SNAPPY: The Snappy compression.
  • ZLIB: The zlib compression.

Journal

Field

Description

enabled

boolean

Whether the journal is enabled or disabled.
Possible values:

  • true (default) - the journal is enabled.
  • false - the journal is disabled.

commitInterval

string (int64)

Commit interval between journal operations, in milliseconds.
Default: 100.

Acceptable values are 1 to 500, inclusive.

OperationProfiling

Field

Description

mode

enum (Mode)

Mode which specifies operations that should be profiled.

  • OFF: The profiler is off and does not collect any data.
  • SLOW_OP: The profiler collects data for operations that take longer than the value of slowOpThreshold.
  • ALL: The profiler collects data for all operations.

slowOpThreshold

string (int64)

The slow operation time threshold, in milliseconds. Operations that run
for longer than this threshold are considered slow, and are processed by the profiler
running in the SLOW_OP mode.

Value must be greater than 0.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of simultaneous connections that mongod will accept.

Acceptable values are 10 to 32768, inclusive.

Resources

Field

Description

resourcePresetId

string

ID of the preset for computational resources available to a host (CPU, memory etc.).
All available presets are listed in the documentation.

diskSize

string (int64)

Volume of the storage available to a host, in bytes.

diskTypeId

string

Type of the storage environment for the host.
Possible values:

  • network-hdd - network HDD drive,
  • network-ssd - network SSD drive,
  • local-ssd - local SSD storage.

DiskSizeAutoscaling

Field

Description

plannedUsageThreshold

string (int64)

Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent.

emergencyUsageThreshold

string (int64)

Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent.

diskSizeLimit

string (int64)

Limit on how large the storage for database instances can automatically grow, in bytes.

MongoCfg

Field

Description

config

MongoCfgConfig3_6

Configuration for mongocfg 3.6 hosts.

resources

Resources

Resources allocated to each mongocfg host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongoCfgConfig3_6

Field

Description

storage

Storage

storage section of mongocfg configuration.

operationProfiling

OperationProfiling

operationProfiling section of mongocfg configuration.

net

Network

net section of mongocfg configuration.

Storage

Field

Description

wiredTiger

WiredTiger

Configuration of the WiredTiger storage engine.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engineConfig

EngineConfig

Engine configuration for WiredTiger.

EngineConfig

Field

Description

cacheSizeGb

number (double)

The maximum size of the internal cache that WiredTiger will use for all data.

OperationProfiling

Field

Description

mode

enum (Mode)

Operation profiling level. For details, see MongoDB documentation.

  • OFF: The profiler is off and does not collect any data. This is the default
    profiler level.
  • SLOW_OP: The profiler collects data for operations that take longer than the value of slowOpThreshold.
  • ALL: The profiler collects data for all operations.

slowOpThreshold

string (int64)

The slow operation time threshold, in milliseconds. Operations that run
for longer than this threshold are considered slow, and are processed by the profiler
running in the SLOW_OP mode. For details see MongoDB documentation.

Value must be greater than 0.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of incoming connections.

Acceptable values are 10 to 32768, inclusive.

Mongos

Field

Description

config

MongosConfig3_6

Configuration for mongos 3.6 hosts.

resources

Resources

Resources allocated to each mongos host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongosConfig3_6

Field

Description

net

Network

Network settings for mongos.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of incoming connections.

Acceptable values are 10 to 32768, inclusive.

MongoInfra

Field

Description

configMongos

MongosConfig3_6

Configuration for mongos of mongoinfra 3.6 hosts.

configMongocfg

MongoCfgConfig3_6

Configuration for mongocfg of mongoinfra 3.6 hosts.

resources

Resources

Resources allocated to each mongoinfra (mongos+mongocfg) host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongodbSpec4_0

Field

Description

mongod

Mongod

Configuration and resource allocation for mongod 4.0 hosts.

mongocfg

MongoCfg

Configuration and resource allocation for mongocfg 4.0 hosts.

mongos

Mongos

Configuration and resource allocation for mongos 4.0 hosts.

mongoinfra

MongoInfra

Configuration and resource allocation for mongoinfra (mongos+mongocfg) 4.0 hosts.

Mongod

Field

Description

config

MongodConfig4_0

Configuration for mongod 4.0 hosts.

resources

Resources

Resources allocated to each mongod host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongodConfig4_0

Configuration of a mongod daemon. Supported options are a limited subset of all
options described in MongoDB documentation.

Field

Description

storage

Storage

storage section of mongod configuration.

operationProfiling

OperationProfiling

operationProfiling section of mongod configuration.

net

Network

net section of mongod configuration.

Storage

Field

Description

wiredTiger

WiredTiger

Configuration of the WiredTiger storage engine.

journal

Journal

Configuration of the MongoDB journal.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engineConfig

EngineConfig

Engine configuration for WiredTiger.

collectionConfig

CollectionConfig

Collection configuration for WiredTiger.

EngineConfig

Field

Description

cacheSizeGb

number (double)

The maximum size of the internal cache that WiredTiger will use for all data.

CollectionConfig

Field

Description

blockCompressor

enum (Compressor)

Default type of compression to use for collection data.

  • NONE: No compression.
  • SNAPPY: The Snappy compression.
  • ZLIB: The zlib compression.

Journal

Field

Description

commitInterval

string (int64)

Commit interval between journal operations, in milliseconds.
Default: 100.

Acceptable values are 1 to 500, inclusive.

OperationProfiling

Field

Description

mode

enum (Mode)

Mode which specifies operations that should be profiled.

  • OFF: The profiler is off and does not collect any data.
  • SLOW_OP: The profiler collects data for operations that take longer than the value of slowOpThreshold.
  • ALL: The profiler collects data for all operations.

slowOpThreshold

string (int64)

The slow operation time threshold, in milliseconds. Operations that run
for longer than this threshold are considered slow, and are processed by the profiler
running in the SLOW_OP mode.

Value must be greater than 0.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of simultaneous connections that mongod will accept.

Acceptable values are 10 to 32768, inclusive.

MongoCfg

Field

Description

config

MongoCfgConfig4_0

Configuration for mongocfg 4.0 hosts.

resources

Resources

Resources allocated to each mongocfg host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongoCfgConfig4_0

Field

Description

storage

Storage

storage section of mongocfg configuration.

operationProfiling

OperationProfiling

operationProfiling section of mongocfg configuration.

net

Network

net section of mongocfg configuration.

Storage

Field

Description

wiredTiger

WiredTiger

Configuration of the WiredTiger storage engine.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engineConfig

EngineConfig

Engine configuration for WiredTiger.

EngineConfig

Field

Description

cacheSizeGb

number (double)

The maximum size of the internal cache that WiredTiger will use for all data.

OperationProfiling

Field

Description

mode

enum (Mode)

Mode which specifies operations that should be profiled.

  • OFF: The profiler is off and does not collect any data.
  • SLOW_OP: The profiler collects data for operations that take longer than the value of slowOpThreshold.
  • ALL: The profiler collects data for all operations.

slowOpThreshold

string (int64)

The slow operation time threshold, in milliseconds. Operations that run
for longer than this threshold are considered slow, and are processed by the profiler
running in the SLOW_OP mode. For details see MongoDB documentation.

Value must be greater than 0.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of simultaneous connections that mongocfg will accept.

Acceptable values are 10 to 32768, inclusive.

Mongos

Field

Description

config

MongosConfig4_0

Configuration for mongos 4.0 hosts.

resources

Resources

Resources allocated to each mongos host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongosConfig4_0

Field

Description

net

Network

Network settings for mongos.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of simultaneous connections that mongos will accept.

Acceptable values are 10 to 32768, inclusive.

MongoInfra

Field

Description

configMongos

MongosConfig4_0

Configuration for mongos of mongoinfra 4.0 hosts.

configMongocfg

MongoCfgConfig4_0

Configuration for mongocfg of mongoinfra 4.0 hosts.

resources

Resources

Resources allocated to each mongoinfra (mongos+mongocfg) host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongodbSpec4_2

Field

Description

mongod

Mongod

Configuration and resource allocation for mongod 4.2 hosts.

mongocfg

MongoCfg

Configuration and resource allocation for mongocfg 4.2 hosts.

mongos

Mongos

Configuration and resource allocation for mongos 4.2 hosts.

mongoinfra

MongoInfra

Configuration and resource allocation for mongoinfra (mongos+mongocfg) 4.2 hosts.

Mongod

Field

Description

config

MongodConfig4_2

Configuration for mongod 4.2 hosts.

resources

Resources

Resources allocated to each mongod host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongodConfig4_2

Configuration of a mongod daemon. Supported options are a limited subset of all
options described in MongoDB documentation.

Field

Description

storage

Storage

storage section of mongod configuration.

operationProfiling

OperationProfiling

operationProfiling section of mongod configuration.

net

Network

net section of mongod configuration.

setParameter

SetParameter

replication section of mongod configuration.

Storage

Field

Description

wiredTiger

WiredTiger

Configuration of the WiredTiger storage engine.

journal

Journal

Configuration of the MongoDB journal.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engineConfig

EngineConfig

Engine configuration for WiredTiger.

collectionConfig

CollectionConfig

Collection configuration for WiredTiger.

indexConfig

IndexConfig

Index configuration for WiredTiger

EngineConfig

Field

Description

cacheSizeGb

number (double)

The maximum size of the internal cache that WiredTiger will use for all data.

CollectionConfig

Field

Description

blockCompressor

enum (Compressor)

Default type of compression to use for collection data.

  • NONE: No compression.
  • SNAPPY: The Snappy compression.
  • ZLIB: The zlib compression.
  • ZSTD: The zstd compression.

IndexConfig

Field

Description

prefixCompression

boolean

Enables or disables prefix compression

Journal

Field

Description

commitInterval

string (int64)

Commit interval between journal operations, in milliseconds.
Default: 100.

Acceptable values are 1 to 500, inclusive.

OperationProfiling

Field

Description

mode

enum (Mode)

Mode which specifies operations that should be profiled.

  • OFF: The profiler is off and does not collect any data.
  • SLOW_OP: The profiler collects data for operations that take longer than the value of slowOpThreshold.
  • ALL: The profiler collects data for all operations.

slowOpThreshold

string (int64)

The slow operation time threshold, in milliseconds. Operations that run
for longer than this threshold are considered slow, and are processed by the profiler
running in the SLOW_OP mode.

Value must be greater than 0.

slowOpSampleRate

number (double)

The fraction of slow operations that should be profiled or logged.
operationProfiling.slowOpSampleRate accepts values between 0 and 1, inclusive.

Acceptable values are 0 to 1, inclusive.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of simultaneous connections that mongod will accept.

Acceptable values are 10 to 32768, inclusive.

compression

Compression

Compression settings

Compression

Field

Description

compressors[]

enum (Compressor)

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format.
    MongoDB supports the following compressors:

The number of elements must be in the range 1-3.

  • SNAPPY: The Snappy compression.
  • ZLIB: The zlib compression.
  • ZSTD: The zstd compression.
  • DISABLED: No compression

SetParameter

Field

Description

enableFlowControl

boolean

Enables or disables the mechanism that controls the rate at which the primary applies its writes with the
goal of keeping the secondary members majority committed
lag under a configurable maximum value.

MongoCfg

Field

Description

config

MongoCfgConfig4_2

Configuration for mongocfg 4.2 hosts.

resources

Resources

Resources allocated to each mongocfg host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongoCfgConfig4_2

Field

Description

storage

Storage

storage section of mongocfg configuration.

operationProfiling

OperationProfiling

operationProfiling section of mongocfg configuration.

net

Network

net section of mongocfg configuration.

Storage

Field

Description

wiredTiger

WiredTiger

Configuration of the WiredTiger storage engine.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engineConfig

EngineConfig

Engine configuration for WiredTiger.

EngineConfig

Field

Description

cacheSizeGb

number (double)

The maximum size of the internal cache that WiredTiger will use for all data.

OperationProfiling

Field

Description

mode

enum (Mode)

Mode which specifies operations that should be profiled.

  • OFF: The profiler is off and does not collect any data.
  • SLOW_OP: The profiler collects data for operations that take longer than the value of slowOpThreshold.
  • ALL: The profiler collects data for all operations.

slowOpThreshold

string (int64)

The slow operation time threshold, in milliseconds. Operations that run
for longer than this threshold are considered slow, and are processed by the profiler
running in the SLOW_OP mode. For details see MongoDB documentation.

Value must be greater than 0.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of simultaneous connections that mongocfg will accept.

Acceptable values are 10 to 32768, inclusive.

Mongos

Field

Description

config

MongosConfig4_2

Configuration for mongos 4.2 hosts.

resources

Resources

Resources allocated to each mongos host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongosConfig4_2

Field

Description

net

Network

Network settings for mongos.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of simultaneous connections that mongos will accept.

Acceptable values are 10 to 32768, inclusive.

compression

Compression

Compression settings

Compression

Field

Description

compressors[]

enum (Compressor)

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format.
    MongoDB supports the following compressors:

The number of elements must be in the range 1-3.

  • SNAPPY: The Snappy compression.
  • ZLIB: The zlib compression.
  • ZSTD: The zstd compression.
  • DISABLED: No compression

MongoInfra

Field

Description

configMongos

MongosConfig4_2

Configuration for mongos of mongoinfra 4.2 hosts.

configMongocfg

MongoCfgConfig4_2

Configuration for mongocfg of mongoinfra 4.2 hosts.

resources

Resources

Resources allocated to each mongoinfra (mongos+mongocfg) host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongodbSpec4_4

Field

Description

mongod

Mongod

Configuration and resource allocation for mongod 4.4 hosts.

mongocfg

MongoCfg

Configuration and resource allocation for mongocfg 4.4 hosts.

mongos

Mongos

Configuration and resource allocation for mongos 4.4 hosts.

mongoinfra

MongoInfra

Configuration and resource allocation for mongoinfra (mongos+mongocfg) 4.4 hosts.

Mongod

Field

Description

config

MongodConfig4_4

Configuration for mongod 4.4 hosts.

resources

Resources

Resources allocated to each mongod host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongodConfig4_4

Configuration of a mongod daemon. Supported options are a limited subset of all
options described in MongoDB documentation.

Field

Description

storage

Storage

storage section of mongod configuration.

operationProfiling

OperationProfiling

operationProfiling section of mongod configuration.

net

Network

net section of mongod configuration.

setParameter

SetParameter

replication section of mongod configuration.

Storage

Field

Description

wiredTiger

WiredTiger

Configuration of the WiredTiger storage engine.

journal

Journal

Configuration of the MongoDB journal.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engineConfig

EngineConfig

Engine configuration for WiredTiger.

collectionConfig

CollectionConfig

Collection configuration for WiredTiger.

indexConfig

IndexConfig

Index configuration for WiredTiger

EngineConfig

Field

Description

cacheSizeGb

number (double)

The maximum size of the internal cache that WiredTiger will use for all data.

CollectionConfig

Field

Description

blockCompressor

enum (Compressor)

Default type of compression to use for collection data.

  • NONE: No compression.
  • SNAPPY: The Snappy compression.
  • ZLIB: The zlib compression.
  • ZSTD: The zstd compression.

IndexConfig

Field

Description

prefixCompression

boolean

Enables or disables prefix compression

Journal

Field

Description

commitInterval

string (int64)

Commit interval between journal operations, in milliseconds.
Default: 100.

Acceptable values are 1 to 500, inclusive.

OperationProfiling

Field

Description

mode

enum (Mode)

Mode which specifies operations that should be profiled.

  • OFF: The profiler is off and does not collect any data.
  • SLOW_OP: The profiler collects data for operations that take longer than the value of slowOpThreshold.
  • ALL: The profiler collects data for all operations.

slowOpThreshold

string (int64)

The slow operation time threshold, in milliseconds. Operations that run
for longer than this threshold are considered slow, and are processed by the profiler
running in the SLOW_OP mode.

Value must be greater than 0.

slowOpSampleRate

number (double)

The fraction of slow operations that should be profiled or logged.
operationProfiling.slowOpSampleRate accepts values between 0 and 1, inclusive.

Acceptable values are 0 to 1, inclusive.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of simultaneous connections that mongod will accept.

Acceptable values are 10 to 32768, inclusive.

compression

Compression

Compression settings

Compression

Field

Description

compressors[]

enum (Compressor)

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format.
    MongoDB supports the following compressors:

The number of elements must be in the range 1-3.

  • SNAPPY: The Snappy compression.
  • ZLIB: The zlib compression.
  • ZSTD: The zstd compression.
  • DISABLED: No compression

SetParameter

Field

Description

enableFlowControl

boolean

Enables or disables the mechanism that controls the rate at which the primary applies its writes with the
goal of keeping the secondary members majority committed
lag under a configurable maximum value.

MongoCfg

Field

Description

config

MongoCfgConfig4_4

Configuration for mongocfg 4.4 hosts.

resources

Resources

Resources allocated to each mongocfg host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongoCfgConfig4_4

Field

Description

storage

Storage

storage section of mongocfg configuration.

operationProfiling

OperationProfiling

operationProfiling section of mongocfg configuration.

net

Network

net section of mongocfg configuration.

Storage

Field

Description

wiredTiger

WiredTiger

Configuration of the WiredTiger storage engine.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engineConfig

EngineConfig

Engine configuration for WiredTiger.

EngineConfig

Field

Description

cacheSizeGb

number (double)

The maximum size of the internal cache that WiredTiger will use for all data.

OperationProfiling

Field

Description

mode

enum (Mode)

Mode which specifies operations that should be profiled.

  • OFF: The profiler is off and does not collect any data.
  • SLOW_OP: The profiler collects data for operations that take longer than the value of slowOpThreshold.
  • ALL: The profiler collects data for all operations.

slowOpThreshold

string (int64)

The slow operation time threshold, in milliseconds. Operations that run
for longer than this threshold are considered slow, and are processed by the profiler
running in the SLOW_OP mode. For details see MongoDB documentation.

Value must be greater than 0.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of simultaneous connections that mongocfg will accept.

Acceptable values are 10 to 32768, inclusive.

Mongos

Field

Description

config

MongosConfig4_4

Configuration for mongos 4.4 hosts.

resources

Resources

Resources allocated to each mongos host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongosConfig4_4

Field

Description

net

Network

Network settings for mongos.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of simultaneous connections that mongos will accept.

Acceptable values are 10 to 32768, inclusive.

compression

Compression

Compression settings

Compression

Field

Description

compressors[]

enum (Compressor)

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format.
    MongoDB supports the following compressors:

The number of elements must be in the range 1-3.

  • SNAPPY: The Snappy compression.
  • ZLIB: The zlib compression.
  • ZSTD: The zstd compression.
  • DISABLED: No compression

MongoInfra

Field

Description

configMongos

MongosConfig4_4

Configuration for mongos of mongoinfra 4.4 hosts.

configMongocfg

MongoCfgConfig4_4

Configuration for mongocfg of mongoinfra 4.4 hosts.

resources

Resources

Resources allocated to each mongoinfra (mongos+mongocfg) host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongodbSpec5_0

Field

Description

mongod

Mongod

Configuration and resource allocation for mongod 5.0 hosts.

mongocfg

MongoCfg

Configuration and resource allocation for mongocfg 5.0 hosts.

mongos

Mongos

Configuration and resource allocation for mongos 5.0 hosts.

mongoinfra

MongoInfra

Configuration and resource allocation for mongoinfra (mongos+mongocfg) 5.0 hosts.

Mongod

Field

Description

config

MongodConfig5_0

Configuration for mongod 5.0 hosts.

resources

Resources

Resources allocated to each mongod host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongodConfig5_0

Configuration of a mongod daemon. Supported options are a limited subset of all
options described in MongoDB documentation.

Field

Description

storage

Storage

storage section of mongod configuration.

operationProfiling

OperationProfiling

operationProfiling section of mongod configuration.

net

Network

net section of mongod configuration.

setParameter

SetParameter

SetParameter section of mongod configuration.

Storage

Field

Description

wiredTiger

WiredTiger

Configuration of the WiredTiger storage engine.

journal

Journal

Configuration of the MongoDB journal.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engineConfig

EngineConfig

Engine configuration for WiredTiger.

collectionConfig

CollectionConfig

Collection configuration for WiredTiger.

indexConfig

IndexConfig

Index configuration for WiredTiger

EngineConfig

Field

Description

cacheSizeGb

number (double)

The maximum size of the internal cache that WiredTiger will use for all data.

CollectionConfig

Field

Description

blockCompressor

enum (Compressor)

Default type of compression to use for collection data.

  • NONE: No compression.
  • SNAPPY: The Snappy compression.
  • ZLIB: The zlib compression.
  • ZSTD: The zstd compression.

IndexConfig

Field

Description

prefixCompression

boolean

Enables or disables prefix compression

Journal

Field

Description

commitInterval

string (int64)

Commit interval between journal operations, in milliseconds.
Default: 100.

Acceptable values are 1 to 500, inclusive.

OperationProfiling

Field

Description

mode

enum (Mode)

Mode which specifies operations that should be profiled.

  • OFF: The profiler is off and does not collect any data.
  • SLOW_OP: The profiler collects data for operations that take longer than the value of slowOpThreshold.
  • ALL: The profiler collects data for all operations.

slowOpThreshold

string (int64)

The slow operation time threshold, in milliseconds. Operations that run
for longer than this threshold are considered slow, and are processed by the profiler
running in the SLOW_OP mode.

Value must be greater than 0.

slowOpSampleRate

number (double)

The fraction of slow operations that should be profiled or logged.
operationProfiling.slowOpSampleRate accepts values between 0 and 1, inclusive.

Acceptable values are 0 to 1, inclusive.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of simultaneous connections that mongod will accept.

Acceptable values are 10 to 32768, inclusive.

compression

Compression

Compression settings

Compression

Field

Description

compressors[]

enum (Compressor)

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format.
    MongoDB supports the following compressors:

The number of elements must be in the range 1-3.

  • SNAPPY: The Snappy compression.
  • ZLIB: The zlib compression.
  • ZSTD: The zstd compression.
  • DISABLED: No compression

SetParameter

Field

Description

enableFlowControl

boolean

Enables or disables the mechanism that controls the rate at which the primary applies its writes with the
goal of keeping the secondary members majority committed
lag under a configurable maximum value.

minSnapshotHistoryWindowInSeconds

string (int64)

The minimum time window in seconds for which the storage engine keeps the snapshot history.

The minimum value is 0.

MongoCfg

Field

Description

config

MongoCfgConfig5_0

Configuration for mongocfg 5.0 hosts.

resources

Resources

Resources allocated to each mongocfg host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongoCfgConfig5_0

Field

Description

storage

Storage

storage section of mongocfg configuration.

operationProfiling

OperationProfiling

operationProfiling section of mongocfg configuration.

net

Network

net section of mongocfg configuration.

Storage

Field

Description

wiredTiger

WiredTiger

Configuration of the WiredTiger storage engine.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engineConfig

EngineConfig

Engine configuration for WiredTiger.

EngineConfig

Field

Description

cacheSizeGb

number (double)

The maximum size of the internal cache that WiredTiger will use for all data.

OperationProfiling

Field

Description

mode

enum (Mode)

Mode which specifies operations that should be profiled.

  • OFF: The profiler is off and does not collect any data.
  • SLOW_OP: The profiler collects data for operations that take longer than the value of slowOpThreshold.
  • ALL: The profiler collects data for all operations.

slowOpThreshold

string (int64)

The slow operation time threshold, in milliseconds. Operations that run
for longer than this threshold are considered slow, and are processed by the profiler
running in the SLOW_OP mode. For details see MongoDB documentation.

Value must be greater than 0.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of simultaneous connections that mongocfg will accept.

Acceptable values are 10 to 32768, inclusive.

Mongos

Field

Description

config

MongosConfig5_0

Configuration for mongos 5.0 hosts.

resources

Resources

Resources allocated to each mongos host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongosConfig5_0

Field

Description

net

Network

Network settings for mongos.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of simultaneous connections that mongos will accept.

Acceptable values are 10 to 32768, inclusive.

compression

Compression

Compression settings

Compression

Field

Description

compressors[]

enum (Compressor)

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format.
    MongoDB supports the following compressors:

The number of elements must be in the range 1-3.

  • SNAPPY: The Snappy compression.
  • ZLIB: The zlib compression.
  • ZSTD: The zstd compression.
  • DISABLED: No compression

MongoInfra

Field

Description

configMongos

MongosConfig5_0

Configuration for mongos of mongoinfra 5.0 hosts.

configMongocfg

MongoCfgConfig5_0

Configuration for mongocfg of mongoinfra 5.0 hosts.

resources

Resources

Resources allocated to each mongoinfra (mongos+mongocfg) host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongodbSpec6_0

Field

Description

mongod

Mongod

Configuration and resource allocation for mongod 6.0 hosts.

mongocfg

MongoCfg

Configuration and resource allocation for mongocfg 6.0 hosts.

mongos

Mongos

Configuration and resource allocation for mongos 6.0 hosts.

mongoinfra

MongoInfra

Configuration and resource allocation for mongoinfra (mongos+mongocfg) 6.0 hosts.

Mongod

Field

Description

config

MongodConfig6_0

Configuration for mongod 6.0 hosts.

resources

Resources

Resources allocated to each mongod host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongodConfig6_0

Configuration of a mongod daemon. Supported options are a limited subset of all
options described in MongoDB documentation.

Field

Description

storage

Storage

storage section of mongod configuration.

operationProfiling

OperationProfiling

operationProfiling section of mongod configuration.

net

Network

net section of mongod configuration.

setParameter

SetParameter

SetParameter section of mongod configuration.

Storage

Field

Description

wiredTiger

WiredTiger

Configuration of the WiredTiger storage engine.

journal

Journal

Configuration of the MongoDB journal.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engineConfig

EngineConfig

Engine configuration for WiredTiger.

collectionConfig

CollectionConfig

Collection configuration for WiredTiger.

indexConfig

IndexConfig

Index configuration for WiredTiger

EngineConfig

Field

Description

cacheSizeGb

number (double)

The maximum size of the internal cache that WiredTiger will use for all data.

CollectionConfig

Field

Description

blockCompressor

enum (Compressor)

Default type of compression to use for collection data.

  • NONE: No compression.
  • SNAPPY: The Snappy compression.
  • ZLIB: The zlib compression.
  • ZSTD: The zstd compression.

IndexConfig

Field

Description

prefixCompression

boolean

Enables or disables prefix compression

Journal

Field

Description

commitInterval

string (int64)

Commit interval between journal operations, in milliseconds.
Default: 100.

Acceptable values are 1 to 500, inclusive.

OperationProfiling

Field

Description

mode

enum (Mode)

Mode which specifies operations that should be profiled.

  • OFF: The profiler is off and does not collect any data.
  • SLOW_OP: The profiler collects data for operations that take longer than the value of slowOpThreshold.
  • ALL: The profiler collects data for all operations.

slowOpThreshold

string (int64)

The slow operation time threshold, in milliseconds. Operations that run
for longer than this threshold are considered slow, and are processed by the profiler
running in the SLOW_OP mode.

Value must be greater than 0.

slowOpSampleRate

number (double)

The fraction of slow operations that should be profiled or logged.
operationProfiling.slowOpSampleRate accepts values between 0 and 1, inclusive.

Acceptable values are 0 to 1, inclusive.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of simultaneous connections that mongod will accept.

Acceptable values are 10 to 32768, inclusive.

compression

Compression

Compression settings

Compression

Field

Description

compressors[]

enum (Compressor)

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format.
    MongoDB supports the following compressors:

The number of elements must be in the range 1-3.

  • SNAPPY: The Snappy compression.
  • ZLIB: The zlib compression.
  • ZSTD: The zstd compression.
  • DISABLED: No compression

SetParameter

Field

Description

enableFlowControl

boolean

Enables or disables the mechanism that controls the rate at which the primary applies its writes with the
goal of keeping the secondary members majority committed
lag under a configurable maximum value.

minSnapshotHistoryWindowInSeconds

string (int64)

The minimum time window in seconds for which the storage engine keeps the snapshot history.

The minimum value is 0.

MongoCfg

Field

Description

config

MongoCfgConfig6_0

Configuration for mongocfg 6.0 hosts.

resources

Resources

Resources allocated to each mongocfg host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongoCfgConfig6_0

Field

Description

storage

Storage

storage section of mongocfg configuration.

operationProfiling

OperationProfiling

operationProfiling section of mongocfg configuration.

net

Network

net section of mongocfg configuration.

Storage

Field

Description

wiredTiger

WiredTiger

Configuration of the WiredTiger storage engine.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engineConfig

EngineConfig

Engine configuration for WiredTiger.

EngineConfig

Field

Description

cacheSizeGb

number (double)

The maximum size of the internal cache that WiredTiger will use for all data.

OperationProfiling

Field

Description

mode

enum (Mode)

Mode which specifies operations that should be profiled.

  • OFF: The profiler is off and does not collect any data.
  • SLOW_OP: The profiler collects data for operations that take longer than the value of slowOpThreshold.
  • ALL: The profiler collects data for all operations.

slowOpThreshold

string (int64)

The slow operation time threshold, in milliseconds. Operations that run
for longer than this threshold are considered slow, and are processed by the profiler
running in the SLOW_OP mode. For details see MongoDB documentation.

Value must be greater than 0.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of simultaneous connections that mongocfg will accept.

Acceptable values are 10 to 32768, inclusive.

Mongos

Field

Description

config

MongosConfig6_0

Configuration for mongos 6.0 hosts.

resources

Resources

Resources allocated to each mongos host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongosConfig6_0

Field

Description

net

Network

Network settings for mongos.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of simultaneous connections that mongos will accept.

Acceptable values are 10 to 32768, inclusive.

compression

Compression

Compression settings

Compression

Field

Description

compressors[]

enum (Compressor)

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format.
    MongoDB supports the following compressors:

The number of elements must be in the range 1-3.

  • SNAPPY: The Snappy compression.
  • ZLIB: The zlib compression.
  • ZSTD: The zstd compression.
  • DISABLED: No compression

MongoInfra

Field

Description

configMongos

MongosConfig6_0

Configuration for mongos of mongoinfra 6.0 hosts.

configMongocfg

MongoCfgConfig6_0

Configuration for mongocfg of mongoinfra 6.0 hosts.

resources

Resources

Resources allocated to each mongoinfra (mongos+mongocfg) host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongodbSpec4_4_enterprise

Field

Description

mongod

Mongod

Configuration and resource allocation for mongod 4.4 hosts.

mongocfg

MongoCfg

Configuration and resource allocation for mongocfg 4.4 hosts.

mongos

Mongos

Configuration and resource allocation for mongos 4.4 hosts.

mongoinfra

MongoInfra

Configuration and resource allocation for mongoinfra (mongos+mongocfg) 4.4 hosts.

Mongod

Field

Description

config

MongodConfig4_4Enterprise

Configuration for mongod 4.4 hosts.

resources

Resources

Resources allocated to each mongod host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongodConfig4_4_enterprise

Configuration of a mongod daemon. Supported options are a limited subset of all
options described in MongoDB documentation.

Field

Description

storage

Storage

storage section of mongod configuration.

operationProfiling

OperationProfiling

operationProfiling section of mongod configuration.

net

Network

net section of mongod configuration.

security

Security

security section of mongod configuration.

auditLog

AuditLog

AuditLog section of mongod configuration.

setParameter

SetParameter

SetParameter section of mongod configuration.

Storage

Field

Description

wiredTiger

WiredTiger

Configuration of the WiredTiger storage engine.

journal

Journal

Configuration of the MongoDB journal.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engineConfig

EngineConfig

Engine configuration for WiredTiger.

collectionConfig

CollectionConfig

Collection configuration for WiredTiger.

indexConfig

IndexConfig

Index configuration for WiredTiger

EngineConfig

Field

Description

cacheSizeGb

number (double)

The maximum size of the internal cache that WiredTiger will use for all data.

CollectionConfig

Field

Description

blockCompressor

enum (Compressor)

Default type of compression to use for collection data.

  • NONE: No compression.
  • SNAPPY: The Snappy compression.
  • ZLIB: The zlib compression.
  • ZSTD: The zstd compression.

IndexConfig

Field

Description

prefixCompression

boolean

Enables or disables prefix compression

Journal

Field

Description

commitInterval

string (int64)

Commit interval between journal operations, in milliseconds.
Default: 100.

Acceptable values are 1 to 500, inclusive.

OperationProfiling

Field

Description

mode

enum (Mode)

Mode which specifies operations that should be profiled.

  • OFF: The profiler is off and does not collect any data.
  • SLOW_OP: The profiler collects data for operations that take longer than the value of slowOpThreshold.
  • ALL: The profiler collects data for all operations.

slowOpThreshold

string (int64)

The slow operation time threshold, in milliseconds. Operations that run
for longer than this threshold are considered slow, and are processed by the profiler
running in the SLOW_OP mode.

Value must be greater than 0.

slowOpSampleRate

number (double)

The fraction of slow operations that should be profiled or logged.
operationProfiling.slowOpSampleRate accepts values between 0 and 1, inclusive.

Acceptable values are 0 to 1, inclusive.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of simultaneous connections that mongod will accept.

Acceptable values are 10 to 32768, inclusive.

compression

Compression

Compression settings

Compression

Field

Description

compressors[]

enum (Compressor)

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format.
    MongoDB supports the following compressors:

The number of elements must be in the range 1-3.

  • SNAPPY: The Snappy compression.
  • ZLIB: The zlib compression.
  • ZSTD: The zstd compression.
  • DISABLED: No compression

Security

Field

Description

enableEncryption

boolean

If encryption at rest should be enabled or not

kmip

KMIP

kmip section of mongod security config

KMIP

Field

Description

serverName

string

KMIP server name

port

string (int64)

KMIP server port

serverCa

string

KMIP Server CA

clientCertificate

string

KMIP client certificate + private key (unencrypted)

keyIdentifier

string

KMIP Key identifier (if any)

AuditLog

Field

Description

filter

string

Audit filter

SetParameter

Field

Description

auditAuthorizationSuccess

boolean

Enables the auditing of authorization successes

enableFlowControl

boolean

Enables or disables the mechanism that controls the rate at which the primary applies its writes with the
goal of keeping the secondary members majority committed
lag under a configurable maximum value.

MongoCfg

Field

Description

config

MongoCfgConfig4_4Enterprise

Configuration for mongocfg 4.4 hosts.

resources

Resources

Resources allocated to each mongocfg host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongoCfgConfig4_4_enterprise

Field

Description

storage

Storage

storage section of mongocfg configuration.

operationProfiling

OperationProfiling

operationProfiling section of mongocfg configuration.

net

Network

net section of mongocfg configuration.

Storage

Field

Description

wiredTiger

WiredTiger

Configuration of the WiredTiger storage engine.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engineConfig

EngineConfig

Engine configuration for WiredTiger.

EngineConfig

Field

Description

cacheSizeGb

number (double)

The maximum size of the internal cache that WiredTiger will use for all data.

OperationProfiling

Field

Description

mode

enum (Mode)

Mode which specifies operations that should be profiled.

  • OFF: The profiler is off and does not collect any data.
  • SLOW_OP: The profiler collects data for operations that take longer than the value of slowOpThreshold.
  • ALL: The profiler collects data for all operations.

slowOpThreshold

string (int64)

The slow operation time threshold, in milliseconds. Operations that run
for longer than this threshold are considered slow, and are processed by the profiler
running in the SLOW_OP mode. For details see MongoDB documentation.

Value must be greater than 0.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of simultaneous connections that mongocfg will accept.

Acceptable values are 10 to 32768, inclusive.

Mongos

Field

Description

config

MongosConfig4_4Enterprise

Configuration for mongos 4.4 hosts.

resources

Resources

Resources allocated to each mongos host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongosConfig4_4_enterprise

Field

Description

net

Network

Network settings for mongos.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of simultaneous connections that mongos will accept.

Acceptable values are 10 to 32768, inclusive.

compression

Compression

Compression settings

Compression

Field

Description

compressors[]

enum (Compressor)

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format.
    MongoDB supports the following compressors:

The number of elements must be in the range 1-3.

  • SNAPPY: The Snappy compression.
  • ZLIB: The zlib compression.
  • ZSTD: The zstd compression.
  • DISABLED: No compression

MongoInfra

Field

Description

configMongos

MongosConfig4_4Enterprise

Configuration for mongos of mongoinfra 4.4 enterprise hosts.

configMongocfg

MongoCfgConfig4_4Enterprise

Configuration for mongocfg of mongoinfra 4.4 enterprise hosts.

resources

Resources

Resources allocated to each mongoinfra (mongos+mongocfg) host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongodbSpec5_0_enterprise

Field

Description

mongod

Mongod

Configuration and resource allocation for mongod 5.0 hosts.

mongocfg

MongoCfg

Configuration and resource allocation for mongocfg 5.0 hosts.

mongos

Mongos

Configuration and resource allocation for mongos 5.0 hosts.

mongoinfra

MongoInfra

Configuration and resource allocation for mongoinfra (mongos+mongocfg) 5.0 hosts.

Mongod

Field

Description

config

MongodConfig5_0Enterprise

Configuration for mongod 5.0 hosts.

resources

Resources

Resources allocated to each mongod host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongodConfig5_0_enterprise

Configuration of a mongod daemon. Supported options are a limited subset of all
options described in MongoDB documentation.

Field

Description

storage

Storage

storage section of mongod configuration.

operationProfiling

OperationProfiling

operationProfiling section of mongod configuration.

net

Network

net section of mongod configuration.

security

Security

security section of mongod configuration.

auditLog

AuditLog

AuditLog section of mongod configuration.

setParameter

SetParameter

SetParameter section of mongod configuration.

Storage

Field

Description

wiredTiger

WiredTiger

Configuration of the WiredTiger storage engine.

journal

Journal

Configuration of the MongoDB journal.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engineConfig

EngineConfig

Engine configuration for WiredTiger.

collectionConfig

CollectionConfig

Collection configuration for WiredTiger.

indexConfig

IndexConfig

Index configuration for WiredTiger

EngineConfig

Field

Description

cacheSizeGb

number (double)

The maximum size of the internal cache that WiredTiger will use for all data.

CollectionConfig

Field

Description

blockCompressor

enum (Compressor)

Default type of compression to use for collection data.

  • NONE: No compression.
  • SNAPPY: The Snappy compression.
  • ZLIB: The zlib compression.
  • ZSTD: The zstd compression.

IndexConfig

Field

Description

prefixCompression

boolean

Enables or disables prefix compression

Journal

Field

Description

commitInterval

string (int64)

Commit interval between journal operations, in milliseconds.
Default: 100.

Acceptable values are 1 to 500, inclusive.

OperationProfiling

Field

Description

mode

enum (Mode)

Mode which specifies operations that should be profiled.

  • OFF: The profiler is off and does not collect any data.
  • SLOW_OP: The profiler collects data for operations that take longer than the value of slowOpThreshold.
  • ALL: The profiler collects data for all operations.

slowOpThreshold

string (int64)

The slow operation time threshold, in milliseconds. Operations that run
for longer than this threshold are considered slow, and are processed by the profiler
running in the SLOW_OP mode.

Value must be greater than 0.

slowOpSampleRate

number (double)

The fraction of slow operations that should be profiled or logged.
operationProfiling.slowOpSampleRate accepts values between 0 and 1, inclusive.

Acceptable values are 0 to 1, inclusive.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of simultaneous connections that mongod will accept.

Acceptable values are 10 to 32768, inclusive.

compression

Compression

Compression settings

Compression

Field

Description

compressors[]

enum (Compressor)

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format.
    MongoDB supports the following compressors:

The number of elements must be in the range 1-3.

  • SNAPPY: The Snappy compression.
  • ZLIB: The zlib compression.
  • ZSTD: The zstd compression.
  • DISABLED: No compression

Security

Field

Description

enableEncryption

boolean

If encryption at rest should be enabled or not

kmip

KMIP

kmip section of mongod security config

KMIP

Field

Description

serverName

string

KMIP server name

port

string (int64)

KMIP server port

serverCa

string

KMIP Server CA

clientCertificate

string

KMIP client certificate + private key (unencrypted)

keyIdentifier

string

KMIP Key identifier (if any)

AuditLog

Field

Description

filter

string

Audit filter

runtimeConfiguration

boolean

Allows runtime configuration of audit filter and auditAuthorizationSuccess

SetParameter

Field

Description

auditAuthorizationSuccess

boolean

Enables the auditing of authorization successes

enableFlowControl

boolean

Enables or disables the mechanism that controls the rate at which the primary applies its writes with the
goal of keeping the secondary members majority committed
lag under a configurable maximum value.

minSnapshotHistoryWindowInSeconds

string (int64)

The minimum time window in seconds for which the storage engine keeps the snapshot history.

The minimum value is 0.

MongoCfg

Field

Description

config

MongoCfgConfig5_0Enterprise

Configuration for mongocfg 5.0 hosts.

resources

Resources

Resources allocated to each mongocfg host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongoCfgConfig5_0_enterprise

Field

Description

storage

Storage

storage section of mongocfg configuration.

operationProfiling

OperationProfiling

operationProfiling section of mongocfg configuration.

net

Network

net section of mongocfg configuration.

Storage

Field

Description

wiredTiger

WiredTiger

Configuration of the WiredTiger storage engine.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engineConfig

EngineConfig

Engine configuration for WiredTiger.

EngineConfig

Field

Description

cacheSizeGb

number (double)

The maximum size of the internal cache that WiredTiger will use for all data.

OperationProfiling

Field

Description

mode

enum (Mode)

Mode which specifies operations that should be profiled.

  • OFF: The profiler is off and does not collect any data.
  • SLOW_OP: The profiler collects data for operations that take longer than the value of slowOpThreshold.
  • ALL: The profiler collects data for all operations.

slowOpThreshold

string (int64)

The slow operation time threshold, in milliseconds. Operations that run
for longer than this threshold are considered slow, and are processed by the profiler
running in the SLOW_OP mode. For details see MongoDB documentation.

Value must be greater than 0.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of simultaneous connections that mongocfg will accept.

Acceptable values are 10 to 32768, inclusive.

Mongos

Field

Description

config

MongosConfig5_0Enterprise

Configuration for mongos 5.0 hosts.

resources

Resources

Resources allocated to each mongos host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongosConfig5_0_enterprise

Field

Description

net

Network

Network settings for mongos.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of simultaneous connections that mongos will accept.

Acceptable values are 10 to 32768, inclusive.

compression

Compression

Compression settings

Compression

Field

Description

compressors[]

enum (Compressor)

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format.
    MongoDB supports the following compressors:

The number of elements must be in the range 1-3.

  • SNAPPY: The Snappy compression.
  • ZLIB: The zlib compression.
  • ZSTD: The zstd compression.
  • DISABLED: No compression

MongoInfra

Field

Description

configMongos

MongosConfig5_0Enterprise

Configuration for mongos of mongoinfra 5.0 enterprise hosts.

configMongocfg

MongoCfgConfig5_0Enterprise

Configuration for mongocfg of mongoinfra 5.0 enterprise hosts.

resources

Resources

Resources allocated to each mongoinfra (mongos+mongocfg) host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongodbSpec6_0_enterprise

Field

Description

mongod

Mongod

Configuration and resource allocation for mongod 6.0 hosts.

mongocfg

MongoCfg

Configuration and resource allocation for mongocfg 6.0 hosts.

mongos

Mongos

Configuration and resource allocation for mongos 6.0 hosts.

mongoinfra

MongoInfra

Configuration and resource allocation for mongoinfra (mongos+mongocfg) 6.0 hosts.

Mongod

Field

Description

config

MongodConfig6_0Enterprise

Configuration for mongod 6.0 hosts.

resources

Resources

Resources allocated to each mongod host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongodConfig6_0_enterprise

Configuration of a mongod daemon. Supported options are a limited subset of all
options described in MongoDB documentation.

Field

Description

storage

Storage

storage section of mongod configuration.

operationProfiling

OperationProfiling

operationProfiling section of mongod configuration.

net

Network

net section of mongod configuration.

security

Security

security section of mongod configuration.

auditLog

AuditLog

AuditLog section of mongod configuration.

setParameter

SetParameter

SetParameter section of mongod configuration.

Storage

Field

Description

wiredTiger

WiredTiger

Configuration of the WiredTiger storage engine.

journal

Journal

Configuration of the MongoDB journal.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engineConfig

EngineConfig

Engine configuration for WiredTiger.

collectionConfig

CollectionConfig

Collection configuration for WiredTiger.

indexConfig

IndexConfig

Index configuration for WiredTiger

EngineConfig

Field

Description

cacheSizeGb

number (double)

The maximum size of the internal cache that WiredTiger will use for all data.

CollectionConfig

Field

Description

blockCompressor

enum (Compressor)

Default type of compression to use for collection data.

  • NONE: No compression.
  • SNAPPY: The Snappy compression.
  • ZLIB: The zlib compression.
  • ZSTD: The zstd compression.

IndexConfig

Field

Description

prefixCompression

boolean

Enables or disables prefix compression

Journal

Field

Description

commitInterval

string (int64)

Commit interval between journal operations, in milliseconds.
Default: 100.

Acceptable values are 1 to 500, inclusive.

OperationProfiling

Field

Description

mode

enum (Mode)

Mode which specifies operations that should be profiled.

  • OFF: The profiler is off and does not collect any data.
  • SLOW_OP: The profiler collects data for operations that take longer than the value of slowOpThreshold.
  • ALL: The profiler collects data for all operations.

slowOpThreshold

string (int64)

The slow operation time threshold, in milliseconds. Operations that run
for longer than this threshold are considered slow, and are processed by the profiler
running in the SLOW_OP mode.

Value must be greater than 0.

slowOpSampleRate

number (double)

The fraction of slow operations that should be profiled or logged.
operationProfiling.slowOpSampleRate accepts values between 0 and 1, inclusive.

Acceptable values are 0 to 1, inclusive.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of simultaneous connections that mongod will accept.

Acceptable values are 10 to 32768, inclusive.

compression

Compression

Compression settings

Compression

Field

Description

compressors[]

enum (Compressor)

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format.
    MongoDB supports the following compressors:

The number of elements must be in the range 1-3.

  • SNAPPY: The Snappy compression.
  • ZLIB: The zlib compression.
  • ZSTD: The zstd compression.
  • DISABLED: No compression

Security

Field

Description

enableEncryption

boolean

If encryption at rest should be enabled or not

kmip

KMIP

kmip section of mongod security config

KMIP

Field

Description

serverName

string

KMIP server name

port

string (int64)

KMIP server port

serverCa

string

KMIP Server CA

clientCertificate

string

KMIP client certificate + private key (unencrypted)

keyIdentifier

string

KMIP Key identifier (if any)

AuditLog

Field

Description

filter

string

Audit filter

runtimeConfiguration

boolean

Allows runtime configuration of audit filter and auditAuthorizationSuccess

SetParameter

Field

Description

auditAuthorizationSuccess

boolean

Enables the auditing of authorization successes

enableFlowControl

boolean

Enables or disables the mechanism that controls the rate at which the primary applies its writes with the
goal of keeping the secondary members majority committed
lag under a configurable maximum value.

minSnapshotHistoryWindowInSeconds

string (int64)

The minimum time window in seconds for which the storage engine keeps the snapshot history.

The minimum value is 0.

MongoCfg

Field

Description

config

MongoCfgConfig6_0Enterprise

Configuration for mongocfg 6.0 hosts.

resources

Resources

Resources allocated to each mongocfg host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongoCfgConfig6_0_enterprise

Field

Description

storage

Storage

storage section of mongocfg configuration.

operationProfiling

OperationProfiling

operationProfiling section of mongocfg configuration.

net

Network

net section of mongocfg configuration.

Storage

Field

Description

wiredTiger

WiredTiger

Configuration of the WiredTiger storage engine.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engineConfig

EngineConfig

Engine configuration for WiredTiger.

EngineConfig

Field

Description

cacheSizeGb

number (double)

The maximum size of the internal cache that WiredTiger will use for all data.

OperationProfiling

Field

Description

mode

enum (Mode)

Mode which specifies operations that should be profiled.

  • OFF: The profiler is off and does not collect any data.
  • SLOW_OP: The profiler collects data for operations that take longer than the value of slowOpThreshold.
  • ALL: The profiler collects data for all operations.

slowOpThreshold

string (int64)

The slow operation time threshold, in milliseconds. Operations that run
for longer than this threshold are considered slow, and are processed by the profiler
running in the SLOW_OP mode. For details see MongoDB documentation.

Value must be greater than 0.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of simultaneous connections that mongocfg will accept.

Acceptable values are 10 to 32768, inclusive.

Mongos

Field

Description

config

MongosConfig6_0Enterprise

Configuration for mongos 6.0 hosts.

resources

Resources

Resources allocated to each mongos host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongosConfig6_0_enterprise

Field

Description

net

Network

Network settings for mongos.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of simultaneous connections that mongos will accept.

Acceptable values are 10 to 32768, inclusive.

compression

Compression

Compression settings

Compression

Field

Description

compressors[]

enum (Compressor)

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format.
    MongoDB supports the following compressors:

The number of elements must be in the range 1-3.

  • SNAPPY: The Snappy compression.
  • ZLIB: The zlib compression.
  • ZSTD: The zstd compression.
  • DISABLED: No compression

MongoInfra

Field

Description

configMongos

MongosConfig6_0Enterprise

Configuration for mongos of mongoinfra 6.0 enterprise hosts.

configMongocfg

MongoCfgConfig6_0Enterprise

Configuration for mongocfg of mongoinfra 6.0 enterprise hosts.

resources

Resources

Resources allocated to each mongoinfra (mongos+mongocfg) host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

TimeOfDay

Represents a time of day. The date and time zone are either not significant
or are specified elsewhere. An API may choose to allow leap seconds. Related
types are google.type.Date and google.protobuf.Timestamp.

Field

Description

hours

integer (int32)

Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
to allow the value "24:00:00" for scenarios like business closing time.

minutes

integer (int32)

Minutes of hour of day. Must be from 0 to 59.

seconds

integer (int32)

Seconds of minutes of the time. Must normally be from 0 to 59. An API may
allow the value 60 if it allows leap-seconds.

nanos

integer (int32)

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

PerformanceDiagnosticsConfig

Field

Description

profilingEnabled

boolean

Whether profiling is enabled for the cluster.

Access

Field

Description

dataLens

boolean

Allow access for DataLens.

webSql

boolean

Allow access for Web SQL.

dataTransfer

boolean

Allow access for DataTransfer.

MongodbSpec

Field

Description

mongod

Mongod

Configuration and resource allocation for mongod hosts.

mongocfg

MongoCfg

Configuration and resource allocation for mongocfg hosts.

mongos

Mongos

Configuration and resource allocation for mongos hosts.

mongoinfra

MongoInfra

Configuration and resource allocation for mongoinfra (mongos+mongocfg) hosts.

Mongod

Field

Description

config

MongodConfig

Configuration for mongod hosts.

resources

Resources

Resources allocated to each mongod host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongodConfig

Configuration of a mongod daemon. Supported options are a limited subset of all
options described in MongoDB documentation.

Field

Description

storage

Storage

storage section of mongod configuration.

operationProfiling

OperationProfiling

operationProfiling section of mongod configuration.

net

Network

net section of mongod configuration.

security

Security

security section of mongod configuration.

auditLog

AuditLog

AuditLog section of mongod configuration.

setParameter

SetParameter

SetParameter section of mongod configuration.

oplog

Oplog

Oplog section of mongod configuration.

chainingAllowed

boolean

Chained replication setting

Storage

Field

Description

wiredTiger

WiredTiger

Configuration of the WiredTiger storage engine.

journal

Journal

Configuration of the MongoDB journal.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engineConfig

EngineConfig

Engine configuration for WiredTiger.

collectionConfig

CollectionConfig

Collection configuration for WiredTiger.

indexConfig

IndexConfig

Index configuration for WiredTiger

EngineConfig

Field

Description

cacheSizeGb

number (double)

The maximum size of the internal cache that WiredTiger will use for all data.

cacheSize

number (double)

The maximum size of the internal cache that WiredTiger will use for all data in percents.

CollectionConfig

Field

Description

blockCompressor

enum (Compressor)

Default type of compression to use for collection data.

  • NONE: No compression.
  • SNAPPY: The Snappy compression.
  • ZLIB: The zlib compression.
  • ZSTD: The zstd compression.

IndexConfig

Field

Description

prefixCompression

boolean

Enables or disables prefix compression

Journal

Field

Description

commitInterval

string (int64)

Commit interval between journal operations, in milliseconds.
Default: 100.

Acceptable values are 1 to 500, inclusive.

OperationProfiling

Field

Description

mode

enum (Mode)

Mode which specifies operations that should be profiled.

  • OFF: The profiler is off and does not collect any data.
  • SLOW_OP: The profiler collects data for operations that take longer than the value of slowOpThreshold.
  • ALL: The profiler collects data for all operations.

slowOpThreshold

string (int64)

The slow operation time threshold, in milliseconds. Operations that run
for longer than this threshold are considered slow, and are processed by the profiler
running in the SLOW_OP mode.

Value must be greater than 0.

slowOpSampleRate

number (double)

The fraction of slow operations that should be profiled or logged.
operationProfiling.slowOpSampleRate accepts values between 0 and 1, inclusive.

Acceptable values are 0 to 1, inclusive.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of simultaneous connections that mongod will accept.

Acceptable values are 10 to 32768, inclusive.

compression

Compression

Compression settings

Compression

Field

Description

compressors[]

enum (Compressor)

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format.
    MongoDB supports the following compressors:

The number of elements must be in the range 1-3.

  • SNAPPY: The Snappy compression.
  • ZLIB: The zlib compression.
  • ZSTD: The zstd compression.
  • DISABLED: No compression

Security

Field

Description

enableEncryption

boolean

If encryption at rest should be enabled or not

kmip

KMIP

kmip section of mongod security config

KMIP

Field

Description

serverName

string

KMIP server name

port

string (int64)

KMIP server port

serverCa

string

KMIP Server CA

clientCertificate

string

KMIP client certificate + private key (unencrypted)

keyIdentifier

string

KMIP Key identifier (if any)

AuditLog

Field

Description

filter

string

Audit filter

runtimeConfiguration

boolean

Allows runtime configuration of audit filter and auditAuthorizationSuccess

SetParameter

Field

Description

auditAuthorizationSuccess

boolean

Enables the auditing of authorization successes

enableFlowControl

boolean

Enables or disables the mechanism that controls the rate at which the primary applies its writes with the
goal of keeping the secondary members majority committed
lag under a configurable maximum value.

minSnapshotHistoryWindowInSeconds

string (int64)

The minimum time window in seconds for which the storage engine keeps the snapshot history.

The minimum value is 0.

flowControlTargetLagSeconds

string (int64)

The target maximum majority committed lag when running with flow control

Value must be greater than 0.

flowControlWarnThresholdSeconds

string (int64)

The amount of time to wait to log a warning once the flow control mechanism detects the majority commit point has not moved.

The minimum value is 0.

migrateCloneInsertionBatchDelayMs

string (int64)

Time in milliseconds to wait between batches of insertions during cloning step of the migration process.

The minimum value is 0.

migrateCloneInsertionBatchSize

string (int64)

The maximum number of documents to insert in a single batch during the cloning step of the migration process.

The minimum value is 0.

orphanCleanupDelaySecs

string (int64)

Minimum delay before a migrated chunk is deleted from the source shard.

persistedChunkCacheUpdateMaxBatchSize

string (int64)

Specifies the maximum batch size used for updating the persisted chunk cache.

rangeDeleterBatchDelayMs

string (int64)

The amount of time in milliseconds to wait before the next batch of deletion during the cleanup stage of chunk migration (or the cleanupOrphaned command).

The minimum value is 0.

rangeDeleterBatchSize

string (int64)

The maximum number of documents in each batch to delete during the cleanup stage of chunk migration (or the cleanupOrphaned command).

The minimum value is 0.

mirrorReads

MirrorReads

Specifies the settings for mirrored reads for the mongod instance

redactClientLogData

boolean

Enables redacting any message accompanying a given log event before logging.
This prevents the mongod or mongos from writing potentially sensitive data
stored on the database to the diagnostic log.
https://mongo-db.ru/reference/configuration-options/index.html#mongodb-setting-security.redactClientLogData

MirrorReads

Field

Description

samplingRate

number (double)

The sampling rate used to mirror a subset of operations that support mirroring.

maxTimeMs

string (int64)

The maximum time in milliseconds for the mirrored reads.

Oplog

Field

Description

maxSizePercent

string (int64)

Oplog maxsize in percents.

minRetentionHours

number (double)

The minimum number of hours to preserve an oplog entry, where decimal values represent the fractions of an hour.

MongoCfg

Field

Description

config

MongoCfgConfig

Configuration for mongocfg hosts.

resources

Resources

Resources allocated to each mongocfg host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongoCfgConfig

Field

Description

storage

Storage

storage section of mongocfg configuration.

operationProfiling

OperationProfiling

operationProfiling section of mongocfg configuration.

net

Network

net section of mongocfg configuration.

setParameter

SetParameter

setParameter section of mongocfg configuration.

auditLog

AuditLog

AuditLog section of mongocfg configuration.

oplog

Oplog

Oplog section of mongod configuration.

chainingAllowed

boolean

Chained replication setting

Storage

Field

Description

wiredTiger

WiredTiger

Configuration of the WiredTiger storage engine.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engineConfig

EngineConfig

Engine configuration for WiredTiger.

EngineConfig

Field

Description

cacheSizeGb

number (double)

The maximum size of the internal cache that WiredTiger will use for all data.

cacheSize

number (double)

The maximum size of the internal cache that WiredTiger will use for all data in percents.

OperationProfiling

Field

Description

mode

enum (Mode)

Mode which specifies operations that should be profiled.

  • OFF: The profiler is off and does not collect any data.
  • SLOW_OP: The profiler collects data for operations that take longer than the value of slowOpThreshold.
  • ALL: The profiler collects data for all operations.

slowOpThreshold

string (int64)

The slow operation time threshold, in milliseconds. Operations that run
for longer than this threshold are considered slow, and are processed by the profiler
running in the SLOW_OP mode. For details see MongoDB documentation.

Value must be greater than 0.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of simultaneous connections that mongocfg will accept.

Acceptable values are 10 to 32768, inclusive.

SetParameter

Field

Description

enableFlowControl

boolean

Enables or disables the mechanism that controls the rate at which the primary applies its writes with the
goal of keeping the secondary members majority committed
lag under a configurable maximum value.

auditAuthorizationSuccess

boolean

Enables the auditing of authorization successes
https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.auditAuthorizationSuccess

redactClientLogData

boolean

Enables redacting any message accompanying a given log event before logging.
This prevents the mongod or mongos from writing potentially sensitive data
stored on the database to the diagnostic log.
https://mongo-db.ru/reference/configuration-options/index.html#mongodb-setting-security.redactClientLogData

AuditLog

Field

Description

filter

string

Audit filter, should be valid JSON object string

Oplog

Field

Description

maxSizePercent

string (int64)

Oplog maxsize in percents.

minRetentionHours

number (double)

The minimum number of hours to preserve an oplog entry, where decimal values represent the fractions of an hour.

Mongos

Field

Description

config

MongosConfig

Configuration for mongos hosts.

resources

Resources

Resources allocated to each mongos host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongosConfig

Field

Description

net

Network

Network settings for mongos.

setParameter

SetParameter

setParameter section of mongos configuration.

auditLog

AuditLog

AuditLog section of mongos configuration.

chunkSize

string (int64)

ChunkSize parameter of mongos configuration.

Network

Field

Description

maxIncomingConnections

string (int64)

The maximum number of simultaneous connections that mongos will accept.

Acceptable values are 10 to 32768, inclusive.

compression

Compression

Compression settings

Compression

Field

Description

compressors[]

enum (Compressor)

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format.
    MongoDB supports the following compressors:

The number of elements must be in the range 1-3.

  • SNAPPY: The Snappy compression.
  • ZLIB: The zlib compression.
  • ZSTD: The zstd compression.
  • DISABLED: No compression

SetParameter

Field

Description

auditAuthorizationSuccess

boolean

Enables the auditing of authorization successes
https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.auditAuthorizationSuccess

readHedgingMode

string

Specifies whether mongos supports hedged reads for those read operations whose read preference have enabled the hedged read option.

shardingTaskExecutorPoolMaxSize

string (int64)

Maximum number of outbound connections each TaskExecutor connection pool can open to any given mongod instance.

shardingTaskExecutorPoolMaxConnecting

string (int64)

Maximum number of simultaneous initiating connections (including pending connections in setup/refresh state) each TaskExecutor connection pool can have to a mongod instance.

shardingTaskExecutorPoolMinSize

string (int64)

Minimum number of outbound connections each TaskExecutor connection pool can open to any given mongod instance.

shardingTaskExecutorPoolReplicaSetMatching

string

On a mongos instance, this parameter sets the policy that determines the minimum size limit of its connection pools to nodes within replica sets.

shardingTaskExecutorPoolHostTimeoutMs

string (int64)

Maximum time that mongos goes without communication to a host before mongos drops all connections to the host.

shardingTaskExecutorPoolRefreshRequirementMs

string (int64)

Maximum time the mongos waits before attempting to heartbeat an idle connection in the pool.

shardingTaskExecutorPoolRefreshTimeoutMs

string (int64)

Maximum time the mongos waits for a heartbeat before timing out the heartbeat.

warmMinConnectionsInShardingTaskExecutorPoolOnStartup

boolean

Configures a mongos instance to prewarm its connection pool on startup.

warmMinConnectionsInShardingTaskExecutorPoolOnStartupWaitMs

string (int64)

Sets the timeout threshold in milliseconds for a mongos to wait for ShardingTaskExecutorPoolMinSize connections to be established per shard host when using the warmMinConnectionsInShardingTaskExecutorPoolOnStartup parameter.

shardingTaskExecutorPoolMaxSizeForConfigServers

string (int64)

Optional override for ShardingTaskExecutorPoolMaxSize to set the maximum number of outbound connections each TaskExecutor connection pool can open to a configuration server.

shardingTaskExecutorPoolMinSizeForConfigServers

string (int64)

Optional override for ShardingTaskExecutorPoolMinSize to set the minimum number of outbound connections each TaskExecutor connection pool can open to a configuration server.

redactClientLogData

boolean

Enables redacting any message accompanying a given log event before logging.
This prevents the mongod or mongos from writing potentially sensitive data
stored on the database to the diagnostic log.
https://mongo-db.ru/reference/configuration-options/index.html#mongodb-setting-security.redactClientLogData

AuditLog

Field

Description

filter

string

Audit filter, should be valid JSON object string

MongoInfra

Field

Description

configMongos

MongosConfig

Configuration for mongos of mongoinfra hosts.

configMongocfg

MongoCfgConfig

Configuration for mongocfg of mongoinfra hosts.

resources

Resources

Resources allocated to each mongoinfra (mongos+mongocfg) host.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

AutoCompactConfig

Field

Description

enabled

boolean

Enable autocompact.

targetFreeSpace

string (int64)

Minimum estimated amount of space to be freed by compact operation to run.

bloatPercent

number (double)

Minimum percentage of bloat of collection to be compacted.

compactionType

enum (CompactionType)

Type of compaction. Either switch primary to run compaction on all hosts or ignore primary host.

  • COMPACTION_TYPE_IGNORE_PRIMARY
  • COMPACTION_TYPE_SWITCH_PRIMARY

MaintenanceWindow

A maintenance window settings.

Field

Description

anytime

object

Maintenance operation can be scheduled anytime.

Includes only one of the fields anytime, weeklyMaintenanceWindow.

The maintenance policy in effect.

weeklyMaintenanceWindow

WeeklyMaintenanceWindow

Maintenance operation can be scheduled on a weekly basis.

Includes only one of the fields anytime, weeklyMaintenanceWindow.

The maintenance policy in effect.

WeeklyMaintenanceWindow

Weelky maintenance window settings.

Field

Description

day

enum (WeekDay)

Day of the week (in DDD format).

  • MON: Monday.
  • TUE: Tuesday.
  • WED: Wednesday.
  • THU: Thursday.
  • FRI: Friday.
  • SAT: Saturday.
  • SUN: Sunday.

hour

string (int64)

Hour of the day in UTC (in HH format).

Acceptable values are 1 to 24, inclusive.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": "object",
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object"
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

object

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

object

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

Status

The error result of the operation in case of failure or cancellation.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.
Previous
Create
Next
Delete