1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. oci
  5. IotDigitalTwinInstance
Oracle Cloud Infrastructure v3.11.1 published on Friday, Nov 14, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

oci.oci.IotDigitalTwinInstance

oci logo
Oracle Cloud Infrastructure v3.11.1 published on Friday, Nov 14, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

    Example Usage

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

const testDigitalTwinInstance = new oci.oci.IotDigitalTwinInstance("test_digital_twin_instance", {
    iotDomainId: testIotDomain.id,
    authId: testAuth.id,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    description: digitalTwinInstanceDescription,
    digitalTwinAdapterId: testDigitalTwinAdapter.id,
    digitalTwinModelId: testDigitalTwinModel.id,
    digitalTwinModelSpecUri: digitalTwinInstanceDigitalTwinModelSpecUri,
    displayName: digitalTwinInstanceDisplayName,
    externalKey: digitalTwinInstanceExternalKey,
    freeformTags: {
        Department: "Finance",
    },
});

    import pulumi
import pulumi_oci as oci

test_digital_twin_instance = oci.oci.IotDigitalTwinInstance("test_digital_twin_instance",
    iot_domain_id=test_iot_domain["id"],
    auth_id=test_auth["id"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    description=digital_twin_instance_description,
    digital_twin_adapter_id=test_digital_twin_adapter["id"],
    digital_twin_model_id=test_digital_twin_model["id"],
    digital_twin_model_spec_uri=digital_twin_instance_digital_twin_model_spec_uri,
    display_name=digital_twin_instance_display_name,
    external_key=digital_twin_instance_external_key,
    freeform_tags={
        "Department": "Finance",
    })

    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.NewIotDigitalTwinInstance(ctx, "test_digital_twin_instance", &oci.IotDigitalTwinInstanceArgs{
			IotDomainId: pulumi.Any(testIotDomain.Id),
			AuthId:      pulumi.Any(testAuth.Id),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			Description:             pulumi.Any(digitalTwinInstanceDescription),
			DigitalTwinAdapterId:    pulumi.Any(testDigitalTwinAdapter.Id),
			DigitalTwinModelId:      pulumi.Any(testDigitalTwinModel.Id),
			DigitalTwinModelSpecUri: pulumi.Any(digitalTwinInstanceDigitalTwinModelSpecUri),
			DisplayName:             pulumi.Any(digitalTwinInstanceDisplayName),
			ExternalKey:             pulumi.Any(digitalTwinInstanceExternalKey),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
		})
		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 = new Oci.Oci.IotDigitalTwinInstance("test_digital_twin_instance", new()
    {
        IotDomainId = testIotDomain.Id,
        AuthId = testAuth.Id,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        Description = digitalTwinInstanceDescription,
        DigitalTwinAdapterId = testDigitalTwinAdapter.Id,
        DigitalTwinModelId = testDigitalTwinModel.Id,
        DigitalTwinModelSpecUri = digitalTwinInstanceDigitalTwinModelSpecUri,
        DisplayName = digitalTwinInstanceDisplayName,
        ExternalKey = digitalTwinInstanceExternalKey,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.oci.IotDigitalTwinInstance;
import com.pulumi.oci.oci.IotDigitalTwinInstanceArgs;
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 testDigitalTwinInstance = new IotDigitalTwinInstance("testDigitalTwinInstance", IotDigitalTwinInstanceArgs.builder()
            .iotDomainId(testIotDomain.id())
            .authId(testAuth.id())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .description(digitalTwinInstanceDescription)
            .digitalTwinAdapterId(testDigitalTwinAdapter.id())
            .digitalTwinModelId(testDigitalTwinModel.id())
            .digitalTwinModelSpecUri(digitalTwinInstanceDigitalTwinModelSpecUri)
            .displayName(digitalTwinInstanceDisplayName)
            .externalKey(digitalTwinInstanceExternalKey)
            .freeformTags(Map.of("Department", "Finance"))
            .build());

    }
}

    resources:
  testDigitalTwinInstance:
    type: oci:oci:IotDigitalTwinInstance
    name: test_digital_twin_instance
    properties:
      iotDomainId: ${testIotDomain.id}
      authId: ${testAuth.id}
      definedTags:
        Operations.CostCenter: '42'
      description: ${digitalTwinInstanceDescription}
      digitalTwinAdapterId: ${testDigitalTwinAdapter.id}
      digitalTwinModelId: ${testDigitalTwinModel.id}
      digitalTwinModelSpecUri: ${digitalTwinInstanceDigitalTwinModelSpecUri}
      displayName: ${digitalTwinInstanceDisplayName}
      externalKey: ${digitalTwinInstanceExternalKey}
      freeformTags:
        Department: Finance

    Create IotDigitalTwinInstance Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new IotDigitalTwinInstance(name: string, args: IotDigitalTwinInstanceArgs, opts?: CustomResourceOptions);
    @overload
def IotDigitalTwinInstance(resource_name: str,
                           args: IotDigitalTwinInstanceArgs,
                           opts: Optional[ResourceOptions] = None)

@overload
def IotDigitalTwinInstance(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           iot_domain_id: Optional[str] = None,
                           auth_id: Optional[str] = None,
                           defined_tags: Optional[Mapping[str, str]] = None,
                           description: Optional[str] = None,
                           digital_twin_adapter_id: Optional[str] = None,
                           digital_twin_model_id: Optional[str] = None,
                           digital_twin_model_spec_uri: Optional[str] = None,
                           display_name: Optional[str] = None,
                           external_key: Optional[str] = None,
                           freeform_tags: Optional[Mapping[str, str]] = None)
    func NewIotDigitalTwinInstance(ctx *Context, name string, args IotDigitalTwinInstanceArgs, opts ...ResourceOption) (*IotDigitalTwinInstance, error)
    public IotDigitalTwinInstance(string name, IotDigitalTwinInstanceArgs args, CustomResourceOptions? opts = null)
    public IotDigitalTwinInstance(String name, IotDigitalTwinInstanceArgs args)
public IotDigitalTwinInstance(String name, IotDigitalTwinInstanceArgs args, CustomResourceOptions options)

    type: oci:oci:IotDigitalTwinInstance
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 IotDigitalTwinInstanceArgs
    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 IotDigitalTwinInstanceArgs
    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 IotDigitalTwinInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IotDigitalTwinInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IotDigitalTwinInstanceArgs
    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 iotDigitalTwinInstanceResource = new Oci.Oci.IotDigitalTwinInstance("iotDigitalTwinInstanceResource", new()
{
    IotDomainId = "string",
    AuthId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    DigitalTwinAdapterId = "string",
    DigitalTwinModelId = "string",
    DigitalTwinModelSpecUri = "string",
    DisplayName = "string",
    ExternalKey = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
});

    example, err := oci.NewIotDigitalTwinInstance(ctx, "iotDigitalTwinInstanceResource", &oci.IotDigitalTwinInstanceArgs{
	IotDomainId: pulumi.String("string"),
	AuthId:      pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description:             pulumi.String("string"),
	DigitalTwinAdapterId:    pulumi.String("string"),
	DigitalTwinModelId:      pulumi.String("string"),
	DigitalTwinModelSpecUri: pulumi.String("string"),
	DisplayName:             pulumi.String("string"),
	ExternalKey:             pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var iotDigitalTwinInstanceResource = new IotDigitalTwinInstance("iotDigitalTwinInstanceResource", IotDigitalTwinInstanceArgs.builder()
    .iotDomainId("string")
    .authId("string")
    .definedTags(Map.of("string", "string"))
    .description("string")
    .digitalTwinAdapterId("string")
    .digitalTwinModelId("string")
    .digitalTwinModelSpecUri("string")
    .displayName("string")
    .externalKey("string")
    .freeformTags(Map.of("string", "string"))
    .build());

    iot_digital_twin_instance_resource = oci.oci.IotDigitalTwinInstance("iotDigitalTwinInstanceResource",
    iot_domain_id="string",
    auth_id="string",
    defined_tags={
        "string": "string",
    },
    description="string",
    digital_twin_adapter_id="string",
    digital_twin_model_id="string",
    digital_twin_model_spec_uri="string",
    display_name="string",
    external_key="string",
    freeform_tags={
        "string": "string",
    })

    const iotDigitalTwinInstanceResource = new oci.oci.IotDigitalTwinInstance("iotDigitalTwinInstanceResource", {
    iotDomainId: "string",
    authId: "string",
    definedTags: {
        string: "string",
    },
    description: "string",
    digitalTwinAdapterId: "string",
    digitalTwinModelId: "string",
    digitalTwinModelSpecUri: "string",
    displayName: "string",
    externalKey: "string",
    freeformTags: {
        string: "string",
    },
});

    type: oci:oci:IotDigitalTwinInstance
properties:
    authId: string
    definedTags:
        string: string
    description: string
    digitalTwinAdapterId: string
    digitalTwinModelId: string
    digitalTwinModelSpecUri: string
    displayName: string
    externalKey: string
    freeformTags:
        string: string
    iotDomainId: string

    IotDigitalTwinInstance 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 IotDigitalTwinInstance resource accepts the following input properties:

    IotDomainId string

    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

    AuthId string
    (Updatable) The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
    DefinedTags 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.
    DigitalTwinAdapterId string
    (Updatable) The OCID of the digital twin adapter.
    DigitalTwinModelId string
    The OCID of the digital twin model.
    DigitalTwinModelSpecUri string
    The URI of the digital twin model specification.
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    ExternalKey string
    (Updatable) 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>
    (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"}
    IotDomainId string

    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

    AuthId string
    (Updatable) The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
    DefinedTags 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.
    DigitalTwinAdapterId string
    (Updatable) The OCID of the digital twin adapter.
    DigitalTwinModelId string
    The OCID of the digital twin model.
    DigitalTwinModelSpecUri string
    The URI of the digital twin model specification.
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    ExternalKey string
    (Updatable) 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
    (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"}
    iotDomainId String

    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

    authId String
    (Updatable) The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
    definedTags 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.
    digitalTwinAdapterId String
    (Updatable) The OCID of the digital twin adapter.
    digitalTwinModelId String
    The OCID of the digital twin model.
    digitalTwinModelSpecUri String
    The URI of the digital twin model specification.
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    externalKey String
    (Updatable) 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>
    (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"}
    iotDomainId string

    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

    authId string
    (Updatable) The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
    definedTags {[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.
    digitalTwinAdapterId string
    (Updatable) The OCID of the digital twin adapter.
    digitalTwinModelId string
    The OCID of the digital twin model.
    digitalTwinModelSpecUri string
    The URI of the digital twin model specification.
    displayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    externalKey string
    (Updatable) 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}
    (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"}
    iot_domain_id str

    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

    auth_id str
    (Updatable) The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
    defined_tags 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_adapter_id str
    (Updatable) The OCID of the digital twin adapter.
    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
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    external_key str
    (Updatable) 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]
    (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"}
    iotDomainId String

    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

    authId String
    (Updatable) The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
    definedTags 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.
    digitalTwinAdapterId String
    (Updatable) The OCID of the digital twin adapter.
    digitalTwinModelId String
    The OCID of the digital twin model.
    digitalTwinModelSpecUri String
    The URI of the digital twin model specification.
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    externalKey String
    (Updatable) 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>
    (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"}

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IotDigitalTwinInstance 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 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
    Id string
    The provider-assigned unique ID for this managed resource.
    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
    id String
    The provider-assigned unique ID for this managed resource.
    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
    id string
    The provider-assigned unique ID for this managed resource.
    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
    id str
    The provider-assigned unique ID for this managed resource.
    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
    id String
    The provider-assigned unique ID for this managed resource.
    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

    Look up Existing IotDigitalTwinInstance Resource

    Get an existing IotDigitalTwinInstance 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?: IotDigitalTwinInstanceState, opts?: CustomResourceOptions): IotDigitalTwinInstance
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        digital_twin_adapter_id: Optional[str] = None,
        digital_twin_model_id: Optional[str] = None,
        digital_twin_model_spec_uri: Optional[str] = None,
        display_name: Optional[str] = None,
        external_key: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = 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) -> IotDigitalTwinInstance
    func GetIotDigitalTwinInstance(ctx *Context, name string, id IDInput, state *IotDigitalTwinInstanceState, opts ...ResourceOption) (*IotDigitalTwinInstance, error)
    public static IotDigitalTwinInstance Get(string name, Input<string> id, IotDigitalTwinInstanceState? state, CustomResourceOptions? opts = null)
    public static IotDigitalTwinInstance get(String name, Output<String> id, IotDigitalTwinInstanceState state, CustomResourceOptions options)
    resources:  _:    type: oci:oci:IotDigitalTwinInstance    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.
    The following state arguments are supported:
    AuthId string
    (Updatable) The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
    DefinedTags 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.
    DigitalTwinAdapterId string
    (Updatable) The OCID of the digital twin adapter.
    DigitalTwinModelId string
    The OCID of the digital twin model.
    DigitalTwinModelSpecUri string
    The URI of the digital twin model specification.
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    ExternalKey string
    (Updatable) 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>
    (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"}
    IotDomainId string

    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 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
    (Updatable) The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
    DefinedTags 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.
    DigitalTwinAdapterId string
    (Updatable) The OCID of the digital twin adapter.
    DigitalTwinModelId string
    The OCID of the digital twin model.
    DigitalTwinModelSpecUri string
    The URI of the digital twin model specification.
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    ExternalKey string
    (Updatable) 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
    (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"}
    IotDomainId string

    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 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
    (Updatable) The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
    definedTags 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.
    digitalTwinAdapterId String
    (Updatable) The OCID of the digital twin adapter.
    digitalTwinModelId String
    The OCID of the digital twin model.
    digitalTwinModelSpecUri String
    The URI of the digital twin model specification.
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    externalKey String
    (Updatable) 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>
    (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"}
    iotDomainId String

    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 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
    (Updatable) The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
    definedTags {[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.
    digitalTwinAdapterId string
    (Updatable) The OCID of the digital twin adapter.
    digitalTwinModelId string
    The OCID of the digital twin model.
    digitalTwinModelSpecUri string
    The URI of the digital twin model specification.
    displayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    externalKey string
    (Updatable) 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}
    (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"}
    iotDomainId string

    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 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
    (Updatable) The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
    defined_tags 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_adapter_id str
    (Updatable) The OCID of the digital twin adapter.
    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
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    external_key str
    (Updatable) 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]
    (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"}
    iot_domain_id str

    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 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
    (Updatable) The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
    definedTags 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.
    digitalTwinAdapterId String
    (Updatable) The OCID of the digital twin adapter.
    digitalTwinModelId String
    The OCID of the digital twin model.
    digitalTwinModelSpecUri String
    The URI of the digital twin model specification.
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    externalKey String
    (Updatable) 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>
    (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"}
    iotDomainId String

    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 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

    Import

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

    $ pulumi import oci:oci/iotDigitalTwinInstance:IotDigitalTwinInstance test_digital_twin_instance "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 oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v3.11.1 published on Friday, Nov 14, 2025 by Pulumi
    Schema (JSON)
    pulumi/pulumi-oci
      Meet Neo: Your AI Platform Teammate