| access |
Access policy to the MongoDB cluster |
object({
data_lens = optional(bool)
data_transfer = optional(bool)
web_sql = optional(bool)
}) |
null |
no |
| backup_retain_period_days |
Retention period for automatic backups in days |
number |
null |
no |
| backup_window_start |
Time to start the daily backup, in the UTC timezone |
object({
hours = optional(number)
minutes = optional(number)
}) |
null |
no |
| cluster_name |
Name of the MongoDB cluster |
string |
n/a |
yes |
| database_name |
Name of the database |
string |
n/a |
yes |
| deletion_protection |
Inhibits deletion of the cluster |
bool |
false |
no |
| description |
Description of the MongoDB cluster |
string |
null |
no |
| disk_encryption_key_id |
ID of the KMS key for cluster disk encryption |
string |
null |
no |
| disk_size_autoscaling_mongocfg |
Disk size autoscaling settings for mongocfg hosts |
object({
disk_size_limit = number
emergency_usage_threshold = optional(number)
planned_usage_threshold = optional(number)
}) |
null |
no |
| disk_size_autoscaling_mongod |
Disk size autoscaling settings for mongod hosts |
object({
disk_size_limit = number
emergency_usage_threshold = optional(number)
planned_usage_threshold = optional(number)
}) |
null |
no |
| disk_size_autoscaling_mongoinfra |
Disk size autoscaling settings for mongoinfra hosts |
object({
disk_size_limit = number
emergency_usage_threshold = optional(number)
planned_usage_threshold = optional(number)
}) |
null |
no |
| disk_size_autoscaling_mongos |
Disk size autoscaling settings for mongos hosts |
object({
disk_size_limit = number
emergency_usage_threshold = optional(number)
planned_usage_threshold = optional(number)
}) |
null |
no |
| environment |
Deployment environment of the MongoDB cluster |
string |
n/a |
yes |
| feature_compatibility_version |
Feature compatibility version of MongoDB |
string |
null |
no |
| labels |
A set of key/value label pairs to assign to the MongoDB cluster |
map(string) |
{} |
no |
| maintenance_window |
Maintenance window settings for the MongoDB cluster |
object({
type = optional(string)
day = optional(string)
hour = optional(number)
}) |
null |
no |
| mongod_hosts |
List of hosts in MongoDB cluster. |
list(object({
assign_public_ip = optional(bool, false)
zone_id = optional(string, "ru-central1-a")
subnet_id = string
type = optional(string, "MONGOD")
})) |
n/a |
yes |
| mongodb_version |
Version of the MongoDB server |
string |
n/a |
yes |
| network_id |
ID of the network, to which the MongoDB cluster belongs |
string |
n/a |
yes |
| performance_diagnostics |
Performance diagnostics to the MongoDB cluster |
object({
enabled = optional(bool)
}) |
null |
no |
| resources_mongocfg |
Resources for mongocfg hosts |
object({
resource_preset_id = string
disk_size = number
disk_type_id = string
}) |
null |
no |
| resources_mongod_disk_size |
Volume of the storage available to a MongoDB host, in gigabytes |
number |
n/a |
yes |
| resources_mongod_disk_type |
Type of the storage of MongoDB hosts |
string |
n/a |
yes |
| resources_mongod_preset |
The ID of the preset for computational resources available to a MongoDB host |
string |
n/a |
yes |
| resources_mongoinfra |
Resources for mongoinfra hosts |
object({
resource_preset_id = string
disk_size = number
disk_type_id = string
}) |
null |
no |
| resources_mongos |
Resources for mongos hosts |
object({
resource_preset_id = string
disk_size = number
disk_type_id = string
}) |
null |
no |
| restore |
Restore settings for creating cluster from a backup |
object({
backup_id = string
time = optional(string)
}) |
null |
no |
| security_group_ids |
A set of ids of security groups assigned to hosts of the cluster |
list(string) |
[] |
no |
| subnet_id |
The ID of the subnet, to which the host belongs. The subnet must be a part of the network to which the cluster belongs |
string |
n/a |
yes |
| timeouts |
Timeouts for create/update/delete operations |
object({
create = optional(string)
delete = optional(string)
update = optional(string)
}) |
null |
no |
| user_name |
Name of the user |
string |
n/a |
yes |
| user_password |
Password of the user |
string |
n/a |
yes |
| user_permissions |
Set of permissions granted to the user (database_name + roles per database). If set, overrides database_name and user_roles with a single permission. |
list(object({
database_name = string
roles = list(string)
})) |
null |
no |
| user_roles |
Roles of the user in the default database (used when user_permissions is not set) |
list(string) |
[
"readWrite"
] |
no |
| zone_id |
Zone for allocating address |
string |
"ru-central1-a" |
no |