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

splight.Bus

Explore with Pulumi AI

splight logo
splight v1.2.2 published on Friday, Nov 8, 2024 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: BusArgs,
        opts: Optional[ResourceOptions] = None)

@overload
def Bus(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        nominal_voltage: Optional[BusNominalVoltageArgs] = None,
        description: Optional[str] = None,
        geometry: Optional[str] = None,
        name: Optional[str] = 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, 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 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 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 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 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 String
    The unique name of the resource.
    args 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()
{
    NominalVoltage = new Splight.Inputs.BusNominalVoltageArgs
    {
        Value = "string",
        Asset = "string",
        Id = "string",
        Name = "string",
        Type = "string",
        Unit = "string",
    },
    Description = "string",
    Geometry = "string",
    Name = "string",
    Tags = new[]
    {
        new Splight.Inputs.BusTagArgs
        {
            Id = "string",
            Name = "string",
        },
    },
    Timezone = "string",
});

    example, err := splight.NewBus(ctx, "busResource", &splight.BusArgs{
	NominalVoltage: &splight.BusNominalVoltageArgs{
		Value: pulumi.String("string"),
		Asset: pulumi.String("string"),
		Id:    pulumi.String("string"),
		Name:  pulumi.String("string"),
		Type:  pulumi.String("string"),
		Unit:  pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Geometry:    pulumi.String("string"),
	Name:        pulumi.String("string"),
	Tags: splight.BusTagArray{
		&splight.BusTagArgs{
			Id:   pulumi.String("string"),
			Name: pulumi.String("string"),
		},
	},
	Timezone: pulumi.String("string"),
})

    var busResource = new Bus("busResource", BusArgs.builder()
    .nominalVoltage(BusNominalVoltageArgs.builder()
        .value("string")
        .asset("string")
        .id("string")
        .name("string")
        .type("string")
        .unit("string")
        .build())
    .description("string")
    .geometry("string")
    .name("string")
    .tags(BusTagArgs.builder()
        .id("string")
        .name("string")
        .build())
    .timezone("string")
    .build());

    bus_resource = splight.Bus("busResource",
    nominal_voltage={
        "value": "string",
        "asset": "string",
        "id": "string",
        "name": "string",
        "type": "string",
        "unit": "string",
    },
    description="string",
    geometry="string",
    name="string",
    tags=[{
        "id": "string",
        "name": "string",
    }],
    timezone="string")

    const busResource = new splight.Bus("busResource", {
    nominalVoltage: {
        value: "string",
        asset: "string",
        id: "string",
        name: "string",
        type: "string",
        unit: "string",
    },
    description: "string",
    geometry: "string",
    name: "string",
    tags: [{
        id: "string",
        name: "string",
    }],
    timezone: "string",
});

    type: splight:Bus
properties:
    description: string
    geometry: string
    name: string
    nominalVoltage:
        asset: string
        id: string
        name: string
        type: string
        unit: string
        value: string
    tags:
        - id: string
          name: string
    timezone: string

    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:

    NominalVoltage Splight.Splight.Inputs.BusNominalVoltage
    attribute of the resource
    Description string
    description of the resource
    Geometry string
    geo position and shape of the resource
    Name string
    name of the resource
    Tags List<Splight.Splight.Inputs.BusTag>
    tags of the resource
    Timezone string
    timezone that overrides location-based timezone of the resource
    NominalVoltage BusNominalVoltageArgs
    attribute of the resource
    Description string
    description of the resource
    Geometry string
    geo position and shape of the resource
    Name string
    name of the resource
    Tags []BusTagArgs
    tags of the resource
    Timezone string
    timezone that overrides location-based timezone of the resource
    nominalVoltage BusNominalVoltage
    attribute of the resource
    description String
    description of the resource
    geometry String
    geo position and shape of the resource
    name String
    name of the resource
    tags List<BusTag>
    tags of the resource
    timezone String
    timezone that overrides location-based timezone of the resource
    nominalVoltage BusNominalVoltage
    attribute of the resource
    description string
    description of the resource
    geometry string
    geo position and shape of the resource
    name string
    name of the resource
    tags BusTag[]
    tags of the resource
    timezone string
    timezone that overrides location-based timezone of the resource
    nominal_voltage BusNominalVoltageArgs
    attribute of the resource
    description str
    description of the resource
    geometry str
    geo position and shape of the resource
    name str
    name of the resource
    tags Sequence[BusTagArgs]
    tags of the resource
    timezone str
    timezone that overrides location-based timezone of the resource
    nominalVoltage Property Map
    attribute of the resource
    description String
    description of the resource
    geometry String
    geo position and shape of the resource
    name String
    name 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:

    Id string
    The provider-assigned unique ID for this managed resource.
    Kinds List<Splight.Splight.Outputs.BusKind>
    kind of the resource
    Id string
    The provider-assigned unique ID for this managed resource.
    Kinds []BusKind
    kind of the resource
    id String
    The provider-assigned unique ID for this managed resource.
    kinds List<BusKind>
    kind of the resource
    id string
    The provider-assigned unique ID for this managed resource.
    kinds BusKind[]
    kind of the resource
    id str
    The provider-assigned unique ID for this managed resource.
    kinds Sequence[BusKind]
    kind of the resource
    id String
    The provider-assigned unique ID for this managed resource.
    kinds List<Property Map>
    kind 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,
        description: Optional[str] = None,
        geometry: Optional[str] = None,
        kinds: Optional[Sequence[BusKindArgs]] = None,
        name: Optional[str] = None,
        nominal_voltage: Optional[BusNominalVoltageArgs] = 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)
    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
    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
    NominalVoltage Splight.Splight.Inputs.BusNominalVoltage
    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
    Kinds []BusKindArgs
    kind of the resource
    Name string
    name of the resource
    NominalVoltage BusNominalVoltageArgs
    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
    kinds List<BusKind>
    kind of the resource
    name String
    name of the resource
    nominalVoltage BusNominalVoltage
    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
    kinds BusKind[]
    kind of the resource
    name string
    name of the resource
    nominalVoltage BusNominalVoltage
    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
    kinds Sequence[BusKindArgs]
    kind of the resource
    name str
    name of the resource
    nominal_voltage BusNominalVoltageArgs
    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
    kinds List<Property Map>
    kind of the resource
    name String
    name of the resource
    nominalVoltage 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

    BusKind, BusKindArgs

    Id string
    kind id
    Name string
    kind name
    Id string
    kind id
    Name string
    kind name
    id String
    kind id
    name String
    kind name
    id string
    kind id
    name string
    kind name
    id str
    kind id
    name str
    kind name
    id String
    kind id
    name String
    kind name

    BusNominalVoltage, BusNominalVoltageArgs

    Value 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 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 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 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 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 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

    BusTag, BusTagArgs

    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/bus:Bus [options] splight_bus.<name> <bus_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