Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

TextChart

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

Example Usage

using Pulumi;
using SignalFx = Pulumi.SignalFx;

class MyStack : Stack
{
    public MyStack()
    {
        var mynote0 = new SignalFx.TextChart("mynote0", new SignalFx.TextChartArgs
        {
            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

",
        });
    }

}
package main

import (
    "fmt"

    "github.com/pulumi/pulumi-signalfx/sdk/v4/go/signalfx"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := signalfx.NewTextChart(ctx, "mynote0", &signalfx.TextChartArgs{
            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(fmt.Sprintf("%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v", "    1. First ordered list item\n", "    2. Another item\n", "      * Unordered sub-list.\n", "    1. Actual numbers don't matter, just that it's a number\n", "      1. Ordered sub-list\n", "    4. And another item.\n", "\n", "       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).\n", "\n", "       To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅\n", "       Note that this line is separate, but within the same paragraph.⋅⋅\n", "       (This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)\n", "\n", "    * Unordered list can use asterisks\n", "    - Or minuses\n", "    + Or pluses\n", "\n")),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_signalfx as signalfx

mynote0 = signalfx.TextChart("mynote0",
    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

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

const mynote0 = new signalfx.TextChart("mynote0", {
    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
`,
});

Create a TextChart Resource

new TextChart(name: string, args: TextChartArgs, opts?: CustomResourceOptions);
def TextChart(resource_name: str, opts: Optional[ResourceOptions] = None, description: Optional[str] = None, markdown: Optional[str] = None, name: Optional[str] = None)
func NewTextChart(ctx *Context, name string, args TextChartArgs, opts ...ResourceOption) (*TextChart, error)
public TextChart(string name, TextChartArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args TextChartArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args TextChartArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args TextChartArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

TextChart Resource Properties

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

Inputs

The TextChart resource accepts the following input properties:

Markdown string

Markdown text to display.

Description string

Description of the text note.

Name string

Name of the text note.

Markdown string

Markdown text to display.

Description string

Description of the text note.

Name string

Name of the text note.

markdown string

Markdown text to display.

description string

Description of the text note.

name string

Name of the text note.

markdown str

Markdown text to display.

description str

Description of the text note.

name str

Name of the text note.

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 str
The provider-assigned unique ID for this managed resource.
url str

The URL of the chart.

Look up an 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, 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)
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.

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.

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.

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.

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.

url str

The URL of the chart.

Package Details

Repository
https://github.com/pulumi/pulumi-signalfx
License
Apache-2.0
Notes
This Pulumi package is based on the signalfx Terraform Provider.