1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Database
  5. getExternalPluggableDatabase
Oracle Cloud Infrastructure v1.16.0 published on Thursday, Nov 2, 2023 by Pulumi

oci.Database.getExternalPluggableDatabase

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.16.0 published on Thursday, Nov 2, 2023 by Pulumi

    This data source provides details about a specific External Pluggable Database resource in Oracle Cloud Infrastructure Database service.

    Gets information about a specific external pluggable database resource.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testExternalPluggableDatabase = Oci.Database.GetExternalPluggableDatabase.Invoke(new()
        {
            ExternalPluggableDatabaseId = oci_database_external_pluggable_database.Test_external_pluggable_database.Id,
        });
    
    });
    
    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.GetExternalPluggableDatabase(ctx, &database.GetExternalPluggableDatabaseArgs{
    			ExternalPluggableDatabaseId: oci_database_external_pluggable_database.Test_external_pluggable_database.Id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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.GetExternalPluggableDatabaseArgs;
    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 testExternalPluggableDatabase = DatabaseFunctions.getExternalPluggableDatabase(GetExternalPluggableDatabaseArgs.builder()
                .externalPluggableDatabaseId(oci_database_external_pluggable_database.test_external_pluggable_database().id())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_oci as oci
    
    test_external_pluggable_database = oci.Database.get_external_pluggable_database(external_pluggable_database_id=oci_database_external_pluggable_database["test_external_pluggable_database"]["id"])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testExternalPluggableDatabase = oci.Database.getExternalPluggableDatabase({
        externalPluggableDatabaseId: oci_database_external_pluggable_database.test_external_pluggable_database.id,
    });
    
    variables:
      testExternalPluggableDatabase:
        fn::invoke:
          Function: oci:Database:getExternalPluggableDatabase
          Arguments:
            externalPluggableDatabaseId: ${oci_database_external_pluggable_database.test_external_pluggable_database.id}
    

    Using getExternalPluggableDatabase

    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 getExternalPluggableDatabase(args: GetExternalPluggableDatabaseArgs, opts?: InvokeOptions): Promise<GetExternalPluggableDatabaseResult>
    function getExternalPluggableDatabaseOutput(args: GetExternalPluggableDatabaseOutputArgs, opts?: InvokeOptions): Output<GetExternalPluggableDatabaseResult>
    def get_external_pluggable_database(external_pluggable_database_id: Optional[str] = None,
                                        opts: Optional[InvokeOptions] = None) -> GetExternalPluggableDatabaseResult
    def get_external_pluggable_database_output(external_pluggable_database_id: Optional[pulumi.Input[str]] = None,
                                        opts: Optional[InvokeOptions] = None) -> Output[GetExternalPluggableDatabaseResult]
    func GetExternalPluggableDatabase(ctx *Context, args *GetExternalPluggableDatabaseArgs, opts ...InvokeOption) (*GetExternalPluggableDatabaseResult, error)
    func GetExternalPluggableDatabaseOutput(ctx *Context, args *GetExternalPluggableDatabaseOutputArgs, opts ...InvokeOption) GetExternalPluggableDatabaseResultOutput

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

    public static class GetExternalPluggableDatabase 
    {
        public static Task<GetExternalPluggableDatabaseResult> InvokeAsync(GetExternalPluggableDatabaseArgs args, InvokeOptions? opts = null)
        public static Output<GetExternalPluggableDatabaseResult> Invoke(GetExternalPluggableDatabaseInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetExternalPluggableDatabaseResult> getExternalPluggableDatabase(GetExternalPluggableDatabaseArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:Database/getExternalPluggableDatabase:getExternalPluggableDatabase
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ExternalPluggableDatabaseId string

    The ExternalPluggableDatabaseId OCID.

    ExternalPluggableDatabaseId string

    The ExternalPluggableDatabaseId OCID.

    externalPluggableDatabaseId String

    The ExternalPluggableDatabaseId OCID.

    externalPluggableDatabaseId string

    The ExternalPluggableDatabaseId OCID.

    external_pluggable_database_id str

    The ExternalPluggableDatabaseId OCID.

    externalPluggableDatabaseId String

    The ExternalPluggableDatabaseId OCID.

    getExternalPluggableDatabase Result

    The following output properties are available:

    CharacterSet string

    The character set of the external database.

    CompartmentId string

    The OCID of the compartment.

    DatabaseConfiguration string

    The Oracle Database configuration

    DatabaseEdition string

    The Oracle Database edition.

    DatabaseManagementConfigs List<GetExternalPluggableDatabaseDatabaseManagementConfig>

    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

    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.

    ExternalPluggableDatabaseId string
    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<GetExternalPluggableDatabaseOperationsInsightsConfig>

    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.

    StackMonitoringConfigs List<GetExternalPluggableDatabaseStackMonitoringConfig>

    The configuration of Stack Monitoring for the external database.

    State string

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

    TimeCreated string

    The date and time the database was created.

    TimeZone string

    The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered.

    CharacterSet string

    The character set of the external database.

    CompartmentId string

    The OCID of the compartment.

    DatabaseConfiguration string

    The Oracle Database configuration

    DatabaseEdition string

    The Oracle Database edition.

    DatabaseManagementConfigs []GetExternalPluggableDatabaseDatabaseManagementConfig

    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

    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.

    ExternalPluggableDatabaseId string
    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 []GetExternalPluggableDatabaseOperationsInsightsConfig

    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.

    StackMonitoringConfigs []GetExternalPluggableDatabaseStackMonitoringConfig

    The configuration of Stack Monitoring for the external database.

    State string

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

    TimeCreated string

    The date and time the database was created.

    TimeZone string

    The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered.

    characterSet String

    The character set of the external database.

    compartmentId String

    The OCID of the compartment.

    databaseConfiguration String

    The Oracle Database configuration

    databaseEdition String

    The Oracle Database edition.

    databaseManagementConfigs List<GetExternalPluggableManagementConfig>

    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

    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.

    externalPluggableDatabaseId String
    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<GetExternalPluggableOperationsInsightsConfig>

    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.

    stackMonitoringConfigs List<GetExternalPluggableStackMonitoringConfig>

    The configuration of Stack Monitoring for the external database.

    state String

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

    timeCreated String

    The date and time the database was created.

    timeZone String

    The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered.

    characterSet string

    The character set of the external database.

    compartmentId string

    The OCID of the compartment.

    databaseConfiguration string

    The Oracle Database configuration

    databaseEdition string

    The Oracle Database edition.

    databaseManagementConfigs GetExternalPluggableDatabaseDatabaseManagementConfig[]

    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

    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.

    externalPluggableDatabaseId string
    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 GetExternalPluggableDatabaseOperationsInsightsConfig[]

    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.

    stackMonitoringConfigs GetExternalPluggableDatabaseStackMonitoringConfig[]

    The configuration of Stack Monitoring for the external database.

    state string

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

    timeCreated string

    The date and time the database was created.

    timeZone string

    The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered.

    character_set str

    The character set of the external database.

    compartment_id str

    The OCID of the compartment.

    database_configuration str

    The Oracle Database configuration

    database_edition str

    The Oracle Database edition.

    database_management_configs GetExternalPluggableDatabaseDatabaseManagementConfig]

    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

    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.

    external_pluggable_database_id str
    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 GetExternalPluggableDatabaseOperationsInsightsConfig]

    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.

    stack_monitoring_configs GetExternalPluggableDatabaseStackMonitoringConfig]

    The configuration of Stack Monitoring for the external database.

    state str

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

    time_created str

    The date and time the database was created.

    time_zone str

    The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered.

    characterSet String

    The character set of the external database.

    compartmentId String

    The OCID of the compartment.

    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

    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.

    externalPluggableDatabaseId String
    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.

    stackMonitoringConfigs List<Property Map>

    The configuration of Stack Monitoring for the external database.

    state String

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

    timeCreated String

    The date and time the database was created.

    timeZone String

    The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered.

    Supporting Types

    GetExternalPluggableDatabaseDatabaseManagementConfig

    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.

    GetExternalPluggableDatabaseOperationsInsightsConfig

    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

    GetExternalPluggableDatabaseStackMonitoringConfig

    StackMonitoringConnectorId string

    The OCID of the external database connector.

    StackMonitoringStatus string

    The status of Stack Monitoring.

    StackMonitoringConnectorId string

    The OCID of the external database connector.

    StackMonitoringStatus string

    The status of Stack Monitoring.

    stackMonitoringConnectorId String

    The OCID of the external database connector.

    stackMonitoringStatus String

    The status of Stack Monitoring.

    stackMonitoringConnectorId string

    The OCID of the external database connector.

    stackMonitoringStatus string

    The status of Stack Monitoring.

    stackMonitoringConnectorId String

    The OCID of the external database connector.

    stackMonitoringStatus String

    The status of Stack Monitoring.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the oci Terraform Provider.

    oci logo
    Oracle Cloud Infrastructure v1.16.0 published on Thursday, Nov 2, 2023 by Pulumi