Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Signalfx Provider
  3. API Docs
  4. TextChart
SignalFx v7.9.0 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-signalfx

signalfx.TextChart

Explore with Pulumi AI

SignalFx v7.9.0 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-signalfx

This special type of chart doesn’t display any metric data. Rather, it lets you place a text note on the dashboard.

Example

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

const mynote0 = new signalfx.TextChart("mynote0", {
    name: "Important Dashboard Note",
    description: "Lorem ipsum dolor sit amet, laudem tibique iracundia at mea. Nam posse dolores ex, nec cu adhuc putent honestatis",
    markdown: `1. First ordered list item
2. Another item
  * Unordered sub-list.
1. Actual numbers don't matter, just that it's a number
  1. Ordered sub-list
4. And another item.

   You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).

   To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅
   Note that this line is separate, but within the same paragraph.⋅⋅
   (This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)

* Unordered list can use asterisks
- Or minuses
+ Or pluses
`,
});
Copy
import pulumi
import pulumi_signalfx as signalfx

mynote0 = signalfx.TextChart("mynote0",
    name="Important Dashboard Note",
    description="Lorem ipsum dolor sit amet, laudem tibique iracundia at mea. Nam posse dolores ex, nec cu adhuc putent honestatis",
    markdown="""1. First ordered list item
2. Another item
  * Unordered sub-list.
1. Actual numbers don't matter, just that it's a number
  1. Ordered sub-list
4. And another item.

   You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).

   To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅
   Note that this line is separate, but within the same paragraph.⋅⋅
   (This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)

* Unordered list can use asterisks
- Or minuses
+ Or pluses
""")
Copy
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.NewTextChart(ctx, "mynote0", &signalfx.TextChartArgs{
			Name:        pulumi.String("Important Dashboard Note"),
			Description: pulumi.String("Lorem ipsum dolor sit amet, laudem tibique iracundia at mea. Nam posse dolores ex, nec cu adhuc putent honestatis"),
			Markdown: pulumi.String(`1. First ordered list item
2. Another item
  * Unordered sub-list.
1. Actual numbers don't matter, just that it's a number
  1. Ordered sub-list
4. And another item.

   You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).

   To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅
   Note that this line is separate, but within the same paragraph.⋅⋅
   (This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)

* Unordered list can use asterisks
- Or minuses
+ Or pluses
`),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using SignalFx = Pulumi.SignalFx;

return await Deployment.RunAsync(() => 
{
    var mynote0 = new SignalFx.TextChart("mynote0", new()
    {
        Name = "Important Dashboard Note",
        Description = "Lorem ipsum dolor sit amet, laudem tibique iracundia at mea. Nam posse dolores ex, nec cu adhuc putent honestatis",
        Markdown = @"1. First ordered list item
2. Another item
  * Unordered sub-list.
1. Actual numbers don't matter, just that it's a number
  1. Ordered sub-list
4. And another item.

   You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).

   To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅
   Note that this line is separate, but within the same paragraph.⋅⋅
   (This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)

* Unordered list can use asterisks
- Or minuses
+ Or pluses
",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.signalfx.TextChart;
import com.pulumi.signalfx.TextChartArgs;
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 mynote0 = new TextChart("mynote0", TextChartArgs.builder()
            .name("Important Dashboard Note")
            .description("Lorem ipsum dolor sit amet, laudem tibique iracundia at mea. Nam posse dolores ex, nec cu adhuc putent honestatis")
            .markdown("""
1. First ordered list item
2. Another item
  * Unordered sub-list.
1. Actual numbers don't matter, just that it's a number
  1. Ordered sub-list
4. And another item.

   You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).

   To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅
   Note that this line is separate, but within the same paragraph.⋅⋅
   (This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)

* Unordered list can use asterisks
- Or minuses
+ Or pluses
            """)
            .build());

    }
}
Copy
resources:
  mynote0:
    type: signalfx:TextChart
    properties:
      name: Important Dashboard Note
      description: Lorem ipsum dolor sit amet, laudem tibique iracundia at mea. Nam posse dolores ex, nec cu adhuc putent honestatis
      markdown: |
        1. First ordered list item
        2. Another item
          * Unordered sub-list.
        1. Actual numbers don't matter, just that it's a number
          1. Ordered sub-list
        4. And another item.

           You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).

           To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅
           Note that this line is separate, but within the same paragraph.⋅⋅
           (This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)

        * Unordered list can use asterisks
        - Or minuses
        + Or pluses
Copy

Create TextChart Resource

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

Constructor syntax

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

@overload
def TextChart(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              markdown: Optional[str] = None,
              description: Optional[str] = None,
              name: Optional[str] = None,
              tags: Optional[Sequence[str]] = None)
func NewTextChart(ctx *Context, name string, args TextChartArgs, opts ...ResourceOption) (*TextChart, error)
public TextChart(string name, TextChartArgs args, CustomResourceOptions? opts = null)
public TextChart(String name, TextChartArgs args)
public TextChart(String name, TextChartArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. TextChartArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. TextChartArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. TextChartArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TextChartArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. TextChartArgs
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 textChartResource = new SignalFx.TextChart("textChartResource", new()
{
    Markdown = "string",
    Description = "string",
    Name = "string",
    Tags = new[]
    {
        "string",
    },
});
Copy
example, err := signalfx.NewTextChart(ctx, "textChartResource", &signalfx.TextChartArgs{
	Markdown:    pulumi.String("string"),
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var textChartResource = new TextChart("textChartResource", TextChartArgs.builder()
    .markdown("string")
    .description("string")
    .name("string")
    .tags("string")
    .build());
Copy
text_chart_resource = signalfx.TextChart("textChartResource",
    markdown="string",
    description="string",
    name="string",
    tags=["string"])
Copy
const textChartResource = new signalfx.TextChart("textChartResource", {
    markdown: "string",
    description: "string",
    name: "string",
    tags: ["string"],
});
Copy
type: signalfx:TextChart
properties:
    description: string
    markdown: string
    name: string
    tags:
        - string
Copy

TextChart 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 TextChart resource accepts the following input properties:

Markdown This property is required. string
Markdown text to display.
Description string
Description of the text note.
Name string
Name of the text note.
Tags List<string>
Tags associated with the resource
Markdown This property is required. string
Markdown text to display.
Description string
Description of the text note.
Name string
Name of the text note.
Tags []string
Tags associated with the resource
markdown This property is required. String
Markdown text to display.
description String
Description of the text note.
name String
Name of the text note.
tags List<String>
Tags associated with the resource
markdown This property is required. string
Markdown text to display.
description string
Description of the text note.
name string
Name of the text note.
tags string[]
Tags associated with the resource
markdown This property is required. str
Markdown text to display.
description str
Description of the text note.
name str
Name of the text note.
tags Sequence[str]
Tags associated with the resource
markdown This property is required. String
Markdown text to display.
description String
Description of the text note.
name String
Name of the text note.
tags List<String>
Tags associated with the resource

Outputs

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

Get an existing TextChart 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?: TextChartState, opts?: CustomResourceOptions): TextChart
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        markdown: Optional[str] = None,
        name: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        url: Optional[str] = None) -> TextChart
func GetTextChart(ctx *Context, name string, id IDInput, state *TextChartState, opts ...ResourceOption) (*TextChart, error)
public static TextChart Get(string name, Input<string> id, TextChartState? state, CustomResourceOptions? opts = null)
public static TextChart get(String name, Output<String> id, TextChartState state, CustomResourceOptions options)
resources:  _:    type: signalfx:TextChart    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Description string
Description of the text note.
Markdown string
Markdown text to display.
Name string
Name of the text note.
Tags List<string>
Tags associated with the resource
Url string
The URL of the chart.
Description string
Description of the text note.
Markdown string
Markdown text to display.
Name string
Name of the text note.
Tags []string
Tags associated with the resource
Url string
The URL of the chart.
description String
Description of the text note.
markdown String
Markdown text to display.
name String
Name of the text note.
tags List<String>
Tags associated with the resource
url String
The URL of the chart.
description string
Description of the text note.
markdown string
Markdown text to display.
name string
Name of the text note.
tags string[]
Tags associated with the resource
url string
The URL of the chart.
description str
Description of the text note.
markdown str
Markdown text to display.
name str
Name of the text note.
tags Sequence[str]
Tags associated with the resource
url str
The URL of the chart.
description String
Description of the text note.
markdown String
Markdown text to display.
name String
Name of the text note.
tags List<String>
Tags associated with the resource
url String
The URL of the chart.

Package Details

Repository
SignalFx pulumi/pulumi-signalfx
License
Apache-2.0
Notes
This Pulumi package is based on the signalfx Terraform Provider.
SignalFx v7.9.0 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-signalfx