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

oci.DatabaseManagement.getExternalClusterInstance

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

    Gets the details for the external cluster instance specified by externalClusterInstanceId.

    Example Usage

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

const testExternalClusterInstance = oci.DatabaseManagement.getExternalClusterInstance({
    externalClusterInstanceId: testExternalClusterInstanceOciDatabaseManagementExternalClusterInstance.id,
});

    import pulumi
import pulumi_oci as oci

test_external_cluster_instance = oci.DatabaseManagement.get_external_cluster_instance(external_cluster_instance_id=test_external_cluster_instance_oci_database_management_external_cluster_instance["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.GetExternalClusterInstance(ctx, &databasemanagement.GetExternalClusterInstanceArgs{
			ExternalClusterInstanceId: testExternalClusterInstanceOciDatabaseManagementExternalClusterInstance.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 testExternalClusterInstance = Oci.DatabaseManagement.GetExternalClusterInstance.Invoke(new()
    {
        ExternalClusterInstanceId = testExternalClusterInstanceOciDatabaseManagementExternalClusterInstance.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.GetExternalClusterInstanceArgs;
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 testExternalClusterInstance = DatabaseManagementFunctions.getExternalClusterInstance(GetExternalClusterInstanceArgs.builder()
            .externalClusterInstanceId(testExternalClusterInstanceOciDatabaseManagementExternalClusterInstance.id())
            .build());

    }
}

    variables:
  testExternalClusterInstance:
    fn::invoke:
      function: oci:DatabaseManagement:getExternalClusterInstance
      arguments:
        externalClusterInstanceId: ${testExternalClusterInstanceOciDatabaseManagementExternalClusterInstance.id}

    Using getExternalClusterInstance

    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 getExternalClusterInstance(args: GetExternalClusterInstanceArgs, opts?: InvokeOptions): Promise<GetExternalClusterInstanceResult>
function getExternalClusterInstanceOutput(args: GetExternalClusterInstanceOutputArgs, opts?: InvokeOptions): Output<GetExternalClusterInstanceResult>
    def get_external_cluster_instance(external_cluster_instance_id: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetExternalClusterInstanceResult
def get_external_cluster_instance_output(external_cluster_instance_id: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetExternalClusterInstanceResult]
    func GetExternalClusterInstance(ctx *Context, args *GetExternalClusterInstanceArgs, opts ...InvokeOption) (*GetExternalClusterInstanceResult, error)
func GetExternalClusterInstanceOutput(ctx *Context, args *GetExternalClusterInstanceOutputArgs, opts ...InvokeOption) GetExternalClusterInstanceResultOutput

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

    public static class GetExternalClusterInstance 
{
    public static Task<GetExternalClusterInstanceResult> InvokeAsync(GetExternalClusterInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetExternalClusterInstanceResult> Invoke(GetExternalClusterInstanceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetExternalClusterInstanceResult> getExternalClusterInstance(GetExternalClusterInstanceArgs args, InvokeOptions options)
public static Output<GetExternalClusterInstanceResult> getExternalClusterInstance(GetExternalClusterInstanceArgs args, InvokeOptions options)

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

    The following arguments are supported:

    ExternalClusterInstanceId string
    The OCID of the external cluster instance.
    ExternalClusterInstanceId string
    The OCID of the external cluster instance.
    externalClusterInstanceId String
    The OCID of the external cluster instance.
    externalClusterInstanceId string
    The OCID of the external cluster instance.
    external_cluster_instance_id str
    The OCID of the external cluster instance.
    externalClusterInstanceId String
    The OCID of the external cluster instance.

    getExternalClusterInstance Result

    The following output properties are available:

    AdrHomeDirectory string
    The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
    CompartmentId string
    The OCID of the compartment.
    ComponentName string
    The name of the external cluster instance.
    CrsBaseDirectory string
    The Oracle base location of Cluster Ready Services (CRS).
    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 cluster instance. The name does not have to be unique.
    ExternalClusterId string
    The OCID of the external cluster that the cluster instance belongs to.
    ExternalClusterInstanceId string
    ExternalConnectorId string
    The OCID of the external connector.
    ExternalDbNodeId string
    The OCID of the external DB node.
    ExternalDbSystemId string
    The OCID of the external DB system that the cluster instance 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"}
    HostName string
    The name of the host on which the cluster instance is running.
    Id string
    The OCID of the external cluster instance.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    NodeRole string
    The role of the cluster node.
    State string
    The current lifecycle state of the external cluster instance.
    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 instance was created.
    TimeUpdated string
    The date and time the external cluster instance was last updated.
    AdrHomeDirectory string
    The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
    CompartmentId string
    The OCID of the compartment.
    ComponentName string
    The name of the external cluster instance.
    CrsBaseDirectory string
    The Oracle base location of Cluster Ready Services (CRS).
    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 cluster instance. The name does not have to be unique.
    ExternalClusterId string
    The OCID of the external cluster that the cluster instance belongs to.
    ExternalClusterInstanceId string
    ExternalConnectorId string
    The OCID of the external connector.
    ExternalDbNodeId string
    The OCID of the external DB node.
    ExternalDbSystemId string
    The OCID of the external DB system that the cluster instance 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"}
    HostName string
    The name of the host on which the cluster instance is running.
    Id string
    The OCID of the external cluster instance.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    NodeRole string
    The role of the cluster node.
    State string
    The current lifecycle state of the external cluster instance.
    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 instance was created.
    TimeUpdated string
    The date and time the external cluster instance was last updated.
    adrHomeDirectory String
    The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
    compartmentId String
    The OCID of the compartment.
    componentName String
    The name of the external cluster instance.
    crsBaseDirectory String
    The Oracle base location of Cluster Ready Services (CRS).
    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 cluster instance. The name does not have to be unique.
    externalClusterId String
    The OCID of the external cluster that the cluster instance belongs to.
    externalClusterInstanceId String
    externalConnectorId String
    The OCID of the external connector.
    externalDbNodeId String
    The OCID of the external DB node.
    externalDbSystemId String
    The OCID of the external DB system that the cluster instance 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"}
    hostName String
    The name of the host on which the cluster instance is running.
    id String
    The OCID of the external cluster instance.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    nodeRole String
    The role of the cluster node.
    state String
    The current lifecycle state of the external cluster instance.
    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 instance was created.
    timeUpdated String
    The date and time the external cluster instance was last updated.
    adrHomeDirectory string
    The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
    compartmentId string
    The OCID of the compartment.
    componentName string
    The name of the external cluster instance.
    crsBaseDirectory string
    The Oracle base location of Cluster Ready Services (CRS).
    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 cluster instance. The name does not have to be unique.
    externalClusterId string
    The OCID of the external cluster that the cluster instance belongs to.
    externalClusterInstanceId string
    externalConnectorId string
    The OCID of the external connector.
    externalDbNodeId string
    The OCID of the external DB node.
    externalDbSystemId string
    The OCID of the external DB system that the cluster instance 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"}
    hostName string
    The name of the host on which the cluster instance is running.
    id string
    The OCID of the external cluster instance.
    lifecycleDetails string
    Additional information about the current lifecycle state.
    nodeRole string
    The role of the cluster node.
    state string
    The current lifecycle state of the external cluster instance.
    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 instance was created.
    timeUpdated string
    The date and time the external cluster instance was last updated.
    adr_home_directory str
    The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
    compartment_id str
    The OCID of the compartment.
    component_name str
    The name of the external cluster instance.
    crs_base_directory str
    The Oracle base location of Cluster Ready Services (CRS).
    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 cluster instance. The name does not have to be unique.
    external_cluster_id str
    The OCID of the external cluster that the cluster instance belongs to.
    external_cluster_instance_id str
    external_connector_id str
    The OCID of the external connector.
    external_db_node_id str
    The OCID of the external DB node.
    external_db_system_id str
    The OCID of the external DB system that the cluster instance 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"}
    host_name str
    The name of the host on which the cluster instance is running.
    id str
    The OCID of the external cluster instance.
    lifecycle_details str
    Additional information about the current lifecycle state.
    node_role str
    The role of the cluster node.
    state str
    The current lifecycle state of the external cluster instance.
    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 instance was created.
    time_updated str
    The date and time the external cluster instance was last updated.
    adrHomeDirectory String
    The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
    compartmentId String
    The OCID of the compartment.
    componentName String
    The name of the external cluster instance.
    crsBaseDirectory String
    The Oracle base location of Cluster Ready Services (CRS).
    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 cluster instance. The name does not have to be unique.
    externalClusterId String
    The OCID of the external cluster that the cluster instance belongs to.
    externalClusterInstanceId String
    externalConnectorId String
    The OCID of the external connector.
    externalDbNodeId String
    The OCID of the external DB node.
    externalDbSystemId String
    The OCID of the external DB system that the cluster instance 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"}
    hostName String
    The name of the host on which the cluster instance is running.
    id String
    The OCID of the external cluster instance.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    nodeRole String
    The role of the cluster node.
    state String
    The current lifecycle state of the external cluster instance.
    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 instance was created.
    timeUpdated String
    The date and time the external cluster instance was last updated.

    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