Oracle Cloud Infrastructure v2.28.0, Mar 27 25

Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi

oci.Database.getExternalContainerDatabases

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const testExternalContainerDatabases = oci.Database.getExternalContainerDatabases({
    compartmentId: compartmentId,
    displayName: externalContainerDatabaseDisplayName,
    state: externalContainerDatabaseState,
});

import pulumi
import pulumi_oci as oci

test_external_container_databases = oci.Database.get_external_container_databases(compartment_id=compartment_id,
    display_name=external_container_database_display_name,
    state=external_container_database_state)

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.GetExternalContainerDatabases(ctx, &database.GetExternalContainerDatabasesArgs{
			CompartmentId: compartmentId,
			DisplayName:   pulumi.StringRef(externalContainerDatabaseDisplayName),
			State:         pulumi.StringRef(externalContainerDatabaseState),
		}, 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 testExternalContainerDatabases = Oci.Database.GetExternalContainerDatabases.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = externalContainerDatabaseDisplayName,
        State = externalContainerDatabaseState,
    });

});

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.GetExternalContainerDatabasesArgs;
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 testExternalContainerDatabases = DatabaseFunctions.getExternalContainerDatabases(GetExternalContainerDatabasesArgs.builder()
            .compartmentId(compartmentId)
            .displayName(externalContainerDatabaseDisplayName)
            .state(externalContainerDatabaseState)
            .build());

    }
}

variables:
  testExternalContainerDatabases:
    fn::invoke:
      function: oci:Database:getExternalContainerDatabases
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${externalContainerDatabaseDisplayName}
        state: ${externalContainerDatabaseState}

Using getExternalContainerDatabases

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 getExternalContainerDatabases(args: GetExternalContainerDatabasesArgs, opts?: InvokeOptions): Promise<GetExternalContainerDatabasesResult>
function getExternalContainerDatabasesOutput(args: GetExternalContainerDatabasesOutputArgs, opts?: InvokeOptions): Output<GetExternalContainerDatabasesResult>

def get_external_container_databases(compartment_id: Optional[str] = None,
                                     display_name: Optional[str] = None,
                                     filters: Optional[Sequence[_database.GetExternalContainerDatabasesFilter]] = None,
                                     state: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetExternalContainerDatabasesResult
def get_external_container_databases_output(compartment_id: Optional[pulumi.Input[str]] = None,
                                     display_name: Optional[pulumi.Input[str]] = None,
                                     filters: Optional[pulumi.Input[Sequence[pulumi.Input[_database.GetExternalContainerDatabasesFilterArgs]]]] = None,
                                     state: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetExternalContainerDatabasesResult]

func GetExternalContainerDatabases(ctx *Context, args *GetExternalContainerDatabasesArgs, opts ...InvokeOption) (*GetExternalContainerDatabasesResult, error)
func GetExternalContainerDatabasesOutput(ctx *Context, args *GetExternalContainerDatabasesOutputArgs, opts ...InvokeOption) GetExternalContainerDatabasesResultOutput

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

public static class GetExternalContainerDatabases 
{
    public static Task<GetExternalContainerDatabasesResult> InvokeAsync(GetExternalContainerDatabasesArgs args, InvokeOptions? opts = null)
    public static Output<GetExternalContainerDatabasesResult> Invoke(GetExternalContainerDatabasesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetExternalContainerDatabasesResult> getExternalContainerDatabases(GetExternalContainerDatabasesArgs args, InvokeOptions options)
public static Output<GetExternalContainerDatabasesResult> getExternalContainerDatabases(GetExternalContainerDatabasesArgs args, InvokeOptions options)

fn::invoke:
  function: oci:Database/getExternalContainerDatabases:getExternalContainerDatabases
  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.
Filters List<GetExternalContainerDatabasesFilter>
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.
Filters []GetExternalContainerDatabasesFilter
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.
filters List<GetExternalContainersFilter>
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.
filters GetExternalContainerDatabasesFilter[]
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.
filters Sequence[database.GetExternalContainerDatabasesFilter]
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.
filters List<Property Map>
state String: A filter to return only resources that match the specified lifecycle state.

getExternalContainerDatabases Result

The following output properties are available:

CompartmentId string: The OCID of the compartment.
ExternalContainerDatabases List<GetExternalContainerDatabasesExternalContainerDatabase>: The list of external_container_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.
Filters List<GetExternalContainerDatabasesFilter>
State string: The current state of the Oracle Cloud Infrastructure external database resource.

CompartmentId string: The OCID of the compartment.
ExternalContainerDatabases []GetExternalContainerDatabasesExternalContainerDatabase: The list of external_container_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.
Filters []GetExternalContainerDatabasesFilter
State string: The current state of the Oracle Cloud Infrastructure external database resource.

compartmentId String: The OCID of the compartment.
externalContainerDatabases List<GetExternalContainersExternalContainer>: The list of external_container_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.
filters List<GetExternalContainersFilter>
state String: The current state of the Oracle Cloud Infrastructure external database resource.

compartmentId string: The OCID of the compartment.
externalContainerDatabases GetExternalContainerDatabasesExternalContainerDatabase[]: The list of external_container_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.
filters GetExternalContainerDatabasesFilter[]
state string: The current state of the Oracle Cloud Infrastructure external database resource.

compartment_id str: The OCID of the compartment.
external_container_databases Sequence[database.GetExternalContainerDatabasesExternalContainerDatabase]: The list of external_container_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.
filters Sequence[database.GetExternalContainerDatabasesFilter]
state str: The current state of the Oracle Cloud Infrastructure external database resource.

compartmentId String: The OCID of the compartment.
externalContainerDatabases List<Property Map>: The list of external_container_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.
filters List<Property Map>
state String: The current state of the Oracle Cloud Infrastructure external database resource.

Supporting Types

GetExternalContainerDatabasesExternalContainerDatabase

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 that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
DatabaseManagementConfigs List<GetExternalContainerDatabasesExternalContainerDatabaseDatabaseManagementConfig>: 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, string>: 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.
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 Oracle Cloud Infrastructure external database resource.
LifecycleDetails string: Additional information about the current lifecycle state.
NcharacterSet string: The national character of the external database.
StackMonitoringConfigs List<GetExternalContainerDatabasesExternalContainerDatabaseStackMonitoringConfig>: The configuration of Stack Monitoring for the external database.
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 that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
DatabaseManagementConfigs []GetExternalContainerDatabasesExternalContainerDatabaseDatabaseManagementConfig: 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]string: 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.
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 Oracle Cloud Infrastructure external database resource.
LifecycleDetails string: Additional information about the current lifecycle state.
NcharacterSet string: The national character of the external database.
StackMonitoringConfigs []GetExternalContainerDatabasesExternalContainerDatabaseStackMonitoringConfig: The configuration of Stack Monitoring for the external database.
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 that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
databaseManagementConfigs List<GetExternalContainersExternalContainerManagementConfig>: 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,String>: 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.
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 Oracle Cloud Infrastructure external database resource.
lifecycleDetails String: Additional information about the current lifecycle state.
ncharacterSet String: The national character of the external database.
stackMonitoringConfigs List<GetExternalContainersExternalContainerStackMonitoringConfig>: The configuration of Stack Monitoring for the external database.
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 that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
databaseManagementConfigs GetExternalContainerDatabasesExternalContainerDatabaseDatabaseManagementConfig[]: 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]: string}: 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.
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 Oracle Cloud Infrastructure external database resource.
lifecycleDetails string: Additional information about the current lifecycle state.
ncharacterSet string: The national character of the external database.
stackMonitoringConfigs GetExternalContainerDatabasesExternalContainerDatabaseStackMonitoringConfig[]: The configuration of Stack Monitoring for the external database.
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 that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
database_management_configs Sequence[database.GetExternalContainerDatabasesExternalContainerDatabaseDatabaseManagementConfig]: 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, str]: 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.
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 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.
stack_monitoring_configs Sequence[database.GetExternalContainerDatabasesExternalContainerDatabaseStackMonitoringConfig]: The configuration of Stack Monitoring for the external database.
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 that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
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<String>: 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.
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 Oracle Cloud Infrastructure external database resource.
lifecycleDetails String: Additional information about the current lifecycle state.
ncharacterSet String: The national character of the external database.
stackMonitoringConfigs List<Property Map>: The configuration of Stack Monitoring for the external database.
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.

GetExternalContainerDatabasesExternalContainerDatabaseDatabaseManagementConfig

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.

GetExternalContainerDatabasesExternalContainerDatabaseStackMonitoringConfig

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.

stack_monitoring_connector_id str: The OCID of the external database connector.
stack_monitoring_status str: The status of Stack Monitoring.

stackMonitoringConnectorId String: The OCID of the external database connector.
stackMonitoringStatus String: The status of Stack Monitoring.

GetExternalContainerDatabasesFilter

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: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi

pulumi/pulumi-oci

oci.Database.getExternalContainerDatabases

On this page

On this page

Example Usage

Using getExternalContainerDatabases

getExternalContainerDatabases Result

Supporting Types

GetExternalContainerDatabasesExternalContainerDatabase

GetExternalContainerDatabasesExternalContainerDatabaseDatabaseManagementConfig

GetExternalContainerDatabasesExternalContainerDatabaseStackMonitoringConfig

GetExternalContainerDatabasesFilter

Package Details

On this page

On this page