stackit-dev-tools/terraform-provider-stackitprivatepreview
2
0
Fork 0
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions
terraform-provider-stackitp.../docs/data-sources/opensearch_instance.md
João Palet aec518b8f3
Add description for the parameters field of DSA instances (#445) 
* Add description for the parameters field of DSA instances

* Improve sentence
2024-07-02 19:02:19 +01:00

2.8 KiB
Raw Blame History

page_title subcategory description
stackit_opensearch_instance Data Source - stackit OpenSearch instance data source schema. Must have a region specified in the provider configuration.

stackit_opensearch_instance (Data Source)

OpenSearch instance data source schema. Must have a region specified in the provider configuration.

Example Usage

data "stackit_opensearch_instance" "example" {
  project_id  = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  instance_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Schema

Required

  • instance_id (String) ID of the OpenSearch instance.
  • project_id (String) STACKIT Project ID to which the instance is associated.

Read-Only

  • cf_guid (String)
  • cf_organization_guid (String)
  • cf_space_guid (String)
  • dashboard_url (String)
  • id (String) Terraform's internal data source. identifier. It is structured as "project_id,instance_id".
  • image_url (String)
  • name (String) Instance name.
  • parameters (Attributes) (see below for nested schema)
  • plan_id (String) The selected plan ID.
  • plan_name (String) The selected plan name.
  • version (String) The service version.

Nested Schema for parameters

Read-Only:

  • enable_monitoring (Boolean) Enable monitoring.
  • graphite (String) If set, monitoring with Graphite will be enabled. Expects the host and port where the Graphite metrics should be sent to (host:port).
  • java_garbage_collector (String) The garbage collector to use for OpenSearch.
  • java_heapspace (Number) The amount of memory (in MB) allocated as heap by the JVM for OpenSearch.
  • java_maxmetaspace (Number) The amount of memory (in MB) used by the JVM to store metadata for OpenSearch.
  • 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 (in seconds).
  • 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 ID of the STACKIT monitoring instance.
  • plugins (List of String) List of plugins to install. Must be a supported plugin name. The plugins repository-s3 and repository-azure are enabled by default and cannot be disabled.
  • 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) The TLS protocol to use.