databases/cosmos_dbs¶
Overview¶
This page documents the Terraform module implementation, key configuration surfaces, and how it integrates with CAF.
Dependency diagram (Mermaid)¶
graph TD
azurecaf_name.cdb["azurecaf_name.cdb"]
azurerm_cosmosdb_account.cosmos_account["azurerm_cosmosdb_account.cosmos_account"]
module.cassandra_keyspaces["module.cassandra_keyspaces"]
module.gremlin_databases["module.gremlin_databases"]
module.mongo_databases["module.mongo_databases"]
module.private_endpoint["module.private_endpoint"]
module.sql_databases["module.sql_databases"]
module.tables["module.tables"]
azurerm_cosmosdb_account.cosmos_account --> azurecaf_name.cdb
module.cassandra_keyspaces --> azurerm_cosmosdb_account.cosmos_account
module.gremlin_databases --> azurerm_cosmosdb_account.cosmos_account
module.mongo_databases --> azurerm_cosmosdb_account.cosmos_account
module.private_endpoint --> azurerm_cosmosdb_account.cosmos_account
module.sql_databases --> azurerm_cosmosdb_account.cosmos_account
module.tables --> azurerm_cosmosdb_account.cosmos_account
Module Reference¶
Category: databases
Path: modules/databases/cosmos_dbs
Azure Resources: azurecaf_name, azurerm_cosmosdb_account
Inputs¶
| Name | Description | Type | Required | Default | Validation |
|---|---|---|---|---|---|
global_settings |
Global settings object (see module README.md) | any |
yes | - |
- |
settings |
The settings for the Azure resource. | any |
yes | - |
- |
client_config |
Client configuration object (see module README.md). | any |
yes | - |
- |
private_endpoints |
any |
yes | - |
- | |
resource_groups |
any |
yes | - |
- | |
private_dns |
map(any) |
no | {} |
- | |
vnets |
any |
yes | - |
- | |
location |
location of the resource if different from the resource group. | string |
no | - |
- |
resource_group_name |
Resource group object to deploy the virtual machine | string |
no | - |
- |
resource_group |
Resource group object to deploy the virtual machine | any |
yes | - |
- |
base_tags |
Base tags for the resource to be inherited from the resource group. | bool |
yes | - |
- |
Outputs¶
| Name | Description | Sensitive | Value |
|---|---|---|---|
cosmos_account |
- | azurerm_cosmosdb_account.cosmos_account.id |
|
primary_key |
- | azurerm_cosmosdb_account.cosmos_account.primary_key |
|
endpoint |
- | azurerm_cosmosdb_account.cosmos_account.endpoint |
|
name |
- | azurecaf_name.cdb.result |
|
resource_group_name |
- | local.resource_group_name |
|
location |
- | local.location |
|
id |
- | azurerm_cosmosdb_account.cosmos_account.id |
Sources¶
modules/databases/cosmos_dbs/cassandra_keyspace.tfmodules/databases/cosmos_dbs/cosmosdb_account.tfmodules/databases/cosmos_dbs/gremlin_database.tfmodules/databases/cosmos_dbs/locals.tfmodules/databases/cosmos_dbs/main.tfmodules/databases/cosmos_dbs/mongo_database.tfmodules/databases/cosmos_dbs/outputs.tfmodules/databases/cosmos_dbs/private_endpoints.tfmodules/databases/cosmos_dbs/sql_database.tfmodules/databases/cosmos_dbs/table.tfmodules/databases/cosmos_dbs/variables.tf