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

oci.DatabaseManagement.getCloudCluster

Explore with Pulumi AI

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

    This data source provides details about a specific Cloud Cluster resource in Oracle Cloud Infrastructure Database Management service.

    Gets the details for the cloud cluster specified by cloudClusterId.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testCloudCluster = oci.DatabaseManagement.getCloudCluster({
        cloudClusterId: testCloudClusterOciDatabaseManagementCloudCluster.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_cloud_cluster = oci.DatabaseManagement.get_cloud_cluster(cloud_cluster_id=test_cloud_cluster_oci_database_management_cloud_cluster["id"])
    
    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.GetCloudCluster(ctx, &databasemanagement.GetCloudClusterArgs{
    			CloudClusterId: testCloudClusterOciDatabaseManagementCloudCluster.Id,
    		}, 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 testCloudCluster = Oci.DatabaseManagement.GetCloudCluster.Invoke(new()
        {
            CloudClusterId = testCloudClusterOciDatabaseManagementCloudCluster.Id,
        });
    
    });
    
    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.GetCloudClusterArgs;
    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 testCloudCluster = DatabaseManagementFunctions.getCloudCluster(GetCloudClusterArgs.builder()
                .cloudClusterId(testCloudClusterOciDatabaseManagementCloudCluster.id())
                .build());
    
        }
    }
    
    variables:
      testCloudCluster:
        fn::invoke:
          function: oci:DatabaseManagement:getCloudCluster
          arguments:
            cloudClusterId: ${testCloudClusterOciDatabaseManagementCloudCluster.id}
    

    Using getCloudCluster

    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 getCloudCluster(args: GetCloudClusterArgs, opts?: InvokeOptions): Promise<GetCloudClusterResult>
    function getCloudClusterOutput(args: GetCloudClusterOutputArgs, opts?: InvokeOptions): Output<GetCloudClusterResult>
    def get_cloud_cluster(cloud_cluster_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetCloudClusterResult
    def get_cloud_cluster_output(cloud_cluster_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetCloudClusterResult]
    func LookupCloudCluster(ctx *Context, args *LookupCloudClusterArgs, opts ...InvokeOption) (*LookupCloudClusterResult, error)
    func LookupCloudClusterOutput(ctx *Context, args *LookupCloudClusterOutputArgs, opts ...InvokeOption) LookupCloudClusterResultOutput

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

    public static class GetCloudCluster 
    {
        public static Task<GetCloudClusterResult> InvokeAsync(GetCloudClusterArgs args, InvokeOptions? opts = null)
        public static Output<GetCloudClusterResult> Invoke(GetCloudClusterInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCloudClusterResult> getCloudCluster(GetCloudClusterArgs args, InvokeOptions options)
    public static Output<GetCloudClusterResult> getCloudCluster(GetCloudClusterArgs args, InvokeOptions options)
    
    fn::invoke:
      function: oci:DatabaseManagement/getCloudCluster:getCloudCluster
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CloudClusterId string
    The OCID of the cloud cluster.
    CloudClusterId string
    The OCID of the cloud cluster.
    cloudClusterId String
    The OCID of the cloud cluster.
    cloudClusterId string
    The OCID of the cloud cluster.
    cloud_cluster_id str
    The OCID of the cloud cluster.
    cloudClusterId String
    The OCID of the cloud cluster.

    getCloudCluster Result

    The following output properties are available:

    AdditionalDetails Dictionary<string, string>
    The additional details of the cloud cluster defined in {"key": "value"} format. Example: {"bar-key": "value"}
    CloudClusterId string
    CloudConnectorId string
    The OCID of the cloud connector.
    CloudDbSystemId string
    The OCID of the cloud DB system that the cluster is a part of.
    CompartmentId string
    The OCID of the compartment.
    ComponentName string
    The name of the cloud cluster.
    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
    The user-friendly name for the cloud cluster. The name does not have to be unique.
    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"}
    GridHome string
    The directory in which Oracle Grid Infrastructure is installed.
    Id string
    The OCID of the cloud cluster.
    IsFlexCluster bool
    Indicates whether the cluster is Oracle Flex Cluster or not.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    NetworkConfigurations List<GetCloudClusterNetworkConfiguration>
    The list of network address configurations of the cloud cluster.
    OcrFileLocation string
    The location of the Oracle Cluster Registry (OCR).
    ScanConfigurations List<GetCloudClusterScanConfiguration>
    The list of Single Client Access Name (SCAN) configurations of the cloud cluster.
    State string
    The current lifecycle state of the cloud cluster.
    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 was created.
    TimeUpdated string
    The date and time the cloud cluster was last updated.
    Version string
    The cluster version.
    VipConfigurations List<GetCloudClusterVipConfiguration>
    The list of Virtual IP (VIP) configurations of the cloud cluster.
    AdditionalDetails map[string]string
    The additional details of the cloud cluster defined in {"key": "value"} format. Example: {"bar-key": "value"}
    CloudClusterId string
    CloudConnectorId string
    The OCID of the cloud connector.
    CloudDbSystemId string
    The OCID of the cloud DB system that the cluster is a part of.
    CompartmentId string
    The OCID of the compartment.
    ComponentName string
    The name of the cloud cluster.
    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
    The user-friendly name for the cloud cluster. The name does not have to be unique.
    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"}
    GridHome string
    The directory in which Oracle Grid Infrastructure is installed.
    Id string
    The OCID of the cloud cluster.
    IsFlexCluster bool
    Indicates whether the cluster is Oracle Flex Cluster or not.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    NetworkConfigurations []GetCloudClusterNetworkConfiguration
    The list of network address configurations of the cloud cluster.
    OcrFileLocation string
    The location of the Oracle Cluster Registry (OCR).
    ScanConfigurations []GetCloudClusterScanConfiguration
    The list of Single Client Access Name (SCAN) configurations of the cloud cluster.
    State string
    The current lifecycle state of the cloud cluster.
    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 was created.
    TimeUpdated string
    The date and time the cloud cluster was last updated.
    Version string
    The cluster version.
    VipConfigurations []GetCloudClusterVipConfiguration
    The list of Virtual IP (VIP) configurations of the cloud cluster.
    additionalDetails Map<String,String>
    The additional details of the cloud cluster defined in {"key": "value"} format. Example: {"bar-key": "value"}
    cloudClusterId String
    cloudConnectorId String
    The OCID of the cloud connector.
    cloudDbSystemId String
    The OCID of the cloud DB system that the cluster is a part of.
    compartmentId String
    The OCID of the compartment.
    componentName String
    The name of the cloud cluster.
    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
    The user-friendly name for the cloud cluster. The name does not have to be unique.
    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"}
    gridHome String
    The directory in which Oracle Grid Infrastructure is installed.
    id String
    The OCID of the cloud cluster.
    isFlexCluster Boolean
    Indicates whether the cluster is Oracle Flex Cluster or not.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    networkConfigurations List<GetCloudClusterNetworkConfiguration>
    The list of network address configurations of the cloud cluster.
    ocrFileLocation String
    The location of the Oracle Cluster Registry (OCR).
    scanConfigurations List<GetCloudClusterScanConfiguration>
    The list of Single Client Access Name (SCAN) configurations of the cloud cluster.
    state String
    The current lifecycle state of the cloud cluster.
    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 was created.
    timeUpdated String
    The date and time the cloud cluster was last updated.
    version String
    The cluster version.
    vipConfigurations List<GetCloudClusterVipConfiguration>
    The list of Virtual IP (VIP) configurations of the cloud cluster.
    additionalDetails {[key: string]: string}
    The additional details of the cloud cluster defined in {"key": "value"} format. Example: {"bar-key": "value"}
    cloudClusterId string
    cloudConnectorId string
    The OCID of the cloud connector.
    cloudDbSystemId string
    The OCID of the cloud DB system that the cluster is a part of.
    compartmentId string
    The OCID of the compartment.
    componentName string
    The name of the cloud cluster.
    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
    The user-friendly name for the cloud cluster. The name does not have to be unique.
    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"}
    gridHome string
    The directory in which Oracle Grid Infrastructure is installed.
    id string
    The OCID of the cloud cluster.
    isFlexCluster boolean
    Indicates whether the cluster is Oracle Flex Cluster or not.
    lifecycleDetails string
    Additional information about the current lifecycle state.
    networkConfigurations GetCloudClusterNetworkConfiguration[]
    The list of network address configurations of the cloud cluster.
    ocrFileLocation string
    The location of the Oracle Cluster Registry (OCR).
    scanConfigurations GetCloudClusterScanConfiguration[]
    The list of Single Client Access Name (SCAN) configurations of the cloud cluster.
    state string
    The current lifecycle state of the cloud cluster.
    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 was created.
    timeUpdated string
    The date and time the cloud cluster was last updated.
    version string
    The cluster version.
    vipConfigurations GetCloudClusterVipConfiguration[]
    The list of Virtual IP (VIP) configurations of the cloud cluster.
    additional_details Mapping[str, str]
    The additional details of the cloud cluster defined in {"key": "value"} format. Example: {"bar-key": "value"}
    cloud_cluster_id str
    cloud_connector_id str
    The OCID of the cloud connector.
    cloud_db_system_id str
    The OCID of the cloud DB system that the cluster is a part of.
    compartment_id str
    The OCID of the compartment.
    component_name str
    The name of the cloud cluster.
    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
    The user-friendly name for the cloud cluster. The name does not have to be unique.
    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"}
    grid_home str
    The directory in which Oracle Grid Infrastructure is installed.
    id str
    The OCID of the cloud cluster.
    is_flex_cluster bool
    Indicates whether the cluster is Oracle Flex Cluster or not.
    lifecycle_details str
    Additional information about the current lifecycle state.
    network_configurations Sequence[GetCloudClusterNetworkConfiguration]
    The list of network address configurations of the cloud cluster.
    ocr_file_location str
    The location of the Oracle Cluster Registry (OCR).
    scan_configurations Sequence[GetCloudClusterScanConfiguration]
    The list of Single Client Access Name (SCAN) configurations of the cloud cluster.
    state str
    The current lifecycle state of the cloud cluster.
    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 was created.
    time_updated str
    The date and time the cloud cluster was last updated.
    version str
    The cluster version.
    vip_configurations Sequence[GetCloudClusterVipConfiguration]
    The list of Virtual IP (VIP) configurations of the cloud cluster.
    additionalDetails Map<String>
    The additional details of the cloud cluster defined in {"key": "value"} format. Example: {"bar-key": "value"}
    cloudClusterId String
    cloudConnectorId String
    The OCID of the cloud connector.
    cloudDbSystemId String
    The OCID of the cloud DB system that the cluster is a part of.
    compartmentId String
    The OCID of the compartment.
    componentName String
    The name of the cloud cluster.
    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
    The user-friendly name for the cloud cluster. The name does not have to be unique.
    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"}
    gridHome String
    The directory in which Oracle Grid Infrastructure is installed.
    id String
    The OCID of the cloud cluster.
    isFlexCluster Boolean
    Indicates whether the cluster is Oracle Flex Cluster or not.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    networkConfigurations List<Property Map>
    The list of network address configurations of the cloud cluster.
    ocrFileLocation String
    The location of the Oracle Cluster Registry (OCR).
    scanConfigurations List<Property Map>
    The list of Single Client Access Name (SCAN) configurations of the cloud cluster.
    state String
    The current lifecycle state of the cloud cluster.
    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 was created.
    timeUpdated String
    The date and time the cloud cluster was last updated.
    version String
    The cluster version.
    vipConfigurations List<Property Map>
    The list of Virtual IP (VIP) configurations of the cloud cluster.

    Supporting Types

    GetCloudClusterNetworkConfiguration

    NetworkNumber int
    The network number from which VIPs are obtained.
    NetworkType string
    The network type.
    Subnet string
    The subnet for the network.
    NetworkNumber int
    The network number from which VIPs are obtained.
    NetworkType string
    The network type.
    Subnet string
    The subnet for the network.
    networkNumber Integer
    The network number from which VIPs are obtained.
    networkType String
    The network type.
    subnet String
    The subnet for the network.
    networkNumber number
    The network number from which VIPs are obtained.
    networkType string
    The network type.
    subnet string
    The subnet for the network.
    network_number int
    The network number from which VIPs are obtained.
    network_type str
    The network type.
    subnet str
    The subnet for the network.
    networkNumber Number
    The network number from which VIPs are obtained.
    networkType String
    The network type.
    subnet String
    The subnet for the network.

    GetCloudClusterScanConfiguration

    NetworkNumber int
    The network number from which VIPs are obtained.
    ScanName string
    The name of the SCAN listener.
    ScanPort int
    The port number of the SCAN listener.
    ScanProtocol string
    The protocol of the SCAN listener.
    NetworkNumber int
    The network number from which VIPs are obtained.
    ScanName string
    The name of the SCAN listener.
    ScanPort int
    The port number of the SCAN listener.
    ScanProtocol string
    The protocol of the SCAN listener.
    networkNumber Integer
    The network number from which VIPs are obtained.
    scanName String
    The name of the SCAN listener.
    scanPort Integer
    The port number of the SCAN listener.
    scanProtocol String
    The protocol of the SCAN listener.
    networkNumber number
    The network number from which VIPs are obtained.
    scanName string
    The name of the SCAN listener.
    scanPort number
    The port number of the SCAN listener.
    scanProtocol string
    The protocol of the SCAN listener.
    network_number int
    The network number from which VIPs are obtained.
    scan_name str
    The name of the SCAN listener.
    scan_port int
    The port number of the SCAN listener.
    scan_protocol str
    The protocol of the SCAN listener.
    networkNumber Number
    The network number from which VIPs are obtained.
    scanName String
    The name of the SCAN listener.
    scanPort Number
    The port number of the SCAN listener.
    scanProtocol String
    The protocol of the SCAN listener.

    GetCloudClusterVipConfiguration

    Address string
    The VIP name or IP address.
    NetworkNumber int
    The network number from which VIPs are obtained.
    NodeName string
    The name of the node with the VIP.
    Address string
    The VIP name or IP address.
    NetworkNumber int
    The network number from which VIPs are obtained.
    NodeName string
    The name of the node with the VIP.
    address String
    The VIP name or IP address.
    networkNumber Integer
    The network number from which VIPs are obtained.
    nodeName String
    The name of the node with the VIP.
    address string
    The VIP name or IP address.
    networkNumber number
    The network number from which VIPs are obtained.
    nodeName string
    The name of the node with the VIP.
    address str
    The VIP name or IP address.
    network_number int
    The network number from which VIPs are obtained.
    node_name str
    The name of the node with the VIP.
    address String
    The VIP name or IP address.
    networkNumber Number
    The network number from which VIPs are obtained.
    nodeName String
    The name of the node with the VIP.

    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