1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DatabaseManagement
  5. getExternalClusters
Oracle Cloud Infrastructure v1.23.0 published on Thursday, Feb 15, 2024 by Pulumi

oci.DatabaseManagement.getExternalClusters

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.23.0 published on Thursday, Feb 15, 2024 by Pulumi

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

    Lists the clusters in the specified external DB system.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testExternalClusters = Oci.DatabaseManagement.GetExternalClusters.Invoke(new()
        {
            CompartmentId = @var.Compartment_id,
            DisplayName = @var.External_cluster_display_name,
            ExternalDbSystemId = oci_database_management_external_db_system.Test_external_db_system.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.GetExternalClusters(ctx, &databasemanagement.GetExternalClustersArgs{
    			CompartmentId:      pulumi.StringRef(_var.Compartment_id),
    			DisplayName:        pulumi.StringRef(_var.External_cluster_display_name),
    			ExternalDbSystemId: pulumi.StringRef(oci_database_management_external_db_system.Test_external_db_system.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.GetExternalClustersArgs;
    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 testExternalClusters = DatabaseManagementFunctions.getExternalClusters(GetExternalClustersArgs.builder()
                .compartmentId(var_.compartment_id())
                .displayName(var_.external_cluster_display_name())
                .externalDbSystemId(oci_database_management_external_db_system.test_external_db_system().id())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_oci as oci
    
    test_external_clusters = oci.DatabaseManagement.get_external_clusters(compartment_id=var["compartment_id"],
        display_name=var["external_cluster_display_name"],
        external_db_system_id=oci_database_management_external_db_system["test_external_db_system"]["id"])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testExternalClusters = oci.DatabaseManagement.getExternalClusters({
        compartmentId: _var.compartment_id,
        displayName: _var.external_cluster_display_name,
        externalDbSystemId: oci_database_management_external_db_system.test_external_db_system.id,
    });
    
    variables:
      testExternalClusters:
        fn::invoke:
          Function: oci:DatabaseManagement:getExternalClusters
          Arguments:
            compartmentId: ${var.compartment_id}
            displayName: ${var.external_cluster_display_name}
            externalDbSystemId: ${oci_database_management_external_db_system.test_external_db_system.id}
    

    Using getExternalClusters

    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 getExternalClusters(args: GetExternalClustersArgs, opts?: InvokeOptions): Promise<GetExternalClustersResult>
    function getExternalClustersOutput(args: GetExternalClustersOutputArgs, opts?: InvokeOptions): Output<GetExternalClustersResult>
    def get_external_clusters(compartment_id: Optional[str] = None,
                              display_name: Optional[str] = None,
                              external_db_system_id: Optional[str] = None,
                              filters: Optional[Sequence[_databasemanagement.GetExternalClustersFilter]] = None,
                              opts: Optional[InvokeOptions] = None) -> GetExternalClustersResult
    def get_external_clusters_output(compartment_id: Optional[pulumi.Input[str]] = None,
                              display_name: Optional[pulumi.Input[str]] = None,
                              external_db_system_id: Optional[pulumi.Input[str]] = None,
                              filters: Optional[pulumi.Input[Sequence[pulumi.Input[_databasemanagement.GetExternalClustersFilterArgs]]]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetExternalClustersResult]
    func GetExternalClusters(ctx *Context, args *GetExternalClustersArgs, opts ...InvokeOption) (*GetExternalClustersResult, error)
    func GetExternalClustersOutput(ctx *Context, args *GetExternalClustersOutputArgs, opts ...InvokeOption) GetExternalClustersResultOutput

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

    public static class GetExternalClusters 
    {
        public static Task<GetExternalClustersResult> InvokeAsync(GetExternalClustersArgs args, InvokeOptions? opts = null)
        public static Output<GetExternalClustersResult> Invoke(GetExternalClustersInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetExternalClustersResult> getExternalClusters(GetExternalClustersArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:DatabaseManagement/getExternalClusters:getExternalClusters
      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.
    ExternalDbSystemId string
    The OCID of the external DB system.
    Filters List<GetExternalClustersFilter>
    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    A filter to only return the resources that match the entire display name.
    ExternalDbSystemId string
    The OCID of the external DB system.
    Filters []GetExternalClustersFilter
    compartmentId String
    The OCID of the compartment.
    displayName String
    A filter to only return the resources that match the entire display name.
    externalDbSystemId String
    The OCID of the external DB system.
    filters List<GetExternalClustersFilter>
    compartmentId string
    The OCID of the compartment.
    displayName string
    A filter to only return the resources that match the entire display name.
    externalDbSystemId string
    The OCID of the external DB system.
    filters GetExternalClustersFilter[]
    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_db_system_id str
    The OCID of the external DB system.
    filters GetExternalClustersFilter]
    compartmentId String
    The OCID of the compartment.
    displayName String
    A filter to only return the resources that match the entire display name.
    externalDbSystemId String
    The OCID of the external DB system.
    filters List<Property Map>

    getExternalClusters Result

    The following output properties are available:

    ExternalClusterCollections List<GetExternalClustersExternalClusterCollection>
    The list of external_cluster_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 external cluster. The name does not have to be unique.
    ExternalDbSystemId string
    The OCID of the external DB system that the cluster is a part of.
    Filters List<GetExternalClustersFilter>
    ExternalClusterCollections []GetExternalClustersExternalClusterCollection
    The list of external_cluster_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 external cluster. The name does not have to be unique.
    ExternalDbSystemId string
    The OCID of the external DB system that the cluster is a part of.
    Filters []GetExternalClustersFilter
    externalClusterCollections List<GetExternalClustersExternalClusterCollection>
    The list of external_cluster_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 external cluster. The name does not have to be unique.
    externalDbSystemId String
    The OCID of the external DB system that the cluster is a part of.
    filters List<GetExternalClustersFilter>
    externalClusterCollections GetExternalClustersExternalClusterCollection[]
    The list of external_cluster_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 external cluster. The name does not have to be unique.
    externalDbSystemId string
    The OCID of the external DB system that the cluster is a part of.
    filters GetExternalClustersFilter[]
    external_cluster_collections GetExternalClustersExternalClusterCollection]
    The list of external_cluster_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 external cluster. The name does not have to be unique.
    external_db_system_id str
    The OCID of the external DB system that the cluster is a part of.
    filters GetExternalClustersFilter]
    externalClusterCollections List<Property Map>
    The list of external_cluster_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 external cluster. The name does not have to be unique.
    externalDbSystemId String
    The OCID of the external DB system that the cluster is a part of.
    filters List<Property Map>

    Supporting Types

    GetExternalClustersExternalClusterCollection

    GetExternalClustersExternalClusterCollectionItem

    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
    A filter to only return the resources that match the entire display name.
    ExternalClusterId string
    ExternalConnectorId string
    The OCID of the external connector.
    ExternalDbSystemId string
    The OCID of the external DB system.
    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<GetExternalClustersExternalClusterCollectionItemNetworkConfiguration>
    The list of network address configurations of the external cluster.
    OcrFileLocation string
    The location of the Oracle Cluster Registry (OCR).
    ScanConfigurations List<GetExternalClustersExternalClusterCollectionItemScanConfiguration>
    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<GetExternalClustersExternalClusterCollectionItemVipConfiguration>
    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
    A filter to only return the resources that match the entire display name.
    ExternalClusterId string
    ExternalConnectorId string
    The OCID of the external connector.
    ExternalDbSystemId string
    The OCID of the external DB system.
    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 []GetExternalClustersExternalClusterCollectionItemNetworkConfiguration
    The list of network address configurations of the external cluster.
    OcrFileLocation string
    The location of the Oracle Cluster Registry (OCR).
    ScanConfigurations []GetExternalClustersExternalClusterCollectionItemScanConfiguration
    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 []GetExternalClustersExternalClusterCollectionItemVipConfiguration
    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
    A filter to only return the resources that match the entire display name.
    externalClusterId String
    externalConnectorId String
    The OCID of the external connector.
    externalDbSystemId String
    The OCID of the external DB system.
    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<GetExternalClustersExternalClusterCollectionItemNetworkConfiguration>
    The list of network address configurations of the external cluster.
    ocrFileLocation String
    The location of the Oracle Cluster Registry (OCR).
    scanConfigurations List<GetExternalClustersExternalClusterCollectionItemScanConfiguration>
    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<GetExternalClustersExternalClusterCollectionItemVipConfiguration>
    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
    A filter to only return the resources that match the entire display name.
    externalClusterId string
    externalConnectorId string
    The OCID of the external connector.
    externalDbSystemId string
    The OCID of the external DB system.
    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 GetExternalClustersExternalClusterCollectionItemNetworkConfiguration[]
    The list of network address configurations of the external cluster.
    ocrFileLocation string
    The location of the Oracle Cluster Registry (OCR).
    scanConfigurations GetExternalClustersExternalClusterCollectionItemScanConfiguration[]
    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 GetExternalClustersExternalClusterCollectionItemVipConfiguration[]
    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
    A filter to only return the resources that match the entire display name.
    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.
    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 GetExternalClustersExternalClusterCollectionItemNetworkConfiguration]
    The list of network address configurations of the external cluster.
    ocr_file_location str
    The location of the Oracle Cluster Registry (OCR).
    scan_configurations GetExternalClustersExternalClusterCollectionItemScanConfiguration]
    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 GetExternalClustersExternalClusterCollectionItemVipConfiguration]
    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
    A filter to only return the resources that match the entire display name.
    externalClusterId String
    externalConnectorId String
    The OCID of the external connector.
    externalDbSystemId String
    The OCID of the external DB system.
    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.

    GetExternalClustersExternalClusterCollectionItemNetworkConfiguration

    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.

    GetExternalClustersExternalClusterCollectionItemScanConfiguration

    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.

    GetExternalClustersExternalClusterCollectionItemVipConfiguration

    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.

    GetExternalClustersFilter

    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.23.0 published on Thursday, Feb 15, 2024 by Pulumi