terraform-provider-stackitp.../docs/data-sources/redis_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

3.1 KiB

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

stackit_redis_instance (Data Source)

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

Example Usage

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

Schema

Required

  • instance_id (String) ID of the Redis 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:

  • down_after_milliseconds (Number) The number of milliseconds after which the instance is considered down.
  • enable_monitoring (Boolean) Enable monitoring.
  • failover_timeout (Number) The failover timeout in milliseconds.
  • graphite (String) Graphite server URL (host and port). If set, monitoring with Graphite will be enabled.
  • lazyfree_lazy_eviction (String) The lazy eviction enablement (yes or no).
  • lazyfree_lazy_expire (String) The lazy expire enablement (yes or no).
  • lua_time_limit (Number) The Lua time limit.
  • max_disk_threshold (Number) The maximum disk threshold in MB. If the disk usage exceeds this threshold, the instance will be stopped.
  • maxclients (Number) The maximum number of clients.
  • maxmemory_policy (String) The policy to handle the maximum memory (volatile-lru, noeviction, etc).
  • maxmemory_samples (Number) The maximum memory samples.
  • 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
  • min_replicas_max_lag (Number) The minimum replicas maximum lag.
  • monitoring_instance_id (String) The ID of the STACKIT monitoring instance.
  • notify_keyspace_events (String) The notify keyspace events.
  • sgw_acl (String) Comma separated list of IP networks in CIDR notation which are allowed to access this instance.
  • snapshot (String) The snapshot configuration.
  • syslog (List of String) List of syslog servers to send logs to.
  • tls_ciphers (List of String) List of TLS ciphers to use.
  • tls_ciphersuites (String) TLS cipher suites to use.
  • tls_protocols (String) TLS protocol to use.