Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Signalfx Provider
  3. API Docs
  4. HeatmapChart
SignalFx v7.4.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-signalfx

signalfx.HeatmapChart

Explore with Pulumi AI

signalfx logo
SignalFx v7.4.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-signalfx

    This chart type shows the specified plot in a heat map fashion. This format is similar to the Infrastructure Navigator, with squares representing each source for the selected metric, and the color of each square representing the value range of the metric.

    Example

    import * as pulumi from "@pulumi/pulumi";
import * as signalfx from "@pulumi/signalfx";

const myheatmapchart0 = new signalfx.HeatmapChart("myheatmapchart0", {
    name: "CPU Total Idle - Heatmap",
    programText: `myfilters = filter("cluster_name", "prod") and filter("role", "search")
data("cpu.total.idle", filter=myfilters).publish()
`,
    description: "Very cool Heatmap",
    disableSampling: true,
    sortBy: "+host",
    groupBies: [
        "hostname",
        "host",
    ],
    hideTimestamp: true,
    timezone: "Europe/Paris",
    colorRange: {
        minValue: 0,
        maxValue: 100,
        color: "#ff0000",
    },
    colorScales: [
        {
            gte: 99,
            color: "green",
        },
        {
            lt: 99,
            gte: 95,
            color: "yellow",
        },
        {
            lt: 95,
            color: "red",
        },
    ],
});

    import pulumi
import pulumi_signalfx as signalfx

myheatmapchart0 = signalfx.HeatmapChart("myheatmapchart0",
    name="CPU Total Idle - Heatmap",
    program_text="""myfilters = filter("cluster_name", "prod") and filter("role", "search")
data("cpu.total.idle", filter=myfilters).publish()
""",
    description="Very cool Heatmap",
    disable_sampling=True,
    sort_by="+host",
    group_bies=[
        "hostname",
        "host",
    ],
    hide_timestamp=True,
    timezone="Europe/Paris",
    color_range={
        "min_value": 0,
        "max_value": 100,
        "color": "#ff0000",
    },
    color_scales=[
        {
            "gte": 99,
            "color": "green",
        },
        {
            "lt": 99,
            "gte": 95,
            "color": "yellow",
        },
        {
            "lt": 95,
            "color": "red",
        },
    ])

    package main

import (
	"github.com/pulumi/pulumi-signalfx/sdk/v7/go/signalfx"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := signalfx.NewHeatmapChart(ctx, "myheatmapchart0", &signalfx.HeatmapChartArgs{
			Name:            pulumi.String("CPU Total Idle - Heatmap"),
			ProgramText:     pulumi.String("myfilters = filter(\"cluster_name\", \"prod\") and filter(\"role\", \"search\")\ndata(\"cpu.total.idle\", filter=myfilters).publish()\n"),
			Description:     pulumi.String("Very cool Heatmap"),
			DisableSampling: pulumi.Bool(true),
			SortBy:          pulumi.String("+host"),
			GroupBies: pulumi.StringArray{
				pulumi.String("hostname"),
				pulumi.String("host"),
			},
			HideTimestamp: pulumi.Bool(true),
			Timezone:      pulumi.String("Europe/Paris"),
			ColorRange: &signalfx.HeatmapChartColorRangeArgs{
				MinValue: pulumi.Float64(0),
				MaxValue: pulumi.Float64(100),
				Color:    pulumi.String("#ff0000"),
			},
			ColorScales: signalfx.HeatmapChartColorScaleArray{
				&signalfx.HeatmapChartColorScaleArgs{
					Gte:   pulumi.Float64(99),
					Color: pulumi.String("green"),
				},
				&signalfx.HeatmapChartColorScaleArgs{
					Lt:    pulumi.Float64(99),
					Gte:   pulumi.Float64(95),
					Color: pulumi.String("yellow"),
				},
				&signalfx.HeatmapChartColorScaleArgs{
					Lt:    pulumi.Float64(95),
					Color: pulumi.String("red"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using SignalFx = Pulumi.SignalFx;

return await Deployment.RunAsync(() => 
{
    var myheatmapchart0 = new SignalFx.HeatmapChart("myheatmapchart0", new()
    {
        Name = "CPU Total Idle - Heatmap",
        ProgramText = @"myfilters = filter(""cluster_name"", ""prod"") and filter(""role"", ""search"")
data(""cpu.total.idle"", filter=myfilters).publish()
",
        Description = "Very cool Heatmap",
        DisableSampling = true,
        SortBy = "+host",
        GroupBies = new[]
        {
            "hostname",
            "host",
        },
        HideTimestamp = true,
        Timezone = "Europe/Paris",
        ColorRange = new SignalFx.Inputs.HeatmapChartColorRangeArgs
        {
            MinValue = 0,
            MaxValue = 100,
            Color = "#ff0000",
        },
        ColorScales = new[]
        {
            new SignalFx.Inputs.HeatmapChartColorScaleArgs
            {
                Gte = 99,
                Color = "green",
            },
            new SignalFx.Inputs.HeatmapChartColorScaleArgs
            {
                Lt = 99,
                Gte = 95,
                Color = "yellow",
            },
            new SignalFx.Inputs.HeatmapChartColorScaleArgs
            {
                Lt = 95,
                Color = "red",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.signalfx.HeatmapChart;
import com.pulumi.signalfx.HeatmapChartArgs;
import com.pulumi.signalfx.inputs.HeatmapChartColorRangeArgs;
import com.pulumi.signalfx.inputs.HeatmapChartColorScaleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var myheatmapchart0 = new HeatmapChart("myheatmapchart0", HeatmapChartArgs.builder()
            .name("CPU Total Idle - Heatmap")
            .programText("""
myfilters = filter("cluster_name", "prod") and filter("role", "search")
data("cpu.total.idle", filter=myfilters).publish()
            """)
            .description("Very cool Heatmap")
            .disableSampling(true)
            .sortBy("+host")
            .groupBies(            
                "hostname",
                "host")
            .hideTimestamp(true)
            .timezone("Europe/Paris")
            .colorRange(HeatmapChartColorRangeArgs.builder()
                .minValue(0)
                .maxValue(100)
                .color("#ff0000")
                .build())
            .colorScales(            
                HeatmapChartColorScaleArgs.builder()
                    .gte(99)
                    .color("green")
                    .build(),
                HeatmapChartColorScaleArgs.builder()
                    .lt(99)
                    .gte(95)
                    .color("yellow")
                    .build(),
                HeatmapChartColorScaleArgs.builder()
                    .lt(95)
                    .color("red")
                    .build())
            .build());

    }
}

    resources:
  myheatmapchart0:
    type: signalfx:HeatmapChart
    properties:
      name: CPU Total Idle - Heatmap
      programText: |
        myfilters = filter("cluster_name", "prod") and filter("role", "search")
        data("cpu.total.idle", filter=myfilters).publish()        
      description: Very cool Heatmap
      disableSampling: true
      sortBy: +host
      groupBies:
        - hostname
        - host
      hideTimestamp: true
      timezone: Europe/Paris
      colorRange:
        minValue: 0
        maxValue: 100
        color: '#ff0000'
      colorScales:
        - gte: 99
          color: green
        - lt: 99
          gte: 95
          color: yellow
        - lt: 95
          color: red

    Create HeatmapChart Resource

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

    Constructor syntax

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

@overload
def HeatmapChart(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 program_text: Optional[str] = None,
                 disable_sampling: Optional[bool] = None,
                 description: Optional[str] = None,
                 color_range: Optional[HeatmapChartColorRangeArgs] = 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,
                 color_scales: Optional[Sequence[HeatmapChartColorScaleArgs]] = None,
                 refresh_interval: Optional[int] = None,
                 sort_by: Optional[str] = None,
                 timezone: Optional[str] = None,
                 unit_prefix: Optional[str] = None)
    func NewHeatmapChart(ctx *Context, name string, args HeatmapChartArgs, opts ...ResourceOption) (*HeatmapChart, error)
    public HeatmapChart(string name, HeatmapChartArgs args, CustomResourceOptions? opts = null)
    public HeatmapChart(String name, HeatmapChartArgs args)
public HeatmapChart(String name, HeatmapChartArgs args, CustomResourceOptions options)

    type: signalfx:HeatmapChart
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 HeatmapChartArgs
    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 HeatmapChartArgs
    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 HeatmapChartArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HeatmapChartArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HeatmapChartArgs
    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 heatmapChartResource = new SignalFx.HeatmapChart("heatmapChartResource", new()
{
    ProgramText = "string",
    DisableSampling = false,
    Description = "string",
    ColorRange = new SignalFx.Inputs.HeatmapChartColorRangeArgs
    {
        Color = "string",
        MaxValue = 0,
        MinValue = 0,
    },
    GroupBies = new[]
    {
        "string",
    },
    HideTimestamp = false,
    MaxDelay = 0,
    MinimumResolution = 0,
    Name = "string",
    ColorScales = new[]
    {
        new SignalFx.Inputs.HeatmapChartColorScaleArgs
        {
            Color = "string",
            Gt = 0,
            Gte = 0,
            Lt = 0,
            Lte = 0,
        },
    },
    RefreshInterval = 0,
    SortBy = "string",
    Timezone = "string",
    UnitPrefix = "string",
});

    example, err := signalfx.NewHeatmapChart(ctx, "heatmapChartResource", &signalfx.HeatmapChartArgs{
	ProgramText:     pulumi.String("string"),
	DisableSampling: pulumi.Bool(false),
	Description:     pulumi.String("string"),
	ColorRange: &signalfx.HeatmapChartColorRangeArgs{
		Color:    pulumi.String("string"),
		MaxValue: pulumi.Float64(0),
		MinValue: pulumi.Float64(0),
	},
	GroupBies: pulumi.StringArray{
		pulumi.String("string"),
	},
	HideTimestamp:     pulumi.Bool(false),
	MaxDelay:          pulumi.Int(0),
	MinimumResolution: pulumi.Int(0),
	Name:              pulumi.String("string"),
	ColorScales: signalfx.HeatmapChartColorScaleArray{
		&signalfx.HeatmapChartColorScaleArgs{
			Color: pulumi.String("string"),
			Gt:    pulumi.Float64(0),
			Gte:   pulumi.Float64(0),
			Lt:    pulumi.Float64(0),
			Lte:   pulumi.Float64(0),
		},
	},
	RefreshInterval: pulumi.Int(0),
	SortBy:          pulumi.String("string"),
	Timezone:        pulumi.String("string"),
	UnitPrefix:      pulumi.String("string"),
})

    var heatmapChartResource = new HeatmapChart("heatmapChartResource", HeatmapChartArgs.builder()
    .programText("string")
    .disableSampling(false)
    .description("string")
    .colorRange(HeatmapChartColorRangeArgs.builder()
        .color("string")
        .maxValue(0)
        .minValue(0)
        .build())
    .groupBies("string")
    .hideTimestamp(false)
    .maxDelay(0)
    .minimumResolution(0)
    .name("string")
    .colorScales(HeatmapChartColorScaleArgs.builder()
        .color("string")
        .gt(0)
        .gte(0)
        .lt(0)
        .lte(0)
        .build())
    .refreshInterval(0)
    .sortBy("string")
    .timezone("string")
    .unitPrefix("string")
    .build());

    heatmap_chart_resource = signalfx.HeatmapChart("heatmapChartResource",
    program_text="string",
    disable_sampling=False,
    description="string",
    color_range={
        "color": "string",
        "max_value": 0,
        "min_value": 0,
    },
    group_bies=["string"],
    hide_timestamp=False,
    max_delay=0,
    minimum_resolution=0,
    name="string",
    color_scales=[{
        "color": "string",
        "gt": 0,
        "gte": 0,
        "lt": 0,
        "lte": 0,
    }],
    refresh_interval=0,
    sort_by="string",
    timezone="string",
    unit_prefix="string")

    const heatmapChartResource = new signalfx.HeatmapChart("heatmapChartResource", {
    programText: "string",
    disableSampling: false,
    description: "string",
    colorRange: {
        color: "string",
        maxValue: 0,
        minValue: 0,
    },
    groupBies: ["string"],
    hideTimestamp: false,
    maxDelay: 0,
    minimumResolution: 0,
    name: "string",
    colorScales: [{
        color: "string",
        gt: 0,
        gte: 0,
        lt: 0,
        lte: 0,
    }],
    refreshInterval: 0,
    sortBy: "string",
    timezone: "string",
    unitPrefix: "string",
});

    type: signalfx:HeatmapChart
properties:
    colorRange:
        color: string
        maxValue: 0
        minValue: 0
    colorScales:
        - color: string
          gt: 0
          gte: 0
          lt: 0
          lte: 0
    description: string
    disableSampling: false
    groupBies:
        - string
    hideTimestamp: false
    maxDelay: 0
    minimumResolution: 0
    name: string
    programText: string
    refreshInterval: 0
    sortBy: string
    timezone: string
    unitPrefix: string

    HeatmapChart Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The HeatmapChart resource accepts the following input properties:

    ProgramText string
    Signalflow program text for the chart. More info at https://dev.splunk.com/observability/docs/signalflow/.
    ColorRange Pulumi.SignalFx.Inputs.HeatmapChartColorRange
    Values and color for the color range. Example: color_range : { min : 0, max : 100, color : "#0000ff" }. Look at this link.
    ColorScales List<Pulumi.SignalFx.Inputs.HeatmapChartColorScale>
    One to N blocks, each defining a single color range including both the color to display for that range and the borders of the range. Example: color_scale { gt = 60, color = "blue" } color_scale { lte = 60, color = "yellow" }. Look at this link.
    Description string
    Description of the chart.
    DisableSampling bool
    If false, samples a subset of the output MTS, which improves UI performance. false by default.
    GroupBies List<string>
    Properties to group by in the heatmap (in nesting order).
    HideTimestamp bool
    Whether to show the timestamp in the chart. false by default.
    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 chart.
    RefreshInterval int
    How often (in seconds) to refresh the values of the heatmap.
    SortBy string
    The property to use when sorting the elements. Must be prepended with + for ascending or - for descending (e.g. -foo).
    Timezone string
    The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
    UnitPrefix string
    Must be "Metric" or "Binary". "Metric" by default.
    ProgramText string
    Signalflow program text for the chart. More info at https://dev.splunk.com/observability/docs/signalflow/.
    ColorRange HeatmapChartColorRangeArgs
    Values and color for the color range. Example: color_range : { min : 0, max : 100, color : "#0000ff" }. Look at this link.
    ColorScales []HeatmapChartColorScaleArgs
    One to N blocks, each defining a single color range including both the color to display for that range and the borders of the range. Example: color_scale { gt = 60, color = "blue" } color_scale { lte = 60, color = "yellow" }. Look at this link.
    Description string
    Description of the chart.
    DisableSampling bool
    If false, samples a subset of the output MTS, which improves UI performance. false by default.
    GroupBies []string
    Properties to group by in the heatmap (in nesting order).
    HideTimestamp bool
    Whether to show the timestamp in the chart. false by default.
    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 chart.
    RefreshInterval int
    How often (in seconds) to refresh the values of the heatmap.
    SortBy string
    The property to use when sorting the elements. Must be prepended with + for ascending or - for descending (e.g. -foo).
    Timezone string
    The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
    UnitPrefix string
    Must be "Metric" or "Binary". "Metric" by default.
    programText String
    Signalflow program text for the chart. More info at https://dev.splunk.com/observability/docs/signalflow/.
    colorRange HeatmapChartColorRange
    Values and color for the color range. Example: color_range : { min : 0, max : 100, color : "#0000ff" }. Look at this link.
    colorScales List<HeatmapChartColorScale>
    One to N blocks, each defining a single color range including both the color to display for that range and the borders of the range. Example: color_scale { gt = 60, color = "blue" } color_scale { lte = 60, color = "yellow" }. Look at this link.
    description String
    Description of the chart.
    disableSampling Boolean
    If false, samples a subset of the output MTS, which improves UI performance. false by default.
    groupBies List<String>
    Properties to group by in the heatmap (in nesting order).
    hideTimestamp Boolean
    Whether to show the timestamp in the chart. false by default.
    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 chart.
    refreshInterval Integer
    How often (in seconds) to refresh the values of the heatmap.
    sortBy String
    The property to use when sorting the elements. Must be prepended with + for ascending or - for descending (e.g. -foo).
    timezone String
    The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
    unitPrefix String
    Must be "Metric" or "Binary". "Metric" by default.
    programText string
    Signalflow program text for the chart. More info at https://dev.splunk.com/observability/docs/signalflow/.
    colorRange HeatmapChartColorRange
    Values and color for the color range. Example: color_range : { min : 0, max : 100, color : "#0000ff" }. Look at this link.
    colorScales HeatmapChartColorScale[]
    One to N blocks, each defining a single color range including both the color to display for that range and the borders of the range. Example: color_scale { gt = 60, color = "blue" } color_scale { lte = 60, color = "yellow" }. Look at this link.
    description string
    Description of the chart.
    disableSampling boolean
    If false, samples a subset of the output MTS, which improves UI performance. false by default.
    groupBies string[]
    Properties to group by in the heatmap (in nesting order).
    hideTimestamp boolean
    Whether to show the timestamp in the chart. false by default.
    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 chart.
    refreshInterval number
    How often (in seconds) to refresh the values of the heatmap.
    sortBy string
    The property to use when sorting the elements. Must be prepended with + for ascending or - for descending (e.g. -foo).
    timezone string
    The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
    unitPrefix string
    Must be "Metric" or "Binary". "Metric" by default.
    program_text str
    Signalflow program text for the chart. More info at https://dev.splunk.com/observability/docs/signalflow/.
    color_range HeatmapChartColorRangeArgs
    Values and color for the color range. Example: color_range : { min : 0, max : 100, color : "#0000ff" }. Look at this link.
    color_scales Sequence[HeatmapChartColorScaleArgs]
    One to N blocks, each defining a single color range including both the color to display for that range and the borders of the range. Example: color_scale { gt = 60, color = "blue" } color_scale { lte = 60, color = "yellow" }. Look at this link.
    description str
    Description of the chart.
    disable_sampling bool
    If false, samples a subset of the output MTS, which improves UI performance. false by default.
    group_bies Sequence[str]
    Properties to group by in the heatmap (in nesting order).
    hide_timestamp bool
    Whether to show the timestamp in the chart. false by default.
    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 chart.
    refresh_interval int
    How often (in seconds) to refresh the values of the heatmap.
    sort_by str
    The property to use when sorting the elements. Must be prepended with + for ascending or - for descending (e.g. -foo).
    timezone str
    The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
    unit_prefix str
    Must be "Metric" or "Binary". "Metric" by default.
    programText String
    Signalflow program text for the chart. More info at https://dev.splunk.com/observability/docs/signalflow/.
    colorRange Property Map
    Values and color for the color range. Example: color_range : { min : 0, max : 100, color : "#0000ff" }. Look at this link.
    colorScales List<Property Map>
    One to N blocks, each defining a single color range including both the color to display for that range and the borders of the range. Example: color_scale { gt = 60, color = "blue" } color_scale { lte = 60, color = "yellow" }. Look at this link.
    description String
    Description of the chart.
    disableSampling Boolean
    If false, samples a subset of the output MTS, which improves UI performance. false by default.
    groupBies List<String>
    Properties to group by in the heatmap (in nesting order).
    hideTimestamp Boolean
    Whether to show the timestamp in the chart. false by default.
    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 chart.
    refreshInterval Number
    How often (in seconds) to refresh the values of the heatmap.
    sortBy String
    The property to use when sorting the elements. Must be prepended with + for ascending or - for descending (e.g. -foo).
    timezone String
    The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
    unitPrefix String
    Must be "Metric" or "Binary". "Metric" by default.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the HeatmapChart 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 HeatmapChart Resource

    Get an existing HeatmapChart 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?: HeatmapChartState, opts?: CustomResourceOptions): HeatmapChart
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        color_range: Optional[HeatmapChartColorRangeArgs] = None,
        color_scales: Optional[Sequence[HeatmapChartColorScaleArgs]] = 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,
        sort_by: Optional[str] = None,
        timezone: Optional[str] = None,
        unit_prefix: Optional[str] = None,
        url: Optional[str] = None) -> HeatmapChart
    func GetHeatmapChart(ctx *Context, name string, id IDInput, state *HeatmapChartState, opts ...ResourceOption) (*HeatmapChart, error)
    public static HeatmapChart Get(string name, Input<string> id, HeatmapChartState? state, CustomResourceOptions? opts = null)
    public static HeatmapChart get(String name, Output<String> id, HeatmapChartState 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:
    ColorRange Pulumi.SignalFx.Inputs.HeatmapChartColorRange
    Values and color for the color range. Example: color_range : { min : 0, max : 100, color : "#0000ff" }. Look at this link.
    ColorScales List<Pulumi.SignalFx.Inputs.HeatmapChartColorScale>
    One to N blocks, each defining a single color range including both the color to display for that range and the borders of the range. Example: color_scale { gt = 60, color = "blue" } color_scale { lte = 60, color = "yellow" }. Look at this link.
    Description string
    Description of the chart.
    DisableSampling bool
    If false, samples a subset of the output MTS, which improves UI performance. false by default.
    GroupBies List<string>
    Properties to group by in the heatmap (in nesting order).
    HideTimestamp bool
    Whether to show the timestamp in the chart. false by default.
    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 chart.
    ProgramText string
    Signalflow program text for the chart. More info at https://dev.splunk.com/observability/docs/signalflow/.
    RefreshInterval int
    How often (in seconds) to refresh the values of the heatmap.
    SortBy string
    The property to use when sorting the elements. Must be prepended with + for ascending or - for descending (e.g. -foo).
    Timezone string
    The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
    UnitPrefix string
    Must be "Metric" or "Binary". "Metric" by default.
    Url string
    The URL of the chart.
    ColorRange HeatmapChartColorRangeArgs
    Values and color for the color range. Example: color_range : { min : 0, max : 100, color : "#0000ff" }. Look at this link.
    ColorScales []HeatmapChartColorScaleArgs
    One to N blocks, each defining a single color range including both the color to display for that range and the borders of the range. Example: color_scale { gt = 60, color = "blue" } color_scale { lte = 60, color = "yellow" }. Look at this link.
    Description string
    Description of the chart.
    DisableSampling bool
    If false, samples a subset of the output MTS, which improves UI performance. false by default.
    GroupBies []string
    Properties to group by in the heatmap (in nesting order).
    HideTimestamp bool
    Whether to show the timestamp in the chart. false by default.
    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 chart.
    ProgramText string
    Signalflow program text for the chart. More info at https://dev.splunk.com/observability/docs/signalflow/.
    RefreshInterval int
    How often (in seconds) to refresh the values of the heatmap.
    SortBy string
    The property to use when sorting the elements. Must be prepended with + for ascending or - for descending (e.g. -foo).
    Timezone string
    The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
    UnitPrefix string
    Must be "Metric" or "Binary". "Metric" by default.
    Url string
    The URL of the chart.
    colorRange HeatmapChartColorRange
    Values and color for the color range. Example: color_range : { min : 0, max : 100, color : "#0000ff" }. Look at this link.
    colorScales List<HeatmapChartColorScale>
    One to N blocks, each defining a single color range including both the color to display for that range and the borders of the range. Example: color_scale { gt = 60, color = "blue" } color_scale { lte = 60, color = "yellow" }. Look at this link.
    description String
    Description of the chart.
    disableSampling Boolean
    If false, samples a subset of the output MTS, which improves UI performance. false by default.
    groupBies List<String>
    Properties to group by in the heatmap (in nesting order).
    hideTimestamp Boolean
    Whether to show the timestamp in the chart. false by default.
    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 chart.
    programText String
    Signalflow program text for the chart. More info at https://dev.splunk.com/observability/docs/signalflow/.
    refreshInterval Integer
    How often (in seconds) to refresh the values of the heatmap.
    sortBy String
    The property to use when sorting the elements. Must be prepended with + for ascending or - for descending (e.g. -foo).
    timezone String
    The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
    unitPrefix String
    Must be "Metric" or "Binary". "Metric" by default.
    url String
    The URL of the chart.
    colorRange HeatmapChartColorRange
    Values and color for the color range. Example: color_range : { min : 0, max : 100, color : "#0000ff" }. Look at this link.
    colorScales HeatmapChartColorScale[]
    One to N blocks, each defining a single color range including both the color to display for that range and the borders of the range. Example: color_scale { gt = 60, color = "blue" } color_scale { lte = 60, color = "yellow" }. Look at this link.
    description string
    Description of the chart.
    disableSampling boolean
    If false, samples a subset of the output MTS, which improves UI performance. false by default.
    groupBies string[]
    Properties to group by in the heatmap (in nesting order).
    hideTimestamp boolean
    Whether to show the timestamp in the chart. false by default.
    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 chart.
    programText string
    Signalflow program text for the chart. More info at https://dev.splunk.com/observability/docs/signalflow/.
    refreshInterval number
    How often (in seconds) to refresh the values of the heatmap.
    sortBy string
    The property to use when sorting the elements. Must be prepended with + for ascending or - for descending (e.g. -foo).
    timezone string
    The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
    unitPrefix string
    Must be "Metric" or "Binary". "Metric" by default.
    url string
    The URL of the chart.
    color_range HeatmapChartColorRangeArgs
    Values and color for the color range. Example: color_range : { min : 0, max : 100, color : "#0000ff" }. Look at this link.
    color_scales Sequence[HeatmapChartColorScaleArgs]
    One to N blocks, each defining a single color range including both the color to display for that range and the borders of the range. Example: color_scale { gt = 60, color = "blue" } color_scale { lte = 60, color = "yellow" }. Look at this link.
    description str
    Description of the chart.
    disable_sampling bool
    If false, samples a subset of the output MTS, which improves UI performance. false by default.
    group_bies Sequence[str]
    Properties to group by in the heatmap (in nesting order).
    hide_timestamp bool
    Whether to show the timestamp in the chart. false by default.
    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 chart.
    program_text str
    Signalflow program text for the chart. More info at https://dev.splunk.com/observability/docs/signalflow/.
    refresh_interval int
    How often (in seconds) to refresh the values of the heatmap.
    sort_by str
    The property to use when sorting the elements. Must be prepended with + for ascending or - for descending (e.g. -foo).
    timezone str
    The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
    unit_prefix str
    Must be "Metric" or "Binary". "Metric" by default.
    url str
    The URL of the chart.
    colorRange Property Map
    Values and color for the color range. Example: color_range : { min : 0, max : 100, color : "#0000ff" }. Look at this link.
    colorScales List<Property Map>
    One to N blocks, each defining a single color range including both the color to display for that range and the borders of the range. Example: color_scale { gt = 60, color = "blue" } color_scale { lte = 60, color = "yellow" }. Look at this link.
    description String
    Description of the chart.
    disableSampling Boolean
    If false, samples a subset of the output MTS, which improves UI performance. false by default.
    groupBies List<String>
    Properties to group by in the heatmap (in nesting order).
    hideTimestamp Boolean
    Whether to show the timestamp in the chart. false by default.
    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 chart.
    programText String
    Signalflow program text for the chart. More info at https://dev.splunk.com/observability/docs/signalflow/.
    refreshInterval Number
    How often (in seconds) to refresh the values of the heatmap.
    sortBy String
    The property to use when sorting the elements. Must be prepended with + for ascending or - for descending (e.g. -foo).
    timezone String
    The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
    unitPrefix String
    Must be "Metric" or "Binary". "Metric" by default.
    url String
    The URL of the chart.

    Supporting Types

    HeatmapChartColorRange, HeatmapChartColorRangeArgs

    Color string
    The color range to use. The starting hex color value for data values in a heatmap chart. Specify the value as a 6-character hexadecimal value preceded by the '#' character, for example "#ea1849" (grass green).
    MaxValue double
    The maximum value within the coloring range.
    MinValue double
    The minimum value within the coloring range.
    Color string
    The color range to use. The starting hex color value for data values in a heatmap chart. Specify the value as a 6-character hexadecimal value preceded by the '#' character, for example "#ea1849" (grass green).
    MaxValue float64
    The maximum value within the coloring range.
    MinValue float64
    The minimum value within the coloring range.
    color String
    The color range to use. The starting hex color value for data values in a heatmap chart. Specify the value as a 6-character hexadecimal value preceded by the '#' character, for example "#ea1849" (grass green).
    maxValue Double
    The maximum value within the coloring range.
    minValue Double
    The minimum value within the coloring range.
    color string
    The color range to use. The starting hex color value for data values in a heatmap chart. Specify the value as a 6-character hexadecimal value preceded by the '#' character, for example "#ea1849" (grass green).
    maxValue number
    The maximum value within the coloring range.
    minValue number
    The minimum value within the coloring range.
    color str
    The color range to use. The starting hex color value for data values in a heatmap chart. Specify the value as a 6-character hexadecimal value preceded by the '#' character, for example "#ea1849" (grass green).
    max_value float
    The maximum value within the coloring range.
    min_value float
    The minimum value within the coloring range.
    color String
    The color range to use. The starting hex color value for data values in a heatmap chart. Specify the value as a 6-character hexadecimal value preceded by the '#' character, for example "#ea1849" (grass green).
    maxValue Number
    The maximum value within the coloring range.
    minValue Number
    The minimum value within the coloring range.

    HeatmapChartColorScale, HeatmapChartColorScaleArgs

    Color string
    The color range to use. Hex values are not supported here. Must be one of 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, or lime_green.
    Gt double
    Indicates the lower threshold non-inclusive value for this range.
    Gte double
    Indicates the lower threshold inclusive value for this range.
    Lt double
    Indicates the upper threshold non-inclusive value for this range.
    Lte double
    Indicates the upper threshold inclusive value for this range.
    Color string
    The color range to use. Hex values are not supported here. Must be one of 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, or lime_green.
    Gt float64
    Indicates the lower threshold non-inclusive value for this range.
    Gte float64
    Indicates the lower threshold inclusive value for this range.
    Lt float64
    Indicates the upper threshold non-inclusive value for this range.
    Lte float64
    Indicates the upper threshold inclusive value for this range.
    color String
    The color range to use. Hex values are not supported here. Must be one of 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, or lime_green.
    gt Double
    Indicates the lower threshold non-inclusive value for this range.
    gte Double
    Indicates the lower threshold inclusive value for this range.
    lt Double
    Indicates the upper threshold non-inclusive value for this range.
    lte Double
    Indicates the upper threshold inclusive value for this range.
    color string
    The color range to use. Hex values are not supported here. Must be one of 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, or lime_green.
    gt number
    Indicates the lower threshold non-inclusive value for this range.
    gte number
    Indicates the lower threshold inclusive value for this range.
    lt number
    Indicates the upper threshold non-inclusive value for this range.
    lte number
    Indicates the upper threshold inclusive value for this range.
    color str
    The color range to use. Hex values are not supported here. Must be one of 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, or lime_green.
    gt float
    Indicates the lower threshold non-inclusive value for this range.
    gte float
    Indicates the lower threshold inclusive value for this range.
    lt float
    Indicates the upper threshold non-inclusive value for this range.
    lte float
    Indicates the upper threshold inclusive value for this range.
    color String
    The color range to use. Hex values are not supported here. Must be one of 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, or lime_green.
    gt Number
    Indicates the lower threshold non-inclusive value for this range.
    gte Number
    Indicates the lower threshold inclusive value for this range.
    lt Number
    Indicates the upper threshold non-inclusive value for this range.
    lte Number
    Indicates the upper threshold inclusive value for this range.

    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.4.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-signalfx