Oracle Cloud Infrastructure v0.13.0, Mar 28 23

oci.DatabaseManagement.getExternalCluster

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

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testExternalCluster = Oci.DatabaseManagement.GetExternalCluster.Invoke(new()
    {
        ExternalClusterId = oci_database_management_external_cluster.Test_external_cluster.Id,
    });

});

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/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: oci_database_management_external_cluster.Test_external_cluster.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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(oci_database_management_external_cluster.test_external_cluster().id())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_external_cluster = oci.DatabaseManagement.get_external_cluster(external_cluster_id=oci_database_management_external_cluster["test_external_cluster"]["id"])

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

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

variables:
  testExternalCluster:
    fn::invoke:
      Function: oci:DatabaseManagement:getExternalCluster
      Arguments:
        externalClusterId: ${oci_database_management_external_cluster.test_external_cluster.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)
// Output-based functions aren't available in Java yet

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, object>: 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.
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.
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.
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]interface{}: 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.
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.
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.
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,Object>: 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.
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.
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.
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]: any}: 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.
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.
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.
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, Any]: 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.
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.
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 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 GetExternalClusterScanConfiguration]: The list of Single Client Access Name (SCAN) configurations of the external cluster.
state str: The current lifecycle state of the external cluster.
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 GetExternalClusterVipConfiguration]: The list of Virtual IP (VIP) configurations of the external cluster.

additionalDetails Map<Any>: 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.
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.
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.
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.