Oracle Cloud Infrastructure

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

getDatabase

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

Gets information about the specified database.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testDatabase = Output.Create(Oci.Database.GetDatabase.InvokeAsync(new Oci.Database.GetDatabaseArgs
        {
            DatabaseId = @var.Database_id,
        }));
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Database.GetDatabase(ctx, &database.GetDatabaseArgs{
			DatabaseId: _var.Database_id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_database = oci.Database.get_database(database_id=var["database_id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

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

Coming soon!

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 GetDatabase(ctx *Context, args *GetDatabaseArgs, opts ...InvokeOption) (*GetDatabaseResult, error)
func GetDatabaseOutput(ctx *Context, args *GetDatabaseOutputArgs, opts ...InvokeOption) GetDatabaseResultOutput

> Note: This function is named GetDatabase 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)
// Output-based functions aren't available in Java yet
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:

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.

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

The database workload type.

DefinedTags Dictionary<string, object>

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

FreeformTags Dictionary<string, object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Id string

The OCID of the database.

IsCdb bool

True if the database is a container database.

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.

LastBackupTimestamp string

The date and time when the latest database backup was created.

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.

VmClusterId string

The OCID of the VM cluster.

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.

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

The database workload type.

DefinedTags map[string]interface{}

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

FreeformTags map[string]interface{}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Id string

The OCID of the database.

IsCdb bool

True if the database is a container database.

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.

LastBackupTimestamp string

The date and time when the latest database backup was created.

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.

VmClusterId string

The OCID of the VM cluster.

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.

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

The database workload type.

definedTags Map<String,Object>

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

freeformTags Map<String,Object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

id String

The OCID of the database.

isCdb Boolean

True if the database is a container database.

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.

lastBackupTimestamp String

The date and time when the latest database backup was created.

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.

vmClusterId String

The OCID of the VM cluster.

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.

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

The database workload type.

definedTags {[key: string]: any}

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

freeformTags {[key: string]: any}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

id string

The OCID of the database.

isCdb boolean

True if the database is a container database.

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.

lastBackupTimestamp string

The date and time when the latest database backup was created.

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.

vmClusterId string

The OCID of the VM cluster.

character_set str

The character set for the database.

compartment_id str

The OCID of the compartment.

connection_strings GetDatabaseConnectionString]

The Connection strings used to connect to the Oracle Database.

database_id str
database_management_configs GetDatabaseDatabaseManagementConfig]

The configuration of the Database Management service.

database_software_image_id str

The database software image OCID

databases GetDatabaseDatabase]
db_backup_configs 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

The database workload type.

defined_tags Mapping[str, Any]

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

freeform_tags Mapping[str, Any]

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

id str

The OCID of the database.

is_cdb bool

True if the database is a container database.

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.

last_backup_timestamp str

The date and time when the latest database backup was created.

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.

vm_cluster_id str

The OCID of the VM cluster.

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.

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

The database workload type.

definedTags Map<Any>

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

freeformTags Map<Any>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

id String

The OCID of the database.

isCdb Boolean

True if the database is a container database.

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.

lastBackupTimestamp String

The date and time when the latest database backup was created.

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.

vmClusterId String

The OCID of the VM cluster.

Supporting Types

GetDatabaseConnectionString

AllConnectionStrings Dictionary<string, object>

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

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

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

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

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

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.

GetDatabaseDatabase

AdminPassword string
BackupId string
BackupTdePassword string
CharacterSet string

The character set for the database.

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

The database workload type.

DefinedTags Dictionary<string, object>

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

FreeformTags Dictionary<string, object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

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.

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.

TdeWalletPassword string
VaultId string

The OCID of the Oracle Cloud Infrastructure vault.

AdminPassword string
BackupId string
BackupTdePassword string
CharacterSet string

The character set for the database.

DatabaseSoftwareImageId string

The database software image OCID

DbBackupConfigs []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

The database workload type.

DefinedTags map[string]interface{}

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

FreeformTags map[string]interface{}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

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.

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.

TdeWalletPassword string
VaultId string

The OCID of the Oracle Cloud Infrastructure vault.

adminPassword String
backupId String
backupTdePassword String
characterSet String

The character set for the database.

databaseSoftwareImageId String

The database software image OCID

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.

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

The database workload type.

definedTags Map<String,Object>

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

freeformTags Map<String,Object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

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.

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.

tdeWalletPassword String
vaultId String

The OCID of the Oracle Cloud Infrastructure vault.

adminPassword string
backupId string
backupTdePassword string
characterSet string

The character set for the database.

databaseSoftwareImageId string

The database software image OCID

dbBackupConfigs 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

The database workload type.

definedTags {[key: string]: any}

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

freeformTags {[key: string]: any}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

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.

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.

tdeWalletPassword string
vaultId string

The OCID of the Oracle Cloud Infrastructure vault.

admin_password str
backup_id str
backup_tde_password str
character_set str

The character set for the database.

database_software_image_id str

The database software image OCID

db_backup_configs 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.

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

The database workload type.

defined_tags Mapping[str, Any]

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

freeform_tags Mapping[str, Any]

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

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

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.

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.

tde_wallet_password str
vault_id str

The OCID of the Oracle Cloud Infrastructure vault.

adminPassword String
backupId String
backupTdePassword String
characterSet String

The character set for the database.

databaseSoftwareImageId String

The database software image OCID

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.

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

The database workload type.

definedTags Map<Any>

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

freeformTags Map<Any>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

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.

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.

tdeWalletPassword String
vaultId String

The OCID of the Oracle Cloud Infrastructure vault.

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

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.

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

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.

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

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.

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

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.

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

backup_destination_details 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.

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

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.

GetDatabaseDatabaseDbBackupConfigBackupDestinationDetail

Id string

The OCID of the database.

Type string

Type of the database backup destination.

VpcUser string
Id string

The OCID of the database.

Type string

Type of the database backup destination.

VpcUser string
id String

The OCID of the database.

type String

Type of the database backup destination.

vpcUser String
id string

The OCID of the database.

type string

Type of the database backup destination.

vpcUser string
id str

The OCID of the database.

type str

Type of the database backup destination.

vpc_user str
id String

The OCID of the database.

type String

Type of the database backup destination.

vpcUser String

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.

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

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.

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

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.

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

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.

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

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.

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

backup_destination_details 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.

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

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.

GetDatabaseDbBackupConfigBackupDestinationDetail

Id string

The OCID of the database.

Type string

Type of the database backup destination.

VpcUser string
Id string

The OCID of the database.

Type string

Type of the database backup destination.

VpcUser string
id String

The OCID of the database.

type String

Type of the database backup destination.

vpcUser String
id string

The OCID of the database.

type string

Type of the database backup destination.

vpcUser string
id str

The OCID of the database.

type str

Type of the database backup destination.

vpc_user str
id String

The OCID of the database.

type String

Type of the database backup destination.

vpcUser String

Package Details

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

This Pulumi package is based on the oci Terraform Provider.