Module types/input

namespace aws

interface GetServicesService

interface GetServicesService

property name

name: string;

interface IntegrationCustomNamespaceSyncRule

interface IntegrationCustomNamespaceSyncRule

property defaultAction

defaultAction?: pulumi.Input<string>;

Controls the SignalFx default behavior for processing data from an AWS namespace. If you do specify a filter, use this property to control how SignalFx treats data that doesn’t match the filter. The available actions are one of "Include" or "Exclude".

property filterAction

filterAction?: pulumi.Input<string>;

Controls how SignalFx processes data from a custom AWS namespace. The available actions are one of "Include" or "Exclude".

property filterSource

filterSource?: pulumi.Input<string>;

Expression that selects the data that SignalFx should sync for the custom namespace associated with this sync rule. The expression uses the syntax defined for the SignalFlow filter() function; it can be any valid SignalFlow filter expression.

property namespace

namespace: pulumi.Input<string>;

An AWS custom namespace having custom AWS metrics that you want to sync with SignalFx. See the AWS documentation on publishing metrics for more information.

interface IntegrationNamespaceSyncRule

interface IntegrationNamespaceSyncRule

property defaultAction

defaultAction?: pulumi.Input<string>;

property filterAction

filterAction?: pulumi.Input<string>;

Controls how SignalFx processes data from a custom AWS namespace. The available actions are one of "Include" or "Exclude".

property filterSource

filterSource?: pulumi.Input<string>;

property namespace

namespace: pulumi.Input<string>;

An AWS custom namespace having custom AWS metrics that you want to sync with SignalFx. See the AWS documentation on publishing metrics for more information.

namespace azure

interface GetServicesService

interface GetServicesService

property name

name: string;

namespace gcp

interface IntegrationProjectServiceKey

interface IntegrationProjectServiceKey

property projectId

projectId: pulumi.Input<string>;

property projectKey

projectKey: pulumi.Input<string>;

APIs

interface AlertMutingRuleFilter

interface AlertMutingRuleFilter

property negated

negated?: pulumi.Input<boolean>;

Determines if this is a “not” filter. Defaults to false.

property property

property: pulumi.Input<string>;

The property to filter.

property propertyValue

propertyValue: pulumi.Input<string>;

The property value to filter.

interface DashboardChart

interface DashboardChart

property chartId

chartId: pulumi.Input<string>;

ID of the chart to display.

property column

column?: pulumi.Input<number>;

Column number for the layout.

property height

height?: pulumi.Input<number>;

How many rows every chart should take up (greater than or equal to 1). 1 by default.

property row

row?: pulumi.Input<number>;

The row to show the chart in (zero-based); if height > 1, this value represents the topmost row of the chart (greater than or equal to 0).

property width

width?: pulumi.Input<number>;

How many columns (out of a total of 12) every chart should take up (between 1 and 12). 12 by default.

interface DashboardColumn

interface DashboardColumn

property chartIds

chartIds: pulumi.Input<pulumi.Input<string>[]>;

List of IDs of the charts to display.

property column

column?: pulumi.Input<number>;

Column number for the layout.

property height

height?: pulumi.Input<number>;

How many rows every chart should take up (greater than or equal to 1). 1 by default.

property width

width?: pulumi.Input<number>;

How many columns (out of a total of 12) every chart should take up (between 1 and 12). 12 by default.

interface DashboardEventOverlay

interface DashboardEventOverlay

property color

color?: pulumi.Input<string>;

Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.

property label

label?: pulumi.Input<string>;

Text shown in the dropdown when selecting this overlay from the menu.

property line

line?: pulumi.Input<boolean>;

Show a vertical line for the event. false by default.

property signal

signal: pulumi.Input<string>;

Search term used to choose the events shown in the overlay.

property sources

sources?: pulumi.Input<pulumi.Input<DashboardEventOverlaySource>[]>;

Each element specifies a filter to use against the signal specified in the signal.

property type

type?: pulumi.Input<string>;

Can be set to eventTimeSeries (the default) to refer to externally reported events, or detectorEvents to refer to events from detector triggers.

interface DashboardEventOverlaySource

interface DashboardEventOverlaySource

property negated

negated?: pulumi.Input<boolean>;

If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.

property property

property: pulumi.Input<string>;

The name of a dimension to filter against.

property values

values: pulumi.Input<pulumi.Input<string>[]>;

A list of values to be used with the property, they will be combined via OR.

interface DashboardFilter

interface DashboardFilter

property applyIfExist

applyIfExist?: pulumi.Input<boolean>;

If true, this variable will also match data that doesn’t have this property at all.

property negated

negated?: pulumi.Input<boolean>;

If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.

property property

property: pulumi.Input<string>;

The name of a dimension to filter against.

property values

values: pulumi.Input<pulumi.Input<string>[]>;

A list of values to be used with the property, they will be combined via OR.

interface DashboardGrid

interface DashboardGrid

property chartIds

chartIds: pulumi.Input<pulumi.Input<string>[]>;

List of IDs of the charts to display.

property height

height?: pulumi.Input<number>;

How many rows every chart should take up (greater than or equal to 1). 1 by default.

property width

width?: pulumi.Input<number>;

How many columns (out of a total of 12) every chart should take up (between 1 and 12). 12 by default.

interface DashboardGroupDashboard

interface DashboardGroupDashboard

property dashboardId

dashboardId: pulumi.Input<string>;

The dashboard id to mirror

property descriptionOverride

descriptionOverride?: pulumi.Input<string>;

The description that will override the original dashboards’s description.

property filterOverrides

filterOverrides?: pulumi.Input<pulumi.Input<DashboardGroupDashboardFilterOverride>[]>;

The description that will override the original dashboards’s description.

property nameOverride

nameOverride?: pulumi.Input<string>;

The name that will override the original dashboards’s name.

property variableOverrides

variableOverrides?: pulumi.Input<pulumi.Input<DashboardGroupDashboardVariableOverride>[]>;

interface DashboardGroupDashboardFilterOverride

interface DashboardGroupDashboardFilterOverride

property negated

negated?: pulumi.Input<boolean>;

If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.

property property

property: pulumi.Input<string>;

A metric time series dimension or property name.

property values

values: pulumi.Input<pulumi.Input<string>[]>;

(Optional) List of of strings (which will be treated as an OR filter on the property).

interface DashboardGroupDashboardVariableOverride

interface DashboardGroupDashboardVariableOverride

property property

property: pulumi.Input<string>;

A metric time series dimension or property name.

property values

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

(Optional) List of of strings (which will be treated as an OR filter on the property).

property valuesSuggesteds

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

A list of strings of suggested values for this variable; these suggestions will receive priority when values are autosuggested for this variable.

interface DashboardGroupImportQualifier

interface DashboardGroupImportQualifier

property filters

filters?: pulumi.Input<pulumi.Input<DashboardGroupImportQualifierFilter>[]>;

property metric

metric: pulumi.Input<string>;

interface DashboardGroupImportQualifierFilter

interface DashboardGroupImportQualifierFilter

property negated

negated?: pulumi.Input<boolean>;

If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.

property property

property: pulumi.Input<string>;

A metric time series dimension or property name.

property values

values: pulumi.Input<pulumi.Input<string>[]>;

(Optional) List of of strings (which will be treated as an OR filter on the property).

interface DashboardSelectedEventOverlay

interface DashboardSelectedEventOverlay

property signal

signal: pulumi.Input<string>;

Search term used to choose the events shown in the overlay.

property sources

sources?: pulumi.Input<pulumi.Input<DashboardSelectedEventOverlaySource>[]>;

Each element specifies a filter to use against the signal specified in the signal.

property type

type?: pulumi.Input<string>;

Can be set to eventTimeSeries (the default) to refer to externally reported events, or detectorEvents to refer to events from detector triggers.

interface DashboardSelectedEventOverlaySource

interface DashboardSelectedEventOverlaySource

property negated

negated?: pulumi.Input<boolean>;

If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.

property property

property: pulumi.Input<string>;

The name of a dimension to filter against.

property values

values: pulumi.Input<pulumi.Input<string>[]>;

A list of values to be used with the property, they will be combined via OR.

interface DashboardVariable

interface DashboardVariable

property alias

alias: pulumi.Input<string>;

An alias for the dashboard variable. This text will appear as the label for the dropdown field on the dashboard.

property applyIfExist

applyIfExist?: pulumi.Input<boolean>;

If true, this variable will also match data that doesn’t have this property at all.

property description

description?: pulumi.Input<string>;

Variable description.

property property

property: pulumi.Input<string>;

The name of a dimension to filter against.

property replaceOnly

replaceOnly?: pulumi.Input<boolean>;

If true, this variable will only apply to charts that have a filter for the property.

property restrictedSuggestions

restrictedSuggestions?: pulumi.Input<boolean>;

If true, this variable may only be set to the values listed in valuesSuggested and only these values will appear in autosuggestion menus. false by default.

property valueRequired

valueRequired?: pulumi.Input<boolean>;

Determines whether a value is required for this variable (and therefore whether it will be possible to view this dashboard without this filter applied). false by default.

property values

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

A list of values to be used with the property, they will be combined via OR.

property valuesSuggesteds

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

A list of strings of suggested values for this variable; these suggestions will receive priority when values are autosuggested for this variable.

interface DataLinkTargetExternalUrl

interface DataLinkTargetExternalUrl

property isDefault

isDefault?: pulumi.Input<boolean>;

Flag that designates a target as the default for a data link object. true by default

property minimumTimeWindow

minimumTimeWindow?: pulumi.Input<string>;

The minimum time window for a search sent to an external site. Defaults to 6000

property name

name: pulumi.Input<string>;

User-assigned target name. Use this value to differentiate between the link targets for a data link object.

property propertyKeyMapping

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

Describes the relationship between SignalFx metadata keys and external system properties when the key names are different.

property timeFormat

timeFormat?: pulumi.Input<string>;

Designates the format of minimumTimeWindow in the same data link target object. Must be one of "ISO8601", "EpochSeconds" or "Epoch" (which is milliseconds). Defaults to "ISO8601".

property url

url: pulumi.Input<string>;

URL string for a Splunk instance or external system data link target. See the supported template variables.

interface DataLinkTargetSignalfxDashboard

interface DataLinkTargetSignalfxDashboard

property dashboardGroupId

dashboardGroupId: pulumi.Input<string>;

SignalFx-assigned ID of the dashboard link target’s dashboard group

property dashboardId

dashboardId: pulumi.Input<string>;

SignalFx-assigned ID of the dashboard link target

property isDefault

isDefault?: pulumi.Input<boolean>;

Flag that designates a target as the default for a data link object. true by default

property name

name: pulumi.Input<string>;

User-assigned target name. Use this value to differentiate between the link targets for a data link object.

interface DataLinkTargetSplunk

interface DataLinkTargetSplunk

property isDefault

isDefault?: pulumi.Input<boolean>;

Flag that designates a target as the default for a data link object. true by default

property name

name: pulumi.Input<string>;

User-assigned target name. Use this value to differentiate between the link targets for a data link object.

property propertyKeyMapping

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

Describes the relationship between SignalFx metadata keys and external system properties when the key names are different.

interface DetectorRule

interface DetectorRule

property description

description?: pulumi.Input<string>;

Description for the rule. Displays as the alert condition in the Alert Rules tab of the detector editor in the web UI.

property detectLabel

detectLabel: pulumi.Input<string>;

A detect label which matches a detect label within programText.

property disabled

disabled?: pulumi.Input<boolean>;

When true, notifications and events will not be generated for the detect label. false by default.

property notifications

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

List of strings specifying where notifications will be sent when an incident occurs. See Create A Single Detector for more info.

property parameterizedBody

parameterizedBody?: pulumi.Input<string>;

Custom notification message body when an alert is triggered. See Set Up Detectors to Trigger Alerts for more info.

property parameterizedSubject

parameterizedSubject?: pulumi.Input<string>;

Custom notification message subject when an alert is triggered. See Set Up Detectors to Trigger Alerts for more info.

property runbookUrl

runbookUrl?: pulumi.Input<string>;

URL of page to consult when an alert is triggered. This can be used with custom notification messages.

property severity

severity: pulumi.Input<string>;

The severity of the rule, must be one of: "Critical", "Major", "Minor", "Warning", "Info".

property tip

tip?: pulumi.Input<string>;

Plain text suggested first course of action, such as a command line to execute. This can be used with custom notification messages.

interface DetectorVizOption

interface DetectorVizOption

property color

color?: pulumi.Input<string>;

Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.

property displayName

displayName?: pulumi.Input<string>;

Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.

property label

label: pulumi.Input<string>;

Label used in the publish statement that displays the plot (metric time series data) you want to customize.

property valuePrefix

valuePrefix?: pulumi.Input<string>;

property valueSuffix

valueSuffix?: pulumi.Input<string>;

property valueUnit

valueUnit?: pulumi.Input<string>;

A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes). Values values are Bit, Kilobit, Megabit, Gigabit, Terabit, Petabit, Exabit, Zettabit, Yottabit, Byte, Kibibyte, Mebibyte, Gigibyte, Tebibyte, Pebibyte, Exbibyte, Zebibyte, Yobibyte, Nanosecond, Microsecond, Millisecond, Second, Minute, Hour, Day, Week. * valuePrefix, valueSuffix - (Optional) Arbitrary prefix/suffix to display with the value of this plot.

interface GetAwsServicesService

interface GetAwsServicesService

property name

name: string;

interface GetAzureServicesService

interface GetAzureServicesService

property name

name: string;

interface HeatmapChartColorRange

interface HeatmapChartColorRange

property color

color: pulumi.Input<string>;

The color range to use. Hex values are not supported here. Must be either gray, blue, light_blue, navy, dark_orange, orange, dark_yellow, magenta, cerise, pink, violet, purple, gray_blue, dark_green, green, aquamarine, red, yellow, vivid_yellow, light_green, lime_green.

property maxValue

maxValue?: pulumi.Input<number>;

The maximum value within the coloring range.

property minValue

minValue?: pulumi.Input<number>;

The minimum value within the coloring range.

interface HeatmapChartColorScale

interface HeatmapChartColorScale

property color

color: pulumi.Input<string>;

property gt

gt?: pulumi.Input<number>;

Indicates the lower threshold non-inclusive value for this range.

property gte

gte?: pulumi.Input<number>;

Indicates the lower threshold inclusive value for this range.

property lt

lt?: pulumi.Input<number>;

Indicates the upper threshold non-inclusive value for this range.

property lte

lte?: pulumi.Input<number>;

Indicates the upper threshold inclusive value for this range.

interface ListChartColorScale

interface ListChartColorScale

property color

color: pulumi.Input<string>;

The color range to use. Must be either gray, blue, navy, orange, yellow, magenta, purple, violet, lilac, green, aquamarine.

property gt

gt?: pulumi.Input<number>;

Indicates the lower threshold non-inclusive value for this range.

property gte

gte?: pulumi.Input<number>;

Indicates the lower threshold inclusive value for this range.

property lt

lt?: pulumi.Input<number>;

Indicates the upper threshold non-inculsive value for this range.

property lte

lte?: pulumi.Input<number>;

Indicates the upper threshold inclusive value for this range.

interface ListChartLegendOptionsField

interface ListChartLegendOptionsField

property enabled

enabled?: pulumi.Input<boolean>;

True or False depending on if you want the property to be shown or hidden.

property property

property: pulumi.Input<string>;

The name of the property to display. Note the special values of sfMetric (corresponding with the API’s Plot Name) which shows the label of the time series publish() and sf_originatingMetric (corresponding with the API’s metric (sf metric)) that shows the name of the metric for the time series being displayed.

interface ListChartVizOption

interface ListChartVizOption

property color

color?: pulumi.Input<string>;

The color range to use. Must be either gray, blue, navy, orange, yellow, magenta, purple, violet, lilac, green, aquamarine.

property displayName

displayName?: pulumi.Input<string>;

Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.

property label

label: pulumi.Input<string>;

Label used in the publish statement that displays the plot (metric time series data) you want to customize.

property valuePrefix

valuePrefix?: pulumi.Input<string>;

property valueSuffix

valueSuffix?: pulumi.Input<string>;

property valueUnit

valueUnit?: pulumi.Input<string>;

interface OrgTokenDpmLimits

interface OrgTokenDpmLimits

property dpmLimit

dpmLimit: pulumi.Input<number>;

The datapoints per minute (dpm) limit for this token. If you exceed this limit, SignalFx sends out an alert.

property dpmNotificationThreshold

dpmNotificationThreshold?: pulumi.Input<number>;

DPM level at which SignalFx sends the notification for this token. If you don’t specify a notification, SignalFx sends the generic notification.

interface OrgTokenHostOrUsageLimits

interface OrgTokenHostOrUsageLimits

property containerLimit

containerLimit?: pulumi.Input<number>;

Max number of Docker containers that can use this token

property containerNotificationThreshold

containerNotificationThreshold?: pulumi.Input<number>;

Notification threshold for Docker containers

property customMetricsLimit

customMetricsLimit?: pulumi.Input<number>;

Max number of custom metrics that can be sent with this token

property customMetricsNotificationThreshold

customMetricsNotificationThreshold?: pulumi.Input<number>;

Notification threshold for custom metrics

property highResMetricsLimit

highResMetricsLimit?: pulumi.Input<number>;

Max number of hi-res metrics that can be sent with this toke

property highResMetricsNotificationThreshold

highResMetricsNotificationThreshold?: pulumi.Input<number>;

Notification threshold for hi-res metrics

property hostLimit

hostLimit?: pulumi.Input<number>;

Max number of hosts that can use this token

property hostNotificationThreshold

hostNotificationThreshold?: pulumi.Input<number>;

Notification threshold for hosts

interface SingleValueChartColorScale

interface SingleValueChartColorScale

property color

color: pulumi.Input<string>;

Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.

property gt

gt?: pulumi.Input<number>;

Indicates the lower threshold non-inclusive value for this range.

property gte

gte?: pulumi.Input<number>;

Indicates the lower threshold inclusive value for this range.

property lt

lt?: pulumi.Input<number>;

Indicates the upper threshold non-inculsive value for this range.

property lte

lte?: pulumi.Input<number>;

Indicates the upper threshold inclusive value for this range.

interface SingleValueChartVizOption

interface SingleValueChartVizOption

property color

color?: pulumi.Input<string>;

Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.

property displayName

displayName?: pulumi.Input<string>;

Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.

property label

label: pulumi.Input<string>;

Label used in the publish statement that displays the plot (metric time series data) you want to customize.

property valuePrefix

valuePrefix?: pulumi.Input<string>;

property valueSuffix

valueSuffix?: pulumi.Input<string>;

property valueUnit

valueUnit?: pulumi.Input<string>;

interface TimeChartAxisLeft

interface TimeChartAxisLeft

property highWatermark

highWatermark?: pulumi.Input<number>;

A line to draw as a high watermark.

property highWatermarkLabel

highWatermarkLabel?: pulumi.Input<string>;

A label to attach to the high watermark line.

property label

label?: pulumi.Input<string>;

Label used in the publish statement that displays the event query you want to customize.

property lowWatermark

lowWatermark?: pulumi.Input<number>;

A line to draw as a low watermark.

property lowWatermarkLabel

lowWatermarkLabel?: pulumi.Input<string>;

A label to attach to the low watermark line.

property maxValue

maxValue?: pulumi.Input<number>;

The maximum value for the right axis.

property minValue

minValue?: pulumi.Input<number>;

The minimum value for the right axis.

property watermarks

watermarks?: pulumi.Input<pulumi.Input<TimeChartAxisLeftWatermark>[]>;

interface TimeChartAxisLeftWatermark

interface TimeChartAxisLeftWatermark

property label

label?: pulumi.Input<string>;

Label used in the publish statement that displays the event query you want to customize.

property value

value: pulumi.Input<number>;

interface TimeChartAxisRight

interface TimeChartAxisRight

property highWatermark

highWatermark?: pulumi.Input<number>;

A line to draw as a high watermark.

property highWatermarkLabel

highWatermarkLabel?: pulumi.Input<string>;

A label to attach to the high watermark line.

property label

label?: pulumi.Input<string>;

Label used in the publish statement that displays the event query you want to customize.

property lowWatermark

lowWatermark?: pulumi.Input<number>;

A line to draw as a low watermark.

property lowWatermarkLabel

lowWatermarkLabel?: pulumi.Input<string>;

A label to attach to the low watermark line.

property maxValue

maxValue?: pulumi.Input<number>;

The maximum value for the right axis.

property minValue

minValue?: pulumi.Input<number>;

The minimum value for the right axis.

property watermarks

watermarks?: pulumi.Input<pulumi.Input<TimeChartAxisRightWatermark>[]>;

interface TimeChartAxisRightWatermark

interface TimeChartAxisRightWatermark

property label

label?: pulumi.Input<string>;

Label used in the publish statement that displays the event query you want to customize.

property value

value: pulumi.Input<number>;

interface TimeChartEventOption

interface TimeChartEventOption

property color

color?: pulumi.Input<string>;

Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.

property displayName

displayName?: pulumi.Input<string>;

Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.

property label

label: pulumi.Input<string>;

Label used in the publish statement that displays the event query you want to customize.

interface TimeChartHistogramOption

interface TimeChartHistogramOption

property colorTheme

colorTheme?: pulumi.Input<string>;

Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine, red, gold, greenyellow, chartreuse, jade

interface TimeChartLegendOptionsField

interface TimeChartLegendOptionsField

property enabled

enabled?: pulumi.Input<boolean>;

True or False depending on if you want the property to be shown or hidden.

property property

property: pulumi.Input<string>;

The name of the property to display. Note the special values of plotLabel (corresponding with the API’s sfMetric) which shows the label of the time series publish() and metric (corresponding with the API’s sf_originatingMetric) that shows the name of the metric for the time series being displayed.