@pulumi/signalfx
Version:
A Pulumi package for creating and managing SignalFx resources.
223 lines (222 loc) • 7.46 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* This special type of chart displays a data table. This table can be grouped by a dimension.
*
* ## Example
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as signalfx from "@pulumi/signalfx";
*
* // signalfx_list_chart.Logs-Exec_0:
* const table0 = new signalfx.TableChart("table_0", {
* description: "beep",
* disableSampling: false,
* maxDelay: 0,
* name: "TableChart!",
* programText: "A = data('cpu.usage.total').publish(label='CPU Total')",
* groupBies: ["ClusterName"],
* });
* ```
*/
export declare class TableChart extends pulumi.CustomResource {
/**
* Get an existing TableChart 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?: TableChartState, opts?: pulumi.CustomResourceOptions): TableChart;
/**
* Returns true if the given object is an instance of TableChart. 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 TableChart;
/**
* Description of the table chart.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* (false by default) If false, samples a subset of the output MTS, which improves UI performance
*/
readonly disableSampling: pulumi.Output<boolean | undefined>;
/**
* Dimension to group by
*/
readonly groupBies: pulumi.Output<string[] | undefined>;
/**
* (false by default) Whether to show the timestamp in the chart
*/
readonly hideTimestamp: pulumi.Output<boolean | undefined>;
/**
* How long (in seconds) to wait for late datapoints
*/
readonly maxDelay: pulumi.Output<number | undefined>;
/**
* The minimum resolution (in seconds) to use for computing the underlying program
*/
readonly minimumResolution: pulumi.Output<number | undefined>;
/**
* Name of the table chart.
*/
readonly name: pulumi.Output<string>;
/**
* The SignalFlow for your Data Table Chart
*/
readonly programText: pulumi.Output<string>;
/**
* How often (in seconds) to refresh the values of the Table
*/
readonly refreshInterval: pulumi.Output<number | undefined>;
/**
* Tags associated with the resource
*/
readonly tags: pulumi.Output<string[] | undefined>;
/**
* The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
*/
readonly timezone: pulumi.Output<string | undefined>;
/**
* (Metric by default) Must be "Metric" or "Binary"
*/
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.TableChartVizOption[] | undefined>;
/**
* Create a TableChart 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: TableChartArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering TableChart resources.
*/
export interface TableChartState {
/**
* Description of the table chart.
*/
description?: pulumi.Input<string>;
/**
* (false by default) If false, samples a subset of the output MTS, which improves UI performance
*/
disableSampling?: pulumi.Input<boolean>;
/**
* Dimension to group by
*/
groupBies?: pulumi.Input<pulumi.Input<string>[]>;
/**
* (false by default) Whether to show the timestamp in the chart
*/
hideTimestamp?: pulumi.Input<boolean>;
/**
* How long (in seconds) to wait for late datapoints
*/
maxDelay?: pulumi.Input<number>;
/**
* The minimum resolution (in seconds) to use for computing the underlying program
*/
minimumResolution?: pulumi.Input<number>;
/**
* Name of the table chart.
*/
name?: pulumi.Input<string>;
/**
* The SignalFlow for your Data Table Chart
*/
programText?: pulumi.Input<string>;
/**
* How often (in seconds) to refresh the values of the Table
*/
refreshInterval?: pulumi.Input<number>;
/**
* Tags associated with the resource
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
*/
timezone?: pulumi.Input<string>;
/**
* (Metric by default) Must be "Metric" or "Binary"
*/
unitPrefix?: pulumi.Input<string>;
/**
* The URL of the chart.
*/
url?: pulumi.Input<string>;
/**
* Plot-level customization options, associated with a publish statement
*/
vizOptions?: pulumi.Input<pulumi.Input<inputs.TableChartVizOption>[]>;
}
/**
* The set of arguments for constructing a TableChart resource.
*/
export interface TableChartArgs {
/**
* Description of the table chart.
*/
description?: pulumi.Input<string>;
/**
* (false by default) If false, samples a subset of the output MTS, which improves UI performance
*/
disableSampling?: pulumi.Input<boolean>;
/**
* Dimension to group by
*/
groupBies?: pulumi.Input<pulumi.Input<string>[]>;
/**
* (false by default) Whether to show the timestamp in the chart
*/
hideTimestamp?: pulumi.Input<boolean>;
/**
* How long (in seconds) to wait for late datapoints
*/
maxDelay?: pulumi.Input<number>;
/**
* The minimum resolution (in seconds) to use for computing the underlying program
*/
minimumResolution?: pulumi.Input<number>;
/**
* Name of the table chart.
*/
name?: pulumi.Input<string>;
/**
* The SignalFlow for your Data Table Chart
*/
programText: pulumi.Input<string>;
/**
* How often (in seconds) to refresh the values of the Table
*/
refreshInterval?: pulumi.Input<number>;
/**
* Tags associated with the resource
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
*/
timezone?: pulumi.Input<string>;
/**
* (Metric by default) Must be "Metric" or "Binary"
*/
unitPrefix?: pulumi.Input<string>;
/**
* Plot-level customization options, associated with a publish statement
*/
vizOptions?: pulumi.Input<pulumi.Input<inputs.TableChartVizOption>[]>;
}