Oracle Cloud Infrastructure v0.13.0, Mar 28 23

oci.DatabaseManagement.getExternalDbSystemConnector

This data source provides details about a specific External Db System Connector resource in Oracle Cloud Infrastructure Database Management service.

Gets the details for the external connector specified by externalDbSystemConnectorId.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testExternalDbSystemConnector = Oci.DatabaseManagement.GetExternalDbSystemConnector.Invoke(new()
    {
        ExternalDbSystemConnectorId = oci_database_management_external_db_system_connector.Test_external_db_system_connector.Id,
    });

});

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/DatabaseManagement"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DatabaseManagement.GetExternalDbSystemConnector(ctx, &databasemanagement.GetExternalDbSystemConnectorArgs{
			ExternalDbSystemConnectorId: oci_database_management_external_db_system_connector.Test_external_db_system_connector.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DatabaseManagement.DatabaseManagementFunctions;
import com.pulumi.oci.DatabaseManagement.inputs.GetExternalDbSystemConnectorArgs;
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 testExternalDbSystemConnector = DatabaseManagementFunctions.getExternalDbSystemConnector(GetExternalDbSystemConnectorArgs.builder()
            .externalDbSystemConnectorId(oci_database_management_external_db_system_connector.test_external_db_system_connector().id())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_external_db_system_connector = oci.DatabaseManagement.get_external_db_system_connector(external_db_system_connector_id=oci_database_management_external_db_system_connector["test_external_db_system_connector"]["id"])

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

const testExternalDbSystemConnector = oci.DatabaseManagement.getExternalDbSystemConnector({
    externalDbSystemConnectorId: oci_database_management_external_db_system_connector.test_external_db_system_connector.id,
});

variables:
  testExternalDbSystemConnector:
    fn::invoke:
      Function: oci:DatabaseManagement:getExternalDbSystemConnector
      Arguments:
        externalDbSystemConnectorId: ${oci_database_management_external_db_system_connector.test_external_db_system_connector.id}

Using getExternalDbSystemConnector

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 getExternalDbSystemConnector(args: GetExternalDbSystemConnectorArgs, opts?: InvokeOptions): Promise<GetExternalDbSystemConnectorResult>
function getExternalDbSystemConnectorOutput(args: GetExternalDbSystemConnectorOutputArgs, opts?: InvokeOptions): Output<GetExternalDbSystemConnectorResult>

def get_external_db_system_connector(external_db_system_connector_id: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetExternalDbSystemConnectorResult
def get_external_db_system_connector_output(external_db_system_connector_id: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetExternalDbSystemConnectorResult]

func GetExternalDbSystemConnector(ctx *Context, args *GetExternalDbSystemConnectorArgs, opts ...InvokeOption) (*GetExternalDbSystemConnectorResult, error)
func GetExternalDbSystemConnectorOutput(ctx *Context, args *GetExternalDbSystemConnectorOutputArgs, opts ...InvokeOption) GetExternalDbSystemConnectorResultOutput

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

public static class GetExternalDbSystemConnector 
{
    public static Task<GetExternalDbSystemConnectorResult> InvokeAsync(GetExternalDbSystemConnectorArgs args, InvokeOptions? opts = null)
    public static Output<GetExternalDbSystemConnectorResult> Invoke(GetExternalDbSystemConnectorInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetExternalDbSystemConnectorResult> getExternalDbSystemConnector(GetExternalDbSystemConnectorArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:DatabaseManagement/getExternalDbSystemConnector:getExternalDbSystemConnector
  arguments:
    # arguments dictionary

The following arguments are supported:

ExternalDbSystemConnectorId string: The OCID of the external connector.

ExternalDbSystemConnectorId string: The OCID of the external connector.

externalDbSystemConnectorId String: The OCID of the external connector.

externalDbSystemConnectorId string: The OCID of the external connector.

external_db_system_connector_id str: The OCID of the external connector.

externalDbSystemConnectorId String: The OCID of the external connector.

getExternalDbSystemConnector Result

The following output properties are available:

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<GetExternalDbSystemConnectorConnectionInfo>: 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.
DisplayName string: The user-friendly name for the external connector. The name does not have to be unique.
ExternalDbSystemConnectorId string
ExternalDbSystemId string: The OCID of the external DB system that the connector is a part of.
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.
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 []GetExternalDbSystemConnectorConnectionInfo: 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.
DisplayName string: The user-friendly name for the external connector. The name does not have to be unique.
ExternalDbSystemConnectorId string
ExternalDbSystemId string: The OCID of the external DB system that the connector is a part of.
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.
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<GetExternalDbSystemConnectorConnectionInfo>: 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.
displayName String: The user-friendly name for the external connector. The name does not have to be unique.
externalDbSystemConnectorId String
externalDbSystemId String: The OCID of the external DB system that the connector is a part of.
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.
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 GetExternalDbSystemConnectorConnectionInfo[]: 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.
displayName string: The user-friendly name for the external connector. The name does not have to be unique.
externalDbSystemConnectorId string
externalDbSystemId string: The OCID of the external DB system that the connector is a part of.
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.
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 GetExternalDbSystemConnectorConnectionInfo]: 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.
display_name str: The user-friendly name for the external connector. The name does not have to be unique.
external_db_system_connector_id str
external_db_system_id str: The OCID of the external DB system that the connector is a part of.
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.
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.
displayName String: The user-friendly name for the external connector. The name does not have to be unique.
externalDbSystemConnectorId String
externalDbSystemId String: The OCID of the external DB system that the connector is a part of.
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.
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.

Supporting Types

GetExternalDbSystemConnectorConnectionInfo

ComponentType string: The component type.
ConnectionCredentials List<GetExternalDbSystemConnectorConnectionInfoConnectionCredential>: The credentials used to connect to the ASM instance. Currently only the DETAILS type is supported for creating MACS connector credentials.
ConnectionStrings List<GetExternalDbSystemConnectorConnectionInfoConnectionString>: The Oracle Database connection string.

ComponentType string: The component type.
ConnectionCredentials []GetExternalDbSystemConnectorConnectionInfoConnectionCredential: The credentials used to connect to the ASM instance. Currently only the DETAILS type is supported for creating MACS connector credentials.
ConnectionStrings []GetExternalDbSystemConnectorConnectionInfoConnectionString: The Oracle Database connection string.

componentType String: The component type.
connectionCredentials List<GetExternalDbSystemConnectorConnectionInfoConnectionCredential>: The credentials used to connect to the ASM instance. Currently only the DETAILS type is supported for creating MACS connector credentials.
connectionStrings List<GetExternalDbSystemConnectorConnectionInfoConnectionString>: The Oracle Database connection string.

componentType string: The component type.
connectionCredentials GetExternalDbSystemConnectorConnectionInfoConnectionCredential[]: The credentials used to connect to the ASM instance. Currently only the DETAILS type is supported for creating MACS connector credentials.
connectionStrings GetExternalDbSystemConnectorConnectionInfoConnectionString[]: The Oracle Database connection string.

component_type str: The component type.
connection_credentials GetExternalDbSystemConnectorConnectionInfoConnectionCredential]: The credentials used to connect to the ASM instance. Currently only the DETAILS type is supported for creating MACS connector credentials.
connection_strings GetExternalDbSystemConnectorConnectionInfoConnectionString]: The Oracle Database connection string.

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.

GetExternalDbSystemConnectorConnectionInfoConnectionCredential

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 credential used to connect to the ASM instance.
PasswordSecretId string: The OCID of the secret containing the user password.
Role string: The role of the user connecting to the ASM instance.
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 credential used to connect to the ASM instance.
PasswordSecretId string: The OCID of the secret containing the user password.
Role string: The role of the user connecting to the ASM instance.
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 credential used to connect to the ASM instance.
passwordSecretId String: The OCID of the secret containing the user password.
role String: The role of the user connecting to the ASM instance.
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 credential used to connect to the ASM instance.
passwordSecretId string: The OCID of the secret containing the user password.
role string: The role of the user connecting to the ASM instance.
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 credential used to connect to the ASM instance.
password_secret_id str: The OCID of the secret containing the user password.
role str: The role of the user connecting to the ASM instance.
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 credential used to connect to the ASM instance.
passwordSecretId String: The OCID of the secret containing the user password.
role String: The role of the user connecting to the ASM instance.
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.

GetExternalDbSystemConnectorConnectionInfoConnectionString

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.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.