Oracle Cloud Infrastructure v2.30.0, Apr 14 25

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

oci.DatabaseManagement.getExternalDbNodes

Explore with Pulumi AI

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

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const testExternalDbNodes = oci.DatabaseManagement.getExternalDbNodes({
    compartmentId: compartmentId,
    displayName: externalDbNodeDisplayName,
    externalDbSystemId: testExternalDbSystem.id,
});

import pulumi
import pulumi_oci as oci

test_external_db_nodes = oci.DatabaseManagement.get_external_db_nodes(compartment_id=compartment_id,
    display_name=external_db_node_display_name,
    external_db_system_id=test_external_db_system["id"])

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/databasemanagement"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databasemanagement.GetExternalDbNodes(ctx, &databasemanagement.GetExternalDbNodesArgs{
			CompartmentId:      pulumi.StringRef(compartmentId),
			DisplayName:        pulumi.StringRef(externalDbNodeDisplayName),
			ExternalDbSystemId: pulumi.StringRef(testExternalDbSystem.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 testExternalDbNodes = Oci.DatabaseManagement.GetExternalDbNodes.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = externalDbNodeDisplayName,
        ExternalDbSystemId = testExternalDbSystem.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.GetExternalDbNodesArgs;
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 testExternalDbNodes = DatabaseManagementFunctions.getExternalDbNodes(GetExternalDbNodesArgs.builder()
            .compartmentId(compartmentId)
            .displayName(externalDbNodeDisplayName)
            .externalDbSystemId(testExternalDbSystem.id())
            .build());

    }
}

variables:
  testExternalDbNodes:
    fn::invoke:
      function: oci:DatabaseManagement:getExternalDbNodes
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${externalDbNodeDisplayName}
        externalDbSystemId: ${testExternalDbSystem.id}

Using getExternalDbNodes

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.

TypeScript
Python
Go
C#
Java
YAML

function getExternalDbNodes(args: GetExternalDbNodesArgs, opts?: InvokeOptions): Promise<GetExternalDbNodesResult>
function getExternalDbNodesOutput(args: GetExternalDbNodesOutputArgs, opts?: InvokeOptions): Output<GetExternalDbNodesResult>

def get_external_db_nodes(compartment_id: Optional[str] = None,
                          display_name: Optional[str] = None,
                          external_db_system_id: Optional[str] = None,
                          filters: Optional[Sequence[_databasemanagement.GetExternalDbNodesFilter]] = None,
                          opts: Optional[InvokeOptions] = None) -> GetExternalDbNodesResult
def get_external_db_nodes_output(compartment_id: Optional[pulumi.Input[str]] = None,
                          display_name: Optional[pulumi.Input[str]] = None,
                          external_db_system_id: Optional[pulumi.Input[str]] = None,
                          filters: Optional[pulumi.Input[Sequence[pulumi.Input[_databasemanagement.GetExternalDbNodesFilterArgs]]]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetExternalDbNodesResult]

func GetExternalDbNodes(ctx *Context, args *GetExternalDbNodesArgs, opts ...InvokeOption) (*GetExternalDbNodesResult, error)
func GetExternalDbNodesOutput(ctx *Context, args *GetExternalDbNodesOutputArgs, opts ...InvokeOption) GetExternalDbNodesResultOutput

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

public static class GetExternalDbNodes 
{
    public static Task<GetExternalDbNodesResult> InvokeAsync(GetExternalDbNodesArgs args, InvokeOptions? opts = null)
    public static Output<GetExternalDbNodesResult> Invoke(GetExternalDbNodesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetExternalDbNodesResult> getExternalDbNodes(GetExternalDbNodesArgs args, InvokeOptions options)
public static Output<GetExternalDbNodesResult> getExternalDbNodes(GetExternalDbNodesArgs args, InvokeOptions options)

fn::invoke:
  function: oci:DatabaseManagement/getExternalDbNodes:getExternalDbNodes
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The OCID of the compartment.
DisplayName string: A filter to only return the resources that match the entire display name.
ExternalDbSystemId string: The OCID of the external DB system.
Filters List<GetExternalDbNodesFilter>

CompartmentId string: The OCID of the compartment.
DisplayName string: A filter to only return the resources that match the entire display name.
ExternalDbSystemId string: The OCID of the external DB system.
Filters []GetExternalDbNodesFilter

compartmentId String: The OCID of the compartment.
displayName String: A filter to only return the resources that match the entire display name.
externalDbSystemId String: The OCID of the external DB system.
filters List<GetExternalDbNodesFilter>

compartmentId string: The OCID of the compartment.
displayName string: A filter to only return the resources that match the entire display name.
externalDbSystemId string: The OCID of the external DB system.
filters GetExternalDbNodesFilter[]

compartment_id str: The OCID of the compartment.
display_name str: A filter to only return the resources that match the entire display name.
external_db_system_id str: The OCID of the external DB system.
filters Sequence[databasemanagement.GetExternalDbNodesFilter]

compartmentId String: The OCID of the compartment.
displayName String: A filter to only return the resources that match the entire display name.
externalDbSystemId String: The OCID of the external DB system.
filters List<Property Map>

getExternalDbNodes Result

The following output properties are available:

ExternalDbNodeCollections List<GetExternalDbNodesExternalDbNodeCollection>: The list of external_db_node_collection.
Id string: The provider-assigned unique ID for this managed resource.
CompartmentId string: The OCID of the compartment.
DisplayName string: The user-friendly name for the external DB node. The name does not have to be unique.
ExternalDbSystemId string: The OCID of the external DB system that the DB node is a part of.
Filters List<GetExternalDbNodesFilter>

ExternalDbNodeCollections []GetExternalDbNodesExternalDbNodeCollection: The list of external_db_node_collection.
Id string: The provider-assigned unique ID for this managed resource.
CompartmentId string: The OCID of the compartment.
DisplayName string: The user-friendly name for the external DB node. The name does not have to be unique.
ExternalDbSystemId string: The OCID of the external DB system that the DB node is a part of.
Filters []GetExternalDbNodesFilter

externalDbNodeCollections List<GetExternalDbNodesExternalDbNodeCollection>: The list of external_db_node_collection.
id String: The provider-assigned unique ID for this managed resource.
compartmentId String: The OCID of the compartment.
displayName String: The user-friendly name for the external DB node. The name does not have to be unique.
externalDbSystemId String: The OCID of the external DB system that the DB node is a part of.
filters List<GetExternalDbNodesFilter>

externalDbNodeCollections GetExternalDbNodesExternalDbNodeCollection[]: The list of external_db_node_collection.
id string: The provider-assigned unique ID for this managed resource.
compartmentId string: The OCID of the compartment.
displayName string: The user-friendly name for the external DB node. The name does not have to be unique.
externalDbSystemId string: The OCID of the external DB system that the DB node is a part of.
filters GetExternalDbNodesFilter[]

external_db_node_collections Sequence[databasemanagement.GetExternalDbNodesExternalDbNodeCollection]: The list of external_db_node_collection.
id str: The provider-assigned unique ID for this managed resource.
compartment_id str: The OCID of the compartment.
display_name str: The user-friendly name for the external DB node. The name does not have to be unique.
external_db_system_id str: The OCID of the external DB system that the DB node is a part of.
filters Sequence[databasemanagement.GetExternalDbNodesFilter]

externalDbNodeCollections List<Property Map>: The list of external_db_node_collection.
id String: The provider-assigned unique ID for this managed resource.
compartmentId String: The OCID of the compartment.
displayName String: The user-friendly name for the external DB node. The name does not have to be unique.
externalDbSystemId String: The OCID of the external DB system that the DB node is a part of.
filters List<Property Map>

Supporting Types

GetExternalDbNodesExternalDbNodeCollection

Items List<GetExternalDbNodesExternalDbNodeCollectionItem>

Items []GetExternalDbNodesExternalDbNodeCollectionItem

items List<GetExternalDbNodesExternalDbNodeCollectionItem>

items GetExternalDbNodesExternalDbNodeCollectionItem[]

items Sequence[databasemanagement.GetExternalDbNodesExternalDbNodeCollectionItem]

items List<Property Map>

GetExternalDbNodesExternalDbNodeCollectionItem

AdditionalDetails Dictionary<string, string>: The additional details of the external DB node defined in {"key": "value"} format. Example: {"bar-key": "value"}
CompartmentId string: The OCID of the compartment.
ComponentName string: The name of the external DB node.
CpuCoreCount double: The number of CPU cores available on the DB node.
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.
DomainName string: Name of the domain.
ExternalConnectorId string: The OCID of the external connector.
ExternalDbNodeId string
ExternalDbSystemId string: The OCID of the external DB system.
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 host name for the DB node.
Id string: The OCID of the external DB node.
LifecycleDetails string: Additional information about the current lifecycle state.
MemorySizeInGbs double: The total memory in gigabytes (GB) on the DB node.
State string: The current lifecycle state of the external DB node.
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 external DB node was created.
TimeUpdated string: The date and time the external DB node was last updated.

AdditionalDetails map[string]string: The additional details of the external DB node defined in {"key": "value"} format. Example: {"bar-key": "value"}
CompartmentId string: The OCID of the compartment.
ComponentName string: The name of the external DB node.
CpuCoreCount float64: The number of CPU cores available on the DB node.
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.
DomainName string: Name of the domain.
ExternalConnectorId string: The OCID of the external connector.
ExternalDbNodeId string
ExternalDbSystemId string: The OCID of the external DB system.
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 host name for the DB node.
Id string: The OCID of the external DB node.
LifecycleDetails string: Additional information about the current lifecycle state.
MemorySizeInGbs float64: The total memory in gigabytes (GB) on the DB node.
State string: The current lifecycle state of the external DB node.
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 external DB node was created.
TimeUpdated string: The date and time the external DB node was last updated.

additionalDetails Map<String,String>: The additional details of the external DB node defined in {"key": "value"} format. Example: {"bar-key": "value"}
compartmentId String: The OCID of the compartment.
componentName String: The name of the external DB node.
cpuCoreCount Double: The number of CPU cores available on the DB node.
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.
domainName String: Name of the domain.
externalConnectorId String: The OCID of the external connector.
externalDbNodeId String
externalDbSystemId String: The OCID of the external DB system.
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 host name for the DB node.
id String: The OCID of the external DB node.
lifecycleDetails String: Additional information about the current lifecycle state.
memorySizeInGbs Double: The total memory in gigabytes (GB) on the DB node.
state String: The current lifecycle state of the external DB node.
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 external DB node was created.
timeUpdated String: The date and time the external DB node was last updated.

additionalDetails {[key: string]: string}: The additional details of the external DB node defined in {"key": "value"} format. Example: {"bar-key": "value"}
compartmentId string: The OCID of the compartment.
componentName string: The name of the external DB node.
cpuCoreCount number: The number of CPU cores available on the DB node.
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.
domainName string: Name of the domain.
externalConnectorId string: The OCID of the external connector.
externalDbNodeId string
externalDbSystemId string: The OCID of the external DB system.
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 host name for the DB node.
id string: The OCID of the external DB node.
lifecycleDetails string: Additional information about the current lifecycle state.
memorySizeInGbs number: The total memory in gigabytes (GB) on the DB node.
state string: The current lifecycle state of the external DB node.
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 external DB node was created.
timeUpdated string: The date and time the external DB node was last updated.

additional_details Mapping[str, str]: The additional details of the external DB node defined in {"key": "value"} format. Example: {"bar-key": "value"}
compartment_id str: The OCID of the compartment.
component_name str: The name of the external DB node.
cpu_core_count float: The number of CPU cores available on the DB node.
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.
domain_name str: Name of the domain.
external_connector_id str: The OCID of the external connector.
external_db_node_id str
external_db_system_id str: The OCID of the external DB system.
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 host name for the DB node.
id str: The OCID of the external DB node.
lifecycle_details str: Additional information about the current lifecycle state.
memory_size_in_gbs float: The total memory in gigabytes (GB) on the DB node.
state str: The current lifecycle state of the external DB node.
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 external DB node was created.
time_updated str: The date and time the external DB node was last updated.

additionalDetails Map<String>: The additional details of the external DB node defined in {"key": "value"} format. Example: {"bar-key": "value"}
compartmentId String: The OCID of the compartment.
componentName String: The name of the external DB node.
cpuCoreCount Number: The number of CPU cores available on the DB node.
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.
domainName String: Name of the domain.
externalConnectorId String: The OCID of the external connector.
externalDbNodeId String
externalDbSystemId String: The OCID of the external DB system.
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 host name for the DB node.
id String: The OCID of the external DB node.
lifecycleDetails String: Additional information about the current lifecycle state.
memorySizeInGbs Number: The total memory in gigabytes (GB) on the DB node.
state String: The current lifecycle state of the external DB node.
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 external DB node was created.
timeUpdated String: The date and time the external DB node was last updated.

GetExternalDbNodesFilter

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.

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

pulumi/pulumi-oci

oci.DatabaseManagement.getExternalDbNodes

On this page

On this page

Example Usage

Using getExternalDbNodes

getExternalDbNodes Result

Supporting Types

GetExternalDbNodesExternalDbNodeCollection

GetExternalDbNodesExternalDbNodeCollectionItem

GetExternalDbNodesFilter

Package Details

On this page

On this page