1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Database
  5. ExternalPluggableDatabaseManagement
Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi

oci.Database.ExternalPluggableDatabaseManagement

Explore with Pulumi AI

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

Enable Database Management Service for the external pluggable database. For more information about the Database Management Service, see Database Management Service.

Example Usage

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

const testExternalPluggableDatabaseManagement = new oci.database.ExternalPluggableDatabaseManagement("test_external_pluggable_database_management", {
    externalDatabaseConnectorId: testExternalDatabaseConnector.id,
    externalPluggableDatabaseId: testExternalPluggableDatabase.id,
});
Copy
import pulumi
import pulumi_oci as oci

test_external_pluggable_database_management = oci.database.ExternalPluggableDatabaseManagement("test_external_pluggable_database_management",
    external_database_connector_id=test_external_database_connector["id"],
    external_pluggable_database_id=test_external_pluggable_database["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.NewExternalPluggableDatabaseManagement(ctx, "test_external_pluggable_database_management", &database.ExternalPluggableDatabaseManagementArgs{
			ExternalDatabaseConnectorId: pulumi.Any(testExternalDatabaseConnector.Id),
			ExternalPluggableDatabaseId: pulumi.Any(testExternalPluggableDatabase.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 testExternalPluggableDatabaseManagement = new Oci.Database.ExternalPluggableDatabaseManagement("test_external_pluggable_database_management", new()
    {
        ExternalDatabaseConnectorId = testExternalDatabaseConnector.Id,
        ExternalPluggableDatabaseId = testExternalPluggableDatabase.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Database.ExternalPluggableDatabaseManagement;
import com.pulumi.oci.Database.ExternalPluggableDatabaseManagementArgs;
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 testExternalPluggableDatabaseManagement = new ExternalPluggableDatabaseManagement("testExternalPluggableDatabaseManagement", ExternalPluggableDatabaseManagementArgs.builder()
            .externalDatabaseConnectorId(testExternalDatabaseConnector.id())
            .externalPluggableDatabaseId(testExternalPluggableDatabase.id())
            .build());

    }
}
Copy
resources:
  testExternalPluggableDatabaseManagement:
    type: oci:Database:ExternalPluggableDatabaseManagement
    name: test_external_pluggable_database_management
    properties:
      externalDatabaseConnectorId: ${testExternalDatabaseConnector.id}
      externalPluggableDatabaseId: ${testExternalPluggableDatabase.id}
Copy

Create ExternalPluggableDatabaseManagement Resource

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

Constructor syntax

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

@overload
def ExternalPluggableDatabaseManagement(resource_name: str,
                                        opts: Optional[ResourceOptions] = None,
                                        enable_management: Optional[bool] = None,
                                        external_database_connector_id: Optional[str] = None,
                                        external_pluggable_database_id: Optional[str] = None)
func NewExternalPluggableDatabaseManagement(ctx *Context, name string, args ExternalPluggableDatabaseManagementArgs, opts ...ResourceOption) (*ExternalPluggableDatabaseManagement, error)
public ExternalPluggableDatabaseManagement(string name, ExternalPluggableDatabaseManagementArgs args, CustomResourceOptions? opts = null)
public ExternalPluggableDatabaseManagement(String name, ExternalPluggableDatabaseManagementArgs args)
public ExternalPluggableDatabaseManagement(String name, ExternalPluggableDatabaseManagementArgs args, CustomResourceOptions options)
type: oci:Database:ExternalPluggableDatabaseManagement
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. ExternalPluggableDatabaseManagementArgs
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. ExternalPluggableDatabaseManagementArgs
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. ExternalPluggableDatabaseManagementArgs
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. ExternalPluggableDatabaseManagementArgs
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. ExternalPluggableDatabaseManagementArgs
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 externalPluggableDatabaseManagementResource = new Oci.Database.ExternalPluggableDatabaseManagement("externalPluggableDatabaseManagementResource", new()
{
    EnableManagement = false,
    ExternalDatabaseConnectorId = "string",
    ExternalPluggableDatabaseId = "string",
});
Copy
example, err := Database.NewExternalPluggableDatabaseManagement(ctx, "externalPluggableDatabaseManagementResource", &Database.ExternalPluggableDatabaseManagementArgs{
	EnableManagement:            pulumi.Bool(false),
	ExternalDatabaseConnectorId: pulumi.String("string"),
	ExternalPluggableDatabaseId: pulumi.String("string"),
})
Copy
var externalPluggableDatabaseManagementResource = new ExternalPluggableDatabaseManagement("externalPluggableDatabaseManagementResource", ExternalPluggableDatabaseManagementArgs.builder()
    .enableManagement(false)
    .externalDatabaseConnectorId("string")
    .externalPluggableDatabaseId("string")
    .build());
Copy
external_pluggable_database_management_resource = oci.database.ExternalPluggableDatabaseManagement("externalPluggableDatabaseManagementResource",
    enable_management=False,
    external_database_connector_id="string",
    external_pluggable_database_id="string")
Copy
const externalPluggableDatabaseManagementResource = new oci.database.ExternalPluggableDatabaseManagement("externalPluggableDatabaseManagementResource", {
    enableManagement: false,
    externalDatabaseConnectorId: "string",
    externalPluggableDatabaseId: "string",
});
Copy
type: oci:Database:ExternalPluggableDatabaseManagement
properties:
    enableManagement: false
    externalDatabaseConnectorId: string
    externalPluggableDatabaseId: string
Copy

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

EnableManagement This property is required. bool
ExternalDatabaseConnectorId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the external database connector.
ExternalPluggableDatabaseId
This property is required.
Changes to this property will trigger replacement.
string

The ExternalPluggableDatabaseId OCID.

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

EnableManagement This property is required. bool
ExternalDatabaseConnectorId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the external database connector.
ExternalPluggableDatabaseId
This property is required.
Changes to this property will trigger replacement.
string

The ExternalPluggableDatabaseId OCID.

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

enableManagement This property is required. Boolean
externalDatabaseConnectorId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the external database connector.
externalPluggableDatabaseId
This property is required.
Changes to this property will trigger replacement.
String

The ExternalPluggableDatabaseId OCID.

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

enableManagement This property is required. boolean
externalDatabaseConnectorId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the external database connector.
externalPluggableDatabaseId
This property is required.
Changes to this property will trigger replacement.
string

The ExternalPluggableDatabaseId OCID.

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

enable_management This property is required. bool
external_database_connector_id
This property is required.
Changes to this property will trigger replacement.
str
The OCID of the external database connector.
external_pluggable_database_id
This property is required.
Changes to this property will trigger replacement.
str

The ExternalPluggableDatabaseId OCID.

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

enableManagement This property is required. Boolean
externalDatabaseConnectorId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the external database connector.
externalPluggableDatabaseId
This property is required.
Changes to this property will trigger replacement.
String

The ExternalPluggableDatabaseId OCID.

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing ExternalPluggableDatabaseManagement Resource

Get an existing ExternalPluggableDatabaseManagement 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?: ExternalPluggableDatabaseManagementState, opts?: CustomResourceOptions): ExternalPluggableDatabaseManagement
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        enable_management: Optional[bool] = None,
        external_database_connector_id: Optional[str] = None,
        external_pluggable_database_id: Optional[str] = None) -> ExternalPluggableDatabaseManagement
func GetExternalPluggableDatabaseManagement(ctx *Context, name string, id IDInput, state *ExternalPluggableDatabaseManagementState, opts ...ResourceOption) (*ExternalPluggableDatabaseManagement, error)
public static ExternalPluggableDatabaseManagement Get(string name, Input<string> id, ExternalPluggableDatabaseManagementState? state, CustomResourceOptions? opts = null)
public static ExternalPluggableDatabaseManagement get(String name, Output<String> id, ExternalPluggableDatabaseManagementState state, CustomResourceOptions options)
resources:  _:    type: oci:Database:ExternalPluggableDatabaseManagement    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:
EnableManagement bool
ExternalDatabaseConnectorId Changes to this property will trigger replacement. string
The OCID of the external database connector.
ExternalPluggableDatabaseId Changes to this property will trigger replacement. string

The ExternalPluggableDatabaseId OCID.

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

EnableManagement bool
ExternalDatabaseConnectorId Changes to this property will trigger replacement. string
The OCID of the external database connector.
ExternalPluggableDatabaseId Changes to this property will trigger replacement. string

The ExternalPluggableDatabaseId OCID.

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

enableManagement Boolean
externalDatabaseConnectorId Changes to this property will trigger replacement. String
The OCID of the external database connector.
externalPluggableDatabaseId Changes to this property will trigger replacement. String

The ExternalPluggableDatabaseId OCID.

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

enableManagement boolean
externalDatabaseConnectorId Changes to this property will trigger replacement. string
The OCID of the external database connector.
externalPluggableDatabaseId Changes to this property will trigger replacement. string

The ExternalPluggableDatabaseId OCID.

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

enable_management bool
external_database_connector_id Changes to this property will trigger replacement. str
The OCID of the external database connector.
external_pluggable_database_id Changes to this property will trigger replacement. str

The ExternalPluggableDatabaseId OCID.

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

enableManagement Boolean
externalDatabaseConnectorId Changes to this property will trigger replacement. String
The OCID of the external database connector.
externalPluggableDatabaseId Changes to this property will trigger replacement. String

The ExternalPluggableDatabaseId OCID.

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

Import

Import is not supported for this resource.

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.