splight.ComponentRoutine
Explore with Pulumi AI
Example Usage
Create ComponentRoutine Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
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.
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=[splight.ComponentRoutineConfigArgs(
name="string",
type="string",
description="string",
multiple=False,
required=False,
sensitive=False,
value="string",
)],
description="string",
inputs=[splight.ComponentRoutineInputArgs(
name="string",
value_type="string",
description="string",
multiple=False,
required=False,
type="string",
values=[splight.ComponentRoutineInputValueArgs(
asset="string",
attribute="string",
)],
)],
name="string",
outputs=[splight.ComponentRoutineOutputArgs(
name="string",
value_type="string",
description="string",
multiple=False,
required=False,
type="string",
values=[splight.ComponentRoutineOutputValueArgs(
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
The ComponentRoutine resource accepts the following input properties:
- Component
Id 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. Component Routine Config> - static config parameters of the routine
- Description string
- optional complementary information about the routine
- Inputs
List<Splight.
Splight. Inputs. Component Routine Input> - asset attribute where to ingest data. Only valid for IncomingRoutine
- Name string
- name of the routine
- Outputs
List<Splight.
Splight. Inputs. Component Routine Output> - asset attribute where to ingest data. Only valid for IncomingRoutine
- Component
Id 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
[]Component
Routine Config Args - static config parameters of the routine
- Description string
- optional complementary information about the routine
- Inputs
[]Component
Routine Input Type Args - asset attribute where to ingest data. Only valid for IncomingRoutine
- Name string
- name of the routine
- Outputs
[]Component
Routine Output Type Args - asset attribute where to ingest data. Only valid for IncomingRoutine
- component
Id 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<Component
Routine Config> - static config parameters of the routine
- description String
- optional complementary information about the routine
- inputs
List<Component
Routine Input> - asset attribute where to ingest data. Only valid for IncomingRoutine
- name String
- name of the routine
- outputs
List<Component
Routine Output> - asset attribute where to ingest data. Only valid for IncomingRoutine
- component
Id 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
Component
Routine Config[] - static config parameters of the routine
- description string
- optional complementary information about the routine
- inputs
Component
Routine Input[] - asset attribute where to ingest data. Only valid for IncomingRoutine
- name string
- name of the routine
- outputs
Component
Routine Output[] - 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[Component
Routine Config Args] - static config parameters of the routine
- description str
- optional complementary information about the routine
- inputs
Sequence[Component
Routine Input Args] - asset attribute where to ingest data. Only valid for IncomingRoutine
- name str
- name of the routine
- outputs
Sequence[Component
Routine Output Args] - asset attribute where to ingest data. Only valid for IncomingRoutine
- component
Id 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.
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)
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.
- Component
Id string - reference to component to be attached
- Configs
List<Splight.
Splight. Inputs. Component Routine Config> - static config parameters of the routine
- Description string
- optional complementary information about the routine
- Inputs
List<Splight.
Splight. Inputs. Component Routine Input> - asset attribute where to ingest data. Only valid for IncomingRoutine
- Name string
- name of the routine
- Outputs
List<Splight.
Splight. Inputs. Component Routine Output> - 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 string - reference to component to be attached
- Configs
[]Component
Routine Config Args - static config parameters of the routine
- Description string
- optional complementary information about the routine
- Inputs
[]Component
Routine Input Type Args - asset attribute where to ingest data. Only valid for IncomingRoutine
- Name string
- name of the routine
- Outputs
[]Component
Routine Output Type Args - 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 String - reference to component to be attached
- configs
List<Component
Routine Config> - static config parameters of the routine
- description String
- optional complementary information about the routine
- inputs
List<Component
Routine Input> - asset attribute where to ingest data. Only valid for IncomingRoutine
- name String
- name of the routine
- outputs
List<Component
Routine Output> - 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 string - reference to component to be attached
- configs
Component
Routine Config[] - static config parameters of the routine
- description string
- optional complementary information about the routine
- inputs
Component
Routine Input[] - asset attribute where to ingest data. Only valid for IncomingRoutine
- name string
- name of the routine
- outputs
Component
Routine Output[] - 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[Component
Routine Config Args] - static config parameters of the routine
- description str
- optional complementary information about the routine
- inputs
Sequence[Component
Routine Input Args] - asset attribute where to ingest data. Only valid for IncomingRoutine
- name str
- name of the routine
- outputs
Sequence[Component
Routine Output Args] - 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)
- component
Id 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
ComponentRoutineInput, ComponentRoutineInputArgs
- Name string
- Value
Type string - Description string
- Multiple bool
- Required bool
- Type string
- Values
List<Splight.
Splight. Inputs. Component Routine Input Value>
- Name string
- Value
Type string - Description string
- Multiple bool
- Required bool
- Type string
- Values
[]Component
Routine Input Value
- name String
- value
Type String - description String
- multiple Boolean
- required Boolean
- type String
- values
List<Component
Routine Input Value>
- name string
- value
Type string - description string
- multiple boolean
- required boolean
- type string
- values
Component
Routine Input Value[]
- name str
- value_
type str - description str
- multiple bool
- required bool
- type str
- values
Sequence[Component
Routine Input Value]
- name String
- value
Type String - description String
- multiple Boolean
- required Boolean
- type String
- values List<Property Map>
ComponentRoutineInputValue, ComponentRoutineInputValueArgs
ComponentRoutineOutput, ComponentRoutineOutputArgs
- Name string
- Value
Type string - Description string
- Multiple bool
- Required bool
- Type string
- Values
List<Splight.
Splight. Inputs. Component Routine Output Value>
- Name string
- Value
Type string - Description string
- Multiple bool
- Required bool
- Type string
- Values
[]Component
Routine Output Value
- name String
- value
Type String - description String
- multiple Boolean
- required Boolean
- type String
- values
List<Component
Routine Output Value>
- name string
- value
Type string - description string
- multiple boolean
- required boolean
- type string
- values
Component
Routine Output Value[]
- name str
- value_
type str - description str
- multiple bool
- required bool
- type str
- values
Sequence[Component
Routine Output Value]
- name String
- value
Type String - description String
- multiple Boolean
- required Boolean
- type String
- values List<Property Map>
ComponentRoutineOutputValue, ComponentRoutineOutputValueArgs
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.