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

oci.DatabaseManagement.getCloudDbHomes

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 Db Homes in Oracle Cloud Infrastructure Database Management service.

    Lists the DB homes in the specified cloud DB system.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testCloudDbHomes = oci.DatabaseManagement.getCloudDbHomes({
        cloudDbSystemId: testCloudDbSystem.id,
        compartmentId: compartmentId,
        displayName: cloudDbHomeDisplayName,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_cloud_db_homes = oci.DatabaseManagement.get_cloud_db_homes(cloud_db_system_id=test_cloud_db_system["id"],
        compartment_id=compartment_id,
        display_name=cloud_db_home_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.GetCloudDbHomes(ctx, &databasemanagement.GetCloudDbHomesArgs{
    			CloudDbSystemId: pulumi.StringRef(testCloudDbSystem.Id),
    			CompartmentId:   pulumi.StringRef(compartmentId),
    			DisplayName:     pulumi.StringRef(cloudDbHomeDisplayName),
    		}, 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 testCloudDbHomes = Oci.DatabaseManagement.GetCloudDbHomes.Invoke(new()
        {
            CloudDbSystemId = testCloudDbSystem.Id,
            CompartmentId = compartmentId,
            DisplayName = cloudDbHomeDisplayName,
        });
    
    });
    
    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.GetCloudDbHomesArgs;
    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 testCloudDbHomes = DatabaseManagementFunctions.getCloudDbHomes(GetCloudDbHomesArgs.builder()
                .cloudDbSystemId(testCloudDbSystem.id())
                .compartmentId(compartmentId)
                .displayName(cloudDbHomeDisplayName)
                .build());
    
        }
    }
    
    variables:
      testCloudDbHomes:
        fn::invoke:
          function: oci:DatabaseManagement:getCloudDbHomes
          arguments:
            cloudDbSystemId: ${testCloudDbSystem.id}
            compartmentId: ${compartmentId}
            displayName: ${cloudDbHomeDisplayName}
    

    Using getCloudDbHomes

    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 getCloudDbHomes(args: GetCloudDbHomesArgs, opts?: InvokeOptions): Promise<GetCloudDbHomesResult>
    function getCloudDbHomesOutput(args: GetCloudDbHomesOutputArgs, opts?: InvokeOptions): Output<GetCloudDbHomesResult>
    def get_cloud_db_homes(cloud_db_system_id: Optional[str] = None,
                           compartment_id: Optional[str] = None,
                           display_name: Optional[str] = None,
                           filters: Optional[Sequence[GetCloudDbHomesFilter]] = None,
                           opts: Optional[InvokeOptions] = None) -> GetCloudDbHomesResult
    def get_cloud_db_homes_output(cloud_db_system_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[GetCloudDbHomesFilterArgs]]]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetCloudDbHomesResult]
    func GetCloudDbHomes(ctx *Context, args *GetCloudDbHomesArgs, opts ...InvokeOption) (*GetCloudDbHomesResult, error)
    func GetCloudDbHomesOutput(ctx *Context, args *GetCloudDbHomesOutputArgs, opts ...InvokeOption) GetCloudDbHomesResultOutput

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

    public static class GetCloudDbHomes 
    {
        public static Task<GetCloudDbHomesResult> InvokeAsync(GetCloudDbHomesArgs args, InvokeOptions? opts = null)
        public static Output<GetCloudDbHomesResult> Invoke(GetCloudDbHomesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCloudDbHomesResult> getCloudDbHomes(GetCloudDbHomesArgs args, InvokeOptions options)
    public static Output<GetCloudDbHomesResult> getCloudDbHomes(GetCloudDbHomesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: oci:DatabaseManagement/getCloudDbHomes:getCloudDbHomes
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CloudDbSystemId string
    The OCID of the cloud DB system.
    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    A filter to only return the resources that match the entire display name.
    Filters List<GetCloudDbHomesFilter>
    CloudDbSystemId string
    The OCID of the cloud DB system.
    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    A filter to only return the resources that match the entire display name.
    Filters []GetCloudDbHomesFilter
    cloudDbSystemId String
    The OCID of the cloud DB system.
    compartmentId String
    The OCID of the compartment.
    displayName String
    A filter to only return the resources that match the entire display name.
    filters List<GetCloudDbHomesFilter>
    cloudDbSystemId string
    The OCID of the cloud DB system.
    compartmentId string
    The OCID of the compartment.
    displayName string
    A filter to only return the resources that match the entire display name.
    filters GetCloudDbHomesFilter[]
    cloud_db_system_id str
    The OCID of the cloud DB system.
    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[GetCloudDbHomesFilter]
    cloudDbSystemId String
    The OCID of the cloud DB system.
    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>

    getCloudDbHomes Result

    The following output properties are available:

    CloudDbHomeCollections List<GetCloudDbHomesCloudDbHomeCollection>
    The list of cloud_db_home_collection.
    Id string
    The provider-assigned unique ID for this managed resource.
    CloudDbSystemId string
    The OCID of the cloud DB system that the DB home is a part of.
    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    The user-friendly name for the cloud DB home. The name does not have to be unique.
    Filters List<GetCloudDbHomesFilter>
    CloudDbHomeCollections []GetCloudDbHomesCloudDbHomeCollection
    The list of cloud_db_home_collection.
    Id string
    The provider-assigned unique ID for this managed resource.
    CloudDbSystemId string
    The OCID of the cloud DB system that the DB home is a part of.
    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    The user-friendly name for the cloud DB home. The name does not have to be unique.
    Filters []GetCloudDbHomesFilter
    cloudDbHomeCollections List<GetCloudDbHomesCloudDbHomeCollection>
    The list of cloud_db_home_collection.
    id String
    The provider-assigned unique ID for this managed resource.
    cloudDbSystemId String
    The OCID of the cloud DB system that the DB home is a part of.
    compartmentId String
    The OCID of the compartment.
    displayName String
    The user-friendly name for the cloud DB home. The name does not have to be unique.
    filters List<GetCloudDbHomesFilter>
    cloudDbHomeCollections GetCloudDbHomesCloudDbHomeCollection[]
    The list of cloud_db_home_collection.
    id string
    The provider-assigned unique ID for this managed resource.
    cloudDbSystemId string
    The OCID of the cloud DB system that the DB home is a part of.
    compartmentId string
    The OCID of the compartment.
    displayName string
    The user-friendly name for the cloud DB home. The name does not have to be unique.
    filters GetCloudDbHomesFilter[]
    cloud_db_home_collections Sequence[GetCloudDbHomesCloudDbHomeCollection]
    The list of cloud_db_home_collection.
    id str
    The provider-assigned unique ID for this managed resource.
    cloud_db_system_id str
    The OCID of the cloud DB system that the DB home is a part of.
    compartment_id str
    The OCID of the compartment.
    display_name str
    The user-friendly name for the cloud DB home. The name does not have to be unique.
    filters Sequence[GetCloudDbHomesFilter]
    cloudDbHomeCollections List<Property Map>
    The list of cloud_db_home_collection.
    id String
    The provider-assigned unique ID for this managed resource.
    cloudDbSystemId String
    The OCID of the cloud DB system that the DB home is a part of.
    compartmentId String
    The OCID of the compartment.
    displayName String
    The user-friendly name for the cloud DB home. The name does not have to be unique.
    filters List<Property Map>

    Supporting Types

    GetCloudDbHomesCloudDbHomeCollection

    GetCloudDbHomesCloudDbHomeCollectionItem

    AdditionalDetails Dictionary<string, string>
    The additional details of the DB home defined in {"key": "value"} format. Example: {"bar-key": "value"}
    CloudDbHomeId string
    CloudDbSystemId string
    The OCID of the cloud DB system.
    CompartmentId string
    The OCID of the compartment.
    ComponentName string
    The name of the cloud DB home.
    DbaasId string
    The OCID of the cloud DB home 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"}
    HomeDirectory string
    The location of the DB home.
    Id string
    The OCID of the cloud DB home.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    State string
    The current lifecycle state of the cloud DB home.
    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 DB home was created.
    TimeUpdated string
    The date and time the cloud DB home was last updated.
    AdditionalDetails map[string]string
    The additional details of the DB home defined in {"key": "value"} format. Example: {"bar-key": "value"}
    CloudDbHomeId string
    CloudDbSystemId string
    The OCID of the cloud DB system.
    CompartmentId string
    The OCID of the compartment.
    ComponentName string
    The name of the cloud DB home.
    DbaasId string
    The OCID of the cloud DB home 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"}
    HomeDirectory string
    The location of the DB home.
    Id string
    The OCID of the cloud DB home.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    State string
    The current lifecycle state of the cloud DB home.
    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 DB home was created.
    TimeUpdated string
    The date and time the cloud DB home was last updated.
    additionalDetails Map<String,String>
    The additional details of the DB home defined in {"key": "value"} format. Example: {"bar-key": "value"}
    cloudDbHomeId String
    cloudDbSystemId String
    The OCID of the cloud DB system.
    compartmentId String
    The OCID of the compartment.
    componentName String
    The name of the cloud DB home.
    dbaasId String
    The OCID of the cloud DB home 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"}
    homeDirectory String
    The location of the DB home.
    id String
    The OCID of the cloud DB home.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    state String
    The current lifecycle state of the cloud DB home.
    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 DB home was created.
    timeUpdated String
    The date and time the cloud DB home was last updated.
    additionalDetails {[key: string]: string}
    The additional details of the DB home defined in {"key": "value"} format. Example: {"bar-key": "value"}
    cloudDbHomeId string
    cloudDbSystemId string
    The OCID of the cloud DB system.
    compartmentId string
    The OCID of the compartment.
    componentName string
    The name of the cloud DB home.
    dbaasId string
    The OCID of the cloud DB home 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"}
    homeDirectory string
    The location of the DB home.
    id string
    The OCID of the cloud DB home.
    lifecycleDetails string
    Additional information about the current lifecycle state.
    state string
    The current lifecycle state of the cloud DB home.
    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 DB home was created.
    timeUpdated string
    The date and time the cloud DB home was last updated.
    additional_details Mapping[str, str]
    The additional details of the DB home defined in {"key": "value"} format. Example: {"bar-key": "value"}
    cloud_db_home_id str
    cloud_db_system_id str
    The OCID of the cloud DB system.
    compartment_id str
    The OCID of the compartment.
    component_name str
    The name of the cloud DB home.
    dbaas_id str
    The OCID of the cloud DB home 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"}
    home_directory str
    The location of the DB home.
    id str
    The OCID of the cloud DB home.
    lifecycle_details str
    Additional information about the current lifecycle state.
    state str
    The current lifecycle state of the cloud DB home.
    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 DB home was created.
    time_updated str
    The date and time the cloud DB home was last updated.
    additionalDetails Map<String>
    The additional details of the DB home defined in {"key": "value"} format. Example: {"bar-key": "value"}
    cloudDbHomeId String
    cloudDbSystemId String
    The OCID of the cloud DB system.
    compartmentId String
    The OCID of the compartment.
    componentName String
    The name of the cloud DB home.
    dbaasId String
    The OCID of the cloud DB home 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"}
    homeDirectory String
    The location of the DB home.
    id String
    The OCID of the cloud DB home.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    state String
    The current lifecycle state of the cloud DB home.
    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 DB home was created.
    timeUpdated String
    The date and time the cloud DB home was last updated.

    GetCloudDbHomesFilter

    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