Oracle Cloud Infrastructure v0.13.0, Mar 28 23

oci.DatabaseManagement.getExternalClusterInstances

This data source provides the list of External Cluster Instances in Oracle Cloud Infrastructure Database Management service.

Lists the cluster instances in the specified external cluster.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testExternalClusterInstances = Oci.DatabaseManagement.GetExternalClusterInstances.Invoke(new()
    {
        CompartmentId = @var.Compartment_id,
        DisplayName = @var.External_cluster_instance_display_name,
        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.GetExternalClusterInstances(ctx, &databasemanagement.GetExternalClusterInstancesArgs{
			CompartmentId:     pulumi.StringRef(_var.Compartment_id),
			DisplayName:       pulumi.StringRef(_var.External_cluster_instance_display_name),
			ExternalClusterId: pulumi.StringRef(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.GetExternalClusterInstancesArgs;
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 testExternalClusterInstances = DatabaseManagementFunctions.getExternalClusterInstances(GetExternalClusterInstancesArgs.builder()
            .compartmentId(var_.compartment_id())
            .displayName(var_.external_cluster_instance_display_name())
            .externalClusterId(oci_database_management_external_cluster.test_external_cluster().id())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_external_cluster_instances = oci.DatabaseManagement.get_external_cluster_instances(compartment_id=var["compartment_id"],
    display_name=var["external_cluster_instance_display_name"],
    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 testExternalClusterInstances = oci.DatabaseManagement.getExternalClusterInstances({
    compartmentId: _var.compartment_id,
    displayName: _var.external_cluster_instance_display_name,
    externalClusterId: oci_database_management_external_cluster.test_external_cluster.id,
});

variables:
  testExternalClusterInstances:
    fn::invoke:
      Function: oci:DatabaseManagement:getExternalClusterInstances
      Arguments:
        compartmentId: ${var.compartment_id}
        displayName: ${var.external_cluster_instance_display_name}
        externalClusterId: ${oci_database_management_external_cluster.test_external_cluster.id}

Using getExternalClusterInstances

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 getExternalClusterInstances(args: GetExternalClusterInstancesArgs, opts?: InvokeOptions): Promise<GetExternalClusterInstancesResult>
function getExternalClusterInstancesOutput(args: GetExternalClusterInstancesOutputArgs, opts?: InvokeOptions): Output<GetExternalClusterInstancesResult>

def get_external_cluster_instances(compartment_id: Optional[str] = None,
                                   display_name: Optional[str] = None,
                                   external_cluster_id: Optional[str] = None,
                                   filters: Optional[Sequence[_databasemanagement.GetExternalClusterInstancesFilter]] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetExternalClusterInstancesResult
def get_external_cluster_instances_output(compartment_id: Optional[pulumi.Input[str]] = None,
                                   display_name: Optional[pulumi.Input[str]] = None,
                                   external_cluster_id: Optional[pulumi.Input[str]] = None,
                                   filters: Optional[pulumi.Input[Sequence[pulumi.Input[_databasemanagement.GetExternalClusterInstancesFilterArgs]]]] = None,
                                   opts: Optional[InvokeOptions] = None) -> Output[GetExternalClusterInstancesResult]

func GetExternalClusterInstances(ctx *Context, args *GetExternalClusterInstancesArgs, opts ...InvokeOption) (*GetExternalClusterInstancesResult, error)
func GetExternalClusterInstancesOutput(ctx *Context, args *GetExternalClusterInstancesOutputArgs, opts ...InvokeOption) GetExternalClusterInstancesResultOutput

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

public static class GetExternalClusterInstances 
{
    public static Task<GetExternalClusterInstancesResult> InvokeAsync(GetExternalClusterInstancesArgs args, InvokeOptions? opts = null)
    public static Output<GetExternalClusterInstancesResult> Invoke(GetExternalClusterInstancesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetExternalClusterInstancesResult> getExternalClusterInstances(GetExternalClusterInstancesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:DatabaseManagement/getExternalClusterInstances:getExternalClusterInstances
  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.
ExternalClusterId string: The OCID of the external cluster.
Filters List<GetExternalClusterInstancesFilter>

CompartmentId string: The OCID of the compartment.
DisplayName string: A filter to only return the resources that match the entire display name.
ExternalClusterId string: The OCID of the external cluster.
Filters []GetExternalClusterInstancesFilter

compartmentId String: The OCID of the compartment.
displayName String: A filter to only return the resources that match the entire display name.
externalClusterId String: The OCID of the external cluster.
filters List<GetExternalClusterInstancesFilter>

compartmentId string: The OCID of the compartment.
displayName string: A filter to only return the resources that match the entire display name.
externalClusterId string: The OCID of the external cluster.
filters GetExternalClusterInstancesFilter[]

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_cluster_id str: The OCID of the external cluster.
filters GetExternalClusterInstancesFilter]

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

getExternalClusterInstances Result

The following output properties are available:

ExternalClusterInstanceCollections List<GetExternalClusterInstancesExternalClusterInstanceCollection>: The list of external_cluster_instance_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 cluster instance. The name does not have to be unique.
ExternalClusterId string: The OCID of the external cluster that the cluster instance belongs to.
Filters List<GetExternalClusterInstancesFilter>

ExternalClusterInstanceCollections []GetExternalClusterInstancesExternalClusterInstanceCollection: The list of external_cluster_instance_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 cluster instance. The name does not have to be unique.
ExternalClusterId string: The OCID of the external cluster that the cluster instance belongs to.
Filters []GetExternalClusterInstancesFilter

externalClusterInstanceCollections List<GetExternalClusterInstancesExternalClusterInstanceCollection>: The list of external_cluster_instance_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 cluster instance. The name does not have to be unique.
externalClusterId String: The OCID of the external cluster that the cluster instance belongs to.
filters List<GetExternalClusterInstancesFilter>

externalClusterInstanceCollections GetExternalClusterInstancesExternalClusterInstanceCollection[]: The list of external_cluster_instance_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 cluster instance. The name does not have to be unique.
externalClusterId string: The OCID of the external cluster that the cluster instance belongs to.
filters GetExternalClusterInstancesFilter[]

external_cluster_instance_collections GetExternalClusterInstancesExternalClusterInstanceCollection]: The list of external_cluster_instance_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 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.
filters GetExternalClusterInstancesFilter]

externalClusterInstanceCollections List<Property Map>: The list of external_cluster_instance_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 cluster instance. The name does not have to be unique.
externalClusterId String: The OCID of the external cluster that the cluster instance belongs to.
filters List<Property Map>

Supporting Types

GetExternalClusterInstancesExternalClusterInstanceCollection

Items List<GetExternalClusterInstancesExternalClusterInstanceCollectionItem>

Items []GetExternalClusterInstancesExternalClusterInstanceCollectionItem

items List<GetExternalClusterInstancesExternalClusterInstanceCollectionItem>

items GetExternalClusterInstancesExternalClusterInstanceCollectionItem[]

items GetExternalClusterInstancesExternalClusterInstanceCollectionItem]

items List<Property Map>

GetExternalClusterInstancesExternalClusterInstanceCollectionItem

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).
DisplayName string: A filter to only return the resources that match the entire display name.
ExternalClusterId string: The OCID of the external cluster.
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.
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.
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).
DisplayName string: A filter to only return the resources that match the entire display name.
ExternalClusterId string: The OCID of the external cluster.
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.
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.
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).
displayName String: A filter to only return the resources that match the entire display name.
externalClusterId String: The OCID of the external cluster.
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.
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.
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).
displayName string: A filter to only return the resources that match the entire display name.
externalClusterId string: The OCID of the external cluster.
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.
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.
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).
display_name str: A filter to only return the resources that match the entire display name.
external_cluster_id str: The OCID of the external cluster.
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.
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.
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).
displayName String: A filter to only return the resources that match the entire display name.
externalClusterId String: The OCID of the external cluster.
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.
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.
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.

GetExternalClusterInstancesFilter

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.