1. Pulumi Registry
  2. SignalFx
  3. API Docs
  4. DashboardGroup
signalfx logo
SignalFx v5.7.0, Jan 18 23

signalfx.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 System.Collections.Generic;
using Pulumi;
using SignalFx = Pulumi.SignalFx;

return await Deployment.RunAsync(() => 
{
    var mydashboardgroup0 = new SignalFx.DashboardGroup("mydashboardgroup0", new()
    {
        Description = "Cool dashboard group",
        AuthorizedWriterTeams = new[]
        {
            signalfx_team.Mycoolteam.Id,
        },
        AuthorizedWriterUsers = new[]
        {
            "abc123",
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-signalfx/sdk/v5/go/signalfx"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := signalfx.NewDashboardGroup(ctx, "mydashboardgroup0", &signalfx.DashboardGroupArgs{
			Description: pulumi.String("Cool dashboard group"),
			AuthorizedWriterTeams: pulumi.StringArray{
				signalfx_team.Mycoolteam.Id,
			},
			AuthorizedWriterUsers: pulumi.StringArray{
				pulumi.String("abc123"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.signalfx.DashboardGroup;
import com.pulumi.signalfx.DashboardGroupArgs;
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 mydashboardgroup0 = new DashboardGroup("mydashboardgroup0", DashboardGroupArgs.builder()        
            .description("Cool dashboard group")
            .authorizedWriterTeams(signalfx_team.mycoolteam().id())
            .authorizedWriterUsers("abc123")
            .build());

    }
}

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"],
});

resources:
  mydashboardgroup0:
    type: signalfx:DashboardGroup
    properties:
      description: Cool dashboard group
      # Note that if you use these features, you must use a user's
      #   # admin key to authenticate the provider, lest Terraform not be able
      #   # to modify the dashboard group in the future!
      authorizedWriterTeams:
        - ${signalfx_team.mycoolteam.id}
      authorizedWriterUsers:
        - abc123

With Permissions

using System.Collections.Generic;
using Pulumi;
using SignalFx = Pulumi.SignalFx;

return await Deployment.RunAsync(() => 
{
    var mydashboardgroupWithpermissions = new SignalFx.DashboardGroup("mydashboardgroupWithpermissions", new()
    {
        Description = "Cool dashboard group",
        Permissions = new[]
        {
            new SignalFx.Inputs.DashboardGroupPermissionArgs
            {
                Actions = new[]
                {
                    "READ",
                },
                PrincipalId = "abc123",
                PrincipalType = "ORG",
            },
            new SignalFx.Inputs.DashboardGroupPermissionArgs
            {
                Actions = new[]
                {
                    "READ",
                    "WRITE",
                },
                PrincipalId = "abc456",
                PrincipalType = "USER",
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-signalfx/sdk/v5/go/signalfx"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := signalfx.NewDashboardGroup(ctx, "mydashboardgroupWithpermissions", &signalfx.DashboardGroupArgs{
			Description: pulumi.String("Cool dashboard group"),
			Permissions: signalfx.DashboardGroupPermissionArray{
				&signalfx.DashboardGroupPermissionArgs{
					Actions: pulumi.StringArray{
						pulumi.String("READ"),
					},
					PrincipalId:   pulumi.String("abc123"),
					PrincipalType: pulumi.String("ORG"),
				},
				&signalfx.DashboardGroupPermissionArgs{
					Actions: pulumi.StringArray{
						pulumi.String("READ"),
						pulumi.String("WRITE"),
					},
					PrincipalId:   pulumi.String("abc456"),
					PrincipalType: pulumi.String("USER"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.signalfx.DashboardGroup;
import com.pulumi.signalfx.DashboardGroupArgs;
import com.pulumi.signalfx.inputs.DashboardGroupPermissionArgs;
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 mydashboardgroupWithpermissions = new DashboardGroup("mydashboardgroupWithpermissions", DashboardGroupArgs.builder()        
            .description("Cool dashboard group")
            .permissions(            
                DashboardGroupPermissionArgs.builder()
                    .actions("READ")
                    .principalId("abc123")
                    .principalType("ORG")
                    .build(),
                DashboardGroupPermissionArgs.builder()
                    .actions(                    
                        "READ",
                        "WRITE")
                    .principalId("abc456")
                    .principalType("USER")
                    .build())
            .build());

    }
}

import pulumi
import pulumi_signalfx as signalfx

mydashboardgroup_withpermissions = signalfx.DashboardGroup("mydashboardgroupWithpermissions",
    description="Cool dashboard group",
    permissions=[
        signalfx.DashboardGroupPermissionArgs(
            actions=["READ"],
            principal_id="abc123",
            principal_type="ORG",
        ),
        signalfx.DashboardGroupPermissionArgs(
            actions=[
                "READ",
                "WRITE",
            ],
            principal_id="abc456",
            principal_type="USER",
        ),
    ])

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

const mydashboardgroupWithpermissions = new signalfx.DashboardGroup("mydashboardgroupWithpermissions", {
    description: "Cool dashboard group",
    permissions: [
        {
            actions: ["READ"],
            principalId: "abc123",
            principalType: "ORG",
        },
        {
            actions: [
                "READ",
                "WRITE",
            ],
            principalId: "abc456",
            principalType: "USER",
        },
    ],
});

resources:
  mydashboardgroupWithpermissions:
    type: signalfx:DashboardGroup
    properties:
      description: Cool dashboard group
      permissions:
        - actions:
            - READ
          principalId: abc123
          principalType: ORG
        - actions:
            - READ
            - WRITE
          principalId: abc456
          principalType: USER

With Mirrored Dashboards

using System.Collections.Generic;
using Pulumi;
using SignalFx = Pulumi.SignalFx;

return await Deployment.RunAsync(() => 
{
    var mydashboardgroupWithmirrors = new SignalFx.DashboardGroup("mydashboardgroupWithmirrors", new()
    {
        Description = "Cool dashboard group",
        Dashboards = new[]
        {
            new SignalFx.Inputs.DashboardGroupDashboardArgs
            {
                DashboardId = signalfx_dashboard.Gc_dashboard.Id,
                NameOverride = "GC For My Service",
                DescriptionOverride = "Garbage Collection dashboard maintained by JVM team",
                FilterOverrides = new[]
                {
                    new SignalFx.Inputs.DashboardGroupDashboardFilterOverrideArgs
                    {
                        Property = "service",
                        Values = new[]
                        {
                            "myservice",
                        },
                        Negated = false,
                    },
                },
                VariableOverrides = new[]
                {
                    new SignalFx.Inputs.DashboardGroupDashboardVariableOverrideArgs
                    {
                        Property = "region",
                        Values = new[]
                        {
                            "us-west1",
                        },
                        ValuesSuggesteds = new[]
                        {
                            "us-west-1",
                            "us-east-1",
                        },
                    },
                },
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-signalfx/sdk/v5/go/signalfx"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := signalfx.NewDashboardGroup(ctx, "mydashboardgroupWithmirrors", &signalfx.DashboardGroupArgs{
			Description: pulumi.String("Cool dashboard group"),
			Dashboards: signalfx.DashboardGroupDashboardArray{
				&signalfx.DashboardGroupDashboardArgs{
					DashboardId:         pulumi.Any(signalfx_dashboard.Gc_dashboard.Id),
					NameOverride:        pulumi.String("GC For My Service"),
					DescriptionOverride: pulumi.String("Garbage Collection dashboard maintained by JVM team"),
					FilterOverrides: signalfx.DashboardGroupDashboardFilterOverrideArray{
						&signalfx.DashboardGroupDashboardFilterOverrideArgs{
							Property: pulumi.String("service"),
							Values: pulumi.StringArray{
								pulumi.String("myservice"),
							},
							Negated: pulumi.Bool(false),
						},
					},
					VariableOverrides: signalfx.DashboardGroupDashboardVariableOverrideArray{
						&signalfx.DashboardGroupDashboardVariableOverrideArgs{
							Property: pulumi.String("region"),
							Values: pulumi.StringArray{
								pulumi.String("us-west1"),
							},
							ValuesSuggesteds: pulumi.StringArray{
								pulumi.String("us-west-1"),
								pulumi.String("us-east-1"),
							},
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.signalfx.DashboardGroup;
import com.pulumi.signalfx.DashboardGroupArgs;
import com.pulumi.signalfx.inputs.DashboardGroupDashboardArgs;
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 mydashboardgroupWithmirrors = new DashboardGroup("mydashboardgroupWithmirrors", DashboardGroupArgs.builder()        
            .description("Cool dashboard group")
            .dashboards(DashboardGroupDashboardArgs.builder()
                .dashboardId(signalfx_dashboard.gc_dashboard().id())
                .nameOverride("GC For My Service")
                .descriptionOverride("Garbage Collection dashboard maintained by JVM team")
                .filterOverrides(DashboardGroupDashboardFilterOverrideArgs.builder()
                    .property("service")
                    .values("myservice")
                    .negated(false)
                    .build())
                .variableOverrides(DashboardGroupDashboardVariableOverrideArgs.builder()
                    .property("region")
                    .values("us-west1")
                    .valuesSuggesteds(                    
                        "us-west-1",
                        "us-east-1")
                    .build())
                .build())
            .build());

    }
}

import pulumi
import pulumi_signalfx as signalfx

mydashboardgroup_withmirrors = signalfx.DashboardGroup("mydashboardgroupWithmirrors",
    description="Cool dashboard group",
    dashboards=[signalfx.DashboardGroupDashboardArgs(
        dashboard_id=signalfx_dashboard["gc_dashboard"]["id"],
        name_override="GC For My Service",
        description_override="Garbage Collection dashboard maintained by JVM team",
        filter_overrides=[signalfx.DashboardGroupDashboardFilterOverrideArgs(
            property="service",
            values=["myservice"],
            negated=False,
        )],
        variable_overrides=[signalfx.DashboardGroupDashboardVariableOverrideArgs(
            property="region",
            values=["us-west1"],
            values_suggesteds=[
                "us-west-1",
                "us-east-1",
            ],
        )],
    )])

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

const mydashboardgroupWithmirrors = new signalfx.DashboardGroup("mydashboardgroupWithmirrors", {
    description: "Cool dashboard group",
    dashboards: [{
        dashboardId: signalfx_dashboard.gc_dashboard.id,
        nameOverride: "GC For My Service",
        descriptionOverride: "Garbage Collection dashboard maintained by JVM team",
        filterOverrides: [{
            property: "service",
            values: ["myservice"],
            negated: false,
        }],
        variableOverrides: [{
            property: "region",
            values: ["us-west1"],
            valuesSuggesteds: [
                "us-west-1",
                "us-east-1",
            ],
        }],
    }],
});

resources:
  mydashboardgroupWithmirrors:
    type: signalfx:DashboardGroup
    properties:
      description: Cool dashboard group
      # You can add as many of these as you like. Make sure your account
      #   // supports this feature!
      dashboards:
        - dashboardId: ${signalfx_dashboard.gc_dashboard.id}
          nameOverride: GC For My Service
          descriptionOverride: Garbage Collection dashboard maintained by JVM team
          filterOverrides:
            - property: service
              values:
                - myservice
              negated: false
          variableOverrides:
            - property: region
              values:
                - us-west1
              valuesSuggesteds:
                - us-west-1
                - us-east-1

Create DashboardGroup Resource

new DashboardGroup(name: string, args?: DashboardGroupArgs, opts?: CustomResourceOptions);
@overload
def DashboardGroup(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   authorized_writer_teams: Optional[Sequence[str]] = None,
                   authorized_writer_users: Optional[Sequence[str]] = None,
                   dashboards: Optional[Sequence[DashboardGroupDashboardArgs]] = None,
                   description: Optional[str] = None,
                   import_qualifiers: Optional[Sequence[DashboardGroupImportQualifierArgs]] = None,
                   name: Optional[str] = None,
                   permissions: Optional[Sequence[DashboardGroupPermissionArgs]] = None,
                   teams: Optional[Sequence[str]] = None)
@overload
def DashboardGroup(resource_name: str,
                   args: Optional[DashboardGroupArgs] = None,
                   opts: Optional[ResourceOptions] = None)
func NewDashboardGroup(ctx *Context, name string, args *DashboardGroupArgs, opts ...ResourceOption) (*DashboardGroup, error)
public DashboardGroup(string name, DashboardGroupArgs? args = null, CustomResourceOptions? opts = null)
public DashboardGroup(String name, DashboardGroupArgs args)
public DashboardGroup(String name, DashboardGroupArgs args, CustomResourceOptions options)

type: signalfx:DashboardGroup
properties: # The arguments to resource properties.
options: # 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.
resource_name str
The unique name of the resource.
args DashboardGroupArgs
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 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.
name String
The unique name of the resource.
args DashboardGroupArgs
The arguments to resource properties.
options 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 Architecture and Concepts 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). Note: Deprecated use permissions instead.

Deprecated:

Please use permissions field now

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). Note: Deprecated use permissions instead.

Deprecated:

Please use permissions field now

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.

Permissions List<Pulumi.SignalFx.Inputs.DashboardGroupPermissionArgs>

Permissions List of read and write permission configuration to specify which user, team, and organization can view and/or edit your dashboard group. Note: This feature is not present in all accounts. Please contact support if you are unsure.

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). Note: Deprecated use permissions instead.

Deprecated:

Please use permissions field now

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). Note: Deprecated use permissions instead.

Deprecated:

Please use permissions field now

Dashboards []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 []DashboardGroupImportQualifierArgs
Name string

Name of the dashboard group.

Permissions []DashboardGroupPermissionArgs

Permissions List of read and write permission configuration to specify which user, team, and organization can view and/or edit your dashboard group. Note: This feature is not present in all accounts. Please contact support if you are unsure.

Teams []string

Team IDs to associate the dashboard group to.

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). Note: Deprecated use permissions instead.

Deprecated:

Please use permissions field now

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). Note: Deprecated use permissions instead.

Deprecated:

Please use permissions field now

dashboards List<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<DashboardGroupImportQualifierArgs>
name String

Name of the dashboard group.

permissions List<DashboardGroupPermissionArgs>

Permissions List of read and write permission configuration to specify which user, team, and organization can view and/or edit your dashboard group. Note: This feature is not present in all accounts. Please contact support if you are unsure.

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). Note: Deprecated use permissions instead.

Deprecated:

Please use permissions field now

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). Note: Deprecated use permissions instead.

Deprecated:

Please use permissions field now

dashboards 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 DashboardGroupImportQualifierArgs[]
name string

Name of the dashboard group.

permissions DashboardGroupPermissionArgs[]

Permissions List of read and write permission configuration to specify which user, team, and organization can view and/or edit your dashboard group. Note: This feature is not present in all accounts. Please contact support if you are unsure.

teams string[]

Team IDs to associate the dashboard group to.

authorized_writer_teams Sequence[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). Note: Deprecated use permissions instead.

Deprecated:

Please use permissions field now

authorized_writer_users Sequence[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). Note: Deprecated use permissions instead.

Deprecated:

Please use permissions field now

dashboards Sequence[DashboardGroupDashboardArgs]

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 Sequence[DashboardGroupImportQualifierArgs]
name str

Name of the dashboard group.

permissions Sequence[DashboardGroupPermissionArgs]

Permissions List of read and write permission configuration to specify which user, team, and organization can view and/or edit your dashboard group. Note: This feature is not present in all accounts. Please contact support if you are unsure.

teams Sequence[str]

Team IDs to associate the dashboard group to.

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). Note: Deprecated use permissions instead.

Deprecated:

Please use permissions field now

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). Note: Deprecated use permissions instead.

Deprecated:

Please use permissions field now

dashboards List<Property Map>

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<Property Map>
name String

Name of the dashboard group.

permissions List<Property Map>

Permissions List of read and write permission configuration to specify which user, team, and organization can view and/or edit your dashboard group. Note: This feature is not present in all accounts. Please contact support if you are unsure.

teams List<String>

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 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 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
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authorized_writer_teams: Optional[Sequence[str]] = None,
        authorized_writer_users: Optional[Sequence[str]] = None,
        dashboards: Optional[Sequence[DashboardGroupDashboardArgs]] = None,
        description: Optional[str] = None,
        import_qualifiers: Optional[Sequence[DashboardGroupImportQualifierArgs]] = None,
        name: Optional[str] = None,
        permissions: Optional[Sequence[DashboardGroupPermissionArgs]] = None,
        teams: Optional[Sequence[str]] = None) -> DashboardGroup
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)
public static DashboardGroup get(String name, Output<String> id, DashboardGroupState 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:
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). Note: Deprecated use permissions instead.

Deprecated:

Please use permissions field now

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). Note: Deprecated use permissions instead.

Deprecated:

Please use permissions field now

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.

Permissions List<Pulumi.SignalFx.Inputs.DashboardGroupPermissionArgs>

Permissions List of read and write permission configuration to specify which user, team, and organization can view and/or edit your dashboard group. Note: This feature is not present in all accounts. Please contact support if you are unsure.

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). Note: Deprecated use permissions instead.

Deprecated:

Please use permissions field now

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). Note: Deprecated use permissions instead.

Deprecated:

Please use permissions field now

Dashboards []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 []DashboardGroupImportQualifierArgs
Name string

Name of the dashboard group.

Permissions []DashboardGroupPermissionArgs

Permissions List of read and write permission configuration to specify which user, team, and organization can view and/or edit your dashboard group. Note: This feature is not present in all accounts. Please contact support if you are unsure.

Teams []string

Team IDs to associate the dashboard group to.

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). Note: Deprecated use permissions instead.

Deprecated:

Please use permissions field now

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). Note: Deprecated use permissions instead.

Deprecated:

Please use permissions field now

dashboards List<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<DashboardGroupImportQualifierArgs>
name String

Name of the dashboard group.

permissions List<DashboardGroupPermissionArgs>

Permissions List of read and write permission configuration to specify which user, team, and organization can view and/or edit your dashboard group. Note: This feature is not present in all accounts. Please contact support if you are unsure.

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). Note: Deprecated use permissions instead.

Deprecated:

Please use permissions field now

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). Note: Deprecated use permissions instead.

Deprecated:

Please use permissions field now

dashboards 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 DashboardGroupImportQualifierArgs[]
name string

Name of the dashboard group.

permissions DashboardGroupPermissionArgs[]

Permissions List of read and write permission configuration to specify which user, team, and organization can view and/or edit your dashboard group. Note: This feature is not present in all accounts. Please contact support if you are unsure.

teams string[]

Team IDs to associate the dashboard group to.

authorized_writer_teams Sequence[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). Note: Deprecated use permissions instead.

Deprecated:

Please use permissions field now

authorized_writer_users Sequence[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). Note: Deprecated use permissions instead.

Deprecated:

Please use permissions field now

dashboards Sequence[DashboardGroupDashboardArgs]

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 Sequence[DashboardGroupImportQualifierArgs]
name str

Name of the dashboard group.

permissions Sequence[DashboardGroupPermissionArgs]

Permissions List of read and write permission configuration to specify which user, team, and organization can view and/or edit your dashboard group. Note: This feature is not present in all accounts. Please contact support if you are unsure.

teams Sequence[str]

Team IDs to associate the dashboard group to.

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). Note: Deprecated use permissions instead.

Deprecated:

Please use permissions field now

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). Note: Deprecated use permissions instead.

Deprecated:

Please use permissions field now

dashboards List<Property Map>

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<Property Map>
name String

Name of the dashboard group.

permissions List<Property Map>

Permissions List of read and write permission configuration to specify which user, team, and organization can view and/or edit your dashboard group. Note: This feature is not present in all accounts. Please contact support if you are unsure.

teams List<String>

Team IDs to associate the dashboard group to.

Supporting Types

DashboardGroupDashboard

DashboardId string

The dashboard id to mirror

ConfigId string
DescriptionOverride string

The description that will override the original dashboards's description.

FilterOverrides List<Pulumi.SignalFx.Inputs.DashboardGroupDashboardFilterOverride>

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.DashboardGroupDashboardVariableOverride>
DashboardId string

The dashboard id to mirror

ConfigId string
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

configId String
descriptionOverride String

The description that will override the original dashboards's description.

filterOverrides List<DashboardGroupDashboardFilterOverride>

The description that will override the original dashboards's description.

nameOverride String

The name that will override the original dashboards's name.

variableOverrides List<DashboardGroupDashboardVariableOverride>
dashboardId string

The dashboard id to mirror

configId string
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[]
dashboard_id str

The dashboard id to mirror

config_id str
description_override str

The description that will override the original dashboards's description.

filter_overrides Sequence[DashboardGroupDashboardFilterOverride]

The description that will override the original dashboards's description.

name_override str

The name that will override the original dashboards's name.

variable_overrides Sequence[DashboardGroupDashboardVariableOverride]
dashboardId String

The dashboard id to mirror

configId String
descriptionOverride String

The description that will override the original dashboards's description.

filterOverrides List<Property Map>

The description that will override the original dashboards's description.

nameOverride String

The name that will override the original dashboards's name.

variableOverrides List<Property Map>

DashboardGroupDashboardFilterOverride

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 List<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 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 Sequence[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.

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 Boolean

If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.

DashboardGroupDashboardVariableOverride

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 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 str

A metric time series dimension or property name.

values Sequence[str]

(Optional) List of of strings (which will be treated as an OR filter on the property).

values_suggesteds Sequence[str]

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 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.

DashboardGroupImportQualifier

DashboardGroupImportQualifierFilter

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 List<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 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 Sequence[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.

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 Boolean

If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.

DashboardGroupPermission

PrincipalId string

ID of the user, team, or organization for which you're granting permissions.

PrincipalType string

Clarify whether this permission configuration is for a user, a team, or an organization. Value can be one of "USER", "TEAM", or "ORG".

Actions List<string>

Action the user, team, or organization can take with the dashboard group. List of values (value can be "READ" or "WRITE").

PrincipalId string

ID of the user, team, or organization for which you're granting permissions.

PrincipalType string

Clarify whether this permission configuration is for a user, a team, or an organization. Value can be one of "USER", "TEAM", or "ORG".

Actions []string

Action the user, team, or organization can take with the dashboard group. List of values (value can be "READ" or "WRITE").

principalId String

ID of the user, team, or organization for which you're granting permissions.

principalType String

Clarify whether this permission configuration is for a user, a team, or an organization. Value can be one of "USER", "TEAM", or "ORG".

actions List<String>

Action the user, team, or organization can take with the dashboard group. List of values (value can be "READ" or "WRITE").

principalId string

ID of the user, team, or organization for which you're granting permissions.

principalType string

Clarify whether this permission configuration is for a user, a team, or an organization. Value can be one of "USER", "TEAM", or "ORG".

actions string[]

Action the user, team, or organization can take with the dashboard group. List of values (value can be "READ" or "WRITE").

principal_id str

ID of the user, team, or organization for which you're granting permissions.

principal_type str

Clarify whether this permission configuration is for a user, a team, or an organization. Value can be one of "USER", "TEAM", or "ORG".

actions Sequence[str]

Action the user, team, or organization can take with the dashboard group. List of values (value can be "READ" or "WRITE").

principalId String

ID of the user, team, or organization for which you're granting permissions.

principalType String

Clarify whether this permission configuration is for a user, a team, or an organization. Value can be one of "USER", "TEAM", or "ORG".

actions List<String>

Action the user, team, or organization can take with the dashboard group. List of values (value can be "READ" or "WRITE").

Package Details

Repository
SignalFx pulumi/pulumi-signalfx
License
Apache-2.0
Notes

This Pulumi package is based on the signalfx Terraform Provider.