terraform-provider-stackitp.../docs/data-sources/mongodbflex_instance.md
stackit-pipeline 959bb83931
fix(deps): update module github.com/hashicorp/terraform-plugin-framework to v1.6.1 + examples fix (#284)
* Update module github.com/hashicorp/terraform-plugin-framework to v1.4.0

* Go get tf plugin sdk v2

* fix(deps): update module github.com/hashicorp/terraform-plugin-framework to v1.6.1

* Update examples

* Update docs

---------

Co-authored-by: Renovate Bot <renovate@whitesourcesoftware.com>
Co-authored-by: vicentepinto98 <vicente.pinto@freiheit.com>
2024-03-07 14:19:45 +00:00

67 lines
1.8 KiB
Markdown

---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "stackit_mongodbflex_instance Data Source - stackit"
subcategory: ""
description: |-
MongoDB Flex instance data source schema. Must have a region specified in the provider configuration.
---
# stackit_mongodbflex_instance (Data Source)
MongoDB Flex instance data source schema. Must have a `region` specified in the provider configuration.
## Example Usage
```terraform
data "stackit_mongodbflex_instance" "example" {
project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
instance_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
```
<!-- schema generated by tfplugindocs -->
## Schema
### Required
- `instance_id` (String) ID of the MongoDB Flex instance.
- `project_id` (String) STACKIT project ID to which the instance is associated.
### Read-Only
- `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))
- `id` (String) Terraform's internal data source. ID. It is structured as "`project_id`,`instance_id`".
- `name` (String) Instance name.
- `options` (Attributes) Custom parameters for the MongoDB Flex instance. (see [below for nested schema](#nestedatt--options))
- `replicas` (Number)
- `storage` (Attributes) (see [below for nested schema](#nestedatt--storage))
- `version` (String)
<a id="nestedatt--flavor"></a>
### Nested Schema for `flavor`
Read-Only:
- `cpu` (Number)
- `description` (String)
- `id` (String)
- `ram` (Number)
<a id="nestedatt--options"></a>
### Nested Schema for `options`
Read-Only:
- `type` (String)
<a id="nestedatt--storage"></a>
### Nested Schema for `storage`
Read-Only:
- `class` (String)
- `size` (Number)