1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. getComputeClusters
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

oci.Core.getComputeClusters

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

This data source provides the list of Compute Clusters in Oracle Cloud Infrastructure Core service.

Lists the compute clusters in the specified compartment. A compute cluster is a remote direct memory access (RDMA) network group.

Example Usage

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

const testComputeClusters = oci.Core.getComputeClusters({
    compartmentId: compartmentId,
    availabilityDomain: computeClusterAvailabilityDomain,
    displayName: computeClusterDisplayName,
});
Copy
import pulumi
import pulumi_oci as oci

test_compute_clusters = oci.Core.get_compute_clusters(compartment_id=compartment_id,
    availability_domain=compute_cluster_availability_domain,
    display_name=compute_cluster_display_name)
Copy
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.GetComputeClusters(ctx, &core.GetComputeClustersArgs{
			CompartmentId:      compartmentId,
			AvailabilityDomain: pulumi.StringRef(computeClusterAvailabilityDomain),
			DisplayName:        pulumi.StringRef(computeClusterDisplayName),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testComputeClusters = Oci.Core.GetComputeClusters.Invoke(new()
    {
        CompartmentId = compartmentId,
        AvailabilityDomain = computeClusterAvailabilityDomain,
        DisplayName = computeClusterDisplayName,
    });

});
Copy
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.GetComputeClustersArgs;
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 testComputeClusters = CoreFunctions.getComputeClusters(GetComputeClustersArgs.builder()
            .compartmentId(compartmentId)
            .availabilityDomain(computeClusterAvailabilityDomain)
            .displayName(computeClusterDisplayName)
            .build());

    }
}
Copy
variables:
  testComputeClusters:
    fn::invoke:
      function: oci:Core:getComputeClusters
      arguments:
        compartmentId: ${compartmentId}
        availabilityDomain: ${computeClusterAvailabilityDomain}
        displayName: ${computeClusterDisplayName}
Copy

Using getComputeClusters

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 getComputeClusters(args: GetComputeClustersArgs, opts?: InvokeOptions): Promise<GetComputeClustersResult>
function getComputeClustersOutput(args: GetComputeClustersOutputArgs, opts?: InvokeOptions): Output<GetComputeClustersResult>
Copy
def get_compute_clusters(availability_domain: Optional[str] = None,
                         compartment_id: Optional[str] = None,
                         display_name: Optional[str] = None,
                         filters: Optional[Sequence[_core.GetComputeClustersFilter]] = None,
                         opts: Optional[InvokeOptions] = None) -> GetComputeClustersResult
def get_compute_clusters_output(availability_domain: 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.GetComputeClustersFilterArgs]]]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetComputeClustersResult]
Copy
func GetComputeClusters(ctx *Context, args *GetComputeClustersArgs, opts ...InvokeOption) (*GetComputeClustersResult, error)
func GetComputeClustersOutput(ctx *Context, args *GetComputeClustersOutputArgs, opts ...InvokeOption) GetComputeClustersResultOutput
Copy

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

public static class GetComputeClusters 
{
    public static Task<GetComputeClustersResult> InvokeAsync(GetComputeClustersArgs args, InvokeOptions? opts = null)
    public static Output<GetComputeClustersResult> Invoke(GetComputeClustersInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetComputeClustersResult> getComputeClusters(GetComputeClustersArgs args, InvokeOptions options)
public static Output<GetComputeClustersResult> getComputeClusters(GetComputeClustersArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:Core/getComputeClusters:getComputeClusters
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CompartmentId This property is required. string
The OCID of the compartment.
AvailabilityDomain string
The name of the availability domain. Example: Uocm:PHX-AD-1
DisplayName string
A filter to return only resources that match the given display name exactly.
Filters Changes to this property will trigger replacement. List<GetComputeClustersFilter>
CompartmentId This property is required. string
The OCID of the compartment.
AvailabilityDomain string
The name of the availability domain. Example: Uocm:PHX-AD-1
DisplayName string
A filter to return only resources that match the given display name exactly.
Filters Changes to this property will trigger replacement. []GetComputeClustersFilter
compartmentId This property is required. String
The OCID of the compartment.
availabilityDomain String
The name of the availability domain. Example: Uocm:PHX-AD-1
displayName String
A filter to return only resources that match the given display name exactly.
filters Changes to this property will trigger replacement. List<GetComputeClustersFilter>
compartmentId This property is required. string
The OCID of the compartment.
availabilityDomain string
The name of the availability domain. Example: Uocm:PHX-AD-1
displayName string
A filter to return only resources that match the given display name exactly.
filters Changes to this property will trigger replacement. GetComputeClustersFilter[]
compartment_id This property is required. str
The OCID of the compartment.
availability_domain str
The name of the availability domain. Example: Uocm:PHX-AD-1
display_name str
A filter to return only resources that match the given display name exactly.
filters Changes to this property will trigger replacement. Sequence[core.GetComputeClustersFilter]
compartmentId This property is required. String
The OCID of the compartment.
availabilityDomain String
The name of the availability domain. Example: Uocm:PHX-AD-1
displayName String
A filter to return only resources that match the given display name exactly.
filters Changes to this property will trigger replacement. List<Property Map>

getComputeClusters Result

The following output properties are available:

CompartmentId string
The OCID of the compartment that contains the compute cluster.
ComputeClusterCollections List<GetComputeClustersComputeClusterCollection>
The list of compute_cluster_collection.
Id string
The provider-assigned unique ID for this managed resource.
AvailabilityDomain string
The availability domain the compute cluster is running in. Example: Uocm:PHX-AD-1
DisplayName string
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Filters List<GetComputeClustersFilter>
CompartmentId string
The OCID of the compartment that contains the compute cluster.
ComputeClusterCollections []GetComputeClustersComputeClusterCollection
The list of compute_cluster_collection.
Id string
The provider-assigned unique ID for this managed resource.
AvailabilityDomain string
The availability domain the compute cluster is running in. Example: Uocm:PHX-AD-1
DisplayName string
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Filters []GetComputeClustersFilter
compartmentId String
The OCID of the compartment that contains the compute cluster.
computeClusterCollections List<GetComputeClustersComputeClusterCollection>
The list of compute_cluster_collection.
id String
The provider-assigned unique ID for this managed resource.
availabilityDomain String
The availability domain the compute cluster is running in. Example: Uocm:PHX-AD-1
displayName String
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters List<GetComputeClustersFilter>
compartmentId string
The OCID of the compartment that contains the compute cluster.
computeClusterCollections GetComputeClustersComputeClusterCollection[]
The list of compute_cluster_collection.
id string
The provider-assigned unique ID for this managed resource.
availabilityDomain string
The availability domain the compute cluster is running in. Example: Uocm:PHX-AD-1
displayName string
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters GetComputeClustersFilter[]
compartment_id str
The OCID of the compartment that contains the compute cluster.
compute_cluster_collections Sequence[core.GetComputeClustersComputeClusterCollection]
The list of compute_cluster_collection.
id str
The provider-assigned unique ID for this managed resource.
availability_domain str
The availability domain the compute cluster is running in. Example: Uocm:PHX-AD-1
display_name str
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters Sequence[core.GetComputeClustersFilter]
compartmentId String
The OCID of the compartment that contains the compute cluster.
computeClusterCollections List<Property Map>
The list of compute_cluster_collection.
id String
The provider-assigned unique ID for this managed resource.
availabilityDomain String
The availability domain the compute cluster is running in. Example: Uocm:PHX-AD-1
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

GetComputeClustersComputeClusterCollection

items This property is required. List<Property Map>

GetComputeClustersComputeClusterCollectionItem

AvailabilityDomain This property is required. string
The name of the availability domain. Example: Uocm:PHX-AD-1
CompartmentId This property is required. string
The OCID of the compartment.
DefinedTags This property is required. 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"}
DisplayName This property is required. string
A filter to return only resources that match the given display name exactly.
FreeformTags This property is required. 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 This property is required. string
The OCID of the compute cluster.
State This property is required. string
The current state of the compute cluster.
TimeCreated This property is required. string
The date and time the compute cluster was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
AvailabilityDomain This property is required. string
The name of the availability domain. Example: Uocm:PHX-AD-1
CompartmentId This property is required. string
The OCID of the compartment.
DefinedTags This property is required. 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"}
DisplayName This property is required. string
A filter to return only resources that match the given display name exactly.
FreeformTags This property is required. 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 This property is required. string
The OCID of the compute cluster.
State This property is required. string
The current state of the compute cluster.
TimeCreated This property is required. string
The date and time the compute cluster was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
availabilityDomain This property is required. String
The name of the availability domain. Example: Uocm:PHX-AD-1
compartmentId This property is required. String
The OCID of the compartment.
definedTags This property is required. 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"}
displayName This property is required. String
A filter to return only resources that match the given display name exactly.
freeformTags This property is required. 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 This property is required. String
The OCID of the compute cluster.
state This property is required. String
The current state of the compute cluster.
timeCreated This property is required. String
The date and time the compute cluster was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
availabilityDomain This property is required. string
The name of the availability domain. Example: Uocm:PHX-AD-1
compartmentId This property is required. string
The OCID of the compartment.
definedTags This property is required. {[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"}
displayName This property is required. string
A filter to return only resources that match the given display name exactly.
freeformTags This property is required. {[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 This property is required. string
The OCID of the compute cluster.
state This property is required. string
The current state of the compute cluster.
timeCreated This property is required. string
The date and time the compute cluster was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
availability_domain This property is required. str
The name of the availability domain. Example: Uocm:PHX-AD-1
compartment_id This property is required. str
The OCID of the compartment.
defined_tags This property is required. 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"}
display_name This property is required. str
A filter to return only resources that match the given display name exactly.
freeform_tags This property is required. 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 This property is required. str
The OCID of the compute cluster.
state This property is required. str
The current state of the compute cluster.
time_created This property is required. str
The date and time the compute cluster was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
availabilityDomain This property is required. String
The name of the availability domain. Example: Uocm:PHX-AD-1
compartmentId This property is required. String
The OCID of the compartment.
definedTags This property is required. 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"}
displayName This property is required. String
A filter to return only resources that match the given display name exactly.
freeformTags This property is required. 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 This property is required. String
The OCID of the compute cluster.
state This property is required. String
The current state of the compute cluster.
timeCreated This property is required. String
The date and time the compute cluster was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

GetComputeClustersFilter

Name This property is required. string
Values This property is required. List<string>
Regex bool
Name This property is required. string
Values This property is required. []string
Regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean
name This property is required. string
values This property is required. string[]
regex boolean
name This property is required. str
values This property is required. Sequence[str]
regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi