A Terraform module for the creation of Cosmos DB Accounts.
No requirements.
Name | Version |
---|---|
azurerm | n/a |
No modules.
Name | Type |
---|---|
azurerm_cosmosdb_account.this | resource |
azurerm_cosmosdb_sql_container.this | resource |
azurerm_cosmosdb_sql_database.this | resource |
Name | Description | Type | Default | Required |
---|---|---|---|---|
analytical_storage_schema | The schema type of the Analytical Storage for this Cosmos DB account. | string |
"WellDefined" |
no |
backup_interval | The interval in minutes between two backups. | number |
240 |
no |
backup_retention | The time in hours that each backup is retained. | number |
8 |
no |
capability | Configure capabilities to be enabled for this Cosmos DB account | string |
null |
no |
consistency_level | (Required) The Consistency Level to use for this CosmosDB Account | string |
"Session" |
no |
containers | List of Cosmos DB SQL Containers to create. Some parameters are inherited from the Cosmos account. | map(object({ |
{} |
no |
databases | Map of Cosmos DB SQL DBs to create. Some parameters are inherited from the Cosmos account. | map(object({ |
{} |
no |
enable_access_key_metadata_writes | Optional) Is write operations on metadata resources (databases, containers, throughput) via account keys enabled? | bool |
true |
no |
enable_automatic_failover | (Optional) Enable automatic failover for this Cosmos DB account. | bool |
false |
no |
env | The environment to deploy to | string |
n/a | yes |
kind | (Optional) Specifies the Kind of CosmosDB to create | string |
"GlobalDocumentDB" |
no |
location | n/a | string |
"uksouth" |
no |
name | The name of your Cosmos DB Account | string |
n/a | yes |
offer_type | (Required) Specifies the Offer Type to use for this CosmosDB Account; currently, this can only be set to Standard. | string |
"Standard" |
no |
resource_group_name | The resource group your Cosmos DB account will be assigned to | string |
n/a | yes |
secondary_location | n/a | string |
"ukwest" |
no |
Name | Description |
---|---|
cosmosdb_account_id | n/a |