Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testDigitalTwinAdapter = new oci.oci.IotDigitalTwinAdapter("test_digital_twin_adapter", {
iotDomainId: testIotDomain.id,
definedTags: {
"Operations.CostCenter": "42",
},
description: digitalTwinAdapterDescription,
digitalTwinModelId: testDigitalTwinModel.id,
digitalTwinModelSpecUri: digitalTwinAdapterDigitalTwinModelSpecUri,
displayName: digitalTwinAdapterDisplayName,
freeformTags: {
Department: "Finance",
},
inboundEnvelope: {
referenceEndpoint: digitalTwinAdapterInboundEnvelopeReferenceEndpoint,
envelopeMapping: {
timeObserved: digitalTwinAdapterInboundEnvelopeEnvelopeMappingTimeObserved,
},
referencePayload: {
data: digitalTwinAdapterInboundEnvelopeReferencePayloadData,
dataFormat: digitalTwinAdapterInboundEnvelopeReferencePayloadDataFormat,
},
},
inboundRoutes: [{
condition: digitalTwinAdapterInboundRoutesCondition,
description: digitalTwinAdapterInboundRoutesDescription,
payloadMapping: digitalTwinAdapterInboundRoutesPayloadMapping,
referencePayload: {
data: digitalTwinAdapterInboundRoutesReferencePayloadData,
dataFormat: digitalTwinAdapterInboundRoutesReferencePayloadDataFormat,
},
}],
});
import pulumi
import pulumi_oci as oci
test_digital_twin_adapter = oci.oci.IotDigitalTwinAdapter("test_digital_twin_adapter",
iot_domain_id=test_iot_domain["id"],
defined_tags={
"Operations.CostCenter": "42",
},
description=digital_twin_adapter_description,
digital_twin_model_id=test_digital_twin_model["id"],
digital_twin_model_spec_uri=digital_twin_adapter_digital_twin_model_spec_uri,
display_name=digital_twin_adapter_display_name,
freeform_tags={
"Department": "Finance",
},
inbound_envelope={
"reference_endpoint": digital_twin_adapter_inbound_envelope_reference_endpoint,
"envelope_mapping": {
"time_observed": digital_twin_adapter_inbound_envelope_envelope_mapping_time_observed,
},
"reference_payload": {
"data": digital_twin_adapter_inbound_envelope_reference_payload_data,
"data_format": digital_twin_adapter_inbound_envelope_reference_payload_data_format,
},
},
inbound_routes=[{
"condition": digital_twin_adapter_inbound_routes_condition,
"description": digital_twin_adapter_inbound_routes_description,
"payload_mapping": digital_twin_adapter_inbound_routes_payload_mapping,
"reference_payload": {
"data": digital_twin_adapter_inbound_routes_reference_payload_data,
"data_format": digital_twin_adapter_inbound_routes_reference_payload_data_format,
},
}])
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v3/go/oci/oci"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := oci.NewIotDigitalTwinAdapter(ctx, "test_digital_twin_adapter", &oci.IotDigitalTwinAdapterArgs{
IotDomainId: pulumi.Any(testIotDomain.Id),
DefinedTags: pulumi.StringMap{
"Operations.CostCenter": pulumi.String("42"),
},
Description: pulumi.Any(digitalTwinAdapterDescription),
DigitalTwinModelId: pulumi.Any(testDigitalTwinModel.Id),
DigitalTwinModelSpecUri: pulumi.Any(digitalTwinAdapterDigitalTwinModelSpecUri),
DisplayName: pulumi.Any(digitalTwinAdapterDisplayName),
FreeformTags: pulumi.StringMap{
"Department": pulumi.String("Finance"),
},
InboundEnvelope: &oci.IotDigitalTwinAdapterInboundEnvelopeArgs{
ReferenceEndpoint: pulumi.Any(digitalTwinAdapterInboundEnvelopeReferenceEndpoint),
EnvelopeMapping: &oci.IotDigitalTwinAdapterInboundEnvelopeEnvelopeMappingArgs{
TimeObserved: pulumi.Any(digitalTwinAdapterInboundEnvelopeEnvelopeMappingTimeObserved),
},
ReferencePayload: &oci.IotDigitalTwinAdapterInboundEnvelopeReferencePayloadArgs{
Data: pulumi.Any(digitalTwinAdapterInboundEnvelopeReferencePayloadData),
DataFormat: pulumi.Any(digitalTwinAdapterInboundEnvelopeReferencePayloadDataFormat),
},
},
InboundRoutes: oci.IotDigitalTwinAdapterInboundRouteArray{
&oci.IotDigitalTwinAdapterInboundRouteArgs{
Condition: pulumi.Any(digitalTwinAdapterInboundRoutesCondition),
Description: pulumi.Any(digitalTwinAdapterInboundRoutesDescription),
PayloadMapping: pulumi.Any(digitalTwinAdapterInboundRoutesPayloadMapping),
ReferencePayload: &oci.IotDigitalTwinAdapterInboundRouteReferencePayloadArgs{
Data: pulumi.Any(digitalTwinAdapterInboundRoutesReferencePayloadData),
DataFormat: pulumi.Any(digitalTwinAdapterInboundRoutesReferencePayloadDataFormat),
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testDigitalTwinAdapter = new Oci.Oci.IotDigitalTwinAdapter("test_digital_twin_adapter", new()
{
IotDomainId = testIotDomain.Id,
DefinedTags =
{
{ "Operations.CostCenter", "42" },
},
Description = digitalTwinAdapterDescription,
DigitalTwinModelId = testDigitalTwinModel.Id,
DigitalTwinModelSpecUri = digitalTwinAdapterDigitalTwinModelSpecUri,
DisplayName = digitalTwinAdapterDisplayName,
FreeformTags =
{
{ "Department", "Finance" },
},
InboundEnvelope = new Oci.Oci.Inputs.IotDigitalTwinAdapterInboundEnvelopeArgs
{
ReferenceEndpoint = digitalTwinAdapterInboundEnvelopeReferenceEndpoint,
EnvelopeMapping = new Oci.Oci.Inputs.IotDigitalTwinAdapterInboundEnvelopeEnvelopeMappingArgs
{
TimeObserved = digitalTwinAdapterInboundEnvelopeEnvelopeMappingTimeObserved,
},
ReferencePayload = new Oci.Oci.Inputs.IotDigitalTwinAdapterInboundEnvelopeReferencePayloadArgs
{
Data = digitalTwinAdapterInboundEnvelopeReferencePayloadData,
DataFormat = digitalTwinAdapterInboundEnvelopeReferencePayloadDataFormat,
},
},
InboundRoutes = new[]
{
new Oci.Oci.Inputs.IotDigitalTwinAdapterInboundRouteArgs
{
Condition = digitalTwinAdapterInboundRoutesCondition,
Description = digitalTwinAdapterInboundRoutesDescription,
PayloadMapping = digitalTwinAdapterInboundRoutesPayloadMapping,
ReferencePayload = new Oci.Oci.Inputs.IotDigitalTwinAdapterInboundRouteReferencePayloadArgs
{
Data = digitalTwinAdapterInboundRoutesReferencePayloadData,
DataFormat = digitalTwinAdapterInboundRoutesReferencePayloadDataFormat,
},
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.oci.IotDigitalTwinAdapter;
import com.pulumi.oci.oci.IotDigitalTwinAdapterArgs;
import com.pulumi.oci.oci.inputs.IotDigitalTwinAdapterInboundEnvelopeArgs;
import com.pulumi.oci.oci.inputs.IotDigitalTwinAdapterInboundEnvelopeEnvelopeMappingArgs;
import com.pulumi.oci.oci.inputs.IotDigitalTwinAdapterInboundEnvelopeReferencePayloadArgs;
import com.pulumi.oci.oci.inputs.IotDigitalTwinAdapterInboundRouteArgs;
import com.pulumi.oci.oci.inputs.IotDigitalTwinAdapterInboundRouteReferencePayloadArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var testDigitalTwinAdapter = new IotDigitalTwinAdapter("testDigitalTwinAdapter", IotDigitalTwinAdapterArgs.builder()
.iotDomainId(testIotDomain.id())
.definedTags(Map.of("Operations.CostCenter", "42"))
.description(digitalTwinAdapterDescription)
.digitalTwinModelId(testDigitalTwinModel.id())
.digitalTwinModelSpecUri(digitalTwinAdapterDigitalTwinModelSpecUri)
.displayName(digitalTwinAdapterDisplayName)
.freeformTags(Map.of("Department", "Finance"))
.inboundEnvelope(IotDigitalTwinAdapterInboundEnvelopeArgs.builder()
.referenceEndpoint(digitalTwinAdapterInboundEnvelopeReferenceEndpoint)
.envelopeMapping(IotDigitalTwinAdapterInboundEnvelopeEnvelopeMappingArgs.builder()
.timeObserved(digitalTwinAdapterInboundEnvelopeEnvelopeMappingTimeObserved)
.build())
.referencePayload(IotDigitalTwinAdapterInboundEnvelopeReferencePayloadArgs.builder()
.data(digitalTwinAdapterInboundEnvelopeReferencePayloadData)
.dataFormat(digitalTwinAdapterInboundEnvelopeReferencePayloadDataFormat)
.build())
.build())
.inboundRoutes(IotDigitalTwinAdapterInboundRouteArgs.builder()
.condition(digitalTwinAdapterInboundRoutesCondition)
.description(digitalTwinAdapterInboundRoutesDescription)
.payloadMapping(digitalTwinAdapterInboundRoutesPayloadMapping)
.referencePayload(IotDigitalTwinAdapterInboundRouteReferencePayloadArgs.builder()
.data(digitalTwinAdapterInboundRoutesReferencePayloadData)
.dataFormat(digitalTwinAdapterInboundRoutesReferencePayloadDataFormat)
.build())
.build())
.build());
}
}
resources:
testDigitalTwinAdapter:
type: oci:oci:IotDigitalTwinAdapter
name: test_digital_twin_adapter
properties:
iotDomainId: ${testIotDomain.id}
definedTags:
Operations.CostCenter: '42'
description: ${digitalTwinAdapterDescription}
digitalTwinModelId: ${testDigitalTwinModel.id}
digitalTwinModelSpecUri: ${digitalTwinAdapterDigitalTwinModelSpecUri}
displayName: ${digitalTwinAdapterDisplayName}
freeformTags:
Department: Finance
inboundEnvelope:
referenceEndpoint: ${digitalTwinAdapterInboundEnvelopeReferenceEndpoint}
envelopeMapping:
timeObserved: ${digitalTwinAdapterInboundEnvelopeEnvelopeMappingTimeObserved}
referencePayload:
data: ${digitalTwinAdapterInboundEnvelopeReferencePayloadData}
dataFormat: ${digitalTwinAdapterInboundEnvelopeReferencePayloadDataFormat}
inboundRoutes:
- condition: ${digitalTwinAdapterInboundRoutesCondition}
description: ${digitalTwinAdapterInboundRoutesDescription}
payloadMapping: ${digitalTwinAdapterInboundRoutesPayloadMapping}
referencePayload:
data: ${digitalTwinAdapterInboundRoutesReferencePayloadData}
dataFormat: ${digitalTwinAdapterInboundRoutesReferencePayloadDataFormat}
Create IotDigitalTwinAdapter Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new IotDigitalTwinAdapter(name: string, args: IotDigitalTwinAdapterArgs, opts?: CustomResourceOptions);@overload
def IotDigitalTwinAdapter(resource_name: str,
args: IotDigitalTwinAdapterArgs,
opts: Optional[ResourceOptions] = None)
@overload
def IotDigitalTwinAdapter(resource_name: str,
opts: Optional[ResourceOptions] = None,
iot_domain_id: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
digital_twin_model_id: Optional[str] = None,
digital_twin_model_spec_uri: Optional[str] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
inbound_envelope: Optional[IotDigitalTwinAdapterInboundEnvelopeArgs] = None,
inbound_routes: Optional[Sequence[IotDigitalTwinAdapterInboundRouteArgs]] = None)func NewIotDigitalTwinAdapter(ctx *Context, name string, args IotDigitalTwinAdapterArgs, opts ...ResourceOption) (*IotDigitalTwinAdapter, error)public IotDigitalTwinAdapter(string name, IotDigitalTwinAdapterArgs args, CustomResourceOptions? opts = null)
public IotDigitalTwinAdapter(String name, IotDigitalTwinAdapterArgs args)
public IotDigitalTwinAdapter(String name, IotDigitalTwinAdapterArgs args, CustomResourceOptions options)
type: oci:oci:IotDigitalTwinAdapter
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 IotDigitalTwinAdapterArgs
- 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 IotDigitalTwinAdapterArgs
- 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 IotDigitalTwinAdapterArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IotDigitalTwinAdapterArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args IotDigitalTwinAdapterArgs
- 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 iotDigitalTwinAdapterResource = new Oci.Oci.IotDigitalTwinAdapter("iotDigitalTwinAdapterResource", new()
{
IotDomainId = "string",
DefinedTags =
{
{ "string", "string" },
},
Description = "string",
DigitalTwinModelId = "string",
DigitalTwinModelSpecUri = "string",
DisplayName = "string",
FreeformTags =
{
{ "string", "string" },
},
InboundEnvelope = new Oci.Oci.Inputs.IotDigitalTwinAdapterInboundEnvelopeArgs
{
ReferenceEndpoint = "string",
EnvelopeMapping = new Oci.Oci.Inputs.IotDigitalTwinAdapterInboundEnvelopeEnvelopeMappingArgs
{
TimeObserved = "string",
},
ReferencePayload = new Oci.Oci.Inputs.IotDigitalTwinAdapterInboundEnvelopeReferencePayloadArgs
{
Data =
{
{ "string", "string" },
},
DataFormat = "string",
},
},
InboundRoutes = new[]
{
new Oci.Oci.Inputs.IotDigitalTwinAdapterInboundRouteArgs
{
Condition = "string",
Description = "string",
PayloadMapping =
{
{ "string", "string" },
},
ReferencePayload = new Oci.Oci.Inputs.IotDigitalTwinAdapterInboundRouteReferencePayloadArgs
{
Data =
{
{ "string", "string" },
},
DataFormat = "string",
},
},
},
});
example, err := oci.NewIotDigitalTwinAdapter(ctx, "iotDigitalTwinAdapterResource", &oci.IotDigitalTwinAdapterArgs{
IotDomainId: pulumi.String("string"),
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Description: pulumi.String("string"),
DigitalTwinModelId: pulumi.String("string"),
DigitalTwinModelSpecUri: pulumi.String("string"),
DisplayName: pulumi.String("string"),
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
InboundEnvelope: &oci.IotDigitalTwinAdapterInboundEnvelopeArgs{
ReferenceEndpoint: pulumi.String("string"),
EnvelopeMapping: &oci.IotDigitalTwinAdapterInboundEnvelopeEnvelopeMappingArgs{
TimeObserved: pulumi.String("string"),
},
ReferencePayload: &oci.IotDigitalTwinAdapterInboundEnvelopeReferencePayloadArgs{
Data: pulumi.StringMap{
"string": pulumi.String("string"),
},
DataFormat: pulumi.String("string"),
},
},
InboundRoutes: oci.IotDigitalTwinAdapterInboundRouteArray{
&oci.IotDigitalTwinAdapterInboundRouteArgs{
Condition: pulumi.String("string"),
Description: pulumi.String("string"),
PayloadMapping: pulumi.StringMap{
"string": pulumi.String("string"),
},
ReferencePayload: &oci.IotDigitalTwinAdapterInboundRouteReferencePayloadArgs{
Data: pulumi.StringMap{
"string": pulumi.String("string"),
},
DataFormat: pulumi.String("string"),
},
},
},
})
var iotDigitalTwinAdapterResource = new IotDigitalTwinAdapter("iotDigitalTwinAdapterResource", IotDigitalTwinAdapterArgs.builder()
.iotDomainId("string")
.definedTags(Map.of("string", "string"))
.description("string")
.digitalTwinModelId("string")
.digitalTwinModelSpecUri("string")
.displayName("string")
.freeformTags(Map.of("string", "string"))
.inboundEnvelope(IotDigitalTwinAdapterInboundEnvelopeArgs.builder()
.referenceEndpoint("string")
.envelopeMapping(IotDigitalTwinAdapterInboundEnvelopeEnvelopeMappingArgs.builder()
.timeObserved("string")
.build())
.referencePayload(IotDigitalTwinAdapterInboundEnvelopeReferencePayloadArgs.builder()
.data(Map.of("string", "string"))
.dataFormat("string")
.build())
.build())
.inboundRoutes(IotDigitalTwinAdapterInboundRouteArgs.builder()
.condition("string")
.description("string")
.payloadMapping(Map.of("string", "string"))
.referencePayload(IotDigitalTwinAdapterInboundRouteReferencePayloadArgs.builder()
.data(Map.of("string", "string"))
.dataFormat("string")
.build())
.build())
.build());
iot_digital_twin_adapter_resource = oci.oci.IotDigitalTwinAdapter("iotDigitalTwinAdapterResource",
iot_domain_id="string",
defined_tags={
"string": "string",
},
description="string",
digital_twin_model_id="string",
digital_twin_model_spec_uri="string",
display_name="string",
freeform_tags={
"string": "string",
},
inbound_envelope={
"reference_endpoint": "string",
"envelope_mapping": {
"time_observed": "string",
},
"reference_payload": {
"data": {
"string": "string",
},
"data_format": "string",
},
},
inbound_routes=[{
"condition": "string",
"description": "string",
"payload_mapping": {
"string": "string",
},
"reference_payload": {
"data": {
"string": "string",
},
"data_format": "string",
},
}])
const iotDigitalTwinAdapterResource = new oci.oci.IotDigitalTwinAdapter("iotDigitalTwinAdapterResource", {
iotDomainId: "string",
definedTags: {
string: "string",
},
description: "string",
digitalTwinModelId: "string",
digitalTwinModelSpecUri: "string",
displayName: "string",
freeformTags: {
string: "string",
},
inboundEnvelope: {
referenceEndpoint: "string",
envelopeMapping: {
timeObserved: "string",
},
referencePayload: {
data: {
string: "string",
},
dataFormat: "string",
},
},
inboundRoutes: [{
condition: "string",
description: "string",
payloadMapping: {
string: "string",
},
referencePayload: {
data: {
string: "string",
},
dataFormat: "string",
},
}],
});
type: oci:oci:IotDigitalTwinAdapter
properties:
definedTags:
string: string
description: string
digitalTwinModelId: string
digitalTwinModelSpecUri: string
displayName: string
freeformTags:
string: string
inboundEnvelope:
envelopeMapping:
timeObserved: string
referenceEndpoint: string
referencePayload:
data:
string: string
dataFormat: string
inboundRoutes:
- condition: string
description: string
payloadMapping:
string: string
referencePayload:
data:
string: string
dataFormat: string
iotDomainId: string
IotDigitalTwinAdapter 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 IotDigitalTwinAdapter resource accepts the following input properties:
- Iot
Domain stringId The OCID of the IoT domain.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Description string
- (Updatable) A short description of the resource.
- Digital
Twin stringModel Id - The OCID of the digital twin model.
- Digital
Twin stringModel Spec Uri - The URI of the digital twin model specification.
- Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Dictionary<string, string>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"} - Inbound
Envelope IotDigital Twin Adapter Inbound Envelope - (Updatable) Payload containing device-specific metadata and optional value mappings used to interpret or transform that metadata. This structure includes the device endpoint, the actual payload, and an optional envelope mapping that applies JQ expressions to extract or reshape the data as needed.
- Inbound
Routes List<IotDigital Twin Adapter Inbound Route> - (Updatable) list of inbound routes
- Iot
Domain stringId The OCID of the IoT domain.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Description string
- (Updatable) A short description of the resource.
- Digital
Twin stringModel Id - The OCID of the digital twin model.
- Digital
Twin stringModel Spec Uri - The URI of the digital twin model specification.
- Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- map[string]string
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"} - Inbound
Envelope IotDigital Twin Adapter Inbound Envelope Args - (Updatable) Payload containing device-specific metadata and optional value mappings used to interpret or transform that metadata. This structure includes the device endpoint, the actual payload, and an optional envelope mapping that applies JQ expressions to extract or reshape the data as needed.
- Inbound
Routes []IotDigital Twin Adapter Inbound Route Args - (Updatable) list of inbound routes
- iot
Domain StringId The OCID of the IoT domain.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - description String
- (Updatable) A short description of the resource.
- digital
Twin StringModel Id - The OCID of the digital twin model.
- digital
Twin StringModel Spec Uri - The URI of the digital twin model specification.
- display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Map<String,String>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"} - inbound
Envelope IotDigital Twin Adapter Inbound Envelope - (Updatable) Payload containing device-specific metadata and optional value mappings used to interpret or transform that metadata. This structure includes the device endpoint, the actual payload, and an optional envelope mapping that applies JQ expressions to extract or reshape the data as needed.
- inbound
Routes List<IotDigital Twin Adapter Inbound Route> - (Updatable) list of inbound routes
- iot
Domain stringId The OCID of the IoT domain.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - description string
- (Updatable) A short description of the resource.
- digital
Twin stringModel Id - The OCID of the digital twin model.
- digital
Twin stringModel Spec Uri - The URI of the digital twin model specification.
- display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- {[key: string]: string}
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"} - inbound
Envelope IotDigital Twin Adapter Inbound Envelope - (Updatable) Payload containing device-specific metadata and optional value mappings used to interpret or transform that metadata. This structure includes the device endpoint, the actual payload, and an optional envelope mapping that applies JQ expressions to extract or reshape the data as needed.
- inbound
Routes IotDigital Twin Adapter Inbound Route[] - (Updatable) list of inbound routes
- iot_
domain_ strid The OCID of the IoT domain.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - description str
- (Updatable) A short description of the resource.
- digital_
twin_ strmodel_ id - The OCID of the digital twin model.
- digital_
twin_ strmodel_ spec_ uri - The URI of the digital twin model specification.
- display_
name str - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Mapping[str, str]
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"} - inbound_
envelope IotDigital Twin Adapter Inbound Envelope Args - (Updatable) Payload containing device-specific metadata and optional value mappings used to interpret or transform that metadata. This structure includes the device endpoint, the actual payload, and an optional envelope mapping that applies JQ expressions to extract or reshape the data as needed.
- inbound_
routes Sequence[IotDigital Twin Adapter Inbound Route Args] - (Updatable) list of inbound routes
- iot
Domain StringId The OCID of the IoT domain.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - description String
- (Updatable) A short description of the resource.
- digital
Twin StringModel Id - The OCID of the digital twin model.
- digital
Twin StringModel Spec Uri - The URI of the digital twin model specification.
- display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Map<String>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"} - inbound
Envelope Property Map - (Updatable) Payload containing device-specific metadata and optional value mappings used to interpret or transform that metadata. This structure includes the device endpoint, the actual payload, and an optional envelope mapping that applies JQ expressions to extract or reshape the data as needed.
- inbound
Routes List<Property Map> - (Updatable) list of inbound routes
Outputs
All input properties are implicitly available as output properties. Additionally, the IotDigitalTwinAdapter resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- State string
- The current state of the digital twin adapter.
- Dictionary<string, string>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The date and time when the resource was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - Time
Updated string - The date and time when the resource was last updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Id string
- The provider-assigned unique ID for this managed resource.
- State string
- The current state of the digital twin adapter.
- map[string]string
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The date and time when the resource was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - Time
Updated string - The date and time when the resource was last updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- id String
- The provider-assigned unique ID for this managed resource.
- state String
- The current state of the digital twin adapter.
- Map<String,String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The date and time when the resource was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - time
Updated String - The date and time when the resource was last updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- id string
- The provider-assigned unique ID for this managed resource.
- state string
- The current state of the digital twin adapter.
- {[key: string]: string}
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created string - The date and time when the resource was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - time
Updated string - The date and time when the resource was last updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- id str
- The provider-assigned unique ID for this managed resource.
- state str
- The current state of the digital twin adapter.
- Mapping[str, str]
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"} - time_
created str - The date and time when the resource was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - time_
updated str - The date and time when the resource was last updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- id String
- The provider-assigned unique ID for this managed resource.
- state String
- The current state of the digital twin adapter.
- Map<String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The date and time when the resource was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - time
Updated String - The date and time when the resource was last updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
Look up Existing IotDigitalTwinAdapter Resource
Get an existing IotDigitalTwinAdapter 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?: IotDigitalTwinAdapterState, opts?: CustomResourceOptions): IotDigitalTwinAdapter@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
defined_tags: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
digital_twin_model_id: Optional[str] = None,
digital_twin_model_spec_uri: Optional[str] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
inbound_envelope: Optional[IotDigitalTwinAdapterInboundEnvelopeArgs] = None,
inbound_routes: Optional[Sequence[IotDigitalTwinAdapterInboundRouteArgs]] = None,
iot_domain_id: Optional[str] = None,
state: Optional[str] = None,
system_tags: Optional[Mapping[str, str]] = None,
time_created: Optional[str] = None,
time_updated: Optional[str] = None) -> IotDigitalTwinAdapterfunc GetIotDigitalTwinAdapter(ctx *Context, name string, id IDInput, state *IotDigitalTwinAdapterState, opts ...ResourceOption) (*IotDigitalTwinAdapter, error)public static IotDigitalTwinAdapter Get(string name, Input<string> id, IotDigitalTwinAdapterState? state, CustomResourceOptions? opts = null)public static IotDigitalTwinAdapter get(String name, Output<String> id, IotDigitalTwinAdapterState state, CustomResourceOptions options)resources: _: type: oci:oci:IotDigitalTwinAdapter 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.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Description string
- (Updatable) A short description of the resource.
- Digital
Twin stringModel Id - The OCID of the digital twin model.
- Digital
Twin stringModel Spec Uri - The URI of the digital twin model specification.
- Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Dictionary<string, string>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"} - Inbound
Envelope IotDigital Twin Adapter Inbound Envelope - (Updatable) Payload containing device-specific metadata and optional value mappings used to interpret or transform that metadata. This structure includes the device endpoint, the actual payload, and an optional envelope mapping that applies JQ expressions to extract or reshape the data as needed.
- Inbound
Routes List<IotDigital Twin Adapter Inbound Route> - (Updatable) list of inbound routes
- Iot
Domain stringId The OCID of the IoT domain.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- State string
- The current state of the digital twin adapter.
- Dictionary<string, string>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The date and time when the resource was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - Time
Updated string - The date and time when the resource was last updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Description string
- (Updatable) A short description of the resource.
- Digital
Twin stringModel Id - The OCID of the digital twin model.
- Digital
Twin stringModel Spec Uri - The URI of the digital twin model specification.
- Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- map[string]string
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"} - Inbound
Envelope IotDigital Twin Adapter Inbound Envelope Args - (Updatable) Payload containing device-specific metadata and optional value mappings used to interpret or transform that metadata. This structure includes the device endpoint, the actual payload, and an optional envelope mapping that applies JQ expressions to extract or reshape the data as needed.
- Inbound
Routes []IotDigital Twin Adapter Inbound Route Args - (Updatable) list of inbound routes
- Iot
Domain stringId The OCID of the IoT domain.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- State string
- The current state of the digital twin adapter.
- map[string]string
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The date and time when the resource was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - Time
Updated string - The date and time when the resource was last updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - description String
- (Updatable) A short description of the resource.
- digital
Twin StringModel Id - The OCID of the digital twin model.
- digital
Twin StringModel Spec Uri - The URI of the digital twin model specification.
- display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Map<String,String>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"} - inbound
Envelope IotDigital Twin Adapter Inbound Envelope - (Updatable) Payload containing device-specific metadata and optional value mappings used to interpret or transform that metadata. This structure includes the device endpoint, the actual payload, and an optional envelope mapping that applies JQ expressions to extract or reshape the data as needed.
- inbound
Routes List<IotDigital Twin Adapter Inbound Route> - (Updatable) list of inbound routes
- iot
Domain StringId The OCID of the IoT domain.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- state String
- The current state of the digital twin adapter.
- Map<String,String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The date and time when the resource was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - time
Updated String - The date and time when the resource was last updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - description string
- (Updatable) A short description of the resource.
- digital
Twin stringModel Id - The OCID of the digital twin model.
- digital
Twin stringModel Spec Uri - The URI of the digital twin model specification.
- display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- {[key: string]: string}
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"} - inbound
Envelope IotDigital Twin Adapter Inbound Envelope - (Updatable) Payload containing device-specific metadata and optional value mappings used to interpret or transform that metadata. This structure includes the device endpoint, the actual payload, and an optional envelope mapping that applies JQ expressions to extract or reshape the data as needed.
- inbound
Routes IotDigital Twin Adapter Inbound Route[] - (Updatable) list of inbound routes
- iot
Domain stringId The OCID of the IoT domain.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- state string
- The current state of the digital twin adapter.
- {[key: string]: string}
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created string - The date and time when the resource was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - time
Updated string - The date and time when the resource was last updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - description str
- (Updatable) A short description of the resource.
- digital_
twin_ strmodel_ id - The OCID of the digital twin model.
- digital_
twin_ strmodel_ spec_ uri - The URI of the digital twin model specification.
- display_
name str - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Mapping[str, str]
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"} - inbound_
envelope IotDigital Twin Adapter Inbound Envelope Args - (Updatable) Payload containing device-specific metadata and optional value mappings used to interpret or transform that metadata. This structure includes the device endpoint, the actual payload, and an optional envelope mapping that applies JQ expressions to extract or reshape the data as needed.
- inbound_
routes Sequence[IotDigital Twin Adapter Inbound Route Args] - (Updatable) list of inbound routes
- iot_
domain_ strid The OCID of the IoT domain.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- state str
- The current state of the digital twin adapter.
- Mapping[str, str]
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"} - time_
created str - The date and time when the resource was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - time_
updated str - The date and time when the resource was last updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - description String
- (Updatable) A short description of the resource.
- digital
Twin StringModel Id - The OCID of the digital twin model.
- digital
Twin StringModel Spec Uri - The URI of the digital twin model specification.
- display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Map<String>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"} - inbound
Envelope Property Map - (Updatable) Payload containing device-specific metadata and optional value mappings used to interpret or transform that metadata. This structure includes the device endpoint, the actual payload, and an optional envelope mapping that applies JQ expressions to extract or reshape the data as needed.
- inbound
Routes List<Property Map> - (Updatable) list of inbound routes
- iot
Domain StringId The OCID of the IoT domain.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- state String
- The current state of the digital twin adapter.
- Map<String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The date and time when the resource was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - time
Updated String - The date and time when the resource was last updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
Supporting Types
IotDigitalTwinAdapterInboundEnvelope, IotDigitalTwinAdapterInboundEnvelopeArgs
- Reference
Endpoint string - (Updatable) The device endpoint.
- Envelope
Mapping IotDigital Twin Adapter Inbound Envelope Envelope Mapping - (Updatable) Maps the metadata fields from the inbound payload using JQ. These mappings allow you to extract specific metadata such as timestamps using JQ expressions.
- Reference
Payload IotDigital Twin Adapter Inbound Envelope Reference Payload - (Updatable) Reference payload structure template received from IoT device. This payload must specify its content type using the
dataFormatproperty.
- Reference
Endpoint string - (Updatable) The device endpoint.
- Envelope
Mapping IotDigital Twin Adapter Inbound Envelope Envelope Mapping - (Updatable) Maps the metadata fields from the inbound payload using JQ. These mappings allow you to extract specific metadata such as timestamps using JQ expressions.
- Reference
Payload IotDigital Twin Adapter Inbound Envelope Reference Payload - (Updatable) Reference payload structure template received from IoT device. This payload must specify its content type using the
dataFormatproperty.
- reference
Endpoint String - (Updatable) The device endpoint.
- envelope
Mapping IotDigital Twin Adapter Inbound Envelope Envelope Mapping - (Updatable) Maps the metadata fields from the inbound payload using JQ. These mappings allow you to extract specific metadata such as timestamps using JQ expressions.
- reference
Payload IotDigital Twin Adapter Inbound Envelope Reference Payload - (Updatable) Reference payload structure template received from IoT device. This payload must specify its content type using the
dataFormatproperty.
- reference
Endpoint string - (Updatable) The device endpoint.
- envelope
Mapping IotDigital Twin Adapter Inbound Envelope Envelope Mapping - (Updatable) Maps the metadata fields from the inbound payload using JQ. These mappings allow you to extract specific metadata such as timestamps using JQ expressions.
- reference
Payload IotDigital Twin Adapter Inbound Envelope Reference Payload - (Updatable) Reference payload structure template received from IoT device. This payload must specify its content type using the
dataFormatproperty.
- reference_
endpoint str - (Updatable) The device endpoint.
- envelope_
mapping IotDigital Twin Adapter Inbound Envelope Envelope Mapping - (Updatable) Maps the metadata fields from the inbound payload using JQ. These mappings allow you to extract specific metadata such as timestamps using JQ expressions.
- reference_
payload IotDigital Twin Adapter Inbound Envelope Reference Payload - (Updatable) Reference payload structure template received from IoT device. This payload must specify its content type using the
dataFormatproperty.
- reference
Endpoint String - (Updatable) The device endpoint.
- envelope
Mapping Property Map - (Updatable) Maps the metadata fields from the inbound payload using JQ. These mappings allow you to extract specific metadata such as timestamps using JQ expressions.
- reference
Payload Property Map - (Updatable) Reference payload structure template received from IoT device. This payload must specify its content type using the
dataFormatproperty.
IotDigitalTwinAdapterInboundEnvelopeEnvelopeMapping, IotDigitalTwinAdapterInboundEnvelopeEnvelopeMappingArgs
- Time
Observed string - (Updatable) JQ expression to extract the observation timestamp from the payload. If not specified, the system will default to using
timeReceivedas the timestamp. Example: For payload{"time": "<timestamp>","temp": 65,"hum": 55}'timeObserved' can be mapped as JQ Expression$.time.
- Time
Observed string - (Updatable) JQ expression to extract the observation timestamp from the payload. If not specified, the system will default to using
timeReceivedas the timestamp. Example: For payload{"time": "<timestamp>","temp": 65,"hum": 55}'timeObserved' can be mapped as JQ Expression$.time.
- time
Observed String - (Updatable) JQ expression to extract the observation timestamp from the payload. If not specified, the system will default to using
timeReceivedas the timestamp. Example: For payload{"time": "<timestamp>","temp": 65,"hum": 55}'timeObserved' can be mapped as JQ Expression$.time.
- time
Observed string - (Updatable) JQ expression to extract the observation timestamp from the payload. If not specified, the system will default to using
timeReceivedas the timestamp. Example: For payload{"time": "<timestamp>","temp": 65,"hum": 55}'timeObserved' can be mapped as JQ Expression$.time.
- time_
observed str - (Updatable) JQ expression to extract the observation timestamp from the payload. If not specified, the system will default to using
timeReceivedas the timestamp. Example: For payload{"time": "<timestamp>","temp": 65,"hum": 55}'timeObserved' can be mapped as JQ Expression$.time.
- time
Observed String - (Updatable) JQ expression to extract the observation timestamp from the payload. If not specified, the system will default to using
timeReceivedas the timestamp. Example: For payload{"time": "<timestamp>","temp": 65,"hum": 55}'timeObserved' can be mapped as JQ Expression$.time.
IotDigitalTwinAdapterInboundEnvelopeReferencePayload, IotDigitalTwinAdapterInboundEnvelopeReferencePayloadArgs
- Data Dictionary<string, string>
- (Updatable) JSON raw data.
- Data
Format string - (Updatable) Data format of the payload.
- Data map[string]string
- (Updatable) JSON raw data.
- Data
Format string - (Updatable) Data format of the payload.
- data Map<String,String>
- (Updatable) JSON raw data.
- data
Format String - (Updatable) Data format of the payload.
- data {[key: string]: string}
- (Updatable) JSON raw data.
- data
Format string - (Updatable) Data format of the payload.
- data Mapping[str, str]
- (Updatable) JSON raw data.
- data_
format str - (Updatable) Data format of the payload.
- data Map<String>
- (Updatable) JSON raw data.
- data
Format String - (Updatable) Data format of the payload.
IotDigitalTwinAdapterInboundRoute, IotDigitalTwinAdapterInboundRouteArgs
- Condition string
- (Updatable) A boolean expression used to determine whether the following transformation should be processed for the incoming payload. This expression is typically based on fields defined at the inbound Envelope and is evaluated before applying the
payloadMapping. - Description string
- (Updatable) Meaningful write up about the inbound route.
- Payload
Mapping Dictionary<string, string> (Updatable) A set of key-value JQ expressions used to transform the incoming payload into a shape compatible with the digital twin model's context or schema.
The keys are target fields (in the digital twin model), and values are JQ expressions pointing to data in the reference payload.
Example: Given payload: { "time": "", "temp": 65, "hum": 55 } And mapping: { "temperature": "$.temp", "humidity": "$.hum", "timeObserved": "$.time" } The output will be: { "temperature": 65, "humidity": 55, "timeObserved": "" }
- Reference
Payload IotDigital Twin Adapter Inbound Route Reference Payload - (Updatable) Reference payload structure template received from IoT device. This payload must specify its content type using the
dataFormatproperty.
- Condition string
- (Updatable) A boolean expression used to determine whether the following transformation should be processed for the incoming payload. This expression is typically based on fields defined at the inbound Envelope and is evaluated before applying the
payloadMapping. - Description string
- (Updatable) Meaningful write up about the inbound route.
- Payload
Mapping map[string]string (Updatable) A set of key-value JQ expressions used to transform the incoming payload into a shape compatible with the digital twin model's context or schema.
The keys are target fields (in the digital twin model), and values are JQ expressions pointing to data in the reference payload.
Example: Given payload: { "time": "", "temp": 65, "hum": 55 } And mapping: { "temperature": "$.temp", "humidity": "$.hum", "timeObserved": "$.time" } The output will be: { "temperature": 65, "humidity": 55, "timeObserved": "" }
- Reference
Payload IotDigital Twin Adapter Inbound Route Reference Payload - (Updatable) Reference payload structure template received from IoT device. This payload must specify its content type using the
dataFormatproperty.
- condition String
- (Updatable) A boolean expression used to determine whether the following transformation should be processed for the incoming payload. This expression is typically based on fields defined at the inbound Envelope and is evaluated before applying the
payloadMapping. - description String
- (Updatable) Meaningful write up about the inbound route.
- payload
Mapping Map<String,String> (Updatable) A set of key-value JQ expressions used to transform the incoming payload into a shape compatible with the digital twin model's context or schema.
The keys are target fields (in the digital twin model), and values are JQ expressions pointing to data in the reference payload.
Example: Given payload: { "time": "", "temp": 65, "hum": 55 } And mapping: { "temperature": "$.temp", "humidity": "$.hum", "timeObserved": "$.time" } The output will be: { "temperature": 65, "humidity": 55, "timeObserved": "" }
- reference
Payload IotDigital Twin Adapter Inbound Route Reference Payload - (Updatable) Reference payload structure template received from IoT device. This payload must specify its content type using the
dataFormatproperty.
- condition string
- (Updatable) A boolean expression used to determine whether the following transformation should be processed for the incoming payload. This expression is typically based on fields defined at the inbound Envelope and is evaluated before applying the
payloadMapping. - description string
- (Updatable) Meaningful write up about the inbound route.
- payload
Mapping {[key: string]: string} (Updatable) A set of key-value JQ expressions used to transform the incoming payload into a shape compatible with the digital twin model's context or schema.
The keys are target fields (in the digital twin model), and values are JQ expressions pointing to data in the reference payload.
Example: Given payload: { "time": "", "temp": 65, "hum": 55 } And mapping: { "temperature": "$.temp", "humidity": "$.hum", "timeObserved": "$.time" } The output will be: { "temperature": 65, "humidity": 55, "timeObserved": "" }
- reference
Payload IotDigital Twin Adapter Inbound Route Reference Payload - (Updatable) Reference payload structure template received from IoT device. This payload must specify its content type using the
dataFormatproperty.
- condition str
- (Updatable) A boolean expression used to determine whether the following transformation should be processed for the incoming payload. This expression is typically based on fields defined at the inbound Envelope and is evaluated before applying the
payloadMapping. - description str
- (Updatable) Meaningful write up about the inbound route.
- payload_
mapping Mapping[str, str] (Updatable) A set of key-value JQ expressions used to transform the incoming payload into a shape compatible with the digital twin model's context or schema.
The keys are target fields (in the digital twin model), and values are JQ expressions pointing to data in the reference payload.
Example: Given payload: { "time": "", "temp": 65, "hum": 55 } And mapping: { "temperature": "$.temp", "humidity": "$.hum", "timeObserved": "$.time" } The output will be: { "temperature": 65, "humidity": 55, "timeObserved": "" }
- reference_
payload IotDigital Twin Adapter Inbound Route Reference Payload - (Updatable) Reference payload structure template received from IoT device. This payload must specify its content type using the
dataFormatproperty.
- condition String
- (Updatable) A boolean expression used to determine whether the following transformation should be processed for the incoming payload. This expression is typically based on fields defined at the inbound Envelope and is evaluated before applying the
payloadMapping. - description String
- (Updatable) Meaningful write up about the inbound route.
- payload
Mapping Map<String> (Updatable) A set of key-value JQ expressions used to transform the incoming payload into a shape compatible with the digital twin model's context or schema.
The keys are target fields (in the digital twin model), and values are JQ expressions pointing to data in the reference payload.
Example: Given payload: { "time": "", "temp": 65, "hum": 55 } And mapping: { "temperature": "$.temp", "humidity": "$.hum", "timeObserved": "$.time" } The output will be: { "temperature": 65, "humidity": 55, "timeObserved": "" }
- reference
Payload Property Map - (Updatable) Reference payload structure template received from IoT device. This payload must specify its content type using the
dataFormatproperty.
IotDigitalTwinAdapterInboundRouteReferencePayload, IotDigitalTwinAdapterInboundRouteReferencePayloadArgs
- Data Dictionary<string, string>
- (Updatable) JSON raw data.
- Data
Format string - (Updatable) Data format of the payload.
- Data map[string]string
- (Updatable) JSON raw data.
- Data
Format string - (Updatable) Data format of the payload.
- data Map<String,String>
- (Updatable) JSON raw data.
- data
Format String - (Updatable) Data format of the payload.
- data {[key: string]: string}
- (Updatable) JSON raw data.
- data
Format string - (Updatable) Data format of the payload.
- data Mapping[str, str]
- (Updatable) JSON raw data.
- data_
format str - (Updatable) Data format of the payload.
- data Map<String>
- (Updatable) JSON raw data.
- data
Format String - (Updatable) Data format of the payload.
Import
DigitalTwinAdapters can be imported using the id, e.g.
$ pulumi import oci:oci/iotDigitalTwinAdapter:IotDigitalTwinAdapter test_digital_twin_adapter "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ociTerraform Provider.
