Docs Packages
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DatabaseManagement
  5. getExternalClusterInstances
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-oci

oci.DatabaseManagement.getExternalClusterInstances

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-oci

    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

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

const testExternalClusterInstances = oci.DatabaseManagement.getExternalClusterInstances({
    compartmentId: compartmentId,
    displayName: externalClusterInstanceDisplayName,
    externalClusterId: testExternalCluster.id,
});

    import pulumi
import pulumi_oci as oci

test_external_cluster_instances = oci.DatabaseManagement.get_external_cluster_instances(compartment_id=compartment_id,
    display_name=external_cluster_instance_display_name,
    external_cluster_id=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(compartmentId),
			DisplayName:       pulumi.StringRef(externalClusterInstanceDisplayName),
			ExternalClusterId: pulumi.StringRef(testExternalCluster.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 testExternalClusterInstances = Oci.DatabaseManagement.GetExternalClusterInstances.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = externalClusterInstanceDisplayName,
        ExternalClusterId = testExternalCluster.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.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(compartmentId)
            .displayName(externalClusterInstanceDisplayName)
            .externalClusterId(testExternalCluster.id())
            .build());

    }
}

    variables:
  testExternalClusterInstances:
    fn::invoke:
      Function: oci:DatabaseManagement:getExternalClusterInstances
      Arguments:
        compartmentId: ${compartmentId}
        displayName: ${externalClusterInstanceDisplayName}
        externalClusterId: ${testExternalCluster.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 Sequence[databasemanagement.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 Sequence[databasemanagement.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 Sequence[databasemanagement.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

    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).
    DefinedTags Dictionary<string, object>
    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.
    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.
    FreeformTags Dictionary<string, object>
    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, object>
    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]interface{}
    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.
    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.
    FreeformTags map[string]interface{}
    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]interface{}
    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,Object>
    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.
    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.
    freeformTags Map<String,Object>
    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,Object>
    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]: any}
    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.
    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.
    freeformTags {[key: string]: any}
    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]: any}
    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, Any]
    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.
    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.
    freeform_tags Mapping[str, Any]
    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, Any]
    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<Any>
    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.
    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.
    freeformTags Map<Any>
    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<Any>
    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.

    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.
    oci logo
    Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
    pulumi/pulumi-oci