Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
oci.DatabaseManagement.getExternalClusters
Explore with Pulumi AI
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
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testExternalClusters = oci.DatabaseManagement.getExternalClusters({
compartmentId: compartmentId,
displayName: externalClusterDisplayName,
externalDbSystemId: testExternalDbSystem.id,
});
import pulumi
import pulumi_oci as oci
test_external_clusters = oci.DatabaseManagement.get_external_clusters(compartment_id=compartment_id,
display_name=external_cluster_display_name,
external_db_system_id=test_external_db_system["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.GetExternalClusters(ctx, &databasemanagement.GetExternalClustersArgs{
CompartmentId: pulumi.StringRef(compartmentId),
DisplayName: pulumi.StringRef(externalClusterDisplayName),
ExternalDbSystemId: pulumi.StringRef(testExternalDbSystem.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 testExternalClusters = Oci.DatabaseManagement.GetExternalClusters.Invoke(new()
{
CompartmentId = compartmentId,
DisplayName = externalClusterDisplayName,
ExternalDbSystemId = testExternalDbSystem.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.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(compartmentId)
.displayName(externalClusterDisplayName)
.externalDbSystemId(testExternalDbSystem.id())
.build());
}
}
variables:
testExternalClusters:
fn::invoke:
Function: oci:DatabaseManagement:getExternalClusters
Arguments:
compartmentId: ${compartmentId}
displayName: ${externalClusterDisplayName}
externalDbSystemId: ${testExternalDbSystem.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:
- Compartment
Id string - The OCID of the compartment.
- Display
Name string - A filter to only return the resources that match the entire display name.
- External
Db stringSystem Id - The OCID of the external DB system.
- Filters
List<Get
External Clusters Filter>
- Compartment
Id string - The OCID of the compartment.
- Display
Name string - A filter to only return the resources that match the entire display name.
- External
Db stringSystem Id - The OCID of the external DB system.
- Filters
[]Get
External Clusters Filter
- compartment
Id String - The OCID of the compartment.
- display
Name String - A filter to only return the resources that match the entire display name.
- external
Db StringSystem Id - The OCID of the external DB system.
- filters
List<Get
External Clusters Filter>
- compartment
Id string - The OCID of the compartment.
- display
Name string - A filter to only return the resources that match the entire display name.
- external
Db stringSystem Id - The OCID of the external DB system.
- filters
Get
External Clusters Filter[]
- 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_ strsystem_ id - The OCID of the external DB system.
- filters
Sequence[databasemanagement.
Get External Clusters Filter]
- compartment
Id String - The OCID of the compartment.
- display
Name String - A filter to only return the resources that match the entire display name.
- external
Db StringSystem Id - The OCID of the external DB system.
- filters List<Property Map>
getExternalClusters Result
The following output properties are available:
- External
Cluster List<GetCollections External Clusters External Cluster Collection> - The list of external_cluster_collection.
- Id string
- The provider-assigned unique ID for this managed resource.
- Compartment
Id string - The OCID of the compartment.
- Display
Name string - The user-friendly name for the external cluster. The name does not have to be unique.
- External
Db stringSystem Id - The OCID of the external DB system that the cluster is a part of.
- Filters
List<Get
External Clusters Filter>
- External
Cluster []GetCollections External Clusters External Cluster Collection - The list of external_cluster_collection.
- Id string
- The provider-assigned unique ID for this managed resource.
- Compartment
Id string - The OCID of the compartment.
- Display
Name string - The user-friendly name for the external cluster. The name does not have to be unique.
- External
Db stringSystem Id - The OCID of the external DB system that the cluster is a part of.
- Filters
[]Get
External Clusters Filter
- external
Cluster List<GetCollections External Clusters External Cluster Collection> - The list of external_cluster_collection.
- id String
- The provider-assigned unique ID for this managed resource.
- compartment
Id String - The OCID of the compartment.
- display
Name String - The user-friendly name for the external cluster. The name does not have to be unique.
- external
Db StringSystem Id - The OCID of the external DB system that the cluster is a part of.
- filters
List<Get
External Clusters Filter>
- external
Cluster GetCollections External Clusters External Cluster Collection[] - The list of external_cluster_collection.
- id string
- The provider-assigned unique ID for this managed resource.
- compartment
Id string - The OCID of the compartment.
- display
Name string - The user-friendly name for the external cluster. The name does not have to be unique.
- external
Db stringSystem Id - The OCID of the external DB system that the cluster is a part of.
- filters
Get
External Clusters Filter[]
- external_
cluster_ Sequence[databasemanagement.collections Get External Clusters External Cluster Collection] - 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_ strsystem_ id - The OCID of the external DB system that the cluster is a part of.
- filters
Sequence[databasemanagement.
Get External Clusters Filter]
- external
Cluster List<Property Map>Collections - The list of external_cluster_collection.
- id String
- The provider-assigned unique ID for this managed resource.
- compartment
Id String - The OCID of the compartment.
- display
Name String - The user-friendly name for the external cluster. The name does not have to be unique.
- external
Db StringSystem Id - The OCID of the external DB system that the cluster is a part of.
- filters List<Property Map>
Supporting Types
GetExternalClustersExternalClusterCollection
GetExternalClustersExternalClusterCollectionItem
- Additional
Details Dictionary<string, string> - The additional details of the external cluster defined in
{"key": "value"}
format. Example:{"bar-key": "value"}
- Compartment
Id string - The OCID of the compartment.
- Component
Name string - The name of the external cluster.
- 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"}
- Display
Name string - A filter to only return the resources that match the entire display name.
- External
Cluster stringId - External
Connector stringId - The OCID of the external connector.
- External
Db stringSystem Id - The OCID of the external DB system.
- 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"}
- Grid
Home string - The directory in which Oracle Grid Infrastructure is installed.
- Id string
- The OCID of the external cluster.
- Is
Flex boolCluster - Indicates whether the cluster is Oracle Flex Cluster or not.
- Lifecycle
Details string - Additional information about the current lifecycle state.
- Network
Configurations List<GetExternal Clusters External Cluster Collection Item Network Configuration> - The list of network address configurations of the external cluster.
- Ocr
File stringLocation - The location of the Oracle Cluster Registry (OCR).
- Scan
Configurations List<GetExternal Clusters External Cluster Collection Item Scan Configuration> - The list of Single Client Access Name (SCAN) configurations of the external cluster.
- State string
- The current lifecycle state of the external cluster.
- 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"}
- Time
Created string - The date and time the external cluster was created.
- Time
Updated string - The date and time the external cluster was last updated.
- Version string
- The cluster version.
- Vip
Configurations List<GetExternal Clusters External Cluster Collection Item Vip Configuration> - The list of Virtual IP (VIP) configurations of the external cluster.
- Additional
Details map[string]string - The additional details of the external cluster defined in
{"key": "value"}
format. Example:{"bar-key": "value"}
- Compartment
Id string - The OCID of the compartment.
- Component
Name string - The name of the external cluster.
- 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"}
- Display
Name string - A filter to only return the resources that match the entire display name.
- External
Cluster stringId - External
Connector stringId - The OCID of the external connector.
- External
Db stringSystem Id - The OCID of the external DB system.
- 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"}
- Grid
Home string - The directory in which Oracle Grid Infrastructure is installed.
- Id string
- The OCID of the external cluster.
- Is
Flex boolCluster - Indicates whether the cluster is Oracle Flex Cluster or not.
- Lifecycle
Details string - Additional information about the current lifecycle state.
- Network
Configurations []GetExternal Clusters External Cluster Collection Item Network Configuration - The list of network address configurations of the external cluster.
- Ocr
File stringLocation - The location of the Oracle Cluster Registry (OCR).
- Scan
Configurations []GetExternal Clusters External Cluster Collection Item Scan Configuration - The list of Single Client Access Name (SCAN) configurations of the external cluster.
- State string
- The current lifecycle state of the external cluster.
- 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"}
- Time
Created string - The date and time the external cluster was created.
- Time
Updated string - The date and time the external cluster was last updated.
- Version string
- The cluster version.
- Vip
Configurations []GetExternal Clusters External Cluster Collection Item Vip Configuration - The list of Virtual IP (VIP) configurations of the external cluster.
- additional
Details Map<String,String> - The additional details of the external cluster defined in
{"key": "value"}
format. Example:{"bar-key": "value"}
- compartment
Id String - The OCID of the compartment.
- component
Name String - The name of the external cluster.
- 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"}
- display
Name String - A filter to only return the resources that match the entire display name.
- external
Cluster StringId - external
Connector StringId - The OCID of the external connector.
- external
Db StringSystem Id - The OCID of the external DB system.
- 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"}
- grid
Home String - The directory in which Oracle Grid Infrastructure is installed.
- id String
- The OCID of the external cluster.
- is
Flex BooleanCluster - Indicates whether the cluster is Oracle Flex Cluster or not.
- lifecycle
Details String - Additional information about the current lifecycle state.
- network
Configurations List<GetExternal Clusters External Cluster Collection Item Network Configuration> - The list of network address configurations of the external cluster.
- ocr
File StringLocation - The location of the Oracle Cluster Registry (OCR).
- scan
Configurations List<GetExternal Clusters External Cluster Collection Item Scan Configuration> - The list of Single Client Access Name (SCAN) configurations of the external cluster.
- state String
- The current lifecycle state of the external cluster.
- 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"}
- time
Created String - The date and time the external cluster was created.
- time
Updated String - The date and time the external cluster was last updated.
- version String
- The cluster version.
- vip
Configurations List<GetExternal Clusters External Cluster Collection Item Vip Configuration> - The list of Virtual IP (VIP) configurations of the external cluster.
- additional
Details {[key: string]: string} - The additional details of the external cluster defined in
{"key": "value"}
format. Example:{"bar-key": "value"}
- compartment
Id string - The OCID of the compartment.
- component
Name string - The name of the external cluster.
- {[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"}
- display
Name string - A filter to only return the resources that match the entire display name.
- external
Cluster stringId - external
Connector stringId - The OCID of the external connector.
- external
Db stringSystem Id - The OCID of the external DB system.
- {[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"}
- grid
Home string - The directory in which Oracle Grid Infrastructure is installed.
- id string
- The OCID of the external cluster.
- is
Flex booleanCluster - Indicates whether the cluster is Oracle Flex Cluster or not.
- lifecycle
Details string - Additional information about the current lifecycle state.
- network
Configurations GetExternal Clusters External Cluster Collection Item Network Configuration[] - The list of network address configurations of the external cluster.
- ocr
File stringLocation - The location of the Oracle Cluster Registry (OCR).
- scan
Configurations GetExternal Clusters External Cluster Collection Item Scan Configuration[] - The list of Single Client Access Name (SCAN) configurations of the external cluster.
- state string
- The current lifecycle state of the external cluster.
- {[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"}
- time
Created string - The date and time the external cluster was created.
- time
Updated string - The date and time the external cluster was last updated.
- version string
- The cluster version.
- vip
Configurations GetExternal Clusters External Cluster Collection Item Vip Configuration[] - The list of Virtual IP (VIP) configurations of the external cluster.
- additional_
details Mapping[str, str] - 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.
- 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 - A filter to only return the resources that match the entire display name.
- external_
cluster_ strid - external_
connector_ strid - The OCID of the external connector.
- external_
db_ strsystem_ id - The OCID of the external DB system.
- 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"}
- grid_
home str - The directory in which Oracle Grid Infrastructure is installed.
- id str
- The OCID of the external cluster.
- is_
flex_ boolcluster - Indicates whether the cluster is Oracle Flex Cluster or not.
- lifecycle_
details str - Additional information about the current lifecycle state.
- network_
configurations Sequence[databasemanagement.Get External Clusters External Cluster Collection Item Network Configuration] - The list of network address configurations of the external cluster.
- ocr_
file_ strlocation - The location of the Oracle Cluster Registry (OCR).
- scan_
configurations Sequence[databasemanagement.Get External Clusters External Cluster Collection Item Scan Configuration] - The list of Single Client Access Name (SCAN) configurations of the external cluster.
- state str
- The current lifecycle state of the external cluster.
- 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 was created.
- time_
updated str - The date and time the external cluster was last updated.
- version str
- The cluster version.
- vip_
configurations Sequence[databasemanagement.Get External Clusters External Cluster Collection Item Vip Configuration] - The list of Virtual IP (VIP) configurations of the external cluster.
- additional
Details Map<String> - The additional details of the external cluster defined in
{"key": "value"}
format. Example:{"bar-key": "value"}
- compartment
Id String - The OCID of the compartment.
- component
Name String - The name of the external cluster.
- 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"}
- display
Name String - A filter to only return the resources that match the entire display name.
- external
Cluster StringId - external
Connector StringId - The OCID of the external connector.
- external
Db StringSystem Id - The OCID of the external DB system.
- 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"}
- grid
Home String - The directory in which Oracle Grid Infrastructure is installed.
- id String
- The OCID of the external cluster.
- is
Flex BooleanCluster - Indicates whether the cluster is Oracle Flex Cluster or not.
- lifecycle
Details String - Additional information about the current lifecycle state.
- network
Configurations List<Property Map> - The list of network address configurations of the external cluster.
- ocr
File StringLocation - The location of the Oracle Cluster Registry (OCR).
- scan
Configurations 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.
- 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"}
- time
Created String - The date and time the external cluster was created.
- time
Updated String - The date and time the external cluster was last updated.
- version String
- The cluster version.
- vip
Configurations List<Property Map> - The list of Virtual IP (VIP) configurations of the external cluster.
GetExternalClustersExternalClusterCollectionItemNetworkConfiguration
- Network
Number int - The network number from which VIPs are obtained.
- Network
Type string - The network type.
- Subnet string
- The subnet for the network.
- Network
Number int - The network number from which VIPs are obtained.
- Network
Type string - The network type.
- Subnet string
- The subnet for the network.
- network
Number Integer - The network number from which VIPs are obtained.
- network
Type String - The network type.
- subnet String
- The subnet for the network.
- network
Number number - The network number from which VIPs are obtained.
- network
Type 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.
- network
Number Number - The network number from which VIPs are obtained.
- network
Type String - The network type.
- subnet String
- The subnet for the network.
GetExternalClustersExternalClusterCollectionItemScanConfiguration
- Network
Number int - The network number from which VIPs are obtained.
- Scan
Name string - The name of the SCAN listener.
- Scan
Port int - The port number of the SCAN listener.
- Scan
Protocol string - The protocol of the SCAN listener.
- Network
Number int - The network number from which VIPs are obtained.
- Scan
Name string - The name of the SCAN listener.
- Scan
Port int - The port number of the SCAN listener.
- Scan
Protocol string - The protocol of the SCAN listener.
- network
Number Integer - The network number from which VIPs are obtained.
- scan
Name String - The name of the SCAN listener.
- scan
Port Integer - The port number of the SCAN listener.
- scan
Protocol String - The protocol of the SCAN listener.
- network
Number number - The network number from which VIPs are obtained.
- scan
Name string - The name of the SCAN listener.
- scan
Port number - The port number of the SCAN listener.
- scan
Protocol 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.
- network
Number Number - The network number from which VIPs are obtained.
- scan
Name String - The name of the SCAN listener.
- scan
Port Number - The port number of the SCAN listener.
- scan
Protocol String - The protocol of the SCAN listener.
GetExternalClustersExternalClusterCollectionItemVipConfiguration
- Address string
- The VIP name or IP address.
- Network
Number int - The network number from which VIPs are obtained.
- Node
Name string - The name of the node with the VIP.
- Address string
- The VIP name or IP address.
- Network
Number int - The network number from which VIPs are obtained.
- Node
Name string - The name of the node with the VIP.
- address String
- The VIP name or IP address.
- network
Number Integer - The network number from which VIPs are obtained.
- node
Name String - The name of the node with the VIP.
- address string
- The VIP name or IP address.
- network
Number number - The network number from which VIPs are obtained.
- node
Name 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.
- network
Number Number - The network number from which VIPs are obtained.
- node
Name String - The name of the node with the VIP.
GetExternalClustersFilter
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.