splight v1.2.2, Nov 8 24

splight v1.2.2 published on Friday, Nov 8, 2024 by splightplatform

splight.Generator

Explore with Pulumi AI

splight v1.2.2 published on Friday, Nov 8, 2024 by splightplatform

splightplatform/pulumi-splight

Example Usage

Create Generator Resource

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

Constructor syntax

new Generator(name: string, args: GeneratorArgs, opts?: CustomResourceOptions);

@overload
def Generator(resource_name: str,
              args: GeneratorArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def Generator(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              co2_coefficient: Optional[GeneratorCo2CoefficientArgs] = None,
              description: Optional[str] = None,
              geometry: Optional[str] = None,
              name: Optional[str] = None,
              tags: Optional[Sequence[GeneratorTagArgs]] = None,
              timezone: Optional[str] = None)

func NewGenerator(ctx *Context, name string, args GeneratorArgs, opts ...ResourceOption) (*Generator, error)

public Generator(string name, GeneratorArgs args, CustomResourceOptions? opts = null)

public Generator(String name, GeneratorArgs args)
public Generator(String name, GeneratorArgs args, CustomResourceOptions options)

type: splight:Generator
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 GeneratorArgs: 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 GeneratorArgs: 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 GeneratorArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GeneratorArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args GeneratorArgs: 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 generatorResource = new Splight.Generator("generatorResource", new()
{
    Co2Coefficient = new Splight.Inputs.GeneratorCo2CoefficientArgs
    {
        Value = "string",
        Asset = "string",
        Id = "string",
        Name = "string",
        Type = "string",
        Unit = "string",
    },
    Description = "string",
    Geometry = "string",
    Name = "string",
    Tags = new[]
    {
        new Splight.Inputs.GeneratorTagArgs
        {
            Id = "string",
            Name = "string",
        },
    },
    Timezone = "string",
});

example, err := splight.NewGenerator(ctx, "generatorResource", &splight.GeneratorArgs{
	Co2Coefficient: &splight.GeneratorCo2CoefficientArgs{
		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.GeneratorTagArray{
		&splight.GeneratorTagArgs{
			Id:   pulumi.String("string"),
			Name: pulumi.String("string"),
		},
	},
	Timezone: pulumi.String("string"),
})

var generatorResource = new Generator("generatorResource", GeneratorArgs.builder()
    .co2Coefficient(GeneratorCo2CoefficientArgs.builder()
        .value("string")
        .asset("string")
        .id("string")
        .name("string")
        .type("string")
        .unit("string")
        .build())
    .description("string")
    .geometry("string")
    .name("string")
    .tags(GeneratorTagArgs.builder()
        .id("string")
        .name("string")
        .build())
    .timezone("string")
    .build());

generator_resource = splight.Generator("generatorResource",
    co2_coefficient={
        "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 generatorResource = new splight.Generator("generatorResource", {
    co2Coefficient: {
        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:Generator
properties:
    co2Coefficient:
        asset: string
        id: string
        name: string
        type: string
        unit: string
        value: string
    description: string
    geometry: string
    name: string
    tags:
        - id: string
          name: string
    timezone: string

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

Co2Coefficient Splight.Splight.Inputs.GeneratorCo2Coefficient: 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.GeneratorTag>: tags of the resource
Timezone string: timezone that overrides location-based timezone of the resource

Co2Coefficient GeneratorCo2CoefficientArgs: 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 []GeneratorTagArgs: tags of the resource
Timezone string: timezone that overrides location-based timezone of the resource

co2Coefficient GeneratorCo2Coefficient: 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<GeneratorTag>: tags of the resource
timezone String: timezone that overrides location-based timezone of the resource

co2Coefficient GeneratorCo2Coefficient: 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 GeneratorTag[]: tags of the resource
timezone string: timezone that overrides location-based timezone of the resource

co2_coefficient GeneratorCo2CoefficientArgs: 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[GeneratorTagArgs]: tags of the resource
timezone str: timezone that overrides location-based timezone of the resource

co2Coefficient 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 Generator resource produces the following output properties:

ActivePowers List<Splight.Splight.Outputs.GeneratorActivePower>: attribute of the resource
DailyEmissionAvoideds List<Splight.Splight.Outputs.GeneratorDailyEmissionAvoided>: attribute of the resource
DailyEnergies List<Splight.Splight.Outputs.GeneratorDailyEnergy>: attribute of the resource
Id string: The provider-assigned unique ID for this managed resource.
Kinds List<Splight.Splight.Outputs.GeneratorKind>: kind of the resource
ReactivePowers List<Splight.Splight.Outputs.GeneratorReactivePower>: attribute of the resource

ActivePowers []GeneratorActivePower: attribute of the resource
DailyEmissionAvoideds []GeneratorDailyEmissionAvoided: attribute of the resource
DailyEnergies []GeneratorDailyEnergy: attribute of the resource
Id string: The provider-assigned unique ID for this managed resource.
Kinds []GeneratorKind: kind of the resource
ReactivePowers []GeneratorReactivePower: attribute of the resource

activePowers List<GeneratorActivePower>: attribute of the resource
dailyEmissionAvoideds List<GeneratorDailyEmissionAvoided>: attribute of the resource
dailyEnergies List<GeneratorDailyEnergy>: attribute of the resource
id String: The provider-assigned unique ID for this managed resource.
kinds List<GeneratorKind>: kind of the resource
reactivePowers List<GeneratorReactivePower>: attribute of the resource

activePowers GeneratorActivePower[]: attribute of the resource
dailyEmissionAvoideds GeneratorDailyEmissionAvoided[]: attribute of the resource
dailyEnergies GeneratorDailyEnergy[]: attribute of the resource
id string: The provider-assigned unique ID for this managed resource.
kinds GeneratorKind[]: kind of the resource
reactivePowers GeneratorReactivePower[]: attribute of the resource

active_powers Sequence[GeneratorActivePower]: attribute of the resource
daily_emission_avoideds Sequence[GeneratorDailyEmissionAvoided]: attribute of the resource
daily_energies Sequence[GeneratorDailyEnergy]: attribute of the resource
id str: The provider-assigned unique ID for this managed resource.
kinds Sequence[GeneratorKind]: kind of the resource
reactive_powers Sequence[GeneratorReactivePower]: attribute of the resource

activePowers List<Property Map>: attribute of the resource
dailyEmissionAvoideds List<Property Map>: attribute of the resource
dailyEnergies 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 Generator Resource

Get an existing Generator 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?: GeneratorState, opts?: CustomResourceOptions): Generator

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active_powers: Optional[Sequence[GeneratorActivePowerArgs]] = None,
        co2_coefficient: Optional[GeneratorCo2CoefficientArgs] = None,
        daily_emission_avoideds: Optional[Sequence[GeneratorDailyEmissionAvoidedArgs]] = None,
        daily_energies: Optional[Sequence[GeneratorDailyEnergyArgs]] = None,
        description: Optional[str] = None,
        geometry: Optional[str] = None,
        kinds: Optional[Sequence[GeneratorKindArgs]] = None,
        name: Optional[str] = None,
        reactive_powers: Optional[Sequence[GeneratorReactivePowerArgs]] = None,
        tags: Optional[Sequence[GeneratorTagArgs]] = None,
        timezone: Optional[str] = None) -> Generator

func GetGenerator(ctx *Context, name string, id IDInput, state *GeneratorState, opts ...ResourceOption) (*Generator, error)

public static Generator Get(string name, Input<string> id, GeneratorState? state, CustomResourceOptions? opts = null)

public static Generator get(String name, Output<String> id, GeneratorState 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:

ActivePowers List<Splight.Splight.Inputs.GeneratorActivePower>: attribute of the resource
Co2Coefficient Splight.Splight.Inputs.GeneratorCo2Coefficient: attribute of the resource
DailyEmissionAvoideds List<Splight.Splight.Inputs.GeneratorDailyEmissionAvoided>: attribute of the resource
DailyEnergies List<Splight.Splight.Inputs.GeneratorDailyEnergy>: attribute of the resource
Description string: description of the resource
Geometry string: geo position and shape of the resource
Kinds List<Splight.Splight.Inputs.GeneratorKind>: kind of the resource
Name string: name of the resource
ReactivePowers List<Splight.Splight.Inputs.GeneratorReactivePower>: attribute of the resource
Tags List<Splight.Splight.Inputs.GeneratorTag>: tags of the resource
Timezone string: timezone that overrides location-based timezone of the resource

ActivePowers []GeneratorActivePowerArgs: attribute of the resource
Co2Coefficient GeneratorCo2CoefficientArgs: attribute of the resource
DailyEmissionAvoideds []GeneratorDailyEmissionAvoidedArgs: attribute of the resource
DailyEnergies []GeneratorDailyEnergyArgs: attribute of the resource
Description string: description of the resource
Geometry string: geo position and shape of the resource
Kinds []GeneratorKindArgs: kind of the resource
Name string: name of the resource
ReactivePowers []GeneratorReactivePowerArgs: attribute of the resource
Tags []GeneratorTagArgs: tags of the resource
Timezone string: timezone that overrides location-based timezone of the resource

activePowers List<GeneratorActivePower>: attribute of the resource
co2Coefficient GeneratorCo2Coefficient: attribute of the resource
dailyEmissionAvoideds List<GeneratorDailyEmissionAvoided>: attribute of the resource
dailyEnergies List<GeneratorDailyEnergy>: attribute of the resource
description String: description of the resource
geometry String: geo position and shape of the resource
kinds List<GeneratorKind>: kind of the resource
name String: name of the resource
reactivePowers List<GeneratorReactivePower>: attribute of the resource
tags List<GeneratorTag>: tags of the resource
timezone String: timezone that overrides location-based timezone of the resource

activePowers GeneratorActivePower[]: attribute of the resource
co2Coefficient GeneratorCo2Coefficient: attribute of the resource
dailyEmissionAvoideds GeneratorDailyEmissionAvoided[]: attribute of the resource
dailyEnergies GeneratorDailyEnergy[]: attribute of the resource
description string: description of the resource
geometry string: geo position and shape of the resource
kinds GeneratorKind[]: kind of the resource
name string: name of the resource
reactivePowers GeneratorReactivePower[]: attribute of the resource
tags GeneratorTag[]: tags of the resource
timezone string: timezone that overrides location-based timezone of the resource

active_powers Sequence[GeneratorActivePowerArgs]: attribute of the resource
co2_coefficient GeneratorCo2CoefficientArgs: attribute of the resource
daily_emission_avoideds Sequence[GeneratorDailyEmissionAvoidedArgs]: attribute of the resource
daily_energies Sequence[GeneratorDailyEnergyArgs]: attribute of the resource
description str: description of the resource
geometry str: geo position and shape of the resource
kinds Sequence[GeneratorKindArgs]: kind of the resource
name str: name of the resource
reactive_powers Sequence[GeneratorReactivePowerArgs]: attribute of the resource
tags Sequence[GeneratorTagArgs]: tags of the resource
timezone str: timezone that overrides location-based timezone of the resource

activePowers List<Property Map>: attribute of the resource
co2Coefficient Property Map: attribute of the resource
dailyEmissionAvoideds List<Property Map>: attribute of the resource
dailyEnergies 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
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

GeneratorActivePower, GeneratorActivePowerArgs

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

GeneratorCo2Coefficient, GeneratorCo2CoefficientArgs

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

GeneratorDailyEmissionAvoided, GeneratorDailyEmissionAvoidedArgs

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

GeneratorDailyEnergy, GeneratorDailyEnergyArgs

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

GeneratorKind, GeneratorKindArgs

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

GeneratorReactivePower, GeneratorReactivePowerArgs

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

GeneratorTag, GeneratorTagArgs

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/generator:Generator [options] splight_generator.<name> <generator_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 v1.2.2 published on Friday, Nov 8, 2024 by splightplatform

splightplatform/pulumi-splight

splight.Generator

On this page

On this page

Example Usage

Create Generator Resource

Constructor syntax

Parameters

Constructor example

Generator Resource Properties

Inputs

Outputs

Look up Existing Generator Resource

Supporting Types

GeneratorActivePower, GeneratorActivePowerArgs

GeneratorCo2Coefficient, GeneratorCo2CoefficientArgs

GeneratorDailyEmissionAvoided, GeneratorDailyEmissionAvoidedArgs

GeneratorDailyEnergy, GeneratorDailyEnergyArgs

GeneratorKind, GeneratorKindArgs

GeneratorReactivePower, GeneratorReactivePowerArgs

GeneratorTag, GeneratorTagArgs

Import

Package Details

On this page

On this page