terraform-provider-stackitp.../docs/resources/mongodbflex_instance.md
Henrique Santos 9d11098102
Improve region details (#90)
* Make client config error message more clear

* Add missing log

* Add region detail to resource/data source description

* Generate docs

* Remove resourcemanager using region

* Apply changes to MongoDBFlex user

* Generate docs

* Fix wrong description

---------

Co-authored-by: Henrique Santos <henrique.santos@freiheit.com>
2023-10-17 16:02:13 +01:00

84 lines
1.9 KiB
Markdown

---
# 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 = 8
}
replicas = 1
storage = {
class = "class"
size = 10
}
version = "5.0"
options = {
type = "Single"
}
}
```
<!-- schema generated by tfplugindocs -->
## Schema
### Required
- `acl` (List of String) The Access Control List (ACL) for the MongoDB Flex instance.
- `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)
### Read-Only
- `backup_schedule` (String)
- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`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:
- `type` (String)
<a id="nestedatt--storage"></a>
### Nested Schema for `storage`
Required:
- `class` (String)
- `size` (Number)