oci_iot_digital_twin_adapter

This resource provides the Digital Twin Adapter resource in Oracle Cloud Infrastructure Iot service.

Creates a new digital twin adapter.

Example Usage

resource "oci_iot_digital_twin_adapter" "test_digital_twin_adapter" {
	#Required
	iot_domain_id = oci_iot_iot_domain.test_iot_domain.id

	#Optional
	defined_tags = {"Operations.CostCenter"= "42"}
	description = var.digital_twin_adapter_description
	digital_twin_model_id = oci_iot_digital_twin_model.test_digital_twin_model.id
	digital_twin_model_spec_uri = var.digital_twin_adapter_digital_twin_model_spec_uri
	display_name = var.digital_twin_adapter_display_name
	freeform_tags = {"Department"= "Finance"}
	inbound_envelope {
		#Required
		reference_endpoint = var.digital_twin_adapter_inbound_envelope_reference_endpoint

		#Optional
		envelope_mapping {

			#Optional
			time_observed = var.digital_twin_adapter_inbound_envelope_envelope_mapping_time_observed
		}
		reference_payload {
			#Required
			data = var.digital_twin_adapter_inbound_envelope_reference_payload_data
			data_format = var.digital_twin_adapter_inbound_envelope_reference_payload_data_format
		}
	}
	inbound_routes {
		#Required
		condition = var.digital_twin_adapter_inbound_routes_condition

		#Optional
		description = var.digital_twin_adapter_inbound_routes_description
		payload_mapping = var.digital_twin_adapter_inbound_routes_payload_mapping
		reference_payload {
			#Required
			data = var.digital_twin_adapter_inbound_routes_reference_payload_data
			data_format = var.digital_twin_adapter_inbound_routes_reference_payload_data_format
		}
	}
}

Argument Reference

The following arguments are supported:

defined_tags - (Optional) (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 - (Optional) (Updatable) A short description of the resource.
digital_twin_model_id - (Optional) The OCID of the digital twin model.
digital_twin_model_spec_uri - (Optional) The URI of the digital twin model specification.
display_name - (Optional) (Updatable) A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
freeform_tags - (Optional) (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 - (Optional) (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.
- envelope_mapping - (Optional) (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.
  - time_observed - (Optional) (Updatable) JQ expression to extract the observation timestamp from the payload. If not specified, the system will default to using timeReceived as the timestamp. Example: For payload {"time": "<timestamp>","temp": 65,"hum": 55} ‘timeObserved’ can be mapped as JQ Expression $.time.
- reference_endpoint - (Required) (Updatable) The device endpoint.
- reference_payload - (Optional) (Updatable) Reference payload structure template received from IoT device. This payload must specify its content type using the dataFormat property.
  - data - (Required) (Updatable) JSON raw data.
  - data_format - (Required) (Updatable) Data format of the payload.
inbound_routes - (Optional) (Updatable) list of inbound routes
- condition - (Required) (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 - (Optional) (Updatable) Meaningful write up about the inbound route.
- payload_mapping - (Optional) (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 - (Optional) (Updatable) Reference payload structure template received from IoT device. This payload must specify its content type using the dataFormat property.
  - data - (Required) (Updatable) JSON raw data.
  - data_format - (Required) (Updatable) Data format of the payload.
iot_domain_id - (Required) 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

Attributes Reference

The following attributes are exported:

defined_tags - 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 - A short description of the resource.
digital_twin_model_id - The OCID of the digital twin model.
digital_twin_model_spec_uri - The URI of the digital twin model specification.
display_name - A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
freeform_tags - 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"}
id - The OCID of the resource.
inbound_envelope - 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.
- envelope_mapping - Maps the metadata fields from the inbound payload using JQ. These mappings allow you to extract specific metadata such as timestamps using JQ expressions.
  - time_observed - JQ expression to extract the observation timestamp from the payload. If not specified, the system will default to using timeReceived as the timestamp. Example: For payload {"time": "<timestamp>","temp": 65,"hum": 55} ‘timeObserved’ can be mapped as JQ Expression $.time.
- reference_endpoint - The device endpoint.
- reference_payload - Reference payload structure template received from IoT device. This payload must specify its content type using the dataFormat property.
  - data - JSON raw data.
  - data_format - Data format of the payload.
inbound_routes - list of routes
- condition - 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 - Meaningful write up about the inbound route.
- payload_mapping - 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 - Reference payload structure template received from IoT device. This payload must specify its content type using the dataFormat property.
  - data - JSON raw data.
  - data_format - Data format of the payload.
iot_domain_id - The OCID of the IoT domain.
state - The current state of the digital twin adapter.
system_tags - System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created - 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 - The date and time when the resource was last updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

Timeouts

The timeouts block allows you to specify timeouts for certain operations: * create - (Defaults to 20 minutes), when creating the Digital Twin Adapter * update - (Defaults to 20 minutes), when updating the Digital Twin Adapter * delete - (Defaults to 20 minutes), when destroying the Digital Twin Adapter

Import

DigitalTwinAdapters can be imported using the id, e.g.

$ terraform import oci_iot_digital_twin_adapter.test_digital_twin_adapter "id"