signalfx.DashboardGroup
Explore with Pulumi AI
In the Splunk Observability Cloud web UI, a dashboard group is a collection of dashboards.
Dashboard groups cannot be accessed directly. You can access them through a dashboard within a group.
NOTE When you want to change or remove write permissions for a user other than yourself regarding dashboard groups, use a session token of an administrator to authenticate the Splunk Observability Cloud provider. See Operations that require a session token for an administrator.
Example
import * as pulumi from "@pulumi/pulumi";
import * as signalfx from "@pulumi/signalfx";
const mydashboardgroup0 = new signalfx.DashboardGroup("mydashboardgroup0", {
name: "My team dashboard group",
description: "Cool dashboard group",
authorizedWriterTeams: [mycoolteam.id],
authorizedWriterUsers: ["abc123"],
});
import pulumi
import pulumi_signalfx as signalfx
mydashboardgroup0 = signalfx.DashboardGroup("mydashboardgroup0",
name="My team dashboard group",
description="Cool dashboard group",
authorized_writer_teams=[mycoolteam["id"]],
authorized_writer_users=["abc123"])
package main
import (
"github.com/pulumi/pulumi-signalfx/sdk/v7/go/signalfx"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := signalfx.NewDashboardGroup(ctx, "mydashboardgroup0", &signalfx.DashboardGroupArgs{
Name: pulumi.String("My team dashboard group"),
Description: pulumi.String("Cool dashboard group"),
AuthorizedWriterTeams: pulumi.StringArray{
mycoolteam.Id,
},
AuthorizedWriterUsers: pulumi.StringArray{
pulumi.String("abc123"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using SignalFx = Pulumi.SignalFx;
return await Deployment.RunAsync(() =>
{
var mydashboardgroup0 = new SignalFx.DashboardGroup("mydashboardgroup0", new()
{
Name = "My team dashboard group",
Description = "Cool dashboard group",
AuthorizedWriterTeams = new[]
{
mycoolteam.Id,
},
AuthorizedWriterUsers = new[]
{
"abc123",
},
});
});
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()
.name("My team dashboard group")
.description("Cool dashboard group")
.authorizedWriterTeams(mycoolteam.id())
.authorizedWriterUsers("abc123")
.build());
}
}
resources:
mydashboardgroup0:
type: signalfx:DashboardGroup
properties:
name: My team dashboard group
description: Cool dashboard group
authorizedWriterTeams:
- ${mycoolteam.id}
authorizedWriterUsers:
- abc123
Example with permissions
import * as pulumi from "@pulumi/pulumi";
import * as signalfx from "@pulumi/signalfx";
const mydashboardgroupWithpermissions = new signalfx.DashboardGroup("mydashboardgroup_withpermissions", {
name: "My team dashboard group",
description: "Cool dashboard group",
permissions: [
{
principalId: "abc123",
principalType: "ORG",
actions: ["READ"],
},
{
principalId: "abc456",
principalType: "USER",
actions: [
"READ",
"WRITE",
],
},
],
});
import pulumi
import pulumi_signalfx as signalfx
mydashboardgroup_withpermissions = signalfx.DashboardGroup("mydashboardgroup_withpermissions",
name="My team dashboard group",
description="Cool dashboard group",
permissions=[
{
"principal_id": "abc123",
"principal_type": "ORG",
"actions": ["READ"],
},
{
"principal_id": "abc456",
"principal_type": "USER",
"actions": [
"READ",
"WRITE",
],
},
])
package main
import (
"github.com/pulumi/pulumi-signalfx/sdk/v7/go/signalfx"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := signalfx.NewDashboardGroup(ctx, "mydashboardgroup_withpermissions", &signalfx.DashboardGroupArgs{
Name: pulumi.String("My team dashboard group"),
Description: pulumi.String("Cool dashboard group"),
Permissions: signalfx.DashboardGroupPermissionArray{
&signalfx.DashboardGroupPermissionArgs{
PrincipalId: pulumi.String("abc123"),
PrincipalType: pulumi.String("ORG"),
Actions: pulumi.StringArray{
pulumi.String("READ"),
},
},
&signalfx.DashboardGroupPermissionArgs{
PrincipalId: pulumi.String("abc456"),
PrincipalType: pulumi.String("USER"),
Actions: pulumi.StringArray{
pulumi.String("READ"),
pulumi.String("WRITE"),
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using SignalFx = Pulumi.SignalFx;
return await Deployment.RunAsync(() =>
{
var mydashboardgroupWithpermissions = new SignalFx.DashboardGroup("mydashboardgroup_withpermissions", new()
{
Name = "My team dashboard group",
Description = "Cool dashboard group",
Permissions = new[]
{
new SignalFx.Inputs.DashboardGroupPermissionArgs
{
PrincipalId = "abc123",
PrincipalType = "ORG",
Actions = new[]
{
"READ",
},
},
new SignalFx.Inputs.DashboardGroupPermissionArgs
{
PrincipalId = "abc456",
PrincipalType = "USER",
Actions = new[]
{
"READ",
"WRITE",
},
},
},
});
});
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()
.name("My team dashboard group")
.description("Cool dashboard group")
.permissions(
DashboardGroupPermissionArgs.builder()
.principalId("abc123")
.principalType("ORG")
.actions("READ")
.build(),
DashboardGroupPermissionArgs.builder()
.principalId("abc456")
.principalType("USER")
.actions(
"READ",
"WRITE")
.build())
.build());
}
}
resources:
mydashboardgroupWithpermissions:
type: signalfx:DashboardGroup
name: mydashboardgroup_withpermissions
properties:
name: My team dashboard group
description: Cool dashboard group
permissions:
- principalId: abc123
principalType: ORG
actions:
- READ
- principalId: abc456
principalType: USER
actions:
- READ
- WRITE
Example With mirrored dashboards
import * as pulumi from "@pulumi/pulumi";
import * as signalfx from "@pulumi/signalfx";
const mydashboardgroupWithmirrors = new signalfx.DashboardGroup("mydashboardgroup_withmirrors", {
name: "My team dashboard group",
description: "Cool dashboard group",
dashboards: [{
dashboardId: gcDashboard.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",
],
}],
}],
});
import pulumi
import pulumi_signalfx as signalfx
mydashboardgroup_withmirrors = signalfx.DashboardGroup("mydashboardgroup_withmirrors",
name="My team dashboard group",
description="Cool dashboard group",
dashboards=[{
"dashboard_id": gc_dashboard["id"],
"name_override": "GC For My Service",
"description_override": "Garbage Collection dashboard maintained by JVM team",
"filter_overrides": [{
"property": "service",
"values": ["myservice"],
"negated": False,
}],
"variable_overrides": [{
"property": "region",
"values": ["us-west1"],
"values_suggesteds": [
"us-west-1",
"us-east-1",
],
}],
}])
package main
import (
"github.com/pulumi/pulumi-signalfx/sdk/v7/go/signalfx"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := signalfx.NewDashboardGroup(ctx, "mydashboardgroup_withmirrors", &signalfx.DashboardGroupArgs{
Name: pulumi.String("My team dashboard group"),
Description: pulumi.String("Cool dashboard group"),
Dashboards: signalfx.DashboardGroupDashboardArray{
&signalfx.DashboardGroupDashboardArgs{
DashboardId: pulumi.Any(gcDashboard.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
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using SignalFx = Pulumi.SignalFx;
return await Deployment.RunAsync(() =>
{
var mydashboardgroupWithmirrors = new SignalFx.DashboardGroup("mydashboardgroup_withmirrors", new()
{
Name = "My team dashboard group",
Description = "Cool dashboard group",
Dashboards = new[]
{
new SignalFx.Inputs.DashboardGroupDashboardArgs
{
DashboardId = gcDashboard.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 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()
.name("My team dashboard group")
.description("Cool dashboard group")
.dashboards(DashboardGroupDashboardArgs.builder()
.dashboardId(gcDashboard.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());
}
}
resources:
mydashboardgroupWithmirrors:
type: signalfx:DashboardGroup
name: mydashboardgroup_withmirrors
properties:
name: My team dashboard group
description: Cool dashboard group
dashboards:
- dashboardId: ${gcDashboard.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
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DashboardGroup(name: string, args?: DashboardGroupArgs, opts?: CustomResourceOptions);
@overload
def DashboardGroup(resource_name: str,
args: Optional[DashboardGroupArgs] = None,
opts: Optional[ResourceOptions] = None)
@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)
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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var dashboardGroupResource = new SignalFx.DashboardGroup("dashboardGroupResource", new()
{
Dashboards = new[]
{
new SignalFx.Inputs.DashboardGroupDashboardArgs
{
DashboardId = "string",
ConfigId = "string",
DescriptionOverride = "string",
FilterOverrides = new[]
{
new SignalFx.Inputs.DashboardGroupDashboardFilterOverrideArgs
{
Property = "string",
Values = new[]
{
"string",
},
Negated = false,
},
},
NameOverride = "string",
VariableOverrides = new[]
{
new SignalFx.Inputs.DashboardGroupDashboardVariableOverrideArgs
{
Property = "string",
Values = new[]
{
"string",
},
ValuesSuggesteds = new[]
{
"string",
},
},
},
},
},
Description = "string",
ImportQualifiers = new[]
{
new SignalFx.Inputs.DashboardGroupImportQualifierArgs
{
Filters = new[]
{
new SignalFx.Inputs.DashboardGroupImportQualifierFilterArgs
{
Property = "string",
Values = new[]
{
"string",
},
Negated = false,
},
},
Metric = "string",
},
},
Name = "string",
Permissions = new[]
{
new SignalFx.Inputs.DashboardGroupPermissionArgs
{
PrincipalId = "string",
PrincipalType = "string",
Actions = new[]
{
"string",
},
},
},
Teams = new[]
{
"string",
},
});
example, err := signalfx.NewDashboardGroup(ctx, "dashboardGroupResource", &signalfx.DashboardGroupArgs{
Dashboards: signalfx.DashboardGroupDashboardArray{
&signalfx.DashboardGroupDashboardArgs{
DashboardId: pulumi.String("string"),
ConfigId: pulumi.String("string"),
DescriptionOverride: pulumi.String("string"),
FilterOverrides: signalfx.DashboardGroupDashboardFilterOverrideArray{
&signalfx.DashboardGroupDashboardFilterOverrideArgs{
Property: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
Negated: pulumi.Bool(false),
},
},
NameOverride: pulumi.String("string"),
VariableOverrides: signalfx.DashboardGroupDashboardVariableOverrideArray{
&signalfx.DashboardGroupDashboardVariableOverrideArgs{
Property: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
ValuesSuggesteds: pulumi.StringArray{
pulumi.String("string"),
},
},
},
},
},
Description: pulumi.String("string"),
ImportQualifiers: signalfx.DashboardGroupImportQualifierArray{
&signalfx.DashboardGroupImportQualifierArgs{
Filters: signalfx.DashboardGroupImportQualifierFilterArray{
&signalfx.DashboardGroupImportQualifierFilterArgs{
Property: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
Negated: pulumi.Bool(false),
},
},
Metric: pulumi.String("string"),
},
},
Name: pulumi.String("string"),
Permissions: signalfx.DashboardGroupPermissionArray{
&signalfx.DashboardGroupPermissionArgs{
PrincipalId: pulumi.String("string"),
PrincipalType: pulumi.String("string"),
Actions: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Teams: pulumi.StringArray{
pulumi.String("string"),
},
})
var dashboardGroupResource = new DashboardGroup("dashboardGroupResource", DashboardGroupArgs.builder()
.dashboards(DashboardGroupDashboardArgs.builder()
.dashboardId("string")
.configId("string")
.descriptionOverride("string")
.filterOverrides(DashboardGroupDashboardFilterOverrideArgs.builder()
.property("string")
.values("string")
.negated(false)
.build())
.nameOverride("string")
.variableOverrides(DashboardGroupDashboardVariableOverrideArgs.builder()
.property("string")
.values("string")
.valuesSuggesteds("string")
.build())
.build())
.description("string")
.importQualifiers(DashboardGroupImportQualifierArgs.builder()
.filters(DashboardGroupImportQualifierFilterArgs.builder()
.property("string")
.values("string")
.negated(false)
.build())
.metric("string")
.build())
.name("string")
.permissions(DashboardGroupPermissionArgs.builder()
.principalId("string")
.principalType("string")
.actions("string")
.build())
.teams("string")
.build());
dashboard_group_resource = signalfx.DashboardGroup("dashboardGroupResource",
dashboards=[{
"dashboard_id": "string",
"config_id": "string",
"description_override": "string",
"filter_overrides": [{
"property": "string",
"values": ["string"],
"negated": False,
}],
"name_override": "string",
"variable_overrides": [{
"property": "string",
"values": ["string"],
"values_suggesteds": ["string"],
}],
}],
description="string",
import_qualifiers=[{
"filters": [{
"property": "string",
"values": ["string"],
"negated": False,
}],
"metric": "string",
}],
name="string",
permissions=[{
"principal_id": "string",
"principal_type": "string",
"actions": ["string"],
}],
teams=["string"])
const dashboardGroupResource = new signalfx.DashboardGroup("dashboardGroupResource", {
dashboards: [{
dashboardId: "string",
configId: "string",
descriptionOverride: "string",
filterOverrides: [{
property: "string",
values: ["string"],
negated: false,
}],
nameOverride: "string",
variableOverrides: [{
property: "string",
values: ["string"],
valuesSuggesteds: ["string"],
}],
}],
description: "string",
importQualifiers: [{
filters: [{
property: "string",
values: ["string"],
negated: false,
}],
metric: "string",
}],
name: "string",
permissions: [{
principalId: "string",
principalType: "string",
actions: ["string"],
}],
teams: ["string"],
});
type: signalfx:DashboardGroup
properties:
dashboards:
- configId: string
dashboardId: string
descriptionOverride: string
filterOverrides:
- negated: false
property: string
values:
- string
nameOverride: string
variableOverrides:
- property: string
values:
- string
valuesSuggesteds:
- string
description: string
importQualifiers:
- filters:
- negated: false
property: string
values:
- string
metric: string
name: string
permissions:
- actions:
- string
principalId: string
principalType: string
teams:
- string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The DashboardGroup resource accepts the following input properties:
- 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 usepermissions
instead. - 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 usepermissions
instead. - Dashboards
List<Pulumi.
Signal Fx. Inputs. Dashboard Group Dashboard> - 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.
- Import
Qualifiers List<Pulumi.Signal Fx. Inputs. Dashboard Group Import Qualifier> - Name string
- Name of the dashboard group.
- Permissions
List<Pulumi.
Signal Fx. Inputs. Dashboard Group Permission> - 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.
- []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 usepermissions
instead. - []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 usepermissions
instead. - Dashboards
[]Dashboard
Group Dashboard Args - 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.
- Import
Qualifiers []DashboardGroup Import Qualifier Args - Name string
- Name of the dashboard group.
- Permissions
[]Dashboard
Group Permission Args - 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.
- 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 usepermissions
instead. - 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 usepermissions
instead. - dashboards
List<Dashboard
Group Dashboard> - 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.
- import
Qualifiers List<DashboardGroup Import Qualifier> - name String
- Name of the dashboard group.
- permissions
List<Dashboard
Group Permission> - 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.
- 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 usepermissions
instead. - 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 usepermissions
instead. - dashboards
Dashboard
Group Dashboard[] - 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.
- import
Qualifiers DashboardGroup Import Qualifier[] - name string
- Name of the dashboard group.
- permissions
Dashboard
Group Permission[] - 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.
- 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 usepermissions
instead. - 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 usepermissions
instead. - dashboards
Sequence[Dashboard
Group Dashboard Args] - 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[DashboardGroup Import Qualifier Args] - name str
- Name of the dashboard group.
- permissions
Sequence[Dashboard
Group Permission Args] - 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.
- 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 usepermissions
instead. - 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 usepermissions
instead. - 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.
- import
Qualifiers 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.
- 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 usepermissions
instead. - 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 usepermissions
instead. - Dashboards
List<Pulumi.
Signal Fx. Inputs. Dashboard Group Dashboard> - 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.
- Import
Qualifiers List<Pulumi.Signal Fx. Inputs. Dashboard Group Import Qualifier> - Name string
- Name of the dashboard group.
- Permissions
List<Pulumi.
Signal Fx. Inputs. Dashboard Group Permission> - 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.
- []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 usepermissions
instead. - []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 usepermissions
instead. - Dashboards
[]Dashboard
Group Dashboard Args - 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.
- Import
Qualifiers []DashboardGroup Import Qualifier Args - Name string
- Name of the dashboard group.
- Permissions
[]Dashboard
Group Permission Args - 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.
- 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 usepermissions
instead. - 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 usepermissions
instead. - dashboards
List<Dashboard
Group Dashboard> - 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.
- import
Qualifiers List<DashboardGroup Import Qualifier> - name String
- Name of the dashboard group.
- permissions
List<Dashboard
Group Permission> - 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.
- 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 usepermissions
instead. - 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 usepermissions
instead. - dashboards
Dashboard
Group Dashboard[] - 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.
- import
Qualifiers DashboardGroup Import Qualifier[] - name string
- Name of the dashboard group.
- permissions
Dashboard
Group Permission[] - 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.
- 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 usepermissions
instead. - 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 usepermissions
instead. - dashboards
Sequence[Dashboard
Group Dashboard Args] - 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[DashboardGroup Import Qualifier Args] - name str
- Name of the dashboard group.
- permissions
Sequence[Dashboard
Group Permission Args] - 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.
- 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 usepermissions
instead. - 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 usepermissions
instead. - 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.
- import
Qualifiers 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, DashboardGroupDashboardArgs
- Dashboard
Id string - The dashboard id to mirror
- Config
Id string - The ID of the association between the dashboard group and the dashboard
- Description
Override string - The description that will override the original dashboards's description.
- Filter
Overrides List<Pulumi.Signal Fx. Inputs. Dashboard Group Dashboard Filter Override> - The description that will override the original dashboards's description.
- Name
Override string - The name that will override the original dashboards's name.
- Variable
Overrides List<Pulumi.Signal Fx. Inputs. Dashboard Group Dashboard Variable Override> - Dashboard variable to apply to each chart in the dashboard
- Dashboard
Id string - The dashboard id to mirror
- Config
Id string - The ID of the association between the dashboard group and the dashboard
- Description
Override string - The description that will override the original dashboards's description.
- Filter
Overrides []DashboardGroup Dashboard Filter Override - The description that will override the original dashboards's description.
- Name
Override string - The name that will override the original dashboards's name.
- Variable
Overrides []DashboardGroup Dashboard Variable Override - Dashboard variable to apply to each chart in the dashboard
- dashboard
Id String - The dashboard id to mirror
- config
Id String - The ID of the association between the dashboard group and the dashboard
- description
Override String - The description that will override the original dashboards's description.
- filter
Overrides List<DashboardGroup Dashboard Filter Override> - The description that will override the original dashboards's description.
- name
Override String - The name that will override the original dashboards's name.
- variable
Overrides List<DashboardGroup Dashboard Variable Override> - Dashboard variable to apply to each chart in the dashboard
- dashboard
Id string - The dashboard id to mirror
- config
Id string - The ID of the association between the dashboard group and the dashboard
- description
Override string - The description that will override the original dashboards's description.
- filter
Overrides DashboardGroup Dashboard Filter Override[] - The description that will override the original dashboards's description.
- name
Override string - The name that will override the original dashboards's name.
- variable
Overrides DashboardGroup Dashboard Variable Override[] - Dashboard variable to apply to each chart in the dashboard
- dashboard_
id str - The dashboard id to mirror
- config_
id str - The ID of the association between the dashboard group and the dashboard
- description_
override str - The description that will override the original dashboards's description.
- filter_
overrides Sequence[DashboardGroup Dashboard Filter Override] - 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[DashboardGroup Dashboard Variable Override] - Dashboard variable to apply to each chart in the dashboard
- dashboard
Id String - The dashboard id to mirror
- config
Id String - The ID of the association between the dashboard group and the dashboard
- description
Override String - The description that will override the original dashboards's description.
- filter
Overrides List<Property Map> - The description that will override the original dashboards's description.
- name
Override String - The name that will override the original dashboards's name.
- variable
Overrides List<Property Map> - Dashboard variable to apply to each chart in the dashboard
DashboardGroupDashboardFilterOverride, DashboardGroupDashboardFilterOverrideArgs
- 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, DashboardGroupDashboardVariableOverrideArgs
- Property string
- A metric time series dimension or property name
- Values List<string>
- List of strings (which will be treated as an OR filter on the property)
- Values
Suggesteds 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
- List of strings (which will be treated as an OR filter on the property)
- Values
Suggesteds []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>
- List of strings (which will be treated as an OR filter on the property)
- values
Suggesteds 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[]
- List of strings (which will be treated as an OR filter on the property)
- values
Suggesteds 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]
- List 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>
- List of strings (which will be treated as an OR filter on the property)
- values
Suggesteds 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, DashboardGroupImportQualifierArgs
- Filters
List<Pulumi.
Signal Fx. Inputs. Dashboard Group Import Qualifier Filter> - Filter to apply to each chart in the dashboard
- Metric string
- Filters
[]Dashboard
Group Import Qualifier Filter - Filter to apply to each chart in the dashboard
- Metric string
- filters
List<Dashboard
Group Import Qualifier Filter> - Filter to apply to each chart in the dashboard
- metric String
- filters
Dashboard
Group Import Qualifier Filter[] - Filter to apply to each chart in the dashboard
- metric string
- filters
Sequence[Dashboard
Group Import Qualifier Filter] - Filter to apply to each chart in the dashboard
- metric str
- filters List<Property Map>
- Filter to apply to each chart in the dashboard
- metric String
DashboardGroupImportQualifierFilter, DashboardGroupImportQualifierFilterArgs
DashboardGroupPermission, DashboardGroupPermissionArgs
- Principal
Id string - ID of the user, team, or organization for which you're granting permissions.
- Principal
Type 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").
- Principal
Id string - ID of the user, team, or organization for which you're granting permissions.
- Principal
Type 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 String - ID of the user, team, or organization for which you're granting permissions.
- principal
Type 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").
- principal
Id string - ID of the user, team, or organization for which you're granting permissions.
- principal
Type 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").
- principal
Id String - ID of the user, team, or organization for which you're granting permissions.
- principal
Type 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.