splight.Dashboard
Explore with Pulumi AI
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as splight from "@splightplatform/pulumi-splight";
const dashboardTest = new splight.Dashboard("dashboardTest", {relatedAssets: ["1234-1234-1234-1234"]});
import pulumi
import pulumi_splight as splight
dashboard_test = splight.Dashboard("dashboardTest", related_assets=["1234-1234-1234-1234"])
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/splightplatform/pulumi-splight/sdk/go/splight"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := splight.NewDashboard(ctx, "dashboardTest", &splight.DashboardArgs{
RelatedAssets: pulumi.StringArray{
pulumi.String("1234-1234-1234-1234"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Splight = Splight.Splight;
return await Deployment.RunAsync(() =>
{
var dashboardTest = new Splight.Dashboard("dashboardTest", new()
{
RelatedAssets = new[]
{
"1234-1234-1234-1234",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.splight.Dashboard;
import com.pulumi.splight.DashboardArgs;
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 dashboardTest = new Dashboard("dashboardTest", DashboardArgs.builder()
.relatedAssets("1234-1234-1234-1234")
.build());
}
}
resources:
dashboardTest:
type: splight:Dashboard
properties:
relatedAssets:
- 1234-1234-1234-1234
Create Dashboard Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Dashboard(name: string, args?: DashboardArgs, opts?: CustomResourceOptions);
@overload
def Dashboard(resource_name: str,
args: Optional[DashboardArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Dashboard(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
name: Optional[str] = None,
related_assets: Optional[Sequence[str]] = None)
func NewDashboard(ctx *Context, name string, args *DashboardArgs, opts ...ResourceOption) (*Dashboard, error)
public Dashboard(string name, DashboardArgs? args = null, CustomResourceOptions? opts = null)
public Dashboard(String name, DashboardArgs args)
public Dashboard(String name, DashboardArgs args, CustomResourceOptions options)
type: splight:Dashboard
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 DashboardArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DashboardArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DashboardArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DashboardArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DashboardArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var dashboardResource = new Splight.Dashboard("dashboardResource", new()
{
Description = "string",
Name = "string",
RelatedAssets = new[]
{
"string",
},
});
example, err := splight.NewDashboard(ctx, "dashboardResource", &splight.DashboardArgs{
Description: pulumi.String("string"),
Name: pulumi.String("string"),
RelatedAssets: pulumi.StringArray{
pulumi.String("string"),
},
})
var dashboardResource = new Dashboard("dashboardResource", DashboardArgs.builder()
.description("string")
.name("string")
.relatedAssets("string")
.build());
dashboard_resource = splight.Dashboard("dashboardResource",
description="string",
name="string",
related_assets=["string"])
const dashboardResource = new splight.Dashboard("dashboardResource", {
description: "string",
name: "string",
relatedAssets: ["string"],
});
type: splight:Dashboard
properties:
description: string
name: string
relatedAssets:
- string
Dashboard Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Dashboard resource accepts the following input properties:
- Description string
- complementary information for the dashboard
- Name string
- dashboard name
- List<string>
- assets linked
- Description string
- complementary information for the dashboard
- Name string
- dashboard name
- []string
- assets linked
- description String
- complementary information for the dashboard
- name String
- dashboard name
- List<String>
- assets linked
- description string
- complementary information for the dashboard
- name string
- dashboard name
- string[]
- assets linked
- description str
- complementary information for the dashboard
- name str
- dashboard name
- Sequence[str]
- assets linked
- description String
- complementary information for the dashboard
- name String
- dashboard name
- List<String>
- assets linked
Outputs
All input properties are implicitly available as output properties. Additionally, the Dashboard resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing Dashboard Resource
Get an existing Dashboard resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: DashboardState, opts?: CustomResourceOptions): Dashboard
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
name: Optional[str] = None,
related_assets: Optional[Sequence[str]] = None) -> Dashboard
func GetDashboard(ctx *Context, name string, id IDInput, state *DashboardState, opts ...ResourceOption) (*Dashboard, error)
public static Dashboard Get(string name, Input<string> id, DashboardState? state, CustomResourceOptions? opts = null)
public static Dashboard get(String name, Output<String> id, DashboardState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Description string
- complementary information for the dashboard
- Name string
- dashboard name
- List<string>
- assets linked
- Description string
- complementary information for the dashboard
- Name string
- dashboard name
- []string
- assets linked
- description String
- complementary information for the dashboard
- name String
- dashboard name
- List<String>
- assets linked
- description string
- complementary information for the dashboard
- name string
- dashboard name
- string[]
- assets linked
- description str
- complementary information for the dashboard
- name str
- dashboard name
- Sequence[str]
- assets linked
- description String
- complementary information for the dashboard
- name String
- dashboard name
- List<String>
- assets linked
Import
$ pulumi import splight:index/dashboard:Dashboard [options] splight_dashboard.<name> <dashboard_id>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- splight splightplatform/pulumi-splight
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
splight
Terraform Provider.