1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DatabaseManagement
  5. getCloudClusterInstances
Oracle Cloud Infrastructure v3.7.0 published on Saturday, Sep 13, 2025 by Pulumi

oci.DatabaseManagement.getCloudClusterInstances

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v3.7.0 published on Saturday, Sep 13, 2025 by Pulumi

    This data source provides the list of Cloud Cluster Instances in Oracle Cloud Infrastructure Database Management service.

    Lists the cluster instances in the specified cloud cluster.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testCloudClusterInstances = oci.DatabaseManagement.getCloudClusterInstances({
        cloudClusterId: testCloudCluster.id,
        compartmentId: compartmentId,
        displayName: cloudClusterInstanceDisplayName,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_cloud_cluster_instances = oci.DatabaseManagement.get_cloud_cluster_instances(cloud_cluster_id=test_cloud_cluster["id"],
        compartment_id=compartment_id,
        display_name=cloud_cluster_instance_display_name)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v3/go/oci/databasemanagement"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := databasemanagement.GetCloudClusterInstances(ctx, &databasemanagement.GetCloudClusterInstancesArgs{
    			CloudClusterId: pulumi.StringRef(testCloudCluster.Id),
    			CompartmentId:  pulumi.StringRef(compartmentId),
    			DisplayName:    pulumi.StringRef(cloudClusterInstanceDisplayName),
    		}, 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 testCloudClusterInstances = Oci.DatabaseManagement.GetCloudClusterInstances.Invoke(new()
        {
            CloudClusterId = testCloudCluster.Id,
            CompartmentId = compartmentId,
            DisplayName = cloudClusterInstanceDisplayName,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.DatabaseManagement.DatabaseManagementFunctions;
    import com.pulumi.oci.DatabaseManagement.inputs.GetCloudClusterInstancesArgs;
    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 testCloudClusterInstances = DatabaseManagementFunctions.getCloudClusterInstances(GetCloudClusterInstancesArgs.builder()
                .cloudClusterId(testCloudCluster.id())
                .compartmentId(compartmentId)
                .displayName(cloudClusterInstanceDisplayName)
                .build());
    
        }
    }
    
    variables:
      testCloudClusterInstances:
        fn::invoke:
          function: oci:DatabaseManagement:getCloudClusterInstances
          arguments:
            cloudClusterId: ${testCloudCluster.id}
            compartmentId: ${compartmentId}
            displayName: ${cloudClusterInstanceDisplayName}
    

    Using getCloudClusterInstances

    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 getCloudClusterInstances(args: GetCloudClusterInstancesArgs, opts?: InvokeOptions): Promise<GetCloudClusterInstancesResult>
    function getCloudClusterInstancesOutput(args: GetCloudClusterInstancesOutputArgs, opts?: InvokeOptions): Output<GetCloudClusterInstancesResult>
    def get_cloud_cluster_instances(cloud_cluster_id: Optional[str] = None,
                                    compartment_id: Optional[str] = None,
                                    display_name: Optional[str] = None,
                                    filters: Optional[Sequence[GetCloudClusterInstancesFilter]] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetCloudClusterInstancesResult
    def get_cloud_cluster_instances_output(cloud_cluster_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[GetCloudClusterInstancesFilterArgs]]]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetCloudClusterInstancesResult]
    func GetCloudClusterInstances(ctx *Context, args *GetCloudClusterInstancesArgs, opts ...InvokeOption) (*GetCloudClusterInstancesResult, error)
    func GetCloudClusterInstancesOutput(ctx *Context, args *GetCloudClusterInstancesOutputArgs, opts ...InvokeOption) GetCloudClusterInstancesResultOutput

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

    public static class GetCloudClusterInstances 
    {
        public static Task<GetCloudClusterInstancesResult> InvokeAsync(GetCloudClusterInstancesArgs args, InvokeOptions? opts = null)
        public static Output<GetCloudClusterInstancesResult> Invoke(GetCloudClusterInstancesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCloudClusterInstancesResult> getCloudClusterInstances(GetCloudClusterInstancesArgs args, InvokeOptions options)
    public static Output<GetCloudClusterInstancesResult> getCloudClusterInstances(GetCloudClusterInstancesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: oci:DatabaseManagement/getCloudClusterInstances:getCloudClusterInstances
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CloudClusterId string
    The OCID of the cloud cluster.
    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    A filter to only return the resources that match the entire display name.
    Filters List<GetCloudClusterInstancesFilter>
    CloudClusterId string
    The OCID of the cloud cluster.
    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    A filter to only return the resources that match the entire display name.
    Filters []GetCloudClusterInstancesFilter
    cloudClusterId String
    The OCID of the cloud cluster.
    compartmentId String
    The OCID of the compartment.
    displayName String
    A filter to only return the resources that match the entire display name.
    filters List<GetCloudClusterInstancesFilter>
    cloudClusterId string
    The OCID of the cloud cluster.
    compartmentId string
    The OCID of the compartment.
    displayName string
    A filter to only return the resources that match the entire display name.
    filters GetCloudClusterInstancesFilter[]
    cloud_cluster_id str
    The OCID of the cloud cluster.
    compartment_id str
    The OCID of the compartment.
    display_name str
    A filter to only return the resources that match the entire display name.
    filters Sequence[GetCloudClusterInstancesFilter]
    cloudClusterId String
    The OCID of the cloud cluster.
    compartmentId String
    The OCID of the compartment.
    displayName String
    A filter to only return the resources that match the entire display name.
    filters List<Property Map>

    getCloudClusterInstances Result

    The following output properties are available:

    CloudClusterInstanceCollections List<GetCloudClusterInstancesCloudClusterInstanceCollection>
    The list of cloud_cluster_instance_collection.
    Id string
    The provider-assigned unique ID for this managed resource.
    CloudClusterId string
    The OCID of the cloud cluster that the cluster instance belongs to.
    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    The user-friendly name for the cluster instance. The name does not have to be unique.
    Filters List<GetCloudClusterInstancesFilter>
    CloudClusterInstanceCollections []GetCloudClusterInstancesCloudClusterInstanceCollection
    The list of cloud_cluster_instance_collection.
    Id string
    The provider-assigned unique ID for this managed resource.
    CloudClusterId string
    The OCID of the cloud cluster that the cluster instance belongs to.
    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    The user-friendly name for the cluster instance. The name does not have to be unique.
    Filters []GetCloudClusterInstancesFilter
    cloudClusterInstanceCollections List<GetCloudClusterInstancesCloudClusterInstanceCollection>
    The list of cloud_cluster_instance_collection.
    id String
    The provider-assigned unique ID for this managed resource.
    cloudClusterId String
    The OCID of the cloud cluster that the cluster instance belongs to.
    compartmentId String
    The OCID of the compartment.
    displayName String
    The user-friendly name for the cluster instance. The name does not have to be unique.
    filters List<GetCloudClusterInstancesFilter>
    cloudClusterInstanceCollections GetCloudClusterInstancesCloudClusterInstanceCollection[]
    The list of cloud_cluster_instance_collection.
    id string
    The provider-assigned unique ID for this managed resource.
    cloudClusterId string
    The OCID of the cloud cluster that the cluster instance belongs to.
    compartmentId string
    The OCID of the compartment.
    displayName string
    The user-friendly name for the cluster instance. The name does not have to be unique.
    filters GetCloudClusterInstancesFilter[]
    cloud_cluster_instance_collections Sequence[GetCloudClusterInstancesCloudClusterInstanceCollection]
    The list of cloud_cluster_instance_collection.
    id str
    The provider-assigned unique ID for this managed resource.
    cloud_cluster_id str
    The OCID of the cloud cluster that the cluster instance belongs to.
    compartment_id str
    The OCID of the compartment.
    display_name str
    The user-friendly name for the cluster instance. The name does not have to be unique.
    filters Sequence[GetCloudClusterInstancesFilter]
    cloudClusterInstanceCollections List<Property Map>
    The list of cloud_cluster_instance_collection.
    id String
    The provider-assigned unique ID for this managed resource.
    cloudClusterId String
    The OCID of the cloud cluster that the cluster instance belongs to.
    compartmentId String
    The OCID of the compartment.
    displayName String
    The user-friendly name for the cluster instance. The name does not have to be unique.
    filters List<Property Map>

    Supporting Types

    GetCloudClusterInstancesCloudClusterInstanceCollection

    GetCloudClusterInstancesCloudClusterInstanceCollectionItem

    AdrHomeDirectory string
    The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
    CloudClusterId string
    The OCID of the cloud cluster.
    CloudClusterInstanceId string
    CloudConnectorId string
    The OCID of the cloud connector.
    CloudDbNodeId string
    The OCID of the cloud DB node.
    CloudDbSystemId string
    The OCID of the cloud DB system that the cluster instance is a part of.
    CompartmentId string
    The OCID of the compartment.
    ComponentName string
    The name of the cloud cluster instance.
    CrsBaseDirectory string
    The Oracle base location of Cluster Ready Services (CRS).
    DbaasId string
    The OCID in DBaas service.
    DefinedTags 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 string
    A filter to only return the resources that match the entire display name.
    FreeformTags 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"}
    HostName string
    The name of the host on which the cluster instance is running.
    Id string
    The OCID of the cloud cluster instance.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    NodeRole string
    The role of the cluster node.
    State string
    The current lifecycle state of the cloud cluster instance.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the cloud cluster instance was created.
    TimeUpdated string
    The date and time the cloud cluster instance was last updated.
    AdrHomeDirectory string
    The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
    CloudClusterId string
    The OCID of the cloud cluster.
    CloudClusterInstanceId string
    CloudConnectorId string
    The OCID of the cloud connector.
    CloudDbNodeId string
    The OCID of the cloud DB node.
    CloudDbSystemId string
    The OCID of the cloud DB system that the cluster instance is a part of.
    CompartmentId string
    The OCID of the compartment.
    ComponentName string
    The name of the cloud cluster instance.
    CrsBaseDirectory string
    The Oracle base location of Cluster Ready Services (CRS).
    DbaasId string
    The OCID in DBaas service.
    DefinedTags 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 string
    A filter to only return the resources that match the entire display name.
    FreeformTags 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"}
    HostName string
    The name of the host on which the cluster instance is running.
    Id string
    The OCID of the cloud cluster instance.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    NodeRole string
    The role of the cluster node.
    State string
    The current lifecycle state of the cloud cluster instance.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the cloud cluster instance was created.
    TimeUpdated string
    The date and time the cloud cluster instance was last updated.
    adrHomeDirectory String
    The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
    cloudClusterId String
    The OCID of the cloud cluster.
    cloudClusterInstanceId String
    cloudConnectorId String
    The OCID of the cloud connector.
    cloudDbNodeId String
    The OCID of the cloud DB node.
    cloudDbSystemId String
    The OCID of the cloud DB system that the cluster instance is a part of.
    compartmentId String
    The OCID of the compartment.
    componentName String
    The name of the cloud cluster instance.
    crsBaseDirectory String
    The Oracle base location of Cluster Ready Services (CRS).
    dbaasId String
    The OCID in DBaas service.
    definedTags 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 String
    A filter to only return the resources that match the entire display name.
    freeformTags 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"}
    hostName String
    The name of the host on which the cluster instance is running.
    id String
    The OCID of the cloud cluster instance.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    nodeRole String
    The role of the cluster node.
    state String
    The current lifecycle state of the cloud cluster instance.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the cloud cluster instance was created.
    timeUpdated String
    The date and time the cloud cluster instance was last updated.
    adrHomeDirectory string
    The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
    cloudClusterId string
    The OCID of the cloud cluster.
    cloudClusterInstanceId string
    cloudConnectorId string
    The OCID of the cloud connector.
    cloudDbNodeId string
    The OCID of the cloud DB node.
    cloudDbSystemId string
    The OCID of the cloud DB system that the cluster instance is a part of.
    compartmentId string
    The OCID of the compartment.
    componentName string
    The name of the cloud cluster instance.
    crsBaseDirectory string
    The Oracle base location of Cluster Ready Services (CRS).
    dbaasId string
    The OCID in DBaas service.
    definedTags {[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 string
    A filter to only return the resources that match the entire display name.
    freeformTags {[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"}
    hostName string
    The name of the host on which the cluster instance is running.
    id string
    The OCID of the cloud cluster instance.
    lifecycleDetails string
    Additional information about the current lifecycle state.
    nodeRole string
    The role of the cluster node.
    state string
    The current lifecycle state of the cloud cluster instance.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time the cloud cluster instance was created.
    timeUpdated string
    The date and time the cloud cluster instance was last updated.
    adr_home_directory str
    The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
    cloud_cluster_id str
    The OCID of the cloud cluster.
    cloud_cluster_instance_id str
    cloud_connector_id str
    The OCID of the cloud connector.
    cloud_db_node_id str
    The OCID of the cloud DB node.
    cloud_db_system_id str
    The OCID of the cloud DB system that the cluster instance is a part of.
    compartment_id str
    The OCID of the compartment.
    component_name str
    The name of the cloud cluster instance.
    crs_base_directory str
    The Oracle base location of Cluster Ready Services (CRS).
    dbaas_id str
    The OCID in DBaas service.
    defined_tags 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 str
    A filter to only return the resources that match the entire display name.
    freeform_tags 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"}
    host_name str
    The name of the host on which the cluster instance is running.
    id str
    The OCID of the cloud cluster instance.
    lifecycle_details str
    Additional information about the current lifecycle state.
    node_role str
    The role of the cluster node.
    state str
    The current lifecycle state of the cloud cluster instance.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time the cloud cluster instance was created.
    time_updated str
    The date and time the cloud cluster instance was last updated.
    adrHomeDirectory String
    The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
    cloudClusterId String
    The OCID of the cloud cluster.
    cloudClusterInstanceId String
    cloudConnectorId String
    The OCID of the cloud connector.
    cloudDbNodeId String
    The OCID of the cloud DB node.
    cloudDbSystemId String
    The OCID of the cloud DB system that the cluster instance is a part of.
    compartmentId String
    The OCID of the compartment.
    componentName String
    The name of the cloud cluster instance.
    crsBaseDirectory String
    The Oracle base location of Cluster Ready Services (CRS).
    dbaasId String
    The OCID in DBaas service.
    definedTags 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 String
    A filter to only return the resources that match the entire display name.
    freeformTags 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"}
    hostName String
    The name of the host on which the cluster instance is running.
    id String
    The OCID of the cloud cluster instance.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    nodeRole String
    The role of the cluster node.
    state String
    The current lifecycle state of the cloud cluster instance.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the cloud cluster instance was created.
    timeUpdated String
    The date and time the cloud cluster instance was last updated.

    GetCloudClusterInstancesFilter

    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

    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.7.0 published on Saturday, Sep 13, 2025 by Pulumi