avm-res-documentdb-mongocluster
Azure/avm-res-documentdb-mongocluster/azurerm
Terraform Azure Verified Resource Module for Cosmos DB for MongoDB (vCore)
terraform-azurerm-avm-res-documentdb-mongocluster This module manages a MongoDB Cluster using vCore Architecture. Requirements The following requirements are needed by this module: - terraform (>= 1.9, azapi (~> 2.4) - azurerm (~> 4.0) - modtm (~> 0.3) - random (~> 3.5) Resources The following resources are used by this module: - azapi_resource.diagnostic_setting (resource) - azapi_resource.firewall_rule (resource) - azapi_resource.mongo_cluster (resource) - azurerm_management_lock.this (resource) - azurerm_private_endpoint.this_managed_dns_zone_groups (resource) - azurerm_private_endpoint.this_unmanaged_dns_zone_groups (resource) - azurerm_private_endpoint_application_security_group_association.this (resource) - azurerm_role_assignment.this (resource) - modtm_telemetry.telemetry (resource
| Name | Type | Description | Default |
|---|---|---|---|
| administrator_login_password | string | Administrator login password (sensitive). Prefer injecting from a secure externa | required |
| location | string | Azure region where the resource should be deployed. | required |
| name | string | The name of the this resource. | required |
| administrator_login | string | Administrator (cluster) login name. Must start with a letter; allowed: letters, | required |
| resource_group_name | string | The resource group where the resources will be deployed. | required |
| compute_tier | string | Compute tier (e.g., M30, M40, etc.). | "M30" |
| diagnostic_settings | map(object({ name | A map of diagnostic settings to create on the Key Vault. The map key is delibera | {} |
| firewall_rules | list(object({ name = s | List of firewall rules (public IP ranges) applied when public network access is | [] |
| managed_identities | object({ system_assigned | Controls the Managed Identity configuration on this resource. The following prop | {} |
| private_endpoints | map(object({ name = option | A map of private endpoints to create on this resource. The map key is deliberate | {} |
| private_endpoints_manage_dns_zone_group | bool | Whether to manage private DNS zone groups with this module. If set to false, you | true |
| public_network_access | string | Enable or disable public network access: Enabled or Disabled. | "Disabled" |
| customer_managed_key | object({ key_vault_resourc | A map describing customer-managed keys to associate with the resource. This incl | null |
| lock | object({ kind = string | Controls the Resource Lock configuration for this resource. The following proper | null |
| node_count | number | (Deprecated) Previous preview node_count for nodeGroupSpecs. Ignored in 2024-07- | null |
| storage_size_gb | number | Cluster storage size in GB (service supported increments). | 32 |
| backup_policy_type | string | Backup policy type (e.g., Periodic, Continuous7Days, Continuous30Days). | "Continuous7Days" |
| ha_mode | string | High availability target mode for the cluster: Disabled, SameZone, ZoneRedundant | "Disabled" |
| server_version | string | MongoDB server version (e.g. 7.0). | "7.0" |
| shard_count | number | Number of shards (properties.sharding.shardCount). | 1 |
| tags | map(string) | (Optional) Tags of the resource. | null |
| enable_ha | bool | (Deprecated) Previous preview boolean for HA. If set and ha_mode not overridden, | null |
| enable_telemetry | bool | This variable controls whether or not telemetry is enabled for the module. For m | true |
| role_assignments | map(object({ role_definiti | A map of role assignments to create on this resource. The map key is deliberatel | {} |
mongo_cluster_name — Name of the MongoDB vCore cluster.mongo_cluster_properties — Raw properties object returned by the AzAPI provider (may include status, sizing, endpoints). Subjecprivate_endpoints — A map of the private endpoints created.
resource_id — The resource ID of the MongoDB vCore cluster (required by AVM).mongo_cluster_connection_string — Primary Mongo connection string if exposed (preview shape). Null if not available yet.mongo_cluster_connection_strings — Collection of connection strings if service returns multiple. Null if not available.mongo_cluster_id — Resource ID of the MongoDB vCore cluster.mongo_cluster_location — Location of the MongoDB vCore cluster.