1. Packages
  2. Wavefront
  3. API Docs
  4. Dashboard
Wavefront v1.4.0 published on Friday, May 19, 2023 by Pulumi

wavefront.Dashboard

Explore with Pulumi AI

wavefront logo
Wavefront v1.4.0 published on Friday, May 19, 2023 by Pulumi

    Provides a Wavefront Dashboard resource. This allows dashboards to be created, updated, and deleted.

    Example Usage

    Coming soon!

    Coming soon!

    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.wavefront.User;
    import com.pulumi.wavefront.UserArgs;
    import com.pulumi.wavefront.Dashboard;
    import com.pulumi.wavefront.DashboardArgs;
    import com.pulumi.wavefront.inputs.DashboardSectionArgs;
    import com.pulumi.wavefront.inputs.DashboardParameterDetailArgs;
    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 basic = new User("basic", UserArgs.builder()        
                .email("test+tftesting@example.com")
                .groups(            
                    "agent_management",
                    "alerts_management")
                .build());
    
            var testDashboard = new Dashboard("testDashboard", DashboardArgs.builder()        
                .description("testing, testing")
                .url("tftestcreate")
                .displaySectionTableOfContents(true)
                .displayQueryParameters(true)
                .canViews(basic.id())
                .sections(DashboardSectionArgs.builder()
                    .name("section 1")
                    .rows(DashboardSectionRowArgs.builder()
                        .charts(DashboardSectionRowChartArgs.builder()
                            .name("chart 1")
                            .description("chart number 1")
                            .units("something per unit")
                            .sources(DashboardSectionRowChartSourceArgs.builder()
                                .name("source name")
                                .query("ts()")
                                .build())
                            .chartSetting(DashboardSectionRowChartChartSettingArgs.builder()
                                .type("linear")
                                .build())
                            .summarization("MEAN")
                            .build())
                        .build())
                    .build())
                .parameterDetails(DashboardParameterDetailArgs.builder()
                    .name("param1")
                    .label("param1")
                    .defaultValue("Label")
                    .hideFromView(false)
                    .parameterType("SIMPLE")
                    .valuesToReadableStrings(Map.of("Label", "test"))
                    .build())
                .tags(            
                    "b",
                    "terraform",
                    "a",
                    "test")
                .build());
    
        }
    }
    

    Coming soon!

    Coming soon!

    resources:
      basic:
        type: wavefront:User
        properties:
          email: test+tftesting@example.com
          groups:
            - agent_management
            - alerts_management
      testDashboard:
        type: wavefront:Dashboard
        properties:
          description: testing, testing
          url: tftestcreate
          displaySectionTableOfContents: true
          displayQueryParameters: true
          canViews:
            - ${basic.id}
          sections:
            - name: section 1
              rows:
                - charts:
                    - name: chart 1
                      description: chart number 1
                      units: something per unit
                      sources:
                        - name: source name
                          query: ts()
                      chartSetting:
                        type: linear
                      summarization: MEAN
          parameterDetails:
            - name: param1
              label: param1
              defaultValue: Label
              hideFromView: false
              parameterType: SIMPLE
              valuesToReadableStrings:
                Label: test
          tags:
            - b
            - terraform
            - a
            - test
    

    Create Dashboard Resource

    new Dashboard(name: string, args: DashboardArgs, opts?: CustomResourceOptions);
    @overload
    def Dashboard(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  can_modifies: Optional[Sequence[str]] = None,
                  can_views: Optional[Sequence[str]] = None,
                  description: Optional[str] = None,
                  display_query_parameters: Optional[bool] = None,
                  display_section_table_of_contents: Optional[bool] = None,
                  event_filter_type: Optional[str] = None,
                  name: Optional[str] = None,
                  parameter_details: Optional[Sequence[DashboardParameterDetailArgs]] = None,
                  sections: Optional[Sequence[DashboardSectionArgs]] = None,
                  tags: Optional[Sequence[str]] = None,
                  url: Optional[str] = None)
    @overload
    def Dashboard(resource_name: str,
                  args: DashboardArgs,
                  opts: Optional[ResourceOptions] = None)
    func NewDashboard(ctx *Context, name string, args DashboardArgs, opts ...ResourceOption) (*Dashboard, error)
    public Dashboard(string name, DashboardArgs args, CustomResourceOptions? opts = null)
    public Dashboard(String name, DashboardArgs args)
    public Dashboard(String name, DashboardArgs args, CustomResourceOptions options)
    
    type: wavefront:Dashboard
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args DashboardArgs
    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 DashboardArgs
    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 DashboardArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DashboardArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DashboardArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    Description string

    Human-readable description of the dashboard.

    Sections List<DashboardSectionArgs>

    Dashboard chart sections. See dashboard sections.

    Tags List<string>

    A set of tags to assign to this resource.

    Url string

    Unique identifier, also a URL slug of the dashboard.

    CanModifies List<string>

    A list of users that have modify ACL access to the dashboard.

    CanViews List<string>

    A list of users that have view ACL access to the dashboard.

    DisplayQueryParameters bool

    Whether the dashboard parameters section is opened by default when the dashboard is shown.

    DisplaySectionTableOfContents bool

    Whether the "pills" quick-linked the sections of the dashboard are displayed by default when the dashboard is shown.

    EventFilterType string

    How charts belonging to this dashboard should display events. BYCHART is default if unspecified. Valid options are: BYCHART, AUTOMATIC, ALL, NONE, BYDASHBOARD, and BYCHARTANDDASHBOARD.

    Name string

    Name of the dashboard.

    ParameterDetails List<DashboardParameterDetailArgs>

    The current JSON representation of dashboard parameters. See parameter details.

    Description string

    Human-readable description of the dashboard.

    Sections []DashboardSectionArgs

    Dashboard chart sections. See dashboard sections.

    Tags []string

    A set of tags to assign to this resource.

    Url string

    Unique identifier, also a URL slug of the dashboard.

    CanModifies []string

    A list of users that have modify ACL access to the dashboard.

    CanViews []string

    A list of users that have view ACL access to the dashboard.

    DisplayQueryParameters bool

    Whether the dashboard parameters section is opened by default when the dashboard is shown.

    DisplaySectionTableOfContents bool

    Whether the "pills" quick-linked the sections of the dashboard are displayed by default when the dashboard is shown.

    EventFilterType string

    How charts belonging to this dashboard should display events. BYCHART is default if unspecified. Valid options are: BYCHART, AUTOMATIC, ALL, NONE, BYDASHBOARD, and BYCHARTANDDASHBOARD.

    Name string

    Name of the dashboard.

    ParameterDetails []DashboardParameterDetailArgs

    The current JSON representation of dashboard parameters. See parameter details.

    description String

    Human-readable description of the dashboard.

    sections List<DashboardSectionArgs>

    Dashboard chart sections. See dashboard sections.

    tags List<String>

    A set of tags to assign to this resource.

    url String

    Unique identifier, also a URL slug of the dashboard.

    canModifies List<String>

    A list of users that have modify ACL access to the dashboard.

    canViews List<String>

    A list of users that have view ACL access to the dashboard.

    displayQueryParameters Boolean

    Whether the dashboard parameters section is opened by default when the dashboard is shown.

    displaySectionTableOfContents Boolean

    Whether the "pills" quick-linked the sections of the dashboard are displayed by default when the dashboard is shown.

    eventFilterType String

    How charts belonging to this dashboard should display events. BYCHART is default if unspecified. Valid options are: BYCHART, AUTOMATIC, ALL, NONE, BYDASHBOARD, and BYCHARTANDDASHBOARD.

    name String

    Name of the dashboard.

    parameterDetails List<DashboardParameterDetailArgs>

    The current JSON representation of dashboard parameters. See parameter details.

    description string

    Human-readable description of the dashboard.

    sections DashboardSectionArgs[]

    Dashboard chart sections. See dashboard sections.

    tags string[]

    A set of tags to assign to this resource.

    url string

    Unique identifier, also a URL slug of the dashboard.

    canModifies string[]

    A list of users that have modify ACL access to the dashboard.

    canViews string[]

    A list of users that have view ACL access to the dashboard.

    displayQueryParameters boolean

    Whether the dashboard parameters section is opened by default when the dashboard is shown.

    displaySectionTableOfContents boolean

    Whether the "pills" quick-linked the sections of the dashboard are displayed by default when the dashboard is shown.

    eventFilterType string

    How charts belonging to this dashboard should display events. BYCHART is default if unspecified. Valid options are: BYCHART, AUTOMATIC, ALL, NONE, BYDASHBOARD, and BYCHARTANDDASHBOARD.

    name string

    Name of the dashboard.

    parameterDetails DashboardParameterDetailArgs[]

    The current JSON representation of dashboard parameters. See parameter details.

    description str

    Human-readable description of the dashboard.

    sections Sequence[DashboardSectionArgs]

    Dashboard chart sections. See dashboard sections.

    tags Sequence[str]

    A set of tags to assign to this resource.

    url str

    Unique identifier, also a URL slug of the dashboard.

    can_modifies Sequence[str]

    A list of users that have modify ACL access to the dashboard.

    can_views Sequence[str]

    A list of users that have view ACL access to the dashboard.

    display_query_parameters bool

    Whether the dashboard parameters section is opened by default when the dashboard is shown.

    display_section_table_of_contents bool

    Whether the "pills" quick-linked the sections of the dashboard are displayed by default when the dashboard is shown.

    event_filter_type str

    How charts belonging to this dashboard should display events. BYCHART is default if unspecified. Valid options are: BYCHART, AUTOMATIC, ALL, NONE, BYDASHBOARD, and BYCHARTANDDASHBOARD.

    name str

    Name of the dashboard.

    parameter_details Sequence[DashboardParameterDetailArgs]

    The current JSON representation of dashboard parameters. See parameter details.

    description String

    Human-readable description of the dashboard.

    sections List<Property Map>

    Dashboard chart sections. See dashboard sections.

    tags List<String>

    A set of tags to assign to this resource.

    url String

    Unique identifier, also a URL slug of the dashboard.

    canModifies List<String>

    A list of users that have modify ACL access to the dashboard.

    canViews List<String>

    A list of users that have view ACL access to the dashboard.

    displayQueryParameters Boolean

    Whether the dashboard parameters section is opened by default when the dashboard is shown.

    displaySectionTableOfContents Boolean

    Whether the "pills" quick-linked the sections of the dashboard are displayed by default when the dashboard is shown.

    eventFilterType String

    How charts belonging to this dashboard should display events. BYCHART is default if unspecified. Valid options are: BYCHART, AUTOMATIC, ALL, NONE, BYDASHBOARD, and BYCHARTANDDASHBOARD.

    name String

    Name of the dashboard.

    parameterDetails List<Property Map>

    The current JSON representation of dashboard parameters. See parameter details.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Dashboard resource produces the following output properties:

    Id string

    The provider-assigned unique ID for this managed resource.

    Id string

    The provider-assigned unique ID for this managed resource.

    id String

    The provider-assigned unique ID for this managed resource.

    id string

    The provider-assigned unique ID for this managed resource.

    id str

    The provider-assigned unique ID for this managed resource.

    id String

    The provider-assigned unique ID for this managed resource.

    Look up Existing Dashboard Resource

    Get an existing Dashboard 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?: DashboardState, opts?: CustomResourceOptions): Dashboard
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            can_modifies: Optional[Sequence[str]] = None,
            can_views: Optional[Sequence[str]] = None,
            description: Optional[str] = None,
            display_query_parameters: Optional[bool] = None,
            display_section_table_of_contents: Optional[bool] = None,
            event_filter_type: Optional[str] = None,
            name: Optional[str] = None,
            parameter_details: Optional[Sequence[DashboardParameterDetailArgs]] = None,
            sections: Optional[Sequence[DashboardSectionArgs]] = None,
            tags: Optional[Sequence[str]] = None,
            url: Optional[str] = None) -> Dashboard
    func GetDashboard(ctx *Context, name string, id IDInput, state *DashboardState, opts ...ResourceOption) (*Dashboard, error)
    public static Dashboard Get(string name, Input<string> id, DashboardState? state, CustomResourceOptions? opts = null)
    public static Dashboard get(String name, Output<String> id, DashboardState 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:
    CanModifies List<string>

    A list of users that have modify ACL access to the dashboard.

    CanViews List<string>

    A list of users that have view ACL access to the dashboard.

    Description string

    Human-readable description of the dashboard.

    DisplayQueryParameters bool

    Whether the dashboard parameters section is opened by default when the dashboard is shown.

    DisplaySectionTableOfContents bool

    Whether the "pills" quick-linked the sections of the dashboard are displayed by default when the dashboard is shown.

    EventFilterType string

    How charts belonging to this dashboard should display events. BYCHART is default if unspecified. Valid options are: BYCHART, AUTOMATIC, ALL, NONE, BYDASHBOARD, and BYCHARTANDDASHBOARD.

    Name string

    Name of the dashboard.

    ParameterDetails List<DashboardParameterDetailArgs>

    The current JSON representation of dashboard parameters. See parameter details.

    Sections List<DashboardSectionArgs>

    Dashboard chart sections. See dashboard sections.

    Tags List<string>

    A set of tags to assign to this resource.

    Url string

    Unique identifier, also a URL slug of the dashboard.

    CanModifies []string

    A list of users that have modify ACL access to the dashboard.

    CanViews []string

    A list of users that have view ACL access to the dashboard.

    Description string

    Human-readable description of the dashboard.

    DisplayQueryParameters bool

    Whether the dashboard parameters section is opened by default when the dashboard is shown.

    DisplaySectionTableOfContents bool

    Whether the "pills" quick-linked the sections of the dashboard are displayed by default when the dashboard is shown.

    EventFilterType string

    How charts belonging to this dashboard should display events. BYCHART is default if unspecified. Valid options are: BYCHART, AUTOMATIC, ALL, NONE, BYDASHBOARD, and BYCHARTANDDASHBOARD.

    Name string

    Name of the dashboard.

    ParameterDetails []DashboardParameterDetailArgs

    The current JSON representation of dashboard parameters. See parameter details.

    Sections []DashboardSectionArgs

    Dashboard chart sections. See dashboard sections.

    Tags []string

    A set of tags to assign to this resource.

    Url string

    Unique identifier, also a URL slug of the dashboard.

    canModifies List<String>

    A list of users that have modify ACL access to the dashboard.

    canViews List<String>

    A list of users that have view ACL access to the dashboard.

    description String

    Human-readable description of the dashboard.

    displayQueryParameters Boolean

    Whether the dashboard parameters section is opened by default when the dashboard is shown.

    displaySectionTableOfContents Boolean

    Whether the "pills" quick-linked the sections of the dashboard are displayed by default when the dashboard is shown.

    eventFilterType String

    How charts belonging to this dashboard should display events. BYCHART is default if unspecified. Valid options are: BYCHART, AUTOMATIC, ALL, NONE, BYDASHBOARD, and BYCHARTANDDASHBOARD.

    name String

    Name of the dashboard.

    parameterDetails List<DashboardParameterDetailArgs>

    The current JSON representation of dashboard parameters. See parameter details.

    sections List<DashboardSectionArgs>

    Dashboard chart sections. See dashboard sections.

    tags List<String>

    A set of tags to assign to this resource.

    url String

    Unique identifier, also a URL slug of the dashboard.

    canModifies string[]

    A list of users that have modify ACL access to the dashboard.

    canViews string[]

    A list of users that have view ACL access to the dashboard.

    description string

    Human-readable description of the dashboard.

    displayQueryParameters boolean

    Whether the dashboard parameters section is opened by default when the dashboard is shown.

    displaySectionTableOfContents boolean

    Whether the "pills" quick-linked the sections of the dashboard are displayed by default when the dashboard is shown.

    eventFilterType string

    How charts belonging to this dashboard should display events. BYCHART is default if unspecified. Valid options are: BYCHART, AUTOMATIC, ALL, NONE, BYDASHBOARD, and BYCHARTANDDASHBOARD.

    name string

    Name of the dashboard.

    parameterDetails DashboardParameterDetailArgs[]

    The current JSON representation of dashboard parameters. See parameter details.

    sections DashboardSectionArgs[]

    Dashboard chart sections. See dashboard sections.

    tags string[]

    A set of tags to assign to this resource.

    url string

    Unique identifier, also a URL slug of the dashboard.

    can_modifies Sequence[str]

    A list of users that have modify ACL access to the dashboard.

    can_views Sequence[str]

    A list of users that have view ACL access to the dashboard.

    description str

    Human-readable description of the dashboard.

    display_query_parameters bool

    Whether the dashboard parameters section is opened by default when the dashboard is shown.

    display_section_table_of_contents bool

    Whether the "pills" quick-linked the sections of the dashboard are displayed by default when the dashboard is shown.

    event_filter_type str

    How charts belonging to this dashboard should display events. BYCHART is default if unspecified. Valid options are: BYCHART, AUTOMATIC, ALL, NONE, BYDASHBOARD, and BYCHARTANDDASHBOARD.

    name str

    Name of the dashboard.

    parameter_details Sequence[DashboardParameterDetailArgs]

    The current JSON representation of dashboard parameters. See parameter details.

    sections Sequence[DashboardSectionArgs]

    Dashboard chart sections. See dashboard sections.

    tags Sequence[str]

    A set of tags to assign to this resource.

    url str

    Unique identifier, also a URL slug of the dashboard.

    canModifies List<String>

    A list of users that have modify ACL access to the dashboard.

    canViews List<String>

    A list of users that have view ACL access to the dashboard.

    description String

    Human-readable description of the dashboard.

    displayQueryParameters Boolean

    Whether the dashboard parameters section is opened by default when the dashboard is shown.

    displaySectionTableOfContents Boolean

    Whether the "pills" quick-linked the sections of the dashboard are displayed by default when the dashboard is shown.

    eventFilterType String

    How charts belonging to this dashboard should display events. BYCHART is default if unspecified. Valid options are: BYCHART, AUTOMATIC, ALL, NONE, BYDASHBOARD, and BYCHARTANDDASHBOARD.

    name String

    Name of the dashboard.

    parameterDetails List<Property Map>

    The current JSON representation of dashboard parameters. See parameter details.

    sections List<Property Map>

    Dashboard chart sections. See dashboard sections.

    tags List<String>

    A set of tags to assign to this resource.

    url String

    Unique identifier, also a URL slug of the dashboard.

    Supporting Types

    DashboardParameterDetail

    DefaultValue string

    The default value of the parameter.

    HideFromView bool

    If true the parameter will only be shown on the edit view of the dashboard.

    Label string

    The label for the parameter.

    Name string

    The name of the parameters.

    ParameterType string

    The type of the parameter. SIMPLE, LIST, or DYNAMIC.

    ValuesToReadableStrings Dictionary<string, string>

    A string->string map. At least one of the keys must match the value of default_value.

    DynamicFieldType string

    For DYNAMIC parameter types, the type of the field. Valid options are SOURCE, SOURCE_TAG, METRIC_NAME, TAG_KEY, and MATCHING_SOURCE_TAG.

    QueryValue string

    For DYNAMIC parameter types, the query to execute to return values.

    TagKey string

    for TAG_KEY dynamic field types, the tag key to return.

    DefaultValue string

    The default value of the parameter.

    HideFromView bool

    If true the parameter will only be shown on the edit view of the dashboard.

    Label string

    The label for the parameter.

    Name string

    The name of the parameters.

    ParameterType string

    The type of the parameter. SIMPLE, LIST, or DYNAMIC.

    ValuesToReadableStrings map[string]string

    A string->string map. At least one of the keys must match the value of default_value.

    DynamicFieldType string

    For DYNAMIC parameter types, the type of the field. Valid options are SOURCE, SOURCE_TAG, METRIC_NAME, TAG_KEY, and MATCHING_SOURCE_TAG.

    QueryValue string

    For DYNAMIC parameter types, the query to execute to return values.

    TagKey string

    for TAG_KEY dynamic field types, the tag key to return.

    defaultValue String

    The default value of the parameter.

    hideFromView Boolean

    If true the parameter will only be shown on the edit view of the dashboard.

    label String

    The label for the parameter.

    name String

    The name of the parameters.

    parameterType String

    The type of the parameter. SIMPLE, LIST, or DYNAMIC.

    valuesToReadableStrings Map<String,String>

    A string->string map. At least one of the keys must match the value of default_value.

    dynamicFieldType String

    For DYNAMIC parameter types, the type of the field. Valid options are SOURCE, SOURCE_TAG, METRIC_NAME, TAG_KEY, and MATCHING_SOURCE_TAG.

    queryValue String

    For DYNAMIC parameter types, the query to execute to return values.

    tagKey String

    for TAG_KEY dynamic field types, the tag key to return.

    defaultValue string

    The default value of the parameter.

    hideFromView boolean

    If true the parameter will only be shown on the edit view of the dashboard.

    label string

    The label for the parameter.

    name string

    The name of the parameters.

    parameterType string

    The type of the parameter. SIMPLE, LIST, or DYNAMIC.

    valuesToReadableStrings {[key: string]: string}

    A string->string map. At least one of the keys must match the value of default_value.

    dynamicFieldType string

    For DYNAMIC parameter types, the type of the field. Valid options are SOURCE, SOURCE_TAG, METRIC_NAME, TAG_KEY, and MATCHING_SOURCE_TAG.

    queryValue string

    For DYNAMIC parameter types, the query to execute to return values.

    tagKey string

    for TAG_KEY dynamic field types, the tag key to return.

    default_value str

    The default value of the parameter.

    hide_from_view bool

    If true the parameter will only be shown on the edit view of the dashboard.

    label str

    The label for the parameter.

    name str

    The name of the parameters.

    parameter_type str

    The type of the parameter. SIMPLE, LIST, or DYNAMIC.

    values_to_readable_strings Mapping[str, str]

    A string->string map. At least one of the keys must match the value of default_value.

    dynamic_field_type str

    For DYNAMIC parameter types, the type of the field. Valid options are SOURCE, SOURCE_TAG, METRIC_NAME, TAG_KEY, and MATCHING_SOURCE_TAG.

    query_value str

    For DYNAMIC parameter types, the query to execute to return values.

    tag_key str

    for TAG_KEY dynamic field types, the tag key to return.

    defaultValue String

    The default value of the parameter.

    hideFromView Boolean

    If true the parameter will only be shown on the edit view of the dashboard.

    label String

    The label for the parameter.

    name String

    The name of the parameters.

    parameterType String

    The type of the parameter. SIMPLE, LIST, or DYNAMIC.

    valuesToReadableStrings Map<String>

    A string->string map. At least one of the keys must match the value of default_value.

    dynamicFieldType String

    For DYNAMIC parameter types, the type of the field. Valid options are SOURCE, SOURCE_TAG, METRIC_NAME, TAG_KEY, and MATCHING_SOURCE_TAG.

    queryValue String

    For DYNAMIC parameter types, the query to execute to return values.

    tagKey String

    for TAG_KEY dynamic field types, the tag key to return.

    DashboardSection

    Name string

    Name of this section.

    Rows List<DashboardSectionRow>

    See dashboard section rows.

    Name string

    Name of this section.

    Rows []DashboardSectionRow

    See dashboard section rows.

    name String

    Name of this section.

    rows List<DashboardSectionRow>

    See dashboard section rows.

    name string

    Name of this section.

    rows DashboardSectionRow[]

    See dashboard section rows.

    name str

    Name of this section.

    rows Sequence[DashboardSectionRow]

    See dashboard section rows.

    name String

    Name of this section.

    rows List<Property Map>

    See dashboard section rows.

    DashboardSectionRow

    Charts List<DashboardSectionRowChart>

    Charts in this section. See dashboard chart.

    Charts []DashboardSectionRowChart

    Charts in this section. See dashboard chart.

    charts List<DashboardSectionRowChart>

    Charts in this section. See dashboard chart.

    charts DashboardSectionRowChart[]

    Charts in this section. See dashboard chart.

    charts Sequence[DashboardSectionRowChart]

    Charts in this section. See dashboard chart.

    charts List<Property Map>

    Charts in this section. See dashboard chart.

    DashboardSectionRowChart

    ChartSetting DashboardSectionRowChartChartSetting

    Chart settings. See chart settings.

    Name string

    Name of the source.

    Sources List<DashboardSectionRowChartSource>

    Query expression to plot on the chart. See chart source queries.

    Summarization string

    Summarization strategy for the chart. MEAN is default. Valid options are, MEAN, MEDIAN, MIN, MAX, SUM, COUNT, LAST, FIRST.

    Units string

    String to label the units of the chart on the Y-Axis.

    Base int

    The base of logarithmic scale charts. Omit or set to 0 for the default linear scale. Usually set to 10 for the traditional logarithmic scale.

    ChartAttribute string
    Description string

    Description of the chart.

    ChartSetting DashboardSectionRowChartChartSetting

    Chart settings. See chart settings.

    Name string

    Name of the source.

    Sources []DashboardSectionRowChartSource

    Query expression to plot on the chart. See chart source queries.

    Summarization string

    Summarization strategy for the chart. MEAN is default. Valid options are, MEAN, MEDIAN, MIN, MAX, SUM, COUNT, LAST, FIRST.

    Units string

    String to label the units of the chart on the Y-Axis.

    Base int

    The base of logarithmic scale charts. Omit or set to 0 for the default linear scale. Usually set to 10 for the traditional logarithmic scale.

    ChartAttribute string
    Description string

    Description of the chart.

    chartSetting DashboardSectionRowChartChartSetting

    Chart settings. See chart settings.

    name String

    Name of the source.

    sources List<DashboardSectionRowChartSource>

    Query expression to plot on the chart. See chart source queries.

    summarization String

    Summarization strategy for the chart. MEAN is default. Valid options are, MEAN, MEDIAN, MIN, MAX, SUM, COUNT, LAST, FIRST.

    units String

    String to label the units of the chart on the Y-Axis.

    base Integer

    The base of logarithmic scale charts. Omit or set to 0 for the default linear scale. Usually set to 10 for the traditional logarithmic scale.

    chartAttribute String
    description String

    Description of the chart.

    chartSetting DashboardSectionRowChartChartSetting

    Chart settings. See chart settings.

    name string

    Name of the source.

    sources DashboardSectionRowChartSource[]

    Query expression to plot on the chart. See chart source queries.

    summarization string

    Summarization strategy for the chart. MEAN is default. Valid options are, MEAN, MEDIAN, MIN, MAX, SUM, COUNT, LAST, FIRST.

    units string

    String to label the units of the chart on the Y-Axis.

    base number

    The base of logarithmic scale charts. Omit or set to 0 for the default linear scale. Usually set to 10 for the traditional logarithmic scale.

    chartAttribute string
    description string

    Description of the chart.

    chart_setting DashboardSectionRowChartChartSetting

    Chart settings. See chart settings.

    name str

    Name of the source.

    sources Sequence[DashboardSectionRowChartSource]

    Query expression to plot on the chart. See chart source queries.

    summarization str

    Summarization strategy for the chart. MEAN is default. Valid options are, MEAN, MEDIAN, MIN, MAX, SUM, COUNT, LAST, FIRST.

    units str

    String to label the units of the chart on the Y-Axis.

    base int

    The base of logarithmic scale charts. Omit or set to 0 for the default linear scale. Usually set to 10 for the traditional logarithmic scale.

    chart_attribute str
    description str

    Description of the chart.

    chartSetting Property Map

    Chart settings. See chart settings.

    name String

    Name of the source.

    sources List<Property Map>

    Query expression to plot on the chart. See chart source queries.

    summarization String

    Summarization strategy for the chart. MEAN is default. Valid options are, MEAN, MEDIAN, MIN, MAX, SUM, COUNT, LAST, FIRST.

    units String

    String to label the units of the chart on the Y-Axis.

    base Number

    The base of logarithmic scale charts. Omit or set to 0 for the default linear scale. Usually set to 10 for the traditional logarithmic scale.

    chartAttribute String
    description String

    Description of the chart.

    DashboardSectionRowChartChartSetting

    Type string

    Chart Type. line refers to the Line Plot, scatter to the Point Plot, stacked-area to the Stacked Area plot, table to the Tabular View, scatterplot-xy to Scatter Plot, markdown-widget to the Markdown display, and sparkline to the Single Stat view. Valid options are line, scatterplot, stacked-area, stacked-column, table, scatterplot-xy, markdown-widget, sparkline, globe, nodemap, top-k, status-list, and histogram.

    AutoColumnTags bool

    This setting is deprecated.

    ColumnTags string

    This setting is deprecated.

    CustomTags List<string>

    For the tabular view, a list of point tags to display when using the custom tag display mode.

    ExpectedDataSpacing int

    Threshold (in seconds) for time delta between consecutive points in a series above which a dotted line will replace a solid in in line plots. Default is 60.

    FixedLegendDisplayStats List<string>

    For a chart with a fixed legend, a list of statistics to display in the legend.

    FixedLegendEnabled bool

    Whether to enable a fixed tabular legend adjacent to the chart.

    FixedLegendFilterField string

    Statistic to use for determining whether a series is displayed on the fixed legend. Valid options are CURRENT, MEAN, MEDIAN, SUM, MIN, MAX, and COUNT.

    FixedLegendFilterLimit int

    Number of series to include in the fixed legend.

    FixedLegendFilterSort string

    Whether to display TOP or BOTTOM ranked series in a fixed legend. Valid options are TOP, and BOTTOM.

    FixedLegendHideLabel bool

    This setting is deprecated.

    FixedLegendPosition string

    Where the fixed legend should be displayed with respect to the chart. Valid options are RIGHT, TOP, LEFT, BOTTOM.

    FixedLegendUseRawStats bool

    If true, the legend uses non-summarized stats instead of summarized.

    GroupBySource bool

    For the tabular view, whether to group multi metrics into a single row by a common source. If false, each source is displayed in its own row. if true, multiple metrics for the same host are displayed as different columns in the same row.

    InvertDynamicLegendHoverControl bool

    Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed).

    LineType string

    Plot interpolation type. linear is default. Valid options are linear, step-before, step-after, basis, cardinal, and monotone.

    Max double

    Max value of the Y-axis. Set to null or leave blank for auto.

    Min double

    Min value of the Y-axis. Set to null or leave blank for auto.

    NumTags int

    For the tabular view defines how many point tags to display.

    PlainMarkdownContent string

    The markdown content for a Markdown display, in plain text.

    ShowHosts bool

    For the tabular view, whether to display sources. Default is true.

    ShowLabels bool

    For the tabular view, whether to display labels. Default is true.

    ShowRawValues bool

    For the tabular view, whether to display raw values. Default is false.

    SortValuesDescending bool

    For the tabular view, whether to display values in descending order. Default is false.

    SparklineDecimalPrecision int

    For the single stat view, the decimal precision of the displayed number.

    SparklineDisplayColor string

    For the single stat view, the color of the displayed text (when not dynamically determined). Values should be in rgba(,,,,) format.

    SparklineDisplayFontSize string

    For the single stat view, the font size of the displayed text, in percent.

    SparklineDisplayHorizontalPosition string

    For the single stat view, the horizontal position of the displayed text. Valid options are MIDDLE, LEFT, RIGHT.

    SparklineDisplayPostfix string

    For the single stat view, a string to append to the displayed text.

    SparklineDisplayPrefix string

    For the single stat view, a string to add before the displayed text.

    SparklineDisplayValueType string

    For the single stat view, where to display the name of the query or the value of the query. Valid options are VALUE or LABEL.

    SparklineDisplayVerticalPosition string

    This setting is deprecated.

    SparklineFillColor string

    For the single stat view, the color of the background fill. Values should be in rgba(,,,,).

    SparklineLineColor string

    For the single stat view, the color of the line. Values should be in rgba(,,,,) format.

    SparklineSize string

    For the single stat view, this determines whether the sparkline of the statistic is displayed in the chart. Valid options are BACKGROUND, BOTTOM, NONE.

    SparklineValueColorMapApplyTo string

    For the single stat view, whether to apply dynamic color settings to the displayed TEXT or BACKGROUND. Valid options are TEXT or BACKGROUND.

    SparklineValueColorMapColors List<string>

    For the single stat view, A list of colors that differing query values map to. Must contain one more element than sparkline_value_color_map_values_v2. Values should be in rgba(,,,,).

    SparklineValueColorMapValues List<int>

    This setting is deprecated.

    SparklineValueColorMapValuesV2s List<double>

    For the single stat view, a list of boundaries for mapping different query values to colors. Must contain one element less than sparkline_value_color_map_colors.

    SparklineValueTextMapTexts List<string>

    For the single stat view, a list of display text values that different query values map to. Must contain one more element than sparkline_value_text_map_thresholds.

    SparklineValueTextMapThresholds List<double>

    For the single stat view, a list of threshold boundaries for mapping different query values to display text. Must contain one element less than sparkline_value_text_map_text.

    StackType string

    Type of stacked chart (applicable only if chart type is stacked). zero (default) means stacked from y=0. expand means normalized from 0 to 1. wiggle means minimize weighted changes. silhouette means to center the stream. Valid options are zero, expand, wiggle, silhouette, and bars.

    TagMode string

    For the tabular view, which mode to use to determine which point tags to display. Valid options are all, top, or custom.

    TimeBasedColoring bool

    For x-y scatterplots, whether to color more recent points as darker than older points.

    WindowSize int

    Width, in minutes, of the time window to use for last windowing.

    Windowing string

    For the tabular view, whether to use the full time window for the query or the last X minutes. Valid options are full or last.

    Xmax double

    For x-y scatterplots, max value for the X-axis. Set to null for auto.

    Xmin double

    For x-y scatterplots, min value for the X-axis. Set to null for auto.

    Y0ScaleSiBy1024 bool

    Whether to scale numerical magnitude labels for left Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI).

    Y0UnitAutoscaling bool

    Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units.

    Y1ScaleSiBy1024 bool

    Whether to scale numerical magnitude labels for right Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI).

    Y1UnitAutoscaling bool

    Whether to automatically adjust magnitude labels and units for the right Y-axis to favor smaller magnitudes and larger units.

    Y1Units string

    For plots with multiple Y-axes, units for right side Y-axis.

    Y1max double

    For plots with multiple Y-axes, max value for the right side Y-axis. Set null for auto.

    Y1min double

    For plots with multiple Y-axes, min value for the right side Y-axis. Set null for auto.

    Ymax double

    For x-y scatterplots, max value for the Y-axis. Set to null for auto.

    Ymin double

    For x-y scatterplots, min value for the Y-axis. Set to null for auto.

    Type string

    Chart Type. line refers to the Line Plot, scatter to the Point Plot, stacked-area to the Stacked Area plot, table to the Tabular View, scatterplot-xy to Scatter Plot, markdown-widget to the Markdown display, and sparkline to the Single Stat view. Valid options are line, scatterplot, stacked-area, stacked-column, table, scatterplot-xy, markdown-widget, sparkline, globe, nodemap, top-k, status-list, and histogram.

    AutoColumnTags bool

    This setting is deprecated.

    ColumnTags string

    This setting is deprecated.

    CustomTags []string

    For the tabular view, a list of point tags to display when using the custom tag display mode.

    ExpectedDataSpacing int

    Threshold (in seconds) for time delta between consecutive points in a series above which a dotted line will replace a solid in in line plots. Default is 60.

    FixedLegendDisplayStats []string

    For a chart with a fixed legend, a list of statistics to display in the legend.

    FixedLegendEnabled bool

    Whether to enable a fixed tabular legend adjacent to the chart.

    FixedLegendFilterField string

    Statistic to use for determining whether a series is displayed on the fixed legend. Valid options are CURRENT, MEAN, MEDIAN, SUM, MIN, MAX, and COUNT.

    FixedLegendFilterLimit int

    Number of series to include in the fixed legend.

    FixedLegendFilterSort string

    Whether to display TOP or BOTTOM ranked series in a fixed legend. Valid options are TOP, and BOTTOM.

    FixedLegendHideLabel bool

    This setting is deprecated.

    FixedLegendPosition string

    Where the fixed legend should be displayed with respect to the chart. Valid options are RIGHT, TOP, LEFT, BOTTOM.

    FixedLegendUseRawStats bool

    If true, the legend uses non-summarized stats instead of summarized.

    GroupBySource bool

    For the tabular view, whether to group multi metrics into a single row by a common source. If false, each source is displayed in its own row. if true, multiple metrics for the same host are displayed as different columns in the same row.

    InvertDynamicLegendHoverControl bool

    Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed).

    LineType string

    Plot interpolation type. linear is default. Valid options are linear, step-before, step-after, basis, cardinal, and monotone.

    Max float64

    Max value of the Y-axis. Set to null or leave blank for auto.

    Min float64

    Min value of the Y-axis. Set to null or leave blank for auto.

    NumTags int

    For the tabular view defines how many point tags to display.

    PlainMarkdownContent string

    The markdown content for a Markdown display, in plain text.

    ShowHosts bool

    For the tabular view, whether to display sources. Default is true.

    ShowLabels bool

    For the tabular view, whether to display labels. Default is true.

    ShowRawValues bool

    For the tabular view, whether to display raw values. Default is false.

    SortValuesDescending bool

    For the tabular view, whether to display values in descending order. Default is false.

    SparklineDecimalPrecision int

    For the single stat view, the decimal precision of the displayed number.

    SparklineDisplayColor string

    For the single stat view, the color of the displayed text (when not dynamically determined). Values should be in rgba(,,,,) format.

    SparklineDisplayFontSize string

    For the single stat view, the font size of the displayed text, in percent.

    SparklineDisplayHorizontalPosition string

    For the single stat view, the horizontal position of the displayed text. Valid options are MIDDLE, LEFT, RIGHT.

    SparklineDisplayPostfix string

    For the single stat view, a string to append to the displayed text.

    SparklineDisplayPrefix string

    For the single stat view, a string to add before the displayed text.

    SparklineDisplayValueType string

    For the single stat view, where to display the name of the query or the value of the query. Valid options are VALUE or LABEL.

    SparklineDisplayVerticalPosition string

    This setting is deprecated.

    SparklineFillColor string

    For the single stat view, the color of the background fill. Values should be in rgba(,,,,).

    SparklineLineColor string

    For the single stat view, the color of the line. Values should be in rgba(,,,,) format.

    SparklineSize string

    For the single stat view, this determines whether the sparkline of the statistic is displayed in the chart. Valid options are BACKGROUND, BOTTOM, NONE.

    SparklineValueColorMapApplyTo string

    For the single stat view, whether to apply dynamic color settings to the displayed TEXT or BACKGROUND. Valid options are TEXT or BACKGROUND.

    SparklineValueColorMapColors []string

    For the single stat view, A list of colors that differing query values map to. Must contain one more element than sparkline_value_color_map_values_v2. Values should be in rgba(,,,,).

    SparklineValueColorMapValues []int

    This setting is deprecated.

    SparklineValueColorMapValuesV2s []float64

    For the single stat view, a list of boundaries for mapping different query values to colors. Must contain one element less than sparkline_value_color_map_colors.

    SparklineValueTextMapTexts []string

    For the single stat view, a list of display text values that different query values map to. Must contain one more element than sparkline_value_text_map_thresholds.

    SparklineValueTextMapThresholds []float64

    For the single stat view, a list of threshold boundaries for mapping different query values to display text. Must contain one element less than sparkline_value_text_map_text.

    StackType string

    Type of stacked chart (applicable only if chart type is stacked). zero (default) means stacked from y=0. expand means normalized from 0 to 1. wiggle means minimize weighted changes. silhouette means to center the stream. Valid options are zero, expand, wiggle, silhouette, and bars.

    TagMode string

    For the tabular view, which mode to use to determine which point tags to display. Valid options are all, top, or custom.

    TimeBasedColoring bool

    For x-y scatterplots, whether to color more recent points as darker than older points.

    WindowSize int

    Width, in minutes, of the time window to use for last windowing.

    Windowing string

    For the tabular view, whether to use the full time window for the query or the last X minutes. Valid options are full or last.

    Xmax float64

    For x-y scatterplots, max value for the X-axis. Set to null for auto.

    Xmin float64

    For x-y scatterplots, min value for the X-axis. Set to null for auto.

    Y0ScaleSiBy1024 bool

    Whether to scale numerical magnitude labels for left Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI).

    Y0UnitAutoscaling bool

    Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units.

    Y1ScaleSiBy1024 bool

    Whether to scale numerical magnitude labels for right Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI).

    Y1UnitAutoscaling bool

    Whether to automatically adjust magnitude labels and units for the right Y-axis to favor smaller magnitudes and larger units.

    Y1Units string

    For plots with multiple Y-axes, units for right side Y-axis.

    Y1max float64

    For plots with multiple Y-axes, max value for the right side Y-axis. Set null for auto.

    Y1min float64

    For plots with multiple Y-axes, min value for the right side Y-axis. Set null for auto.

    Ymax float64

    For x-y scatterplots, max value for the Y-axis. Set to null for auto.

    Ymin float64

    For x-y scatterplots, min value for the Y-axis. Set to null for auto.

    type String

    Chart Type. line refers to the Line Plot, scatter to the Point Plot, stacked-area to the Stacked Area plot, table to the Tabular View, scatterplot-xy to Scatter Plot, markdown-widget to the Markdown display, and sparkline to the Single Stat view. Valid options are line, scatterplot, stacked-area, stacked-column, table, scatterplot-xy, markdown-widget, sparkline, globe, nodemap, top-k, status-list, and histogram.

    autoColumnTags Boolean

    This setting is deprecated.

    columnTags String

    This setting is deprecated.

    customTags List<String>

    For the tabular view, a list of point tags to display when using the custom tag display mode.

    expectedDataSpacing Integer

    Threshold (in seconds) for time delta between consecutive points in a series above which a dotted line will replace a solid in in line plots. Default is 60.

    fixedLegendDisplayStats List<String>

    For a chart with a fixed legend, a list of statistics to display in the legend.

    fixedLegendEnabled Boolean

    Whether to enable a fixed tabular legend adjacent to the chart.

    fixedLegendFilterField String

    Statistic to use for determining whether a series is displayed on the fixed legend. Valid options are CURRENT, MEAN, MEDIAN, SUM, MIN, MAX, and COUNT.

    fixedLegendFilterLimit Integer

    Number of series to include in the fixed legend.

    fixedLegendFilterSort String

    Whether to display TOP or BOTTOM ranked series in a fixed legend. Valid options are TOP, and BOTTOM.

    fixedLegendHideLabel Boolean

    This setting is deprecated.

    fixedLegendPosition String

    Where the fixed legend should be displayed with respect to the chart. Valid options are RIGHT, TOP, LEFT, BOTTOM.

    fixedLegendUseRawStats Boolean

    If true, the legend uses non-summarized stats instead of summarized.

    groupBySource Boolean

    For the tabular view, whether to group multi metrics into a single row by a common source. If false, each source is displayed in its own row. if true, multiple metrics for the same host are displayed as different columns in the same row.

    invertDynamicLegendHoverControl Boolean

    Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed).

    lineType String

    Plot interpolation type. linear is default. Valid options are linear, step-before, step-after, basis, cardinal, and monotone.

    max Double

    Max value of the Y-axis. Set to null or leave blank for auto.

    min Double

    Min value of the Y-axis. Set to null or leave blank for auto.

    numTags Integer

    For the tabular view defines how many point tags to display.

    plainMarkdownContent String

    The markdown content for a Markdown display, in plain text.

    showHosts Boolean

    For the tabular view, whether to display sources. Default is true.

    showLabels Boolean

    For the tabular view, whether to display labels. Default is true.

    showRawValues Boolean

    For the tabular view, whether to display raw values. Default is false.

    sortValuesDescending Boolean

    For the tabular view, whether to display values in descending order. Default is false.

    sparklineDecimalPrecision Integer

    For the single stat view, the decimal precision of the displayed number.

    sparklineDisplayColor String

    For the single stat view, the color of the displayed text (when not dynamically determined). Values should be in rgba(,,,,) format.

    sparklineDisplayFontSize String

    For the single stat view, the font size of the displayed text, in percent.

    sparklineDisplayHorizontalPosition String

    For the single stat view, the horizontal position of the displayed text. Valid options are MIDDLE, LEFT, RIGHT.

    sparklineDisplayPostfix String

    For the single stat view, a string to append to the displayed text.

    sparklineDisplayPrefix String

    For the single stat view, a string to add before the displayed text.

    sparklineDisplayValueType String

    For the single stat view, where to display the name of the query or the value of the query. Valid options are VALUE or LABEL.

    sparklineDisplayVerticalPosition String

    This setting is deprecated.

    sparklineFillColor String

    For the single stat view, the color of the background fill. Values should be in rgba(,,,,).

    sparklineLineColor String

    For the single stat view, the color of the line. Values should be in rgba(,,,,) format.

    sparklineSize String

    For the single stat view, this determines whether the sparkline of the statistic is displayed in the chart. Valid options are BACKGROUND, BOTTOM, NONE.

    sparklineValueColorMapApplyTo String

    For the single stat view, whether to apply dynamic color settings to the displayed TEXT or BACKGROUND. Valid options are TEXT or BACKGROUND.

    sparklineValueColorMapColors List<String>

    For the single stat view, A list of colors that differing query values map to. Must contain one more element than sparkline_value_color_map_values_v2. Values should be in rgba(,,,,).

    sparklineValueColorMapValues List<Integer>

    This setting is deprecated.

    sparklineValueColorMapValuesV2s List<Double>

    For the single stat view, a list of boundaries for mapping different query values to colors. Must contain one element less than sparkline_value_color_map_colors.

    sparklineValueTextMapTexts List<String>

    For the single stat view, a list of display text values that different query values map to. Must contain one more element than sparkline_value_text_map_thresholds.

    sparklineValueTextMapThresholds List<Double>

    For the single stat view, a list of threshold boundaries for mapping different query values to display text. Must contain one element less than sparkline_value_text_map_text.

    stackType String

    Type of stacked chart (applicable only if chart type is stacked). zero (default) means stacked from y=0. expand means normalized from 0 to 1. wiggle means minimize weighted changes. silhouette means to center the stream. Valid options are zero, expand, wiggle, silhouette, and bars.

    tagMode String

    For the tabular view, which mode to use to determine which point tags to display. Valid options are all, top, or custom.

    timeBasedColoring Boolean

    For x-y scatterplots, whether to color more recent points as darker than older points.

    windowSize Integer

    Width, in minutes, of the time window to use for last windowing.

    windowing String

    For the tabular view, whether to use the full time window for the query or the last X minutes. Valid options are full or last.

    xmax Double

    For x-y scatterplots, max value for the X-axis. Set to null for auto.

    xmin Double

    For x-y scatterplots, min value for the X-axis. Set to null for auto.

    y0ScaleSiBy1024 Boolean

    Whether to scale numerical magnitude labels for left Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI).

    y0UnitAutoscaling Boolean

    Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units.

    y1ScaleSiBy1024 Boolean

    Whether to scale numerical magnitude labels for right Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI).

    y1UnitAutoscaling Boolean

    Whether to automatically adjust magnitude labels and units for the right Y-axis to favor smaller magnitudes and larger units.

    y1Units String

    For plots with multiple Y-axes, units for right side Y-axis.

    y1max Double

    For plots with multiple Y-axes, max value for the right side Y-axis. Set null for auto.

    y1min Double

    For plots with multiple Y-axes, min value for the right side Y-axis. Set null for auto.

    ymax Double

    For x-y scatterplots, max value for the Y-axis. Set to null for auto.

    ymin Double

    For x-y scatterplots, min value for the Y-axis. Set to null for auto.

    type string

    Chart Type. line refers to the Line Plot, scatter to the Point Plot, stacked-area to the Stacked Area plot, table to the Tabular View, scatterplot-xy to Scatter Plot, markdown-widget to the Markdown display, and sparkline to the Single Stat view. Valid options are line, scatterplot, stacked-area, stacked-column, table, scatterplot-xy, markdown-widget, sparkline, globe, nodemap, top-k, status-list, and histogram.

    autoColumnTags boolean

    This setting is deprecated.

    columnTags string

    This setting is deprecated.

    customTags string[]

    For the tabular view, a list of point tags to display when using the custom tag display mode.

    expectedDataSpacing number

    Threshold (in seconds) for time delta between consecutive points in a series above which a dotted line will replace a solid in in line plots. Default is 60.

    fixedLegendDisplayStats string[]

    For a chart with a fixed legend, a list of statistics to display in the legend.

    fixedLegendEnabled boolean

    Whether to enable a fixed tabular legend adjacent to the chart.

    fixedLegendFilterField string

    Statistic to use for determining whether a series is displayed on the fixed legend. Valid options are CURRENT, MEAN, MEDIAN, SUM, MIN, MAX, and COUNT.

    fixedLegendFilterLimit number

    Number of series to include in the fixed legend.

    fixedLegendFilterSort string

    Whether to display TOP or BOTTOM ranked series in a fixed legend. Valid options are TOP, and BOTTOM.

    fixedLegendHideLabel boolean

    This setting is deprecated.

    fixedLegendPosition string

    Where the fixed legend should be displayed with respect to the chart. Valid options are RIGHT, TOP, LEFT, BOTTOM.

    fixedLegendUseRawStats boolean

    If true, the legend uses non-summarized stats instead of summarized.

    groupBySource boolean

    For the tabular view, whether to group multi metrics into a single row by a common source. If false, each source is displayed in its own row. if true, multiple metrics for the same host are displayed as different columns in the same row.

    invertDynamicLegendHoverControl boolean

    Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed).

    lineType string

    Plot interpolation type. linear is default. Valid options are linear, step-before, step-after, basis, cardinal, and monotone.

    max number

    Max value of the Y-axis. Set to null or leave blank for auto.

    min number

    Min value of the Y-axis. Set to null or leave blank for auto.

    numTags number

    For the tabular view defines how many point tags to display.

    plainMarkdownContent string

    The markdown content for a Markdown display, in plain text.

    showHosts boolean

    For the tabular view, whether to display sources. Default is true.

    showLabels boolean

    For the tabular view, whether to display labels. Default is true.

    showRawValues boolean

    For the tabular view, whether to display raw values. Default is false.

    sortValuesDescending boolean

    For the tabular view, whether to display values in descending order. Default is false.

    sparklineDecimalPrecision number

    For the single stat view, the decimal precision of the displayed number.

    sparklineDisplayColor string

    For the single stat view, the color of the displayed text (when not dynamically determined). Values should be in rgba(,,,,) format.

    sparklineDisplayFontSize string

    For the single stat view, the font size of the displayed text, in percent.

    sparklineDisplayHorizontalPosition string

    For the single stat view, the horizontal position of the displayed text. Valid options are MIDDLE, LEFT, RIGHT.

    sparklineDisplayPostfix string

    For the single stat view, a string to append to the displayed text.

    sparklineDisplayPrefix string

    For the single stat view, a string to add before the displayed text.

    sparklineDisplayValueType string

    For the single stat view, where to display the name of the query or the value of the query. Valid options are VALUE or LABEL.

    sparklineDisplayVerticalPosition string

    This setting is deprecated.

    sparklineFillColor string

    For the single stat view, the color of the background fill. Values should be in rgba(,,,,).

    sparklineLineColor string

    For the single stat view, the color of the line. Values should be in rgba(,,,,) format.

    sparklineSize string

    For the single stat view, this determines whether the sparkline of the statistic is displayed in the chart. Valid options are BACKGROUND, BOTTOM, NONE.

    sparklineValueColorMapApplyTo string

    For the single stat view, whether to apply dynamic color settings to the displayed TEXT or BACKGROUND. Valid options are TEXT or BACKGROUND.

    sparklineValueColorMapColors string[]

    For the single stat view, A list of colors that differing query values map to. Must contain one more element than sparkline_value_color_map_values_v2. Values should be in rgba(,,,,).

    sparklineValueColorMapValues number[]

    This setting is deprecated.

    sparklineValueColorMapValuesV2s number[]

    For the single stat view, a list of boundaries for mapping different query values to colors. Must contain one element less than sparkline_value_color_map_colors.

    sparklineValueTextMapTexts string[]

    For the single stat view, a list of display text values that different query values map to. Must contain one more element than sparkline_value_text_map_thresholds.

    sparklineValueTextMapThresholds number[]

    For the single stat view, a list of threshold boundaries for mapping different query values to display text. Must contain one element less than sparkline_value_text_map_text.

    stackType string

    Type of stacked chart (applicable only if chart type is stacked). zero (default) means stacked from y=0. expand means normalized from 0 to 1. wiggle means minimize weighted changes. silhouette means to center the stream. Valid options are zero, expand, wiggle, silhouette, and bars.

    tagMode string

    For the tabular view, which mode to use to determine which point tags to display. Valid options are all, top, or custom.

    timeBasedColoring boolean

    For x-y scatterplots, whether to color more recent points as darker than older points.

    windowSize number

    Width, in minutes, of the time window to use for last windowing.

    windowing string

    For the tabular view, whether to use the full time window for the query or the last X minutes. Valid options are full or last.

    xmax number

    For x-y scatterplots, max value for the X-axis. Set to null for auto.

    xmin number

    For x-y scatterplots, min value for the X-axis. Set to null for auto.

    y0ScaleSiBy1024 boolean

    Whether to scale numerical magnitude labels for left Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI).

    y0UnitAutoscaling boolean

    Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units.

    y1ScaleSiBy1024 boolean

    Whether to scale numerical magnitude labels for right Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI).

    y1UnitAutoscaling boolean

    Whether to automatically adjust magnitude labels and units for the right Y-axis to favor smaller magnitudes and larger units.

    y1Units string

    For plots with multiple Y-axes, units for right side Y-axis.

    y1max number

    For plots with multiple Y-axes, max value for the right side Y-axis. Set null for auto.

    y1min number

    For plots with multiple Y-axes, min value for the right side Y-axis. Set null for auto.

    ymax number

    For x-y scatterplots, max value for the Y-axis. Set to null for auto.

    ymin number

    For x-y scatterplots, min value for the Y-axis. Set to null for auto.

    type str

    Chart Type. line refers to the Line Plot, scatter to the Point Plot, stacked-area to the Stacked Area plot, table to the Tabular View, scatterplot-xy to Scatter Plot, markdown-widget to the Markdown display, and sparkline to the Single Stat view. Valid options are line, scatterplot, stacked-area, stacked-column, table, scatterplot-xy, markdown-widget, sparkline, globe, nodemap, top-k, status-list, and histogram.

    auto_column_tags bool

    This setting is deprecated.

    column_tags str

    This setting is deprecated.

    custom_tags Sequence[str]

    For the tabular view, a list of point tags to display when using the custom tag display mode.

    expected_data_spacing int

    Threshold (in seconds) for time delta between consecutive points in a series above which a dotted line will replace a solid in in line plots. Default is 60.

    fixed_legend_display_stats Sequence[str]

    For a chart with a fixed legend, a list of statistics to display in the legend.

    fixed_legend_enabled bool

    Whether to enable a fixed tabular legend adjacent to the chart.

    fixed_legend_filter_field str

    Statistic to use for determining whether a series is displayed on the fixed legend. Valid options are CURRENT, MEAN, MEDIAN, SUM, MIN, MAX, and COUNT.

    fixed_legend_filter_limit int

    Number of series to include in the fixed legend.

    fixed_legend_filter_sort str

    Whether to display TOP or BOTTOM ranked series in a fixed legend. Valid options are TOP, and BOTTOM.

    fixed_legend_hide_label bool

    This setting is deprecated.

    fixed_legend_position str

    Where the fixed legend should be displayed with respect to the chart. Valid options are RIGHT, TOP, LEFT, BOTTOM.

    fixed_legend_use_raw_stats bool

    If true, the legend uses non-summarized stats instead of summarized.

    group_by_source bool

    For the tabular view, whether to group multi metrics into a single row by a common source. If false, each source is displayed in its own row. if true, multiple metrics for the same host are displayed as different columns in the same row.

    invert_dynamic_legend_hover_control bool

    Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed).

    line_type str

    Plot interpolation type. linear is default. Valid options are linear, step-before, step-after, basis, cardinal, and monotone.

    max float

    Max value of the Y-axis. Set to null or leave blank for auto.

    min float

    Min value of the Y-axis. Set to null or leave blank for auto.

    num_tags int

    For the tabular view defines how many point tags to display.

    plain_markdown_content str

    The markdown content for a Markdown display, in plain text.

    show_hosts bool

    For the tabular view, whether to display sources. Default is true.

    show_labels bool

    For the tabular view, whether to display labels. Default is true.

    show_raw_values bool

    For the tabular view, whether to display raw values. Default is false.

    sort_values_descending bool

    For the tabular view, whether to display values in descending order. Default is false.

    sparkline_decimal_precision int

    For the single stat view, the decimal precision of the displayed number.

    sparkline_display_color str

    For the single stat view, the color of the displayed text (when not dynamically determined). Values should be in rgba(,,,,) format.

    sparkline_display_font_size str

    For the single stat view, the font size of the displayed text, in percent.

    sparkline_display_horizontal_position str

    For the single stat view, the horizontal position of the displayed text. Valid options are MIDDLE, LEFT, RIGHT.

    sparkline_display_postfix str

    For the single stat view, a string to append to the displayed text.

    sparkline_display_prefix str

    For the single stat view, a string to add before the displayed text.

    sparkline_display_value_type str

    For the single stat view, where to display the name of the query or the value of the query. Valid options are VALUE or LABEL.

    sparkline_display_vertical_position str

    This setting is deprecated.

    sparkline_fill_color str

    For the single stat view, the color of the background fill. Values should be in rgba(,,,,).

    sparkline_line_color str

    For the single stat view, the color of the line. Values should be in rgba(,,,,) format.

    sparkline_size str

    For the single stat view, this determines whether the sparkline of the statistic is displayed in the chart. Valid options are BACKGROUND, BOTTOM, NONE.

    sparkline_value_color_map_apply_to str

    For the single stat view, whether to apply dynamic color settings to the displayed TEXT or BACKGROUND. Valid options are TEXT or BACKGROUND.

    sparkline_value_color_map_colors Sequence[str]

    For the single stat view, A list of colors that differing query values map to. Must contain one more element than sparkline_value_color_map_values_v2. Values should be in rgba(,,,,).

    sparkline_value_color_map_values Sequence[int]

    This setting is deprecated.

    sparkline_value_color_map_values_v2s Sequence[float]

    For the single stat view, a list of boundaries for mapping different query values to colors. Must contain one element less than sparkline_value_color_map_colors.

    sparkline_value_text_map_texts Sequence[str]

    For the single stat view, a list of display text values that different query values map to. Must contain one more element than sparkline_value_text_map_thresholds.

    sparkline_value_text_map_thresholds Sequence[float]

    For the single stat view, a list of threshold boundaries for mapping different query values to display text. Must contain one element less than sparkline_value_text_map_text.

    stack_type str

    Type of stacked chart (applicable only if chart type is stacked). zero (default) means stacked from y=0. expand means normalized from 0 to 1. wiggle means minimize weighted changes. silhouette means to center the stream. Valid options are zero, expand, wiggle, silhouette, and bars.

    tag_mode str

    For the tabular view, which mode to use to determine which point tags to display. Valid options are all, top, or custom.

    time_based_coloring bool

    For x-y scatterplots, whether to color more recent points as darker than older points.

    window_size int

    Width, in minutes, of the time window to use for last windowing.

    windowing str

    For the tabular view, whether to use the full time window for the query or the last X minutes. Valid options are full or last.

    xmax float

    For x-y scatterplots, max value for the X-axis. Set to null for auto.

    xmin float

    For x-y scatterplots, min value for the X-axis. Set to null for auto.

    y0_scale_si_by1024 bool

    Whether to scale numerical magnitude labels for left Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI).

    y0_unit_autoscaling bool

    Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units.

    y1_scale_si_by1024 bool

    Whether to scale numerical magnitude labels for right Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI).

    y1_unit_autoscaling bool

    Whether to automatically adjust magnitude labels and units for the right Y-axis to favor smaller magnitudes and larger units.

    y1_units str

    For plots with multiple Y-axes, units for right side Y-axis.

    y1max float

    For plots with multiple Y-axes, max value for the right side Y-axis. Set null for auto.

    y1min float

    For plots with multiple Y-axes, min value for the right side Y-axis. Set null for auto.

    ymax float

    For x-y scatterplots, max value for the Y-axis. Set to null for auto.

    ymin float

    For x-y scatterplots, min value for the Y-axis. Set to null for auto.

    type String

    Chart Type. line refers to the Line Plot, scatter to the Point Plot, stacked-area to the Stacked Area plot, table to the Tabular View, scatterplot-xy to Scatter Plot, markdown-widget to the Markdown display, and sparkline to the Single Stat view. Valid options are line, scatterplot, stacked-area, stacked-column, table, scatterplot-xy, markdown-widget, sparkline, globe, nodemap, top-k, status-list, and histogram.

    autoColumnTags Boolean

    This setting is deprecated.

    columnTags String

    This setting is deprecated.

    customTags List<String>

    For the tabular view, a list of point tags to display when using the custom tag display mode.

    expectedDataSpacing Number

    Threshold (in seconds) for time delta between consecutive points in a series above which a dotted line will replace a solid in in line plots. Default is 60.

    fixedLegendDisplayStats List<String>

    For a chart with a fixed legend, a list of statistics to display in the legend.

    fixedLegendEnabled Boolean

    Whether to enable a fixed tabular legend adjacent to the chart.

    fixedLegendFilterField String

    Statistic to use for determining whether a series is displayed on the fixed legend. Valid options are CURRENT, MEAN, MEDIAN, SUM, MIN, MAX, and COUNT.

    fixedLegendFilterLimit Number

    Number of series to include in the fixed legend.

    fixedLegendFilterSort String

    Whether to display TOP or BOTTOM ranked series in a fixed legend. Valid options are TOP, and BOTTOM.

    fixedLegendHideLabel Boolean

    This setting is deprecated.

    fixedLegendPosition String

    Where the fixed legend should be displayed with respect to the chart. Valid options are RIGHT, TOP, LEFT, BOTTOM.

    fixedLegendUseRawStats Boolean

    If true, the legend uses non-summarized stats instead of summarized.

    groupBySource Boolean

    For the tabular view, whether to group multi metrics into a single row by a common source. If false, each source is displayed in its own row. if true, multiple metrics for the same host are displayed as different columns in the same row.

    invertDynamicLegendHoverControl Boolean

    Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed).

    lineType String

    Plot interpolation type. linear is default. Valid options are linear, step-before, step-after, basis, cardinal, and monotone.

    max Number

    Max value of the Y-axis. Set to null or leave blank for auto.

    min Number

    Min value of the Y-axis. Set to null or leave blank for auto.

    numTags Number

    For the tabular view defines how many point tags to display.

    plainMarkdownContent String

    The markdown content for a Markdown display, in plain text.

    showHosts Boolean

    For the tabular view, whether to display sources. Default is true.

    showLabels Boolean

    For the tabular view, whether to display labels. Default is true.

    showRawValues Boolean

    For the tabular view, whether to display raw values. Default is false.

    sortValuesDescending Boolean

    For the tabular view, whether to display values in descending order. Default is false.

    sparklineDecimalPrecision Number

    For the single stat view, the decimal precision of the displayed number.

    sparklineDisplayColor String

    For the single stat view, the color of the displayed text (when not dynamically determined). Values should be in rgba(,,,,) format.

    sparklineDisplayFontSize String

    For the single stat view, the font size of the displayed text, in percent.

    sparklineDisplayHorizontalPosition String

    For the single stat view, the horizontal position of the displayed text. Valid options are MIDDLE, LEFT, RIGHT.

    sparklineDisplayPostfix String

    For the single stat view, a string to append to the displayed text.

    sparklineDisplayPrefix String

    For the single stat view, a string to add before the displayed text.

    sparklineDisplayValueType String

    For the single stat view, where to display the name of the query or the value of the query. Valid options are VALUE or LABEL.

    sparklineDisplayVerticalPosition String

    This setting is deprecated.

    sparklineFillColor String

    For the single stat view, the color of the background fill. Values should be in rgba(,,,,).

    sparklineLineColor String

    For the single stat view, the color of the line. Values should be in rgba(,,,,) format.

    sparklineSize String

    For the single stat view, this determines whether the sparkline of the statistic is displayed in the chart. Valid options are BACKGROUND, BOTTOM, NONE.

    sparklineValueColorMapApplyTo String

    For the single stat view, whether to apply dynamic color settings to the displayed TEXT or BACKGROUND. Valid options are TEXT or BACKGROUND.

    sparklineValueColorMapColors List<String>

    For the single stat view, A list of colors that differing query values map to. Must contain one more element than sparkline_value_color_map_values_v2. Values should be in rgba(,,,,).

    sparklineValueColorMapValues List<Number>

    This setting is deprecated.

    sparklineValueColorMapValuesV2s List<Number>

    For the single stat view, a list of boundaries for mapping different query values to colors. Must contain one element less than sparkline_value_color_map_colors.

    sparklineValueTextMapTexts List<String>

    For the single stat view, a list of display text values that different query values map to. Must contain one more element than sparkline_value_text_map_thresholds.

    sparklineValueTextMapThresholds List<Number>

    For the single stat view, a list of threshold boundaries for mapping different query values to display text. Must contain one element less than sparkline_value_text_map_text.

    stackType String

    Type of stacked chart (applicable only if chart type is stacked). zero (default) means stacked from y=0. expand means normalized from 0 to 1. wiggle means minimize weighted changes. silhouette means to center the stream. Valid options are zero, expand, wiggle, silhouette, and bars.

    tagMode String

    For the tabular view, which mode to use to determine which point tags to display. Valid options are all, top, or custom.

    timeBasedColoring Boolean

    For x-y scatterplots, whether to color more recent points as darker than older points.

    windowSize Number

    Width, in minutes, of the time window to use for last windowing.

    windowing String

    For the tabular view, whether to use the full time window for the query or the last X minutes. Valid options are full or last.

    xmax Number

    For x-y scatterplots, max value for the X-axis. Set to null for auto.

    xmin Number

    For x-y scatterplots, min value for the X-axis. Set to null for auto.

    y0ScaleSiBy1024 Boolean

    Whether to scale numerical magnitude labels for left Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI).

    y0UnitAutoscaling Boolean

    Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units.

    y1ScaleSiBy1024 Boolean

    Whether to scale numerical magnitude labels for right Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI).

    y1UnitAutoscaling Boolean

    Whether to automatically adjust magnitude labels and units for the right Y-axis to favor smaller magnitudes and larger units.

    y1Units String

    For plots with multiple Y-axes, units for right side Y-axis.

    y1max Number

    For plots with multiple Y-axes, max value for the right side Y-axis. Set null for auto.

    y1min Number

    For plots with multiple Y-axes, min value for the right side Y-axis. Set null for auto.

    ymax Number

    For x-y scatterplots, max value for the Y-axis. Set to null for auto.

    ymin Number

    For x-y scatterplots, min value for the Y-axis. Set to null for auto.

    DashboardSectionRowChartSource

    Name string

    Name of the source.

    Query string

    Query expression to plot on the chart.

    Disabled bool

    Whether the source is disabled.

    QueryBuilderEnabled bool

    Whether or not this source line should have the query builder enabled.

    ScatterPlotSource string

    For scatter plots, does this query source the X-axis or the Y-axis, X, or Y.

    SourceDescription string

    A description for the purpose of this source.

    Name string

    Name of the source.

    Query string

    Query expression to plot on the chart.

    Disabled bool

    Whether the source is disabled.

    QueryBuilderEnabled bool

    Whether or not this source line should have the query builder enabled.

    ScatterPlotSource string

    For scatter plots, does this query source the X-axis or the Y-axis, X, or Y.

    SourceDescription string

    A description for the purpose of this source.

    name String

    Name of the source.

    query String

    Query expression to plot on the chart.

    disabled Boolean

    Whether the source is disabled.

    queryBuilderEnabled Boolean

    Whether or not this source line should have the query builder enabled.

    scatterPlotSource String

    For scatter plots, does this query source the X-axis or the Y-axis, X, or Y.

    sourceDescription String

    A description for the purpose of this source.

    name string

    Name of the source.

    query string

    Query expression to plot on the chart.

    disabled boolean

    Whether the source is disabled.

    queryBuilderEnabled boolean

    Whether or not this source line should have the query builder enabled.

    scatterPlotSource string

    For scatter plots, does this query source the X-axis or the Y-axis, X, or Y.

    sourceDescription string

    A description for the purpose of this source.

    name str

    Name of the source.

    query str

    Query expression to plot on the chart.

    disabled bool

    Whether the source is disabled.

    query_builder_enabled bool

    Whether or not this source line should have the query builder enabled.

    scatter_plot_source str

    For scatter plots, does this query source the X-axis or the Y-axis, X, or Y.

    source_description str

    A description for the purpose of this source.

    name String

    Name of the source.

    query String

    Query expression to plot on the chart.

    disabled Boolean

    Whether the source is disabled.

    queryBuilderEnabled Boolean

    Whether or not this source line should have the query builder enabled.

    scatterPlotSource String

    For scatter plots, does this query source the X-axis or the Y-axis, X, or Y.

    sourceDescription String

    A description for the purpose of this source.

    Import

    Dashboards can be imported by using the id, e.g.

     $ pulumi import wavefront:index/dashboard:Dashboard dashboard tftestimport
    

    Package Details

    Repository
    Wavefront pulumi/pulumi-wavefront
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the wavefront Terraform Provider.

    wavefront logo
    Wavefront v1.4.0 published on Friday, May 19, 2023 by Pulumi