Want to learn about running containers in Lambda? Join our free hands-on workshop. Register Now

Module types/input

This page documents the language specification for the wavefront package. If you're looking for help working with the inputs, outputs, or functions of wavefront resources in a Pulumi program, please see the resource documentation for examples and API reference.

APIs

APIs

interface AlertTargetRoute

interface AlertTargetRoute

property filter

filter?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

property method

method: pulumi.Input<string>;

The notification method used for notification target. One of WEBHOOK, EMAIL, PAGERDUTY.

property target

target: pulumi.Input<string>;

interface CloudIntegrationNewRelicMetricFilter

interface CloudIntegrationNewRelicMetricFilter

property appName

appName: pulumi.Input<string>;

The name of a NewRelic App

property metricFilterRegex

metricFilterRegex: pulumi.Input<string>;

A regular expression that a metric name must match (case-insensitively) in order to be ingested

interface DashboardParameterDetail

interface DashboardParameterDetail

property defaultValue

defaultValue: pulumi.Input<string>;

The default value of the parameter

property dynamicFieldType

dynamicFieldType?: pulumi.Input<string>;

For DYNAMIC parameter types, the type of the field. Valid options are SOURCE, SOURCE_TAG, METRIC_NAME, TAG_KEY, MATCHING_SOURCE_TAG

property hideFromView

hideFromView: pulumi.Input<boolean>;

If true the parameter will only be shown on the edit view of the dashboard

property label

label: pulumi.Input<string>;

The label for the parameter

property name

name: pulumi.Input<string>;

The name of the parameters

property parameterType

parameterType: pulumi.Input<string>;

The type of the parameter. SIMPLE, LIST, or DYNAMIC

property queryValue

queryValue?: pulumi.Input<string>;

For DYNAMIC parameter types, the query to execute to return values

property tagKey

tagKey?: pulumi.Input<string>;

for TAG_KEY dynamic field types, the tag key to return

property valuesToReadableStrings

valuesToReadableStrings: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A string->string map. At least one of the keys must match the value of defaultValue

interface DashboardSection

interface DashboardSection

property name

name: pulumi.Input<string>;

Name of this section

property rows

rows: pulumi.Input<pulumi.Input<DashboardSectionRow>[]>;

See dashboard section rows

interface DashboardSectionRow

interface DashboardSectionRow

property charts

charts: pulumi.Input<pulumi.Input<DashboardSectionRowChart>[]>;

Charts in this section. See dashboard chart

interface DashboardSectionRowChart

interface DashboardSectionRowChart

property chartSetting

chartSetting: pulumi.Input<DashboardSectionRowChartChartSetting>;

Chart settings. See chart settings

property description

description?: pulumi.Input<string>;

Description of the chart

property name

name: pulumi.Input<string>;

Name of the source

property sources

sources: pulumi.Input<pulumi.Input<DashboardSectionRowChartSource>[]>;

Query expression to plot on the chart. See chart source queries

property summarization

summarization: pulumi.Input<string>;

Summarization strategy for the chart. MEAN is default. Valid options are, MEAN, MEDIAN, MIN, MAX, SUM, COUNT, LAST, FIRST

property units

units: pulumi.Input<string>;

String to label the units of the chart on the Y-Axis

interface DashboardSectionRowChartChartSetting

interface DashboardSectionRowChartChartSetting

property autoColumnTags

autoColumnTags?: pulumi.Input<boolean>;

deprecated

property columnTags

columnTags?: pulumi.Input<string>;

deprecated

property customTags

customTags?: pulumi.Input<pulumi.Input<string>[]>;

For the tabular view, a list of point tags to display when using the custom tag display mode

property expectedDataSpacing

expectedDataSpacing?: pulumi.Input<number>;

Threshold (in seconds) for time delta between consecutive points in a series above which a dotted line will replace a solid in in line plots. Default 60

property fixedLegendDisplayStats

fixedLegendDisplayStats?: pulumi.Input<pulumi.Input<string>[]>;

For a chart with a fixed legend, a list of statistics to display in the legend

property fixedLegendEnabled

fixedLegendEnabled?: pulumi.Input<boolean>;

Whether to enable a fixed tabular legend adjacent to the chart

property fixedLegendFilterField

fixedLegendFilterField?: pulumi.Input<string>;

Statistic to use for determining whether a series is displayed on the fixed legend. Valid options are CURRENT, MEAN, MEDIAN, SUM, MIN, MAX, COUNT

property fixedLegendFilterLimit

fixedLegendFilterLimit?: pulumi.Input<number>;

Number of series to include in the fixed legend

property fixedLegendFilterSort

fixedLegendFilterSort?: pulumi.Input<string>;

Whether to display TOP or BOTTOM ranked series in a fixed legend. Valid options are TOP, and BOTTOM

property fixedLegendHideLabel

fixedLegendHideLabel?: pulumi.Input<boolean>;

deprecated

property fixedLegendPosition

fixedLegendPosition?: pulumi.Input<string>;

Where the fixed legend should be displayed with respect ot the chart. Valid options are RIGHt, TOP, LEFT, BOTTOM

property fixedLegendUseRawStats

fixedLegendUseRawStats?: pulumi.Input<boolean>;

If true, the legend uses non-summarized stats instead of summarized

property groupBySource

groupBySource?: pulumi.Input<boolean>;

For the tabular view, whether to group multi metrics into a single row by a common source. If false, each source is displayed in its own row. if true, multiple metrics for the same host will be displayed as different columns in the same row

property invertDynamicLegendHoverControl

invertDynamicLegendHoverControl?: pulumi.Input<boolean>;

Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed)

property lineType

lineType?: pulumi.Input<string>;

Plot interpolation type. linear is default. Valid options are linear, step-before, step-after, basis, cardinal, monotone

property max

max?: pulumi.Input<number>;

Max value of the Y-axis. Set to null or leave blank for auto

property min

min?: pulumi.Input<number>;

Min value of the Y-axis. Set to null or leave blank for auto

property numTags

numTags?: pulumi.Input<number>;

For the tabular view, how many point tags to display

property plainMarkdownContent

plainMarkdownContent?: pulumi.Input<string>;

The markdown content for a Markdown display, in plain text.

property showHosts

showHosts?: pulumi.Input<boolean>;

For the tabular view, whether to display sources. Default is true

property showLabels

showLabels?: pulumi.Input<boolean>;

For the tabular view, whether to display labels. Default is true

property showRawValues

showRawValues?: pulumi.Input<boolean>;

For the tabular view, whether to display raw values. Default is false

property sortValuesDescending

sortValuesDescending?: pulumi.Input<boolean>;

For the tabular view, whether to display display values in descending order. Default is false

property sparklineDecimalPrecision

sparklineDecimalPrecision?: pulumi.Input<number>;

For the single stat view, the decimal precision of the displayed number

property sparklineDisplayColor

sparklineDisplayColor?: pulumi.Input<string>;

For the single stat view, the color of the displayed text (when not dynamically determined). Values should be in rgba(,,,,) format

property sparklineDisplayFontSize

sparklineDisplayFontSize?: pulumi.Input<string>;

For the single stat view, the font size of the displayed text, in percent

property sparklineDisplayHorizontalPosition

sparklineDisplayHorizontalPosition?: pulumi.Input<string>;

For the single stat view, the horizontal position of the displayed text. Valid options are MIDDLE, LEFT, RIGHT

property sparklineDisplayPostfix

sparklineDisplayPostfix?: pulumi.Input<string>;

For the single stat view, a string to append to the displayed text

property sparklineDisplayPrefix

sparklineDisplayPrefix?: pulumi.Input<string>;

For the single stat view, a string to add before the displayed text

property sparklineDisplayValueType

sparklineDisplayValueType?: pulumi.Input<string>;

For the single stat view, where to display the name of the query or the value of the query. Valid options are VALUE or LABEL

property sparklineDisplayVerticalPosition

sparklineDisplayVerticalPosition?: pulumi.Input<string>;

deprecated

property sparklineFillColor

sparklineFillColor?: pulumi.Input<string>;

For the single stat view, the color of the background fill. Values should be in rgba(,,,,)

property sparklineLineColor

sparklineLineColor?: pulumi.Input<string>;

For the single stat view, the color of the line. Values should be in rgba(,,,,) format

property sparklineSize

sparklineSize?: pulumi.Input<string>;

For the single stat view, This determines whether the sparkline of the statistic is displayed in the chart BACKGROUND, BOTTOM, or NONE. Valid options are BACKGROUND, BOTTOM, NONE

property sparklineValueColorMapApplyTo

sparklineValueColorMapApplyTo?: pulumi.Input<string>;

For the single stat view, whether to apply dyunamic color settings to the displayed TEXT or BACKGROUND. Valid options are TEXT or BACKGROUND

property sparklineValueColorMapColors

sparklineValueColorMapColors?: pulumi.Input<pulumi.Input<string>[]>;

For the single stat view, A list of colors that differing query values map to. Must contain one more element than sparklineValueColorMapValuesV2. Values should be in rgba(,,,,)

property sparklineValueColorMapValues

sparklineValueColorMapValues?: pulumi.Input<pulumi.Input<number>[]>;

deprecated

property sparklineValueColorMapValuesV2s

sparklineValueColorMapValuesV2s?: pulumi.Input<pulumi.Input<number>[]>;

For the single stat view, a list of boundaries for mapping different query values to colors. Must contain one less element than sparklineValueColorMapColors

property sparklineValueTextMapTexts

sparklineValueTextMapTexts?: pulumi.Input<pulumi.Input<string>[]>;

For the single stat view, a list of display text values that different query values map to. Must contain one more element than sparklineValueTextMapThresholds

property sparklineValueTextMapThresholds

sparklineValueTextMapThresholds?: pulumi.Input<pulumi.Input<number>[]>;

For the single stat view, a list of threshold boundaries for mapping different query values to display text. Must contain one less element than sparklineValueTextMapText

property stackType

stackType?: pulumi.Input<string>;

Type of stacked chart (applicable only if chart type is stacked). zero (default) means stacked from y=0. expand means normalized from 0 to 1. wiggle means minimize weighted changes. silhouette means to center the stream. Valid options are zero, expand, wiggle, silhouette, bars

property tagMode

tagMode?: pulumi.Input<string>;

For the tabular view, which mode to use to determine which point tags to display. Valid options are all, top, or custom

property timeBasedColoring

timeBasedColoring?: pulumi.Input<boolean>;

For x-y scatterplots, whether to color more recent points as darker than older points

property type

type: pulumi.Input<string>;

Chart Type. line refers to the Line Plot, scatter to the Point Plot, stacked-area to the Stacked Area plot, table to the Tabular View, scatterploy-xy to Scatter Plot, markdown-widget to the Markdown display, and sparkline to the Single Stat view. Valid options areĀ line, scatterplot, stacked-area, stacked-column, table, scatterplot-xy, markdown-widget, sparkline, globe, nodemap, top-k, status-list, histogram

property windowSize

windowSize?: pulumi.Input<number>;

Width, in minutes, of the time window to use for last windowing

property windowing

windowing?: pulumi.Input<string>;

For the tabular view, whether to use the full time window for the query or the last X minutes. Valid options are full or last

property xmax

xmax?: pulumi.Input<number>;

For x-y scatterplots, max value for the X-axis. Set to null for auto

property xmin

xmin?: pulumi.Input<number>;

For x-y scatterplots, min value for the X-axis. Set to null for auto

property y0ScaleSiBy1024

y0ScaleSiBy1024?: pulumi.Input<boolean>;

Whether to scale numerical magnitude labels for left Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI)

property y0UnitAutoscaling

y0UnitAutoscaling?: pulumi.Input<boolean>;

Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units

property y1ScaleSiBy1024

y1ScaleSiBy1024?: pulumi.Input<boolean>;

Whether to scale numerical magnitude labels for right Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI)

property y1UnitAutoscaling

y1UnitAutoscaling?: pulumi.Input<boolean>;

Whether to automatically adjust magnitude labels and units for the right Y-axis to favor smaller magnitudes and larger units

property y1Units

y1Units?: pulumi.Input<string>;

For plots with multiple Y-axes, units for right side Y-axis

property y1max

y1max?: pulumi.Input<number>;

For plots with multiple Y-axes, max value for the right side Y-axis. Set null for auto

property y1min

y1min?: pulumi.Input<number>;

For plots with multiple Y-axes, min value for the right side Y-axis. Set null for auto

property ymax

ymax?: pulumi.Input<number>;

For x-y scatterplots, max value for the Y-axis. Set to null for auto

property ymin

ymin?: pulumi.Input<number>;

For x-y scatterplots, min value for the Y-axis. Set to null for auto

interface DashboardSectionRowChartSource

interface DashboardSectionRowChartSource

property disabled

disabled?: pulumi.Input<boolean>;

Whether the source is disabled

property name

name: pulumi.Input<string>;

Name of the source

property query

query: pulumi.Input<string>;

Query expression to plot on the chart

property queryBuilderEnabled

queryBuilderEnabled?: pulumi.Input<boolean>;

Whether oir not this source line should have the query builder enabled

property scatterPlotSource

scatterPlotSource?: pulumi.Input<string>;

For scatter plots, does this query source the X-axis or the Y-axis, X, or Y.

property sourceDescription

sourceDescription?: pulumi.Input<string>;

A description for the purpose of this source