splight v1.2.13, Feb 14 25

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

splight.ComponentRoutine

Explore with Pulumi AI

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

Example Usage

Create ComponentRoutine Resource

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

new ComponentRoutine(name: string, args: ComponentRoutineArgs, opts?: CustomResourceOptions);

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

@overload
def ComponentRoutine(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     component_id: Optional[str] = None,
                     type: Optional[str] = None,
                     configs: Optional[Sequence[ComponentRoutineConfigArgs]] = None,
                     description: Optional[str] = None,
                     inputs: Optional[Sequence[ComponentRoutineInputArgs]] = None,
                     name: Optional[str] = None,
                     outputs: Optional[Sequence[ComponentRoutineOutputArgs]] = None)

func NewComponentRoutine(ctx *Context, name string, args ComponentRoutineArgs, opts ...ResourceOption) (*ComponentRoutine, error)

public ComponentRoutine(string name, ComponentRoutineArgs args, CustomResourceOptions? opts = null)

public ComponentRoutine(String name, ComponentRoutineArgs args)
public ComponentRoutine(String name, ComponentRoutineArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args ComponentRoutineArgs: 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.

TypeScript
Python
Go
C#
Java
YAML

var componentRoutineResource = new Splight.ComponentRoutine("componentRoutineResource", new()
{
    ComponentId = "string",
    Type = "string",
    Configs = new[]
    {
        new Splight.Inputs.ComponentRoutineConfigArgs
        {
            Name = "string",
            Type = "string",
            Description = "string",
            Multiple = false,
            Required = false,
            Sensitive = false,
            Value = "string",
        },
    },
    Description = "string",
    Inputs = new[]
    {
        new Splight.Inputs.ComponentRoutineInputArgs
        {
            Name = "string",
            ValueType = "string",
            Description = "string",
            Multiple = false,
            Required = false,
            Type = "string",
            Values = new[]
            {
                new Splight.Inputs.ComponentRoutineInputValueArgs
                {
                    Asset = "string",
                    Attribute = "string",
                },
            },
        },
    },
    Name = "string",
    Outputs = new[]
    {
        new Splight.Inputs.ComponentRoutineOutputArgs
        {
            Name = "string",
            ValueType = "string",
            Description = "string",
            Multiple = false,
            Required = false,
            Type = "string",
            Values = new[]
            {
                new Splight.Inputs.ComponentRoutineOutputValueArgs
                {
                    Asset = "string",
                    Attribute = "string",
                },
            },
        },
    },
});

example, err := splight.NewComponentRoutine(ctx, "componentRoutineResource", &splight.ComponentRoutineArgs{
	ComponentId: pulumi.String("string"),
	Type:        pulumi.String("string"),
	Configs: splight.ComponentRoutineConfigArray{
		&splight.ComponentRoutineConfigArgs{
			Name:        pulumi.String("string"),
			Type:        pulumi.String("string"),
			Description: pulumi.String("string"),
			Multiple:    pulumi.Bool(false),
			Required:    pulumi.Bool(false),
			Sensitive:   pulumi.Bool(false),
			Value:       pulumi.String("string"),
		},
	},
	Description: pulumi.String("string"),
	Inputs: splight.ComponentRoutineInputTypeArray{
		&splight.ComponentRoutineInputTypeArgs{
			Name:        pulumi.String("string"),
			ValueType:   pulumi.String("string"),
			Description: pulumi.String("string"),
			Multiple:    pulumi.Bool(false),
			Required:    pulumi.Bool(false),
			Type:        pulumi.String("string"),
			Values: splight.ComponentRoutineInputValueArray{
				&splight.ComponentRoutineInputValueArgs{
					Asset:     pulumi.String("string"),
					Attribute: pulumi.String("string"),
				},
			},
		},
	},
	Name: pulumi.String("string"),
	Outputs: splight.ComponentRoutineOutputTypeArray{
		&splight.ComponentRoutineOutputTypeArgs{
			Name:        pulumi.String("string"),
			ValueType:   pulumi.String("string"),
			Description: pulumi.String("string"),
			Multiple:    pulumi.Bool(false),
			Required:    pulumi.Bool(false),
			Type:        pulumi.String("string"),
			Values: splight.ComponentRoutineOutputValueArray{
				&splight.ComponentRoutineOutputValueArgs{
					Asset:     pulumi.String("string"),
					Attribute: pulumi.String("string"),
				},
			},
		},
	},
})

var componentRoutineResource = new ComponentRoutine("componentRoutineResource", ComponentRoutineArgs.builder()
    .componentId("string")
    .type("string")
    .configs(ComponentRoutineConfigArgs.builder()
        .name("string")
        .type("string")
        .description("string")
        .multiple(false)
        .required(false)
        .sensitive(false)
        .value("string")
        .build())
    .description("string")
    .inputs(ComponentRoutineInputArgs.builder()
        .name("string")
        .valueType("string")
        .description("string")
        .multiple(false)
        .required(false)
        .type("string")
        .values(ComponentRoutineInputValueArgs.builder()
            .asset("string")
            .attribute("string")
            .build())
        .build())
    .name("string")
    .outputs(ComponentRoutineOutputArgs.builder()
        .name("string")
        .valueType("string")
        .description("string")
        .multiple(false)
        .required(false)
        .type("string")
        .values(ComponentRoutineOutputValueArgs.builder()
            .asset("string")
            .attribute("string")
            .build())
        .build())
    .build());

component_routine_resource = splight.ComponentRoutine("componentRoutineResource",
    component_id="string",
    type="string",
    configs=[{
        "name": "string",
        "type": "string",
        "description": "string",
        "multiple": False,
        "required": False,
        "sensitive": False,
        "value": "string",
    }],
    description="string",
    inputs=[{
        "name": "string",
        "value_type": "string",
        "description": "string",
        "multiple": False,
        "required": False,
        "type": "string",
        "values": [{
            "asset": "string",
            "attribute": "string",
        }],
    }],
    name="string",
    outputs=[{
        "name": "string",
        "value_type": "string",
        "description": "string",
        "multiple": False,
        "required": False,
        "type": "string",
        "values": [{
            "asset": "string",
            "attribute": "string",
        }],
    }])

const componentRoutineResource = new splight.ComponentRoutine("componentRoutineResource", {
    componentId: "string",
    type: "string",
    configs: [{
        name: "string",
        type: "string",
        description: "string",
        multiple: false,
        required: false,
        sensitive: false,
        value: "string",
    }],
    description: "string",
    inputs: [{
        name: "string",
        valueType: "string",
        description: "string",
        multiple: false,
        required: false,
        type: "string",
        values: [{
            asset: "string",
            attribute: "string",
        }],
    }],
    name: "string",
    outputs: [{
        name: "string",
        valueType: "string",
        description: "string",
        multiple: false,
        required: false,
        type: "string",
        values: [{
            asset: "string",
            attribute: "string",
        }],
    }],
});

type: splight:ComponentRoutine
properties:
    componentId: string
    configs:
        - description: string
          multiple: false
          name: string
          required: false
          sensitive: false
          type: string
          value: string
    description: string
    inputs:
        - description: string
          multiple: false
          name: string
          required: false
          type: string
          valueType: string
          values:
            - asset: string
              attribute: string
    name: string
    outputs:
        - description: string
          multiple: false
          name: string
          required: false
          type: string
          valueType: string
          values:
            - asset: string
              attribute: string
    type: string

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

ComponentId string: reference to component to be attached
Type string: [IncomingRoutine|OutgoingRoutine] direction of the data flow (from device to system or from system to device)
Configs List<Splight.Splight.Inputs.ComponentRoutineConfig>: static config parameters of the routine
Description string: optional complementary information about the routine
Inputs List<Splight.Splight.Inputs.ComponentRoutineInput>: asset attribute where to ingest data. Only valid for IncomingRoutine
Name string: name of the routine
Outputs List<Splight.Splight.Inputs.ComponentRoutineOutput>: asset attribute where to ingest data. Only valid for IncomingRoutine

ComponentId string: reference to component to be attached
Type string: [IncomingRoutine|OutgoingRoutine] direction of the data flow (from device to system or from system to device)
Configs []ComponentRoutineConfigArgs: static config parameters of the routine
Description string: optional complementary information about the routine
Inputs []ComponentRoutineInputTypeArgs: asset attribute where to ingest data. Only valid for IncomingRoutine
Name string: name of the routine
Outputs []ComponentRoutineOutputTypeArgs: asset attribute where to ingest data. Only valid for IncomingRoutine

componentId String: reference to component to be attached
type String: [IncomingRoutine|OutgoingRoutine] direction of the data flow (from device to system or from system to device)
configs List<ComponentRoutineConfig>: static config parameters of the routine
description String: optional complementary information about the routine
inputs List<ComponentRoutineInput>: asset attribute where to ingest data. Only valid for IncomingRoutine
name String: name of the routine
outputs List<ComponentRoutineOutput>: asset attribute where to ingest data. Only valid for IncomingRoutine

componentId string: reference to component to be attached
type string: [IncomingRoutine|OutgoingRoutine] direction of the data flow (from device to system or from system to device)
configs ComponentRoutineConfig[]: static config parameters of the routine
description string: optional complementary information about the routine
inputs ComponentRoutineInput[]: asset attribute where to ingest data. Only valid for IncomingRoutine
name string: name of the routine
outputs ComponentRoutineOutput[]: asset attribute where to ingest data. Only valid for IncomingRoutine

component_id str: reference to component to be attached
type str: [IncomingRoutine|OutgoingRoutine] direction of the data flow (from device to system or from system to device)
configs Sequence[ComponentRoutineConfigArgs]: static config parameters of the routine
description str: optional complementary information about the routine
inputs Sequence[ComponentRoutineInputArgs]: asset attribute where to ingest data. Only valid for IncomingRoutine
name str: name of the routine
outputs Sequence[ComponentRoutineOutputArgs]: asset attribute where to ingest data. Only valid for IncomingRoutine

componentId String: reference to component to be attached
type String: [IncomingRoutine|OutgoingRoutine] direction of the data flow (from device to system or from system to device)
configs List<Property Map>: static config parameters of the routine
description String: optional complementary information about the routine
inputs List<Property Map>: asset attribute where to ingest data. Only valid for IncomingRoutine
name String: name of the routine
outputs List<Property Map>: asset attribute where to ingest data. Only valid for IncomingRoutine

Outputs

All input properties are implicitly available as output properties. Additionally, the ComponentRoutine 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 ComponentRoutine Resource

Get an existing ComponentRoutine resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: ComponentRoutineState, opts?: CustomResourceOptions): ComponentRoutine

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        component_id: Optional[str] = None,
        configs: Optional[Sequence[ComponentRoutineConfigArgs]] = None,
        description: Optional[str] = None,
        inputs: Optional[Sequence[ComponentRoutineInputArgs]] = None,
        name: Optional[str] = None,
        outputs: Optional[Sequence[ComponentRoutineOutputArgs]] = None,
        type: Optional[str] = None) -> ComponentRoutine

func GetComponentRoutine(ctx *Context, name string, id IDInput, state *ComponentRoutineState, opts ...ResourceOption) (*ComponentRoutine, error)

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

public static ComponentRoutine get(String name, Output<String> id, ComponentRoutineState state, CustomResourceOptions options)

resources:  _:    type: splight:ComponentRoutine    get:      id: ${id}

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:

ComponentId string: reference to component to be attached
Configs List<Splight.Splight.Inputs.ComponentRoutineConfig>: static config parameters of the routine
Description string: optional complementary information about the routine
Inputs List<Splight.Splight.Inputs.ComponentRoutineInput>: asset attribute where to ingest data. Only valid for IncomingRoutine
Name string: name of the routine
Outputs List<Splight.Splight.Inputs.ComponentRoutineOutput>: asset attribute where to ingest data. Only valid for IncomingRoutine
Type string: [IncomingRoutine|OutgoingRoutine] direction of the data flow (from device to system or from system to device)

ComponentId string: reference to component to be attached
Configs []ComponentRoutineConfigArgs: static config parameters of the routine
Description string: optional complementary information about the routine
Inputs []ComponentRoutineInputTypeArgs: asset attribute where to ingest data. Only valid for IncomingRoutine
Name string: name of the routine
Outputs []ComponentRoutineOutputTypeArgs: asset attribute where to ingest data. Only valid for IncomingRoutine
Type string: [IncomingRoutine|OutgoingRoutine] direction of the data flow (from device to system or from system to device)

componentId String: reference to component to be attached
configs List<ComponentRoutineConfig>: static config parameters of the routine
description String: optional complementary information about the routine
inputs List<ComponentRoutineInput>: asset attribute where to ingest data. Only valid for IncomingRoutine
name String: name of the routine
outputs List<ComponentRoutineOutput>: asset attribute where to ingest data. Only valid for IncomingRoutine
type String: [IncomingRoutine|OutgoingRoutine] direction of the data flow (from device to system or from system to device)

componentId string: reference to component to be attached
configs ComponentRoutineConfig[]: static config parameters of the routine
description string: optional complementary information about the routine
inputs ComponentRoutineInput[]: asset attribute where to ingest data. Only valid for IncomingRoutine
name string: name of the routine
outputs ComponentRoutineOutput[]: asset attribute where to ingest data. Only valid for IncomingRoutine
type string: [IncomingRoutine|OutgoingRoutine] direction of the data flow (from device to system or from system to device)

component_id str: reference to component to be attached
configs Sequence[ComponentRoutineConfigArgs]: static config parameters of the routine
description str: optional complementary information about the routine
inputs Sequence[ComponentRoutineInputArgs]: asset attribute where to ingest data. Only valid for IncomingRoutine
name str: name of the routine
outputs Sequence[ComponentRoutineOutputArgs]: asset attribute where to ingest data. Only valid for IncomingRoutine
type str: [IncomingRoutine|OutgoingRoutine] direction of the data flow (from device to system or from system to device)

componentId String: reference to component to be attached
configs List<Property Map>: static config parameters of the routine
description String: optional complementary information about the routine
inputs List<Property Map>: asset attribute where to ingest data. Only valid for IncomingRoutine
name String: name of the routine
outputs List<Property Map>: asset attribute where to ingest data. Only valid for IncomingRoutine
type String: [IncomingRoutine|OutgoingRoutine] direction of the data flow (from device to system or from system to device)

Supporting Types

ComponentRoutineConfig
, ComponentRoutineConfigArgs

Name string
Type string
Description string
Multiple bool
Required bool
Sensitive bool
Value string

Name string
Type string
Description string
Multiple bool
Required bool
Sensitive bool
Value string

name String
type String
description String
multiple Boolean
required Boolean
sensitive Boolean
value String

name string
type string
description string
multiple boolean
required boolean
sensitive boolean
value string

name str
type str
description str
multiple bool
required bool
sensitive bool
value str

name String
type String
description String
multiple Boolean
required Boolean
sensitive Boolean
value String

ComponentRoutineInput
, ComponentRoutineInputArgs

Name string
ValueType string
Description string
Multiple bool
Required bool
Type string
Values List<Splight.Splight.Inputs.ComponentRoutineInputValue>

Name string
ValueType string
Description string
Multiple bool
Required bool
Type string
Values []ComponentRoutineInputValue

name String
valueType String
description String
multiple Boolean
required Boolean
type String
values List<ComponentRoutineInputValue>

name string
valueType string
description string
multiple boolean
required boolean
type string
values ComponentRoutineInputValue[]

name str
value_type str
description str
multiple bool
required bool
type str
values Sequence[ComponentRoutineInputValue]

name String
valueType String
description String
multiple Boolean
required Boolean
type String
values List<Property Map>

ComponentRoutineInputValue
, ComponentRoutineInputValueArgs

Asset string
Attribute string

Asset string
Attribute string

asset String
attribute String

asset string
attribute string

asset str
attribute str

asset String
attribute String

ComponentRoutineOutput
, ComponentRoutineOutputArgs

Name string
ValueType string
Description string
Multiple bool
Required bool
Type string
Values List<Splight.Splight.Inputs.ComponentRoutineOutputValue>

Name string
ValueType string
Description string
Multiple bool
Required bool
Type string
Values []ComponentRoutineOutputValue

name String
valueType String
description String
multiple Boolean
required Boolean
type String
values List<ComponentRoutineOutputValue>

name string
valueType string
description string
multiple boolean
required boolean
type string
values ComponentRoutineOutputValue[]

name str
value_type str
description str
multiple bool
required bool
type str
values Sequence[ComponentRoutineOutputValue]

name String
valueType String
description String
multiple Boolean
required Boolean
type String
values List<Property Map>

ComponentRoutineOutputValue
, ComponentRoutineOutputValueArgs

Asset string
Attribute string

Asset string
Attribute string

asset String
attribute String

asset string
attribute string

asset str
attribute str

asset String
attribute String

Import

$ pulumi import splight:index/componentRoutine:ComponentRoutine [options] splight_component_routine.<name> <component_routine_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.13 published on Friday, Feb 14, 2025 by splightplatform

splightplatform/pulumi-splight

splight.ComponentRoutine

On this page

On this page

Example Usage

Create ComponentRoutine Resource

Constructor syntax

Parameters

Constructor example

ComponentRoutine Resource Properties

Inputs

Outputs

Look up Existing ComponentRoutine Resource

Supporting Types

ComponentRoutineConfig
, ComponentRoutineConfigArgs

ComponentRoutineInput
, ComponentRoutineInputArgs

ComponentRoutineInputValue
, ComponentRoutineInputValueArgs

ComponentRoutineOutput
, ComponentRoutineOutputArgs

ComponentRoutineOutputValue
, ComponentRoutineOutputValueArgs

Import

Package Details

On this page

On this page

splight.ComponentRoutine

On this page

On this page

Example Usage

Create ComponentRoutine Resource

Constructor syntax

Parameters

Constructor example

ComponentRoutine Resource Properties

Inputs

Outputs

Look up Existing ComponentRoutine Resource

Supporting Types

ComponentRoutineConfig, ComponentRoutineConfigArgs

ComponentRoutineInput, ComponentRoutineInputArgs

ComponentRoutineInputValue, ComponentRoutineInputValueArgs

ComponentRoutineOutput, ComponentRoutineOutputArgs

ComponentRoutineOutputValue, ComponentRoutineOutputValueArgs

Import

Package Details

On this page

On this page

ComponentRoutineConfig
, ComponentRoutineConfigArgs

ComponentRoutineInput
, ComponentRoutineInputArgs

ComponentRoutineInputValue
, ComponentRoutineInputValueArgs

ComponentRoutineOutput
, ComponentRoutineOutputArgs

ComponentRoutineOutputValue
, ComponentRoutineOutputValueArgs