1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. oci
  5. getIotDigitalTwinInstance
Viewing docs for Oracle Cloud Infrastructure v4.5.0
published on Thursday, Apr 2, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

oci.oci.getIotDigitalTwinInstance

logo
Viewing docs for Oracle Cloud Infrastructure v4.5.0
published on Thursday, Apr 2, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

    This data source provides details about a specific Digital Twin Instance resource in Oracle Cloud Infrastructure Iot service.

    Retrieves the digital twin instance identified by the specified OCID.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testDigitalTwinInstance = oci.oci.getIotDigitalTwinInstance({
    digitalTwinInstanceId: testDigitalTwinInstanceOciIotDigitalTwinInstance.id,
});

    import pulumi
import pulumi_oci as oci

test_digital_twin_instance = oci.oci.get_iot_digital_twin_instance(digital_twin_instance_id=test_digital_twin_instance_oci_iot_digital_twin_instance["id"])

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v4/go/oci/oci"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := oci.LookupIotDigitalTwinInstance(ctx, &oci.LookupIotDigitalTwinInstanceArgs{
			DigitalTwinInstanceId: testDigitalTwinInstanceOciIotDigitalTwinInstance.Id,
		}, nil)
		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 testDigitalTwinInstance = Oci.Oci.GetIotDigitalTwinInstance.Invoke(new()
    {
        DigitalTwinInstanceId = testDigitalTwinInstanceOciIotDigitalTwinInstance.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.oci.OciFunctions;
import com.pulumi.oci.oci.inputs.GetIotDigitalTwinInstanceArgs;
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) {
        final var testDigitalTwinInstance = OciFunctions.getIotDigitalTwinInstance(GetIotDigitalTwinInstanceArgs.builder()
            .digitalTwinInstanceId(testDigitalTwinInstanceOciIotDigitalTwinInstance.id())
            .build());

    }
}

    variables:
  testDigitalTwinInstance:
    fn::invoke:
      function: oci:oci:getIotDigitalTwinInstance
      arguments:
        digitalTwinInstanceId: ${testDigitalTwinInstanceOciIotDigitalTwinInstance.id}

    Using getIotDigitalTwinInstance

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getIotDigitalTwinInstance(args: GetIotDigitalTwinInstanceArgs, opts?: InvokeOptions): Promise<GetIotDigitalTwinInstanceResult>
function getIotDigitalTwinInstanceOutput(args: GetIotDigitalTwinInstanceOutputArgs, opts?: InvokeOptions): Output<GetIotDigitalTwinInstanceResult>
    def get_iot_digital_twin_instance(digital_twin_instance_id: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetIotDigitalTwinInstanceResult
def get_iot_digital_twin_instance_output(digital_twin_instance_id: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetIotDigitalTwinInstanceResult]
    func LookupIotDigitalTwinInstance(ctx *Context, args *LookupIotDigitalTwinInstanceArgs, opts ...InvokeOption) (*LookupIotDigitalTwinInstanceResult, error)
func LookupIotDigitalTwinInstanceOutput(ctx *Context, args *LookupIotDigitalTwinInstanceOutputArgs, opts ...InvokeOption) LookupIotDigitalTwinInstanceResultOutput

    > Note: This function is named LookupIotDigitalTwinInstance in the Go SDK.

    public static class GetIotDigitalTwinInstance 
{
    public static Task<GetIotDigitalTwinInstanceResult> InvokeAsync(GetIotDigitalTwinInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetIotDigitalTwinInstanceResult> Invoke(GetIotDigitalTwinInstanceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIotDigitalTwinInstanceResult> getIotDigitalTwinInstance(GetIotDigitalTwinInstanceArgs args, InvokeOptions options)
public static Output<GetIotDigitalTwinInstanceResult> getIotDigitalTwinInstance(GetIotDigitalTwinInstanceArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:oci/getIotDigitalTwinInstance:getIotDigitalTwinInstance
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DigitalTwinInstanceId string
    The OCID of digital twin instance.
    DigitalTwinInstanceId string
    The OCID of digital twin instance.
    digitalTwinInstanceId String
    The OCID of digital twin instance.
    digitalTwinInstanceId string
    The OCID of digital twin instance.
    digital_twin_instance_id str
    The OCID of digital twin instance.
    digitalTwinInstanceId String
    The OCID of digital twin instance.

    getIotDigitalTwinInstance Result

    The following output properties are available:

    AuthId string
    The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
    DefinedTags Dictionary<string, string>
    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
    A short description of the resource.
    DigitalTwinAdapterId string
    The OCID of the digital twin adapter.
    DigitalTwinInstanceId string
    DigitalTwinModelId string
    The OCID of the digital twin model.
    DigitalTwinModelSpecUri string
    The URI of the digital twin model specification.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    ExternalKey string
    A unique identifier for the physical entity (typically an IoT device) represented by the digital twin instance. This could be a Bluetooth address, Ethernet MAC address, or serial number, depending on the use case. If not provided, the system will automatically generate one.
    FreeformTags Dictionary<string, string>
    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 string
    The OCID of the resource.
    IotDomainId string
    The OCID of the IoT domain.
    State string
    The current state of the digital twin instance.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time when the resource was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated 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
    AuthId string
    The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
    DefinedTags map[string]string
    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
    A short description of the resource.
    DigitalTwinAdapterId string
    The OCID of the digital twin adapter.
    DigitalTwinInstanceId string
    DigitalTwinModelId string
    The OCID of the digital twin model.
    DigitalTwinModelSpecUri string
    The URI of the digital twin model specification.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    ExternalKey string
    A unique identifier for the physical entity (typically an IoT device) represented by the digital twin instance. This could be a Bluetooth address, Ethernet MAC address, or serial number, depending on the use case. If not provided, the system will automatically generate one.
    FreeformTags map[string]string
    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 string
    The OCID of the resource.
    IotDomainId string
    The OCID of the IoT domain.
    State string
    The current state of the digital twin instance.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time when the resource was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated 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
    authId String
    The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
    definedTags Map<String,String>
    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
    A short description of the resource.
    digitalTwinAdapterId String
    The OCID of the digital twin adapter.
    digitalTwinInstanceId String
    digitalTwinModelId String
    The OCID of the digital twin model.
    digitalTwinModelSpecUri String
    The URI of the digital twin model specification.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    externalKey String
    A unique identifier for the physical entity (typically an IoT device) represented by the digital twin instance. This could be a Bluetooth address, Ethernet MAC address, or serial number, depending on the use case. If not provided, the system will automatically generate one.
    freeformTags Map<String,String>
    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 String
    The OCID of the resource.
    iotDomainId String
    The OCID of the IoT domain.
    state String
    The current state of the digital twin instance.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time when the resource was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated 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
    authId string
    The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
    definedTags {[key: string]: string}
    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
    A short description of the resource.
    digitalTwinAdapterId string
    The OCID of the digital twin adapter.
    digitalTwinInstanceId string
    digitalTwinModelId string
    The OCID of the digital twin model.
    digitalTwinModelSpecUri string
    The URI of the digital twin model specification.
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    externalKey string
    A unique identifier for the physical entity (typically an IoT device) represented by the digital twin instance. This could be a Bluetooth address, Ethernet MAC address, or serial number, depending on the use case. If not provided, the system will automatically generate one.
    freeformTags {[key: string]: string}
    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 string
    The OCID of the resource.
    iotDomainId string
    The OCID of the IoT domain.
    state string
    The current state of the digital twin instance.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time when the resource was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated 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
    auth_id str
    The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
    defined_tags Mapping[str, str]
    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
    A short description of the resource.
    digital_twin_adapter_id str
    The OCID of the digital twin adapter.
    digital_twin_instance_id str
    digital_twin_model_id str
    The OCID of the digital twin model.
    digital_twin_model_spec_uri str
    The URI of the digital twin model specification.
    display_name str
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    external_key str
    A unique identifier for the physical entity (typically an IoT device) represented by the digital twin instance. This could be a Bluetooth address, Ethernet MAC address, or serial number, depending on the use case. If not provided, the system will automatically generate one.
    freeform_tags Mapping[str, str]
    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 str
    The OCID of the resource.
    iot_domain_id str
    The OCID of the IoT domain.
    state str
    The current state of the digital twin instance.
    system_tags 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
    authId String
    The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
    definedTags Map<String>
    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
    A short description of the resource.
    digitalTwinAdapterId String
    The OCID of the digital twin adapter.
    digitalTwinInstanceId String
    digitalTwinModelId String
    The OCID of the digital twin model.
    digitalTwinModelSpecUri String
    The URI of the digital twin model specification.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    externalKey String
    A unique identifier for the physical entity (typically an IoT device) represented by the digital twin instance. This could be a Bluetooth address, Ethernet MAC address, or serial number, depending on the use case. If not provided, the system will automatically generate one.
    freeformTags Map<String>
    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 String
    The OCID of the resource.
    iotDomainId String
    The OCID of the IoT domain.
    state String
    The current state of the digital twin instance.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time when the resource was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated 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

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    logo
    Viewing docs for Oracle Cloud Infrastructure v4.5.0
    published on Thursday, Apr 2, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-oci
      Try Pulumi Cloud free. Your team will thank you.