Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Database
  5. ExternalPluggableDatabase
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci

oci.Database.ExternalPluggableDatabase

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci

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

Registers a new ExternalPluggableDatabase resource.

Example Usage

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

const testExternalPluggableDatabase = new oci.database.ExternalPluggableDatabase("test_external_pluggable_database", {
    compartmentId: compartmentId,
    displayName: externalPluggableDatabaseDisplayName,
    externalContainerDatabaseId: testExternalContainerDatabase.id,
    definedTags: externalPluggableDatabaseDefinedTags,
    freeformTags: {
        Department: "Finance",
    },
    sourceId: testSource.id,
});
Copy
import pulumi
import pulumi_oci as oci

test_external_pluggable_database = oci.database.ExternalPluggableDatabase("test_external_pluggable_database",
    compartment_id=compartment_id,
    display_name=external_pluggable_database_display_name,
    external_container_database_id=test_external_container_database["id"],
    defined_tags=external_pluggable_database_defined_tags,
    freeform_tags={
        "Department": "Finance",
    },
    source_id=test_source["id"])
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.NewExternalPluggableDatabase(ctx, "test_external_pluggable_database", &database.ExternalPluggableDatabaseArgs{
			CompartmentId:               pulumi.Any(compartmentId),
			DisplayName:                 pulumi.Any(externalPluggableDatabaseDisplayName),
			ExternalContainerDatabaseId: pulumi.Any(testExternalContainerDatabase.Id),
			DefinedTags:                 pulumi.Any(externalPluggableDatabaseDefinedTags),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			SourceId: pulumi.Any(testSource.Id),
		})
		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 testExternalPluggableDatabase = new Oci.Database.ExternalPluggableDatabase("test_external_pluggable_database", new()
    {
        CompartmentId = compartmentId,
        DisplayName = externalPluggableDatabaseDisplayName,
        ExternalContainerDatabaseId = testExternalContainerDatabase.Id,
        DefinedTags = externalPluggableDatabaseDefinedTags,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        SourceId = testSource.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Database.ExternalPluggableDatabase;
import com.pulumi.oci.Database.ExternalPluggableDatabaseArgs;
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 testExternalPluggableDatabase = new ExternalPluggableDatabase("testExternalPluggableDatabase", ExternalPluggableDatabaseArgs.builder()
            .compartmentId(compartmentId)
            .displayName(externalPluggableDatabaseDisplayName)
            .externalContainerDatabaseId(testExternalContainerDatabase.id())
            .definedTags(externalPluggableDatabaseDefinedTags)
            .freeformTags(Map.of("Department", "Finance"))
            .sourceId(testSource.id())
            .build());

    }
}
Copy
resources:
  testExternalPluggableDatabase:
    type: oci:Database:ExternalPluggableDatabase
    name: test_external_pluggable_database
    properties:
      compartmentId: ${compartmentId}
      displayName: ${externalPluggableDatabaseDisplayName}
      externalContainerDatabaseId: ${testExternalContainerDatabase.id}
      definedTags: ${externalPluggableDatabaseDefinedTags}
      freeformTags:
        Department: Finance
      sourceId: ${testSource.id}
Copy

Create ExternalPluggableDatabase Resource

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

Constructor syntax

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

@overload
def ExternalPluggableDatabase(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              compartment_id: Optional[str] = None,
                              display_name: Optional[str] = None,
                              external_container_database_id: Optional[str] = None,
                              defined_tags: Optional[Mapping[str, str]] = None,
                              freeform_tags: Optional[Mapping[str, str]] = None,
                              source_id: Optional[str] = None)
func NewExternalPluggableDatabase(ctx *Context, name string, args ExternalPluggableDatabaseArgs, opts ...ResourceOption) (*ExternalPluggableDatabase, error)
public ExternalPluggableDatabase(string name, ExternalPluggableDatabaseArgs args, CustomResourceOptions? opts = null)
public ExternalPluggableDatabase(String name, ExternalPluggableDatabaseArgs args)
public ExternalPluggableDatabase(String name, ExternalPluggableDatabaseArgs args, CustomResourceOptions options)

type: oci:Database:ExternalPluggableDatabase
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. ExternalPluggableDatabaseArgs
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. ExternalPluggableDatabaseArgs
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. ExternalPluggableDatabaseArgs
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. ExternalPluggableDatabaseArgs
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. ExternalPluggableDatabaseArgs
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 externalPluggableDatabaseResource = new Oci.Database.ExternalPluggableDatabase("externalPluggableDatabaseResource", new()
{
    CompartmentId = "string",
    DisplayName = "string",
    ExternalContainerDatabaseId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
    SourceId = "string",
});
Copy
example, err := Database.NewExternalPluggableDatabase(ctx, "externalPluggableDatabaseResource", &Database.ExternalPluggableDatabaseArgs{
	CompartmentId:               pulumi.String("string"),
	DisplayName:                 pulumi.String("string"),
	ExternalContainerDatabaseId: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	SourceId: pulumi.String("string"),
})
Copy
var externalPluggableDatabaseResource = new ExternalPluggableDatabase("externalPluggableDatabaseResource", ExternalPluggableDatabaseArgs.builder()
    .compartmentId("string")
    .displayName("string")
    .externalContainerDatabaseId("string")
    .definedTags(Map.of("string", "string"))
    .freeformTags(Map.of("string", "string"))
    .sourceId("string")
    .build());
Copy
external_pluggable_database_resource = oci.database.ExternalPluggableDatabase("externalPluggableDatabaseResource",
    compartment_id="string",
    display_name="string",
    external_container_database_id="string",
    defined_tags={
        "string": "string",
    },
    freeform_tags={
        "string": "string",
    },
    source_id="string")
Copy
const externalPluggableDatabaseResource = new oci.database.ExternalPluggableDatabase("externalPluggableDatabaseResource", {
    compartmentId: "string",
    displayName: "string",
    externalContainerDatabaseId: "string",
    definedTags: {
        string: "string",
    },
    freeformTags: {
        string: "string",
    },
    sourceId: "string",
});
Copy
type: oci:Database:ExternalPluggableDatabase
properties:
    compartmentId: string
    definedTags:
        string: string
    displayName: string
    externalContainerDatabaseId: string
    freeformTags:
        string: string
    sourceId: string
Copy

ExternalPluggableDatabase 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 ExternalPluggableDatabase resource accepts the following input properties:

CompartmentId This property is required. string
(Updatable) The OCID of the compartment.
DisplayName This property is required. string
(Updatable) The user-friendly name for the external database. The name does not have to be unique.
ExternalContainerDatabaseId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the external container database that contains the specified external pluggable 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"}
SourceId Changes to this property will trigger replacement. string

The OCID of the the non-container database that was converted to a pluggable database to create this resource.

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

CompartmentId This property is required. string
(Updatable) The OCID of the compartment.
DisplayName This property is required. string
(Updatable) The user-friendly name for the external database. The name does not have to be unique.
ExternalContainerDatabaseId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the external container database that contains the specified external pluggable 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"}
SourceId Changes to this property will trigger replacement. string

The OCID of the the non-container database that was converted to a pluggable database to create this resource.

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

compartmentId This property is required. String
(Updatable) The OCID of the compartment.
displayName This property is required. String
(Updatable) The user-friendly name for the external database. The name does not have to be unique.
externalContainerDatabaseId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the external container database that contains the specified external pluggable 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"}
sourceId Changes to this property will trigger replacement. String

The OCID of the the non-container database that was converted to a pluggable database to create this resource.

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

compartmentId This property is required. string
(Updatable) The OCID of the compartment.
displayName This property is required. string
(Updatable) The user-friendly name for the external database. The name does not have to be unique.
externalContainerDatabaseId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the external container database that contains the specified external pluggable 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"}
sourceId Changes to this property will trigger replacement. string

The OCID of the the non-container database that was converted to a pluggable database to create this resource.

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

compartment_id This property is required. str
(Updatable) The OCID of the compartment.
display_name This property is required. str
(Updatable) The user-friendly name for the external database. The name does not have to be unique.
external_container_database_id
This property is required.
Changes to this property will trigger replacement.
str
The OCID of the external container database that contains the specified external pluggable 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"}
source_id Changes to this property will trigger replacement. str

The OCID of the the non-container database that was converted to a pluggable database to create this resource.

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

compartmentId This property is required. String
(Updatable) The OCID of the compartment.
displayName This property is required. String
(Updatable) The user-friendly name for the external database. The name does not have to be unique.
externalContainerDatabaseId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the external container database that contains the specified external pluggable 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"}
sourceId Changes to this property will trigger replacement. String

The OCID of the the non-container database that was converted to a pluggable database to create this resource.

** 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 ExternalPluggableDatabase resource produces the following output properties:

CharacterSet string
The character set of the external database.
DatabaseConfiguration string
The Oracle Database configuration
DatabaseEdition string
The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
DatabaseManagementConfigs List<ExternalPluggableDatabaseDatabaseManagementConfig>
The configuration of the Database Management service.
DatabaseVersion string
The Oracle Database version.
DbId string
The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud.
DbPacks string
The database packs licensed for the external Oracle Database.
DbUniqueName string
The DB_UNIQUE_NAME of the external database.
Id string
The provider-assigned unique ID for this managed resource.
LifecycleDetails string
Additional information about the current lifecycle state.
NcharacterSet string
The national character of the external database.
OperationsInsightsConfigs List<ExternalPluggableDatabaseOperationsInsightsConfig>
The configuration of Operations Insights for the external database
StackMonitoringConfigs List<ExternalPluggableDatabaseStackMonitoringConfig>
The configuration of Stack Monitoring for the external database.
State string
The current state of the Oracle Cloud Infrastructure external database resource.
TimeCreated string
The date and time the database was created.
TimeZone string
The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered.
CharacterSet string
The character set of the external database.
DatabaseConfiguration string
The Oracle Database configuration
DatabaseEdition string
The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
DatabaseManagementConfigs []ExternalPluggableDatabaseDatabaseManagementConfig
The configuration of the Database Management service.
DatabaseVersion string
The Oracle Database version.
DbId string
The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud.
DbPacks string
The database packs licensed for the external Oracle Database.
DbUniqueName string
The DB_UNIQUE_NAME of the external database.
Id string
The provider-assigned unique ID for this managed resource.
LifecycleDetails string
Additional information about the current lifecycle state.
NcharacterSet string
The national character of the external database.
OperationsInsightsConfigs []ExternalPluggableDatabaseOperationsInsightsConfig
The configuration of Operations Insights for the external database
StackMonitoringConfigs []ExternalPluggableDatabaseStackMonitoringConfig
The configuration of Stack Monitoring for the external database.
State string
The current state of the Oracle Cloud Infrastructure external database resource.
TimeCreated string
The date and time the database was created.
TimeZone string
The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered.
characterSet String
The character set of the external database.
databaseConfiguration String
The Oracle Database configuration
databaseEdition String
The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
databaseManagementConfigs List<ExternalPluggableManagementConfig>
The configuration of the Database Management service.
databaseVersion String
The Oracle Database version.
dbId String
The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud.
dbPacks String
The database packs licensed for the external Oracle Database.
dbUniqueName String
The DB_UNIQUE_NAME of the external database.
id String
The provider-assigned unique ID for this managed resource.
lifecycleDetails String
Additional information about the current lifecycle state.
ncharacterSet String
The national character of the external database.
operationsInsightsConfigs List<ExternalPluggableOperationsInsightsConfig>
The configuration of Operations Insights for the external database
stackMonitoringConfigs List<ExternalPluggableStackMonitoringConfig>
The configuration of Stack Monitoring for the external database.
state String
The current state of the Oracle Cloud Infrastructure external database resource.
timeCreated String
The date and time the database was created.
timeZone String
The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered.
characterSet string
The character set of the external database.
databaseConfiguration string
The Oracle Database configuration
databaseEdition string
The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
databaseManagementConfigs ExternalPluggableDatabaseDatabaseManagementConfig[]
The configuration of the Database Management service.
databaseVersion string
The Oracle Database version.
dbId string
The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud.
dbPacks string
The database packs licensed for the external Oracle Database.
dbUniqueName string
The DB_UNIQUE_NAME of the external database.
id string
The provider-assigned unique ID for this managed resource.
lifecycleDetails string
Additional information about the current lifecycle state.
ncharacterSet string
The national character of the external database.
operationsInsightsConfigs ExternalPluggableDatabaseOperationsInsightsConfig[]
The configuration of Operations Insights for the external database
stackMonitoringConfigs ExternalPluggableDatabaseStackMonitoringConfig[]
The configuration of Stack Monitoring for the external database.
state string
The current state of the Oracle Cloud Infrastructure external database resource.
timeCreated string
The date and time the database was created.
timeZone string
The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered.
character_set str
The character set of the external database.
database_configuration str
The Oracle Database configuration
database_edition str
The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
database_management_configs Sequence[database.ExternalPluggableDatabaseDatabaseManagementConfig]
The configuration of the Database Management service.
database_version str
The Oracle Database version.
db_id str
The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud.
db_packs str
The database packs licensed for the external Oracle Database.
db_unique_name str
The DB_UNIQUE_NAME of the external database.
id str
The provider-assigned unique ID for this managed resource.
lifecycle_details str
Additional information about the current lifecycle state.
ncharacter_set str
The national character of the external database.
operations_insights_configs Sequence[database.ExternalPluggableDatabaseOperationsInsightsConfig]
The configuration of Operations Insights for the external database
stack_monitoring_configs Sequence[database.ExternalPluggableDatabaseStackMonitoringConfig]
The configuration of Stack Monitoring for the external database.
state str
The current state of the Oracle Cloud Infrastructure external database resource.
time_created str
The date and time the database was created.
time_zone str
The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered.
characterSet String
The character set of the external database.
databaseConfiguration String
The Oracle Database configuration
databaseEdition String
The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
databaseManagementConfigs List<Property Map>
The configuration of the Database Management service.
databaseVersion String
The Oracle Database version.
dbId String
The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud.
dbPacks String
The database packs licensed for the external Oracle Database.
dbUniqueName String
The DB_UNIQUE_NAME of the external database.
id String
The provider-assigned unique ID for this managed resource.
lifecycleDetails String
Additional information about the current lifecycle state.
ncharacterSet String
The national character of the external database.
operationsInsightsConfigs List<Property Map>
The configuration of Operations Insights for the external database
stackMonitoringConfigs List<Property Map>
The configuration of Stack Monitoring for the external database.
state String
The current state of the Oracle Cloud Infrastructure external database resource.
timeCreated String
The date and time the database was created.
timeZone String
The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered.

Look up Existing ExternalPluggableDatabase Resource

Get an existing ExternalPluggableDatabase 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?: ExternalPluggableDatabaseState, opts?: CustomResourceOptions): ExternalPluggableDatabase
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        character_set: Optional[str] = None,
        compartment_id: Optional[str] = None,
        database_configuration: Optional[str] = None,
        database_edition: Optional[str] = None,
        database_management_configs: Optional[Sequence[_database.ExternalPluggableDatabaseDatabaseManagementConfigArgs]] = None,
        database_version: Optional[str] = None,
        db_id: Optional[str] = None,
        db_packs: Optional[str] = None,
        db_unique_name: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        external_container_database_id: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        lifecycle_details: Optional[str] = None,
        ncharacter_set: Optional[str] = None,
        operations_insights_configs: Optional[Sequence[_database.ExternalPluggableDatabaseOperationsInsightsConfigArgs]] = None,
        source_id: Optional[str] = None,
        stack_monitoring_configs: Optional[Sequence[_database.ExternalPluggableDatabaseStackMonitoringConfigArgs]] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        time_zone: Optional[str] = None) -> ExternalPluggableDatabase
func GetExternalPluggableDatabase(ctx *Context, name string, id IDInput, state *ExternalPluggableDatabaseState, opts ...ResourceOption) (*ExternalPluggableDatabase, error)
public static ExternalPluggableDatabase Get(string name, Input<string> id, ExternalPluggableDatabaseState? state, CustomResourceOptions? opts = null)
public static ExternalPluggableDatabase get(String name, Output<String> id, ExternalPluggableDatabaseState state, CustomResourceOptions options)
resources:  _:    type: oci:Database:ExternalPluggableDatabase    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:
CharacterSet string
The character set of the external database.
CompartmentId string
(Updatable) The OCID of the compartment.
DatabaseConfiguration string
The Oracle Database configuration
DatabaseEdition string
The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
DatabaseManagementConfigs List<ExternalPluggableDatabaseDatabaseManagementConfig>
The configuration of the Database Management service.
DatabaseVersion string
The Oracle Database version.
DbId string
The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud.
DbPacks string
The database packs licensed for the external Oracle Database.
DbUniqueName string
The DB_UNIQUE_NAME of the external database.
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. The name does not have to be unique.
ExternalContainerDatabaseId Changes to this property will trigger replacement. string
The OCID of the external container database that contains the specified external pluggable 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"}
LifecycleDetails string
Additional information about the current lifecycle state.
NcharacterSet string
The national character of the external database.
OperationsInsightsConfigs List<ExternalPluggableDatabaseOperationsInsightsConfig>
The configuration of Operations Insights for the external database
SourceId Changes to this property will trigger replacement. string

The OCID of the the non-container database that was converted to a pluggable database to create this resource.

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

StackMonitoringConfigs List<ExternalPluggableDatabaseStackMonitoringConfig>
The configuration of Stack Monitoring for the external database.
State string
The current state of the Oracle Cloud Infrastructure external database resource.
TimeCreated string
The date and time the database was created.
TimeZone string
The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered.
CharacterSet string
The character set of the external database.
CompartmentId string
(Updatable) The OCID of the compartment.
DatabaseConfiguration string
The Oracle Database configuration
DatabaseEdition string
The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
DatabaseManagementConfigs []ExternalPluggableDatabaseDatabaseManagementConfigArgs
The configuration of the Database Management service.
DatabaseVersion string
The Oracle Database version.
DbId string
The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud.
DbPacks string
The database packs licensed for the external Oracle Database.
DbUniqueName string
The DB_UNIQUE_NAME of the external database.
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. The name does not have to be unique.
ExternalContainerDatabaseId Changes to this property will trigger replacement. string
The OCID of the external container database that contains the specified external pluggable 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"}
LifecycleDetails string
Additional information about the current lifecycle state.
NcharacterSet string
The national character of the external database.
OperationsInsightsConfigs []ExternalPluggableDatabaseOperationsInsightsConfigArgs
The configuration of Operations Insights for the external database
SourceId Changes to this property will trigger replacement. string

The OCID of the the non-container database that was converted to a pluggable database to create this resource.

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

StackMonitoringConfigs []ExternalPluggableDatabaseStackMonitoringConfigArgs
The configuration of Stack Monitoring for the external database.
State string
The current state of the Oracle Cloud Infrastructure external database resource.
TimeCreated string
The date and time the database was created.
TimeZone string
The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered.
characterSet String
The character set of the external database.
compartmentId String
(Updatable) The OCID of the compartment.
databaseConfiguration String
The Oracle Database configuration
databaseEdition String
The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
databaseManagementConfigs List<ExternalPluggableManagementConfig>
The configuration of the Database Management service.
databaseVersion String
The Oracle Database version.
dbId String
The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud.
dbPacks String
The database packs licensed for the external Oracle Database.
dbUniqueName String
The DB_UNIQUE_NAME of the external database.
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. The name does not have to be unique.
externalContainerDatabaseId Changes to this property will trigger replacement. String
The OCID of the external container database that contains the specified external pluggable 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"}
lifecycleDetails String
Additional information about the current lifecycle state.
ncharacterSet String
The national character of the external database.
operationsInsightsConfigs List<ExternalPluggableOperationsInsightsConfig>
The configuration of Operations Insights for the external database
sourceId Changes to this property will trigger replacement. String

The OCID of the the non-container database that was converted to a pluggable database to create this resource.

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

stackMonitoringConfigs List<ExternalPluggableStackMonitoringConfig>
The configuration of Stack Monitoring for the external database.
state String
The current state of the Oracle Cloud Infrastructure external database resource.
timeCreated String
The date and time the database was created.
timeZone String
The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered.
characterSet string
The character set of the external database.
compartmentId string
(Updatable) The OCID of the compartment.
databaseConfiguration string
The Oracle Database configuration
databaseEdition string
The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
databaseManagementConfigs ExternalPluggableDatabaseDatabaseManagementConfig[]
The configuration of the Database Management service.
databaseVersion string
The Oracle Database version.
dbId string
The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud.
dbPacks string
The database packs licensed for the external Oracle Database.
dbUniqueName string
The DB_UNIQUE_NAME of the external database.
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. The name does not have to be unique.
externalContainerDatabaseId Changes to this property will trigger replacement. string
The OCID of the external container database that contains the specified external pluggable 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"}
lifecycleDetails string
Additional information about the current lifecycle state.
ncharacterSet string
The national character of the external database.
operationsInsightsConfigs ExternalPluggableDatabaseOperationsInsightsConfig[]
The configuration of Operations Insights for the external database
sourceId Changes to this property will trigger replacement. string

The OCID of the the non-container database that was converted to a pluggable database to create this resource.

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

stackMonitoringConfigs ExternalPluggableDatabaseStackMonitoringConfig[]
The configuration of Stack Monitoring for the external database.
state string
The current state of the Oracle Cloud Infrastructure external database resource.
timeCreated string
The date and time the database was created.
timeZone string
The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered.
character_set str
The character set of the external database.
compartment_id str
(Updatable) The OCID of the compartment.
database_configuration str
The Oracle Database configuration
database_edition str
The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
database_management_configs Sequence[database.ExternalPluggableDatabaseDatabaseManagementConfigArgs]
The configuration of the Database Management service.
database_version str
The Oracle Database version.
db_id str
The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud.
db_packs str
The database packs licensed for the external Oracle Database.
db_unique_name str
The DB_UNIQUE_NAME of the external database.
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. The name does not have to be unique.
external_container_database_id Changes to this property will trigger replacement. str
The OCID of the external container database that contains the specified external pluggable 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"}
lifecycle_details str
Additional information about the current lifecycle state.
ncharacter_set str
The national character of the external database.
operations_insights_configs Sequence[database.ExternalPluggableDatabaseOperationsInsightsConfigArgs]
The configuration of Operations Insights for the external database
source_id Changes to this property will trigger replacement. str

The OCID of the the non-container database that was converted to a pluggable database to create this resource.

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

stack_monitoring_configs Sequence[database.ExternalPluggableDatabaseStackMonitoringConfigArgs]
The configuration of Stack Monitoring for the external database.
state str
The current state of the Oracle Cloud Infrastructure external database resource.
time_created str
The date and time the database was created.
time_zone str
The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered.
characterSet String
The character set of the external database.
compartmentId String
(Updatable) The OCID of the compartment.
databaseConfiguration String
The Oracle Database configuration
databaseEdition String
The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
databaseManagementConfigs List<Property Map>
The configuration of the Database Management service.
databaseVersion String
The Oracle Database version.
dbId String
The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud.
dbPacks String
The database packs licensed for the external Oracle Database.
dbUniqueName String
The DB_UNIQUE_NAME of the external database.
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. The name does not have to be unique.
externalContainerDatabaseId Changes to this property will trigger replacement. String
The OCID of the external container database that contains the specified external pluggable 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"}
lifecycleDetails String
Additional information about the current lifecycle state.
ncharacterSet String
The national character of the external database.
operationsInsightsConfigs List<Property Map>
The configuration of Operations Insights for the external database
sourceId Changes to this property will trigger replacement. String

The OCID of the the non-container database that was converted to a pluggable database to create this resource.

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

stackMonitoringConfigs List<Property Map>
The configuration of Stack Monitoring for the external database.
state String
The current state of the Oracle Cloud Infrastructure external database resource.
timeCreated String
The date and time the database was created.
timeZone String
The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered.

Supporting Types

ExternalPluggableDatabaseDatabaseManagementConfig
, ExternalPluggableDatabaseDatabaseManagementConfigArgs

DatabaseManagementConnectionId string
The OCID of the external database connector.
DatabaseManagementStatus string
The status of the Database Management service.
LicenseModel string
The Oracle license model that applies to the external database.
DatabaseManagementConnectionId string
The OCID of the external database connector.
DatabaseManagementStatus string
The status of the Database Management service.
LicenseModel string
The Oracle license model that applies to the external database.
databaseManagementConnectionId String
The OCID of the external database connector.
databaseManagementStatus String
The status of the Database Management service.
licenseModel String
The Oracle license model that applies to the external database.
databaseManagementConnectionId string
The OCID of the external database connector.
databaseManagementStatus string
The status of the Database Management service.
licenseModel string
The Oracle license model that applies to the external database.
database_management_connection_id str
The OCID of the external database connector.
database_management_status str
The status of the Database Management service.
license_model str
The Oracle license model that applies to the external database.
databaseManagementConnectionId String
The OCID of the external database connector.
databaseManagementStatus String
The status of the Database Management service.
licenseModel String
The Oracle license model that applies to the external database.

ExternalPluggableDatabaseOperationsInsightsConfig
, ExternalPluggableDatabaseOperationsInsightsConfigArgs

OperationsInsightsConnectorId string
The OCID of the external database connector.
OperationsInsightsStatus string
The status of Operations Insights
OperationsInsightsConnectorId string
The OCID of the external database connector.
OperationsInsightsStatus string
The status of Operations Insights
operationsInsightsConnectorId String
The OCID of the external database connector.
operationsInsightsStatus String
The status of Operations Insights
operationsInsightsConnectorId string
The OCID of the external database connector.
operationsInsightsStatus string
The status of Operations Insights
operationsInsightsConnectorId String
The OCID of the external database connector.
operationsInsightsStatus String
The status of Operations Insights

ExternalPluggableDatabaseStackMonitoringConfig
, ExternalPluggableDatabaseStackMonitoringConfigArgs

StackMonitoringConnectorId string
The OCID of the external database connector.
StackMonitoringStatus string
The status of Stack Monitoring.
StackMonitoringConnectorId string
The OCID of the external database connector.
StackMonitoringStatus string
The status of Stack Monitoring.
stackMonitoringConnectorId String
The OCID of the external database connector.
stackMonitoringStatus String
The status of Stack Monitoring.
stackMonitoringConnectorId string
The OCID of the external database connector.
stackMonitoringStatus string
The status of Stack Monitoring.
stackMonitoringConnectorId String
The OCID of the external database connector.
stackMonitoringStatus String
The status of Stack Monitoring.

Import

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

$ pulumi import oci:Database/externalPluggableDatabase:ExternalPluggableDatabase test_external_pluggable_database "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.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci