1. Packages
  2. SignalFx
  3. API Docs
  4. HeatmapChart
SignalFx v7.1.1 published on Tuesday, Feb 27, 2024 by Pulumi

signalfx.HeatmapChart

Explore with Pulumi AI

signalfx logo
SignalFx v7.1.1 published on Tuesday, Feb 27, 2024 by Pulumi

    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", {
        colorRange: {
            color: "#ff0000",
            maxValue: 100,
            minValue: 0,
        },
        colorScales: [
            {
                color: "green",
                gte: 99,
            },
            {
                color: "yellow",
                gte: 95,
                lt: 99,
            },
            {
                color: "red",
                lt: 95,
            },
        ],
        description: "Very cool Heatmap",
        disableSampling: true,
        groupBies: [
            "hostname",
            "host",
        ],
        hideTimestamp: true,
        programText: `myfilters = filter("cluster_name", "prod") and filter("role", "search")
    data("cpu.total.idle", filter=myfilters).publish()
    
    `,
        sortBy: "+host",
        timezone: "Europe/Paris",
    });
    
    import pulumi
    import pulumi_signalfx as signalfx
    
    myheatmapchart0 = signalfx.HeatmapChart("myheatmapchart0",
        color_range=signalfx.HeatmapChartColorRangeArgs(
            color="#ff0000",
            max_value=100,
            min_value=0,
        ),
        color_scales=[
            signalfx.HeatmapChartColorScaleArgs(
                color="green",
                gte=99,
            ),
            signalfx.HeatmapChartColorScaleArgs(
                color="yellow",
                gte=95,
                lt=99,
            ),
            signalfx.HeatmapChartColorScaleArgs(
                color="red",
                lt=95,
            ),
        ],
        description="Very cool Heatmap",
        disable_sampling=True,
        group_bies=[
            "hostname",
            "host",
        ],
        hide_timestamp=True,
        program_text="""myfilters = filter("cluster_name", "prod") and filter("role", "search")
    data("cpu.total.idle", filter=myfilters).publish()
    
    """,
        sort_by="+host",
        timezone="Europe/Paris")
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using SignalFx = Pulumi.SignalFx;
    
    return await Deployment.RunAsync(() => 
    {
        var myheatmapchart0 = new SignalFx.HeatmapChart("myheatmapchart0", new()
        {
            ColorRange = new SignalFx.Inputs.HeatmapChartColorRangeArgs
            {
                Color = "#ff0000",
                MaxValue = 100,
                MinValue = 0,
            },
            ColorScales = new[]
            {
                new SignalFx.Inputs.HeatmapChartColorScaleArgs
                {
                    Color = "green",
                    Gte = 99,
                },
                new SignalFx.Inputs.HeatmapChartColorScaleArgs
                {
                    Color = "yellow",
                    Gte = 95,
                    Lt = 99,
                },
                new SignalFx.Inputs.HeatmapChartColorScaleArgs
                {
                    Color = "red",
                    Lt = 95,
                },
            },
            Description = "Very cool Heatmap",
            DisableSampling = true,
            GroupBies = new[]
            {
                "hostname",
                "host",
            },
            HideTimestamp = true,
            ProgramText = @"myfilters = filter(""cluster_name"", ""prod"") and filter(""role"", ""search"")
    data(""cpu.total.idle"", filter=myfilters).publish()
    
    ",
            SortBy = "+host",
            Timezone = "Europe/Paris",
        });
    
    });
    
    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{
    			ColorRange: &signalfx.HeatmapChartColorRangeArgs{
    				Color:    pulumi.String("#ff0000"),
    				MaxValue: pulumi.Float64(100),
    				MinValue: pulumi.Float64(0),
    			},
    			ColorScales: signalfx.HeatmapChartColorScaleArray{
    				&signalfx.HeatmapChartColorScaleArgs{
    					Color: pulumi.String("green"),
    					Gte:   pulumi.Float64(99),
    				},
    				&signalfx.HeatmapChartColorScaleArgs{
    					Color: pulumi.String("yellow"),
    					Gte:   pulumi.Float64(95),
    					Lt:    pulumi.Float64(99),
    				},
    				&signalfx.HeatmapChartColorScaleArgs{
    					Color: pulumi.String("red"),
    					Lt:    pulumi.Float64(95),
    				},
    			},
    			Description:     pulumi.String("Very cool Heatmap"),
    			DisableSampling: pulumi.Bool(true),
    			GroupBies: pulumi.StringArray{
    				pulumi.String("hostname"),
    				pulumi.String("host"),
    			},
    			HideTimestamp: pulumi.Bool(true),
    			ProgramText:   pulumi.String("myfilters = filter(\"cluster_name\", \"prod\") and filter(\"role\", \"search\")\ndata(\"cpu.total.idle\", filter=myfilters).publish()\n\n"),
    			SortBy:        pulumi.String("+host"),
    			Timezone:      pulumi.String("Europe/Paris"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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()        
                .colorRange(HeatmapChartColorRangeArgs.builder()
                    .color("#ff0000")
                    .maxValue(100)
                    .minValue(0)
                    .build())
                .colorScales(            
                    HeatmapChartColorScaleArgs.builder()
                        .color("green")
                        .gte(99)
                        .build(),
                    HeatmapChartColorScaleArgs.builder()
                        .color("yellow")
                        .gte(95)
                        .lt(99)
                        .build(),
                    HeatmapChartColorScaleArgs.builder()
                        .color("red")
                        .lt(95)
                        .build())
                .description("Very cool Heatmap")
                .disableSampling(true)
                .groupBies(            
                    "hostname",
                    "host")
                .hideTimestamp(true)
                .programText("""
    myfilters = filter("cluster_name", "prod") and filter("role", "search")
    data("cpu.total.idle", filter=myfilters).publish()
    
                """)
                .sortBy("+host")
                .timezone("Europe/Paris")
                .build());
    
        }
    }
    
    resources:
      myheatmapchart0:
        type: signalfx:HeatmapChart
        properties:
          colorRange:
            color: '#ff0000'
            maxValue: 100
            minValue: 0
          colorScales:
            - color: green
              gte: 99
            - color: yellow
              gte: 95
              lt: 99
            - color: red
              lt: 95
          description: Very cool Heatmap
          disableSampling: true
          groupBies:
            - hostname
            - host
          hideTimestamp: true
          programText: |+
            myfilters = filter("cluster_name", "prod") and filter("role", "search")
            data("cpu.total.idle", filter=myfilters).publish()        
    
          sortBy: +host
          timezone: Europe/Paris
    

    Arguments

    The following arguments are supported in the resource block:

    • name - (Required) Name of the chart.
    • program_text - (Required) Signalflow program text for the chart. More info at https://dev.splunk.com/observability/docs/signalflow/.
    • description - (Optional) Description of the chart.
    • unit_prefix - (Optional) Must be "Metric" or "Binary". "Metric" by default.
    • minimum_resolution - (Optional) The minimum resolution (in seconds) to use for computing the underlying program.
    • max_delay - (Optional) How long (in seconds) to wait for late datapoints.
    • timezone - (Optional) The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
    • refresh_interval - (Optional) How often (in seconds) to refresh the values of the heatmap.
    • disable_sampling - (Optional) If false, samples a subset of the output MTS, which improves UI performance. false by default.
    • group_by - (Optional) Properties to group by in the heatmap (in nesting order).
    • sort_by - (Optional) The property to use when sorting the elements. Must be prepended with + for ascending or - for descending (e.g. -foo).
    • hide_timestamp - (Optional) Whether to show the timestamp in the chart. false by default.
    • color_range - (Optional, Default) Values and color for the color range. Example: color_range : { min : 0, max : 100, color : "#0000ff" }. Look at this link.
      • min_value - (Optional) The minimum value within the coloring range.
      • max_value - (Optional) The maximum value within the coloring range.
      • color - (Required) 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).
    • color_scale - (Optional. Conflicts with color_range) 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.
      • gt - (Optional) Indicates the lower threshold non-inclusive value for this range.
      • gte - (Optional) Indicates the lower threshold inclusive value for this range.
      • lt - (Optional) Indicates the upper threshold non-inclusive value for this range.
      • lte - (Optional) Indicates the upper threshold inclusive value for this range.
      • color - (Required) 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.

    Attributes

    In a addition to all arguments above, the following attributes are exported:

    • id - The ID of the chart.
    • url - The URL of the chart.

    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.

    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=signalfx.HeatmapChartColorRangeArgs(
            color="string",
            max_value=0,
            min_value=0,
        ),
        group_bies=["string"],
        hide_timestamp=False,
        max_delay=0,
        minimum_resolution=0,
        name="string",
        color_scales=[signalfx.HeatmapChartColorScaleArgs(
            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

    The HeatmapChart resource accepts the following input properties:

    ProgramText string
    Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
    ColorRange Pulumi.SignalFx.Inputs.HeatmapChartColorRange
    Values and color for the color range. Example: colorRange : { min : 0, max : 100, color : "#0000ff" }
    ColorScales List<Pulumi.SignalFx.Inputs.HeatmapChartColorScale>
    Single color range including both the color to display for that range and the borders of the range
    Description string
    Description of the chart (Optional)
    DisableSampling bool
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    GroupBies List<string>
    Properties to group by in the heatmap (in nesting order)
    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 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, (e.g. Australia/Sydney)
    UnitPrefix string
    (Metric by default) Must be "Metric" or "Binary"
    ProgramText string
    Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
    ColorRange HeatmapChartColorRangeArgs
    Values and color for the color range. Example: colorRange : { min : 0, max : 100, color : "#0000ff" }
    ColorScales []HeatmapChartColorScaleArgs
    Single color range including both the color to display for that range and the borders of the range
    Description string
    Description of the chart (Optional)
    DisableSampling bool
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    GroupBies []string
    Properties to group by in the heatmap (in nesting order)
    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 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, (e.g. Australia/Sydney)
    UnitPrefix string
    (Metric by default) Must be "Metric" or "Binary"
    programText String
    Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
    colorRange HeatmapChartColorRange
    Values and color for the color range. Example: colorRange : { min : 0, max : 100, color : "#0000ff" }
    colorScales List<HeatmapChartColorScale>
    Single color range including both the color to display for that range and the borders of the range
    description String
    Description of the chart (Optional)
    disableSampling Boolean
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    groupBies List<String>
    Properties to group by in the heatmap (in nesting order)
    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 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, (e.g. Australia/Sydney)
    unitPrefix String
    (Metric by default) Must be "Metric" or "Binary"
    programText string
    Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
    colorRange HeatmapChartColorRange
    Values and color for the color range. Example: colorRange : { min : 0, max : 100, color : "#0000ff" }
    colorScales HeatmapChartColorScale[]
    Single color range including both the color to display for that range and the borders of the range
    description string
    Description of the chart (Optional)
    disableSampling boolean
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    groupBies string[]
    Properties to group by in the heatmap (in nesting order)
    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 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, (e.g. Australia/Sydney)
    unitPrefix string
    (Metric by default) Must be "Metric" or "Binary"
    program_text str
    Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
    color_range HeatmapChartColorRangeArgs
    Values and color for the color range. Example: colorRange : { min : 0, max : 100, color : "#0000ff" }
    color_scales Sequence[HeatmapChartColorScaleArgs]
    Single color range including both the color to display for that range and the borders of the range
    description str
    Description of the chart (Optional)
    disable_sampling bool
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    group_bies Sequence[str]
    Properties to group by in the heatmap (in nesting order)
    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 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, (e.g. Australia/Sydney)
    unit_prefix str
    (Metric by default) Must be "Metric" or "Binary"
    programText String
    Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
    colorRange Property Map
    Values and color for the color range. Example: colorRange : { min : 0, max : 100, color : "#0000ff" }
    colorScales List<Property Map>
    Single color range including both the color to display for that range and the borders of the range
    description String
    Description of the chart (Optional)
    disableSampling Boolean
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    groupBies List<String>
    Properties to group by in the heatmap (in nesting order)
    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 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, (e.g. Australia/Sydney)
    unitPrefix String
    (Metric by default) Must be "Metric" or "Binary"

    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
    URL of the chart
    Id string
    The provider-assigned unique ID for this managed resource.
    Url string
    URL of the chart
    id String
    The provider-assigned unique ID for this managed resource.
    url String
    URL of the chart
    id string
    The provider-assigned unique ID for this managed resource.
    url string
    URL of the chart
    id str
    The provider-assigned unique ID for this managed resource.
    url str
    URL of the chart
    id String
    The provider-assigned unique ID for this managed resource.
    url String
    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: colorRange : { min : 0, max : 100, color : "#0000ff" }
    ColorScales List<Pulumi.SignalFx.Inputs.HeatmapChartColorScale>
    Single color range including both the color to display for that range and the borders of the range
    Description string
    Description of the chart (Optional)
    DisableSampling bool
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    GroupBies List<string>
    Properties to group by in the heatmap (in nesting order)
    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 chart
    ProgramText string
    Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
    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, (e.g. Australia/Sydney)
    UnitPrefix string
    (Metric by default) Must be "Metric" or "Binary"
    Url string
    URL of the chart
    ColorRange HeatmapChartColorRangeArgs
    Values and color for the color range. Example: colorRange : { min : 0, max : 100, color : "#0000ff" }
    ColorScales []HeatmapChartColorScaleArgs
    Single color range including both the color to display for that range and the borders of the range
    Description string
    Description of the chart (Optional)
    DisableSampling bool
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    GroupBies []string
    Properties to group by in the heatmap (in nesting order)
    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 chart
    ProgramText string
    Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
    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, (e.g. Australia/Sydney)
    UnitPrefix string
    (Metric by default) Must be "Metric" or "Binary"
    Url string
    URL of the chart
    colorRange HeatmapChartColorRange
    Values and color for the color range. Example: colorRange : { min : 0, max : 100, color : "#0000ff" }
    colorScales List<HeatmapChartColorScale>
    Single color range including both the color to display for that range and the borders of the range
    description String
    Description of the chart (Optional)
    disableSampling Boolean
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    groupBies List<String>
    Properties to group by in the heatmap (in nesting order)
    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 chart
    programText String
    Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
    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, (e.g. Australia/Sydney)
    unitPrefix String
    (Metric by default) Must be "Metric" or "Binary"
    url String
    URL of the chart
    colorRange HeatmapChartColorRange
    Values and color for the color range. Example: colorRange : { min : 0, max : 100, color : "#0000ff" }
    colorScales HeatmapChartColorScale[]
    Single color range including both the color to display for that range and the borders of the range
    description string
    Description of the chart (Optional)
    disableSampling boolean
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    groupBies string[]
    Properties to group by in the heatmap (in nesting order)
    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 chart
    programText string
    Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
    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, (e.g. Australia/Sydney)
    unitPrefix string
    (Metric by default) Must be "Metric" or "Binary"
    url string
    URL of the chart
    color_range HeatmapChartColorRangeArgs
    Values and color for the color range. Example: colorRange : { min : 0, max : 100, color : "#0000ff" }
    color_scales Sequence[HeatmapChartColorScaleArgs]
    Single color range including both the color to display for that range and the borders of the range
    description str
    Description of the chart (Optional)
    disable_sampling bool
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    group_bies Sequence[str]
    Properties to group by in the heatmap (in nesting order)
    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 chart
    program_text str
    Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
    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, (e.g. Australia/Sydney)
    unit_prefix str
    (Metric by default) Must be "Metric" or "Binary"
    url str
    URL of the chart
    colorRange Property Map
    Values and color for the color range. Example: colorRange : { min : 0, max : 100, color : "#0000ff" }
    colorScales List<Property Map>
    Single color range including both the color to display for that range and the borders of the range
    description String
    Description of the chart (Optional)
    disableSampling Boolean
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    groupBies List<String>
    Properties to group by in the heatmap (in nesting order)
    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 chart
    programText String
    Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
    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, (e.g. Australia/Sydney)
    unitPrefix String
    (Metric by default) Must be "Metric" or "Binary"
    url String
    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 to use. 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-inculsive value for this range
    Lte double
    Indicates the upper threshold inclusive value for this range
    Color string
    The color to use. 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-inculsive value for this range
    Lte float64
    Indicates the upper threshold inclusive value for this range
    color String
    The color to use. 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-inculsive value for this range
    lte Double
    Indicates the upper threshold inclusive value for this range
    color string
    The color to use. 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-inculsive value for this range
    lte number
    Indicates the upper threshold inclusive value for this range
    color str
    The color to use. 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-inculsive value for this range
    lte float
    Indicates the upper threshold inclusive value for this range
    color String
    The color to use. 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-inculsive 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.1.1 published on Tuesday, Feb 27, 2024 by Pulumi