Oracle Cloud Infrastructure v2.33.0, May 1 25

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

oci.Database.getDatabase

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

Example Usage

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

const testDatabase = oci.Database.getDatabase({
    databaseId: databaseId,
});

import pulumi
import pulumi_oci as oci

test_database = oci.Database.get_database(database_id=database_id)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := database.GetDatabase(ctx, &database.GetDatabaseArgs{
			DatabaseId: databaseId,
		}, 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 testDatabase = Oci.Database.GetDatabase.Invoke(new()
    {
        DatabaseId = databaseId,
    });

});

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.GetDatabaseArgs;
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 testDatabase = DatabaseFunctions.getDatabase(GetDatabaseArgs.builder()
            .databaseId(databaseId)
            .build());

    }
}

variables:
  testDatabase:
    fn::invoke:
      function: oci:Database:getDatabase
      arguments:
        databaseId: ${databaseId}

Using getDatabase

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 getDatabase(args: GetDatabaseArgs, opts?: InvokeOptions): Promise<GetDatabaseResult>
function getDatabaseOutput(args: GetDatabaseOutputArgs, opts?: InvokeOptions): Output<GetDatabaseResult>

def get_database(database_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetDatabaseResult
def get_database_output(database_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseResult]

func LookupDatabase(ctx *Context, args *LookupDatabaseArgs, opts ...InvokeOption) (*LookupDatabaseResult, error)
func LookupDatabaseOutput(ctx *Context, args *LookupDatabaseOutputArgs, opts ...InvokeOption) LookupDatabaseResultOutput

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

public static class GetDatabase 
{
    public static Task<GetDatabaseResult> InvokeAsync(GetDatabaseArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseResult> Invoke(GetDatabaseInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDatabaseResult> getDatabase(GetDatabaseArgs args, InvokeOptions options)
public static Output<GetDatabaseResult> getDatabase(GetDatabaseArgs args, InvokeOptions options)

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

The following arguments are supported:

DatabaseId string: The database OCID.

DatabaseId string: The database OCID.

databaseId String: The database OCID.

databaseId string: The database OCID.

database_id str: The database OCID.

databaseId String: The database OCID.

getDatabase Result

The following output properties are available:

ActionTrigger int
CharacterSet string: The character set for the database.
CompartmentId string: The OCID of the compartment.
ConnectionStrings List<GetDatabaseConnectionString>: The Connection strings used to connect to the Oracle Database.
DataGuardAction string
DataGuardGroups List<GetDatabaseDataGuardGroup>: Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
DatabaseId string: The OCID of the Database.
DatabaseManagementConfigs List<GetDatabaseDatabaseManagementConfig>: The configuration of the Database Management service.
DatabaseSoftwareImageId string: The database software image OCID
Databases List<GetDatabaseDatabase>
DbBackupConfigs List<GetDatabaseDbBackupConfig>: Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
DbHomeId string: The OCID of the Database Home.
DbName string: The database name.
DbSystemId string: The OCID of the DB system.
DbUniqueName string: A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
DbVersion string
DbWorkload string: Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
FreeformTags Dictionary<string, string>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: The OCID of the database.
IsCdb bool: True if the database is a container database.
KeyStoreId string: The OCID of the key store of Oracle Vault.
KeyStoreWalletName string: The wallet name for Oracle Key Vault.
KmsKeyId string: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
KmsKeyMigration bool
KmsKeyRotation int
KmsKeyVersionId string: The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
LastBackupDurationInSeconds int: The duration when the latest database backup created.
LastBackupTimestamp string: The date and time when the latest database backup was created.
LastFailedBackupTimestamp string: The date and time when the latest database backup failed.
LifecycleDetails string: Additional information about the current lifecycle state.
NcharacterSet string: The national character set for the database.
PdbName string: The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
SidPrefix string: Specifies a prefix for the Oracle SID of the database to be created.
Source string
SourceDatabasePointInTimeRecoveryTimestamp string: Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
State string: The current state of the database.
TimeCreated string: The date and time the database was created.
VaultId string: The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
VmClusterId string: The OCID of the VM cluster.

ActionTrigger int
CharacterSet string: The character set for the database.
CompartmentId string: The OCID of the compartment.
ConnectionStrings []GetDatabaseConnectionString: The Connection strings used to connect to the Oracle Database.
DataGuardAction string
DataGuardGroups []GetDatabaseDataGuardGroup: Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
DatabaseId string: The OCID of the Database.
DatabaseManagementConfigs []GetDatabaseDatabaseManagementConfig: The configuration of the Database Management service.
DatabaseSoftwareImageId string: The database software image OCID
Databases []GetDatabaseDatabase
DbBackupConfigs []GetDatabaseDbBackupConfig: Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
DbHomeId string: The OCID of the Database Home.
DbName string: The database name.
DbSystemId string: The OCID of the DB system.
DbUniqueName string: A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
DbVersion string
DbWorkload string: Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
FreeformTags map[string]string: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: The OCID of the database.
IsCdb bool: True if the database is a container database.
KeyStoreId string: The OCID of the key store of Oracle Vault.
KeyStoreWalletName string: The wallet name for Oracle Key Vault.
KmsKeyId string: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
KmsKeyMigration bool
KmsKeyRotation int
KmsKeyVersionId string: The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
LastBackupDurationInSeconds int: The duration when the latest database backup created.
LastBackupTimestamp string: The date and time when the latest database backup was created.
LastFailedBackupTimestamp string: The date and time when the latest database backup failed.
LifecycleDetails string: Additional information about the current lifecycle state.
NcharacterSet string: The national character set for the database.
PdbName string: The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
SidPrefix string: Specifies a prefix for the Oracle SID of the database to be created.
Source string
SourceDatabasePointInTimeRecoveryTimestamp string: Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
State string: The current state of the database.
TimeCreated string: The date and time the database was created.
VaultId string: The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
VmClusterId string: The OCID of the VM cluster.

actionTrigger Integer
characterSet String: The character set for the database.
compartmentId String: The OCID of the compartment.
connectionStrings List<GetConnectionString>: The Connection strings used to connect to the Oracle Database.
dataGuardAction String
dataGuardGroups List<GetDataGuardGroup>: Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
databaseId String: The OCID of the Database.
databaseManagementConfigs List<GetManagementConfig>: The configuration of the Database Management service.
databaseSoftwareImageId String: The database software image OCID
databases List<Get>
dbBackupConfigs List<GetDbBackupConfig>: Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
dbHomeId String: The OCID of the Database Home.
dbName String: The database name.
dbSystemId String: The OCID of the DB system.
dbUniqueName String: A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
dbVersion String
dbWorkload String: Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
freeformTags Map<String,String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: The OCID of the database.
isCdb Boolean: True if the database is a container database.
keyStoreId String: The OCID of the key store of Oracle Vault.
keyStoreWalletName String: The wallet name for Oracle Key Vault.
kmsKeyId String: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyMigration Boolean
kmsKeyRotation Integer
kmsKeyVersionId String: The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
lastBackupDurationInSeconds Integer: The duration when the latest database backup created.
lastBackupTimestamp String: The date and time when the latest database backup was created.
lastFailedBackupTimestamp String: The date and time when the latest database backup failed.
lifecycleDetails String: Additional information about the current lifecycle state.
ncharacterSet String: The national character set for the database.
pdbName String: The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
sidPrefix String: Specifies a prefix for the Oracle SID of the database to be created.
source String
sourceDatabasePointInTimeRecoveryTimestamp String: Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
state String: The current state of the database.
timeCreated String: The date and time the database was created.
vaultId String: The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
vmClusterId String: The OCID of the VM cluster.

actionTrigger number
characterSet string: The character set for the database.
compartmentId string: The OCID of the compartment.
connectionStrings GetDatabaseConnectionString[]: The Connection strings used to connect to the Oracle Database.
dataGuardAction string
dataGuardGroups GetDatabaseDataGuardGroup[]: Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
databaseId string: The OCID of the Database.
databaseManagementConfigs GetDatabaseDatabaseManagementConfig[]: The configuration of the Database Management service.
databaseSoftwareImageId string: The database software image OCID
databases GetDatabaseDatabase[]
dbBackupConfigs GetDatabaseDbBackupConfig[]: Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
dbHomeId string: The OCID of the Database Home.
dbName string: The database name.
dbSystemId string: The OCID of the DB system.
dbUniqueName string: A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
dbVersion string
dbWorkload string: Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
freeformTags {[key: string]: string}: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id string: The OCID of the database.
isCdb boolean: True if the database is a container database.
keyStoreId string: The OCID of the key store of Oracle Vault.
keyStoreWalletName string: The wallet name for Oracle Key Vault.
kmsKeyId string: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyMigration boolean
kmsKeyRotation number
kmsKeyVersionId string: The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
lastBackupDurationInSeconds number: The duration when the latest database backup created.
lastBackupTimestamp string: The date and time when the latest database backup was created.
lastFailedBackupTimestamp string: The date and time when the latest database backup failed.
lifecycleDetails string: Additional information about the current lifecycle state.
ncharacterSet string: The national character set for the database.
pdbName string: The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
sidPrefix string: Specifies a prefix for the Oracle SID of the database to be created.
source string
sourceDatabasePointInTimeRecoveryTimestamp string: Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
state string: The current state of the database.
timeCreated string: The date and time the database was created.
vaultId string: The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
vmClusterId string: The OCID of the VM cluster.

action_trigger int
character_set str: The character set for the database.
compartment_id str: The OCID of the compartment.
connection_strings Sequence[GetDatabaseConnectionString]: The Connection strings used to connect to the Oracle Database.
data_guard_action str
data_guard_groups Sequence[GetDatabaseDataGuardGroup]: Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
database_id str: The OCID of the Database.
database_management_configs Sequence[GetDatabaseDatabaseManagementConfig]: The configuration of the Database Management service.
database_software_image_id str: The database software image OCID
databases Sequence[GetDatabaseDatabase]
db_backup_configs Sequence[GetDatabaseDbBackupConfig]: Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
db_home_id str: The OCID of the Database Home.
db_name str: The database name.
db_system_id str: The OCID of the DB system.
db_unique_name str: A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
db_version str
db_workload str: Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
freeform_tags Mapping[str, str]: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id str: The OCID of the database.
is_cdb bool: True if the database is a container database.
key_store_id str: The OCID of the key store of Oracle Vault.
key_store_wallet_name str: The wallet name for Oracle Key Vault.
kms_key_id str: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kms_key_migration bool
kms_key_rotation int
kms_key_version_id str: The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
last_backup_duration_in_seconds int: The duration when the latest database backup created.
last_backup_timestamp str: The date and time when the latest database backup was created.
last_failed_backup_timestamp str: The date and time when the latest database backup failed.
lifecycle_details str: Additional information about the current lifecycle state.
ncharacter_set str: The national character set for the database.
pdb_name str: The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
sid_prefix str: Specifies a prefix for the Oracle SID of the database to be created.
source str
source_database_point_in_time_recovery_timestamp str: Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
state str: The current state of the database.
time_created str: The date and time the database was created.
vault_id str: The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
vm_cluster_id str: The OCID of the VM cluster.

actionTrigger Number
characterSet String: The character set for the database.
compartmentId String: The OCID of the compartment.
connectionStrings List<Property Map>: The Connection strings used to connect to the Oracle Database.
dataGuardAction String
dataGuardGroups List<Property Map>: Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
databaseId String: The OCID of the Database.
databaseManagementConfigs List<Property Map>: The configuration of the Database Management service.
databaseSoftwareImageId String: The database software image OCID
databases List<Property Map>
dbBackupConfigs List<Property Map>: Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
dbHomeId String: The OCID of the Database Home.
dbName String: The database name.
dbSystemId String: The OCID of the DB system.
dbUniqueName String: A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
dbVersion String
dbWorkload String: Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
freeformTags Map<String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: The OCID of the database.
isCdb Boolean: True if the database is a container database.
keyStoreId String: The OCID of the key store of Oracle Vault.
keyStoreWalletName String: The wallet name for Oracle Key Vault.
kmsKeyId String: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyMigration Boolean
kmsKeyRotation Number
kmsKeyVersionId String: The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
lastBackupDurationInSeconds Number: The duration when the latest database backup created.
lastBackupTimestamp String: The date and time when the latest database backup was created.
lastFailedBackupTimestamp String: The date and time when the latest database backup failed.
lifecycleDetails String: Additional information about the current lifecycle state.
ncharacterSet String: The national character set for the database.
pdbName String: The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
sidPrefix String: Specifies a prefix for the Oracle SID of the database to be created.
source String
sourceDatabasePointInTimeRecoveryTimestamp String: Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
state String: The current state of the database.
timeCreated String: The date and time the database was created.
vaultId String: The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
vmClusterId String: The OCID of the VM cluster.

Supporting Types

GetDatabaseConnectionString

AllConnectionStrings Dictionary<string, string>: All connection strings to use to connect to the Database.
CdbDefault string: Host name based CDB Connection String.
CdbIpDefault string: IP based CDB Connection String.

AllConnectionStrings map[string]string: All connection strings to use to connect to the Database.
CdbDefault string: Host name based CDB Connection String.
CdbIpDefault string: IP based CDB Connection String.

allConnectionStrings Map<String,String>: All connection strings to use to connect to the Database.
cdbDefault String: Host name based CDB Connection String.
cdbIpDefault String: IP based CDB Connection String.

allConnectionStrings {[key: string]: string}: All connection strings to use to connect to the Database.
cdbDefault string: Host name based CDB Connection String.
cdbIpDefault string: IP based CDB Connection String.

all_connection_strings Mapping[str, str]: All connection strings to use to connect to the Database.
cdb_default str: Host name based CDB Connection String.
cdb_ip_default str: IP based CDB Connection String.

allConnectionStrings Map<String>: All connection strings to use to connect to the Database.
cdbDefault String: Host name based CDB Connection String.
cdbIpDefault String: IP based CDB Connection String.

GetDatabaseDataGuardGroup

Members List<GetDatabaseDataGuardGroupMember>: List of Data Guard members, representing each database that is part of Data Guard.
ProtectionMode string: The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

Members []GetDatabaseDataGuardGroupMember: List of Data Guard members, representing each database that is part of Data Guard.
ProtectionMode string: The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

members List<GetDataGuardGroupMember>: List of Data Guard members, representing each database that is part of Data Guard.
protectionMode String: The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

members GetDatabaseDataGuardGroupMember[]: List of Data Guard members, representing each database that is part of Data Guard.
protectionMode string: The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

members Sequence[GetDatabaseDataGuardGroupMember]: List of Data Guard members, representing each database that is part of Data Guard.
protection_mode str: The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

members List<Property Map>: List of Data Guard members, representing each database that is part of Data Guard.
protectionMode String: The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

GetDatabaseDataGuardGroupMember

ApplyLag string

The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 1 second

ApplyRate string

The rate at which redo logs are synced between the associated databases. Example: 102.96 MByte/s

DatabaseId string

The database OCID.

DbSystemId string

The OCID of the DB system.

IsActiveDataGuardEnabled bool

True if active Data Guard is enabled.

Role string

The role of the reporting database in this Data Guard association.

TransportLag string

The rate at which redo logs are transported between the associated databases. Example: 1 second

TransportLagRefresh string

The date and time when last redo transport has been done.

TransportType string

The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
MAXIMUM_PERFORMANCE - ASYNC
MAXIMUM_PROTECTION - SYNC

ApplyLag string

The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 1 second

ApplyRate string

The rate at which redo logs are synced between the associated databases. Example: 102.96 MByte/s

DatabaseId string

The database OCID.

DbSystemId string

The OCID of the DB system.

IsActiveDataGuardEnabled bool

True if active Data Guard is enabled.

Role string

The role of the reporting database in this Data Guard association.

TransportLag string

The rate at which redo logs are transported between the associated databases. Example: 1 second

TransportLagRefresh string

The date and time when last redo transport has been done.

TransportType string

The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
MAXIMUM_PERFORMANCE - ASYNC
MAXIMUM_PROTECTION - SYNC

applyLag String

The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 1 second

applyRate String

The rate at which redo logs are synced between the associated databases. Example: 102.96 MByte/s

databaseId String

The database OCID.

dbSystemId String

The OCID of the DB system.

isActiveDataGuardEnabled Boolean

True if active Data Guard is enabled.

role String

The role of the reporting database in this Data Guard association.

transportLag String

The rate at which redo logs are transported between the associated databases. Example: 1 second

transportLagRefresh String

The date and time when last redo transport has been done.

transportType String

The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
MAXIMUM_PERFORMANCE - ASYNC
MAXIMUM_PROTECTION - SYNC

applyLag string

The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 1 second

applyRate string

The rate at which redo logs are synced between the associated databases. Example: 102.96 MByte/s

databaseId string

The database OCID.

dbSystemId string

The OCID of the DB system.

isActiveDataGuardEnabled boolean

True if active Data Guard is enabled.

role string

The role of the reporting database in this Data Guard association.

transportLag string

The rate at which redo logs are transported between the associated databases. Example: 1 second

transportLagRefresh string

The date and time when last redo transport has been done.

transportType string

The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
MAXIMUM_PERFORMANCE - ASYNC
MAXIMUM_PROTECTION - SYNC

apply_lag str

The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 1 second

apply_rate str

The rate at which redo logs are synced between the associated databases. Example: 102.96 MByte/s

database_id str

The database OCID.

db_system_id str

The OCID of the DB system.

is_active_data_guard_enabled bool

True if active Data Guard is enabled.

role str

The role of the reporting database in this Data Guard association.

transport_lag str

The rate at which redo logs are transported between the associated databases. Example: 1 second

transport_lag_refresh str

The date and time when last redo transport has been done.

transport_type str

The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
MAXIMUM_PERFORMANCE - ASYNC
MAXIMUM_PROTECTION - SYNC

applyLag String

The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 1 second

applyRate String

The rate at which redo logs are synced between the associated databases. Example: 102.96 MByte/s

databaseId String

The database OCID.

dbSystemId String

The OCID of the DB system.

isActiveDataGuardEnabled Boolean

True if active Data Guard is enabled.

role String

The role of the reporting database in this Data Guard association.

transportLag String

The rate at which redo logs are transported between the associated databases. Example: 1 second

transportLagRefresh String

The date and time when last redo transport has been done.

transportType String

The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
MAXIMUM_PERFORMANCE - ASYNC
MAXIMUM_PROTECTION - SYNC

GetDatabaseDatabase

AdminPassword string

BackupId string

BackupTdePassword string

CharacterSet string

The character set for the database.

DatabaseAdminPassword string

DatabaseSoftwareImageId string

The database software image OCID

DbBackupConfigs List<GetDatabaseDatabaseDbBackupConfig>

Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

DbName string

The database name.

DbUniqueName string

A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.

DbWorkload string

Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.

DefinedTags Dictionary<string, string>

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

EncryptionKeyLocationDetails List<GetDatabaseDatabaseEncryptionKeyLocationDetail>

Types of providers supported for managing database encryption keys

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"}

IsActiveDataGuardEnabled bool

True if active Data Guard is enabled.

KmsKeyId string

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

KmsKeyVersionId string

The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.

NcharacterSet string

The national character set for the database.

PdbName string

The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.

PluggableDatabases List<string>

ProtectionMode string

The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

SidPrefix string

Specifies a prefix for the Oracle SID of the database to be created.

SourceDatabaseId string

SourceEncryptionKeyLocationDetails List<GetDatabaseDatabaseSourceEncryptionKeyLocationDetail>

SourceTdeWalletPassword string

TdeWalletPassword string

TransportType string

The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
MAXIMUM_PERFORMANCE - ASYNC
MAXIMUM_PROTECTION - SYNC

VaultId string

The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

AdminPassword string

BackupId string

BackupTdePassword string

CharacterSet string

The character set for the database.

DatabaseAdminPassword string

DatabaseSoftwareImageId string

The database software image OCID

DbBackupConfigs []GetDatabaseDatabaseDbBackupConfig

DbName string

The database name.

DbUniqueName string

A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.

DbWorkload string

DefinedTags map[string]string

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

EncryptionKeyLocationDetails []GetDatabaseDatabaseEncryptionKeyLocationDetail

Types of providers supported for managing database encryption keys

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"}

IsActiveDataGuardEnabled bool

True if active Data Guard is enabled.

KmsKeyId string

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

KmsKeyVersionId string

NcharacterSet string

The national character set for the database.

PdbName string

PluggableDatabases []string

ProtectionMode string

The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

SidPrefix string

Specifies a prefix for the Oracle SID of the database to be created.

SourceDatabaseId string

SourceEncryptionKeyLocationDetails []GetDatabaseDatabaseSourceEncryptionKeyLocationDetail

SourceTdeWalletPassword string

TdeWalletPassword string

TransportType string

The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
MAXIMUM_PERFORMANCE - ASYNC
MAXIMUM_PROTECTION - SYNC

VaultId string

The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

adminPassword String

backupId String

backupTdePassword String

characterSet String

The character set for the database.

databaseAdminPassword String

databaseSoftwareImageId String

The database software image OCID

dbBackupConfigs List<GetDbBackupConfig>

dbName String

The database name.

dbUniqueName String

A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.

dbWorkload String

definedTags Map<String,String>

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

encryptionKeyLocationDetails List<GetEncryptionKeyLocationDetail>

Types of providers supported for managing database encryption keys

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"}

isActiveDataGuardEnabled Boolean

True if active Data Guard is enabled.

kmsKeyId String

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

kmsKeyVersionId String

ncharacterSet String

The national character set for the database.

pdbName String

pluggableDatabases List<String>

protectionMode String

The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

sidPrefix String

Specifies a prefix for the Oracle SID of the database to be created.

sourceDatabaseId String

sourceEncryptionKeyLocationDetails List<GetSourceEncryptionKeyLocationDetail>

sourceTdeWalletPassword String

tdeWalletPassword String

transportType String

The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
MAXIMUM_PERFORMANCE - ASYNC
MAXIMUM_PROTECTION - SYNC

vaultId String

The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

adminPassword string

backupId string

backupTdePassword string

characterSet string

The character set for the database.

databaseAdminPassword string

databaseSoftwareImageId string

The database software image OCID

dbBackupConfigs GetDatabaseDatabaseDbBackupConfig[]

dbName string

The database name.

dbUniqueName string

A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.

dbWorkload string

definedTags {[key: string]: string}

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

encryptionKeyLocationDetails GetDatabaseDatabaseEncryptionKeyLocationDetail[]

Types of providers supported for managing database encryption keys

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"}

isActiveDataGuardEnabled boolean

True if active Data Guard is enabled.

kmsKeyId string

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

kmsKeyVersionId string

ncharacterSet string

The national character set for the database.

pdbName string

pluggableDatabases string[]

protectionMode string

The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

sidPrefix string

Specifies a prefix for the Oracle SID of the database to be created.

sourceDatabaseId string

sourceEncryptionKeyLocationDetails GetDatabaseDatabaseSourceEncryptionKeyLocationDetail[]

sourceTdeWalletPassword string

tdeWalletPassword string

transportType string

The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
MAXIMUM_PERFORMANCE - ASYNC
MAXIMUM_PROTECTION - SYNC

vaultId string

The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

admin_password str

backup_id str

backup_tde_password str

character_set str

The character set for the database.

database_admin_password str

database_software_image_id str

The database software image OCID

db_backup_configs Sequence[GetDatabaseDatabaseDbBackupConfig]

db_name str

The database name.

db_unique_name str

A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.

db_workload str

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.

encryption_key_location_details Sequence[GetDatabaseDatabaseEncryptionKeyLocationDetail]

Types of providers supported for managing database encryption keys

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"}

is_active_data_guard_enabled bool

True if active Data Guard is enabled.

kms_key_id str

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

kms_key_version_id str

ncharacter_set str

The national character set for the database.

pdb_name str

pluggable_databases Sequence[str]

protection_mode str

The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

sid_prefix str

Specifies a prefix for the Oracle SID of the database to be created.

source_database_id str

source_encryption_key_location_details Sequence[GetDatabaseDatabaseSourceEncryptionKeyLocationDetail]

source_tde_wallet_password str

tde_wallet_password str

transport_type str

The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
MAXIMUM_PERFORMANCE - ASYNC
MAXIMUM_PROTECTION - SYNC

vault_id str

The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

adminPassword String

backupId String

backupTdePassword String

characterSet String

The character set for the database.

databaseAdminPassword String

databaseSoftwareImageId String

The database software image OCID

dbBackupConfigs List<Property Map>

dbName String

The database name.

dbUniqueName String

A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.

dbWorkload String

definedTags Map<String>

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

encryptionKeyLocationDetails List<Property Map>

Types of providers supported for managing database encryption keys

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"}

isActiveDataGuardEnabled Boolean

True if active Data Guard is enabled.

kmsKeyId String

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

kmsKeyVersionId String

ncharacterSet String

The national character set for the database.

pdbName String

pluggableDatabases List<String>

protectionMode String

The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

sidPrefix String

Specifies a prefix for the Oracle SID of the database to be created.

sourceDatabaseId String

sourceEncryptionKeyLocationDetails List<Property Map>

sourceTdeWalletPassword String

tdeWalletPassword String

transportType String

The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
MAXIMUM_PERFORMANCE - ASYNC
MAXIMUM_PROTECTION - SYNC

vaultId String

The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

GetDatabaseDatabaseDbBackupConfig

AutoBackupEnabled bool: If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
AutoBackupWindow string: Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
AutoFullBackupDay string: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
AutoFullBackupWindow string: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
BackupDeletionPolicy string: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
BackupDestinationDetails List<GetDatabaseDatabaseDbBackupConfigBackupDestinationDetail>: Backup destination details.
RecoveryWindowInDays int: Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
RunImmediateFullBackup bool: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

AutoBackupEnabled bool: If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
AutoBackupWindow string: Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
AutoFullBackupDay string: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
AutoFullBackupWindow string: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
BackupDeletionPolicy string: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
BackupDestinationDetails []GetDatabaseDatabaseDbBackupConfigBackupDestinationDetail: Backup destination details.
RecoveryWindowInDays int: Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
RunImmediateFullBackup bool: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

autoBackupEnabled Boolean: If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
autoBackupWindow String: Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
autoFullBackupDay String: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
autoFullBackupWindow String: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
backupDeletionPolicy String: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
backupDestinationDetails List<GetDbBackupConfigBackupDestinationDetail>: Backup destination details.
recoveryWindowInDays Integer: Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
runImmediateFullBackup Boolean: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

autoBackupEnabled boolean: If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
autoBackupWindow string: Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
autoFullBackupDay string: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
autoFullBackupWindow string: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
backupDeletionPolicy string: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
backupDestinationDetails GetDatabaseDatabaseDbBackupConfigBackupDestinationDetail[]: Backup destination details.
recoveryWindowInDays number: Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
runImmediateFullBackup boolean: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

auto_backup_enabled bool: If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
auto_backup_window str: Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
auto_full_backup_day str: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
auto_full_backup_window str: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
backup_deletion_policy str: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
backup_destination_details Sequence[GetDatabaseDatabaseDbBackupConfigBackupDestinationDetail]: Backup destination details.
recovery_window_in_days int: Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
run_immediate_full_backup bool: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

autoBackupEnabled Boolean: If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
autoBackupWindow String: Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
autoFullBackupDay String: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
autoFullBackupWindow String: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
backupDeletionPolicy String: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
backupDestinationDetails List<Property Map>: Backup destination details.
recoveryWindowInDays Number: Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
runImmediateFullBackup Boolean: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

GetDatabaseDatabaseDbBackupConfigBackupDestinationDetail

DbrsPolicyId string: The OCID of the DBRS policy used for backup.
Id string: The OCID of the database.
Type string: Type of the database backup destination.
VpcUser string

DbrsPolicyId string: The OCID of the DBRS policy used for backup.
Id string: The OCID of the database.
Type string: Type of the database backup destination.
VpcUser string

dbrsPolicyId String: The OCID of the DBRS policy used for backup.
id String: The OCID of the database.
type String: Type of the database backup destination.
vpcUser String

dbrsPolicyId string: The OCID of the DBRS policy used for backup.
id string: The OCID of the database.
type string: Type of the database backup destination.
vpcUser string

dbrs_policy_id str: The OCID of the DBRS policy used for backup.
id str: The OCID of the database.
type str: Type of the database backup destination.
vpc_user str

dbrsPolicyId String: The OCID of the DBRS policy used for backup.
id String: The OCID of the database.
type String: Type of the database backup destination.
vpcUser String

GetDatabaseDatabaseEncryptionKeyLocationDetail

HsmPassword string: Provide the HSM password as you would in RDBMS for External HSM.
ProviderType string: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

HsmPassword string: Provide the HSM password as you would in RDBMS for External HSM.
ProviderType string: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

hsmPassword String: Provide the HSM password as you would in RDBMS for External HSM.
providerType String: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

hsmPassword string: Provide the HSM password as you would in RDBMS for External HSM.
providerType string: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

hsm_password str: Provide the HSM password as you would in RDBMS for External HSM.
provider_type str: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

hsmPassword String: Provide the HSM password as you would in RDBMS for External HSM.
providerType String: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

GetDatabaseDatabaseManagementConfig

ManagementStatus string: The status of the Database Management service.
ManagementType string: The Database Management type.

ManagementStatus string: The status of the Database Management service.
ManagementType string: The Database Management type.

managementStatus String: The status of the Database Management service.
managementType String: The Database Management type.

managementStatus string: The status of the Database Management service.
managementType string: The Database Management type.

management_status str: The status of the Database Management service.
management_type str: The Database Management type.

managementStatus String: The status of the Database Management service.
managementType String: The Database Management type.

GetDatabaseDatabaseSourceEncryptionKeyLocationDetail

HsmPassword string: Provide the HSM password as you would in RDBMS for External HSM.
ProviderType string: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

HsmPassword string: Provide the HSM password as you would in RDBMS for External HSM.
ProviderType string: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

hsmPassword String: Provide the HSM password as you would in RDBMS for External HSM.
providerType String: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

hsmPassword string: Provide the HSM password as you would in RDBMS for External HSM.
providerType string: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

hsm_password str: Provide the HSM password as you would in RDBMS for External HSM.
provider_type str: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

hsmPassword String: Provide the HSM password as you would in RDBMS for External HSM.
providerType String: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

GetDatabaseDbBackupConfig

AutoBackupEnabled bool: If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
AutoBackupWindow string: Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
AutoFullBackupDay string: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
AutoFullBackupWindow string: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
BackupDeletionPolicy string: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
BackupDestinationDetails List<GetDatabaseDbBackupConfigBackupDestinationDetail>: Backup destination details.
RecoveryWindowInDays int: Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
RunImmediateFullBackup bool: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

AutoBackupEnabled bool: If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
AutoBackupWindow string: Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
AutoFullBackupDay string: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
AutoFullBackupWindow string: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
BackupDeletionPolicy string: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
BackupDestinationDetails []GetDatabaseDbBackupConfigBackupDestinationDetail: Backup destination details.
RecoveryWindowInDays int: Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
RunImmediateFullBackup bool: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

autoBackupEnabled Boolean: If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
autoBackupWindow String: Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
autoFullBackupDay String: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
autoFullBackupWindow String: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
backupDeletionPolicy String: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
backupDestinationDetails List<GetDbBackupConfigBackupDestinationDetail>: Backup destination details.
recoveryWindowInDays Integer: Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
runImmediateFullBackup Boolean: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

autoBackupEnabled boolean: If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
autoBackupWindow string: Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
autoFullBackupDay string: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
autoFullBackupWindow string: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
backupDeletionPolicy string: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
backupDestinationDetails GetDatabaseDbBackupConfigBackupDestinationDetail[]: Backup destination details.
recoveryWindowInDays number: Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
runImmediateFullBackup boolean: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

auto_backup_enabled bool: If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
auto_backup_window str: Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
auto_full_backup_day str: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
auto_full_backup_window str: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
backup_deletion_policy str: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
backup_destination_details Sequence[GetDatabaseDbBackupConfigBackupDestinationDetail]: Backup destination details.
recovery_window_in_days int: Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
run_immediate_full_backup bool: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

autoBackupEnabled Boolean: If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
autoBackupWindow String: Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
autoFullBackupDay String: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
autoFullBackupWindow String: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
backupDeletionPolicy String: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
backupDestinationDetails List<Property Map>: Backup destination details.
recoveryWindowInDays Number: Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
runImmediateFullBackup Boolean: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

GetDatabaseDbBackupConfigBackupDestinationDetail

DbrsPolicyId string: The OCID of the DBRS policy used for backup.
Id string: The OCID of the database.
Type string: Type of the database backup destination.
VpcUser string

DbrsPolicyId string: The OCID of the DBRS policy used for backup.
Id string: The OCID of the database.
Type string: Type of the database backup destination.
VpcUser string

dbrsPolicyId String: The OCID of the DBRS policy used for backup.
id String: The OCID of the database.
type String: Type of the database backup destination.
vpcUser String

dbrsPolicyId string: The OCID of the DBRS policy used for backup.
id string: The OCID of the database.
type string: Type of the database backup destination.
vpcUser string

dbrs_policy_id str: The OCID of the DBRS policy used for backup.
id str: The OCID of the database.
type str: Type of the database backup destination.
vpc_user str

dbrsPolicyId String: The OCID of the DBRS policy used for backup.
id String: The OCID of the database.
type String: Type of the database backup destination.
vpcUser String

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.33.0 published on Thursday, May 1, 2025 by Pulumi

pulumi/pulumi-oci

oci.Database.getDatabase

On this page

On this page

Example Usage

Using getDatabase

getDatabase Result

Supporting Types

GetDatabaseConnectionString

GetDatabaseDataGuardGroup

GetDatabaseDataGuardGroupMember

GetDatabaseDatabase

GetDatabaseDatabaseDbBackupConfig

GetDatabaseDatabaseDbBackupConfigBackupDestinationDetail

GetDatabaseDatabaseEncryptionKeyLocationDetail

GetDatabaseDatabaseManagementConfig

GetDatabaseDatabaseSourceEncryptionKeyLocationDetail

GetDatabaseDbBackupConfig

GetDatabaseDbBackupConfigBackupDestinationDetail

Package Details

On this page

On this page