Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Database
  5. ExternalDatabaseConnector
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

oci.Database.ExternalDatabaseConnector

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

This resource provides the External Database Connector resource in Oracle Cloud Infrastructure Database service.

Creates a new external database connector.

Example Usage

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

const testExternalDatabaseConnector = new oci.database.ExternalDatabaseConnector("test_external_database_connector", {
    connectionCredentials: {
        credentialName: externalDatabaseConnectorConnectionCredentialsCredentialName,
        credentialType: externalDatabaseConnectorConnectionCredentialsCredentialType,
        password: externalDatabaseConnectorConnectionCredentialsPassword,
        role: externalDatabaseConnectorConnectionCredentialsRole,
        sslSecretId: testSecret.id,
        username: externalDatabaseConnectorConnectionCredentialsUsername,
    },
    connectionString: {
        hostname: externalDatabaseConnectorConnectionStringHostname,
        port: externalDatabaseConnectorConnectionStringPort,
        protocol: externalDatabaseConnectorConnectionStringProtocol,
        service: externalDatabaseConnectorConnectionStringService,
    },
    connectorAgentId: testConnectorAgent.id,
    displayName: externalDatabaseConnectorDisplayName,
    externalDatabaseId: testDatabase.id,
    connectorType: externalDatabaseConnectorConnectorType,
    definedTags: externalDatabaseConnectorDefinedTags,
    freeformTags: {
        Department: "Finance",
    },
});
Copy
import pulumi
import pulumi_oci as oci

test_external_database_connector = oci.database.ExternalDatabaseConnector("test_external_database_connector",
    connection_credentials={
        "credential_name": external_database_connector_connection_credentials_credential_name,
        "credential_type": external_database_connector_connection_credentials_credential_type,
        "password": external_database_connector_connection_credentials_password,
        "role": external_database_connector_connection_credentials_role,
        "ssl_secret_id": test_secret["id"],
        "username": external_database_connector_connection_credentials_username,
    },
    connection_string={
        "hostname": external_database_connector_connection_string_hostname,
        "port": external_database_connector_connection_string_port,
        "protocol": external_database_connector_connection_string_protocol,
        "service": external_database_connector_connection_string_service,
    },
    connector_agent_id=test_connector_agent["id"],
    display_name=external_database_connector_display_name,
    external_database_id=test_database["id"],
    connector_type=external_database_connector_connector_type,
    defined_tags=external_database_connector_defined_tags,
    freeform_tags={
        "Department": "Finance",
    })
Copy
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.NewExternalDatabaseConnector(ctx, "test_external_database_connector", &database.ExternalDatabaseConnectorArgs{
			ConnectionCredentials: &database.ExternalDatabaseConnectorConnectionCredentialsArgs{
				CredentialName: pulumi.Any(externalDatabaseConnectorConnectionCredentialsCredentialName),
				CredentialType: pulumi.Any(externalDatabaseConnectorConnectionCredentialsCredentialType),
				Password:       pulumi.Any(externalDatabaseConnectorConnectionCredentialsPassword),
				Role:           pulumi.Any(externalDatabaseConnectorConnectionCredentialsRole),
				SslSecretId:    pulumi.Any(testSecret.Id),
				Username:       pulumi.Any(externalDatabaseConnectorConnectionCredentialsUsername),
			},
			ConnectionString: &database.ExternalDatabaseConnectorConnectionStringArgs{
				Hostname: pulumi.Any(externalDatabaseConnectorConnectionStringHostname),
				Port:     pulumi.Any(externalDatabaseConnectorConnectionStringPort),
				Protocol: pulumi.Any(externalDatabaseConnectorConnectionStringProtocol),
				Service:  pulumi.Any(externalDatabaseConnectorConnectionStringService),
			},
			ConnectorAgentId:   pulumi.Any(testConnectorAgent.Id),
			DisplayName:        pulumi.Any(externalDatabaseConnectorDisplayName),
			ExternalDatabaseId: pulumi.Any(testDatabase.Id),
			ConnectorType:      pulumi.Any(externalDatabaseConnectorConnectorType),
			DefinedTags:        pulumi.Any(externalDatabaseConnectorDefinedTags),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testExternalDatabaseConnector = new Oci.Database.ExternalDatabaseConnector("test_external_database_connector", new()
    {
        ConnectionCredentials = new Oci.Database.Inputs.ExternalDatabaseConnectorConnectionCredentialsArgs
        {
            CredentialName = externalDatabaseConnectorConnectionCredentialsCredentialName,
            CredentialType = externalDatabaseConnectorConnectionCredentialsCredentialType,
            Password = externalDatabaseConnectorConnectionCredentialsPassword,
            Role = externalDatabaseConnectorConnectionCredentialsRole,
            SslSecretId = testSecret.Id,
            Username = externalDatabaseConnectorConnectionCredentialsUsername,
        },
        ConnectionString = new Oci.Database.Inputs.ExternalDatabaseConnectorConnectionStringArgs
        {
            Hostname = externalDatabaseConnectorConnectionStringHostname,
            Port = externalDatabaseConnectorConnectionStringPort,
            Protocol = externalDatabaseConnectorConnectionStringProtocol,
            Service = externalDatabaseConnectorConnectionStringService,
        },
        ConnectorAgentId = testConnectorAgent.Id,
        DisplayName = externalDatabaseConnectorDisplayName,
        ExternalDatabaseId = testDatabase.Id,
        ConnectorType = externalDatabaseConnectorConnectorType,
        DefinedTags = externalDatabaseConnectorDefinedTags,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Database.ExternalDatabaseConnector;
import com.pulumi.oci.Database.ExternalDatabaseConnectorArgs;
import com.pulumi.oci.Database.inputs.ExternalDatabaseConnectorConnectionCredentialsArgs;
import com.pulumi.oci.Database.inputs.ExternalDatabaseConnectorConnectionStringArgs;
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) {
        var testExternalDatabaseConnector = new ExternalDatabaseConnector("testExternalDatabaseConnector", ExternalDatabaseConnectorArgs.builder()
            .connectionCredentials(ExternalDatabaseConnectorConnectionCredentialsArgs.builder()
                .credentialName(externalDatabaseConnectorConnectionCredentialsCredentialName)
                .credentialType(externalDatabaseConnectorConnectionCredentialsCredentialType)
                .password(externalDatabaseConnectorConnectionCredentialsPassword)
                .role(externalDatabaseConnectorConnectionCredentialsRole)
                .sslSecretId(testSecret.id())
                .username(externalDatabaseConnectorConnectionCredentialsUsername)
                .build())
            .connectionString(ExternalDatabaseConnectorConnectionStringArgs.builder()
                .hostname(externalDatabaseConnectorConnectionStringHostname)
                .port(externalDatabaseConnectorConnectionStringPort)
                .protocol(externalDatabaseConnectorConnectionStringProtocol)
                .service(externalDatabaseConnectorConnectionStringService)
                .build())
            .connectorAgentId(testConnectorAgent.id())
            .displayName(externalDatabaseConnectorDisplayName)
            .externalDatabaseId(testDatabase.id())
            .connectorType(externalDatabaseConnectorConnectorType)
            .definedTags(externalDatabaseConnectorDefinedTags)
            .freeformTags(Map.of("Department", "Finance"))
            .build());

    }
}
Copy
resources:
  testExternalDatabaseConnector:
    type: oci:Database:ExternalDatabaseConnector
    name: test_external_database_connector
    properties:
      connectionCredentials:
        credentialName: ${externalDatabaseConnectorConnectionCredentialsCredentialName}
        credentialType: ${externalDatabaseConnectorConnectionCredentialsCredentialType}
        password: ${externalDatabaseConnectorConnectionCredentialsPassword}
        role: ${externalDatabaseConnectorConnectionCredentialsRole}
        sslSecretId: ${testSecret.id}
        username: ${externalDatabaseConnectorConnectionCredentialsUsername}
      connectionString:
        hostname: ${externalDatabaseConnectorConnectionStringHostname}
        port: ${externalDatabaseConnectorConnectionStringPort}
        protocol: ${externalDatabaseConnectorConnectionStringProtocol}
        service: ${externalDatabaseConnectorConnectionStringService}
      connectorAgentId: ${testConnectorAgent.id}
      displayName: ${externalDatabaseConnectorDisplayName}
      externalDatabaseId: ${testDatabase.id}
      connectorType: ${externalDatabaseConnectorConnectorType}
      definedTags: ${externalDatabaseConnectorDefinedTags}
      freeformTags:
        Department: Finance
Copy

Create ExternalDatabaseConnector Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ExternalDatabaseConnector(name: string, args: ExternalDatabaseConnectorArgs, opts?: CustomResourceOptions);
@overload
def ExternalDatabaseConnector(resource_name: str,
                              args: ExternalDatabaseConnectorArgs,
                              opts: Optional[ResourceOptions] = None)

@overload
def ExternalDatabaseConnector(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              connection_credentials: Optional[_database.ExternalDatabaseConnectorConnectionCredentialsArgs] = None,
                              connection_string: Optional[_database.ExternalDatabaseConnectorConnectionStringArgs] = None,
                              connector_agent_id: Optional[str] = None,
                              display_name: Optional[str] = None,
                              external_database_id: Optional[str] = None,
                              connector_type: Optional[str] = None,
                              defined_tags: Optional[Mapping[str, str]] = None,
                              freeform_tags: Optional[Mapping[str, str]] = None)
func NewExternalDatabaseConnector(ctx *Context, name string, args ExternalDatabaseConnectorArgs, opts ...ResourceOption) (*ExternalDatabaseConnector, error)
public ExternalDatabaseConnector(string name, ExternalDatabaseConnectorArgs args, CustomResourceOptions? opts = null)
public ExternalDatabaseConnector(String name, ExternalDatabaseConnectorArgs args)
public ExternalDatabaseConnector(String name, ExternalDatabaseConnectorArgs args, CustomResourceOptions options)

type: oci:Database:ExternalDatabaseConnector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ExternalDatabaseConnectorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ExternalDatabaseConnectorArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ExternalDatabaseConnectorArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ExternalDatabaseConnectorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ExternalDatabaseConnectorArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var externalDatabaseConnectorResource = new Oci.Database.ExternalDatabaseConnector("externalDatabaseConnectorResource", new()
{
    ConnectionCredentials = new Oci.Database.Inputs.ExternalDatabaseConnectorConnectionCredentialsArgs
    {
        CredentialName = "string",
        CredentialType = "string",
        Password = "string",
        Role = "string",
        SslSecretId = "string",
        Username = "string",
    },
    ConnectionString = new Oci.Database.Inputs.ExternalDatabaseConnectorConnectionStringArgs
    {
        Hostname = "string",
        Port = 0,
        Protocol = "string",
        Service = "string",
    },
    ConnectorAgentId = "string",
    DisplayName = "string",
    ExternalDatabaseId = "string",
    ConnectorType = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := Database.NewExternalDatabaseConnector(ctx, "externalDatabaseConnectorResource", &Database.ExternalDatabaseConnectorArgs{
	ConnectionCredentials: &database.ExternalDatabaseConnectorConnectionCredentialsArgs{
		CredentialName: pulumi.String("string"),
		CredentialType: pulumi.String("string"),
		Password:       pulumi.String("string"),
		Role:           pulumi.String("string"),
		SslSecretId:    pulumi.String("string"),
		Username:       pulumi.String("string"),
	},
	ConnectionString: &database.ExternalDatabaseConnectorConnectionStringArgs{
		Hostname: pulumi.String("string"),
		Port:     pulumi.Int(0),
		Protocol: pulumi.String("string"),
		Service:  pulumi.String("string"),
	},
	ConnectorAgentId:   pulumi.String("string"),
	DisplayName:        pulumi.String("string"),
	ExternalDatabaseId: pulumi.String("string"),
	ConnectorType:      pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var externalDatabaseConnectorResource = new ExternalDatabaseConnector("externalDatabaseConnectorResource", ExternalDatabaseConnectorArgs.builder()
    .connectionCredentials(ExternalDatabaseConnectorConnectionCredentialsArgs.builder()
        .credentialName("string")
        .credentialType("string")
        .password("string")
        .role("string")
        .sslSecretId("string")
        .username("string")
        .build())
    .connectionString(ExternalDatabaseConnectorConnectionStringArgs.builder()
        .hostname("string")
        .port(0)
        .protocol("string")
        .service("string")
        .build())
    .connectorAgentId("string")
    .displayName("string")
    .externalDatabaseId("string")
    .connectorType("string")
    .definedTags(Map.of("string", "string"))
    .freeformTags(Map.of("string", "string"))
    .build());
Copy
external_database_connector_resource = oci.database.ExternalDatabaseConnector("externalDatabaseConnectorResource",
    connection_credentials={
        "credential_name": "string",
        "credential_type": "string",
        "password": "string",
        "role": "string",
        "ssl_secret_id": "string",
        "username": "string",
    },
    connection_string={
        "hostname": "string",
        "port": 0,
        "protocol": "string",
        "service": "string",
    },
    connector_agent_id="string",
    display_name="string",
    external_database_id="string",
    connector_type="string",
    defined_tags={
        "string": "string",
    },
    freeform_tags={
        "string": "string",
    })
Copy
const externalDatabaseConnectorResource = new oci.database.ExternalDatabaseConnector("externalDatabaseConnectorResource", {
    connectionCredentials: {
        credentialName: "string",
        credentialType: "string",
        password: "string",
        role: "string",
        sslSecretId: "string",
        username: "string",
    },
    connectionString: {
        hostname: "string",
        port: 0,
        protocol: "string",
        service: "string",
    },
    connectorAgentId: "string",
    displayName: "string",
    externalDatabaseId: "string",
    connectorType: "string",
    definedTags: {
        string: "string",
    },
    freeformTags: {
        string: "string",
    },
});
Copy
type: oci:Database:ExternalDatabaseConnector
properties:
    connectionCredentials:
        credentialName: string
        credentialType: string
        password: string
        role: string
        sslSecretId: string
        username: string
    connectionString:
        hostname: string
        port: 0
        protocol: string
        service: string
    connectorAgentId: string
    connectorType: string
    definedTags:
        string: string
    displayName: string
    externalDatabaseId: string
    freeformTags:
        string: string
Copy

ExternalDatabaseConnector Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ExternalDatabaseConnector resource accepts the following input properties:

ConnectionCredentials This property is required. ExternalDatabaseConnectorConnectionCredentials
(Updatable) Credentials used to connect to the database. Currently only the DETAILS type is supported for creating MACS connector crendentials.
ConnectionString This property is required. ExternalDatabaseConnectorConnectionString
(Updatable) The Oracle Database connection string.
ConnectorAgentId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the agent used for the external database connector.
DisplayName This property is required. string
(Updatable) The user-friendly name for the external database connector. The name does not have to be unique.
ExternalDatabaseId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the external database resource.
ConnectorType string
(Updatable) The type of connector used by the external database resource.
DefinedTags Dictionary<string, string>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
FreeformTags Dictionary<string, string>

(Updatable) 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"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

ConnectionCredentials This property is required. ExternalDatabaseConnectorConnectionCredentialsArgs
(Updatable) Credentials used to connect to the database. Currently only the DETAILS type is supported for creating MACS connector crendentials.
ConnectionString This property is required. ExternalDatabaseConnectorConnectionStringArgs
(Updatable) The Oracle Database connection string.
ConnectorAgentId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the agent used for the external database connector.
DisplayName This property is required. string
(Updatable) The user-friendly name for the external database connector. The name does not have to be unique.
ExternalDatabaseId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the external database resource.
ConnectorType string
(Updatable) The type of connector used by the external database resource.
DefinedTags map[string]string
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
FreeformTags map[string]string

(Updatable) 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"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

connectionCredentials This property is required. ExternalConnectorConnectionCredentials
(Updatable) Credentials used to connect to the database. Currently only the DETAILS type is supported for creating MACS connector crendentials.
connectionString This property is required. ExternalConnectorConnectionString
(Updatable) The Oracle Database connection string.
connectorAgentId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the agent used for the external database connector.
displayName This property is required. String
(Updatable) The user-friendly name for the external database connector. The name does not have to be unique.
externalDatabaseId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the external database resource.
connectorType String
(Updatable) The type of connector used by the external database resource.
definedTags Map<String,String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
freeformTags Map<String,String>

(Updatable) 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"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

connectionCredentials This property is required. ExternalDatabaseConnectorConnectionCredentials
(Updatable) Credentials used to connect to the database. Currently only the DETAILS type is supported for creating MACS connector crendentials.
connectionString This property is required. ExternalDatabaseConnectorConnectionString
(Updatable) The Oracle Database connection string.
connectorAgentId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the agent used for the external database connector.
displayName This property is required. string
(Updatable) The user-friendly name for the external database connector. The name does not have to be unique.
externalDatabaseId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the external database resource.
connectorType string
(Updatable) The type of connector used by the external database resource.
definedTags {[key: string]: string}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
freeformTags {[key: string]: string}

(Updatable) 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"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

connection_credentials This property is required. database.ExternalDatabaseConnectorConnectionCredentialsArgs
(Updatable) Credentials used to connect to the database. Currently only the DETAILS type is supported for creating MACS connector crendentials.
connection_string This property is required. database.ExternalDatabaseConnectorConnectionStringArgs
(Updatable) The Oracle Database connection string.
connector_agent_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the agent used for the external database connector.
display_name This property is required. str
(Updatable) The user-friendly name for the external database connector. The name does not have to be unique.
external_database_id
This property is required.
Changes to this property will trigger replacement.
str
The OCID of the external database resource.
connector_type str
(Updatable) The type of connector used by the external database resource.
defined_tags Mapping[str, str]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
freeform_tags Mapping[str, str]

(Updatable) 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"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

connectionCredentials This property is required. Property Map
(Updatable) Credentials used to connect to the database. Currently only the DETAILS type is supported for creating MACS connector crendentials.
connectionString This property is required. Property Map
(Updatable) The Oracle Database connection string.
connectorAgentId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the agent used for the external database connector.
displayName This property is required. String
(Updatable) The user-friendly name for the external database connector. The name does not have to be unique.
externalDatabaseId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the external database resource.
connectorType String
(Updatable) The type of connector used by the external database resource.
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
freeformTags Map<String>

(Updatable) 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"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

Outputs

All input properties are implicitly available as output properties. Additionally, the ExternalDatabaseConnector resource produces the following output properties:

CompartmentId string
The OCID of the compartment.
ConnectionStatus string
The status of connectivity to the external database.
Id string
The provider-assigned unique ID for this managed resource.
LifecycleDetails string
Additional information about the current lifecycle state.
State string
The current lifecycle state of the external database connector resource.
TimeConnectionStatusLastUpdated string
The date and time the connectionStatus of this external connector was last updated.
TimeCreated string
The date and time the external connector was created.
CompartmentId string
The OCID of the compartment.
ConnectionStatus string
The status of connectivity to the external database.
Id string
The provider-assigned unique ID for this managed resource.
LifecycleDetails string
Additional information about the current lifecycle state.
State string
The current lifecycle state of the external database connector resource.
TimeConnectionStatusLastUpdated string
The date and time the connectionStatus of this external connector was last updated.
TimeCreated string
The date and time the external connector was created.
compartmentId String
The OCID of the compartment.
connectionStatus String
The status of connectivity to the external database.
id String
The provider-assigned unique ID for this managed resource.
lifecycleDetails String
Additional information about the current lifecycle state.
state String
The current lifecycle state of the external database connector resource.
timeConnectionStatusLastUpdated String
The date and time the connectionStatus of this external connector was last updated.
timeCreated String
The date and time the external connector was created.
compartmentId string
The OCID of the compartment.
connectionStatus string
The status of connectivity to the external database.
id string
The provider-assigned unique ID for this managed resource.
lifecycleDetails string
Additional information about the current lifecycle state.
state string
The current lifecycle state of the external database connector resource.
timeConnectionStatusLastUpdated string
The date and time the connectionStatus of this external connector was last updated.
timeCreated string
The date and time the external connector was created.
compartment_id str
The OCID of the compartment.
connection_status str
The status of connectivity to the external database.
id str
The provider-assigned unique ID for this managed resource.
lifecycle_details str
Additional information about the current lifecycle state.
state str
The current lifecycle state of the external database connector resource.
time_connection_status_last_updated str
The date and time the connectionStatus of this external connector was last updated.
time_created str
The date and time the external connector was created.
compartmentId String
The OCID of the compartment.
connectionStatus String
The status of connectivity to the external database.
id String
The provider-assigned unique ID for this managed resource.
lifecycleDetails String
Additional information about the current lifecycle state.
state String
The current lifecycle state of the external database connector resource.
timeConnectionStatusLastUpdated String
The date and time the connectionStatus of this external connector was last updated.
timeCreated String
The date and time the external connector was created.

Look up Existing ExternalDatabaseConnector Resource

Get an existing ExternalDatabaseConnector resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ExternalDatabaseConnectorState, opts?: CustomResourceOptions): ExternalDatabaseConnector
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        connection_credentials: Optional[_database.ExternalDatabaseConnectorConnectionCredentialsArgs] = None,
        connection_status: Optional[str] = None,
        connection_string: Optional[_database.ExternalDatabaseConnectorConnectionStringArgs] = None,
        connector_agent_id: Optional[str] = None,
        connector_type: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        external_database_id: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        lifecycle_details: Optional[str] = None,
        state: Optional[str] = None,
        time_connection_status_last_updated: Optional[str] = None,
        time_created: Optional[str] = None) -> ExternalDatabaseConnector
func GetExternalDatabaseConnector(ctx *Context, name string, id IDInput, state *ExternalDatabaseConnectorState, opts ...ResourceOption) (*ExternalDatabaseConnector, error)
public static ExternalDatabaseConnector Get(string name, Input<string> id, ExternalDatabaseConnectorState? state, CustomResourceOptions? opts = null)
public static ExternalDatabaseConnector get(String name, Output<String> id, ExternalDatabaseConnectorState state, CustomResourceOptions options)
resources:  _:    type: oci:Database:ExternalDatabaseConnector    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CompartmentId string
The OCID of the compartment.
ConnectionCredentials ExternalDatabaseConnectorConnectionCredentials
(Updatable) Credentials used to connect to the database. Currently only the DETAILS type is supported for creating MACS connector crendentials.
ConnectionStatus string
The status of connectivity to the external database.
ConnectionString ExternalDatabaseConnectorConnectionString
(Updatable) The Oracle Database connection string.
ConnectorAgentId Changes to this property will trigger replacement. string
The ID of the agent used for the external database connector.
ConnectorType string
(Updatable) The type of connector used by the external database resource.
DefinedTags Dictionary<string, string>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
DisplayName string
(Updatable) The user-friendly name for the external database connector. The name does not have to be unique.
ExternalDatabaseId Changes to this property will trigger replacement. string
The OCID of the external database resource.
FreeformTags Dictionary<string, string>

(Updatable) 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"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

LifecycleDetails string
Additional information about the current lifecycle state.
State string
The current lifecycle state of the external database connector resource.
TimeConnectionStatusLastUpdated string
The date and time the connectionStatus of this external connector was last updated.
TimeCreated string
The date and time the external connector was created.
CompartmentId string
The OCID of the compartment.
ConnectionCredentials ExternalDatabaseConnectorConnectionCredentialsArgs
(Updatable) Credentials used to connect to the database. Currently only the DETAILS type is supported for creating MACS connector crendentials.
ConnectionStatus string
The status of connectivity to the external database.
ConnectionString ExternalDatabaseConnectorConnectionStringArgs
(Updatable) The Oracle Database connection string.
ConnectorAgentId Changes to this property will trigger replacement. string
The ID of the agent used for the external database connector.
ConnectorType string
(Updatable) The type of connector used by the external database resource.
DefinedTags map[string]string
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
DisplayName string
(Updatable) The user-friendly name for the external database connector. The name does not have to be unique.
ExternalDatabaseId Changes to this property will trigger replacement. string
The OCID of the external database resource.
FreeformTags map[string]string

(Updatable) 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"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

LifecycleDetails string
Additional information about the current lifecycle state.
State string
The current lifecycle state of the external database connector resource.
TimeConnectionStatusLastUpdated string
The date and time the connectionStatus of this external connector was last updated.
TimeCreated string
The date and time the external connector was created.
compartmentId String
The OCID of the compartment.
connectionCredentials ExternalConnectorConnectionCredentials
(Updatable) Credentials used to connect to the database. Currently only the DETAILS type is supported for creating MACS connector crendentials.
connectionStatus String
The status of connectivity to the external database.
connectionString ExternalConnectorConnectionString
(Updatable) The Oracle Database connection string.
connectorAgentId Changes to this property will trigger replacement. String
The ID of the agent used for the external database connector.
connectorType String
(Updatable) The type of connector used by the external database resource.
definedTags Map<String,String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
displayName String
(Updatable) The user-friendly name for the external database connector. The name does not have to be unique.
externalDatabaseId Changes to this property will trigger replacement. String
The OCID of the external database resource.
freeformTags Map<String,String>

(Updatable) 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"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

lifecycleDetails String
Additional information about the current lifecycle state.
state String
The current lifecycle state of the external database connector resource.
timeConnectionStatusLastUpdated String
The date and time the connectionStatus of this external connector was last updated.
timeCreated String
The date and time the external connector was created.
compartmentId string
The OCID of the compartment.
connectionCredentials ExternalDatabaseConnectorConnectionCredentials
(Updatable) Credentials used to connect to the database. Currently only the DETAILS type is supported for creating MACS connector crendentials.
connectionStatus string
The status of connectivity to the external database.
connectionString ExternalDatabaseConnectorConnectionString
(Updatable) The Oracle Database connection string.
connectorAgentId Changes to this property will trigger replacement. string
The ID of the agent used for the external database connector.
connectorType string
(Updatable) The type of connector used by the external database resource.
definedTags {[key: string]: string}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
displayName string
(Updatable) The user-friendly name for the external database connector. The name does not have to be unique.
externalDatabaseId Changes to this property will trigger replacement. string
The OCID of the external database resource.
freeformTags {[key: string]: string}

(Updatable) 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"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

lifecycleDetails string
Additional information about the current lifecycle state.
state string
The current lifecycle state of the external database connector resource.
timeConnectionStatusLastUpdated string
The date and time the connectionStatus of this external connector was last updated.
timeCreated string
The date and time the external connector was created.
compartment_id str
The OCID of the compartment.
connection_credentials database.ExternalDatabaseConnectorConnectionCredentialsArgs
(Updatable) Credentials used to connect to the database. Currently only the DETAILS type is supported for creating MACS connector crendentials.
connection_status str
The status of connectivity to the external database.
connection_string database.ExternalDatabaseConnectorConnectionStringArgs
(Updatable) The Oracle Database connection string.
connector_agent_id Changes to this property will trigger replacement. str
The ID of the agent used for the external database connector.
connector_type str
(Updatable) The type of connector used by the external database resource.
defined_tags Mapping[str, str]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
display_name str
(Updatable) The user-friendly name for the external database connector. The name does not have to be unique.
external_database_id Changes to this property will trigger replacement. str
The OCID of the external database resource.
freeform_tags Mapping[str, str]

(Updatable) 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"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

lifecycle_details str
Additional information about the current lifecycle state.
state str
The current lifecycle state of the external database connector resource.
time_connection_status_last_updated str
The date and time the connectionStatus of this external connector was last updated.
time_created str
The date and time the external connector was created.
compartmentId String
The OCID of the compartment.
connectionCredentials Property Map
(Updatable) Credentials used to connect to the database. Currently only the DETAILS type is supported for creating MACS connector crendentials.
connectionStatus String
The status of connectivity to the external database.
connectionString Property Map
(Updatable) The Oracle Database connection string.
connectorAgentId Changes to this property will trigger replacement. String
The ID of the agent used for the external database connector.
connectorType String
(Updatable) The type of connector used by the external database resource.
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
displayName String
(Updatable) The user-friendly name for the external database connector. The name does not have to be unique.
externalDatabaseId Changes to this property will trigger replacement. String
The OCID of the external database resource.
freeformTags Map<String>

(Updatable) 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"}

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

lifecycleDetails String
Additional information about the current lifecycle state.
state String
The current lifecycle state of the external database connector resource.
timeConnectionStatusLastUpdated String
The date and time the connectionStatus of this external connector was last updated.
timeCreated String
The date and time the external connector was created.

Supporting Types

ExternalDatabaseConnectorConnectionCredentials
, ExternalDatabaseConnectorConnectionCredentialsArgs

CredentialName string

(Updatable) 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.

For example: inventorydb.abc112233445566778899

CredentialType string
(Updatable) The type of credential used to connect to the database.
Password string
(Updatable) The password that will be used to connect to the database.
Role string
(Updatable) The role of the user that will be connecting to the database.
SslSecretId string
(Updatable) The OCID of the Oracle Cloud Infrastructure secret.
Username string
(Updatable) The username that will be used to connect to the database.
CredentialName string

(Updatable) 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.

For example: inventorydb.abc112233445566778899

CredentialType string
(Updatable) The type of credential used to connect to the database.
Password string
(Updatable) The password that will be used to connect to the database.
Role string
(Updatable) The role of the user that will be connecting to the database.
SslSecretId string
(Updatable) The OCID of the Oracle Cloud Infrastructure secret.
Username string
(Updatable) The username that will be used to connect to the database.
credentialName String

(Updatable) 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.

For example: inventorydb.abc112233445566778899

credentialType String
(Updatable) The type of credential used to connect to the database.
password String
(Updatable) The password that will be used to connect to the database.
role String
(Updatable) The role of the user that will be connecting to the database.
sslSecretId String
(Updatable) The OCID of the Oracle Cloud Infrastructure secret.
username String
(Updatable) The username that will be used to connect to the database.
credentialName string

(Updatable) 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.

For example: inventorydb.abc112233445566778899

credentialType string
(Updatable) The type of credential used to connect to the database.
password string
(Updatable) The password that will be used to connect to the database.
role string
(Updatable) The role of the user that will be connecting to the database.
sslSecretId string
(Updatable) The OCID of the Oracle Cloud Infrastructure secret.
username string
(Updatable) The username that will be used to connect to the database.
credential_name str

(Updatable) 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.

For example: inventorydb.abc112233445566778899

credential_type str
(Updatable) The type of credential used to connect to the database.
password str
(Updatable) The password that will be used to connect to the database.
role str
(Updatable) The role of the user that will be connecting to the database.
ssl_secret_id str
(Updatable) The OCID of the Oracle Cloud Infrastructure secret.
username str
(Updatable) The username that will be used to connect to the database.
credentialName String

(Updatable) 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.

For example: inventorydb.abc112233445566778899

credentialType String
(Updatable) The type of credential used to connect to the database.
password String
(Updatable) The password that will be used to connect to the database.
role String
(Updatable) The role of the user that will be connecting to the database.
sslSecretId String
(Updatable) The OCID of the Oracle Cloud Infrastructure secret.
username String
(Updatable) The username that will be used to connect to the database.

ExternalDatabaseConnectorConnectionString
, ExternalDatabaseConnectorConnectionStringArgs

Hostname This property is required. string
(Updatable) The host name of the database.
Port This property is required. int
(Updatable) The port used to connect to the database.
Protocol This property is required. string
(Updatable) The protocol used to connect to the database.
Service This property is required. string
(Updatable) The name of the service alias used to connect to the database.
Hostname This property is required. string
(Updatable) The host name of the database.
Port This property is required. int
(Updatable) The port used to connect to the database.
Protocol This property is required. string
(Updatable) The protocol used to connect to the database.
Service This property is required. string
(Updatable) The name of the service alias used to connect to the database.
hostname This property is required. String
(Updatable) The host name of the database.
port This property is required. Integer
(Updatable) The port used to connect to the database.
protocol This property is required. String
(Updatable) The protocol used to connect to the database.
service This property is required. String
(Updatable) The name of the service alias used to connect to the database.
hostname This property is required. string
(Updatable) The host name of the database.
port This property is required. number
(Updatable) The port used to connect to the database.
protocol This property is required. string
(Updatable) The protocol used to connect to the database.
service This property is required. string
(Updatable) The name of the service alias used to connect to the database.
hostname This property is required. str
(Updatable) The host name of the database.
port This property is required. int
(Updatable) The port used to connect to the database.
protocol This property is required. str
(Updatable) The protocol used to connect to the database.
service This property is required. str
(Updatable) The name of the service alias used to connect to the database.
hostname This property is required. String
(Updatable) The host name of the database.
port This property is required. Number
(Updatable) The port used to connect to the database.
protocol This property is required. String
(Updatable) The protocol used to connect to the database.
service This property is required. String
(Updatable) The name of the service alias used to connect to the database.

Import

ExternalDatabaseConnectors can be imported using the id, e.g.

$ pulumi import oci:Database/externalDatabaseConnector:ExternalDatabaseConnector test_external_database_connector "id"
Copy

To learn more about importing existing cloud resources, see Importing resources.

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.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci