Skip to main content

equinix_fabric_stream_alert_rule (Resource)

Fabric V4 API compatible resource allows creation and management of Equinix Fabric Stream Alert Rules' ~> Note Equinix Fabric v4 Stream Alert Rule resource is currently in Beta. The interfaces related to equinix_fabric_stream_alert_rule may change ahead of general availability. Please, do not hesitate to report any problems that you experience by opening a new issue https://github.com/equinix/terraform-provider-equinix/issues/new?template=bug.md

Additional Documentation:

Example Usage​

resource "equinix_fabric_stream_alert_rule" "new_stream_alert_rule" {
  stream_id          = "<stream_id>"
  name               = "<name>"
  type               = "METRIC_ALERT"
  description        = "<description>"
  enabled            = true
  metric_selector = {
    include = ["equinix.fabric.connection.bandwidth_tx.usage"]
  }
  detection_method = {
    operand            = "ABOVE"
    window_size        = "<window_size>"
    warning_threshold  = "<warning_threshold>"
    critical_threshold = "<critical_threshold>"
  }
  resource_selector = {
    include = ["*/connections/<connection_id>"]
  }
}

output "stream_alert_rule_type" {
  value = equinix_fabric_stream_alert_rule.new_stream_alert_rule.type
}

output "stream_alert_rule_id" {
  value = equinix_fabric_stream_alert_rule.new_stream_alert_rule.uuid
}

output "stream_alert_rule_stream_id" {
  value = equinix_fabric_stream_alert_rule.new_stream_alert_rule.stream_id
}

output "stream_alert_rule_state" {
  value = equinix_fabric_stream_alert_rule.new_stream_alert_rule.state
}

Schema​

Required​

  • description (String) Customer-provided stream alert rule description
  • detection_method (Attributes) Detection method for stream alert rule (see below for nested schema)
  • metric_selector (Attributes) Metric selector for the stream alert rule (see below for nested schema)
  • name (String) Customer-provided stream alert rule name
  • resource_selector (Attributes) Resource selector for the stream alert rule (see below for nested schema)
  • stream_id (String) The stream UUID that contains this alert rule
  • type (String) Type of the stream alert rule

Optional​

Read-Only​

  • change_log (Attributes) Details of the last change on the stream resource (see below for nested schema)
  • href (String) Equinix assigned URI of the stream alert rule
  • id (String) The unique identifier of the resource
  • state (String) Value representing provisioning status for the stream alert rule
  • uuid (String) Equinix assigned unique identifier for the stream alert rule

Nested Schema for detection_method​

Required:

  • type (String) Stream Alert Rule detection method type

Optional:

  • critical_threshold (String) Stream alert rule metric critical threshold
  • operand (String) Stream alert rule metric operand
  • warning_threshold (String) Stream alert rule metric warning threshold
  • window_size (String) Stream alert rule metric window size

Nested Schema for metric_selector​

Required:

  • include (List of String) List of metrics to include

Nested Schema for resource_selector​

Required:

  • include (List of String) List of metrics to include

Nested Schema for timeouts​

Optional:

  • create (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
  • delete (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
  • read (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
  • update (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

Nested Schema for change_log​

Read-Only:

  • created_by (String) User name of creator of the stream resource
  • created_by_email (String) Email of creator of the stream resource
  • created_by_full_name (String) Legal name of creator of the stream resource
  • created_date_time (String) Creation time of the stream resource
  • deleted_by (String) User name of deleter of the stream resource
  • deleted_by_email (String) Email of deleter of the stream resource
  • deleted_by_full_name (String) Legal name of deleter of the stream resource
  • deleted_date_time (String) Deletion time of the stream resource
  • updated_by (String) User name of last updater of the stream resource
  • updated_by_email (String) Email of last updater of the stream resource
  • updated_by_full_name (String) Legal name of last updater of the stream resource
  • updated_date_time (String) Last update time of the stream resource
Was this page helpful?