Oracle Cloud Infrastructure v2.30.0, Apr 14 25

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

oci.DatabaseManagement.getExternalDbSystemConnectors

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const testExternalDbSystemConnectors = oci.DatabaseManagement.getExternalDbSystemConnectors({
    compartmentId: compartmentId,
    displayName: externalDbSystemConnectorDisplayName,
    externalDbSystemId: testExternalDbSystem.id,
});

import pulumi
import pulumi_oci as oci

test_external_db_system_connectors = oci.DatabaseManagement.get_external_db_system_connectors(compartment_id=compartment_id,
    display_name=external_db_system_connector_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.GetExternalDbSystemConnectors(ctx, &databasemanagement.GetExternalDbSystemConnectorsArgs{
			CompartmentId:      pulumi.StringRef(compartmentId),
			DisplayName:        pulumi.StringRef(externalDbSystemConnectorDisplayName),
			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 testExternalDbSystemConnectors = Oci.DatabaseManagement.GetExternalDbSystemConnectors.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = externalDbSystemConnectorDisplayName,
        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.GetExternalDbSystemConnectorsArgs;
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 testExternalDbSystemConnectors = DatabaseManagementFunctions.getExternalDbSystemConnectors(GetExternalDbSystemConnectorsArgs.builder()
            .compartmentId(compartmentId)
            .displayName(externalDbSystemConnectorDisplayName)
            .externalDbSystemId(testExternalDbSystem.id())
            .build());

    }
}

variables:
  testExternalDbSystemConnectors:
    fn::invoke:
      function: oci:DatabaseManagement:getExternalDbSystemConnectors
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${externalDbSystemConnectorDisplayName}
        externalDbSystemId: ${testExternalDbSystem.id}

Using getExternalDbSystemConnectors

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.

TypeScript
Python
Go
C#
Java
YAML

function getExternalDbSystemConnectors(args: GetExternalDbSystemConnectorsArgs, opts?: InvokeOptions): Promise<GetExternalDbSystemConnectorsResult>
function getExternalDbSystemConnectorsOutput(args: GetExternalDbSystemConnectorsOutputArgs, opts?: InvokeOptions): Output<GetExternalDbSystemConnectorsResult>

def get_external_db_system_connectors(compartment_id: Optional[str] = None,
                                      display_name: Optional[str] = None,
                                      external_db_system_id: Optional[str] = None,
                                      filters: Optional[Sequence[_databasemanagement.GetExternalDbSystemConnectorsFilter]] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetExternalDbSystemConnectorsResult
def get_external_db_system_connectors_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.GetExternalDbSystemConnectorsFilterArgs]]]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetExternalDbSystemConnectorsResult]

func GetExternalDbSystemConnectors(ctx *Context, args *GetExternalDbSystemConnectorsArgs, opts ...InvokeOption) (*GetExternalDbSystemConnectorsResult, error)
func GetExternalDbSystemConnectorsOutput(ctx *Context, args *GetExternalDbSystemConnectorsOutputArgs, opts ...InvokeOption) GetExternalDbSystemConnectorsResultOutput

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

public static class GetExternalDbSystemConnectors 
{
    public static Task<GetExternalDbSystemConnectorsResult> InvokeAsync(GetExternalDbSystemConnectorsArgs args, InvokeOptions? opts = null)
    public static Output<GetExternalDbSystemConnectorsResult> Invoke(GetExternalDbSystemConnectorsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetExternalDbSystemConnectorsResult> getExternalDbSystemConnectors(GetExternalDbSystemConnectorsArgs args, InvokeOptions options)
public static Output<GetExternalDbSystemConnectorsResult> getExternalDbSystemConnectors(GetExternalDbSystemConnectorsArgs args, InvokeOptions options)

fn::invoke:
  function: oci:DatabaseManagement/getExternalDbSystemConnectors:getExternalDbSystemConnectors
  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<GetExternalDbSystemConnectorsFilter>

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 []GetExternalDbSystemConnectorsFilter

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<GetExternalDbSystemConnectorsFilter>

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 GetExternalDbSystemConnectorsFilter[]

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 Sequence[databasemanagement.GetExternalDbSystemConnectorsFilter]

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>

getExternalDbSystemConnectors Result

The following output properties are available:

ExternalDbSystemConnectorCollections List<GetExternalDbSystemConnectorsExternalDbSystemConnectorCollection>: The list of external_db_system_connector_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 connector. The name does not have to be unique.
ExternalDbSystemId string: The OCID of the external DB system that the connector is a part of.
Filters List<GetExternalDbSystemConnectorsFilter>

ExternalDbSystemConnectorCollections []GetExternalDbSystemConnectorsExternalDbSystemConnectorCollection: The list of external_db_system_connector_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 connector. The name does not have to be unique.
ExternalDbSystemId string: The OCID of the external DB system that the connector is a part of.
Filters []GetExternalDbSystemConnectorsFilter

externalDbSystemConnectorCollections List<GetExternalDbSystemConnectorsExternalDbSystemConnectorCollection>: The list of external_db_system_connector_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 connector. The name does not have to be unique.
externalDbSystemId String: The OCID of the external DB system that the connector is a part of.
filters List<GetExternalDbSystemConnectorsFilter>

externalDbSystemConnectorCollections GetExternalDbSystemConnectorsExternalDbSystemConnectorCollection[]: The list of external_db_system_connector_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 connector. The name does not have to be unique.
externalDbSystemId string: The OCID of the external DB system that the connector is a part of.
filters GetExternalDbSystemConnectorsFilter[]

external_db_system_connector_collections Sequence[databasemanagement.GetExternalDbSystemConnectorsExternalDbSystemConnectorCollection]: The list of external_db_system_connector_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 connector. The name does not have to be unique.
external_db_system_id str: The OCID of the external DB system that the connector is a part of.
filters Sequence[databasemanagement.GetExternalDbSystemConnectorsFilter]

externalDbSystemConnectorCollections List<Property Map>: The list of external_db_system_connector_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 connector. The name does not have to be unique.
externalDbSystemId String: The OCID of the external DB system that the connector is a part of.
filters List<Property Map>

Supporting Types

GetExternalDbSystemConnectorsExternalDbSystemConnectorCollection

Items List<GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItem>

Items []GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItem

items List<GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItem>

items GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItem[]

items Sequence[databasemanagement.GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItem]

items List<Property Map>

GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItem

AgentId string: The OCID of the management agent used for the external DB system connector.
CompartmentId string: The OCID of the compartment.
ConnectionFailureMessage string: The error message indicating the reason for connection failure or null if the connection was successful.
ConnectionInfos List<GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfo>: The connection details required to connect to an external DB system component.
ConnectionStatus string: The status of connectivity to the external DB system component.
ConnectorType string: The type of connector.
DefinedTags 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"}
DisplayName string: A filter to only return the resources that match the entire display name.
ExternalDbSystemId string: The OCID of the external DB system.
FreeformTags 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 DB system connector.
LifecycleDetails string: Additional information about the current lifecycle state.
State string: The current lifecycle state of the external DB system connector.
SystemTags 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"}
TimeConnectionStatusLastUpdated string: The date and time the connectionStatus of the external DB system connector was last updated.
TimeCreated string: The date and time the external DB system connector was created.
TimeUpdated string: The date and time the external DB system connector was last updated.

AgentId string: The OCID of the management agent used for the external DB system connector.
CompartmentId string: The OCID of the compartment.
ConnectionFailureMessage string: The error message indicating the reason for connection failure or null if the connection was successful.
ConnectionInfos []GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfo: The connection details required to connect to an external DB system component.
ConnectionStatus string: The status of connectivity to the external DB system component.
ConnectorType string: The type of connector.
DefinedTags 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"}
DisplayName string: A filter to only return the resources that match the entire display name.
ExternalDbSystemId string: The OCID of the external DB system.
FreeformTags 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 DB system connector.
LifecycleDetails string: Additional information about the current lifecycle state.
State string: The current lifecycle state of the external DB system connector.
SystemTags 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"}
TimeConnectionStatusLastUpdated string: The date and time the connectionStatus of the external DB system connector was last updated.
TimeCreated string: The date and time the external DB system connector was created.
TimeUpdated string: The date and time the external DB system connector was last updated.

agentId String: The OCID of the management agent used for the external DB system connector.
compartmentId String: The OCID of the compartment.
connectionFailureMessage String: The error message indicating the reason for connection failure or null if the connection was successful.
connectionInfos List<GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfo>: The connection details required to connect to an external DB system component.
connectionStatus String: The status of connectivity to the external DB system component.
connectorType String: The type of connector.
definedTags 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"}
displayName String: A filter to only return the resources that match the entire display name.
externalDbSystemId String: The OCID of the external DB system.
freeformTags 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 DB system connector.
lifecycleDetails String: Additional information about the current lifecycle state.
state String: The current lifecycle state of the external DB system connector.
systemTags 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"}
timeConnectionStatusLastUpdated String: The date and time the connectionStatus of the external DB system connector was last updated.
timeCreated String: The date and time the external DB system connector was created.
timeUpdated String: The date and time the external DB system connector was last updated.

agentId string: The OCID of the management agent used for the external DB system connector.
compartmentId string: The OCID of the compartment.
connectionFailureMessage string: The error message indicating the reason for connection failure or null if the connection was successful.
connectionInfos GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfo[]: The connection details required to connect to an external DB system component.
connectionStatus string: The status of connectivity to the external DB system component.
connectorType string: The type of connector.
definedTags {[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"}
displayName string: A filter to only return the resources that match the entire display name.
externalDbSystemId string: The OCID of the external DB system.
freeformTags {[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 DB system connector.
lifecycleDetails string: Additional information about the current lifecycle state.
state string: The current lifecycle state of the external DB system connector.
systemTags {[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"}
timeConnectionStatusLastUpdated string: The date and time the connectionStatus of the external DB system connector was last updated.
timeCreated string: The date and time the external DB system connector was created.
timeUpdated string: The date and time the external DB system connector was last updated.

agent_id str: The OCID of the management agent used for the external DB system connector.
compartment_id str: The OCID of the compartment.
connection_failure_message str: The error message indicating the reason for connection failure or null if the connection was successful.
connection_infos Sequence[databasemanagement.GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfo]: The connection details required to connect to an external DB system component.
connection_status str: The status of connectivity to the external DB system component.
connector_type str: The type of connector.
defined_tags 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_db_system_id str: The OCID of the external DB system.
freeform_tags 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 DB system connector.
lifecycle_details str: Additional information about the current lifecycle state.
state str: The current lifecycle state of the external DB system connector.
system_tags 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_connection_status_last_updated str: The date and time the connectionStatus of the external DB system connector was last updated.
time_created str: The date and time the external DB system connector was created.
time_updated str: The date and time the external DB system connector was last updated.

agentId String: The OCID of the management agent used for the external DB system connector.
compartmentId String: The OCID of the compartment.
connectionFailureMessage String: The error message indicating the reason for connection failure or null if the connection was successful.
connectionInfos List<Property Map>: The connection details required to connect to an external DB system component.
connectionStatus String: The status of connectivity to the external DB system component.
connectorType String: The type of connector.
definedTags 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"}
displayName String: A filter to only return the resources that match the entire display name.
externalDbSystemId String: The OCID of the external DB system.
freeformTags 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 DB system connector.
lifecycleDetails String: Additional information about the current lifecycle state.
state String: The current lifecycle state of the external DB system connector.
systemTags 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"}
timeConnectionStatusLastUpdated String: The date and time the connectionStatus of the external DB system connector was last updated.
timeCreated String: The date and time the external DB system connector was created.
timeUpdated String: The date and time the external DB system connector was last updated.

GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfo

ComponentType string: The component type.
ConnectionCredentials List<GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfoConnectionCredential>: The credentials used to connect to the ASM instance. Currently only the DETAILS type is supported for creating MACS connector credentials.
ConnectionStrings List<GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfoConnectionString>: The Oracle Database connection string.
DatabaseCredentials List<GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfoDatabaseCredential>: The credential to connect to the database to perform tablespace administration tasks.

ComponentType string: The component type.
ConnectionCredentials []GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfoConnectionCredential: The credentials used to connect to the ASM instance. Currently only the DETAILS type is supported for creating MACS connector credentials.
ConnectionStrings []GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfoConnectionString: The Oracle Database connection string.
DatabaseCredentials []GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfoDatabaseCredential: The credential to connect to the database to perform tablespace administration tasks.

componentType String: The component type.
connectionCredentials List<GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfoConnectionCredential>: The credentials used to connect to the ASM instance. Currently only the DETAILS type is supported for creating MACS connector credentials.
connectionStrings List<GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfoConnectionString>: The Oracle Database connection string.
databaseCredentials List<GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfoDatabaseCredential>: The credential to connect to the database to perform tablespace administration tasks.

componentType string: The component type.
connectionCredentials GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfoConnectionCredential[]: The credentials used to connect to the ASM instance. Currently only the DETAILS type is supported for creating MACS connector credentials.
connectionStrings GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfoConnectionString[]: The Oracle Database connection string.
databaseCredentials GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfoDatabaseCredential[]: The credential to connect to the database to perform tablespace administration tasks.

component_type str: The component type.
connection_credentials Sequence[databasemanagement.GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfoConnectionCredential]: The credentials used to connect to the ASM instance. Currently only the DETAILS type is supported for creating MACS connector credentials.
connection_strings Sequence[databasemanagement.GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfoConnectionString]: The Oracle Database connection string.
database_credentials Sequence[databasemanagement.GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfoDatabaseCredential]: The credential to connect to the database to perform tablespace administration tasks.

componentType String: The component type.
connectionCredentials List<Property Map>: The credentials used to connect to the ASM instance. Currently only the DETAILS type is supported for creating MACS connector credentials.
connectionStrings List<Property Map>: The Oracle Database connection string.
databaseCredentials List<Property Map>: The credential to connect to the database to perform tablespace administration tasks.

GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfoConnectionCredential

CredentialName string: The name of the credential information that used to connect to the DB system resource. 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 the credential for tablespace administration tasks.
NamedCredentialId string: The OCID of the named credential where the database password metadata is stored.
PasswordSecretId string: The OCID of the Secret where the database password is stored.
Role string: The role of the database user.
SslSecretId string: The OCID of the secret containing the SSL keystore and truststore details.
UserName string: The user name used to connect to the ASM instance.

CredentialName string: The name of the credential information that used to connect to the DB system resource. 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 the credential for tablespace administration tasks.
NamedCredentialId string: The OCID of the named credential where the database password metadata is stored.
PasswordSecretId string: The OCID of the Secret where the database password is stored.
Role string: The role of the database user.
SslSecretId string: The OCID of the secret containing the SSL keystore and truststore details.
UserName string: The user name used to connect to the ASM instance.

credentialName String: The name of the credential information that used to connect to the DB system resource. 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 the credential for tablespace administration tasks.
namedCredentialId String: The OCID of the named credential where the database password metadata is stored.
passwordSecretId String: The OCID of the Secret where the database password is stored.
role String: The role of the database user.
sslSecretId String: The OCID of the secret containing the SSL keystore and truststore details.
userName String: The user name used to connect to the ASM instance.

credentialName string: The name of the credential information that used to connect to the DB system resource. 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 the credential for tablespace administration tasks.
namedCredentialId string: The OCID of the named credential where the database password metadata is stored.
passwordSecretId string: The OCID of the Secret where the database password is stored.
role string: The role of the database user.
sslSecretId string: The OCID of the secret containing the SSL keystore and truststore details.
userName string: The user name used to connect to the ASM instance.

credential_name str: The name of the credential information that used to connect to the DB system resource. 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 the credential for tablespace administration tasks.
named_credential_id str: The OCID of the named credential where the database password metadata is stored.
password_secret_id str: The OCID of the Secret where the database password is stored.
role str: The role of the database user.
ssl_secret_id str: The OCID of the secret containing the SSL keystore and truststore details.
user_name str: The user name used to connect to the ASM instance.

credentialName String: The name of the credential information that used to connect to the DB system resource. 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 the credential for tablespace administration tasks.
namedCredentialId String: The OCID of the named credential where the database password metadata is stored.
passwordSecretId String: The OCID of the Secret where the database password is stored.
role String: The role of the database user.
sslSecretId String: The OCID of the secret containing the SSL keystore and truststore details.
userName String: The user name used to connect to the ASM instance.

GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfoConnectionString

HostName string: The host name of the database or the SCAN name in case of a RAC database.
Hosts List<string>: The list of host names of the ASM instances.
Port int: The port used to connect to the ASM instance.
Protocol string: The protocol used to connect to the ASM instance.
Service string: The service name of the ASM instance.

HostName string: The host name of the database or the SCAN name in case of a RAC database.
Hosts []string: The list of host names of the ASM instances.
Port int: The port used to connect to the ASM instance.
Protocol string: The protocol used to connect to the ASM instance.
Service string: The service name of the ASM instance.

hostName String: The host name of the database or the SCAN name in case of a RAC database.
hosts List<String>: The list of host names of the ASM instances.
port Integer: The port used to connect to the ASM instance.
protocol String: The protocol used to connect to the ASM instance.
service String: The service name of the ASM instance.

hostName string: The host name of the database or the SCAN name in case of a RAC database.
hosts string[]: The list of host names of the ASM instances.
port number: The port used to connect to the ASM instance.
protocol string: The protocol used to connect to the ASM instance.
service string: The service name of the ASM instance.

host_name str: The host name of the database or the SCAN name in case of a RAC database.
hosts Sequence[str]: The list of host names of the ASM instances.
port int: The port used to connect to the ASM instance.
protocol str: The protocol used to connect to the ASM instance.
service str: The service name of the ASM instance.

hostName String: The host name of the database or the SCAN name in case of a RAC database.
hosts List<String>: The list of host names of the ASM instances.
port Number: The port used to connect to the ASM instance.
protocol String: The protocol used to connect to the ASM instance.
service String: The service name of the ASM instance.

GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfoDatabaseCredential

CredentialType string: The type of the credential for tablespace administration tasks.
NamedCredentialId string: The OCID of the named credential where the database password metadata is stored.
Password string: The database user's password encoded using BASE64 scheme.
PasswordSecretId string: The OCID of the Secret where the database password is stored.
Role string: The role of the database user.
Username string: The user to connect to the database.

CredentialType string: The type of the credential for tablespace administration tasks.
NamedCredentialId string: The OCID of the named credential where the database password metadata is stored.
Password string: The database user's password encoded using BASE64 scheme.
PasswordSecretId string: The OCID of the Secret where the database password is stored.
Role string: The role of the database user.
Username string: The user to connect to the database.

credentialType String: The type of the credential for tablespace administration tasks.
namedCredentialId String: The OCID of the named credential where the database password metadata is stored.
password String: The database user's password encoded using BASE64 scheme.
passwordSecretId String: The OCID of the Secret where the database password is stored.
role String: The role of the database user.
username String: The user to connect to the database.

credentialType string: The type of the credential for tablespace administration tasks.
namedCredentialId string: The OCID of the named credential where the database password metadata is stored.
password string: The database user's password encoded using BASE64 scheme.
passwordSecretId string: The OCID of the Secret where the database password is stored.
role string: The role of the database user.
username string: The user to connect to the database.

credential_type str: The type of the credential for tablespace administration tasks.
named_credential_id str: The OCID of the named credential where the database password metadata is stored.
password str: The database user's password encoded using BASE64 scheme.
password_secret_id str: The OCID of the Secret where the database password is stored.
role str: The role of the database user.
username str: The user to connect to the database.

credentialType String: The type of the credential for tablespace administration tasks.
namedCredentialId String: The OCID of the named credential where the database password metadata is stored.
password String: The database user's password encoded using BASE64 scheme.
passwordSecretId String: The OCID of the Secret where the database password is stored.
role String: The role of the database user.
username String: The user to connect to the database.

GetExternalDbSystemConnectorsFilter

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.

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

pulumi/pulumi-oci

oci.DatabaseManagement.getExternalDbSystemConnectors

On this page

On this page

Example Usage

Using getExternalDbSystemConnectors

getExternalDbSystemConnectors Result

Supporting Types

GetExternalDbSystemConnectorsExternalDbSystemConnectorCollection

GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItem

GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfo

GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfoConnectionCredential

GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfoConnectionString

GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfoDatabaseCredential

GetExternalDbSystemConnectorsFilter

Package Details

On this page

On this page