Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Splight
  3. API Docs
  4. Dashboard
splight v1.2.2 published on Friday, Nov 8, 2024 by splightplatform
splightplatform/pulumi-splight

splight.Dashboard

Explore with Pulumi AI

splight logo
splight v1.2.2 published on Friday, Nov 8, 2024 by splightplatform
splightplatform/pulumi-splight

    Example Usage

    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[DashboardRelatedAssetArgs]] = None,
              tags: Optional[Sequence[DashboardTagArgs]] = 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[]
    {
        new Splight.Inputs.DashboardRelatedAssetArgs
        {
            Id = "string",
            Name = "string",
        },
    },
    Tags = new[]
    {
        new Splight.Inputs.DashboardTagArgs
        {
            Id = "string",
            Name = "string",
        },
    },
});

    example, err := splight.NewDashboard(ctx, "dashboardResource", &splight.DashboardArgs{
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	RelatedAssets: splight.DashboardRelatedAssetArray{
		&splight.DashboardRelatedAssetArgs{
			Id:   pulumi.String("string"),
			Name: pulumi.String("string"),
		},
	},
	Tags: splight.DashboardTagArray{
		&splight.DashboardTagArgs{
			Id:   pulumi.String("string"),
			Name: pulumi.String("string"),
		},
	},
})

    var dashboardResource = new Dashboard("dashboardResource", DashboardArgs.builder()
    .description("string")
    .name("string")
    .relatedAssets(DashboardRelatedAssetArgs.builder()
        .id("string")
        .name("string")
        .build())
    .tags(DashboardTagArgs.builder()
        .id("string")
        .name("string")
        .build())
    .build());

    dashboard_resource = splight.Dashboard("dashboardResource",
    description="string",
    name="string",
    related_assets=[{
        "id": "string",
        "name": "string",
    }],
    tags=[{
        "id": "string",
        "name": "string",
    }])

    const dashboardResource = new splight.Dashboard("dashboardResource", {
    description: "string",
    name: "string",
    relatedAssets: [{
        id: "string",
        name: "string",
    }],
    tags: [{
        id: "string",
        name: "string",
    }],
});

    type: splight:Dashboard
properties:
    description: string
    name: string
    relatedAssets:
        - id: string
          name: string
    tags:
        - id: string
          name: 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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Dashboard resource accepts the following input properties:

    Description string
    dashboard description
    Name string
    dashboard name
    RelatedAssets List<Splight.Splight.Inputs.DashboardRelatedAsset>
    related assets of the resource
    Tags List<Splight.Splight.Inputs.DashboardTag>
    tags of the resource
    Description string
    dashboard description
    Name string
    dashboard name
    RelatedAssets []DashboardRelatedAssetArgs
    related assets of the resource
    Tags []DashboardTagArgs
    tags of the resource
    description String
    dashboard description
    name String
    dashboard name
    relatedAssets List<DashboardRelatedAsset>
    related assets of the resource
    tags List<DashboardTag>
    tags of the resource
    description string
    dashboard description
    name string
    dashboard name
    relatedAssets DashboardRelatedAsset[]
    related assets of the resource
    tags DashboardTag[]
    tags of the resource
    description str
    dashboard description
    name str
    dashboard name
    related_assets Sequence[DashboardRelatedAssetArgs]
    related assets of the resource
    tags Sequence[DashboardTagArgs]
    tags of the resource
    description String
    dashboard description
    name String
    dashboard name
    relatedAssets List<Property Map>
    related assets of the resource
    tags List<Property Map>
    tags of the resource

    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[DashboardRelatedAssetArgs]] = None,
        tags: Optional[Sequence[DashboardTagArgs]] = 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.
    The following state arguments are supported:
    Description string
    dashboard description
    Name string
    dashboard name
    RelatedAssets List<Splight.Splight.Inputs.DashboardRelatedAsset>
    related assets of the resource
    Tags List<Splight.Splight.Inputs.DashboardTag>
    tags of the resource
    Description string
    dashboard description
    Name string
    dashboard name
    RelatedAssets []DashboardRelatedAssetArgs
    related assets of the resource
    Tags []DashboardTagArgs
    tags of the resource
    description String
    dashboard description
    name String
    dashboard name
    relatedAssets List<DashboardRelatedAsset>
    related assets of the resource
    tags List<DashboardTag>
    tags of the resource
    description string
    dashboard description
    name string
    dashboard name
    relatedAssets DashboardRelatedAsset[]
    related assets of the resource
    tags DashboardTag[]
    tags of the resource
    description str
    dashboard description
    name str
    dashboard name
    related_assets Sequence[DashboardRelatedAssetArgs]
    related assets of the resource
    tags Sequence[DashboardTagArgs]
    tags of the resource
    description String
    dashboard description
    name String
    dashboard name
    relatedAssets List<Property Map>
    related assets of the resource
    tags List<Property Map>
    tags of the resource

    Supporting Types

    DashboardRelatedAsset, DashboardRelatedAssetArgs

    Id string
    asset id
    Name string
    asset name
    Id string
    asset id
    Name string
    asset name
    id String
    asset id
    name String
    asset name
    id string
    asset id
    name string
    asset name
    id str
    asset id
    name str
    asset name
    id String
    asset id
    name String
    asset name

    DashboardTag, DashboardTagArgs

    Id string
    tag id
    Name string
    tag name
    Id string
    tag id
    Name string
    tag name
    id String
    tag id
    name String
    tag name
    id string
    tag id
    name string
    tag name
    id str
    tag id
    name str
    tag name
    id String
    tag id
    name String
    tag name

    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.
    splight logo
    splight v1.2.2 published on Friday, Nov 8, 2024 by splightplatform
    splightplatform/pulumi-splight