Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Splight
  3. API Docs
  4. Bus
splight v1.2.13 published on Friday, Feb 14, 2025 by splightplatform
splightplatform/pulumi-splight

splight.Bus

Explore with Pulumi AI

splight v1.2.13 published on Friday, Feb 14, 2025 by splightplatform
splightplatform/pulumi-splight

Example Usage

Create Bus Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Bus(name: string, args?: BusArgs, opts?: CustomResourceOptions);
@overload
def Bus(resource_name: str,
        args: Optional[BusArgs] = None,
        opts: Optional[ResourceOptions] = None)

@overload
def Bus(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        geometry: Optional[str] = None,
        name: Optional[str] = None,
        nominal_voltage_kv: Optional[BusNominalVoltageKvArgs] = None,
        tags: Optional[Sequence[BusTagArgs]] = None,
        timezone: Optional[str] = None)
func NewBus(ctx *Context, name string, args *BusArgs, opts ...ResourceOption) (*Bus, error)
public Bus(string name, BusArgs? args = null, CustomResourceOptions? opts = null)
public Bus(String name, BusArgs args)
public Bus(String name, BusArgs args, CustomResourceOptions options)

type: splight:Bus
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args BusArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args BusArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args BusArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args BusArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. BusArgs
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 busResource = new Splight.Bus("busResource", new()
{
    Description = "string",
    Geometry = "string",
    Name = "string",
    NominalVoltageKv = new Splight.Inputs.BusNominalVoltageKvArgs
    {
        Value = "string",
        Asset = "string",
        Id = "string",
        Name = "string",
        Type = "string",
        Unit = "string",
    },
    Tags = new[]
    {
        new Splight.Inputs.BusTagArgs
        {
            Id = "string",
            Name = "string",
        },
    },
    Timezone = "string",
});
Copy
example, err := splight.NewBus(ctx, "busResource", &splight.BusArgs{
	Description: pulumi.String("string"),
	Geometry:    pulumi.String("string"),
	Name:        pulumi.String("string"),
	NominalVoltageKv: &splight.BusNominalVoltageKvArgs{
		Value: pulumi.String("string"),
		Asset: pulumi.String("string"),
		Id:    pulumi.String("string"),
		Name:  pulumi.String("string"),
		Type:  pulumi.String("string"),
		Unit:  pulumi.String("string"),
	},
	Tags: splight.BusTagArray{
		&splight.BusTagArgs{
			Id:   pulumi.String("string"),
			Name: pulumi.String("string"),
		},
	},
	Timezone: pulumi.String("string"),
})
Copy
var busResource = new Bus("busResource", BusArgs.builder()
    .description("string")
    .geometry("string")
    .name("string")
    .nominalVoltageKv(BusNominalVoltageKvArgs.builder()
        .value("string")
        .asset("string")
        .id("string")
        .name("string")
        .type("string")
        .unit("string")
        .build())
    .tags(BusTagArgs.builder()
        .id("string")
        .name("string")
        .build())
    .timezone("string")
    .build());
Copy
bus_resource = splight.Bus("busResource",
    description="string",
    geometry="string",
    name="string",
    nominal_voltage_kv={
        "value": "string",
        "asset": "string",
        "id": "string",
        "name": "string",
        "type": "string",
        "unit": "string",
    },
    tags=[{
        "id": "string",
        "name": "string",
    }],
    timezone="string")
Copy
const busResource = new splight.Bus("busResource", {
    description: "string",
    geometry: "string",
    name: "string",
    nominalVoltageKv: {
        value: "string",
        asset: "string",
        id: "string",
        name: "string",
        type: "string",
        unit: "string",
    },
    tags: [{
        id: "string",
        name: "string",
    }],
    timezone: "string",
});
Copy
type: splight:Bus
properties:
    description: string
    geometry: string
    name: string
    nominalVoltageKv:
        asset: string
        id: string
        name: string
        type: string
        unit: string
        value: string
    tags:
        - id: string
          name: string
    timezone: string
Copy

Bus 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 Bus resource accepts the following input properties:

Description string
description of the resource
Geometry string
geo position and shape of the resource
Name string
name of the resource
NominalVoltageKv Splight.Splight.Inputs.BusNominalVoltageKv
attribute of the resource
Tags List<Splight.Splight.Inputs.BusTag>
tags of the resource
Timezone string
timezone that overrides location-based timezone of the resource
Description string
description of the resource
Geometry string
geo position and shape of the resource
Name string
name of the resource
NominalVoltageKv BusNominalVoltageKvArgs
attribute of the resource
Tags []BusTagArgs
tags of the resource
Timezone string
timezone that overrides location-based timezone of the resource
description String
description of the resource
geometry String
geo position and shape of the resource
name String
name of the resource
nominalVoltageKv BusNominalVoltageKv
attribute of the resource
tags List<BusTag>
tags of the resource
timezone String
timezone that overrides location-based timezone of the resource
description string
description of the resource
geometry string
geo position and shape of the resource
name string
name of the resource
nominalVoltageKv BusNominalVoltageKv
attribute of the resource
tags BusTag[]
tags of the resource
timezone string
timezone that overrides location-based timezone of the resource
description str
description of the resource
geometry str
geo position and shape of the resource
name str
name of the resource
nominal_voltage_kv BusNominalVoltageKvArgs
attribute of the resource
tags Sequence[BusTagArgs]
tags of the resource
timezone str
timezone that overrides location-based timezone of the resource
description String
description of the resource
geometry String
geo position and shape of the resource
name String
name of the resource
nominalVoltageKv Property Map
attribute of the resource
tags List<Property Map>
tags of the resource
timezone String
timezone that overrides location-based timezone of the resource

Outputs

All input properties are implicitly available as output properties. Additionally, the Bus resource produces the following output properties:

ActivePowers List<Splight.Splight.Outputs.BusActivePower>
attribute of the resource
Id string
The provider-assigned unique ID for this managed resource.
Kinds List<Splight.Splight.Outputs.BusKind>
kind of the resource
ReactivePowers List<Splight.Splight.Outputs.BusReactivePower>
attribute of the resource
ActivePowers []BusActivePower
attribute of the resource
Id string
The provider-assigned unique ID for this managed resource.
Kinds []BusKind
kind of the resource
ReactivePowers []BusReactivePower
attribute of the resource
activePowers List<BusActivePower>
attribute of the resource
id String
The provider-assigned unique ID for this managed resource.
kinds List<BusKind>
kind of the resource
reactivePowers List<BusReactivePower>
attribute of the resource
activePowers BusActivePower[]
attribute of the resource
id string
The provider-assigned unique ID for this managed resource.
kinds BusKind[]
kind of the resource
reactivePowers BusReactivePower[]
attribute of the resource
active_powers Sequence[BusActivePower]
attribute of the resource
id str
The provider-assigned unique ID for this managed resource.
kinds Sequence[BusKind]
kind of the resource
reactive_powers Sequence[BusReactivePower]
attribute of the resource
activePowers List<Property Map>
attribute of the resource
id String
The provider-assigned unique ID for this managed resource.
kinds List<Property Map>
kind of the resource
reactivePowers List<Property Map>
attribute of the resource

Look up Existing Bus Resource

Get an existing Bus 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?: BusState, opts?: CustomResourceOptions): Bus
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active_powers: Optional[Sequence[BusActivePowerArgs]] = None,
        description: Optional[str] = None,
        geometry: Optional[str] = None,
        kinds: Optional[Sequence[BusKindArgs]] = None,
        name: Optional[str] = None,
        nominal_voltage_kv: Optional[BusNominalVoltageKvArgs] = None,
        reactive_powers: Optional[Sequence[BusReactivePowerArgs]] = None,
        tags: Optional[Sequence[BusTagArgs]] = None,
        timezone: Optional[str] = None) -> Bus
func GetBus(ctx *Context, name string, id IDInput, state *BusState, opts ...ResourceOption) (*Bus, error)
public static Bus Get(string name, Input<string> id, BusState? state, CustomResourceOptions? opts = null)
public static Bus get(String name, Output<String> id, BusState state, CustomResourceOptions options)
resources:  _:    type: splight:Bus    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ActivePowers List<Splight.Splight.Inputs.BusActivePower>
attribute of the resource
Description string
description of the resource
Geometry string
geo position and shape of the resource
Kinds List<Splight.Splight.Inputs.BusKind>
kind of the resource
Name string
name of the resource
NominalVoltageKv Splight.Splight.Inputs.BusNominalVoltageKv
attribute of the resource
ReactivePowers List<Splight.Splight.Inputs.BusReactivePower>
attribute of the resource
Tags List<Splight.Splight.Inputs.BusTag>
tags of the resource
Timezone string
timezone that overrides location-based timezone of the resource
ActivePowers []BusActivePowerArgs
attribute of the resource
Description string
description of the resource
Geometry string
geo position and shape of the resource
Kinds []BusKindArgs
kind of the resource
Name string
name of the resource
NominalVoltageKv BusNominalVoltageKvArgs
attribute of the resource
ReactivePowers []BusReactivePowerArgs
attribute of the resource
Tags []BusTagArgs
tags of the resource
Timezone string
timezone that overrides location-based timezone of the resource
activePowers List<BusActivePower>
attribute of the resource
description String
description of the resource
geometry String
geo position and shape of the resource
kinds List<BusKind>
kind of the resource
name String
name of the resource
nominalVoltageKv BusNominalVoltageKv
attribute of the resource
reactivePowers List<BusReactivePower>
attribute of the resource
tags List<BusTag>
tags of the resource
timezone String
timezone that overrides location-based timezone of the resource
activePowers BusActivePower[]
attribute of the resource
description string
description of the resource
geometry string
geo position and shape of the resource
kinds BusKind[]
kind of the resource
name string
name of the resource
nominalVoltageKv BusNominalVoltageKv
attribute of the resource
reactivePowers BusReactivePower[]
attribute of the resource
tags BusTag[]
tags of the resource
timezone string
timezone that overrides location-based timezone of the resource
active_powers Sequence[BusActivePowerArgs]
attribute of the resource
description str
description of the resource
geometry str
geo position and shape of the resource
kinds Sequence[BusKindArgs]
kind of the resource
name str
name of the resource
nominal_voltage_kv BusNominalVoltageKvArgs
attribute of the resource
reactive_powers Sequence[BusReactivePowerArgs]
attribute of the resource
tags Sequence[BusTagArgs]
tags of the resource
timezone str
timezone that overrides location-based timezone of the resource
activePowers List<Property Map>
attribute of the resource
description String
description of the resource
geometry String
geo position and shape of the resource
kinds List<Property Map>
kind of the resource
name String
name of the resource
nominalVoltageKv Property Map
attribute of the resource
reactivePowers List<Property Map>
attribute of the resource
tags List<Property Map>
tags of the resource
timezone String
timezone that overrides location-based timezone of the resource

Supporting Types

BusActivePower
, BusActivePowerArgs

Asset string
reference to the asset to be linked to
Id string
id of the resource
Name string
name of the resource
Type string
[String|Boolean|Number] type of the data to be ingested in this attribute
Unit string
unit of measure
Asset string
reference to the asset to be linked to
Id string
id of the resource
Name string
name of the resource
Type string
[String|Boolean|Number] type of the data to be ingested in this attribute
Unit string
unit of measure
asset String
reference to the asset to be linked to
id String
id of the resource
name String
name of the resource
type String
[String|Boolean|Number] type of the data to be ingested in this attribute
unit String
unit of measure
asset string
reference to the asset to be linked to
id string
id of the resource
name string
name of the resource
type string
[String|Boolean|Number] type of the data to be ingested in this attribute
unit string
unit of measure
asset str
reference to the asset to be linked to
id str
id of the resource
name str
name of the resource
type str
[String|Boolean|Number] type of the data to be ingested in this attribute
unit str
unit of measure
asset String
reference to the asset to be linked to
id String
id of the resource
name String
name of the resource
type String
[String|Boolean|Number] type of the data to be ingested in this attribute
unit String
unit of measure

BusKind
, BusKindArgs

Id
This property is required.
Changes to this property will trigger replacement.
string
kind id
Name
This property is required.
Changes to this property will trigger replacement.
string
kind name
Id
This property is required.
Changes to this property will trigger replacement.
string
kind id
Name
This property is required.
Changes to this property will trigger replacement.
string
kind name
id
This property is required.
Changes to this property will trigger replacement.
String
kind id
name
This property is required.
Changes to this property will trigger replacement.
String
kind name
id
This property is required.
Changes to this property will trigger replacement.
string
kind id
name
This property is required.
Changes to this property will trigger replacement.
string
kind name
id
This property is required.
Changes to this property will trigger replacement.
str
kind id
name
This property is required.
Changes to this property will trigger replacement.
str
kind name
id
This property is required.
Changes to this property will trigger replacement.
String
kind id
name
This property is required.
Changes to this property will trigger replacement.
String
kind name

BusNominalVoltageKv
, BusNominalVoltageKvArgs

Value This property is required. string
metadata value
Asset string
reference to the asset to be linked to
Id string
id of the resource
Name string
name of the resource
Type string
[String|Boolean|Number] type of the data to be ingested in this attribute
Unit string
unit of measure
Value This property is required. string
metadata value
Asset string
reference to the asset to be linked to
Id string
id of the resource
Name string
name of the resource
Type string
[String|Boolean|Number] type of the data to be ingested in this attribute
Unit string
unit of measure
value This property is required. String
metadata value
asset String
reference to the asset to be linked to
id String
id of the resource
name String
name of the resource
type String
[String|Boolean|Number] type of the data to be ingested in this attribute
unit String
unit of measure
value This property is required. string
metadata value
asset string
reference to the asset to be linked to
id string
id of the resource
name string
name of the resource
type string
[String|Boolean|Number] type of the data to be ingested in this attribute
unit string
unit of measure
value This property is required. str
metadata value
asset str
reference to the asset to be linked to
id str
id of the resource
name str
name of the resource
type str
[String|Boolean|Number] type of the data to be ingested in this attribute
unit str
unit of measure
value This property is required. String
metadata value
asset String
reference to the asset to be linked to
id String
id of the resource
name String
name of the resource
type String
[String|Boolean|Number] type of the data to be ingested in this attribute
unit String
unit of measure

BusReactivePower
, BusReactivePowerArgs

Asset string
reference to the asset to be linked to
Id string
id of the resource
Name string
name of the resource
Type string
[String|Boolean|Number] type of the data to be ingested in this attribute
Unit string
unit of measure
Asset string
reference to the asset to be linked to
Id string
id of the resource
Name string
name of the resource
Type string
[String|Boolean|Number] type of the data to be ingested in this attribute
Unit string
unit of measure
asset String
reference to the asset to be linked to
id String
id of the resource
name String
name of the resource
type String
[String|Boolean|Number] type of the data to be ingested in this attribute
unit String
unit of measure
asset string
reference to the asset to be linked to
id string
id of the resource
name string
name of the resource
type string
[String|Boolean|Number] type of the data to be ingested in this attribute
unit string
unit of measure
asset str
reference to the asset to be linked to
id str
id of the resource
name str
name of the resource
type str
[String|Boolean|Number] type of the data to be ingested in this attribute
unit str
unit of measure
asset String
reference to the asset to be linked to
id String
id of the resource
name String
name of the resource
type String
[String|Boolean|Number] type of the data to be ingested in this attribute
unit String
unit of measure

BusTag
, BusTagArgs

Id This property is required. string
tag id
Name This property is required. string
tag name
Id This property is required. string
tag id
Name This property is required. string
tag name
id This property is required. String
tag id
name This property is required. String
tag name
id This property is required. string
tag id
name This property is required. string
tag name
id This property is required. str
tag id
name This property is required. str
tag name
id This property is required. String
tag id
name This property is required. String
tag name

Import

$ pulumi import splight:index/bus:Bus [options] splight_bus.<name> <bus_id>
Copy

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 v1.2.13 published on Friday, Feb 14, 2025 by splightplatform
splightplatform/pulumi-splight