Oracle Cloud Infrastructure

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

getExternalPluggableDatabases

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

Gets a list of the ExternalPluggableDatabase resources in the specified compartment.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testExternalPluggableDatabases = Output.Create(Oci.Database.GetExternalPluggableDatabases.InvokeAsync(new Oci.Database.GetExternalPluggableDatabasesArgs
        {
            CompartmentId = @var.Compartment_id,
            DisplayName = @var.External_pluggable_database_display_name,
            ExternalContainerDatabaseId = oci_database_external_container_database.Test_external_container_database.Id,
            State = @var.External_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.GetExternalPluggableDatabases(ctx, &database.GetExternalPluggableDatabasesArgs{
			CompartmentId:               _var.Compartment_id,
			DisplayName:                 pulumi.StringRef(_var.External_pluggable_database_display_name),
			ExternalContainerDatabaseId: pulumi.StringRef(oci_database_external_container_database.Test_external_container_database.Id),
			State:                       pulumi.StringRef(_var.External_pluggable_database_state),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_external_pluggable_databases = oci.Database.get_external_pluggable_databases(compartment_id=var["compartment_id"],
    display_name=var["external_pluggable_database_display_name"],
    external_container_database_id=oci_database_external_container_database["test_external_container_database"]["id"],
    state=var["external_pluggable_database_state"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testExternalPluggableDatabases = oci.Database.getExternalPluggableDatabases({
    compartmentId: _var.compartment_id,
    displayName: _var.external_pluggable_database_display_name,
    externalContainerDatabaseId: oci_database_external_container_database.test_external_container_database.id,
    state: _var.external_pluggable_database_state,
});

Coming soon!

Using getExternalPluggableDatabases

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 getExternalPluggableDatabases(args: GetExternalPluggableDatabasesArgs, opts?: InvokeOptions): Promise<GetExternalPluggableDatabasesResult>
function getExternalPluggableDatabasesOutput(args: GetExternalPluggableDatabasesOutputArgs, opts?: InvokeOptions): Output<GetExternalPluggableDatabasesResult>
def get_external_pluggable_databases(compartment_id: Optional[str] = None,
                                     display_name: Optional[str] = None,
                                     external_container_database_id: Optional[str] = None,
                                     filters: Optional[Sequence[_database.GetExternalPluggableDatabasesFilter]] = None,
                                     state: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetExternalPluggableDatabasesResult
def get_external_pluggable_databases_output(compartment_id: Optional[pulumi.Input[str]] = None,
                                     display_name: Optional[pulumi.Input[str]] = None,
                                     external_container_database_id: Optional[pulumi.Input[str]] = None,
                                     filters: Optional[pulumi.Input[Sequence[pulumi.Input[_database.GetExternalPluggableDatabasesFilterArgs]]]] = None,
                                     state: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetExternalPluggableDatabasesResult]
func GetExternalPluggableDatabases(ctx *Context, args *GetExternalPluggableDatabasesArgs, opts ...InvokeOption) (*GetExternalPluggableDatabasesResult, error)
func GetExternalPluggableDatabasesOutput(ctx *Context, args *GetExternalPluggableDatabasesOutputArgs, opts ...InvokeOption) GetExternalPluggableDatabasesResultOutput

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

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

The following arguments are supported:

CompartmentId string

The compartment OCID.

DisplayName string

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

ExternalContainerDatabaseId string

The ExternalContainerDatabase OCID.

Filters List<GetExternalPluggableDatabasesFilter>
State string

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

CompartmentId string

The compartment OCID.

DisplayName string

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

ExternalContainerDatabaseId string

The ExternalContainerDatabase OCID.

Filters []GetExternalPluggableDatabasesFilter
State string

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

compartmentId String

The compartment OCID.

displayName String

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

externalContainerDatabaseId String

The ExternalContainerDatabase OCID.

filters List<GetExternalPluggablesFilter>
state String

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

compartmentId string

The compartment OCID.

displayName string

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

externalContainerDatabaseId string

The ExternalContainerDatabase OCID.

filters GetExternalPluggableDatabasesFilter[]
state string

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

compartment_id str

The compartment OCID.

display_name str

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

external_container_database_id str

The ExternalContainerDatabase OCID.

filters GetExternalPluggableDatabasesFilter]
state str

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

compartmentId String

The compartment OCID.

displayName String

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

externalContainerDatabaseId String

The ExternalContainerDatabase OCID.

filters List<Property Map>
state String

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

getExternalPluggableDatabases Result

The following output properties are available:

CompartmentId string

The OCID of the compartment.

ExternalPluggableDatabases List<GetExternalPluggableDatabasesExternalPluggableDatabase>

The list of external_pluggable_databases.

Id string

The provider-assigned unique ID for this managed resource.

DisplayName string

The user-friendly name for the external database. The name does not have to be unique.

ExternalContainerDatabaseId string

The OCID of the external container database that contains the specified external pluggable database resource.

Filters List<GetExternalPluggableDatabasesFilter>
State string

The current state of the Oracle Cloud Infrastructure external database resource.

CompartmentId string

The OCID of the compartment.

ExternalPluggableDatabases []GetExternalPluggableDatabasesExternalPluggableDatabase

The list of external_pluggable_databases.

Id string

The provider-assigned unique ID for this managed resource.

DisplayName string

The user-friendly name for the external database. The name does not have to be unique.

ExternalContainerDatabaseId string

The OCID of the external container database that contains the specified external pluggable database resource.

Filters []GetExternalPluggableDatabasesFilter
State string

The current state of the Oracle Cloud Infrastructure external database resource.

compartmentId String

The OCID of the compartment.

externalPluggableDatabases List<GetExternalPluggablesExternalPluggable>

The list of external_pluggable_databases.

id String

The provider-assigned unique ID for this managed resource.

displayName String

The user-friendly name for the external database. The name does not have to be unique.

externalContainerDatabaseId String

The OCID of the external container database that contains the specified external pluggable database resource.

filters List<GetExternalPluggablesFilter>
state String

The current state of the Oracle Cloud Infrastructure external database resource.

compartmentId string

The OCID of the compartment.

externalPluggableDatabases GetExternalPluggableDatabasesExternalPluggableDatabase[]

The list of external_pluggable_databases.

id string

The provider-assigned unique ID for this managed resource.

displayName string

The user-friendly name for the external database. The name does not have to be unique.

externalContainerDatabaseId string

The OCID of the external container database that contains the specified external pluggable database resource.

filters GetExternalPluggableDatabasesFilter[]
state string

The current state of the Oracle Cloud Infrastructure external database resource.

compartment_id str

The OCID of the compartment.

external_pluggable_databases GetExternalPluggableDatabasesExternalPluggableDatabase]

The list of external_pluggable_databases.

id str

The provider-assigned unique ID for this managed resource.

display_name str

The user-friendly name for the external database. The name does not have to be unique.

external_container_database_id str

The OCID of the external container database that contains the specified external pluggable database resource.

filters GetExternalPluggableDatabasesFilter]
state str

The current state of the Oracle Cloud Infrastructure external database resource.

compartmentId String

The OCID of the compartment.

externalPluggableDatabases List<Property Map>

The list of external_pluggable_databases.

id String

The provider-assigned unique ID for this managed resource.

displayName String

The user-friendly name for the external database. The name does not have to be unique.

externalContainerDatabaseId String

The OCID of the external container database that contains the specified external pluggable database resource.

filters List<Property Map>
state String

The current state of the Oracle Cloud Infrastructure external database resource.

Supporting Types

GetExternalPluggableDatabasesExternalPluggableDatabase

CharacterSet string

The character set of the external database.

CompartmentId string

The compartment OCID.

DatabaseConfiguration string

The Oracle Database configuration

DatabaseEdition string

The Oracle Database edition.

DatabaseManagementConfigs List<GetExternalPluggableDatabasesExternalPluggableDatabaseDatabaseManagementConfig>

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

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

DisplayName string

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

ExternalContainerDatabaseId string

The ExternalContainerDatabase OCID.

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 Oracle Cloud Infrastructure external database resource.

LifecycleDetails string

Additional information about the current lifecycle state.

NcharacterSet string

The national character of the external database.

OperationsInsightsConfigs List<GetExternalPluggableDatabasesExternalPluggableDatabaseOperationsInsightsConfig>

The configuration of Operations Insights for the external database

SourceId string

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

State string

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

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

The compartment OCID.

DatabaseConfiguration string

The Oracle Database configuration

DatabaseEdition string

The Oracle Database edition.

DatabaseManagementConfigs []GetExternalPluggableDatabasesExternalPluggableDatabaseDatabaseManagementConfig

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

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

DisplayName string

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

ExternalContainerDatabaseId string

The ExternalContainerDatabase OCID.

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 Oracle Cloud Infrastructure external database resource.

LifecycleDetails string

Additional information about the current lifecycle state.

NcharacterSet string

The national character of the external database.

OperationsInsightsConfigs []GetExternalPluggableDatabasesExternalPluggableDatabaseOperationsInsightsConfig

The configuration of Operations Insights for the external database

SourceId string

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

State string

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

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

The compartment OCID.

databaseConfiguration String

The Oracle Database configuration

databaseEdition String

The Oracle Database edition.

databaseManagementConfigs List<GetExternalPluggablesExternalPluggableManagementConfig>

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

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

displayName String

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

externalContainerDatabaseId String

The ExternalContainerDatabase OCID.

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 Oracle Cloud Infrastructure external database resource.

lifecycleDetails String

Additional information about the current lifecycle state.

ncharacterSet String

The national character of the external database.

operationsInsightsConfigs List<GetExternalPluggablesExternalPluggableOperationsInsightsConfig>

The configuration of Operations Insights for the external database

sourceId String

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

state String

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

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

The compartment OCID.

databaseConfiguration string

The Oracle Database configuration

databaseEdition string

The Oracle Database edition.

databaseManagementConfigs GetExternalPluggableDatabasesExternalPluggableDatabaseDatabaseManagementConfig[]

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

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

displayName string

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

externalContainerDatabaseId string

The ExternalContainerDatabase OCID.

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 Oracle Cloud Infrastructure external database resource.

lifecycleDetails string

Additional information about the current lifecycle state.

ncharacterSet string

The national character of the external database.

operationsInsightsConfigs GetExternalPluggableDatabasesExternalPluggableDatabaseOperationsInsightsConfig[]

The configuration of Operations Insights for the external database

sourceId string

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

state string

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

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

The compartment OCID.

database_configuration str

The Oracle Database configuration

database_edition str

The Oracle Database edition.

database_management_configs GetExternalPluggableDatabasesExternalPluggableDatabaseDatabaseManagementConfig]

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

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

display_name str

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

external_container_database_id str

The ExternalContainerDatabase OCID.

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 Oracle Cloud Infrastructure external database resource.

lifecycle_details str

Additional information about the current lifecycle state.

ncharacter_set str

The national character of the external database.

operations_insights_configs GetExternalPluggableDatabasesExternalPluggableDatabaseOperationsInsightsConfig]

The configuration of Operations Insights for the external database

source_id str

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

state str

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

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

The compartment OCID.

databaseConfiguration String

The Oracle Database configuration

databaseEdition String

The Oracle Database edition.

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

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

displayName String

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

externalContainerDatabaseId String

The ExternalContainerDatabase OCID.

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 Oracle Cloud Infrastructure external database 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

sourceId String

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

state String

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

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.

GetExternalPluggableDatabasesExternalPluggableDatabaseDatabaseManagementConfig

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.

GetExternalPluggableDatabasesExternalPluggableDatabaseOperationsInsightsConfig

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

GetExternalPluggableDatabasesFilter

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

Package Details

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

This Pulumi package is based on the oci Terraform Provider.