---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "stackit_mongodbflex_instance Resource - stackit"
subcategory: ""
description: |-
  MongoDB Flex instance resource schema. Must have a region specified in the provider configuration.
---

# stackit_mongodbflex_instance (Resource)

MongoDB Flex instance resource schema. Must have a `region` specified in the provider configuration.

## Example Usage

```terraform
resource "stackit_mongodbflex_instance" "example" {
  project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  name       = "example-instance"
  acl        = ["XXX.XXX.XXX.X/XX", "XX.XXX.XX.X/XX"]
  flavor = {
    cpu = 1
    ram = 4
  }
  replicas = 1
  storage = {
    class = "class"
    size  = 10
  }
  version = "7.0"
  options = {
    type                       = "Single"
    snapshot_retention_days    = 3
    point_in_time_window_hours = 30
  }
  backup_schedule = "0 0 * * *"
}

# Only use the import statement, if you want to import an existing mongodbflex instance
import {
  to = stackit_mongodbflex_instance.import-example
  id = "${var.project_id},${var.region},${var.instance_id}"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `acl` (List of String) The Access Control List (ACL) for the MongoDB Flex instance.
- `backup_schedule` (String) The backup schedule. Should follow the cron scheduling system format (e.g. "0 0 * * *").
- `flavor` (Attributes) (see [below for nested schema](#nestedatt--flavor))
- `name` (String) Instance name.
- `options` (Attributes) (see [below for nested schema](#nestedatt--options))
- `project_id` (String) STACKIT project ID to which the instance is associated.
- `replicas` (Number)
- `storage` (Attributes) (see [below for nested schema](#nestedatt--storage))
- `version` (String)

### Optional

- `region` (String) The resource region. If not defined, the provider region is used.

### Read-Only

- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`region`,`instance_id`".
- `instance_id` (String) ID of the MongoDB Flex instance.

<a id="nestedatt--flavor"></a>
### Nested Schema for `flavor`

Required:

- `cpu` (Number)
- `ram` (Number)

Read-Only:

- `description` (String)
- `id` (String)


<a id="nestedatt--options"></a>
### Nested Schema for `options`

Required:

- `point_in_time_window_hours` (Number) The number of hours back in time the point-in-time recovery feature will be able to recover.
- `type` (String) Type of the MongoDB Flex instance. Supported values are: `Replica`, `Sharded`, `Single`.

Optional:

- `daily_snapshot_retention_days` (Number) The number of days that daily backups will be retained.
- `monthly_snapshot_retention_months` (Number) The number of months that monthly backups will be retained.
- `snapshot_retention_days` (Number) The number of days that continuous backups (controlled via the `backup_schedule`) will be retained.
- `weekly_snapshot_retention_weeks` (Number) The number of weeks that weekly backups will be retained.


<a id="nestedatt--storage"></a>
### Nested Schema for `storage`

Required:

- `class` (String)
- `size` (Number)