terraform-provider-stackitp.../docs/resources/mongodbflex_instance.md
João Palet 2810545ef7
Add additional backup configurations to MongoDB Flex instance resource (#486)
* Extend resource and datasource

* Extend acc test

* Extend example

* Generate docs

* Fix linter

* Update stackit/internal/services/mongodbflex/instance/datasource.go

Co-authored-by: GokceGK <161626272+GokceGK@users.noreply.github.com>

---------

Co-authored-by: GokceGK <161626272+GokceGK@users.noreply.github.com>
2024-07-31 10:55:14 +01:00

2.7 KiB

page_title subcategory description
stackit_mongodbflex_instance Resource - stackit 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

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 = 8
  }
  replicas = 1
  storage = {
    class = "class"
    size  = 10
  }
  version = "7.0"
  options = {
    type                    = "Single"
    snapshot_retention_days = 3
  }
  backup_schedule = "0 0 * * *"
}

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)
  • name (String) Instance name.
  • options (Attributes) (see below for nested schema)
  • project_id (String) STACKIT project ID to which the instance is associated.
  • replicas (Number)
  • storage (Attributes) (see below for nested schema)
  • version (String)

Read-Only

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

Nested Schema for flavor

Required:

  • cpu (Number)
  • ram (Number)

Read-Only:

  • description (String)
  • id (String)

Nested Schema for options

Required:

  • 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.
  • point_in_time_window_hours (Number) The number of hours back in time the point-in-time recovery feature will be able to recover.
  • 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.

Nested Schema for storage

Required:

  • class (String)
  • size (Number)