Oracle Cloud Infrastructure Documentation

Creating a Digital Twin Instance

Create a digital twin instance for your Internet of Things (IoT). A digital representation of a physical entity, that is based on a digital twin model if you want to receive structured data from a device.

For administrators, see Prerequisites for information about policies, certificates, and secrets.

You can create a digital twin instance with or without authentication:
  • With authentication: If the digital twin instance is set up to receive device data, then you must use the authentication ID parameter with a vault secret or certificate OCID, so the digital twin can authenticate. To do that create a secret or create a certificate in the same region and tenancy as any other related IoT resources.
  • Without authentication: If you want to create a digital twin instance without ingestible data from a device, then you can create a digital twin instance without the authentication ID. This enables you to create digital twin relationships to simulate your IoT environment without the complexity of data.

If you are receiving structured data from a device, then you must create and associate a digital twin model and a digital twin adapter to the digital twin instance.

For specific examples to set up digital twins, see Scenarios.

  • For unstructured data:

    Use the oci iot digital-twin-instance create command and the required parameters to create a digital twin instance for an associated IoT domain.

    Replace the <iot-domain-OCID> with the IoT domain's OCID you want to associate to this digital twin instance and replace <certificate-or-secret-OCID> with your certificate or secret:

    oci iot digital-twin-instance create --auth-id <certificate-or-secret-OCID> --iot-domain-id <iot-domain-OCID>

    For structured data:

    Use the oci iot digital-twin-instance create command and the required parameters. Structured data requires creating a digital twin instance with an authentication id and a digital twin adapter.

    Replace the <iot-domain-OCID> with the IoT domain's OCID you want to associate to this digital twin instance and replace <certificate-or-secret-OCID> with your certificate or secret.

    Replace the <digital-twin-adapter-OCID> with the related digital twin adapter OCID: 
    oci iot digital-twin-instance create --iot-domain-id <iot-domain-OCID> --auth-id <certificate-or-secret-OCID> --digital-twin-adapter-id <digital-twin-adapter-OCID>

    For more information, see Creating a Digital Twin Adapter.

    For a complete list of parameters and values for CLI commands, see CLI Command Reference.

  • Run the CreateDigitalTwinInstance operation to create a digital twin instance.