Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

getPluggableDatabases

This data source provides the list of Pluggable Databases in Oracle Cloud Infrastructure Database service.

Gets a list of the pluggable databases in a database or compartment. You must provide either a databaseId or compartmentId value.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testPluggableDatabases = Output.Create(Oci.Database.GetPluggableDatabases.InvokeAsync(new Oci.Database.GetPluggableDatabasesArgs
        {
            CompartmentId = @var.Compartment_id,
            DatabaseId = oci_database_database.Test_database.Id,
            PdbName = @var.Pluggable_database_pdb_name,
            State = @var.Pluggable_database_state,
        }));
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Database.GetPluggableDatabases(ctx, &database.GetPluggableDatabasesArgs{
			CompartmentId: pulumi.StringRef(_var.Compartment_id),
			DatabaseId:    pulumi.StringRef(oci_database_database.Test_database.Id),
			PdbName:       pulumi.StringRef(_var.Pluggable_database_pdb_name),
			State:         pulumi.StringRef(_var.Pluggable_database_state),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_pluggable_databases = oci.Database.get_pluggable_databases(compartment_id=var["compartment_id"],
    database_id=oci_database_database["test_database"]["id"],
    pdb_name=var["pluggable_database_pdb_name"],
    state=var["pluggable_database_state"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testPluggableDatabases = oci.Database.getPluggableDatabases({
    compartmentId: _var.compartment_id,
    databaseId: oci_database_database.test_database.id,
    pdbName: _var.pluggable_database_pdb_name,
    state: _var.pluggable_database_state,
});

Coming soon!

Using getPluggableDatabases

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

function getPluggableDatabases(args: GetPluggableDatabasesArgs, opts?: InvokeOptions): Promise<GetPluggableDatabasesResult>
function getPluggableDatabasesOutput(args: GetPluggableDatabasesOutputArgs, opts?: InvokeOptions): Output<GetPluggableDatabasesResult>
def get_pluggable_databases(compartment_id: Optional[str] = None,
                            database_id: Optional[str] = None,
                            filters: Optional[Sequence[_database.GetPluggableDatabasesFilter]] = None,
                            pdb_name: Optional[str] = None,
                            state: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetPluggableDatabasesResult
def get_pluggable_databases_output(compartment_id: Optional[pulumi.Input[str]] = None,
                            database_id: Optional[pulumi.Input[str]] = None,
                            filters: Optional[pulumi.Input[Sequence[pulumi.Input[_database.GetPluggableDatabasesFilterArgs]]]] = None,
                            pdb_name: Optional[pulumi.Input[str]] = None,
                            state: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetPluggableDatabasesResult]
func GetPluggableDatabases(ctx *Context, args *GetPluggableDatabasesArgs, opts ...InvokeOption) (*GetPluggableDatabasesResult, error)
func GetPluggableDatabasesOutput(ctx *Context, args *GetPluggableDatabasesOutputArgs, opts ...InvokeOption) GetPluggableDatabasesResultOutput

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

public static class GetPluggableDatabases 
{
    public static Task<GetPluggableDatabasesResult> InvokeAsync(GetPluggableDatabasesArgs args, InvokeOptions? opts = null)
    public static Output<GetPluggableDatabasesResult> Invoke(GetPluggableDatabasesInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetPluggableDatabasesResult> getPluggableDatabases(GetPluggableDatabasesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:Database/getPluggableDatabases:getPluggableDatabases
  Arguments:
    # Arguments dictionary

The following arguments are supported:

CompartmentId string

The compartment OCID.

DatabaseId string

The OCID of the database.

Filters List<GetPluggableDatabasesFilter>
PdbName string

A filter to return only pluggable databases that match the entire name given. The match is not case sensitive.

State string

A filter to return only resources that match the given lifecycle state exactly.

CompartmentId string

The compartment OCID.

DatabaseId string

The OCID of the database.

Filters []GetPluggableDatabasesFilter
PdbName string

A filter to return only pluggable databases that match the entire name given. The match is not case sensitive.

State string

A filter to return only resources that match the given lifecycle state exactly.

compartmentId String

The compartment OCID.

databaseId String

The OCID of the database.

filters List<GetPluggablesFilter>
pdbName String

A filter to return only pluggable databases that match the entire name given. The match is not case sensitive.

state String

A filter to return only resources that match the given lifecycle state exactly.

compartmentId string

The compartment OCID.

databaseId string

The OCID of the database.

filters GetPluggableDatabasesFilter[]
pdbName string

A filter to return only pluggable databases that match the entire name given. The match is not case sensitive.

state string

A filter to return only resources that match the given lifecycle state exactly.

compartment_id str

The compartment OCID.

database_id str

The OCID of the database.

filters GetPluggableDatabasesFilter]
pdb_name str

A filter to return only pluggable databases that match the entire name given. The match is not case sensitive.

state str

A filter to return only resources that match the given lifecycle state exactly.

compartmentId String

The compartment OCID.

databaseId String

The OCID of the database.

filters List<Property Map>
pdbName String

A filter to return only pluggable databases that match the entire name given. The match is not case sensitive.

state String

A filter to return only resources that match the given lifecycle state exactly.

getPluggableDatabases Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

PluggableDatabases List<GetPluggableDatabasesPluggableDatabase>

The list of pluggable_databases.

CompartmentId string

The OCID of the compartment.

DatabaseId string
Filters List<GetPluggableDatabasesFilter>
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.

State string

The current state of the pluggable database.

Id string

The provider-assigned unique ID for this managed resource.

PluggableDatabases []GetPluggableDatabasesPluggableDatabase

The list of pluggable_databases.

CompartmentId string

The OCID of the compartment.

DatabaseId string
Filters []GetPluggableDatabasesFilter
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.

State string

The current state of the pluggable database.

id String

The provider-assigned unique ID for this managed resource.

pluggableDatabases List<GetPluggablesPluggable>

The list of pluggable_databases.

compartmentId String

The OCID of the compartment.

databaseId String
filters List<GetPluggablesFilter>
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.

state String

The current state of the pluggable database.

id string

The provider-assigned unique ID for this managed resource.

pluggableDatabases GetPluggableDatabasesPluggableDatabase[]

The list of pluggable_databases.

compartmentId string

The OCID of the compartment.

databaseId string
filters GetPluggableDatabasesFilter[]
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.

state string

The current state of the pluggable database.

id str

The provider-assigned unique ID for this managed resource.

pluggable_databases GetPluggableDatabasesPluggableDatabase]

The list of pluggable_databases.

compartment_id str

The OCID of the compartment.

database_id str
filters GetPluggableDatabasesFilter]
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.

state str

The current state of the pluggable database.

id String

The provider-assigned unique ID for this managed resource.

pluggableDatabases List<Property Map>

The list of pluggable_databases.

compartmentId String

The OCID of the compartment.

databaseId String
filters 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.

state String

The current state of the pluggable database.

Supporting Types

GetPluggableDatabasesFilter

Name string
Values List<string>
Regex bool
Name string
Values []string
Regex bool
name String
values List<String>
regex Boolean
name string
values string[]
regex boolean
name str
values Sequence[str]
regex bool
name String
values List<String>
regex Boolean

GetPluggableDatabasesPluggableDatabase

CompartmentId string

The compartment OCID.

ConnectionStrings List<GetPluggableDatabasesPluggableDatabaseConnectionString>

Connection strings to connect to an Oracle Pluggable Database.

ContainerDatabaseId string

The OCID of the CDB.

DefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

FreeformTags Dictionary<string, object>

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.

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
PdbName string

A filter to return only pluggable databases that match the entire name given. The match is not case sensitive.

ShouldPdbAdminAccountBeLocked bool
State string

A filter to return only resources that match the given lifecycle state exactly.

TdeWalletPassword string
TimeCreated string

The date and time the pluggable database was created.

CompartmentId string

The compartment OCID.

ConnectionStrings []GetPluggableDatabasesPluggableDatabaseConnectionString

Connection strings to connect to an Oracle Pluggable Database.

ContainerDatabaseId string

The OCID of the CDB.

DefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

FreeformTags map[string]interface{}

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.

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
PdbName string

A filter to return only pluggable databases that match the entire name given. The match is not case sensitive.

ShouldPdbAdminAccountBeLocked bool
State string

A filter to return only resources that match the given lifecycle state exactly.

TdeWalletPassword string
TimeCreated string

The date and time the pluggable database was created.

compartmentId String

The compartment OCID.

connectionStrings List<GetPluggablesPluggableConnectionString>

Connection strings to connect to an Oracle Pluggable Database.

containerDatabaseId String

The OCID of the CDB.

definedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeformTags Map<String,Object>

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.

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
pdbName String

A filter to return only pluggable databases that match the entire name given. The match is not case sensitive.

shouldPdbAdminAccountBeLocked Boolean
state String

A filter to return only resources that match the given lifecycle state exactly.

tdeWalletPassword String
timeCreated String

The date and time the pluggable database was created.

compartmentId string

The compartment OCID.

connectionStrings GetPluggableDatabasesPluggableDatabaseConnectionString[]

Connection strings to connect to an Oracle Pluggable Database.

containerDatabaseId string

The OCID of the CDB.

definedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeformTags {[key: string]: any}

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.

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
pdbName string

A filter to return only pluggable databases that match the entire name given. The match is not case sensitive.

shouldPdbAdminAccountBeLocked boolean
state string

A filter to return only resources that match the given lifecycle state exactly.

tdeWalletPassword string
timeCreated string

The date and time the pluggable database was created.

compartment_id str

The compartment OCID.

connection_strings GetPluggableDatabasesPluggableDatabaseConnectionString]

Connection strings to connect to an Oracle Pluggable Database.

container_database_id str

The OCID of the CDB.

defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeform_tags Mapping[str, Any]

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.

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_name str

A filter to return only pluggable databases that match the entire name given. The match is not case sensitive.

should_pdb_admin_account_be_locked bool
state str

A filter to return only resources that match the given lifecycle state exactly.

tde_wallet_password str
time_created str

The date and time the pluggable database was created.

compartmentId String

The compartment OCID.

connectionStrings List<Property Map>

Connection strings to connect to an Oracle Pluggable Database.

containerDatabaseId String

The OCID of the CDB.

definedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeformTags Map<Any>

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.

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
pdbName String

A filter to return only pluggable databases that match the entire name given. The match is not case sensitive.

shouldPdbAdminAccountBeLocked Boolean
state String

A filter to return only resources that match the given lifecycle state exactly.

tdeWalletPassword String
timeCreated String

The date and time the pluggable database was created.

GetPluggableDatabasesPluggableDatabaseConnectionString

AllConnectionStrings Dictionary<string, object>

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]interface{}

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,Object>

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]: any}

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, Any]

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

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.

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.