Docs Packages
  1. Packages
  2. SignalFx
  3. API Docs
  4. TableChart
SignalFx v7.1.6 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-signalfx

signalfx.TableChart

Explore with Pulumi AI

signalfx logo
SignalFx v7.1.6 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-signalfx

    This special type of chart displays a data table. This table can be grouped by a dimension.

    Example

    # signalfx_list_chart.Logs-Exec_0:
resource "signalfx_table_chart" "table_0" {
    description             = "beep"
    disable_sampling        = false
    max_delay               = 0
    name                    = "TableChart!"
    program_text            = "A = data('cpu.usage.total').publish(label='CPU Total')"
    group_by                = ["ClusterName"]
}

    Create TableChart Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new TableChart(name: string, args: TableChartArgs, opts?: CustomResourceOptions);
    @overload
def TableChart(resource_name: str,
               args: TableChartArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def TableChart(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               program_text: Optional[str] = None,
               description: Optional[str] = None,
               disable_sampling: Optional[bool] = None,
               group_bies: Optional[Sequence[str]] = None,
               hide_timestamp: Optional[bool] = None,
               max_delay: Optional[int] = None,
               minimum_resolution: Optional[int] = None,
               name: Optional[str] = None,
               refresh_interval: Optional[int] = None,
               timezone: Optional[str] = None,
               unit_prefix: Optional[str] = None,
               viz_options: Optional[Sequence[TableChartVizOptionArgs]] = None)
    func NewTableChart(ctx *Context, name string, args TableChartArgs, opts ...ResourceOption) (*TableChart, error)
    public TableChart(string name, TableChartArgs args, CustomResourceOptions? opts = null)
    public TableChart(String name, TableChartArgs args)
public TableChart(String name, TableChartArgs args, CustomResourceOptions options)

    type: signalfx:TableChart
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args TableChartArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args TableChartArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args TableChartArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TableChartArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TableChartArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var tableChartResource = new SignalFx.TableChart("tableChartResource", new()
{
    ProgramText = "string",
    Description = "string",
    DisableSampling = false,
    GroupBies = new[]
    {
        "string",
    },
    HideTimestamp = false,
    MaxDelay = 0,
    MinimumResolution = 0,
    Name = "string",
    RefreshInterval = 0,
    Timezone = "string",
    UnitPrefix = "string",
    VizOptions = new[]
    {
        new SignalFx.Inputs.TableChartVizOptionArgs
        {
            Label = "string",
            Color = "string",
            DisplayName = "string",
            ValuePrefix = "string",
            ValueSuffix = "string",
            ValueUnit = "string",
        },
    },
});

    example, err := signalfx.NewTableChart(ctx, "tableChartResource", &signalfx.TableChartArgs{
	ProgramText:     pulumi.String("string"),
	Description:     pulumi.String("string"),
	DisableSampling: pulumi.Bool(false),
	GroupBies: pulumi.StringArray{
		pulumi.String("string"),
	},
	HideTimestamp:     pulumi.Bool(false),
	MaxDelay:          pulumi.Int(0),
	MinimumResolution: pulumi.Int(0),
	Name:              pulumi.String("string"),
	RefreshInterval:   pulumi.Int(0),
	Timezone:          pulumi.String("string"),
	UnitPrefix:        pulumi.String("string"),
	VizOptions: signalfx.TableChartVizOptionArray{
		&signalfx.TableChartVizOptionArgs{
			Label:       pulumi.String("string"),
			Color:       pulumi.String("string"),
			DisplayName: pulumi.String("string"),
			ValuePrefix: pulumi.String("string"),
			ValueSuffix: pulumi.String("string"),
			ValueUnit:   pulumi.String("string"),
		},
	},
})

    var tableChartResource = new TableChart("tableChartResource", TableChartArgs.builder()
    .programText("string")
    .description("string")
    .disableSampling(false)
    .groupBies("string")
    .hideTimestamp(false)
    .maxDelay(0)
    .minimumResolution(0)
    .name("string")
    .refreshInterval(0)
    .timezone("string")
    .unitPrefix("string")
    .vizOptions(TableChartVizOptionArgs.builder()
        .label("string")
        .color("string")
        .displayName("string")
        .valuePrefix("string")
        .valueSuffix("string")
        .valueUnit("string")
        .build())
    .build());

    table_chart_resource = signalfx.TableChart("tableChartResource",
    program_text="string",
    description="string",
    disable_sampling=False,
    group_bies=["string"],
    hide_timestamp=False,
    max_delay=0,
    minimum_resolution=0,
    name="string",
    refresh_interval=0,
    timezone="string",
    unit_prefix="string",
    viz_options=[signalfx.TableChartVizOptionArgs(
        label="string",
        color="string",
        display_name="string",
        value_prefix="string",
        value_suffix="string",
        value_unit="string",
    )])

    const tableChartResource = new signalfx.TableChart("tableChartResource", {
    programText: "string",
    description: "string",
    disableSampling: false,
    groupBies: ["string"],
    hideTimestamp: false,
    maxDelay: 0,
    minimumResolution: 0,
    name: "string",
    refreshInterval: 0,
    timezone: "string",
    unitPrefix: "string",
    vizOptions: [{
        label: "string",
        color: "string",
        displayName: "string",
        valuePrefix: "string",
        valueSuffix: "string",
        valueUnit: "string",
    }],
});

    type: signalfx:TableChart
properties:
    description: string
    disableSampling: false
    groupBies:
        - string
    hideTimestamp: false
    maxDelay: 0
    minimumResolution: 0
    name: string
    programText: string
    refreshInterval: 0
    timezone: string
    unitPrefix: string
    vizOptions:
        - color: string
          displayName: string
          label: string
          valuePrefix: string
          valueSuffix: string
          valueUnit: string

    TableChart Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The TableChart resource accepts the following input properties:

    ProgramText string
    The SignalFlow for your Data Table Chart
    Description string
    Description of the table chart.
    DisableSampling bool
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    GroupBies List<string>
    Dimension to group by
    HideTimestamp bool
    (false by default) Whether to show the timestamp in the chart
    MaxDelay int
    How long (in seconds) to wait for late datapoints
    MinimumResolution int
    The minimum resolution (in seconds) to use for computing the underlying program
    Name string
    Name of the table chart.
    RefreshInterval int
    How often (in seconds) to refresh the values of the Table
    Timezone string
    The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
    UnitPrefix string
    (Metric by default) Must be "Metric" or "Binary"
    VizOptions List<Pulumi.SignalFx.Inputs.TableChartVizOption>
    Plot-level customization options, associated with a publish statement
    ProgramText string
    The SignalFlow for your Data Table Chart
    Description string
    Description of the table chart.
    DisableSampling bool
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    GroupBies []string
    Dimension to group by
    HideTimestamp bool
    (false by default) Whether to show the timestamp in the chart
    MaxDelay int
    How long (in seconds) to wait for late datapoints
    MinimumResolution int
    The minimum resolution (in seconds) to use for computing the underlying program
    Name string
    Name of the table chart.
    RefreshInterval int
    How often (in seconds) to refresh the values of the Table
    Timezone string
    The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
    UnitPrefix string
    (Metric by default) Must be "Metric" or "Binary"
    VizOptions []TableChartVizOptionArgs
    Plot-level customization options, associated with a publish statement
    programText String
    The SignalFlow for your Data Table Chart
    description String
    Description of the table chart.
    disableSampling Boolean
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    groupBies List<String>
    Dimension to group by
    hideTimestamp Boolean
    (false by default) Whether to show the timestamp in the chart
    maxDelay Integer
    How long (in seconds) to wait for late datapoints
    minimumResolution Integer
    The minimum resolution (in seconds) to use for computing the underlying program
    name String
    Name of the table chart.
    refreshInterval Integer
    How often (in seconds) to refresh the values of the Table
    timezone String
    The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
    unitPrefix String
    (Metric by default) Must be "Metric" or "Binary"
    vizOptions List<TableChartVizOption>
    Plot-level customization options, associated with a publish statement
    programText string
    The SignalFlow for your Data Table Chart
    description string
    Description of the table chart.
    disableSampling boolean
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    groupBies string[]
    Dimension to group by
    hideTimestamp boolean
    (false by default) Whether to show the timestamp in the chart
    maxDelay number
    How long (in seconds) to wait for late datapoints
    minimumResolution number
    The minimum resolution (in seconds) to use for computing the underlying program
    name string
    Name of the table chart.
    refreshInterval number
    How often (in seconds) to refresh the values of the Table
    timezone string
    The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
    unitPrefix string
    (Metric by default) Must be "Metric" or "Binary"
    vizOptions TableChartVizOption[]
    Plot-level customization options, associated with a publish statement
    program_text str
    The SignalFlow for your Data Table Chart
    description str
    Description of the table chart.
    disable_sampling bool
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    group_bies Sequence[str]
    Dimension to group by
    hide_timestamp bool
    (false by default) Whether to show the timestamp in the chart
    max_delay int
    How long (in seconds) to wait for late datapoints
    minimum_resolution int
    The minimum resolution (in seconds) to use for computing the underlying program
    name str
    Name of the table chart.
    refresh_interval int
    How often (in seconds) to refresh the values of the Table
    timezone str
    The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
    unit_prefix str
    (Metric by default) Must be "Metric" or "Binary"
    viz_options Sequence[TableChartVizOptionArgs]
    Plot-level customization options, associated with a publish statement
    programText String
    The SignalFlow for your Data Table Chart
    description String
    Description of the table chart.
    disableSampling Boolean
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    groupBies List<String>
    Dimension to group by
    hideTimestamp Boolean
    (false by default) Whether to show the timestamp in the chart
    maxDelay Number
    How long (in seconds) to wait for late datapoints
    minimumResolution Number
    The minimum resolution (in seconds) to use for computing the underlying program
    name String
    Name of the table chart.
    refreshInterval Number
    How often (in seconds) to refresh the values of the Table
    timezone String
    The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
    unitPrefix String
    (Metric by default) Must be "Metric" or "Binary"
    vizOptions List<Property Map>
    Plot-level customization options, associated with a publish statement

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TableChart resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Url string
    The URL of the chart.
    Id string
    The provider-assigned unique ID for this managed resource.
    Url string
    The URL of the chart.
    id String
    The provider-assigned unique ID for this managed resource.
    url String
    The URL of the chart.
    id string
    The provider-assigned unique ID for this managed resource.
    url string
    The URL of the chart.
    id str
    The provider-assigned unique ID for this managed resource.
    url str
    The URL of the chart.
    id String
    The provider-assigned unique ID for this managed resource.
    url String
    The URL of the chart.

    Look up Existing TableChart Resource

    Get an existing TableChart resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: TableChartState, opts?: CustomResourceOptions): TableChart
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        disable_sampling: Optional[bool] = None,
        group_bies: Optional[Sequence[str]] = None,
        hide_timestamp: Optional[bool] = None,
        max_delay: Optional[int] = None,
        minimum_resolution: Optional[int] = None,
        name: Optional[str] = None,
        program_text: Optional[str] = None,
        refresh_interval: Optional[int] = None,
        timezone: Optional[str] = None,
        unit_prefix: Optional[str] = None,
        url: Optional[str] = None,
        viz_options: Optional[Sequence[TableChartVizOptionArgs]] = None) -> TableChart
    func GetTableChart(ctx *Context, name string, id IDInput, state *TableChartState, opts ...ResourceOption) (*TableChart, error)
    public static TableChart Get(string name, Input<string> id, TableChartState? state, CustomResourceOptions? opts = null)
    public static TableChart get(String name, Output<String> id, TableChartState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    Description of the table chart.
    DisableSampling bool
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    GroupBies List<string>
    Dimension to group by
    HideTimestamp bool
    (false by default) Whether to show the timestamp in the chart
    MaxDelay int
    How long (in seconds) to wait for late datapoints
    MinimumResolution int
    The minimum resolution (in seconds) to use for computing the underlying program
    Name string
    Name of the table chart.
    ProgramText string
    The SignalFlow for your Data Table Chart
    RefreshInterval int
    How often (in seconds) to refresh the values of the Table
    Timezone string
    The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
    UnitPrefix string
    (Metric by default) Must be "Metric" or "Binary"
    Url string
    The URL of the chart.
    VizOptions List<Pulumi.SignalFx.Inputs.TableChartVizOption>
    Plot-level customization options, associated with a publish statement
    Description string
    Description of the table chart.
    DisableSampling bool
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    GroupBies []string
    Dimension to group by
    HideTimestamp bool
    (false by default) Whether to show the timestamp in the chart
    MaxDelay int
    How long (in seconds) to wait for late datapoints
    MinimumResolution int
    The minimum resolution (in seconds) to use for computing the underlying program
    Name string
    Name of the table chart.
    ProgramText string
    The SignalFlow for your Data Table Chart
    RefreshInterval int
    How often (in seconds) to refresh the values of the Table
    Timezone string
    The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
    UnitPrefix string
    (Metric by default) Must be "Metric" or "Binary"
    Url string
    The URL of the chart.
    VizOptions []TableChartVizOptionArgs
    Plot-level customization options, associated with a publish statement
    description String
    Description of the table chart.
    disableSampling Boolean
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    groupBies List<String>
    Dimension to group by
    hideTimestamp Boolean
    (false by default) Whether to show the timestamp in the chart
    maxDelay Integer
    How long (in seconds) to wait for late datapoints
    minimumResolution Integer
    The minimum resolution (in seconds) to use for computing the underlying program
    name String
    Name of the table chart.
    programText String
    The SignalFlow for your Data Table Chart
    refreshInterval Integer
    How often (in seconds) to refresh the values of the Table
    timezone String
    The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
    unitPrefix String
    (Metric by default) Must be "Metric" or "Binary"
    url String
    The URL of the chart.
    vizOptions List<TableChartVizOption>
    Plot-level customization options, associated with a publish statement
    description string
    Description of the table chart.
    disableSampling boolean
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    groupBies string[]
    Dimension to group by
    hideTimestamp boolean
    (false by default) Whether to show the timestamp in the chart
    maxDelay number
    How long (in seconds) to wait for late datapoints
    minimumResolution number
    The minimum resolution (in seconds) to use for computing the underlying program
    name string
    Name of the table chart.
    programText string
    The SignalFlow for your Data Table Chart
    refreshInterval number
    How often (in seconds) to refresh the values of the Table
    timezone string
    The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
    unitPrefix string
    (Metric by default) Must be "Metric" or "Binary"
    url string
    The URL of the chart.
    vizOptions TableChartVizOption[]
    Plot-level customization options, associated with a publish statement
    description str
    Description of the table chart.
    disable_sampling bool
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    group_bies Sequence[str]
    Dimension to group by
    hide_timestamp bool
    (false by default) Whether to show the timestamp in the chart
    max_delay int
    How long (in seconds) to wait for late datapoints
    minimum_resolution int
    The minimum resolution (in seconds) to use for computing the underlying program
    name str
    Name of the table chart.
    program_text str
    The SignalFlow for your Data Table Chart
    refresh_interval int
    How often (in seconds) to refresh the values of the Table
    timezone str
    The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
    unit_prefix str
    (Metric by default) Must be "Metric" or "Binary"
    url str
    The URL of the chart.
    viz_options Sequence[TableChartVizOptionArgs]
    Plot-level customization options, associated with a publish statement
    description String
    Description of the table chart.
    disableSampling Boolean
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    groupBies List<String>
    Dimension to group by
    hideTimestamp Boolean
    (false by default) Whether to show the timestamp in the chart
    maxDelay Number
    How long (in seconds) to wait for late datapoints
    minimumResolution Number
    The minimum resolution (in seconds) to use for computing the underlying program
    name String
    Name of the table chart.
    programText String
    The SignalFlow for your Data Table Chart
    refreshInterval Number
    How often (in seconds) to refresh the values of the Table
    timezone String
    The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
    unitPrefix String
    (Metric by default) Must be "Metric" or "Binary"
    url String
    The URL of the chart.
    vizOptions List<Property Map>
    Plot-level customization options, associated with a publish statement

    Supporting Types

    TableChartVizOption, TableChartVizOptionArgs

    Label string
    The label used in the publish statement that displays the plot (metric time series data) you want to customize
    Color string
    Color to use
    DisplayName string
    Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
    ValuePrefix string
    An arbitrary prefix to display with the value of this plot
    ValueSuffix string
    An arbitrary suffix to display with the value of this plot
    ValueUnit string
    A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes)
    Label string
    The label used in the publish statement that displays the plot (metric time series data) you want to customize
    Color string
    Color to use
    DisplayName string
    Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
    ValuePrefix string
    An arbitrary prefix to display with the value of this plot
    ValueSuffix string
    An arbitrary suffix to display with the value of this plot
    ValueUnit string
    A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes)
    label String
    The label used in the publish statement that displays the plot (metric time series data) you want to customize
    color String
    Color to use
    displayName String
    Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
    valuePrefix String
    An arbitrary prefix to display with the value of this plot
    valueSuffix String
    An arbitrary suffix to display with the value of this plot
    valueUnit String
    A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes)
    label string
    The label used in the publish statement that displays the plot (metric time series data) you want to customize
    color string
    Color to use
    displayName string
    Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
    valuePrefix string
    An arbitrary prefix to display with the value of this plot
    valueSuffix string
    An arbitrary suffix to display with the value of this plot
    valueUnit string
    A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes)
    label str
    The label used in the publish statement that displays the plot (metric time series data) you want to customize
    color str
    Color to use
    display_name str
    Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
    value_prefix str
    An arbitrary prefix to display with the value of this plot
    value_suffix str
    An arbitrary suffix to display with the value of this plot
    value_unit str
    A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes)
    label String
    The label used in the publish statement that displays the plot (metric time series data) you want to customize
    color String
    Color to use
    displayName String
    Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
    valuePrefix String
    An arbitrary prefix to display with the value of this plot
    valueSuffix String
    An arbitrary suffix to display with the value of this plot
    valueUnit String
    A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes)

    Package Details

    Repository
    SignalFx pulumi/pulumi-signalfx
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the signalfx Terraform Provider.
    signalfx logo
    SignalFx v7.1.6 published on Wednesday, Jun 19, 2024 by Pulumi
    pulumi/pulumi-signalfx