MongoDB parameters

Parameters for creating a service

These parameters are provided as parameters in the method CreateService.

When creating a new service, the parameters marked as Required should be provided.

If the selected version MongoDB supports other parameters, they can be set in the options parameter.

version

DBMS version.

Required	Datatype	Valid Values
Yes	String	3.6 4.0 4.2 4.4 5.0

maxconns

The maximum number of concurrent connections allowed for mongos or mongod.

Required	Datatype	Valid Values	Default
No	Integer	10–51200	51200

profile

Indicates which operations to profile.

DBMS profiler operating mode:

• off — profiling disabled;

• slowOp (by default) — information is collected only about slow operations the duration of which exceeds the threshold as per operationProfiling.slowOpThresholdMs;

• all — information is collected about all operations.

Required	Datatype	Valid Values	Default
No	String	off slowOp all	slowOp

slowms

The operation time threshold in milliseconds, above which the operation is considered slow.

Required	Datatype	Valid Values	Default
No	Integer	0–36000000	100

verbose

The quiet mode of mongos or mongod, which is used to limit the output volume.

Required	Datatype	Valid Values	Default
No	Boolean	true false	false

verbositylevel

The level of message detail in the message log. To learn more, see MongoDB documentation.

Required	Datatype	Valid Values	Default
No	String	v vv vvv vvvv vvvvv	0

journal_commit_interval

The maximum interval between saving log data, in milliseconds.

Required	Datatype	Valid Values	Default
No	Integer	1–500	100

storage_engine_cache_size

The maximum size of internal cache in gibibytes, which will be used to store all data. To learn more about the parameter, follow this link.

Required	Datatype	Valid Values	Default
No	Float	0,25–100000 GiB	(RAM — 1 GiB)/2 or 0,25 GiB

monitoring - The monitoring information for the instance

Connection to a monitoring service.

Required	Editable	Datatype	Valid Values	Default
For all services, except for Prometheus	Yes	Boolean	true false	false

monitor_by

Monitoring service ID. The specified service must be deployed in the same project as the current service.

Required	Editable	Datatype	Valid Values
Yes, if the monitoring = true parameter is passed. If monitoring = false, the parameter cannot be passed	Yes	String	The ID of a monitoring service running within the same VPC as the current service

monitoring_labels

Labels to be assigned to the metrics of the monitored service in the monitoring service.

Required	Editable	Datatype	Valid Values
No. If monitoring = false, the parameter cannot be passed	Yes	Dict	The label name may contain digits, Latin letters, and an underscore character. The label value may contain any ASCII characters.

logging

Connection to a logging service.

Required	Editable	Datatype	Valid Values	Default
For all services, except for ELK and Prometheus	Yes	Boolean	true false	false

log_to

Logging service ID. The logged service must be deployed in the same project as the current service.

Required	Editable	Datatype	Valid Values	Default
Yes, if the logging = true parameter is passed. If logging = false, the parameter cannot be passed	Yes	String	The ID of a monitoring service running within the same VPC as the current service

logging_tags

Tags to be assigned in the logging service to the log records of the current service.

Required	Editable	Datatype	Valid Values	Default
No. If logging = false, the parameter cannot be passed	Yes	List of strings	String of 256 characters max

options

Container for other parameters MongoDB.

Note

If the parameter name includes a dot, then it cannot be passed in the container for additional parameters. If you need to use such parameter, contact technical support.

Required	Datatype	Valid Values
No	Dict	N/A

User creation parameters

These parameters are specified in the parameters attribute of the User object when the latter is passed in the users parameter of the ModifyService method.

The Editable property indicates whether the parameter value can be edited after the user has been created.

password

Required	Editable	Datatype	Valid Values	Default
Yes	No	String	It should not contain such characters as ', ", ` and \	N/A

User parameters to set when creating a database

These parameters are specified in the parameters attribute of the User object, which is nested in the users attribute of the Database object when the latter is passed in the databases parameter of the ModifyService method.

The Editable property indicates whether a parameter value can be edited after the database has been created.

roles

Required	Editable	Datatype	Valid Values	Default
No	Yes	Array of strings	read readWrite dbAdmin dbOwner	readWrite