yandex_monitoring_dashboard (Resource)

Get information about a Yandex Monitoring dashboard.

Example usageExample usage

//
// Create a new Monitoring Dashboard.
//
resource "yandex_monitoring_dashboard" "my-dashboard" {
  name        = "local-id-resource"
  description = "Description"
  title       = "My title"
  labels = {
    a = "b"
  }
  parametrization {
    selectors = "a=b"
    parameters {
      description = "param1 description"
      title       = "title"
      hidden      = false
      id          = "param1"
      custom {
        default_values  = ["1", "2"]
        values          = ["1", "2", "3"]
        multiselectable = true
      }
    }
    parameters {
      hidden = true
      id     = "param2"
      label_values {
        default_values  = ["1", "2"]
        multiselectable = true
        label_key       = "key"
        selectors       = "a=b"
      }
    }
    parameters {
      hidden = true
      id     = "param3"
      text {
        default_value = "abc"
      }
    }
  }
  widgets {
    text {
      text = "text here"
    }
    position {
      h = 1
      w = 1
      x = 4
      y = 4
    }
  }
  widgets {
    chart {
      description    = "chart description"
      title          = "title for chart"
      chart_id       = "chart1id"
      display_legend = true
      freeze         = "FREEZE_DURATION_HOUR"
      name_hiding_settings {
        names    = ["a", "b"]
        positive = true
      }
      queries {
        downsampling {
          disabled         = false
          gap_filling      = "GAP_FILLING_NULL"
          grid_aggregation = "GRID_AGGREGATION_COUNT"
          max_points       = 100
        }
        target {
          hidden    = true
          text_mode = true
          query     = "{service=monitoring}"
        }
      }
      series_overrides {
        name = "name"
        settings {
          color          = "colorValue"
          grow_down      = true
          name           = "series_overrides name"
          type           = "SERIES_VISUALIZATION_TYPE_LINE"
          yaxis_position = "YAXIS_POSITION_LEFT"
          stack_name     = "stack name"
        }
      }
      visualization_settings {
        aggregation = "SERIES_AGGREGATION_AVG"
        interpolate = "INTERPOLATE_LEFT"
        type        = "VISUALIZATION_TYPE_POINTS"
        normalize   = true
        show_labels = true
        title       = "visualization_settings title"
        color_scheme_settings {
          gradient {
            green_value  = "11"
            red_value    = "22"
            violet_value = "33"
            yellow_value = "44"
          }
        }
        heatmap_settings {
          green_value  = "1"
          red_value    = "2"
          violet_value = "3"
          yellow_value = "4"
        }
        yaxis_settings {
          left {
            max         = "111"
            min         = "11"
            title       = "yaxis_settings left title"
            precision   = 3
            type        = "YAXIS_TYPE_LOGARITHMIC"
            unit_format = "UNIT_CELSIUS"
          }
          right {
            max         = "22"
            min         = "2"
            title       = "yaxis_settings right title"
            precision   = 2
            type        = "YAXIS_TYPE_LOGARITHMIC"
            unit_format = "UNIT_NONE"
          }
        }
      }
    }
    position {
      h = 100
      w = 100
      x = 6
      y = 6
    }
  }
  widgets {
    title {
      text = "title here"
      size = "TITLE_SIZE_XS"
    }
    position {
      h = 1
      w = 1
      x = 1
      y = 1
    }
  }
}

SchemaSchema

RequiredRequired

• name (String) The resource name.

OptionalOptional

• description (String) The resource description.
• folder_id (String) The folder identifier that resource belongs to. If it is not provided, the default provider folder-id is used.
• labels (Map of String) A set of key/value label pairs which assigned to resource.
• parametrization (Block List) Dashboard parametrization. (see below for nested schema)
• timeouts (Block, Optional) (see below for nested schema)
• title (String) Dashboard title.
• widgets (Block List) Widgets. (see below for nested schema)

Read-OnlyRead-Only

• dashboard_id (String) Dashboard ID.
• id (String) The ID of this resource.

Nested Schema for Nested Schema for parametrization

Optional:

• parameters (Block List) Dashboard parameters. (see below for nested schema)
• selectors (String) Dashboard predefined parameters selector.

Nested Schema for Nested Schema for parametrization.parameters

Required:

• id (String) Parameter identifier.

Optional:

• custom (Block List) Custom values parameter. Oneof: label_values, custom, text. (see below for nested schema)
• description (String) Parameter description.
• hidden (Boolean) UI-visibility
• label_values (Block List) Label values parameter. Oneof: label_values, custom, text. (see below for nested schema)
• text (Block List) Text parameter. Oneof: label_values, custom, text. (see below for nested schema)
• title (String) UI-visible title of the parameter.

Nested Schema for Nested Schema for parametrization.parameters.custom

Optional:

• default_values (List of String) Default value.
• multiselectable (Boolean) Specifies the multiselectable values of parameter.
• values (List of String) Parameter values.

Nested Schema for Nested Schema for parametrization.parameters.label_values

Required:

• label_key (String) Label key to list label values.

Optional:

• default_values (List of String) Default value.
• folder_id (String) Folder ID.
• multiselectable (Boolean) Specifies the multiselectable values of parameter.
• selectors (String) Selectors to select metric label values.

Nested Schema for Nested Schema for parametrization.parameters.text

Optional:

• default_value (String) Default value.

Nested Schema for 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 Nested Schema for widgets

Optional:

• chart (Block List) Chart widget settings. (see below for nested schema)
• position (Block List) Widget layout position. (see below for nested schema)
• text (Block List) Text widget settings. (see below for nested schema)
• title (Block List) Title widget settings. (see below for nested schema)

Nested Schema for Nested Schema for widgets.chart

Optional:

• chart_id (String) Chart ID.
• description (String) Chart description in dashboard (not enabled in UI).
• display_legend (Boolean) Enable legend under chart.
• freeze (String) Fixed time interval for chart. Values:
• FREEZE_DURATION_HOUR: Last hour.
• FREEZE_DURATION_DAY: Last day = last 24 hours.
• FREEZE_DURATION_WEEK: Last 7 days.
• FREEZE_DURATION_MONTH: Last 31 days.
• name_hiding_settings (Block List) Name hiding settings (see below for nested schema)
• queries (Block List) Queries settings. (see below for nested schema)
• series_overrides (Block List) Time series settings. (see below for nested schema)
• title (String) Chart widget title.
• visualization_settings (Block List) Visualization settings. (see below for nested schema)

Nested Schema for Nested Schema for widgets.chart.name_hiding_settings

Optional:

• names (List of String)
• positive (Boolean) True if we want to show concrete series names only, false if we want to hide concrete series names

Nested Schema for Nested Schema for widgets.chart.queries

Optional:

• downsampling (Block List) Downsampling settings (see below for nested schema)
• target (Block List) Downsampling settings (see below for nested schema)

Nested Schema for Nested Schema for widgets.chart.queries.downsampling

Optional:

• disabled (Boolean) Disable downsampling
• gap_filling (String) Parameters for filling gaps in data
• grid_aggregation (String) Function that is used for downsampling
• grid_interval (Number) Time interval (grid) for downsampling in milliseconds. Points in the specified range are aggregated into one time point
• max_points (Number) Maximum number of points to be returned

Nested Schema for Nested Schema for widgets.chart.queries.target

Optional:

• hidden (Boolean) Checks that target is visible or invisible
• query (String) Required. Query
• text_mode (Boolean) Text mode

Nested Schema for Nested Schema for widgets.chart.series_overrides

Optional:

• name (String) Series name
• settings (Block List) Override settings (see below for nested schema)
• target_index (String) Target index

Nested Schema for Nested Schema for widgets.chart.series_overrides.settings

Optional:

• color (String) Series color or empty
• grow_down (Boolean) Stack grow down
• name (String) Series name or empty
• stack_name (String) Stack name or empty
• type (String) Type
• yaxis_position (String) Yaxis position

Nested Schema for Nested Schema for widgets.chart.visualization_settings

Optional:

• aggregation (String) Aggregation
• color_scheme_settings (Block List) Color scheme settings (see below for nested schema)
• heatmap_settings (Block List) Heatmap settings (see below for nested schema)
• interpolate (String) Interpolate
• normalize (Boolean) Normalize
• show_labels (Boolean) Show chart labels
• title (String) Inside chart title
• type (String) Visualization type
• yaxis_settings (Block List) Y axis settings (see below for nested schema)

Nested Schema for Nested Schema for widgets.chart.visualization_settings.color_scheme_settings

Optional:

• automatic (Block List) Automatic color scheme (see below for nested schema)
• gradient (Block List) Gradient color scheme (see below for nested schema)
• standard (Block List) Standard color scheme (see below for nested schema)

Nested Schema for Nested Schema for widgets.chart.visualization_settings.color_scheme_settings.automatic

Nested Schema for Nested Schema for widgets.chart.visualization_settings.color_scheme_settings.gradient

Optional:

• green_value (String) Gradient green value
• red_value (String) Gradient red value
• violet_value (String) Gradient violet_value
• yellow_value (String) Gradient yellow value

Nested Schema for Nested Schema for widgets.chart.visualization_settings.color_scheme_settings.standard

Nested Schema for Nested Schema for widgets.chart.visualization_settings.heatmap_settings

Optional:

• green_value (String) Heatmap green value
• red_value (String) Heatmap red value
• violet_value (String) Heatmap violet_value
• yellow_value (String) Heatmap yellow value

Nested Schema for Nested Schema for widgets.chart.visualization_settings.yaxis_settings

Optional:

• left (Block List) Left Y axis settings (see below for nested schema)
• right (Block List) Right Y axis settings (see below for nested schema)

Nested Schema for Nested Schema for widgets.chart.visualization_settings.yaxis_settings.left

Optional:

• max (String) Max value in extended number format or empty
• min (String) Min value in extended number format or empty
• precision (Number) Tick value precision (null as default, 0-7 in other cases)
• title (String) Title or empty
• type (String) Type
• unit_format (String) Unit format

Nested Schema for Nested Schema for widgets.chart.visualization_settings.yaxis_settings.right

Optional:

• max (String) Max value in extended number format or empty
• min (String) Min value in extended number format or empty
• precision (Number) Tick value precision (null as default, 0-7 in other cases)
• title (String) Title or empty
• type (String) Type
• unit_format (String) Unit format

Nested Schema for Nested Schema for widgets.position

Optional:

• h (Number) Height.
• w (Number) Weight.
• x (Number) X-axis top-left corner coordinate.
• y (Number) Y-axis top-left corner coordinate.

Nested Schema for Nested Schema for widgets.text

Optional:

• text (String) Widget text.

Nested Schema for Nested Schema for widgets.title

Required:

• text (String) Title text.

Optional:

• size (String) Title size.
  Title size. Values:
• TITLE_SIZE_XS: Extra small size.
• TITLE_SIZE_S: Small size.
• TITLE_SIZE_M: Middle size.
• TITLE_SIZE_L: Large size.

ImportImport

The resource can be imported by using their resource ID. For getting the resource ID you can use Yandex Cloud Web Console or YC CLI.

# terraform import yandex_monitoring.<resource Name> <resource Id>
terraform import yandex_monitoring_dashboard.my-dashboard ...