Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi
oci.Core.getClusterNetworkInstances
Start a Neo task
Explain and create an oci.Core.getClusterNetworkInstances resource
This data source provides the list of Cluster Network Instances in Oracle Cloud Infrastructure Core service.
Lists the instances in a cluster network with instance pools.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testClusterNetworkInstances = oci.Core.getClusterNetworkInstances({
clusterNetworkId: testClusterNetwork.id,
compartmentId: compartmentId,
displayName: clusterNetworkInstanceDisplayName,
});
import pulumi
import pulumi_oci as oci
test_cluster_network_instances = oci.Core.get_cluster_network_instances(cluster_network_id=test_cluster_network["id"],
compartment_id=compartment_id,
display_name=cluster_network_instance_display_name)
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v3/go/oci/core"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := core.GetClusterNetworkInstances(ctx, &core.GetClusterNetworkInstancesArgs{
ClusterNetworkId: testClusterNetwork.Id,
CompartmentId: compartmentId,
DisplayName: pulumi.StringRef(clusterNetworkInstanceDisplayName),
}, 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 testClusterNetworkInstances = Oci.Core.GetClusterNetworkInstances.Invoke(new()
{
ClusterNetworkId = testClusterNetwork.Id,
CompartmentId = compartmentId,
DisplayName = clusterNetworkInstanceDisplayName,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.CoreFunctions;
import com.pulumi.oci.Core.inputs.GetClusterNetworkInstancesArgs;
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 testClusterNetworkInstances = CoreFunctions.getClusterNetworkInstances(GetClusterNetworkInstancesArgs.builder()
.clusterNetworkId(testClusterNetwork.id())
.compartmentId(compartmentId)
.displayName(clusterNetworkInstanceDisplayName)
.build());
}
}
variables:
testClusterNetworkInstances:
fn::invoke:
function: oci:Core:getClusterNetworkInstances
arguments:
clusterNetworkId: ${testClusterNetwork.id}
compartmentId: ${compartmentId}
displayName: ${clusterNetworkInstanceDisplayName}
Using getClusterNetworkInstances
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 getClusterNetworkInstances(args: GetClusterNetworkInstancesArgs, opts?: InvokeOptions): Promise<GetClusterNetworkInstancesResult>
function getClusterNetworkInstancesOutput(args: GetClusterNetworkInstancesOutputArgs, opts?: InvokeOptions): Output<GetClusterNetworkInstancesResult>def get_cluster_network_instances(cluster_network_id: Optional[str] = None,
compartment_id: Optional[str] = None,
display_name: Optional[str] = None,
filters: Optional[Sequence[GetClusterNetworkInstancesFilter]] = None,
opts: Optional[InvokeOptions] = None) -> GetClusterNetworkInstancesResult
def get_cluster_network_instances_output(cluster_network_id: Optional[pulumi.Input[str]] = None,
compartment_id: Optional[pulumi.Input[str]] = None,
display_name: Optional[pulumi.Input[str]] = None,
filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetClusterNetworkInstancesFilterArgs]]]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetClusterNetworkInstancesResult]func GetClusterNetworkInstances(ctx *Context, args *GetClusterNetworkInstancesArgs, opts ...InvokeOption) (*GetClusterNetworkInstancesResult, error)
func GetClusterNetworkInstancesOutput(ctx *Context, args *GetClusterNetworkInstancesOutputArgs, opts ...InvokeOption) GetClusterNetworkInstancesResultOutput> Note: This function is named GetClusterNetworkInstances in the Go SDK.
public static class GetClusterNetworkInstances
{
public static Task<GetClusterNetworkInstancesResult> InvokeAsync(GetClusterNetworkInstancesArgs args, InvokeOptions? opts = null)
public static Output<GetClusterNetworkInstancesResult> Invoke(GetClusterNetworkInstancesInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetClusterNetworkInstancesResult> getClusterNetworkInstances(GetClusterNetworkInstancesArgs args, InvokeOptions options)
public static Output<GetClusterNetworkInstancesResult> getClusterNetworkInstances(GetClusterNetworkInstancesArgs args, InvokeOptions options)
fn::invoke:
function: oci:Core/getClusterNetworkInstances:getClusterNetworkInstances
arguments:
# arguments dictionaryThe following arguments are supported:
- Cluster
Network stringId - The OCID of the cluster network.
- Compartment
Id string - The OCID of the compartment.
- Display
Name string - A filter to return only resources that match the given display name exactly.
- Filters
List<Get
Cluster Network Instances Filter>
- Cluster
Network stringId - The OCID of the cluster network.
- Compartment
Id string - The OCID of the compartment.
- Display
Name string - A filter to return only resources that match the given display name exactly.
- Filters
[]Get
Cluster Network Instances Filter
- cluster
Network StringId - The OCID of the cluster network.
- compartment
Id String - The OCID of the compartment.
- display
Name String - A filter to return only resources that match the given display name exactly.
- filters
List<Get
Cluster Network Instances Filter>
- cluster
Network stringId - The OCID of the cluster network.
- compartment
Id string - The OCID of the compartment.
- display
Name string - A filter to return only resources that match the given display name exactly.
- filters
Get
Cluster Network Instances Filter[]
- cluster_
network_ strid - The OCID of the cluster network.
- compartment_
id str - The OCID of the compartment.
- display_
name str - A filter to return only resources that match the given display name exactly.
- filters
Sequence[Get
Cluster Network Instances Filter]
- cluster
Network StringId - The OCID of the cluster network.
- compartment
Id String - The OCID of the compartment.
- display
Name String - A filter to return only resources that match the given display name exactly.
- filters List<Property Map>
getClusterNetworkInstances Result
The following output properties are available:
- Cluster
Network stringId - Compartment
Id string - The OCID of the compartment that contains the instance.
- Id string
- The provider-assigned unique ID for this managed resource.
- Instances
List<Get
Cluster Network Instances Instance> - The list of instances.
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Filters
List<Get
Cluster Network Instances Filter>
- Cluster
Network stringId - Compartment
Id string - The OCID of the compartment that contains the instance.
- Id string
- The provider-assigned unique ID for this managed resource.
- Instances
[]Get
Cluster Network Instances Instance - The list of instances.
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Filters
[]Get
Cluster Network Instances Filter
- cluster
Network StringId - compartment
Id String - The OCID of the compartment that contains the instance.
- id String
- The provider-assigned unique ID for this managed resource.
- instances
List<Get
Cluster Network Instances Instance> - The list of instances.
- display
Name String - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filters
List<Get
Cluster Network Instances Filter>
- cluster
Network stringId - compartment
Id string - The OCID of the compartment that contains the instance.
- id string
- The provider-assigned unique ID for this managed resource.
- instances
Get
Cluster Network Instances Instance[] - The list of instances.
- display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filters
Get
Cluster Network Instances Filter[]
- cluster_
network_ strid - compartment_
id str - The OCID of the compartment that contains the instance.
- id str
- The provider-assigned unique ID for this managed resource.
- instances
Sequence[Get
Cluster Network Instances Instance] - The list of instances.
- display_
name str - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filters
Sequence[Get
Cluster Network Instances Filter]
- cluster
Network StringId - compartment
Id String - The OCID of the compartment that contains the instance.
- id String
- The provider-assigned unique ID for this managed resource.
- instances List<Property Map>
- The list of instances.
- 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>
Supporting Types
GetClusterNetworkInstancesFilter
GetClusterNetworkInstancesInstance
- Availability
Domain string - The availability domain the instance is running in.
- Compartment
Id string - The OCID of the compartment.
- Display
Name string - A filter to return only resources that match the given display name exactly.
- Fault
Domain string - The fault domain the instance is running in.
- Id string
- The OCID of the instance.
- Instance
Configuration stringId - The OCID of the instance confgiuration used to create the instance.
- Load
Balancer List<GetBackends Cluster Network Instances Instance Load Balancer Backend> - The load balancer backends that are configured for the instance pool instance.
- Region string
- The region that contains the availability domain the instance is running in.
- Shape string
- The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.
- State string
- The current state of the instance pool instance.
- Time
Created string - The date and time the instance pool instance was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- Availability
Domain string - The availability domain the instance is running in.
- Compartment
Id string - The OCID of the compartment.
- Display
Name string - A filter to return only resources that match the given display name exactly.
- Fault
Domain string - The fault domain the instance is running in.
- Id string
- The OCID of the instance.
- Instance
Configuration stringId - The OCID of the instance confgiuration used to create the instance.
- Load
Balancer []GetBackends Cluster Network Instances Instance Load Balancer Backend - The load balancer backends that are configured for the instance pool instance.
- Region string
- The region that contains the availability domain the instance is running in.
- Shape string
- The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.
- State string
- The current state of the instance pool instance.
- Time
Created string - The date and time the instance pool instance was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- availability
Domain String - The availability domain the instance is running in.
- compartment
Id String - The OCID of the compartment.
- display
Name String - A filter to return only resources that match the given display name exactly.
- fault
Domain String - The fault domain the instance is running in.
- id String
- The OCID of the instance.
- instance
Configuration StringId - The OCID of the instance confgiuration used to create the instance.
- load
Balancer List<GetBackends Cluster Network Instances Instance Load Balancer Backend> - The load balancer backends that are configured for the instance pool instance.
- region String
- The region that contains the availability domain the instance is running in.
- shape String
- The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.
- state String
- The current state of the instance pool instance.
- time
Created String - The date and time the instance pool instance was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- availability
Domain string - The availability domain the instance is running in.
- compartment
Id string - The OCID of the compartment.
- display
Name string - A filter to return only resources that match the given display name exactly.
- fault
Domain string - The fault domain the instance is running in.
- id string
- The OCID of the instance.
- instance
Configuration stringId - The OCID of the instance confgiuration used to create the instance.
- load
Balancer GetBackends Cluster Network Instances Instance Load Balancer Backend[] - The load balancer backends that are configured for the instance pool instance.
- region string
- The region that contains the availability domain the instance is running in.
- shape string
- The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.
- state string
- The current state of the instance pool instance.
- time
Created string - The date and time the instance pool instance was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- availability_
domain str - The availability domain the instance is running in.
- compartment_
id str - The OCID of the compartment.
- display_
name str - A filter to return only resources that match the given display name exactly.
- fault_
domain str - The fault domain the instance is running in.
- id str
- The OCID of the instance.
- instance_
configuration_ strid - The OCID of the instance confgiuration used to create the instance.
- load_
balancer_ Sequence[Getbackends Cluster Network Instances Instance Load Balancer Backend] - The load balancer backends that are configured for the instance pool instance.
- region str
- The region that contains the availability domain the instance is running in.
- shape str
- The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.
- state str
- The current state of the instance pool instance.
- time_
created str - The date and time the instance pool instance was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- availability
Domain String - The availability domain the instance is running in.
- compartment
Id String - The OCID of the compartment.
- display
Name String - A filter to return only resources that match the given display name exactly.
- fault
Domain String - The fault domain the instance is running in.
- id String
- The OCID of the instance.
- instance
Configuration StringId - The OCID of the instance confgiuration used to create the instance.
- load
Balancer List<Property Map>Backends - The load balancer backends that are configured for the instance pool instance.
- region String
- The region that contains the availability domain the instance is running in.
- shape String
- The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.
- state String
- The current state of the instance pool instance.
- time
Created String - The date and time the instance pool instance was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
GetClusterNetworkInstancesInstanceLoadBalancerBackend
- Backend
Health stringStatus - The health of the backend as observed by the load balancer.
- Backend
Name string - The name of the backend in the backend set.
- Backend
Set stringName - The name of the backend set on the load balancer.
- Load
Balancer stringId - The OCID of the load balancer attached to the instance pool.
- State string
- The current state of the instance pool instance.
- Backend
Health stringStatus - The health of the backend as observed by the load balancer.
- Backend
Name string - The name of the backend in the backend set.
- Backend
Set stringName - The name of the backend set on the load balancer.
- Load
Balancer stringId - The OCID of the load balancer attached to the instance pool.
- State string
- The current state of the instance pool instance.
- backend
Health StringStatus - The health of the backend as observed by the load balancer.
- backend
Name String - The name of the backend in the backend set.
- backend
Set StringName - The name of the backend set on the load balancer.
- load
Balancer StringId - The OCID of the load balancer attached to the instance pool.
- state String
- The current state of the instance pool instance.
- backend
Health stringStatus - The health of the backend as observed by the load balancer.
- backend
Name string - The name of the backend in the backend set.
- backend
Set stringName - The name of the backend set on the load balancer.
- load
Balancer stringId - The OCID of the load balancer attached to the instance pool.
- state string
- The current state of the instance pool instance.
- backend_
health_ strstatus - The health of the backend as observed by the load balancer.
- backend_
name str - The name of the backend in the backend set.
- backend_
set_ strname - The name of the backend set on the load balancer.
- load_
balancer_ strid - The OCID of the load balancer attached to the instance pool.
- state str
- The current state of the instance pool instance.
- backend
Health StringStatus - The health of the backend as observed by the load balancer.
- backend
Name String - The name of the backend in the backend set.
- backend
Set StringName - The name of the backend set on the load balancer.
- load
Balancer StringId - The OCID of the load balancer attached to the instance pool.
- state String
- The current state of the instance pool instance.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ociTerraform Provider.
