9f82c3262b
* Extend RabbitMQ instance parameters (#409) * Extend Schema * initial parameter integration in resource * datasource, resource and acceptance testing * add docs, fix map fields edge case * improve testing * rename tls_protocols to singular * revert renaming * Extend Redis instance parameters (#410) * Extend Schema * initial parameter integration in resource * datasource, resource and acceptance testing * add docs, fix map fields edge case * improve testing * rename tls_protocols to singular * revert renaming * initial schema * resource and datasource * acceptance testing * fix linting and testing, generate docs * improve acceptance testing --------- Co-authored-by: Diogo Ferrão <diogo.ferrao@freiheit.com>
72 lines
2.7 KiB
Markdown
72 lines
2.7 KiB
Markdown
---
|
|
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
|
page_title: "stackit_rabbitmq_instance Resource - stackit"
|
|
subcategory: ""
|
|
description: |-
|
|
RabbitMQ instance resource schema. Must have a region specified in the provider configuration.
|
|
---
|
|
|
|
# stackit_rabbitmq_instance (Resource)
|
|
|
|
RabbitMQ instance resource schema. Must have a `region` specified in the provider configuration.
|
|
|
|
## Example Usage
|
|
|
|
```terraform
|
|
resource "stackit_rabbitmq_instance" "example" {
|
|
project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
name = "example-instance"
|
|
version = "10"
|
|
plan_name = "example-plan-name"
|
|
parameters = {
|
|
sgw_acl = "x.x.x.x/x,y.y.y.y/y"
|
|
consumer_timeout = 18000000
|
|
enable_monitoring = false
|
|
plugins = ["example-plugin1", "example-plugin2"]
|
|
}
|
|
}
|
|
```
|
|
|
|
<!-- schema generated by tfplugindocs -->
|
|
## Schema
|
|
|
|
### Required
|
|
|
|
- `name` (String) Instance name.
|
|
- `plan_name` (String) The selected plan name.
|
|
- `project_id` (String) STACKIT project ID to which the instance is associated.
|
|
- `version` (String) The service version.
|
|
|
|
### Optional
|
|
|
|
- `parameters` (Attributes) (see [below for nested schema](#nestedatt--parameters))
|
|
|
|
### Read-Only
|
|
|
|
- `cf_guid` (String)
|
|
- `cf_organization_guid` (String)
|
|
- `cf_space_guid` (String)
|
|
- `dashboard_url` (String)
|
|
- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`".
|
|
- `image_url` (String)
|
|
- `instance_id` (String) ID of the RabbitMQ instance.
|
|
- `plan_id` (String) The selected plan ID.
|
|
|
|
<a id="nestedatt--parameters"></a>
|
|
### Nested Schema for `parameters`
|
|
|
|
Optional:
|
|
|
|
- `consumer_timeout` (Number) The timeout in milliseconds for the consumer.
|
|
- `enable_monitoring` (Boolean) Enable monitoring.
|
|
- `graphite` (String) Graphite server URL (host and port). If set, monitoring with Graphite will be enabled.
|
|
- `max_disk_threshold` (Number) The maximum disk threshold in MB. If the disk usage exceeds this threshold, the instance will be stopped.
|
|
- `metrics_frequency` (Number) The frequency in seconds at which metrics are emitted.
|
|
- `metrics_prefix` (String) The prefix for the metrics. Could be useful when using Graphite monitoring to prefix the metrics with a certain value, like an API key
|
|
- `monitoring_instance_id` (String) The monitoring instance ID.
|
|
- `plugins` (List of String) List of plugins to install. Must be a supported plugin name.
|
|
- `roles` (List of String) List of roles to assign to the instance.
|
|
- `sgw_acl` (String) Comma separated list of IP networks in CIDR notation which are allowed to access this instance.
|
|
- `syslog` (List of String) List of syslog servers to send logs to.
|
|
- `tls_ciphers` (List of String) List of TLS ciphers to use.
|
|
- `tls_protocols` (String) TLS protocol to use.
|