Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DatabaseManagement
  5. getExternalCluster
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

oci.DatabaseManagement.getExternalCluster

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

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

    Gets the details for the external cluster specified by externalClusterId.

    Example Usage

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

const testExternalCluster = oci.DatabaseManagement.getExternalCluster({
    externalClusterId: testExternalClusterOciDatabaseManagementExternalCluster.id,
});

    import pulumi
import pulumi_oci as oci

test_external_cluster = oci.DatabaseManagement.get_external_cluster(external_cluster_id=test_external_cluster_oci_database_management_external_cluster["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.GetExternalCluster(ctx, &databasemanagement.GetExternalClusterArgs{
			ExternalClusterId: testExternalClusterOciDatabaseManagementExternalCluster.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 testExternalCluster = Oci.DatabaseManagement.GetExternalCluster.Invoke(new()
    {
        ExternalClusterId = testExternalClusterOciDatabaseManagementExternalCluster.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.GetExternalClusterArgs;
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 testExternalCluster = DatabaseManagementFunctions.getExternalCluster(GetExternalClusterArgs.builder()
            .externalClusterId(testExternalClusterOciDatabaseManagementExternalCluster.id())
            .build());

    }
}

    variables:
  testExternalCluster:
    fn::invoke:
      function: oci:DatabaseManagement:getExternalCluster
      arguments:
        externalClusterId: ${testExternalClusterOciDatabaseManagementExternalCluster.id}

    Using getExternalCluster

    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 getExternalCluster(args: GetExternalClusterArgs, opts?: InvokeOptions): Promise<GetExternalClusterResult>
function getExternalClusterOutput(args: GetExternalClusterOutputArgs, opts?: InvokeOptions): Output<GetExternalClusterResult>
    def get_external_cluster(external_cluster_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetExternalClusterResult
def get_external_cluster_output(external_cluster_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetExternalClusterResult]
    func GetExternalCluster(ctx *Context, args *GetExternalClusterArgs, opts ...InvokeOption) (*GetExternalClusterResult, error)
func GetExternalClusterOutput(ctx *Context, args *GetExternalClusterOutputArgs, opts ...InvokeOption) GetExternalClusterResultOutput

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

    public static class GetExternalCluster 
{
    public static Task<GetExternalClusterResult> InvokeAsync(GetExternalClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetExternalClusterResult> Invoke(GetExternalClusterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetExternalClusterResult> getExternalCluster(GetExternalClusterArgs args, InvokeOptions options)
public static Output<GetExternalClusterResult> getExternalCluster(GetExternalClusterArgs args, InvokeOptions options)

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

    The following arguments are supported:

    ExternalClusterId string
    The OCID of the external cluster.
    ExternalClusterId string
    The OCID of the external cluster.
    externalClusterId String
    The OCID of the external cluster.
    externalClusterId string
    The OCID of the external cluster.
    external_cluster_id str
    The OCID of the external cluster.
    externalClusterId String
    The OCID of the external cluster.

    getExternalCluster Result

    The following output properties are available:

    AdditionalDetails Dictionary<string, string>
    The additional details of the external cluster defined in {"key": "value"} format. Example: {"bar-key": "value"}
    CompartmentId string
    The OCID of the compartment.
    ComponentName string
    The name of the external cluster.
    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 external cluster. The name does not have to be unique.
    ExternalClusterId string
    ExternalConnectorId string
    The OCID of the external connector.
    ExternalDbSystemId string
    The OCID of the external DB system that the cluster is a part of.
    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 external cluster.
    IsFlexCluster bool
    Indicates whether the cluster is Oracle Flex Cluster or not.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    NetworkConfigurations List<GetExternalClusterNetworkConfiguration>
    The list of network address configurations of the external cluster.
    OcrFileLocation string
    The location of the Oracle Cluster Registry (OCR).
    ScanConfigurations List<GetExternalClusterScanConfiguration>
    The list of Single Client Access Name (SCAN) configurations of the external cluster.
    State string
    The current lifecycle state of the external 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 external cluster was created.
    TimeUpdated string
    The date and time the external cluster was last updated.
    Version string
    The cluster version.
    VipConfigurations List<GetExternalClusterVipConfiguration>
    The list of Virtual IP (VIP) configurations of the external cluster.
    AdditionalDetails map[string]string
    The additional details of the external cluster defined in {"key": "value"} format. Example: {"bar-key": "value"}
    CompartmentId string
    The OCID of the compartment.
    ComponentName string
    The name of the external cluster.
    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 external cluster. The name does not have to be unique.
    ExternalClusterId string
    ExternalConnectorId string
    The OCID of the external connector.
    ExternalDbSystemId string
    The OCID of the external DB system that the cluster is a part of.
    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 external cluster.
    IsFlexCluster bool
    Indicates whether the cluster is Oracle Flex Cluster or not.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    NetworkConfigurations []GetExternalClusterNetworkConfiguration
    The list of network address configurations of the external cluster.
    OcrFileLocation string
    The location of the Oracle Cluster Registry (OCR).
    ScanConfigurations []GetExternalClusterScanConfiguration
    The list of Single Client Access Name (SCAN) configurations of the external cluster.
    State string
    The current lifecycle state of the external 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 external cluster was created.
    TimeUpdated string
    The date and time the external cluster was last updated.
    Version string
    The cluster version.
    VipConfigurations []GetExternalClusterVipConfiguration
    The list of Virtual IP (VIP) configurations of the external cluster.
    additionalDetails Map<String,String>
    The additional details of the external cluster defined in {"key": "value"} format. Example: {"bar-key": "value"}
    compartmentId String
    The OCID of the compartment.
    componentName String
    The name of the external cluster.
    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 external cluster. The name does not have to be unique.
    externalClusterId String
    externalConnectorId String
    The OCID of the external connector.
    externalDbSystemId String
    The OCID of the external DB system that the cluster is a part of.
    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 external cluster.
    isFlexCluster Boolean
    Indicates whether the cluster is Oracle Flex Cluster or not.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    networkConfigurations List<GetExternalClusterNetworkConfiguration>
    The list of network address configurations of the external cluster.
    ocrFileLocation String
    The location of the Oracle Cluster Registry (OCR).
    scanConfigurations List<GetExternalClusterScanConfiguration>
    The list of Single Client Access Name (SCAN) configurations of the external cluster.
    state String
    The current lifecycle state of the external 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 external cluster was created.
    timeUpdated String
    The date and time the external cluster was last updated.
    version String
    The cluster version.
    vipConfigurations List<GetExternalClusterVipConfiguration>
    The list of Virtual IP (VIP) configurations of the external cluster.
    additionalDetails {[key: string]: string}
    The additional details of the external cluster defined in {"key": "value"} format. Example: {"bar-key": "value"}
    compartmentId string
    The OCID of the compartment.
    componentName string
    The name of the external cluster.
    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 external cluster. The name does not have to be unique.
    externalClusterId string
    externalConnectorId string
    The OCID of the external connector.
    externalDbSystemId string
    The OCID of the external DB system that the cluster is a part of.
    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 external cluster.
    isFlexCluster boolean
    Indicates whether the cluster is Oracle Flex Cluster or not.
    lifecycleDetails string
    Additional information about the current lifecycle state.
    networkConfigurations GetExternalClusterNetworkConfiguration[]
    The list of network address configurations of the external cluster.
    ocrFileLocation string
    The location of the Oracle Cluster Registry (OCR).
    scanConfigurations GetExternalClusterScanConfiguration[]
    The list of Single Client Access Name (SCAN) configurations of the external cluster.
    state string
    The current lifecycle state of the external 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 external cluster was created.
    timeUpdated string
    The date and time the external cluster was last updated.
    version string
    The cluster version.
    vipConfigurations GetExternalClusterVipConfiguration[]
    The list of Virtual IP (VIP) configurations of the external cluster.
    additional_details Mapping[str, str]
    The additional details of the external cluster 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 cluster.
    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 external cluster. The name does not have to be unique.
    external_cluster_id str
    external_connector_id str
    The OCID of the external connector.
    external_db_system_id str
    The OCID of the external DB system that the cluster is a part of.
    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 external 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[databasemanagement.GetExternalClusterNetworkConfiguration]
    The list of network address configurations of the external cluster.
    ocr_file_location str
    The location of the Oracle Cluster Registry (OCR).
    scan_configurations Sequence[databasemanagement.GetExternalClusterScanConfiguration]
    The list of Single Client Access Name (SCAN) configurations of the external cluster.
    state str
    The current lifecycle state of the external 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 external cluster was created.
    time_updated str
    The date and time the external cluster was last updated.
    version str
    The cluster version.
    vip_configurations Sequence[databasemanagement.GetExternalClusterVipConfiguration]
    The list of Virtual IP (VIP) configurations of the external cluster.
    additionalDetails Map<String>
    The additional details of the external cluster defined in {"key": "value"} format. Example: {"bar-key": "value"}
    compartmentId String
    The OCID of the compartment.
    componentName String
    The name of the external cluster.
    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 external cluster. The name does not have to be unique.
    externalClusterId String
    externalConnectorId String
    The OCID of the external connector.
    externalDbSystemId String
    The OCID of the external DB system that the cluster is a part of.
    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 external 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 external 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 external cluster.
    state String
    The current lifecycle state of the external 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 external cluster was created.
    timeUpdated String
    The date and time the external cluster was last updated.
    version String
    The cluster version.
    vipConfigurations List<Property Map>
    The list of Virtual IP (VIP) configurations of the external cluster.

    Supporting Types

    GetExternalClusterNetworkConfiguration

    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.

    GetExternalClusterScanConfiguration

    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.

    GetExternalClusterVipConfiguration

    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 v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
    pulumi/pulumi-oci