DashboardGroup

In the SignalFx web UI, a dashboard group is a collection of dashboards.

NOTE Dashboard groups cannot be accessed directly, but just via a dashboard contained in them. This is the reason why make show won’t show any of yours dashboard groups.

Example Usage

using Pulumi;
using SignalFx = Pulumi.SignalFx;

class MyStack : Stack
{
    public MyStack()
    {
        var mydashboardgroup0 = new SignalFx.DashboardGroup("mydashboardgroup0", new SignalFx.DashboardGroupArgs
        {
            Description = "Cool dashboard group",
            AuthorizedWriterTeams = 
            {
                signalfx_team.Mycoolteam.Id,
            },
            AuthorizedWriterUsers = 
            {
                "abc123",
            },
        });
    }

}

Coming soon!

import pulumi
import pulumi_signalfx as signalfx

mydashboardgroup0 = signalfx.DashboardGroup("mydashboardgroup0",
    description="Cool dashboard group",
    authorized_writer_teams=[signalfx_team["mycoolteam"]["id"]],
    authorized_writer_users=["abc123"])

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

const mydashboardgroup0 = new signalfx.DashboardGroup("mydashboardgroup0", {
    description: "Cool dashboard group",
    authorizedWriterTeams: [signalfx_team.mycoolteam.id],
    authorizedWriterUsers: ["abc123"],
});

Create a DashboardGroup Resource

new DashboardGroup(name: string, args?: DashboardGroupArgs, opts?: CustomResourceOptions);

def DashboardGroup(resource_name, opts=None, authorized_writer_teams=None, authorized_writer_users=None, dashboards=None, description=None, import_qualifiers=None, name=None, teams=None, __props__=None);

func NewDashboardGroup(ctx *Context, name string, args *DashboardGroupArgs, opts ...ResourceOption) (*DashboardGroup, error)

public DashboardGroup(string name, DashboardGroupArgs? args = null, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args DashboardGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args DashboardGroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DashboardGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

DashboardGroup Resource Properties

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

Inputs

The DashboardGroup resource accepts the following input properties:

AuthorizedWriterTeams List<string>: Team IDs that have write access to this dashboard group. Remember to use an admin’s token if using this feature and to include that admin’s team (or user id in authorized_writer_teams).
AuthorizedWriterUsers List<string>: User IDs that have write access to this dashboard group. Remember to use an admin’s token if using this feature and to include that admin’s user id (or team id in authorized_writer_teams).
Dashboards List<Pulumi.SignalFx.Inputs.DashboardGroupDashboardArgs>: Mirrored dashboards in this dashboard group. Note: This feature is not present in all accounts. Please contact support if you are unsure.
Description string: Description of the dashboard group.
ImportQualifiers List<Pulumi.SignalFx.Inputs.DashboardGroupImportQualifierArgs>
Name string: Name of the dashboard group.
Teams List<string>: Team IDs to associate the dashboard group to.

AuthorizedWriterTeams []string: Team IDs that have write access to this dashboard group. Remember to use an admin’s token if using this feature and to include that admin’s team (or user id in authorized_writer_teams).
AuthorizedWriterUsers []string: User IDs that have write access to this dashboard group. Remember to use an admin’s token if using this feature and to include that admin’s user id (or team id in authorized_writer_teams).
Dashboards []DashboardGroupDashboard: Mirrored dashboards in this dashboard group. Note: This feature is not present in all accounts. Please contact support if you are unsure.
Description string: Description of the dashboard group.
ImportQualifiers []DashboardGroupImportQualifier
Name string: Name of the dashboard group.
Teams []string: Team IDs to associate the dashboard group to.

authorizedWriterTeams string[]: Team IDs that have write access to this dashboard group. Remember to use an admin’s token if using this feature and to include that admin’s team (or user id in authorized_writer_teams).
authorizedWriterUsers string[]: User IDs that have write access to this dashboard group. Remember to use an admin’s token if using this feature and to include that admin’s user id (or team id in authorized_writer_teams).
dashboards DashboardGroupDashboard[]: Mirrored dashboards in this dashboard group. Note: This feature is not present in all accounts. Please contact support if you are unsure.
description string: Description of the dashboard group.
importQualifiers DashboardGroupImportQualifier[]
name string: Name of the dashboard group.
teams string[]: Team IDs to associate the dashboard group to.

authorized_writer_teams List[str]: Team IDs that have write access to this dashboard group. Remember to use an admin’s token if using this feature and to include that admin’s team (or user id in authorized_writer_teams).
authorized_writer_users List[str]: User IDs that have write access to this dashboard group. Remember to use an admin’s token if using this feature and to include that admin’s user id (or team id in authorized_writer_teams).
dashboards List[DashboardGroupDashboard]: Mirrored dashboards in this dashboard group. Note: This feature is not present in all accounts. Please contact support if you are unsure.
description str: Description of the dashboard group.
import_qualifiers List[DashboardGroupImportQualifier]
name str: Name of the dashboard group.
teams List[str]: Team IDs to associate the dashboard group to.

Outputs

All input properties are implicitly available as output properties. Additionally, the DashboardGroup 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 str: The provider-assigned unique ID for this managed resource.

Look up an Existing DashboardGroup Resource

Get an existing DashboardGroup 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?: DashboardGroupState, opts?: CustomResourceOptions): DashboardGroup

static get(resource_name, id, opts=None, authorized_writer_teams=None, authorized_writer_users=None, dashboards=None, description=None, import_qualifiers=None, name=None, teams=None, __props__=None);

func GetDashboardGroup(ctx *Context, name string, id IDInput, state *DashboardGroupState, opts ...ResourceOption) (*DashboardGroup, error)

public static DashboardGroup Get(string name, Input<string> id, DashboardGroupState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AuthorizedWriterTeams List<string>: Team IDs that have write access to this dashboard group. Remember to use an admin’s token if using this feature and to include that admin’s team (or user id in authorized_writer_teams).
AuthorizedWriterUsers List<string>: User IDs that have write access to this dashboard group. Remember to use an admin’s token if using this feature and to include that admin’s user id (or team id in authorized_writer_teams).
Dashboards List<Pulumi.SignalFx.Inputs.DashboardGroupDashboardArgs>: Mirrored dashboards in this dashboard group. Note: This feature is not present in all accounts. Please contact support if you are unsure.
Description string: Description of the dashboard group.
ImportQualifiers List<Pulumi.SignalFx.Inputs.DashboardGroupImportQualifierArgs>
Name string: Name of the dashboard group.
Teams List<string>: Team IDs to associate the dashboard group to.

AuthorizedWriterTeams []string: Team IDs that have write access to this dashboard group. Remember to use an admin’s token if using this feature and to include that admin’s team (or user id in authorized_writer_teams).
AuthorizedWriterUsers []string: User IDs that have write access to this dashboard group. Remember to use an admin’s token if using this feature and to include that admin’s user id (or team id in authorized_writer_teams).
Dashboards []DashboardGroupDashboard: Mirrored dashboards in this dashboard group. Note: This feature is not present in all accounts. Please contact support if you are unsure.
Description string: Description of the dashboard group.
ImportQualifiers []DashboardGroupImportQualifier
Name string: Name of the dashboard group.
Teams []string: Team IDs to associate the dashboard group to.

authorizedWriterTeams string[]: Team IDs that have write access to this dashboard group. Remember to use an admin’s token if using this feature and to include that admin’s team (or user id in authorized_writer_teams).
authorizedWriterUsers string[]: User IDs that have write access to this dashboard group. Remember to use an admin’s token if using this feature and to include that admin’s user id (or team id in authorized_writer_teams).
dashboards DashboardGroupDashboard[]: Mirrored dashboards in this dashboard group. Note: This feature is not present in all accounts. Please contact support if you are unsure.
description string: Description of the dashboard group.
importQualifiers DashboardGroupImportQualifier[]
name string: Name of the dashboard group.
teams string[]: Team IDs to associate the dashboard group to.

authorized_writer_teams List[str]: Team IDs that have write access to this dashboard group. Remember to use an admin’s token if using this feature and to include that admin’s team (or user id in authorized_writer_teams).
authorized_writer_users List[str]: User IDs that have write access to this dashboard group. Remember to use an admin’s token if using this feature and to include that admin’s user id (or team id in authorized_writer_teams).
dashboards List[DashboardGroupDashboard]: Mirrored dashboards in this dashboard group. Note: This feature is not present in all accounts. Please contact support if you are unsure.
description str: Description of the dashboard group.
import_qualifiers List[DashboardGroupImportQualifier]
name str: Name of the dashboard group.
teams List[str]: Team IDs to associate the dashboard group to.

Supporting Types

DashboardGroupDashboard

See the input and output API doc for this type.

DashboardId string: The dashboard id to mirror
DescriptionOverride string: The description that will override the original dashboards’s description.
FilterOverrides List<Pulumi.SignalFx.Inputs.DashboardGroupDashboardFilterOverrideArgs>: The description that will override the original dashboards’s description.
NameOverride string: The name that will override the original dashboards’s name.
VariableOverrides List<Pulumi.SignalFx.Inputs.DashboardGroupDashboardVariableOverrideArgs>

DashboardId string: The dashboard id to mirror
DescriptionOverride string: The description that will override the original dashboards’s description.
FilterOverrides []DashboardGroupDashboardFilterOverride: The description that will override the original dashboards’s description.
NameOverride string: The name that will override the original dashboards’s name.
VariableOverrides []DashboardGroupDashboardVariableOverride

dashboardId string: The dashboard id to mirror
descriptionOverride string: The description that will override the original dashboards’s description.
filterOverrides DashboardGroupDashboardFilterOverride[]: The description that will override the original dashboards’s description.
nameOverride string: The name that will override the original dashboards’s name.
variableOverrides DashboardGroupDashboardVariableOverride[]

dashboardId str: The dashboard id to mirror
descriptionOverride str: The description that will override the original dashboards’s description.
filterOverrides List[DashboardGroupDashboardFilterOverride]: The description that will override the original dashboards’s description.
nameOverride str: The name that will override the original dashboards’s name.
variableOverrides List[DashboardGroupDashboardVariableOverride]

DashboardGroupDashboardFilterOverride

See the input and output API doc for this type.

Property string: A metric time series dimension or property name.
Values List<string>: (Optional) List of of strings (which will be treated as an OR filter on the property).
Negated bool: If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.

Property string: A metric time series dimension or property name.
Values []string: (Optional) List of of strings (which will be treated as an OR filter on the property).
Negated bool: If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.

property string: A metric time series dimension or property name.
values string[]: (Optional) List of of strings (which will be treated as an OR filter on the property).
negated boolean: If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.

property str: A metric time series dimension or property name.
values List[str]: (Optional) List of of strings (which will be treated as an OR filter on the property).
negated bool: If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.

DashboardGroupDashboardVariableOverride

See the input and output API doc for this type.

Property string: A metric time series dimension or property name.
Values List<string>: (Optional) List of of strings (which will be treated as an OR filter on the property).
ValuesSuggesteds List<string>: A list of strings of suggested values for this variable; these suggestions will receive priority when values are autosuggested for this variable.

Property string: A metric time series dimension or property name.
Values []string: (Optional) List of of strings (which will be treated as an OR filter on the property).
ValuesSuggesteds []string: A list of strings of suggested values for this variable; these suggestions will receive priority when values are autosuggested for this variable.

property string: A metric time series dimension or property name.
values string[]: (Optional) List of of strings (which will be treated as an OR filter on the property).
valuesSuggesteds string[]: A list of strings of suggested values for this variable; these suggestions will receive priority when values are autosuggested for this variable.

property str: A metric time series dimension or property name.
values List[str]: (Optional) List of of strings (which will be treated as an OR filter on the property).
valuesSuggesteds List[str]: A list of strings of suggested values for this variable; these suggestions will receive priority when values are autosuggested for this variable.

DashboardGroupImportQualifier

See the input and output API doc for this type.

Metric string
Filters List<Pulumi.SignalFx.Inputs.DashboardGroupImportQualifierFilterArgs>

Metric string
Filters []DashboardGroupImportQualifierFilter

metric string
filters DashboardGroupImportQualifierFilter[]

metric str
filters List[DashboardGroupImportQualifierFilter]

DashboardGroupImportQualifierFilter

See the input and output API doc for this type.

Property string: A metric time series dimension or property name.
Values List<string>: (Optional) List of of strings (which will be treated as an OR filter on the property).
Negated bool: If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.

Property string: A metric time series dimension or property name.
Values []string: (Optional) List of of strings (which will be treated as an OR filter on the property).
Negated bool: If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.

property string: A metric time series dimension or property name.
values string[]: (Optional) List of of strings (which will be treated as an OR filter on the property).
negated boolean: If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.

property str: A metric time series dimension or property name.
values List[str]: (Optional) List of of strings (which will be treated as an OR filter on the property).
negated bool: If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

DashboardGroup

Example Usage

Create a DashboardGroup Resource

DashboardGroup Resource Properties

Inputs

Outputs

Look up an Existing DashboardGroup Resource

Supporting Types

DashboardGroupDashboard

DashboardGroupDashboardFilterOverride

DashboardGroupDashboardVariableOverride

DashboardGroupImportQualifier

DashboardGroupImportQualifierFilter

Package Details

On This Page