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

signalfx.TextChart

Explore with Pulumi AI

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

    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", {
        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 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
    
    """)
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using SignalFx = Pulumi.SignalFx;
    
    return await Deployment.RunAsync(() => 
    {
        var mynote0 = new SignalFx.TextChart("mynote0", new()
        {
            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 (
    	"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{
    			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
    	})
    }
    
    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()        
                .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());
    
        }
    }
    
    resources:
      mynote0:
        type: signalfx:TextChart
        properties:
          description: Lorem ipsum dolor sit amet, laudem tibique iracundia at mea. Nam posse dolores ex, nec cu adhuc putent honestatis
          markdown: |2+
                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
    

    Arguments

    The following arguments are supported in the resource block:

    • name - (Required) Name of the text note.
    • markdown - (Required) Markdown text to display.
    • description - (Optional) Description of the text note.

    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 TextChart Resource

    new TextChart(name: string, args: TextChartArgs, opts?: CustomResourceOptions);
    @overload
    def TextChart(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  description: Optional[str] = None,
                  markdown: Optional[str] = None,
                  name: Optional[str] = None)
    @overload
    def TextChart(resource_name: str,
                  args: TextChartArgs,
                  opts: Optional[ResourceOptions] = 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.
    
    
    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.
    args 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 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.
    name String
    The unique name of the resource.
    args TextChartArgs
    The arguments to resource properties.
    options 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 Architecture and Concepts docs.

    Inputs

    The TextChart resource accepts the following input properties:

    Markdown string
    Markdown text to display. More info at: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
    Description string
    Description of the chart (Optional)
    Name string
    Name of the chart
    Markdown string
    Markdown text to display. More info at: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
    Description string
    Description of the chart (Optional)
    Name string
    Name of the chart
    markdown String
    Markdown text to display. More info at: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
    description String
    Description of the chart (Optional)
    name String
    Name of the chart
    markdown string
    Markdown text to display. More info at: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
    description string
    Description of the chart (Optional)
    name string
    Name of the chart
    markdown str
    Markdown text to display. More info at: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
    description str
    Description of the chart (Optional)
    name str
    Name of the chart
    markdown String
    Markdown text to display. More info at: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
    description String
    Description of the chart (Optional)
    name String
    Name of the chart

    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
    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 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)
    public static TextChart get(String name, Output<String> id, TextChartState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    Description of the chart (Optional)
    Markdown string
    Markdown text to display. More info at: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
    Name string
    Name of the chart
    Url string
    URL of the chart
    Description string
    Description of the chart (Optional)
    Markdown string
    Markdown text to display. More info at: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
    Name string
    Name of the chart
    Url string
    URL of the chart
    description String
    Description of the chart (Optional)
    markdown String
    Markdown text to display. More info at: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
    name String
    Name of the chart
    url String
    URL of the chart
    description string
    Description of the chart (Optional)
    markdown string
    Markdown text to display. More info at: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
    name string
    Name of the chart
    url string
    URL of the chart
    description str
    Description of the chart (Optional)
    markdown str
    Markdown text to display. More info at: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
    name str
    Name of the chart
    url str
    URL of the chart
    description String
    Description of the chart (Optional)
    markdown String
    Markdown text to display. More info at: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
    name String
    Name of the chart
    url String
    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 logo
    SignalFx v7.1.1 published on Tuesday, Feb 27, 2024 by Pulumi