Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
oci.Database.getExternalDatabaseConnectors
Explore with Pulumi AI
This data source provides the list of External Database Connectors in Oracle Cloud Infrastructure Database service.
Gets a list of the external database connectors in the specified compartment.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testExternalDatabaseConnectors = oci.Database.getExternalDatabaseConnectors({
    compartmentId: compartmentId,
    externalDatabaseId: testDatabase.id,
    displayName: externalDatabaseConnectorDisplayName,
    state: externalDatabaseConnectorState,
});
import pulumi
import pulumi_oci as oci
test_external_database_connectors = oci.Database.get_external_database_connectors(compartment_id=compartment_id,
    external_database_id=test_database["id"],
    display_name=external_database_connector_display_name,
    state=external_database_connector_state)
package main
import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/database"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := database.GetExternalDatabaseConnectors(ctx, &database.GetExternalDatabaseConnectorsArgs{
			CompartmentId:      compartmentId,
			ExternalDatabaseId: testDatabase.Id,
			DisplayName:        pulumi.StringRef(externalDatabaseConnectorDisplayName),
			State:              pulumi.StringRef(externalDatabaseConnectorState),
		}, 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 testExternalDatabaseConnectors = Oci.Database.GetExternalDatabaseConnectors.Invoke(new()
    {
        CompartmentId = compartmentId,
        ExternalDatabaseId = testDatabase.Id,
        DisplayName = externalDatabaseConnectorDisplayName,
        State = externalDatabaseConnectorState,
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Database.DatabaseFunctions;
import com.pulumi.oci.Database.inputs.GetExternalDatabaseConnectorsArgs;
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 testExternalDatabaseConnectors = DatabaseFunctions.getExternalDatabaseConnectors(GetExternalDatabaseConnectorsArgs.builder()
            .compartmentId(compartmentId)
            .externalDatabaseId(testDatabase.id())
            .displayName(externalDatabaseConnectorDisplayName)
            .state(externalDatabaseConnectorState)
            .build());
    }
}
variables:
  testExternalDatabaseConnectors:
    fn::invoke:
      function: oci:Database:getExternalDatabaseConnectors
      arguments:
        compartmentId: ${compartmentId}
        externalDatabaseId: ${testDatabase.id}
        displayName: ${externalDatabaseConnectorDisplayName}
        state: ${externalDatabaseConnectorState}
Using getExternalDatabaseConnectors
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 getExternalDatabaseConnectors(args: GetExternalDatabaseConnectorsArgs, opts?: InvokeOptions): Promise<GetExternalDatabaseConnectorsResult>
function getExternalDatabaseConnectorsOutput(args: GetExternalDatabaseConnectorsOutputArgs, opts?: InvokeOptions): Output<GetExternalDatabaseConnectorsResult>def get_external_database_connectors(compartment_id: Optional[str] = None,
                                     display_name: Optional[str] = None,
                                     external_database_id: Optional[str] = None,
                                     filters: Optional[Sequence[GetExternalDatabaseConnectorsFilter]] = None,
                                     state: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetExternalDatabaseConnectorsResult
def get_external_database_connectors_output(compartment_id: Optional[pulumi.Input[str]] = None,
                                     display_name: Optional[pulumi.Input[str]] = None,
                                     external_database_id: Optional[pulumi.Input[str]] = None,
                                     filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetExternalDatabaseConnectorsFilterArgs]]]] = None,
                                     state: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetExternalDatabaseConnectorsResult]func GetExternalDatabaseConnectors(ctx *Context, args *GetExternalDatabaseConnectorsArgs, opts ...InvokeOption) (*GetExternalDatabaseConnectorsResult, error)
func GetExternalDatabaseConnectorsOutput(ctx *Context, args *GetExternalDatabaseConnectorsOutputArgs, opts ...InvokeOption) GetExternalDatabaseConnectorsResultOutput> Note: This function is named GetExternalDatabaseConnectors in the Go SDK.
public static class GetExternalDatabaseConnectors 
{
    public static Task<GetExternalDatabaseConnectorsResult> InvokeAsync(GetExternalDatabaseConnectorsArgs args, InvokeOptions? opts = null)
    public static Output<GetExternalDatabaseConnectorsResult> Invoke(GetExternalDatabaseConnectorsInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetExternalDatabaseConnectorsResult> getExternalDatabaseConnectors(GetExternalDatabaseConnectorsArgs args, InvokeOptions options)
public static Output<GetExternalDatabaseConnectorsResult> getExternalDatabaseConnectors(GetExternalDatabaseConnectorsArgs args, InvokeOptions options)
fn::invoke:
  function: oci:Database/getExternalDatabaseConnectors:getExternalDatabaseConnectors
  arguments:
    # arguments dictionaryThe following arguments are supported:
- CompartmentId string
- The compartment OCID.
- ExternalDatabase stringId 
- The OCID of the external database whose connectors will be listed.
- DisplayName string
- A filter to return only resources that match the entire display name given. The match is not case sensitive.
- Filters
List<GetExternal Database Connectors Filter> 
- State string
- A filter to return only resources that match the specified lifecycle state.
- CompartmentId string
- The compartment OCID.
- ExternalDatabase stringId 
- The OCID of the external database whose connectors will be listed.
- DisplayName string
- A filter to return only resources that match the entire display name given. The match is not case sensitive.
- Filters
[]GetExternal Database Connectors Filter 
- State string
- A filter to return only resources that match the specified lifecycle state.
- compartmentId String
- The compartment OCID.
- externalDatabase StringId 
- The OCID of the external database whose connectors will be listed.
- displayName String
- A filter to return only resources that match the entire display name given. The match is not case sensitive.
- filters
List<GetExternal Connectors Filter> 
- state String
- A filter to return only resources that match the specified lifecycle state.
- compartmentId string
- The compartment OCID.
- externalDatabase stringId 
- The OCID of the external database whose connectors will be listed.
- displayName string
- A filter to return only resources that match the entire display name given. The match is not case sensitive.
- filters
GetExternal Database Connectors Filter[] 
- state string
- A filter to return only resources that match the specified lifecycle state.
- compartment_id str
- The compartment OCID.
- external_database_ strid 
- The OCID of the external database whose connectors will be listed.
- display_name str
- A filter to return only resources that match the entire display name given. The match is not case sensitive.
- filters
Sequence[GetExternal Database Connectors Filter] 
- state str
- A filter to return only resources that match the specified lifecycle state.
- compartmentId String
- The compartment OCID.
- externalDatabase StringId 
- The OCID of the external database whose connectors will be listed.
- displayName String
- A filter to return only resources that match the entire display name given. The match is not case sensitive.
- filters List<Property Map>
- state String
- A filter to return only resources that match the specified lifecycle state.
getExternalDatabaseConnectors Result
The following output properties are available:
- CompartmentId string
- The OCID of the compartment.
- ExternalDatabase List<GetConnectors External Database Connectors External Database Connector> 
- The list of external_database_connectors.
- ExternalDatabase stringId 
- The OCID of the external database resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- DisplayName string
- The user-friendly name for the external database connector. The name does not have to be unique.
- Filters
List<GetExternal Database Connectors Filter> 
- State string
- The current lifecycle state of the external database connector resource.
- CompartmentId string
- The OCID of the compartment.
- ExternalDatabase []GetConnectors External Database Connectors External Database Connector 
- The list of external_database_connectors.
- ExternalDatabase stringId 
- The OCID of the external database resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- DisplayName string
- The user-friendly name for the external database connector. The name does not have to be unique.
- Filters
[]GetExternal Database Connectors Filter 
- State string
- The current lifecycle state of the external database connector resource.
- compartmentId String
- The OCID of the compartment.
- externalDatabase List<GetConnectors External Connectors External Connector> 
- The list of external_database_connectors.
- externalDatabase StringId 
- The OCID of the external database resource.
- id String
- The provider-assigned unique ID for this managed resource.
- displayName String
- The user-friendly name for the external database connector. The name does not have to be unique.
- filters
List<GetExternal Connectors Filter> 
- state String
- The current lifecycle state of the external database connector resource.
- compartmentId string
- The OCID of the compartment.
- externalDatabase GetConnectors External Database Connectors External Database Connector[] 
- The list of external_database_connectors.
- externalDatabase stringId 
- The OCID of the external database resource.
- id string
- The provider-assigned unique ID for this managed resource.
- displayName string
- The user-friendly name for the external database connector. The name does not have to be unique.
- filters
GetExternal Database Connectors Filter[] 
- state string
- The current lifecycle state of the external database connector resource.
- compartment_id str
- The OCID of the compartment.
- external_database_ Sequence[Getconnectors External Database Connectors External Database Connector] 
- The list of external_database_connectors.
- external_database_ strid 
- The OCID of the external database resource.
- id str
- The provider-assigned unique ID for this managed resource.
- display_name str
- The user-friendly name for the external database connector. The name does not have to be unique.
- filters
Sequence[GetExternal Database Connectors Filter] 
- state str
- The current lifecycle state of the external database connector resource.
- compartmentId String
- The OCID of the compartment.
- externalDatabase List<Property Map>Connectors 
- The list of external_database_connectors.
- externalDatabase StringId 
- The OCID of the external database resource.
- id String
- The provider-assigned unique ID for this managed resource.
- displayName String
- The user-friendly name for the external database connector. The name does not have to be unique.
- filters List<Property Map>
- state String
- The current lifecycle state of the external database connector resource.
Supporting Types
GetExternalDatabaseConnectorsExternalDatabaseConnector      
- CompartmentId string
- The compartment OCID.
- ConnectionCredentials List<GetExternal Database Connectors External Database Connector Connection Credential> 
- Credentials used to connect to the database. Currently only the DETAILStype is supported for creating MACS connector crendentials.
- ConnectionStatus string
- The status of connectivity to the external database.
- ConnectionStrings List<GetExternal Database Connectors External Database Connector Connection String> 
- The Oracle Database connection string.
- ConnectorAgent stringId 
- The ID of the agent used for the external database connector.
- ConnectorType string
- The type of connector used by the external database resource.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- DisplayName string
- A filter to return only resources that match the entire display name given. The match is not case sensitive.
- ExternalDatabase stringId 
- The OCID of the external database whose connectors will be listed.
- 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"}
- Id string
- The OCID of the external database connector.
- LifecycleDetails string
- Additional information about the current lifecycle state.
- State string
- A filter to return only resources that match the specified lifecycle state.
- TimeConnection stringStatus Last Updated 
- The date and time the connectionStatusof this external connector was last updated.
- TimeCreated string
- The date and time the external connector was created.
- CompartmentId string
- The compartment OCID.
- ConnectionCredentials []GetExternal Database Connectors External Database Connector Connection Credential 
- Credentials used to connect to the database. Currently only the DETAILStype is supported for creating MACS connector crendentials.
- ConnectionStatus string
- The status of connectivity to the external database.
- ConnectionStrings []GetExternal Database Connectors External Database Connector Connection String 
- The Oracle Database connection string.
- ConnectorAgent stringId 
- The ID of the agent used for the external database connector.
- ConnectorType string
- The type of connector used by the external database resource.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- DisplayName string
- A filter to return only resources that match the entire display name given. The match is not case sensitive.
- ExternalDatabase stringId 
- The OCID of the external database whose connectors will be listed.
- 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"}
- Id string
- The OCID of the external database connector.
- LifecycleDetails string
- Additional information about the current lifecycle state.
- State string
- A filter to return only resources that match the specified lifecycle state.
- TimeConnection stringStatus Last Updated 
- The date and time the connectionStatusof this external connector was last updated.
- TimeCreated string
- The date and time the external connector was created.
- compartmentId String
- The compartment OCID.
- connectionCredentials List<GetExternal Connectors External Connector Connection Credential> 
- Credentials used to connect to the database. Currently only the DETAILStype is supported for creating MACS connector crendentials.
- connectionStatus String
- The status of connectivity to the external database.
- connectionStrings List<GetExternal Connectors External Connector Connection String> 
- The Oracle Database connection string.
- connectorAgent StringId 
- The ID of the agent used for the external database connector.
- connectorType String
- The type of connector used by the external database resource.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- displayName String
- A filter to return only resources that match the entire display name given. The match is not case sensitive.
- externalDatabase StringId 
- The OCID of the external database whose connectors will be listed.
- 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"}
- id String
- The OCID of the external database connector.
- lifecycleDetails String
- Additional information about the current lifecycle state.
- state String
- A filter to return only resources that match the specified lifecycle state.
- timeConnection StringStatus Last Updated 
- The date and time the connectionStatusof this external connector was last updated.
- timeCreated String
- The date and time the external connector was created.
- compartmentId string
- The compartment OCID.
- connectionCredentials GetExternal Database Connectors External Database Connector Connection Credential[] 
- Credentials used to connect to the database. Currently only the DETAILStype is supported for creating MACS connector crendentials.
- connectionStatus string
- The status of connectivity to the external database.
- connectionStrings GetExternal Database Connectors External Database Connector Connection String[] 
- The Oracle Database connection string.
- connectorAgent stringId 
- The ID of the agent used for the external database connector.
- connectorType string
- The type of connector used by the external database resource.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- displayName string
- A filter to return only resources that match the entire display name given. The match is not case sensitive.
- externalDatabase stringId 
- The OCID of the external database whose connectors will be listed.
- {[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"}
- id string
- The OCID of the external database connector.
- lifecycleDetails string
- Additional information about the current lifecycle state.
- state string
- A filter to return only resources that match the specified lifecycle state.
- timeConnection stringStatus Last Updated 
- The date and time the connectionStatusof this external connector was last updated.
- timeCreated string
- The date and time the external connector was created.
- compartment_id str
- The compartment OCID.
- connection_credentials Sequence[GetExternal Database Connectors External Database Connector Connection Credential] 
- Credentials used to connect to the database. Currently only the DETAILStype is supported for creating MACS connector crendentials.
- connection_status str
- The status of connectivity to the external database.
- connection_strings Sequence[GetExternal Database Connectors External Database Connector Connection String] 
- The Oracle Database connection string.
- connector_agent_ strid 
- The ID of the agent used for the external database connector.
- connector_type str
- The type of connector used by the external database resource.
- Mapping[str, str]
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- display_name str
- A filter to return only resources that match the entire display name given. The match is not case sensitive.
- external_database_ strid 
- The OCID of the external database whose connectors will be listed.
- 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"}
- id str
- The OCID of the external database connector.
- lifecycle_details str
- Additional information about the current lifecycle state.
- state str
- A filter to return only resources that match the specified lifecycle state.
- time_connection_ strstatus_ last_ updated 
- The date and time the connectionStatusof this external connector was last updated.
- time_created str
- The date and time the external connector was created.
- compartmentId String
- The compartment OCID.
- connectionCredentials List<Property Map>
- Credentials used to connect to the database. Currently only the DETAILStype is supported for creating MACS connector crendentials.
- connectionStatus String
- The status of connectivity to the external database.
- connectionStrings List<Property Map>
- The Oracle Database connection string.
- connectorAgent StringId 
- The ID of the agent used for the external database connector.
- connectorType String
- The type of connector used by the external database resource.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- displayName String
- A filter to return only resources that match the entire display name given. The match is not case sensitive.
- externalDatabase StringId 
- The OCID of the external database whose connectors will be listed.
- 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"}
- id String
- The OCID of the external database connector.
- lifecycleDetails String
- Additional information about the current lifecycle state.
- state String
- A filter to return only resources that match the specified lifecycle state.
- timeConnection StringStatus Last Updated 
- The date and time the connectionStatusof this external connector was last updated.
- timeCreated String
- The date and time the external connector was created.
GetExternalDatabaseConnectorsExternalDatabaseConnectorConnectionCredential        
- CredentialName string
- The name of the credential information that used to connect to the database. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. IMPORTANT - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name.
- CredentialType string
- The type of credential used to connect to the database.
- Password string
- The password that will be used to connect to the database.
- Role string
- The role of the user that will be connecting to the database.
- SslSecret stringId 
- The OCID of the Oracle Cloud Infrastructure secret.
- Username string
- The username that will be used to connect to the database.
- CredentialName string
- The name of the credential information that used to connect to the database. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. IMPORTANT - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name.
- CredentialType string
- The type of credential used to connect to the database.
- Password string
- The password that will be used to connect to the database.
- Role string
- The role of the user that will be connecting to the database.
- SslSecret stringId 
- The OCID of the Oracle Cloud Infrastructure secret.
- Username string
- The username that will be used to connect to the database.
- credentialName String
- The name of the credential information that used to connect to the database. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. IMPORTANT - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name.
- credentialType String
- The type of credential used to connect to the database.
- password String
- The password that will be used to connect to the database.
- role String
- The role of the user that will be connecting to the database.
- sslSecret StringId 
- The OCID of the Oracle Cloud Infrastructure secret.
- username String
- The username that will be used to connect to the database.
- credentialName string
- The name of the credential information that used to connect to the database. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. IMPORTANT - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name.
- credentialType string
- The type of credential used to connect to the database.
- password string
- The password that will be used to connect to the database.
- role string
- The role of the user that will be connecting to the database.
- sslSecret stringId 
- The OCID of the Oracle Cloud Infrastructure secret.
- username string
- The username that will be used to connect to the database.
- credential_name str
- The name of the credential information that used to connect to the database. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. IMPORTANT - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name.
- credential_type str
- The type of credential used to connect to the database.
- password str
- The password that will be used to connect to the database.
- role str
- The role of the user that will be connecting to the database.
- ssl_secret_ strid 
- The OCID of the Oracle Cloud Infrastructure secret.
- username str
- The username that will be used to connect to the database.
- credentialName String
- The name of the credential information that used to connect to the database. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. IMPORTANT - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name.
- credentialType String
- The type of credential used to connect to the database.
- password String
- The password that will be used to connect to the database.
- role String
- The role of the user that will be connecting to the database.
- sslSecret StringId 
- The OCID of the Oracle Cloud Infrastructure secret.
- username String
- The username that will be used to connect to the database.
GetExternalDatabaseConnectorsExternalDatabaseConnectorConnectionString        
GetExternalDatabaseConnectorsFilter    
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the ociTerraform Provider.