Oracle Cloud Infrastructure v2.31.0, Apr 17 25

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.Database.getPluggableDatabase

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const testPluggableDatabase = oci.Database.getPluggableDatabase({
    pluggableDatabaseId: testPluggableDatabaseOciDatabasePluggableDatabase.id,
});

import pulumi
import pulumi_oci as oci

test_pluggable_database = oci.Database.get_pluggable_database(pluggable_database_id=test_pluggable_database_oci_database_pluggable_database["id"])

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.GetPluggableDatabase(ctx, &database.GetPluggableDatabaseArgs{
			PluggableDatabaseId: testPluggableDatabaseOciDatabasePluggableDatabase.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testPluggableDatabase = Oci.Database.GetPluggableDatabase.Invoke(new()
    {
        PluggableDatabaseId = testPluggableDatabaseOciDatabasePluggableDatabase.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Database.DatabaseFunctions;
import com.pulumi.oci.Database.inputs.GetPluggableDatabaseArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testPluggableDatabase = DatabaseFunctions.getPluggableDatabase(GetPluggableDatabaseArgs.builder()
            .pluggableDatabaseId(testPluggableDatabaseOciDatabasePluggableDatabase.id())
            .build());

    }
}

variables:
  testPluggableDatabase:
    fn::invoke:
      function: oci:Database:getPluggableDatabase
      arguments:
        pluggableDatabaseId: ${testPluggableDatabaseOciDatabasePluggableDatabase.id}

Using getPluggableDatabase

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getPluggableDatabase(args: GetPluggableDatabaseArgs, opts?: InvokeOptions): Promise<GetPluggableDatabaseResult>
function getPluggableDatabaseOutput(args: GetPluggableDatabaseOutputArgs, opts?: InvokeOptions): Output<GetPluggableDatabaseResult>

def get_pluggable_database(pluggable_database_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetPluggableDatabaseResult
def get_pluggable_database_output(pluggable_database_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetPluggableDatabaseResult]

func GetPluggableDatabase(ctx *Context, args *GetPluggableDatabaseArgs, opts ...InvokeOption) (*GetPluggableDatabaseResult, error)
func GetPluggableDatabaseOutput(ctx *Context, args *GetPluggableDatabaseOutputArgs, opts ...InvokeOption) GetPluggableDatabaseResultOutput

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

public static class GetPluggableDatabase 
{
    public static Task<GetPluggableDatabaseResult> InvokeAsync(GetPluggableDatabaseArgs args, InvokeOptions? opts = null)
    public static Output<GetPluggableDatabaseResult> Invoke(GetPluggableDatabaseInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPluggableDatabaseResult> getPluggableDatabase(GetPluggableDatabaseArgs args, InvokeOptions options)
public static Output<GetPluggableDatabaseResult> getPluggableDatabase(GetPluggableDatabaseArgs args, InvokeOptions options)

fn::invoke:
  function: oci:Database/getPluggableDatabase:getPluggableDatabase
  arguments:
    # arguments dictionary

The following arguments are supported:

PluggableDatabaseId string: The database OCID.

PluggableDatabaseId string: The database OCID.

pluggableDatabaseId String: The database OCID.

pluggableDatabaseId string: The database OCID.

pluggable_database_id str: The database OCID.

pluggableDatabaseId String: The database OCID.

getPluggableDatabase Result

The following output properties are available:

CompartmentId string: The OCID of the compartment.
ConnectionStrings List<GetPluggableDatabaseConnectionString>: Connection strings to connect to an Oracle Pluggable Database.
ContainerDatabaseAdminPassword string
ContainerDatabaseId string: The OCID of the CDB.
ConvertToRegularTrigger int
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
FreeformTags Dictionary<string, string>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: The OCID of the pluggable database.
IsRestricted bool: The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.
KmsKeyVersionId string
LifecycleDetails string: Detailed message for the lifecycle state.
OpenMode string: The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).
PdbAdminPassword string
PdbCreationTypeDetails List<GetPluggableDatabasePdbCreationTypeDetail>
PdbName string: The name for the pluggable database (PDB). The name is unique in the context of a container database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name.
PdbNodeLevelDetails List<GetPluggableDatabasePdbNodeLevelDetail>: Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
PluggableDatabaseId string
PluggableDatabaseManagementConfigs List<GetPluggableDatabasePluggableDatabaseManagementConfig>: The configuration of the Pluggable Database Management service.
RefreshTrigger int
RefreshableCloneConfigs List<GetPluggableDatabaseRefreshableCloneConfig>: Pluggable Database Refreshable Clone Configuration.
RotateKeyTrigger int
ShouldCreatePdbBackup bool
ShouldPdbAdminAccountBeLocked bool
State string: The current state of the pluggable database.
TdeWalletPassword string
TimeCreated string: The date and time the pluggable database was created.

CompartmentId string: The OCID of the compartment.
ConnectionStrings []GetPluggableDatabaseConnectionString: Connection strings to connect to an Oracle Pluggable Database.
ContainerDatabaseAdminPassword string
ContainerDatabaseId string: The OCID of the CDB.
ConvertToRegularTrigger int
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
FreeformTags map[string]string: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: The OCID of the pluggable database.
IsRestricted bool: The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.
KmsKeyVersionId string
LifecycleDetails string: Detailed message for the lifecycle state.
OpenMode string: The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).
PdbAdminPassword string
PdbCreationTypeDetails []GetPluggableDatabasePdbCreationTypeDetail
PdbName string: The name for the pluggable database (PDB). The name is unique in the context of a container database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name.
PdbNodeLevelDetails []GetPluggableDatabasePdbNodeLevelDetail: Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
PluggableDatabaseId string
PluggableDatabaseManagementConfigs []GetPluggableDatabasePluggableDatabaseManagementConfig: The configuration of the Pluggable Database Management service.
RefreshTrigger int
RefreshableCloneConfigs []GetPluggableDatabaseRefreshableCloneConfig: Pluggable Database Refreshable Clone Configuration.
RotateKeyTrigger int
ShouldCreatePdbBackup bool
ShouldPdbAdminAccountBeLocked bool
State string: The current state of the pluggable database.
TdeWalletPassword string
TimeCreated string: The date and time the pluggable database was created.

compartmentId String: The OCID of the compartment.
connectionStrings List<GetPluggableConnectionString>: Connection strings to connect to an Oracle Pluggable Database.
containerDatabaseAdminPassword String
containerDatabaseId String: The OCID of the CDB.
convertToRegularTrigger Integer
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
freeformTags Map<String,String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: The OCID of the pluggable database.
isRestricted Boolean: The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.
kmsKeyVersionId String
lifecycleDetails String: Detailed message for the lifecycle state.
openMode String: The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).
pdbAdminPassword String
pdbCreationTypeDetails List<GetPluggablePdbCreationTypeDetail>
pdbName String: The name for the pluggable database (PDB). The name is unique in the context of a container database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name.
pdbNodeLevelDetails List<GetPluggablePdbNodeLevelDetail>: Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
pluggableDatabaseId String
pluggableDatabaseManagementConfigs List<GetPluggablePluggableManagementConfig>: The configuration of the Pluggable Database Management service.
refreshTrigger Integer
refreshableCloneConfigs List<GetPluggableRefreshableCloneConfig>: Pluggable Database Refreshable Clone Configuration.
rotateKeyTrigger Integer
shouldCreatePdbBackup Boolean
shouldPdbAdminAccountBeLocked Boolean
state String: The current state of the pluggable database.
tdeWalletPassword String
timeCreated String: The date and time the pluggable database was created.

compartmentId string: The OCID of the compartment.
connectionStrings GetPluggableDatabaseConnectionString[]: Connection strings to connect to an Oracle Pluggable Database.
containerDatabaseAdminPassword string
containerDatabaseId string: The OCID of the CDB.
convertToRegularTrigger number
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
freeformTags {[key: string]: string}: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id string: The OCID of the pluggable database.
isRestricted boolean: The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.
kmsKeyVersionId string
lifecycleDetails string: Detailed message for the lifecycle state.
openMode string: The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).
pdbAdminPassword string
pdbCreationTypeDetails GetPluggableDatabasePdbCreationTypeDetail[]
pdbName string: The name for the pluggable database (PDB). The name is unique in the context of a container database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name.
pdbNodeLevelDetails GetPluggableDatabasePdbNodeLevelDetail[]: Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
pluggableDatabaseId string
pluggableDatabaseManagementConfigs GetPluggableDatabasePluggableDatabaseManagementConfig[]: The configuration of the Pluggable Database Management service.
refreshTrigger number
refreshableCloneConfigs GetPluggableDatabaseRefreshableCloneConfig[]: Pluggable Database Refreshable Clone Configuration.
rotateKeyTrigger number
shouldCreatePdbBackup boolean
shouldPdbAdminAccountBeLocked boolean
state string: The current state of the pluggable database.
tdeWalletPassword string
timeCreated string: The date and time the pluggable database was created.

compartment_id str: The OCID of the compartment.
connection_strings Sequence[database.GetPluggableDatabaseConnectionString]: Connection strings to connect to an Oracle Pluggable Database.
container_database_admin_password str
container_database_id str: The OCID of the CDB.
convert_to_regular_trigger int
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
freeform_tags Mapping[str, str]: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id str: The OCID of the pluggable database.
is_restricted bool: The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.
kms_key_version_id str
lifecycle_details str: Detailed message for the lifecycle state.
open_mode str: The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).
pdb_admin_password str
pdb_creation_type_details Sequence[database.GetPluggableDatabasePdbCreationTypeDetail]
pdb_name str: The name for the pluggable database (PDB). The name is unique in the context of a container database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name.
pdb_node_level_details Sequence[database.GetPluggableDatabasePdbNodeLevelDetail]: Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
pluggable_database_id str
pluggable_database_management_configs Sequence[database.GetPluggableDatabasePluggableDatabaseManagementConfig]: The configuration of the Pluggable Database Management service.
refresh_trigger int
refreshable_clone_configs Sequence[database.GetPluggableDatabaseRefreshableCloneConfig]: Pluggable Database Refreshable Clone Configuration.
rotate_key_trigger int
should_create_pdb_backup bool
should_pdb_admin_account_be_locked bool
state str: The current state of the pluggable database.
tde_wallet_password str
time_created str: The date and time the pluggable database was created.

compartmentId String: The OCID of the compartment.
connectionStrings List<Property Map>: Connection strings to connect to an Oracle Pluggable Database.
containerDatabaseAdminPassword String
containerDatabaseId String: The OCID of the CDB.
convertToRegularTrigger Number
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
freeformTags Map<String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: The OCID of the pluggable database.
isRestricted Boolean: The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.
kmsKeyVersionId String
lifecycleDetails String: Detailed message for the lifecycle state.
openMode String: The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).
pdbAdminPassword String
pdbCreationTypeDetails List<Property Map>
pdbName String: The name for the pluggable database (PDB). The name is unique in the context of a container database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name.
pdbNodeLevelDetails List<Property Map>: Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
pluggableDatabaseId String
pluggableDatabaseManagementConfigs List<Property Map>: The configuration of the Pluggable Database Management service.
refreshTrigger Number
refreshableCloneConfigs List<Property Map>: Pluggable Database Refreshable Clone Configuration.
rotateKeyTrigger Number
shouldCreatePdbBackup Boolean
shouldPdbAdminAccountBeLocked Boolean
state String: The current state of the pluggable database.
tdeWalletPassword String
timeCreated String: The date and time the pluggable database was created.

Supporting Types

GetPluggableDatabaseConnectionString

AllConnectionStrings Dictionary<string, string>: All connection strings to use to connect to the pluggable database.
PdbDefault string: A host name-based PDB connection string.
PdbIpDefault string: An IP-based PDB connection string.

AllConnectionStrings map[string]string: All connection strings to use to connect to the pluggable database.
PdbDefault string: A host name-based PDB connection string.
PdbIpDefault string: An IP-based PDB connection string.

allConnectionStrings Map<String,String>: All connection strings to use to connect to the pluggable database.
pdbDefault String: A host name-based PDB connection string.
pdbIpDefault String: An IP-based PDB connection string.

allConnectionStrings {[key: string]: string}: All connection strings to use to connect to the pluggable database.
pdbDefault string: A host name-based PDB connection string.
pdbIpDefault string: An IP-based PDB connection string.

all_connection_strings Mapping[str, str]: All connection strings to use to connect to the pluggable database.
pdb_default str: A host name-based PDB connection string.
pdb_ip_default str: An IP-based PDB connection string.

allConnectionStrings Map<String>: All connection strings to use to connect to the pluggable database.
pdbDefault String: A host name-based PDB connection string.
pdbIpDefault String: An IP-based PDB connection string.

GetPluggableDatabasePdbCreationTypeDetail

CreationType string
DblinkUserPassword string
DblinkUsername string
IsThinClone bool
RefreshableCloneDetails List<GetPluggableDatabasePdbCreationTypeDetailRefreshableCloneDetail>
SourceContainerDatabaseAdminPassword string
SourcePluggableDatabaseId string

CreationType string
DblinkUserPassword string
DblinkUsername string
IsThinClone bool
RefreshableCloneDetails []GetPluggableDatabasePdbCreationTypeDetailRefreshableCloneDetail
SourceContainerDatabaseAdminPassword string
SourcePluggableDatabaseId string

creationType String
dblinkUserPassword String
dblinkUsername String
isThinClone Boolean
refreshableCloneDetails List<GetPluggablePdbCreationTypeDetailRefreshableCloneDetail>
sourceContainerDatabaseAdminPassword String
sourcePluggableDatabaseId String

creationType string
dblinkUserPassword string
dblinkUsername string
isThinClone boolean
refreshableCloneDetails GetPluggableDatabasePdbCreationTypeDetailRefreshableCloneDetail[]
sourceContainerDatabaseAdminPassword string
sourcePluggableDatabaseId string

creation_type str
dblink_user_password str
dblink_username str
is_thin_clone bool
refreshable_clone_details Sequence[database.GetPluggableDatabasePdbCreationTypeDetailRefreshableCloneDetail]
source_container_database_admin_password str
source_pluggable_database_id str

creationType String
dblinkUserPassword String
dblinkUsername String
isThinClone Boolean
refreshableCloneDetails List<Property Map>
sourceContainerDatabaseAdminPassword String
sourcePluggableDatabaseId String

GetPluggableDatabasePdbCreationTypeDetailRefreshableCloneDetail

IsRefreshableClone bool: Indicates whether the Pluggable Database is a refreshable clone.

IsRefreshableClone bool: Indicates whether the Pluggable Database is a refreshable clone.

isRefreshableClone Boolean: Indicates whether the Pluggable Database is a refreshable clone.

isRefreshableClone boolean: Indicates whether the Pluggable Database is a refreshable clone.

is_refreshable_clone bool: Indicates whether the Pluggable Database is a refreshable clone.

isRefreshableClone Boolean: Indicates whether the Pluggable Database is a refreshable clone.

GetPluggableDatabasePdbNodeLevelDetail

NodeName string: The Node name of the Database Instance.
OpenMode string: The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).

NodeName string: The Node name of the Database Instance.
OpenMode string: The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).

nodeName String: The Node name of the Database Instance.
openMode String: The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).

nodeName string: The Node name of the Database Instance.
openMode string: The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).

node_name str: The Node name of the Database Instance.
open_mode str: The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).

nodeName String: The Node name of the Database Instance.
openMode String: The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).

GetPluggableDatabasePluggableDatabaseManagementConfig

ManagementStatus string: The status of the Pluggable Database Management service.

ManagementStatus string: The status of the Pluggable Database Management service.

managementStatus String: The status of the Pluggable Database Management service.

managementStatus string: The status of the Pluggable Database Management service.

management_status str: The status of the Pluggable Database Management service.

managementStatus String: The status of the Pluggable Database Management service.

GetPluggableDatabaseRefreshableCloneConfig

IsRefreshableClone bool: Indicates whether the Pluggable Database is a refreshable clone.

IsRefreshableClone bool: Indicates whether the Pluggable Database is a refreshable clone.

isRefreshableClone Boolean: Indicates whether the Pluggable Database is a refreshable clone.

isRefreshableClone boolean: Indicates whether the Pluggable Database is a refreshable clone.

is_refreshable_clone bool: Indicates whether the Pluggable Database is a refreshable clone.

isRefreshableClone Boolean: Indicates whether the Pluggable Database is a refreshable clone.

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

oci.Database.getPluggableDatabase

On this page

On this page

Example Usage

Using getPluggableDatabase

getPluggableDatabase Result

Supporting Types

GetPluggableDatabaseConnectionString

GetPluggableDatabasePdbCreationTypeDetail

GetPluggableDatabasePdbCreationTypeDetailRefreshableCloneDetail

GetPluggableDatabasePdbNodeLevelDetail

GetPluggableDatabasePluggableDatabaseManagementConfig

GetPluggableDatabaseRefreshableCloneConfig

Package Details

On this page

On this page