Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi
oci.oci.getIotDigitalTwinInstances
This data source provides the list of Digital Twin Instances in Oracle Cloud Infrastructure Iot service.
Retrieves a list of digital twin instances within the specified IoT domain.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testDigitalTwinInstances = oci.oci.getIotDigitalTwinInstances({
iotDomainId: testIotDomain.id,
digitalTwinModelId: testDigitalTwinModel.id,
digitalTwinModelSpecUri: digitalTwinInstanceDigitalTwinModelSpecUri,
displayName: digitalTwinInstanceDisplayName,
id: digitalTwinInstanceId,
state: digitalTwinInstanceState,
});
import pulumi
import pulumi_oci as oci
test_digital_twin_instances = oci.oci.get_iot_digital_twin_instances(iot_domain_id=test_iot_domain["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,
id=digital_twin_instance_id,
state=digital_twin_instance_state)
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.GetIotDigitalTwinInstances(ctx, &oci.GetIotDigitalTwinInstancesArgs{
IotDomainId: testIotDomain.Id,
DigitalTwinModelId: pulumi.StringRef(testDigitalTwinModel.Id),
DigitalTwinModelSpecUri: pulumi.StringRef(digitalTwinInstanceDigitalTwinModelSpecUri),
DisplayName: pulumi.StringRef(digitalTwinInstanceDisplayName),
Id: pulumi.StringRef(digitalTwinInstanceId),
State: pulumi.StringRef(digitalTwinInstanceState),
}, 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 testDigitalTwinInstances = Oci.Oci.GetIotDigitalTwinInstances.Invoke(new()
{
IotDomainId = testIotDomain.Id,
DigitalTwinModelId = testDigitalTwinModel.Id,
DigitalTwinModelSpecUri = digitalTwinInstanceDigitalTwinModelSpecUri,
DisplayName = digitalTwinInstanceDisplayName,
Id = digitalTwinInstanceId,
State = digitalTwinInstanceState,
});
});
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.GetIotDigitalTwinInstancesArgs;
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 testDigitalTwinInstances = OciFunctions.getIotDigitalTwinInstances(GetIotDigitalTwinInstancesArgs.builder()
.iotDomainId(testIotDomain.id())
.digitalTwinModelId(testDigitalTwinModel.id())
.digitalTwinModelSpecUri(digitalTwinInstanceDigitalTwinModelSpecUri)
.displayName(digitalTwinInstanceDisplayName)
.id(digitalTwinInstanceId)
.state(digitalTwinInstanceState)
.build());
}
}
variables:
testDigitalTwinInstances:
fn::invoke:
function: oci:oci:getIotDigitalTwinInstances
arguments:
iotDomainId: ${testIotDomain.id}
digitalTwinModelId: ${testDigitalTwinModel.id}
digitalTwinModelSpecUri: ${digitalTwinInstanceDigitalTwinModelSpecUri}
displayName: ${digitalTwinInstanceDisplayName}
id: ${digitalTwinInstanceId}
state: ${digitalTwinInstanceState}
Using getIotDigitalTwinInstances
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 getIotDigitalTwinInstances(args: GetIotDigitalTwinInstancesArgs, opts?: InvokeOptions): Promise<GetIotDigitalTwinInstancesResult>
function getIotDigitalTwinInstancesOutput(args: GetIotDigitalTwinInstancesOutputArgs, opts?: InvokeOptions): Output<GetIotDigitalTwinInstancesResult>def get_iot_digital_twin_instances(digital_twin_model_id: Optional[str] = None,
digital_twin_model_spec_uri: Optional[str] = None,
display_name: Optional[str] = None,
filters: Optional[Sequence[GetIotDigitalTwinInstancesFilter]] = None,
id: Optional[str] = None,
iot_domain_id: Optional[str] = None,
state: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetIotDigitalTwinInstancesResult
def get_iot_digital_twin_instances_output(digital_twin_model_id: Optional[pulumi.Input[str]] = None,
digital_twin_model_spec_uri: Optional[pulumi.Input[str]] = None,
display_name: Optional[pulumi.Input[str]] = None,
filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetIotDigitalTwinInstancesFilterArgs]]]] = None,
id: Optional[pulumi.Input[str]] = None,
iot_domain_id: Optional[pulumi.Input[str]] = None,
state: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetIotDigitalTwinInstancesResult]func GetIotDigitalTwinInstances(ctx *Context, args *GetIotDigitalTwinInstancesArgs, opts ...InvokeOption) (*GetIotDigitalTwinInstancesResult, error)
func GetIotDigitalTwinInstancesOutput(ctx *Context, args *GetIotDigitalTwinInstancesOutputArgs, opts ...InvokeOption) GetIotDigitalTwinInstancesResultOutput> Note: This function is named GetIotDigitalTwinInstances in the Go SDK.
public static class GetIotDigitalTwinInstances
{
public static Task<GetIotDigitalTwinInstancesResult> InvokeAsync(GetIotDigitalTwinInstancesArgs args, InvokeOptions? opts = null)
public static Output<GetIotDigitalTwinInstancesResult> Invoke(GetIotDigitalTwinInstancesInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetIotDigitalTwinInstancesResult> getIotDigitalTwinInstances(GetIotDigitalTwinInstancesArgs args, InvokeOptions options)
public static Output<GetIotDigitalTwinInstancesResult> getIotDigitalTwinInstances(GetIotDigitalTwinInstancesArgs args, InvokeOptions options)
fn::invoke:
function: oci:oci/getIotDigitalTwinInstances:getIotDigitalTwinInstances
arguments:
# arguments dictionaryThe following arguments are supported:
- Iot
Domain stringId - The OCID of the IoT domain in which to list digital twin resources.
- Digital
Twin stringModel Id - Filter resources that match the specified OCID of the digital twin model.
- Digital
Twin stringModel Spec Uri - Filter resources that match the specified URI (DTMI) of the digital twin model.
- Display
Name string - Filter resources whose display name matches the specified value.
- Filters
List<Get
Iot Digital Twin Instances Filter> - Id string
- Filter resources by OCID. Must be a valid OCID of the resource type.
- State string
- Filter resources whose lifecycleState matches the specified value.
- Iot
Domain stringId - The OCID of the IoT domain in which to list digital twin resources.
- Digital
Twin stringModel Id - Filter resources that match the specified OCID of the digital twin model.
- Digital
Twin stringModel Spec Uri - Filter resources that match the specified URI (DTMI) of the digital twin model.
- Display
Name string - Filter resources whose display name matches the specified value.
- Filters
[]Get
Iot Digital Twin Instances Filter - Id string
- Filter resources by OCID. Must be a valid OCID of the resource type.
- State string
- Filter resources whose lifecycleState matches the specified value.
- iot
Domain StringId - The OCID of the IoT domain in which to list digital twin resources.
- digital
Twin StringModel Id - Filter resources that match the specified OCID of the digital twin model.
- digital
Twin StringModel Spec Uri - Filter resources that match the specified URI (DTMI) of the digital twin model.
- display
Name String - Filter resources whose display name matches the specified value.
- filters
List<Get
Iot Digital Twin Instances Filter> - id String
- Filter resources by OCID. Must be a valid OCID of the resource type.
- state String
- Filter resources whose lifecycleState matches the specified value.
- iot
Domain stringId - The OCID of the IoT domain in which to list digital twin resources.
- digital
Twin stringModel Id - Filter resources that match the specified OCID of the digital twin model.
- digital
Twin stringModel Spec Uri - Filter resources that match the specified URI (DTMI) of the digital twin model.
- display
Name string - Filter resources whose display name matches the specified value.
- filters
Get
Iot Digital Twin Instances Filter[] - id string
- Filter resources by OCID. Must be a valid OCID of the resource type.
- state string
- Filter resources whose lifecycleState matches the specified value.
- iot_
domain_ strid - The OCID of the IoT domain in which to list digital twin resources.
- digital_
twin_ strmodel_ id - Filter resources that match the specified OCID of the digital twin model.
- digital_
twin_ strmodel_ spec_ uri - Filter resources that match the specified URI (DTMI) of the digital twin model.
- display_
name str - Filter resources whose display name matches the specified value.
- filters
Sequence[Get
Iot Digital Twin Instances Filter] - id str
- Filter resources by OCID. Must be a valid OCID of the resource type.
- state str
- Filter resources whose lifecycleState matches the specified value.
- iot
Domain StringId - The OCID of the IoT domain in which to list digital twin resources.
- digital
Twin StringModel Id - Filter resources that match the specified OCID of the digital twin model.
- digital
Twin StringModel Spec Uri - Filter resources that match the specified URI (DTMI) of the digital twin model.
- display
Name String - Filter resources whose display name matches the specified value.
- filters List<Property Map>
- id String
- Filter resources by OCID. Must be a valid OCID of the resource type.
- state String
- Filter resources whose lifecycleState matches the specified value.
getIotDigitalTwinInstances Result
The following output properties are available:
- Digital
Twin List<GetInstance Collections Iot Digital Twin Instances Digital Twin Instance Collection> - The list of digital_twin_instance_collection.
- Iot
Domain stringId - The OCID of the IoT domain.
- 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 - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Filters
List<Get
Iot Digital Twin Instances Filter> - Id string
- The OCID of the resource.
- State string
- The current state of the digital twin instance.
- Digital
Twin []GetInstance Collections Iot Digital Twin Instances Digital Twin Instance Collection - The list of digital_twin_instance_collection.
- Iot
Domain stringId - The OCID of the IoT domain.
- 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 - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Filters
[]Get
Iot Digital Twin Instances Filter - Id string
- The OCID of the resource.
- State string
- The current state of the digital twin instance.
- digital
Twin List<GetInstance Collections Iot Digital Twin Instances Digital Twin Instance Collection> - The list of digital_twin_instance_collection.
- iot
Domain StringId - The OCID of the IoT domain.
- 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 - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filters
List<Get
Iot Digital Twin Instances Filter> - id String
- The OCID of the resource.
- state String
- The current state of the digital twin instance.
- digital
Twin GetInstance Collections Iot Digital Twin Instances Digital Twin Instance Collection[] - The list of digital_twin_instance_collection.
- iot
Domain stringId - The OCID of the IoT domain.
- 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 - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filters
Get
Iot Digital Twin Instances Filter[] - id string
- The OCID of the resource.
- state string
- The current state of the digital twin instance.
- digital_
twin_ Sequence[Getinstance_ collections Iot Digital Twin Instances Digital Twin Instance Collection] - The list of digital_twin_instance_collection.
- iot_
domain_ strid - The OCID of the IoT domain.
- 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 - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filters
Sequence[Get
Iot Digital Twin Instances Filter] - id str
- The OCID of the resource.
- state str
- The current state of the digital twin instance.
- digital
Twin List<Property Map>Instance Collections - The list of digital_twin_instance_collection.
- iot
Domain StringId - The OCID of the IoT domain.
- 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 - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filters List<Property Map>
- id String
- The OCID of the resource.
- state String
- The current state of the digital twin instance.
Supporting Types
GetIotDigitalTwinInstancesDigitalTwinInstanceCollection
GetIotDigitalTwinInstancesDigitalTwinInstanceCollectionItem
- Auth
Id string - The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
- 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.
- Digital
Twin stringAdapter Id - The OCID of the digital twin adapter.
- Digital
Twin stringModel Id - Filter resources that match the specified OCID of the digital twin model.
- Digital
Twin stringModel Spec Uri - Filter resources that match the specified URI (DTMI) of the digital twin model.
- Display
Name string - Filter resources whose display name matches the specified value.
- External
Key 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.
- 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
- Filter resources by OCID. Must be a valid OCID of the resource type.
- Iot
Domain stringId - The OCID of the IoT domain in which to list digital twin resources.
- State string
- Filter resources whose lifecycleState matches the specified value.
- 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
- Auth
Id string - The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
- 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.
- Digital
Twin stringAdapter Id - The OCID of the digital twin adapter.
- Digital
Twin stringModel Id - Filter resources that match the specified OCID of the digital twin model.
- Digital
Twin stringModel Spec Uri - Filter resources that match the specified URI (DTMI) of the digital twin model.
- Display
Name string - Filter resources whose display name matches the specified value.
- External
Key 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.
- 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
- Filter resources by OCID. Must be a valid OCID of the resource type.
- Iot
Domain stringId - The OCID of the IoT domain in which to list digital twin resources.
- State string
- Filter resources whose lifecycleState matches the specified value.
- 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
- auth
Id String - The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
- 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.
- digital
Twin StringAdapter Id - The OCID of the digital twin adapter.
- digital
Twin StringModel Id - Filter resources that match the specified OCID of the digital twin model.
- digital
Twin StringModel Spec Uri - Filter resources that match the specified URI (DTMI) of the digital twin model.
- display
Name String - Filter resources whose display name matches the specified value.
- external
Key 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.
- 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
- Filter resources by OCID. Must be a valid OCID of the resource type.
- iot
Domain StringId - The OCID of the IoT domain in which to list digital twin resources.
- state String
- Filter resources whose lifecycleState matches the specified value.
- 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
- auth
Id string - The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
- {[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.
- digital
Twin stringAdapter Id - The OCID of the digital twin adapter.
- digital
Twin stringModel Id - Filter resources that match the specified OCID of the digital twin model.
- digital
Twin stringModel Spec Uri - Filter resources that match the specified URI (DTMI) of the digital twin model.
- display
Name string - Filter resources whose display name matches the specified value.
- external
Key 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.
- {[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
- Filter resources by OCID. Must be a valid OCID of the resource type.
- iot
Domain stringId - The OCID of the IoT domain in which to list digital twin resources.
- state string
- Filter resources whose lifecycleState matches the specified value.
- {[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
- auth_
id str - The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
- 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_ stradapter_ id - The OCID of the digital twin adapter.
- digital_
twin_ strmodel_ id - Filter resources that match the specified OCID of the digital twin model.
- digital_
twin_ strmodel_ spec_ uri - Filter resources that match the specified URI (DTMI) of the digital twin model.
- display_
name str - Filter resources whose display name matches the specified value.
- 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.
- 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
- Filter resources by OCID. Must be a valid OCID of the resource type.
- iot_
domain_ strid - The OCID of the IoT domain in which to list digital twin resources.
- state str
- Filter resources whose lifecycleState matches the specified value.
- 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
- auth
Id String - The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
- 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.
- digital
Twin StringAdapter Id - The OCID of the digital twin adapter.
- digital
Twin StringModel Id - Filter resources that match the specified OCID of the digital twin model.
- digital
Twin StringModel Spec Uri - Filter resources that match the specified URI (DTMI) of the digital twin model.
- display
Name String - Filter resources whose display name matches the specified value.
- external
Key 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.
- 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
- Filter resources by OCID. Must be a valid OCID of the resource type.
- iot
Domain StringId - The OCID of the IoT domain in which to list digital twin resources.
- state String
- Filter resources whose lifecycleState matches the specified value.
- 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
GetIotDigitalTwinInstancesFilter
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ociTerraform Provider.
