@pulumi/signalfx
Version:
A Pulumi package for creating and managing SignalFx resources.
141 lines • 6.1 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.DashboardGroup = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
* In the Splunk Observability Cloud web UI, a [dashboard group](https://developers.signalfx.com/dashboard_groups_reference.html) 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](https://dev.splunk.com/observability/docs/administration/authtokens#Operations-that-require-a-session-token-for-an-administrator).
*
* ## Example
*
* ```typescript
* 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"],
* });
* ```
*
* ## Example with permissions
*
* ```typescript
* 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",
* ],
* },
* ],
* });
* ```
*
* ## Example With mirrored dashboards
*
* ```typescript
* 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",
* ],
* }],
* }],
* });
* ```
*/
class DashboardGroup extends pulumi.CustomResource {
/**
* Get an existing DashboardGroup resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name, id, state, opts) {
return new DashboardGroup(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of DashboardGroup. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === DashboardGroup.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["authorizedWriterTeams"] = state ? state.authorizedWriterTeams : undefined;
resourceInputs["authorizedWriterUsers"] = state ? state.authorizedWriterUsers : undefined;
resourceInputs["dashboards"] = state ? state.dashboards : undefined;
resourceInputs["description"] = state ? state.description : undefined;
resourceInputs["importQualifiers"] = state ? state.importQualifiers : undefined;
resourceInputs["name"] = state ? state.name : undefined;
resourceInputs["permissions"] = state ? state.permissions : undefined;
resourceInputs["teams"] = state ? state.teams : undefined;
}
else {
const args = argsOrState;
resourceInputs["authorizedWriterTeams"] = args ? args.authorizedWriterTeams : undefined;
resourceInputs["authorizedWriterUsers"] = args ? args.authorizedWriterUsers : undefined;
resourceInputs["dashboards"] = args ? args.dashboards : undefined;
resourceInputs["description"] = args ? args.description : undefined;
resourceInputs["importQualifiers"] = args ? args.importQualifiers : undefined;
resourceInputs["name"] = args ? args.name : undefined;
resourceInputs["permissions"] = args ? args.permissions : undefined;
resourceInputs["teams"] = args ? args.teams : undefined;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(DashboardGroup.__pulumiType, name, resourceInputs, opts);
}
}
exports.DashboardGroup = DashboardGroup;
/** @internal */
DashboardGroup.__pulumiType = 'signalfx:index/dashboardGroup:DashboardGroup';
//# sourceMappingURL=dashboardGroup.js.map