Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. getClusterNetworkInstances
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

oci.Core.getClusterNetworkInstances

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

    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/v2/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[_core.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[_core.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)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: oci:Core/getClusterNetworkInstances:getClusterNetworkInstances
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ClusterNetworkId string
    The OCID of the cluster network.
    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    Filters List<GetClusterNetworkInstancesFilter>
    ClusterNetworkId string
    The OCID of the cluster network.
    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    Filters []GetClusterNetworkInstancesFilter
    clusterNetworkId String
    The OCID of the cluster network.
    compartmentId String
    The OCID of the compartment.
    displayName String
    A filter to return only resources that match the given display name exactly.
    filters List<GetClusterNetworkInstancesFilter>
    clusterNetworkId string
    The OCID of the cluster network.
    compartmentId string
    The OCID of the compartment.
    displayName string
    A filter to return only resources that match the given display name exactly.
    filters GetClusterNetworkInstancesFilter[]
    cluster_network_id str
    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[core.GetClusterNetworkInstancesFilter]
    clusterNetworkId String
    The OCID of the cluster network.
    compartmentId String
    The OCID of the compartment.
    displayName 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:

    ClusterNetworkId string
    CompartmentId string
    The OCID of the compartment that contains the instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    Instances List<GetClusterNetworkInstancesInstance>
    The list of instances.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    Filters List<GetClusterNetworkInstancesFilter>
    ClusterNetworkId string
    CompartmentId string
    The OCID of the compartment that contains the instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    Instances []GetClusterNetworkInstancesInstance
    The list of instances.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    Filters []GetClusterNetworkInstancesFilter
    clusterNetworkId String
    compartmentId String
    The OCID of the compartment that contains the instance.
    id String
    The provider-assigned unique ID for this managed resource.
    instances List<GetClusterNetworkInstancesInstance>
    The list of instances.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    filters List<GetClusterNetworkInstancesFilter>
    clusterNetworkId string
    compartmentId string
    The OCID of the compartment that contains the instance.
    id string
    The provider-assigned unique ID for this managed resource.
    instances GetClusterNetworkInstancesInstance[]
    The list of instances.
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    filters GetClusterNetworkInstancesFilter[]
    cluster_network_id str
    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[core.GetClusterNetworkInstancesInstance]
    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[core.GetClusterNetworkInstancesFilter]
    clusterNetworkId String
    compartmentId 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.
    displayName 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

    Name string
    Values List<string>
    Regex bool
    Name string
    Values []string
    Regex bool
    name String
    values List<String>
    regex Boolean
    name string
    values string[]
    regex boolean
    name str
    values Sequence[str]
    regex bool
    name String
    values List<String>
    regex Boolean

    GetClusterNetworkInstancesInstance

    AvailabilityDomain string
    The availability domain the instance is running in.
    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    FaultDomain string
    The fault domain the instance is running in.
    Id string
    The OCID of the instance.
    InstanceConfigurationId string
    The OCID of the instance confgiuration used to create the instance.
    LoadBalancerBackends List<GetClusterNetworkInstancesInstanceLoadBalancerBackend>
    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.
    TimeCreated string
    The date and time the instance pool instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    AvailabilityDomain string
    The availability domain the instance is running in.
    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    FaultDomain string
    The fault domain the instance is running in.
    Id string
    The OCID of the instance.
    InstanceConfigurationId string
    The OCID of the instance confgiuration used to create the instance.
    LoadBalancerBackends []GetClusterNetworkInstancesInstanceLoadBalancerBackend
    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.
    TimeCreated string
    The date and time the instance pool instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    availabilityDomain String
    The availability domain the instance is running in.
    compartmentId String
    The OCID of the compartment.
    displayName String
    A filter to return only resources that match the given display name exactly.
    faultDomain String
    The fault domain the instance is running in.
    id String
    The OCID of the instance.
    instanceConfigurationId String
    The OCID of the instance confgiuration used to create the instance.
    loadBalancerBackends List<GetClusterNetworkInstancesInstanceLoadBalancerBackend>
    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.
    timeCreated String
    The date and time the instance pool instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    availabilityDomain string
    The availability domain the instance is running in.
    compartmentId string
    The OCID of the compartment.
    displayName string
    A filter to return only resources that match the given display name exactly.
    faultDomain string
    The fault domain the instance is running in.
    id string
    The OCID of the instance.
    instanceConfigurationId string
    The OCID of the instance confgiuration used to create the instance.
    loadBalancerBackends GetClusterNetworkInstancesInstanceLoadBalancerBackend[]
    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.
    timeCreated 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_id str
    The OCID of the instance confgiuration used to create the instance.
    load_balancer_backends Sequence[core.GetClusterNetworkInstancesInstanceLoadBalancerBackend]
    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
    availabilityDomain String
    The availability domain the instance is running in.
    compartmentId String
    The OCID of the compartment.
    displayName String
    A filter to return only resources that match the given display name exactly.
    faultDomain String
    The fault domain the instance is running in.
    id String
    The OCID of the instance.
    instanceConfigurationId String
    The OCID of the instance confgiuration used to create the instance.
    loadBalancerBackends List<Property Map>
    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.
    timeCreated 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

    BackendHealthStatus string
    The health of the backend as observed by the load balancer.
    BackendName string
    The name of the backend in the backend set.
    BackendSetName string
    The name of the backend set on the load balancer.
    LoadBalancerId string
    The OCID of the load balancer attached to the instance pool.
    State string
    The current state of the instance pool instance.
    BackendHealthStatus string
    The health of the backend as observed by the load balancer.
    BackendName string
    The name of the backend in the backend set.
    BackendSetName string
    The name of the backend set on the load balancer.
    LoadBalancerId string
    The OCID of the load balancer attached to the instance pool.
    State string
    The current state of the instance pool instance.
    backendHealthStatus String
    The health of the backend as observed by the load balancer.
    backendName String
    The name of the backend in the backend set.
    backendSetName String
    The name of the backend set on the load balancer.
    loadBalancerId String
    The OCID of the load balancer attached to the instance pool.
    state String
    The current state of the instance pool instance.
    backendHealthStatus string
    The health of the backend as observed by the load balancer.
    backendName string
    The name of the backend in the backend set.
    backendSetName string
    The name of the backend set on the load balancer.
    loadBalancerId string
    The OCID of the load balancer attached to the instance pool.
    state string
    The current state of the instance pool instance.
    backend_health_status str
    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_name str
    The name of the backend set on the load balancer.
    load_balancer_id str
    The OCID of the load balancer attached to the instance pool.
    state str
    The current state of the instance pool instance.
    backendHealthStatus String
    The health of the backend as observed by the load balancer.
    backendName String
    The name of the backend in the backend set.
    backendSetName String
    The name of the backend set on the load balancer.
    loadBalancerId String
    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 oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-oci