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

Managed Service for MongoDB API, gRPC: ClusterService.Create

Written by
Updated at June 1, 2026

Creates a MongoDB cluster in the specified folder.

gRPC request

rpc Create (CreateClusterRequest) returns (operation.Operation)

CreateClusterRequest

{
  "folder_id": "string",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "environment": "Environment",
  "config_spec": {
    "version": "string",
    "feature_compatibility_version": "string",
    // Includes only one of the fields `mongodb_spec_3_6`, `mongodb_spec_4_0`, `mongodb_spec_4_2`, `mongodb_spec_4_4`, `mongodb_spec_5_0`, `mongodb_spec_6_0`, `mongodb_spec_4_4_enterprise`, `mongodb_spec_5_0_enterprise`, `mongodb_spec_6_0_enterprise`
    "mongodb_spec_3_6": {
      "mongod": {
        "config": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue"
              },
              "collection_config": {
                "block_compressor": "Compressor"
              }
            },
            "journal": {
              "enabled": "google.protobuf.BoolValue",
              "commit_interval": "google.protobuf.Int64Value"
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value"
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongocfg": {
        "config": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue"
              }
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value"
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongos": {
        "config": {
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value"
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongoinfra": {
        "config_mongos": {
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value"
          }
        },
        "config_mongocfg": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue"
              }
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value"
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      }
    },
    "mongodb_spec_4_0": {
      "mongod": {
        "config": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue"
              },
              "collection_config": {
                "block_compressor": "Compressor"
              }
            },
            "journal": {
              "commit_interval": "google.protobuf.Int64Value"
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value"
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongocfg": {
        "config": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue"
              }
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value"
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongos": {
        "config": {
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value"
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongoinfra": {
        "config_mongos": {
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value"
          }
        },
        "config_mongocfg": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue"
              }
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value"
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      }
    },
    "mongodb_spec_4_2": {
      "mongod": {
        "config": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue"
              },
              "collection_config": {
                "block_compressor": "Compressor"
              },
              "index_config": {
                "prefix_compression": "google.protobuf.BoolValue"
              }
            },
            "journal": {
              "commit_interval": "google.protobuf.Int64Value"
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value",
            "slow_op_sample_rate": "google.protobuf.DoubleValue"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value",
            "compression": {
              "compressors": [
                "Compressor"
              ]
            }
          },
          "set_parameter": {
            "enable_flow_control": "google.protobuf.BoolValue"
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongocfg": {
        "config": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue"
              }
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value"
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongos": {
        "config": {
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value",
            "compression": {
              "compressors": [
                "Compressor"
              ]
            }
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongoinfra": {
        "config_mongos": {
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value",
            "compression": {
              "compressors": [
                "Compressor"
              ]
            }
          }
        },
        "config_mongocfg": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue"
              }
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value"
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      }
    },
    "mongodb_spec_4_4": {
      "mongod": {
        "config": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue"
              },
              "collection_config": {
                "block_compressor": "Compressor"
              },
              "index_config": {
                "prefix_compression": "google.protobuf.BoolValue"
              }
            },
            "journal": {
              "commit_interval": "google.protobuf.Int64Value"
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value",
            "slow_op_sample_rate": "google.protobuf.DoubleValue"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value",
            "compression": {
              "compressors": [
                "Compressor"
              ]
            }
          },
          "set_parameter": {
            "enable_flow_control": "google.protobuf.BoolValue"
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongocfg": {
        "config": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue"
              }
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value"
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongos": {
        "config": {
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value",
            "compression": {
              "compressors": [
                "Compressor"
              ]
            }
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongoinfra": {
        "config_mongos": {
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value",
            "compression": {
              "compressors": [
                "Compressor"
              ]
            }
          }
        },
        "config_mongocfg": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue"
              }
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value"
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      }
    },
    "mongodb_spec_5_0": {
      "mongod": {
        "config": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue"
              },
              "collection_config": {
                "block_compressor": "Compressor"
              },
              "index_config": {
                "prefix_compression": "google.protobuf.BoolValue"
              }
            },
            "journal": {
              "commit_interval": "google.protobuf.Int64Value"
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value",
            "slow_op_sample_rate": "google.protobuf.DoubleValue"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value",
            "compression": {
              "compressors": [
                "Compressor"
              ]
            }
          },
          "set_parameter": {
            "enable_flow_control": "google.protobuf.BoolValue",
            "min_snapshot_history_window_in_seconds": "google.protobuf.Int64Value"
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongocfg": {
        "config": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue"
              }
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value"
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongos": {
        "config": {
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value",
            "compression": {
              "compressors": [
                "Compressor"
              ]
            }
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongoinfra": {
        "config_mongos": {
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value",
            "compression": {
              "compressors": [
                "Compressor"
              ]
            }
          }
        },
        "config_mongocfg": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue"
              }
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value"
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      }
    },
    "mongodb_spec_6_0": {
      "mongod": {
        "config": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue"
              },
              "collection_config": {
                "block_compressor": "Compressor"
              },
              "index_config": {
                "prefix_compression": "google.protobuf.BoolValue"
              }
            },
            "journal": {
              "commit_interval": "google.protobuf.Int64Value"
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value",
            "slow_op_sample_rate": "google.protobuf.DoubleValue"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value",
            "compression": {
              "compressors": [
                "Compressor"
              ]
            }
          },
          "set_parameter": {
            "enable_flow_control": "google.protobuf.BoolValue",
            "min_snapshot_history_window_in_seconds": "google.protobuf.Int64Value"
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongocfg": {
        "config": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue"
              }
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value"
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongos": {
        "config": {
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value",
            "compression": {
              "compressors": [
                "Compressor"
              ]
            }
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongoinfra": {
        "config_mongos": {
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value",
            "compression": {
              "compressors": [
                "Compressor"
              ]
            }
          }
        },
        "config_mongocfg": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue"
              }
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value"
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      }
    },
    "mongodb_spec_4_4_enterprise": {
      "mongod": {
        "config": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue"
              },
              "collection_config": {
                "block_compressor": "Compressor"
              },
              "index_config": {
                "prefix_compression": "google.protobuf.BoolValue"
              }
            },
            "journal": {
              "commit_interval": "google.protobuf.Int64Value"
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value",
            "slow_op_sample_rate": "google.protobuf.DoubleValue"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value",
            "compression": {
              "compressors": [
                "Compressor"
              ]
            }
          },
          "security": {
            "enable_encryption": "google.protobuf.BoolValue",
            "kmip": {
              "server_name": "string",
              "port": "google.protobuf.Int64Value",
              "server_ca": "string",
              "client_certificate": "string",
              "key_identifier": "string"
            }
          },
          "audit_log": {
            "filter": "string"
          },
          "set_parameter": {
            "audit_authorization_success": "google.protobuf.BoolValue",
            "enable_flow_control": "google.protobuf.BoolValue"
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongocfg": {
        "config": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue"
              }
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value"
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongos": {
        "config": {
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value",
            "compression": {
              "compressors": [
                "Compressor"
              ]
            }
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongoinfra": {
        "config_mongos": {
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value",
            "compression": {
              "compressors": [
                "Compressor"
              ]
            }
          }
        },
        "config_mongocfg": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue"
              }
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value"
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      }
    },
    "mongodb_spec_5_0_enterprise": {
      "mongod": {
        "config": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue"
              },
              "collection_config": {
                "block_compressor": "Compressor"
              },
              "index_config": {
                "prefix_compression": "google.protobuf.BoolValue"
              }
            },
            "journal": {
              "commit_interval": "google.protobuf.Int64Value"
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value",
            "slow_op_sample_rate": "google.protobuf.DoubleValue"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value",
            "compression": {
              "compressors": [
                "Compressor"
              ]
            }
          },
          "security": {
            "enable_encryption": "google.protobuf.BoolValue",
            "kmip": {
              "server_name": "string",
              "port": "google.protobuf.Int64Value",
              "server_ca": "string",
              "client_certificate": "string",
              "key_identifier": "string"
            }
          },
          "audit_log": {
            "filter": "string",
            "runtime_configuration": "google.protobuf.BoolValue"
          },
          "set_parameter": {
            "audit_authorization_success": "google.protobuf.BoolValue",
            "enable_flow_control": "google.protobuf.BoolValue",
            "min_snapshot_history_window_in_seconds": "google.protobuf.Int64Value"
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongocfg": {
        "config": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue"
              }
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value"
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongos": {
        "config": {
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value",
            "compression": {
              "compressors": [
                "Compressor"
              ]
            }
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongoinfra": {
        "config_mongos": {
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value",
            "compression": {
              "compressors": [
                "Compressor"
              ]
            }
          }
        },
        "config_mongocfg": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue"
              }
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value"
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      }
    },
    "mongodb_spec_6_0_enterprise": {
      "mongod": {
        "config": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue"
              },
              "collection_config": {
                "block_compressor": "Compressor"
              },
              "index_config": {
                "prefix_compression": "google.protobuf.BoolValue"
              }
            },
            "journal": {
              "commit_interval": "google.protobuf.Int64Value"
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value",
            "slow_op_sample_rate": "google.protobuf.DoubleValue"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value",
            "compression": {
              "compressors": [
                "Compressor"
              ]
            }
          },
          "security": {
            "enable_encryption": "google.protobuf.BoolValue",
            "kmip": {
              "server_name": "string",
              "port": "google.protobuf.Int64Value",
              "server_ca": "string",
              "client_certificate": "string",
              "key_identifier": "string"
            }
          },
          "audit_log": {
            "filter": "string",
            "runtime_configuration": "google.protobuf.BoolValue"
          },
          "set_parameter": {
            "audit_authorization_success": "google.protobuf.BoolValue",
            "enable_flow_control": "google.protobuf.BoolValue",
            "min_snapshot_history_window_in_seconds": "google.protobuf.Int64Value"
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongocfg": {
        "config": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue"
              }
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value"
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongos": {
        "config": {
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value",
            "compression": {
              "compressors": [
                "Compressor"
              ]
            }
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongoinfra": {
        "config_mongos": {
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value",
            "compression": {
              "compressors": [
                "Compressor"
              ]
            }
          }
        },
        "config_mongocfg": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue"
              }
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value"
          }
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      }
    },
    // end of the list of possible fields
    "backup_window_start": "google.type.TimeOfDay",
    "backup_retain_period_days": "google.protobuf.Int64Value",
    "performance_diagnostics": {
      "profiling_enabled": "bool"
    },
    "access": {
      "data_lens": "bool",
      "web_sql": "bool",
      "data_transfer": "bool"
    },
    "mongodb": {
      "mongod": {
        "config": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue",
                "cache_size": "google.protobuf.DoubleValue"
              },
              "collection_config": {
                "block_compressor": "Compressor"
              },
              "index_config": {
                "prefix_compression": "google.protobuf.BoolValue"
              }
            },
            "journal": {
              "commit_interval": "google.protobuf.Int64Value"
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value",
            "slow_op_sample_rate": "google.protobuf.DoubleValue"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value",
            "compression": {
              "compressors": [
                "Compressor"
              ]
            }
          },
          "security": {
            "enable_encryption": "google.protobuf.BoolValue",
            "kmip": {
              "server_name": "string",
              "port": "google.protobuf.Int64Value",
              "server_ca": "string",
              "client_certificate": "string",
              "key_identifier": "string"
            }
          },
          "audit_log": {
            "filter": "string",
            "runtime_configuration": "google.protobuf.BoolValue"
          },
          "set_parameter": {
            "audit_authorization_success": "google.protobuf.BoolValue",
            "enable_flow_control": "google.protobuf.BoolValue",
            "min_snapshot_history_window_in_seconds": "google.protobuf.Int64Value",
            "flow_control_target_lag_seconds": "google.protobuf.Int64Value",
            "flow_control_warn_threshold_seconds": "google.protobuf.Int64Value",
            "migrate_clone_insertion_batch_delay_ms": "google.protobuf.Int64Value",
            "migrate_clone_insertion_batch_size": "google.protobuf.Int64Value",
            "orphan_cleanup_delay_secs": "google.protobuf.Int64Value",
            "persisted_chunk_cache_update_max_batch_size": "google.protobuf.Int64Value",
            "range_deleter_batch_delay_ms": "google.protobuf.Int64Value",
            "range_deleter_batch_size": "google.protobuf.Int64Value",
            "mirror_reads": {
              "sampling_rate": "google.protobuf.DoubleValue",
              "max_time_ms": "google.protobuf.Int64Value"
            },
            "redact_client_log_data": "google.protobuf.BoolValue"
          },
          "oplog": {
            "max_size_percent": "google.protobuf.Int64Value",
            "min_retention_hours": "google.protobuf.DoubleValue"
          },
          "chaining_allowed": "google.protobuf.BoolValue"
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongocfg": {
        "config": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue",
                "cache_size": "google.protobuf.DoubleValue"
              }
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value"
          },
          "set_parameter": {
            "enable_flow_control": "google.protobuf.BoolValue",
            "audit_authorization_success": "google.protobuf.BoolValue",
            "redact_client_log_data": "google.protobuf.BoolValue"
          },
          "audit_log": {
            "filter": "string"
          },
          "oplog": {
            "max_size_percent": "google.protobuf.Int64Value",
            "min_retention_hours": "google.protobuf.DoubleValue"
          },
          "chaining_allowed": "google.protobuf.BoolValue"
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongos": {
        "config": {
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value",
            "compression": {
              "compressors": [
                "Compressor"
              ]
            }
          },
          "set_parameter": {
            "audit_authorization_success": "google.protobuf.BoolValue",
            "read_hedging_mode": "google.protobuf.StringValue",
            "sharding_task_executor_pool_max_size": "google.protobuf.Int64Value",
            "sharding_task_executor_pool_max_connecting": "google.protobuf.Int64Value",
            "sharding_task_executor_pool_min_size": "google.protobuf.Int64Value",
            "sharding_task_executor_pool_replica_set_matching": "google.protobuf.StringValue",
            "sharding_task_executor_pool_host_timeout_ms": "google.protobuf.Int64Value",
            "sharding_task_executor_pool_refresh_requirement_ms": "google.protobuf.Int64Value",
            "sharding_task_executor_pool_refresh_timeout_ms": "google.protobuf.Int64Value",
            "warm_min_connections_in_sharding_task_executor_pool_on_startup": "google.protobuf.BoolValue",
            "warm_min_connections_in_sharding_task_executor_pool_on_startup_wait_ms": "google.protobuf.Int64Value",
            "sharding_task_executor_pool_max_size_for_config_servers": "google.protobuf.Int64Value",
            "sharding_task_executor_pool_min_size_for_config_servers": "google.protobuf.Int64Value",
            "redact_client_log_data": "google.protobuf.BoolValue"
          },
          "audit_log": {
            "filter": "string"
          },
          "chunk_size": "google.protobuf.Int64Value"
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      },
      "mongoinfra": {
        "config_mongos": {
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value",
            "compression": {
              "compressors": [
                "Compressor"
              ]
            }
          },
          "set_parameter": {
            "audit_authorization_success": "google.protobuf.BoolValue",
            "read_hedging_mode": "google.protobuf.StringValue",
            "sharding_task_executor_pool_max_size": "google.protobuf.Int64Value",
            "sharding_task_executor_pool_max_connecting": "google.protobuf.Int64Value",
            "sharding_task_executor_pool_min_size": "google.protobuf.Int64Value",
            "sharding_task_executor_pool_replica_set_matching": "google.protobuf.StringValue",
            "sharding_task_executor_pool_host_timeout_ms": "google.protobuf.Int64Value",
            "sharding_task_executor_pool_refresh_requirement_ms": "google.protobuf.Int64Value",
            "sharding_task_executor_pool_refresh_timeout_ms": "google.protobuf.Int64Value",
            "warm_min_connections_in_sharding_task_executor_pool_on_startup": "google.protobuf.BoolValue",
            "warm_min_connections_in_sharding_task_executor_pool_on_startup_wait_ms": "google.protobuf.Int64Value",
            "sharding_task_executor_pool_max_size_for_config_servers": "google.protobuf.Int64Value",
            "sharding_task_executor_pool_min_size_for_config_servers": "google.protobuf.Int64Value",
            "redact_client_log_data": "google.protobuf.BoolValue"
          },
          "audit_log": {
            "filter": "string"
          },
          "chunk_size": "google.protobuf.Int64Value"
        },
        "config_mongocfg": {
          "storage": {
            "wired_tiger": {
              "engine_config": {
                "cache_size_gb": "google.protobuf.DoubleValue",
                "cache_size": "google.protobuf.DoubleValue"
              }
            }
          },
          "operation_profiling": {
            "mode": "Mode",
            "slow_op_threshold": "google.protobuf.Int64Value"
          },
          "net": {
            "max_incoming_connections": "google.protobuf.Int64Value"
          },
          "set_parameter": {
            "enable_flow_control": "google.protobuf.BoolValue",
            "audit_authorization_success": "google.protobuf.BoolValue",
            "redact_client_log_data": "google.protobuf.BoolValue"
          },
          "audit_log": {
            "filter": "string"
          },
          "oplog": {
            "max_size_percent": "google.protobuf.Int64Value",
            "min_retention_hours": "google.protobuf.DoubleValue"
          },
          "chaining_allowed": "google.protobuf.BoolValue"
        },
        "resources": {
          "resource_preset_id": "string",
          "disk_size": "int64",
          "disk_type_id": "string"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "google.protobuf.Int64Value",
          "emergency_usage_threshold": "google.protobuf.Int64Value",
          "disk_size_limit": "google.protobuf.Int64Value"
        }
      }
    },
    "autocompact_config": {
      "enabled": "bool",
      "target_free_space": "google.protobuf.Int64Value",
      "bloat_percent": "google.protobuf.DoubleValue",
      "compaction_type": "CompactionType"
    }
  },
  "database_specs": [
    {
      "name": "string"
    }
  ],
  "user_specs": [
    {
      "name": "string",
      "password": "string",
      "permissions": [
        {
          "database_name": "string",
          "roles": [
            "string"
          ]
        }
      ]
    }
  ],
  "host_specs": [
    {
      "zone_id": "string",
      "subnet_id": "string",
      "assign_public_ip": "bool",
      "type": "Type",
      "shard_name": "string",
      "hidden": "google.protobuf.BoolValue",
      "secondary_delay_secs": "google.protobuf.Int64Value",
      "priority": "google.protobuf.DoubleValue",
      "tags": "map<string, string>"
    }
  ],
  "network_id": "string",
  "security_group_ids": [
    "string"
  ],
  "deletion_protection": "bool",
  "maintenance_window": {
    // Includes only one of the fields `anytime`, `weekly_maintenance_window`
    "anytime": "AnytimeMaintenanceWindow",
    "weekly_maintenance_window": {
      "day": "WeekDay",
      "hour": "int64"
    }
    // end of the list of possible fields
  },
  "disk_encryption_key_id": "google.protobuf.StringValue",
  "retention_policies": [
    {
      "policy_name": "string",
      "cron": {
        "day_of_month": "string",
        "month": "string",
        "day_of_week": "string"
      },
      "retain_for_days": "int64",
      "description": "string"
    }
  ]
}

Field

Description

folder_id

string

Required field. ID of the folder to create MongoDB cluster in.

The maximum string length in characters is 50.

name

string

Required field. Name of the MongoDB cluster. The name must be unique within the folder.

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

description

string

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 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.

environment

enum Environment

Required field. Deployment environment of the MongoDB cluster.

  • PRODUCTION: Stable environment with a conservative update policy: only hotfixes
    are applied during regular maintenance.
  • PRESTABLE: Environment with more aggressive update policy: new versions
    are rolled out irrespective of backward compatibility.

config_spec

ConfigSpec

Required field. Configuration and resources for hosts that should be created for the MongoDB cluster.

database_specs[]

DatabaseSpec

Descriptions of databases to be created in the MongoDB cluster.

user_specs[]

UserSpec

Descriptions of database users to be created in the MongoDB cluster.

host_specs[]

HostSpec

Individual configurations for hosts that should be created for the MongoDB cluster.

The number of elements must be greater than 0.

network_id

string

ID of the network to create the cluster in.

The maximum string length in characters is 150.

security_group_ids[]

string

User security groups

deletion_protection

bool

Deletion Protection inhibits deletion of the cluster

maintenance_window

MaintenanceWindow

Maintenance window settings for the cluster.

disk_encryption_key_id

google.protobuf.StringValue

ID of the key to encrypt cluster disks.

retention_policies[]

BackupRetentionPolicySpec

Backup long-term retention policies setting.

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.

feature_compatibility_version

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.

mongodb_spec_3_6

MongodbSpec3_6

Configuration and resource allocation for a MongoDB 3.6 cluster.

Includes only one of the fields mongodb_spec_3_6, mongodb_spec_4_0, mongodb_spec_4_2, mongodb_spec_4_4, mongodb_spec_5_0, mongodb_spec_6_0, mongodb_spec_4_4_enterprise, mongodb_spec_5_0_enterprise, mongodb_spec_6_0_enterprise.

mongodb_spec_4_0

MongodbSpec4_0

Configuration and resource allocation for a MongoDB 4.0 cluster.

Includes only one of the fields mongodb_spec_3_6, mongodb_spec_4_0, mongodb_spec_4_2, mongodb_spec_4_4, mongodb_spec_5_0, mongodb_spec_6_0, mongodb_spec_4_4_enterprise, mongodb_spec_5_0_enterprise, mongodb_spec_6_0_enterprise.

mongodb_spec_4_2

MongodbSpec4_2

Configuration and resource allocation for a MongoDB 4.2 cluster.

Includes only one of the fields mongodb_spec_3_6, mongodb_spec_4_0, mongodb_spec_4_2, mongodb_spec_4_4, mongodb_spec_5_0, mongodb_spec_6_0, mongodb_spec_4_4_enterprise, mongodb_spec_5_0_enterprise, mongodb_spec_6_0_enterprise.

mongodb_spec_4_4

MongodbSpec4_4

Configuration and resource allocation for a MongoDB 4.4 cluster.

Includes only one of the fields mongodb_spec_3_6, mongodb_spec_4_0, mongodb_spec_4_2, mongodb_spec_4_4, mongodb_spec_5_0, mongodb_spec_6_0, mongodb_spec_4_4_enterprise, mongodb_spec_5_0_enterprise, mongodb_spec_6_0_enterprise.

mongodb_spec_5_0

MongodbSpec5_0

Configuration and resource allocation for a MongoDB 5.0 cluster.

Includes only one of the fields mongodb_spec_3_6, mongodb_spec_4_0, mongodb_spec_4_2, mongodb_spec_4_4, mongodb_spec_5_0, mongodb_spec_6_0, mongodb_spec_4_4_enterprise, mongodb_spec_5_0_enterprise, mongodb_spec_6_0_enterprise.

mongodb_spec_6_0

MongodbSpec6_0

Configuration and resource allocation for a MongoDB 6.0 cluster.

Includes only one of the fields mongodb_spec_3_6, mongodb_spec_4_0, mongodb_spec_4_2, mongodb_spec_4_4, mongodb_spec_5_0, mongodb_spec_6_0, mongodb_spec_4_4_enterprise, mongodb_spec_5_0_enterprise, mongodb_spec_6_0_enterprise.

mongodb_spec_4_4_enterprise

MongodbSpec4_4_enterprise

Configuration and resource allocation for a MongoDB 4.4 Enterprise cluster.

Includes only one of the fields mongodb_spec_3_6, mongodb_spec_4_0, mongodb_spec_4_2, mongodb_spec_4_4, mongodb_spec_5_0, mongodb_spec_6_0, mongodb_spec_4_4_enterprise, mongodb_spec_5_0_enterprise, mongodb_spec_6_0_enterprise.

mongodb_spec_5_0_enterprise

MongodbSpec5_0_enterprise

Configuration and resource allocation for a MongoDB 5.0 Enterprise cluster.

Includes only one of the fields mongodb_spec_3_6, mongodb_spec_4_0, mongodb_spec_4_2, mongodb_spec_4_4, mongodb_spec_5_0, mongodb_spec_6_0, mongodb_spec_4_4_enterprise, mongodb_spec_5_0_enterprise, mongodb_spec_6_0_enterprise.

mongodb_spec_6_0_enterprise

MongodbSpec6_0_enterprise

Configuration and resource allocation for a MongoDB 6.0 Enterprise cluster.

Includes only one of the fields mongodb_spec_3_6, mongodb_spec_4_0, mongodb_spec_4_2, mongodb_spec_4_4, mongodb_spec_5_0, mongodb_spec_6_0, mongodb_spec_4_4_enterprise, mongodb_spec_5_0_enterprise, mongodb_spec_6_0_enterprise.

backup_window_start

google.type.TimeOfDay

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

backup_retain_period_days

google.protobuf.Int64Value

Retain period of automatically created backup in days

Acceptable values are 7 to 35, inclusive.

performance_diagnostics

PerformanceDiagnosticsConfig

Performance Diagnosics configuration

access

Access

Access policy to DB

mongodb

MongodbSpec

Configuration and resource allocation for a MongoDB 7.0 Enterprise cluster.

autocompact_config

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.

disk_size_autoscaling

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.

operation_profiling

OperationProfiling

operationProfiling section of mongod configuration.

net

Network

net section of mongod configuration.

Storage

Field

Description

wired_tiger

WiredTiger

Configuration of the WiredTiger storage engine.

journal

Journal

Configuration of the MongoDB journal.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engine_config

EngineConfig

Engine configuration for WiredTiger.

collection_config

CollectionConfig

Collection configuration for WiredTiger.

EngineConfig

Field

Description

cache_size_gb

google.protobuf.DoubleValue

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

CollectionConfig

Field

Description

block_compressor

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

google.protobuf.BoolValue

Whether the journal is enabled or disabled.
Possible values:

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

commit_interval

google.protobuf.Int64Value

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 slow_op_threshold.
  • ALL: The profiler collects data for all operations.

slow_op_threshold

google.protobuf.Int64Value

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

max_incoming_connections

google.protobuf.Int64Value

The maximum number of simultaneous connections that mongod will accept.

Acceptable values are 10 to 32768, inclusive.

Resources

Field

Description

resource_preset_id

string

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

disk_size

int64

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

disk_type_id

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

planned_usage_threshold

google.protobuf.Int64Value

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

emergency_usage_threshold

google.protobuf.Int64Value

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

disk_size_limit

google.protobuf.Int64Value

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.

disk_size_autoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongoCfgConfig3_6

Field

Description

storage

Storage

storage section of mongocfg configuration.

operation_profiling

OperationProfiling

operationProfiling section of mongocfg configuration.

net

Network

net section of mongocfg configuration.

Storage

Field

Description

wired_tiger

WiredTiger

Configuration of the WiredTiger storage engine.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engine_config

EngineConfig

Engine configuration for WiredTiger.

EngineConfig

Field

Description

cache_size_gb

google.protobuf.DoubleValue

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 slow_op_threshold.
  • ALL: The profiler collects data for all operations.

slow_op_threshold

google.protobuf.Int64Value

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

max_incoming_connections

google.protobuf.Int64Value

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.

disk_size_autoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongosConfig3_6

Field

Description

net

Network

Network settings for mongos.

Network

Field

Description

max_incoming_connections

google.protobuf.Int64Value

The maximum number of incoming connections.

Acceptable values are 10 to 32768, inclusive.

MongoInfra

Field

Description

config_mongos

MongosConfig3_6

Configuration for mongos of mongoinfra 3.6 hosts.

config_mongocfg

MongoCfgConfig3_6

Configuration for mongocfg of mongoinfra 3.6 hosts.

resources

Resources

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

disk_size_autoscaling

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.

disk_size_autoscaling

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.

operation_profiling

OperationProfiling

operationProfiling section of mongod configuration.

net

Network

net section of mongod configuration.

Storage

Field

Description

wired_tiger

WiredTiger

Configuration of the WiredTiger storage engine.

journal

Journal

Configuration of the MongoDB journal.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engine_config

EngineConfig

Engine configuration for WiredTiger.

collection_config

CollectionConfig

Collection configuration for WiredTiger.

EngineConfig

Field

Description

cache_size_gb

google.protobuf.DoubleValue

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

CollectionConfig

Field

Description

block_compressor

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

commit_interval

google.protobuf.Int64Value

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 slow_op_threshold.
  • ALL: The profiler collects data for all operations.

slow_op_threshold

google.protobuf.Int64Value

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

max_incoming_connections

google.protobuf.Int64Value

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.

disk_size_autoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongoCfgConfig4_0

Field

Description

storage

Storage

storage section of mongocfg configuration.

operation_profiling

OperationProfiling

operationProfiling section of mongocfg configuration.

net

Network

net section of mongocfg configuration.

Storage

Field

Description

wired_tiger

WiredTiger

Configuration of the WiredTiger storage engine.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engine_config

EngineConfig

Engine configuration for WiredTiger.

EngineConfig

Field

Description

cache_size_gb

google.protobuf.DoubleValue

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 slow_op_threshold.
  • ALL: The profiler collects data for all operations.

slow_op_threshold

google.protobuf.Int64Value

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

max_incoming_connections

google.protobuf.Int64Value

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.

disk_size_autoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongosConfig4_0

Field

Description

net

Network

Network settings for mongos.

Network

Field

Description

max_incoming_connections

google.protobuf.Int64Value

The maximum number of simultaneous connections that mongos will accept.

Acceptable values are 10 to 32768, inclusive.

MongoInfra

Field

Description

config_mongos

MongosConfig4_0

Configuration for mongos of mongoinfra 4.0 hosts.

config_mongocfg

MongoCfgConfig4_0

Configuration for mongocfg of mongoinfra 4.0 hosts.

resources

Resources

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

disk_size_autoscaling

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.

disk_size_autoscaling

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.

operation_profiling

OperationProfiling

operationProfiling section of mongod configuration.

net

Network

net section of mongod configuration.

set_parameter

SetParameter

replication section of mongod configuration.

Storage

Field

Description

wired_tiger

WiredTiger

Configuration of the WiredTiger storage engine.

journal

Journal

Configuration of the MongoDB journal.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engine_config

EngineConfig

Engine configuration for WiredTiger.

collection_config

CollectionConfig

Collection configuration for WiredTiger.

index_config

IndexConfig

Index configuration for WiredTiger

EngineConfig

Field

Description

cache_size_gb

google.protobuf.DoubleValue

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

CollectionConfig

Field

Description

block_compressor

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

prefix_compression

google.protobuf.BoolValue

Enables or disables prefix compression

Journal

Field

Description

commit_interval

google.protobuf.Int64Value

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 slow_op_threshold.
  • ALL: The profiler collects data for all operations.

slow_op_threshold

google.protobuf.Int64Value

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.

slow_op_sample_rate

google.protobuf.DoubleValue

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

max_incoming_connections

google.protobuf.Int64Value

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

enable_flow_control

google.protobuf.BoolValue

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.

disk_size_autoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongoCfgConfig4_2

Field

Description

storage

Storage

storage section of mongocfg configuration.

operation_profiling

OperationProfiling

operationProfiling section of mongocfg configuration.

net

Network

net section of mongocfg configuration.

Storage

Field

Description

wired_tiger

WiredTiger

Configuration of the WiredTiger storage engine.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engine_config

EngineConfig

Engine configuration for WiredTiger.

EngineConfig

Field

Description

cache_size_gb

google.protobuf.DoubleValue

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 slow_op_threshold.
  • ALL: The profiler collects data for all operations.

slow_op_threshold

google.protobuf.Int64Value

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

max_incoming_connections

google.protobuf.Int64Value

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.

disk_size_autoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongosConfig4_2

Field

Description

net

Network

Network settings for mongos.

Network

Field

Description

max_incoming_connections

google.protobuf.Int64Value

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

config_mongos

MongosConfig4_2

Configuration for mongos of mongoinfra 4.2 hosts.

config_mongocfg

MongoCfgConfig4_2

Configuration for mongocfg of mongoinfra 4.2 hosts.

resources

Resources

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

disk_size_autoscaling

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.

disk_size_autoscaling

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.

operation_profiling

OperationProfiling

operationProfiling section of mongod configuration.

net

Network

net section of mongod configuration.

set_parameter

SetParameter

replication section of mongod configuration.

Storage

Field

Description

wired_tiger

WiredTiger

Configuration of the WiredTiger storage engine.

journal

Journal

Configuration of the MongoDB journal.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engine_config

EngineConfig

Engine configuration for WiredTiger.

collection_config

CollectionConfig

Collection configuration for WiredTiger.

index_config

IndexConfig

Index configuration for WiredTiger

EngineConfig

Field

Description

cache_size_gb

google.protobuf.DoubleValue

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

CollectionConfig

Field

Description

block_compressor

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

prefix_compression

google.protobuf.BoolValue

Enables or disables prefix compression

Journal

Field

Description

commit_interval

google.protobuf.Int64Value

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 slow_op_threshold.
  • ALL: The profiler collects data for all operations.

slow_op_threshold

google.protobuf.Int64Value

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.

slow_op_sample_rate

google.protobuf.DoubleValue

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

max_incoming_connections

google.protobuf.Int64Value

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

enable_flow_control

google.protobuf.BoolValue

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.

disk_size_autoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongoCfgConfig4_4

Field

Description

storage

Storage

storage section of mongocfg configuration.

operation_profiling

OperationProfiling

operationProfiling section of mongocfg configuration.

net

Network

net section of mongocfg configuration.

Storage

Field

Description

wired_tiger

WiredTiger

Configuration of the WiredTiger storage engine.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engine_config

EngineConfig

Engine configuration for WiredTiger.

EngineConfig

Field

Description

cache_size_gb

google.protobuf.DoubleValue

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 slow_op_threshold.
  • ALL: The profiler collects data for all operations.

slow_op_threshold

google.protobuf.Int64Value

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

max_incoming_connections

google.protobuf.Int64Value

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.

disk_size_autoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongosConfig4_4

Field

Description

net

Network

Network settings for mongos.

Network

Field

Description

max_incoming_connections

google.protobuf.Int64Value

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

config_mongos

MongosConfig4_4

Configuration for mongos of mongoinfra 4.4 hosts.

config_mongocfg

MongoCfgConfig4_4

Configuration for mongocfg of mongoinfra 4.4 hosts.

resources

Resources

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

disk_size_autoscaling

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.

disk_size_autoscaling

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.

operation_profiling

OperationProfiling

operationProfiling section of mongod configuration.

net

Network

net section of mongod configuration.

set_parameter

SetParameter

SetParameter section of mongod configuration.

Storage

Field

Description

wired_tiger

WiredTiger

Configuration of the WiredTiger storage engine.

journal

Journal

Configuration of the MongoDB journal.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engine_config

EngineConfig

Engine configuration for WiredTiger.

collection_config

CollectionConfig

Collection configuration for WiredTiger.

index_config

IndexConfig

Index configuration for WiredTiger

EngineConfig

Field

Description

cache_size_gb

google.protobuf.DoubleValue

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

CollectionConfig

Field

Description

block_compressor

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

prefix_compression

google.protobuf.BoolValue

Enables or disables prefix compression

Journal

Field

Description

commit_interval

google.protobuf.Int64Value

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 slow_op_threshold.
  • ALL: The profiler collects data for all operations.

slow_op_threshold

google.protobuf.Int64Value

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.

slow_op_sample_rate

google.protobuf.DoubleValue

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

max_incoming_connections

google.protobuf.Int64Value

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

enable_flow_control

google.protobuf.BoolValue

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.

min_snapshot_history_window_in_seconds

google.protobuf.Int64Value

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.

disk_size_autoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongoCfgConfig5_0

Field

Description

storage

Storage

storage section of mongocfg configuration.

operation_profiling

OperationProfiling

operationProfiling section of mongocfg configuration.

net

Network

net section of mongocfg configuration.

Storage

Field

Description

wired_tiger

WiredTiger

Configuration of the WiredTiger storage engine.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engine_config

EngineConfig

Engine configuration for WiredTiger.

EngineConfig

Field

Description

cache_size_gb

google.protobuf.DoubleValue

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 slow_op_threshold.
  • ALL: The profiler collects data for all operations.

slow_op_threshold

google.protobuf.Int64Value

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

max_incoming_connections

google.protobuf.Int64Value

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.

disk_size_autoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongosConfig5_0

Field

Description

net

Network

Network settings for mongos.

Network

Field

Description

max_incoming_connections

google.protobuf.Int64Value

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

config_mongos

MongosConfig5_0

Configuration for mongos of mongoinfra 5.0 hosts.

config_mongocfg

MongoCfgConfig5_0

Configuration for mongocfg of mongoinfra 5.0 hosts.

resources

Resources

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

disk_size_autoscaling

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.

disk_size_autoscaling

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.

operation_profiling

OperationProfiling

operationProfiling section of mongod configuration.

net

Network

net section of mongod configuration.

set_parameter

SetParameter

SetParameter section of mongod configuration.

Storage

Field

Description

wired_tiger

WiredTiger

Configuration of the WiredTiger storage engine.

journal

Journal

Configuration of the MongoDB journal.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engine_config

EngineConfig

Engine configuration for WiredTiger.

collection_config

CollectionConfig

Collection configuration for WiredTiger.

index_config

IndexConfig

Index configuration for WiredTiger

EngineConfig

Field

Description

cache_size_gb

google.protobuf.DoubleValue

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

CollectionConfig

Field

Description

block_compressor

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

prefix_compression

google.protobuf.BoolValue

Enables or disables prefix compression

Journal

Field

Description

commit_interval

google.protobuf.Int64Value

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 slow_op_threshold.
  • ALL: The profiler collects data for all operations.

slow_op_threshold

google.protobuf.Int64Value

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.

slow_op_sample_rate

google.protobuf.DoubleValue

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

max_incoming_connections

google.protobuf.Int64Value

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

enable_flow_control

google.protobuf.BoolValue

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.

min_snapshot_history_window_in_seconds

google.protobuf.Int64Value

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.

disk_size_autoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongoCfgConfig6_0

Field

Description

storage

Storage

storage section of mongocfg configuration.

operation_profiling

OperationProfiling

operationProfiling section of mongocfg configuration.

net

Network

net section of mongocfg configuration.

Storage

Field

Description

wired_tiger

WiredTiger

Configuration of the WiredTiger storage engine.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engine_config

EngineConfig

Engine configuration for WiredTiger.

EngineConfig

Field

Description

cache_size_gb

google.protobuf.DoubleValue

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 slow_op_threshold.
  • ALL: The profiler collects data for all operations.

slow_op_threshold

google.protobuf.Int64Value

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

max_incoming_connections

google.protobuf.Int64Value

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.

disk_size_autoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongosConfig6_0

Field

Description

net

Network

Network settings for mongos.

Network

Field

Description

max_incoming_connections

google.protobuf.Int64Value

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

config_mongos

MongosConfig6_0

Configuration for mongos of mongoinfra 6.0 hosts.

config_mongocfg

MongoCfgConfig6_0

Configuration for mongocfg of mongoinfra 6.0 hosts.

resources

Resources

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

disk_size_autoscaling

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_4_enterprise

Configuration for mongod 4.4 hosts.

resources

Resources

Resources allocated to each mongod host.

disk_size_autoscaling

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.

operation_profiling

OperationProfiling

operationProfiling section of mongod configuration.

net

Network

net section of mongod configuration.

security

Security

security section of mongod configuration.

audit_log

AuditLog

AuditLog section of mongod configuration.

set_parameter

SetParameter

SetParameter section of mongod configuration.

Storage

Field

Description

wired_tiger

WiredTiger

Configuration of the WiredTiger storage engine.

journal

Journal

Configuration of the MongoDB journal.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engine_config

EngineConfig

Engine configuration for WiredTiger.

collection_config

CollectionConfig

Collection configuration for WiredTiger.

index_config

IndexConfig

Index configuration for WiredTiger

EngineConfig

Field

Description

cache_size_gb

google.protobuf.DoubleValue

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

CollectionConfig

Field

Description

block_compressor

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

prefix_compression

google.protobuf.BoolValue

Enables or disables prefix compression

Journal

Field

Description

commit_interval

google.protobuf.Int64Value

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 slow_op_threshold.
  • ALL: The profiler collects data for all operations.

slow_op_threshold

google.protobuf.Int64Value

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.

slow_op_sample_rate

google.protobuf.DoubleValue

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

max_incoming_connections

google.protobuf.Int64Value

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

enable_encryption

google.protobuf.BoolValue

If encryption at rest should be enabled or not

kmip

KMIP

kmip section of mongod security config

KMIP

Field

Description

server_name

string

KMIP server name

port

google.protobuf.Int64Value

KMIP server port

server_ca

string

KMIP Server CA

client_certificate

string

KMIP client certificate + private key (unencrypted)

key_identifier

string

KMIP Key identifier (if any)

AuditLog

Field

Description

filter

string

Audit filter

SetParameter

Field

Description

audit_authorization_success

google.protobuf.BoolValue

Enables the auditing of authorization successes

enable_flow_control

google.protobuf.BoolValue

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_enterprise

Configuration for mongocfg 4.4 hosts.

resources

Resources

Resources allocated to each mongocfg host.

disk_size_autoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongoCfgConfig4_4_enterprise

Field

Description

storage

Storage

storage section of mongocfg configuration.

operation_profiling

OperationProfiling

operationProfiling section of mongocfg configuration.

net

Network

net section of mongocfg configuration.

Storage

Field

Description

wired_tiger

WiredTiger

Configuration of the WiredTiger storage engine.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engine_config

EngineConfig

Engine configuration for WiredTiger.

EngineConfig

Field

Description

cache_size_gb

google.protobuf.DoubleValue

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 slow_op_threshold.
  • ALL: The profiler collects data for all operations.

slow_op_threshold

google.protobuf.Int64Value

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

max_incoming_connections

google.protobuf.Int64Value

The maximum number of simultaneous connections that mongocfg will accept.

Acceptable values are 10 to 32768, inclusive.

Mongos

Field

Description

config

MongosConfig4_4_enterprise

Configuration for mongos 4.4 hosts.

resources

Resources

Resources allocated to each mongos host.

disk_size_autoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongosConfig4_4_enterprise

Field

Description

net

Network

Network settings for mongos.

Network

Field

Description

max_incoming_connections

google.protobuf.Int64Value

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

config_mongos

MongosConfig4_4_enterprise

Configuration for mongos of mongoinfra 4.4 enterprise hosts.

config_mongocfg

MongoCfgConfig4_4_enterprise

Configuration for mongocfg of mongoinfra 4.4 enterprise hosts.

resources

Resources

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

disk_size_autoscaling

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_0_enterprise

Configuration for mongod 5.0 hosts.

resources

Resources

Resources allocated to each mongod host.

disk_size_autoscaling

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.

operation_profiling

OperationProfiling

operationProfiling section of mongod configuration.

net

Network

net section of mongod configuration.

security

Security

security section of mongod configuration.

audit_log

AuditLog

AuditLog section of mongod configuration.

set_parameter

SetParameter

SetParameter section of mongod configuration.

Storage

Field

Description

wired_tiger

WiredTiger

Configuration of the WiredTiger storage engine.

journal

Journal

Configuration of the MongoDB journal.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engine_config

EngineConfig

Engine configuration for WiredTiger.

collection_config

CollectionConfig

Collection configuration for WiredTiger.

index_config

IndexConfig

Index configuration for WiredTiger

EngineConfig

Field

Description

cache_size_gb

google.protobuf.DoubleValue

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

CollectionConfig

Field

Description

block_compressor

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

prefix_compression

google.protobuf.BoolValue

Enables or disables prefix compression

Journal

Field

Description

commit_interval

google.protobuf.Int64Value

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 slow_op_threshold.
  • ALL: The profiler collects data for all operations.

slow_op_threshold

google.protobuf.Int64Value

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.

slow_op_sample_rate

google.protobuf.DoubleValue

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

max_incoming_connections

google.protobuf.Int64Value

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

enable_encryption

google.protobuf.BoolValue

If encryption at rest should be enabled or not

kmip

KMIP

kmip section of mongod security config

KMIP

Field

Description

server_name

string

KMIP server name

port

google.protobuf.Int64Value

KMIP server port

server_ca

string

KMIP Server CA

client_certificate

string

KMIP client certificate + private key (unencrypted)

key_identifier

string

KMIP Key identifier (if any)

AuditLog

Field

Description

filter

string

Audit filter

runtime_configuration

google.protobuf.BoolValue

Allows runtime configuration of audit filter and auditAuthorizationSuccess

SetParameter

Field

Description

audit_authorization_success

google.protobuf.BoolValue

Enables the auditing of authorization successes

enable_flow_control

google.protobuf.BoolValue

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.

min_snapshot_history_window_in_seconds

google.protobuf.Int64Value

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_enterprise

Configuration for mongocfg 5.0 hosts.

resources

Resources

Resources allocated to each mongocfg host.

disk_size_autoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongoCfgConfig5_0_enterprise

Field

Description

storage

Storage

storage section of mongocfg configuration.

operation_profiling

OperationProfiling

operationProfiling section of mongocfg configuration.

net

Network

net section of mongocfg configuration.

Storage

Field

Description

wired_tiger

WiredTiger

Configuration of the WiredTiger storage engine.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engine_config

EngineConfig

Engine configuration for WiredTiger.

EngineConfig

Field

Description

cache_size_gb

google.protobuf.DoubleValue

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 slow_op_threshold.
  • ALL: The profiler collects data for all operations.

slow_op_threshold

google.protobuf.Int64Value

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

max_incoming_connections

google.protobuf.Int64Value

The maximum number of simultaneous connections that mongocfg will accept.

Acceptable values are 10 to 32768, inclusive.

Mongos

Field

Description

config

MongosConfig5_0_enterprise

Configuration for mongos 5.0 hosts.

resources

Resources

Resources allocated to each mongos host.

disk_size_autoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongosConfig5_0_enterprise

Field

Description

net

Network

Network settings for mongos.

Network

Field

Description

max_incoming_connections

google.protobuf.Int64Value

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

config_mongos

MongosConfig5_0_enterprise

Configuration for mongos of mongoinfra 5.0 enterprise hosts.

config_mongocfg

MongoCfgConfig5_0_enterprise

Configuration for mongocfg of mongoinfra 5.0 enterprise hosts.

resources

Resources

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

disk_size_autoscaling

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_0_enterprise

Configuration for mongod 6.0 hosts.

resources

Resources

Resources allocated to each mongod host.

disk_size_autoscaling

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.

operation_profiling

OperationProfiling

operationProfiling section of mongod configuration.

net

Network

net section of mongod configuration.

security

Security

security section of mongod configuration.

audit_log

AuditLog

AuditLog section of mongod configuration.

set_parameter

SetParameter

SetParameter section of mongod configuration.

Storage

Field

Description

wired_tiger

WiredTiger

Configuration of the WiredTiger storage engine.

journal

Journal

Configuration of the MongoDB journal.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engine_config

EngineConfig

Engine configuration for WiredTiger.

collection_config

CollectionConfig

Collection configuration for WiredTiger.

index_config

IndexConfig

Index configuration for WiredTiger

EngineConfig

Field

Description

cache_size_gb

google.protobuf.DoubleValue

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

CollectionConfig

Field

Description

block_compressor

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

prefix_compression

google.protobuf.BoolValue

Enables or disables prefix compression

Journal

Field

Description

commit_interval

google.protobuf.Int64Value

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 slow_op_threshold.
  • ALL: The profiler collects data for all operations.

slow_op_threshold

google.protobuf.Int64Value

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.

slow_op_sample_rate

google.protobuf.DoubleValue

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

max_incoming_connections

google.protobuf.Int64Value

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

enable_encryption

google.protobuf.BoolValue

If encryption at rest should be enabled or not

kmip

KMIP

kmip section of mongod security config

KMIP

Field

Description

server_name

string

KMIP server name

port

google.protobuf.Int64Value

KMIP server port

server_ca

string

KMIP Server CA

client_certificate

string

KMIP client certificate + private key (unencrypted)

key_identifier

string

KMIP Key identifier (if any)

AuditLog

Field

Description

filter

string

Audit filter

runtime_configuration

google.protobuf.BoolValue

Allows runtime configuration of audit filter and auditAuthorizationSuccess

SetParameter

Field

Description

audit_authorization_success

google.protobuf.BoolValue

Enables the auditing of authorization successes

enable_flow_control

google.protobuf.BoolValue

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.

min_snapshot_history_window_in_seconds

google.protobuf.Int64Value

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_enterprise

Configuration for mongocfg 6.0 hosts.

resources

Resources

Resources allocated to each mongocfg host.

disk_size_autoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongoCfgConfig6_0_enterprise

Field

Description

storage

Storage

storage section of mongocfg configuration.

operation_profiling

OperationProfiling

operationProfiling section of mongocfg configuration.

net

Network

net section of mongocfg configuration.

Storage

Field

Description

wired_tiger

WiredTiger

Configuration of the WiredTiger storage engine.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engine_config

EngineConfig

Engine configuration for WiredTiger.

EngineConfig

Field

Description

cache_size_gb

google.protobuf.DoubleValue

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 slow_op_threshold.
  • ALL: The profiler collects data for all operations.

slow_op_threshold

google.protobuf.Int64Value

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

max_incoming_connections

google.protobuf.Int64Value

The maximum number of simultaneous connections that mongocfg will accept.

Acceptable values are 10 to 32768, inclusive.

Mongos

Field

Description

config

MongosConfig6_0_enterprise

Configuration for mongos 6.0 hosts.

resources

Resources

Resources allocated to each mongos host.

disk_size_autoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongosConfig6_0_enterprise

Field

Description

net

Network

Network settings for mongos.

Network

Field

Description

max_incoming_connections

google.protobuf.Int64Value

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

config_mongos

MongosConfig6_0_enterprise

Configuration for mongos of mongoinfra 6.0 enterprise hosts.

config_mongocfg

MongoCfgConfig6_0_enterprise

Configuration for mongocfg of mongoinfra 6.0 enterprise hosts.

resources

Resources

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

disk_size_autoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

PerformanceDiagnosticsConfig

Field

Description

profiling_enabled

bool

Whether profiling is enabled for the cluster.

Access

Field

Description

data_lens

bool

Allow access for DataLens.

web_sql

bool

Allow access for Web SQL.

data_transfer

bool

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.

disk_size_autoscaling

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.

operation_profiling

OperationProfiling

operationProfiling section of mongod configuration.

net

Network

net section of mongod configuration.

security

Security

security section of mongod configuration.

audit_log

AuditLog

AuditLog section of mongod configuration.

set_parameter

SetParameter

SetParameter section of mongod configuration.

oplog

Oplog

Oplog section of mongod configuration.

chaining_allowed

google.protobuf.BoolValue

Chained replication setting

Storage

Field

Description

wired_tiger

WiredTiger

Configuration of the WiredTiger storage engine.

journal

Journal

Configuration of the MongoDB journal.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engine_config

EngineConfig

Engine configuration for WiredTiger.

collection_config

CollectionConfig

Collection configuration for WiredTiger.

index_config

IndexConfig

Index configuration for WiredTiger

EngineConfig

Field

Description

cache_size_gb

google.protobuf.DoubleValue

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

cache_size

google.protobuf.DoubleValue

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

CollectionConfig

Field

Description

block_compressor

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

prefix_compression

google.protobuf.BoolValue

Enables or disables prefix compression

Journal

Field

Description

commit_interval

google.protobuf.Int64Value

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 slow_op_threshold.
  • ALL: The profiler collects data for all operations.

slow_op_threshold

google.protobuf.Int64Value

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.

slow_op_sample_rate

google.protobuf.DoubleValue

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

max_incoming_connections

google.protobuf.Int64Value

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

enable_encryption

google.protobuf.BoolValue

If encryption at rest should be enabled or not

kmip

KMIP

kmip section of mongod security config

KMIP

Field

Description

server_name

string

KMIP server name

port

google.protobuf.Int64Value

KMIP server port

server_ca

string

KMIP Server CA

client_certificate

string

KMIP client certificate + private key (unencrypted)

key_identifier

string

KMIP Key identifier (if any)

AuditLog

Field

Description

filter

string

Audit filter

runtime_configuration

google.protobuf.BoolValue

Allows runtime configuration of audit filter and auditAuthorizationSuccess

SetParameter

Field

Description

audit_authorization_success

google.protobuf.BoolValue

Enables the auditing of authorization successes

enable_flow_control

google.protobuf.BoolValue

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.

min_snapshot_history_window_in_seconds

google.protobuf.Int64Value

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

The minimum value is 0.

flow_control_target_lag_seconds

google.protobuf.Int64Value

The target maximum majority committed lag when running with flow control

Value must be greater than 0.

flow_control_warn_threshold_seconds

google.protobuf.Int64Value

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.

migrate_clone_insertion_batch_delay_ms

google.protobuf.Int64Value

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

The minimum value is 0.

migrate_clone_insertion_batch_size

google.protobuf.Int64Value

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

The minimum value is 0.

orphan_cleanup_delay_secs

google.protobuf.Int64Value

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

persisted_chunk_cache_update_max_batch_size

google.protobuf.Int64Value

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

range_deleter_batch_delay_ms

google.protobuf.Int64Value

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.

range_deleter_batch_size

google.protobuf.Int64Value

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.

mirror_reads

MirrorReads

Specifies the settings for mirrored reads for the mongod instance

redact_client_log_data

google.protobuf.BoolValue

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

sampling_rate

google.protobuf.DoubleValue

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

max_time_ms

google.protobuf.Int64Value

The maximum time in milliseconds for the mirrored reads.

Oplog

Field

Description

max_size_percent

google.protobuf.Int64Value

Oplog maxsize in percents.

min_retention_hours

google.protobuf.DoubleValue

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.

disk_size_autoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongoCfgConfig

Field

Description

storage

Storage

storage section of mongocfg configuration.

operation_profiling

OperationProfiling

operationProfiling section of mongocfg configuration.

net

Network

net section of mongocfg configuration.

set_parameter

SetParameter

setParameter section of mongocfg configuration.

audit_log

AuditLog

AuditLog section of mongocfg configuration.

oplog

Oplog

Oplog section of mongod configuration.

chaining_allowed

google.protobuf.BoolValue

Chained replication setting

Storage

Field

Description

wired_tiger

WiredTiger

Configuration of the WiredTiger storage engine.

WiredTiger

Configuration of WiredTiger storage engine.

Field

Description

engine_config

EngineConfig

Engine configuration for WiredTiger.

EngineConfig

Field

Description

cache_size_gb

google.protobuf.DoubleValue

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

cache_size

google.protobuf.DoubleValue

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 slow_op_threshold.
  • ALL: The profiler collects data for all operations.

slow_op_threshold

google.protobuf.Int64Value

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

max_incoming_connections

google.protobuf.Int64Value

The maximum number of simultaneous connections that mongocfg will accept.

Acceptable values are 10 to 32768, inclusive.

SetParameter

Field

Description

enable_flow_control

google.protobuf.BoolValue

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.

audit_authorization_success

google.protobuf.BoolValue

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

redact_client_log_data

google.protobuf.BoolValue

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

max_size_percent

google.protobuf.Int64Value

Oplog maxsize in percents.

min_retention_hours

google.protobuf.DoubleValue

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.

disk_size_autoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

MongosConfig

Field

Description

net

Network

Network settings for mongos.

set_parameter

SetParameter

setParameter section of mongos configuration.

audit_log

AuditLog

AuditLog section of mongos configuration.

chunk_size

google.protobuf.Int64Value

ChunkSize parameter of mongos configuration.

Network

Field

Description

max_incoming_connections

google.protobuf.Int64Value

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

audit_authorization_success

google.protobuf.BoolValue

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

read_hedging_mode

google.protobuf.StringValue

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

sharding_task_executor_pool_max_size

google.protobuf.Int64Value

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

sharding_task_executor_pool_max_connecting

google.protobuf.Int64Value

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

sharding_task_executor_pool_min_size

google.protobuf.Int64Value

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

sharding_task_executor_pool_replica_set_matching

google.protobuf.StringValue

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

sharding_task_executor_pool_host_timeout_ms

google.protobuf.Int64Value

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

sharding_task_executor_pool_refresh_requirement_ms

google.protobuf.Int64Value

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

sharding_task_executor_pool_refresh_timeout_ms

google.protobuf.Int64Value

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

warm_min_connections_in_sharding_task_executor_pool_on_startup

google.protobuf.BoolValue

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

warm_min_connections_in_sharding_task_executor_pool_on_startup_wait_ms

google.protobuf.Int64Value

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.

sharding_task_executor_pool_max_size_for_config_servers

google.protobuf.Int64Value

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

sharding_task_executor_pool_min_size_for_config_servers

google.protobuf.Int64Value

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

redact_client_log_data

google.protobuf.BoolValue

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

config_mongos

MongosConfig

Configuration for mongos of mongoinfra hosts.

config_mongocfg

MongoCfgConfig

Configuration for mongocfg of mongoinfra hosts.

resources

Resources

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

disk_size_autoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

AutoCompactConfig

Field

Description

enabled

bool

Enable autocompact.

target_free_space

google.protobuf.Int64Value

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

bloat_percent

google.protobuf.DoubleValue

Minimum percentage of bloat of collection to be compacted.

compaction_type

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

DatabaseSpec

Field

Description

name

string

Required field. Name of the MongoDB database. 1-63 characters long.

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

UserSpec

Field

Description

name

string

Required field. Name of the MongoDB user.

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

password

string

Password of the MongoDB user.

The maximum string length in characters is 128.

permissions[]

Permission

Set of permissions to grant to the user.

Permission

Field

Description

database_name

string

Name of the database that the permission grants access to.

roles[]

string

MongoDB roles for the database_name database that the permission grants.

HostSpec

Field

Description

zone_id

string

ID of the availability zone where the host resides.
To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request.

The maximum string length in characters is 50.

subnet_id

string

ID of the subnet that the host should belong to. This subnet should be a part
of the network that the cluster belongs to.
The network ID is set in the Cluster.network_id field.

The maximum string length in characters is 50.

assign_public_ip

bool

Whether the host should get a public IP address on creation.
After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign
a public IP to a host without one, recreate the host with assign_public_ip set as needed.
Possible values:

  • false - don't assign a public IP to the host.
  • true - the host should have a public IP address.

type

enum Type

Type of the host to be deployed.

  • MONGOD: A mongod host.
  • MONGOS: A mongos host.
  • MONGOCFG: A mongocfg host.
  • MONGOINFRA: A mongoinfra (mongos+mongocfg) host.

shard_name

string

Name of the shard that the host belongs to.

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

hidden

google.protobuf.BoolValue

Is host hidden in replSet

secondary_delay_secs

google.protobuf.Int64Value

The number of seconds "behind" the primary that this replica set member should "lag"

priority

google.protobuf.DoubleValue

Priority of host for the election in replSet

tags

object (map<string, string>)

Host tags

MaintenanceWindow

A maintenance window settings.

Field

Description

anytime

AnytimeMaintenanceWindow

Maintenance operation can be scheduled anytime.

Includes only one of the fields anytime, weekly_maintenance_window.

The maintenance policy in effect.

weekly_maintenance_window

WeeklyMaintenanceWindow

Maintenance operation can be scheduled on a weekly basis.

Includes only one of the fields anytime, weekly_maintenance_window.

The maintenance policy in effect.

AnytimeMaintenanceWindow

Field

Description

Empty

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

int64

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

Acceptable values are 1 to 24, inclusive.

BackupRetentionPolicySpec

Message to describe a new retention policy for cluster backups.

Field

Description

policy_name

string

Required field. Required. Policy name.

cron

CronTab

CronTab schedule.

retain_for_days

int64

Retention duration.

description

string

Human-readable description.

CronTab

Message to describe a crontab schedule.

Field

Description

day_of_month

string

Day of month in cron format. Valid values: 1-31, , ranges (1-15), steps (/2, 1-15/3), lists (1,15,28).
Defaults to "*".

month

string

Month in cron format. Valid values: 1-12, , ranges (1-6), steps (/3), lists (1,6,12).
Defaults to "*".

day_of_week

string

Day of week in cron format. Valid values: 0-7 (0 and 7 both mean Sunday), , ranges (1-5), steps (0-6/2), lists (1,3,5).
Defaults to "".

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "google.protobuf.Any",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Any"
  // 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.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

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

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

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

google.protobuf.Any

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

google.rpc.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

google.protobuf.Any

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.
Previous
List
Next
Update