@pulumi/signalfx
Version:
A Pulumi package for creating and managing SignalFx resources.
355 lines • 16 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* This chart type displays current data values in a list format.
*
* The name of each value in the chart reflects the name of the plot and any associated dimensions. We recommend you click the Pencil icon and give the plot a meaningful name, as in plot B from the example. Otherwise, just the raw metric name will be displayed on the chart, as in plot A from the example.
*
* ## Example
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as signalfx from "@pulumi/signalfx";
*
* const mylistchart0 = new signalfx.ListChart("mylistchart0", {
* name: "CPU Total Idle - List",
* programText: `myfilters = filter(\\"cluster_name\\", \\"prod\\") and filter(\\"role\\", \\"search\\")
* data(\\"cpu.total.idle\\", filter=myfilters).publish()
* `,
* description: "Very cool List Chart",
* colorBy: "Metric",
* maxDelay: 2,
* timezone: "Europe/Paris",
* disableSampling: true,
* refreshInterval: 1,
* hideMissingValues: true,
* legendOptionsFields: [
* {
* property: "collector",
* enabled: false,
* },
* {
* property: "cluster_name",
* enabled: true,
* },
* {
* property: "role",
* enabled: true,
* },
* {
* property: "collector",
* enabled: false,
* },
* {
* property: "host",
* enabled: false,
* },
* ],
* maxPrecision: 2,
* sortBy: "-value",
* });
* ```
*/
export declare class ListChart extends pulumi.CustomResource {
/**
* Get an existing ListChart resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ListChartState, opts?: pulumi.CustomResourceOptions): ListChart;
/**
* Returns true if the given object is an instance of ListChart. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is ListChart;
/**
* Must be one of `"Scale"`, `"Dimension"` or `"Metric"`. `"Dimension"` by default.
*/
readonly colorBy: pulumi.Output<string | undefined>;
/**
* Single color range including both the color to display for that range and the borders of the range. Example: `[{ gt = 60, color = "blue" }, { lte = 60, color = "yellow" }]`. Look at this [link](https://docs.splunk.com/observability/en/data-visualization/charts/chart-options.html).
*/
readonly colorScales: pulumi.Output<outputs.ListChartColorScale[] | undefined>;
/**
* Description of the chart.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* If `false`, samples a subset of the output MTS, which improves UI performance. `false` by default.
*/
readonly disableSampling: pulumi.Output<boolean | undefined>;
/**
* Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
*/
readonly endTime: pulumi.Output<number | undefined>;
/**
* Determines whether to hide missing data points in the chart. If `true`, missing data points in the chart would be hidden. `false` by default.
*/
readonly hideMissingValues: pulumi.Output<boolean | undefined>;
/**
* List of properties that should not be displayed in the chart legend (i.e. dimension names). All the properties are visible by default. Deprecated, please use `legendOptionsFields`.
*
* @deprecated Please use legend_options_fields
*/
readonly legendFieldsToHides: pulumi.Output<string[] | undefined>;
/**
* List of property names and enabled flags that should be displayed in the data table for the chart, in the order provided. This option cannot be used with `legendFieldsToHide`.
*/
readonly legendOptionsFields: pulumi.Output<outputs.ListChartLegendOptionsField[] | undefined>;
/**
* How long (in seconds) to wait for late datapoints.
*/
readonly maxDelay: pulumi.Output<number | undefined>;
/**
* Maximum number of digits to display when rounding values up or down.
*/
readonly maxPrecision: pulumi.Output<number | undefined>;
/**
* Name of the chart.
*/
readonly name: pulumi.Output<string>;
/**
* Signalflow program text for the chart. More info[in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/).
*/
readonly programText: pulumi.Output<string>;
/**
* How often (in seconds) to refresh the values of the list.
*/
readonly refreshInterval: pulumi.Output<number | undefined>;
/**
* The type of secondary visualization. Can be `None`, `Radial`, `Linear`, or `Sparkline`. If unset, the Splunk Observability Cloud default is used (`Sparkline`).
*/
readonly secondaryVisualization: pulumi.Output<string | undefined>;
/**
* The property to use when sorting the elements. Use `value` if you want to sort by value. Must be prepended with `+` for ascending or `-` for descending (e.g. `-foo`). Note there are some special values for some of the options provided in the UX: `"value"` for Value, `"sf_originatingMetric"` for Metric, and `"sfMetric"` for plot.
*/
readonly sortBy: pulumi.Output<string | undefined>;
/**
* Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
*/
readonly startTime: pulumi.Output<number | undefined>;
/**
* Tags associated with the resource
*/
readonly tags: pulumi.Output<string[] | undefined>;
/**
* How many seconds ago from which to display data. For example, the last hour would be `3600`, etc. Conflicts with `startTime` and `endTime`.
*/
readonly timeRange: pulumi.Output<number | undefined>;
/**
* The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
*/
readonly timezone: pulumi.Output<string | undefined>;
/**
* Must be `"Metric"` or `"Binary`". `"Metric"` by default.
*/
readonly unitPrefix: pulumi.Output<string | undefined>;
/**
* The URL of the chart.
*/
readonly url: pulumi.Output<string>;
/**
* Plot-level customization options, associated with a publish statement.
*/
readonly vizOptions: pulumi.Output<outputs.ListChartVizOption[] | undefined>;
/**
* Create a ListChart resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ListChartArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ListChart resources.
*/
export interface ListChartState {
/**
* Must be one of `"Scale"`, `"Dimension"` or `"Metric"`. `"Dimension"` by default.
*/
colorBy?: pulumi.Input<string | undefined>;
/**
* Single color range including both the color to display for that range and the borders of the range. Example: `[{ gt = 60, color = "blue" }, { lte = 60, color = "yellow" }]`. Look at this [link](https://docs.splunk.com/observability/en/data-visualization/charts/chart-options.html).
*/
colorScales?: pulumi.Input<pulumi.Input<inputs.ListChartColorScale>[] | undefined>;
/**
* Description of the chart.
*/
description?: pulumi.Input<string | undefined>;
/**
* If `false`, samples a subset of the output MTS, which improves UI performance. `false` by default.
*/
disableSampling?: pulumi.Input<boolean | undefined>;
/**
* Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
*/
endTime?: pulumi.Input<number | undefined>;
/**
* Determines whether to hide missing data points in the chart. If `true`, missing data points in the chart would be hidden. `false` by default.
*/
hideMissingValues?: pulumi.Input<boolean | undefined>;
/**
* List of properties that should not be displayed in the chart legend (i.e. dimension names). All the properties are visible by default. Deprecated, please use `legendOptionsFields`.
*
* @deprecated Please use legend_options_fields
*/
legendFieldsToHides?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* List of property names and enabled flags that should be displayed in the data table for the chart, in the order provided. This option cannot be used with `legendFieldsToHide`.
*/
legendOptionsFields?: pulumi.Input<pulumi.Input<inputs.ListChartLegendOptionsField>[] | undefined>;
/**
* How long (in seconds) to wait for late datapoints.
*/
maxDelay?: pulumi.Input<number | undefined>;
/**
* Maximum number of digits to display when rounding values up or down.
*/
maxPrecision?: pulumi.Input<number | undefined>;
/**
* Name of the chart.
*/
name?: pulumi.Input<string | undefined>;
/**
* Signalflow program text for the chart. More info[in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/).
*/
programText?: pulumi.Input<string | undefined>;
/**
* How often (in seconds) to refresh the values of the list.
*/
refreshInterval?: pulumi.Input<number | undefined>;
/**
* The type of secondary visualization. Can be `None`, `Radial`, `Linear`, or `Sparkline`. If unset, the Splunk Observability Cloud default is used (`Sparkline`).
*/
secondaryVisualization?: pulumi.Input<string | undefined>;
/**
* The property to use when sorting the elements. Use `value` if you want to sort by value. Must be prepended with `+` for ascending or `-` for descending (e.g. `-foo`). Note there are some special values for some of the options provided in the UX: `"value"` for Value, `"sf_originatingMetric"` for Metric, and `"sfMetric"` for plot.
*/
sortBy?: pulumi.Input<string | undefined>;
/**
* Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
*/
startTime?: pulumi.Input<number | undefined>;
/**
* Tags associated with the resource
*/
tags?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* How many seconds ago from which to display data. For example, the last hour would be `3600`, etc. Conflicts with `startTime` and `endTime`.
*/
timeRange?: pulumi.Input<number | undefined>;
/**
* The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
*/
timezone?: pulumi.Input<string | undefined>;
/**
* Must be `"Metric"` or `"Binary`". `"Metric"` by default.
*/
unitPrefix?: pulumi.Input<string | undefined>;
/**
* The URL of the chart.
*/
url?: pulumi.Input<string | undefined>;
/**
* Plot-level customization options, associated with a publish statement.
*/
vizOptions?: pulumi.Input<pulumi.Input<inputs.ListChartVizOption>[] | undefined>;
}
/**
* The set of arguments for constructing a ListChart resource.
*/
export interface ListChartArgs {
/**
* Must be one of `"Scale"`, `"Dimension"` or `"Metric"`. `"Dimension"` by default.
*/
colorBy?: pulumi.Input<string | undefined>;
/**
* Single color range including both the color to display for that range and the borders of the range. Example: `[{ gt = 60, color = "blue" }, { lte = 60, color = "yellow" }]`. Look at this [link](https://docs.splunk.com/observability/en/data-visualization/charts/chart-options.html).
*/
colorScales?: pulumi.Input<pulumi.Input<inputs.ListChartColorScale>[] | undefined>;
/**
* Description of the chart.
*/
description?: pulumi.Input<string | undefined>;
/**
* If `false`, samples a subset of the output MTS, which improves UI performance. `false` by default.
*/
disableSampling?: pulumi.Input<boolean | undefined>;
/**
* Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
*/
endTime?: pulumi.Input<number | undefined>;
/**
* Determines whether to hide missing data points in the chart. If `true`, missing data points in the chart would be hidden. `false` by default.
*/
hideMissingValues?: pulumi.Input<boolean | undefined>;
/**
* List of properties that should not be displayed in the chart legend (i.e. dimension names). All the properties are visible by default. Deprecated, please use `legendOptionsFields`.
*
* @deprecated Please use legend_options_fields
*/
legendFieldsToHides?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* List of property names and enabled flags that should be displayed in the data table for the chart, in the order provided. This option cannot be used with `legendFieldsToHide`.
*/
legendOptionsFields?: pulumi.Input<pulumi.Input<inputs.ListChartLegendOptionsField>[] | undefined>;
/**
* How long (in seconds) to wait for late datapoints.
*/
maxDelay?: pulumi.Input<number | undefined>;
/**
* Maximum number of digits to display when rounding values up or down.
*/
maxPrecision?: pulumi.Input<number | undefined>;
/**
* Name of the chart.
*/
name?: pulumi.Input<string | undefined>;
/**
* Signalflow program text for the chart. More info[in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/).
*/
programText: pulumi.Input<string>;
/**
* How often (in seconds) to refresh the values of the list.
*/
refreshInterval?: pulumi.Input<number | undefined>;
/**
* The type of secondary visualization. Can be `None`, `Radial`, `Linear`, or `Sparkline`. If unset, the Splunk Observability Cloud default is used (`Sparkline`).
*/
secondaryVisualization?: pulumi.Input<string | undefined>;
/**
* The property to use when sorting the elements. Use `value` if you want to sort by value. Must be prepended with `+` for ascending or `-` for descending (e.g. `-foo`). Note there are some special values for some of the options provided in the UX: `"value"` for Value, `"sf_originatingMetric"` for Metric, and `"sfMetric"` for plot.
*/
sortBy?: pulumi.Input<string | undefined>;
/**
* Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
*/
startTime?: pulumi.Input<number | undefined>;
/**
* Tags associated with the resource
*/
tags?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* How many seconds ago from which to display data. For example, the last hour would be `3600`, etc. Conflicts with `startTime` and `endTime`.
*/
timeRange?: pulumi.Input<number | undefined>;
/**
* The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
*/
timezone?: pulumi.Input<string | undefined>;
/**
* Must be `"Metric"` or `"Binary`". `"Metric"` by default.
*/
unitPrefix?: pulumi.Input<string | undefined>;
/**
* Plot-level customization options, associated with a publish statement.
*/
vizOptions?: pulumi.Input<pulumi.Input<inputs.ListChartVizOption>[] | undefined>;
}
//# sourceMappingURL=listChart.d.ts.map