oci.Database.Database
Explore with Pulumi AI
This resource provides the Database resource in Oracle Cloud Infrastructure Database service.
Creates a new database in the specified Database Home. If the database version is provided, it must match the version of the Database Home. Applies only to Exadata systems.
Important: When auto_backup_enabled
is not present in the configuration or set to true, the auto_backup_window
and auto_full_backup_window
will be ignored
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testDatabase = new Oci.Database.Database("testDatabase", new()
{
DatabaseName = new Oci.Database.Inputs.DatabaseDatabaseArgs
{
AdminPassword = @var.Database_database_admin_password,
DbName = @var.Database_database_db_name,
BackupId = oci_database_backup.Test_backup.Id,
BackupTdePassword = @var.Database_database_backup_tde_password,
CharacterSet = @var.Database_database_character_set,
DatabaseSoftwareImageId = oci_database_database_software_image.Test_database_software_image.Id,
DbBackupConfig = new Oci.Database.Inputs.DatabaseDatabaseDbBackupConfigArgs
{
AutoBackupEnabled = @var.Database_database_db_backup_config_auto_backup_enabled,
AutoBackupWindow = @var.Database_database_db_backup_config_auto_backup_window,
AutoFullBackupDay = @var.Database_database_db_backup_config_auto_full_backup_day,
AutoFullBackupWindow = @var.Database_database_db_backup_config_auto_full_backup_window,
BackupDeletionPolicy = @var.Database_database_db_backup_config_backup_deletion_policy,
BackupDestinationDetails = new[]
{
new Oci.Database.Inputs.DatabaseDatabaseDbBackupConfigBackupDestinationDetailArgs
{
DbrsPolicyId = oci_identity_policy.Test_policy.Id,
Id = @var.Database_database_db_backup_config_backup_destination_details_id,
Type = @var.Database_database_db_backup_config_backup_destination_details_type,
},
},
RecoveryWindowInDays = @var.Database_database_db_backup_config_recovery_window_in_days,
RunImmediateFullBackup = @var.Database_database_db_backup_config_run_immediate_full_backup,
},
DbUniqueName = @var.Database_database_db_unique_name,
DbWorkload = @var.Database_database_db_workload,
DefinedTags = @var.Database_database_defined_tags,
FreeformTags = @var.Database_database_freeform_tags,
KmsKeyId = oci_kms_key.Test_key.Id,
KmsKeyVersionId = oci_kms_key_version.Test_key_version.Id,
NcharacterSet = @var.Database_database_ncharacter_set,
PdbName = @var.Database_database_pdb_name,
SidPrefix = @var.Database_database_sid_prefix,
TdeWalletPassword = @var.Database_database_tde_wallet_password,
VaultId = oci_kms_vault.Test_vault.Id,
},
DbHomeId = oci_database_db_home.Test_db_home.Id,
Source = @var.Database_source,
DbVersion = @var.Database_db_version,
KmsKeyId = oci_kms_key.Test_key.Id,
KmsKeyVersionId = oci_kms_key_version.Test_key_version.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.NewDatabase(ctx, "testDatabase", &Database.DatabaseArgs{
Database: &database.DatabaseDatabaseArgs{
AdminPassword: pulumi.Any(_var.Database_database_admin_password),
DbName: pulumi.Any(_var.Database_database_db_name),
BackupId: pulumi.Any(oci_database_backup.Test_backup.Id),
BackupTdePassword: pulumi.Any(_var.Database_database_backup_tde_password),
CharacterSet: pulumi.Any(_var.Database_database_character_set),
DatabaseSoftwareImageId: pulumi.Any(oci_database_database_software_image.Test_database_software_image.Id),
DbBackupConfig: &database.DatabaseDatabaseDbBackupConfigArgs{
AutoBackupEnabled: pulumi.Any(_var.Database_database_db_backup_config_auto_backup_enabled),
AutoBackupWindow: pulumi.Any(_var.Database_database_db_backup_config_auto_backup_window),
AutoFullBackupDay: pulumi.Any(_var.Database_database_db_backup_config_auto_full_backup_day),
AutoFullBackupWindow: pulumi.Any(_var.Database_database_db_backup_config_auto_full_backup_window),
BackupDeletionPolicy: pulumi.Any(_var.Database_database_db_backup_config_backup_deletion_policy),
BackupDestinationDetails: database.DatabaseDatabaseDbBackupConfigBackupDestinationDetailArray{
&database.DatabaseDatabaseDbBackupConfigBackupDestinationDetailArgs{
DbrsPolicyId: pulumi.Any(oci_identity_policy.Test_policy.Id),
Id: pulumi.Any(_var.Database_database_db_backup_config_backup_destination_details_id),
Type: pulumi.Any(_var.Database_database_db_backup_config_backup_destination_details_type),
},
},
RecoveryWindowInDays: pulumi.Any(_var.Database_database_db_backup_config_recovery_window_in_days),
RunImmediateFullBackup: pulumi.Any(_var.Database_database_db_backup_config_run_immediate_full_backup),
},
DbUniqueName: pulumi.Any(_var.Database_database_db_unique_name),
DbWorkload: pulumi.Any(_var.Database_database_db_workload),
DefinedTags: pulumi.Any(_var.Database_database_defined_tags),
FreeformTags: pulumi.Any(_var.Database_database_freeform_tags),
KmsKeyId: pulumi.Any(oci_kms_key.Test_key.Id),
KmsKeyVersionId: pulumi.Any(oci_kms_key_version.Test_key_version.Id),
NcharacterSet: pulumi.Any(_var.Database_database_ncharacter_set),
PdbName: pulumi.Any(_var.Database_database_pdb_name),
SidPrefix: pulumi.Any(_var.Database_database_sid_prefix),
TdeWalletPassword: pulumi.Any(_var.Database_database_tde_wallet_password),
VaultId: pulumi.Any(oci_kms_vault.Test_vault.Id),
},
DbHomeId: pulumi.Any(oci_database_db_home.Test_db_home.Id),
Source: pulumi.Any(_var.Database_source),
DbVersion: pulumi.Any(_var.Database_db_version),
KmsKeyId: pulumi.Any(oci_kms_key.Test_key.Id),
KmsKeyVersionId: pulumi.Any(oci_kms_key_version.Test_key_version.Id),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Database.Database;
import com.pulumi.oci.Database.DatabaseArgs;
import com.pulumi.oci.Database.inputs.DatabaseDatabaseArgs;
import com.pulumi.oci.Database.inputs.DatabaseDatabaseDbBackupConfigArgs;
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) {
var testDatabase = new Database("testDatabase", DatabaseArgs.builder()
.database(DatabaseDatabaseArgs.builder()
.adminPassword(var_.database_database_admin_password())
.dbName(var_.database_database_db_name())
.backupId(oci_database_backup.test_backup().id())
.backupTdePassword(var_.database_database_backup_tde_password())
.characterSet(var_.database_database_character_set())
.databaseSoftwareImageId(oci_database_database_software_image.test_database_software_image().id())
.dbBackupConfig(DatabaseDatabaseDbBackupConfigArgs.builder()
.autoBackupEnabled(var_.database_database_db_backup_config_auto_backup_enabled())
.autoBackupWindow(var_.database_database_db_backup_config_auto_backup_window())
.autoFullBackupDay(var_.database_database_db_backup_config_auto_full_backup_day())
.autoFullBackupWindow(var_.database_database_db_backup_config_auto_full_backup_window())
.backupDeletionPolicy(var_.database_database_db_backup_config_backup_deletion_policy())
.backupDestinationDetails(DatabaseDatabaseDbBackupConfigBackupDestinationDetailArgs.builder()
.dbrsPolicyId(oci_identity_policy.test_policy().id())
.id(var_.database_database_db_backup_config_backup_destination_details_id())
.type(var_.database_database_db_backup_config_backup_destination_details_type())
.build())
.recoveryWindowInDays(var_.database_database_db_backup_config_recovery_window_in_days())
.runImmediateFullBackup(var_.database_database_db_backup_config_run_immediate_full_backup())
.build())
.dbUniqueName(var_.database_database_db_unique_name())
.dbWorkload(var_.database_database_db_workload())
.definedTags(var_.database_database_defined_tags())
.freeformTags(var_.database_database_freeform_tags())
.kmsKeyId(oci_kms_key.test_key().id())
.kmsKeyVersionId(oci_kms_key_version.test_key_version().id())
.ncharacterSet(var_.database_database_ncharacter_set())
.pdbName(var_.database_database_pdb_name())
.sidPrefix(var_.database_database_sid_prefix())
.tdeWalletPassword(var_.database_database_tde_wallet_password())
.vaultId(oci_kms_vault.test_vault().id())
.build())
.dbHomeId(oci_database_db_home.test_db_home().id())
.source(var_.database_source())
.dbVersion(var_.database_db_version())
.kmsKeyId(oci_kms_key.test_key().id())
.kmsKeyVersionId(oci_kms_key_version.test_key_version().id())
.build());
}
}
import pulumi
import pulumi_oci as oci
test_database = oci.database.Database("testDatabase",
database=oci.database.DatabaseDatabaseArgs(
admin_password=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
db_name=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
backup_id=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
backup_tde_password=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
character_set=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
database_software_image_id=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
db_backup_config=oci.database.DatabaseDatabaseDbBackupConfigArgs(
auto_backup_enabled=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
auto_backup_window=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
auto_full_backup_day=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
auto_full_backup_window=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
backup_deletion_policy=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
backup_destination_details=[oci.database.DatabaseDatabaseDbBackupConfigBackupDestinationDetailArgs(
dbrs_policy_id=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
id=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
type=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
)],
recovery_window_in_days=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
run_immediate_full_backup=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
),
db_unique_name=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
db_workload=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
defined_tags=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
freeform_tags=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
kms_key_id=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
kms_key_version_id=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
ncharacter_set=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
pdb_name=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
sid_prefix=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
tde_wallet_password=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
vault_id=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
),
db_home_id=oci_database_db_home["test_db_home"]["id"],
source=var["database_source"],
db_version=var["database_db_version"],
kms_key_id=oci_kms_key["test_key"]["id"],
kms_key_version_id=oci_kms_key_version["test_key_version"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testDatabase = new oci.database.Database("testDatabase", {
database: {
adminPassword: _var.database_database_admin_password,
dbName: _var.database_database_db_name,
backupId: oci_database_backup.test_backup.id,
backupTdePassword: _var.database_database_backup_tde_password,
characterSet: _var.database_database_character_set,
databaseSoftwareImageId: oci_database_database_software_image.test_database_software_image.id,
dbBackupConfig: {
autoBackupEnabled: _var.database_database_db_backup_config_auto_backup_enabled,
autoBackupWindow: _var.database_database_db_backup_config_auto_backup_window,
autoFullBackupDay: _var.database_database_db_backup_config_auto_full_backup_day,
autoFullBackupWindow: _var.database_database_db_backup_config_auto_full_backup_window,
backupDeletionPolicy: _var.database_database_db_backup_config_backup_deletion_policy,
backupDestinationDetails: [{
dbrsPolicyId: oci_identity_policy.test_policy.id,
id: _var.database_database_db_backup_config_backup_destination_details_id,
type: _var.database_database_db_backup_config_backup_destination_details_type,
}],
recoveryWindowInDays: _var.database_database_db_backup_config_recovery_window_in_days,
runImmediateFullBackup: _var.database_database_db_backup_config_run_immediate_full_backup,
},
dbUniqueName: _var.database_database_db_unique_name,
dbWorkload: _var.database_database_db_workload,
definedTags: _var.database_database_defined_tags,
freeformTags: _var.database_database_freeform_tags,
kmsKeyId: oci_kms_key.test_key.id,
kmsKeyVersionId: oci_kms_key_version.test_key_version.id,
ncharacterSet: _var.database_database_ncharacter_set,
pdbName: _var.database_database_pdb_name,
sidPrefix: _var.database_database_sid_prefix,
tdeWalletPassword: _var.database_database_tde_wallet_password,
vaultId: oci_kms_vault.test_vault.id,
},
dbHomeId: oci_database_db_home.test_db_home.id,
source: _var.database_source,
dbVersion: _var.database_db_version,
kmsKeyId: oci_kms_key.test_key.id,
kmsKeyVersionId: oci_kms_key_version.test_key_version.id,
});
resources:
testDatabase:
type: oci:Database:Database
properties:
database:
adminPassword: ${var.database_database_admin_password}
dbName: ${var.database_database_db_name}
backupId: ${oci_database_backup.test_backup.id}
backupTdePassword: ${var.database_database_backup_tde_password}
characterSet: ${var.database_database_character_set}
databaseSoftwareImageId: ${oci_database_database_software_image.test_database_software_image.id}
dbBackupConfig:
autoBackupEnabled: ${var.database_database_db_backup_config_auto_backup_enabled}
autoBackupWindow: ${var.database_database_db_backup_config_auto_backup_window}
autoFullBackupDay: ${var.database_database_db_backup_config_auto_full_backup_day}
autoFullBackupWindow: ${var.database_database_db_backup_config_auto_full_backup_window}
backupDeletionPolicy: ${var.database_database_db_backup_config_backup_deletion_policy}
backupDestinationDetails:
- dbrsPolicyId: ${oci_identity_policy.test_policy.id}
id: ${var.database_database_db_backup_config_backup_destination_details_id}
type: ${var.database_database_db_backup_config_backup_destination_details_type}
recoveryWindowInDays: ${var.database_database_db_backup_config_recovery_window_in_days}
runImmediateFullBackup: ${var.database_database_db_backup_config_run_immediate_full_backup}
dbUniqueName: ${var.database_database_db_unique_name}
dbWorkload: ${var.database_database_db_workload}
definedTags: ${var.database_database_defined_tags}
freeformTags: ${var.database_database_freeform_tags}
kmsKeyId: ${oci_kms_key.test_key.id}
kmsKeyVersionId: ${oci_kms_key_version.test_key_version.id}
ncharacterSet: ${var.database_database_ncharacter_set}
pdbName: ${var.database_database_pdb_name}
sidPrefix: ${var.database_database_sid_prefix}
tdeWalletPassword: ${var.database_database_tde_wallet_password}
vaultId: ${oci_kms_vault.test_vault.id}
dbHomeId: ${oci_database_db_home.test_db_home.id}
source: ${var.database_source}
#Optional
dbVersion: ${var.database_db_version}
kmsKeyId: ${oci_kms_key.test_key.id}
kmsKeyVersionId: ${oci_kms_key_version.test_key_version.id}
Create Database Resource
new Database(name: string, args: DatabaseArgs, opts?: CustomResourceOptions);
@overload
def Database(resource_name: str,
opts: Optional[ResourceOptions] = None,
database: Optional[_database.DatabaseDatabaseArgs] = None,
db_home_id: Optional[str] = None,
db_version: Optional[str] = None,
kms_key_id: Optional[str] = None,
kms_key_migration: Optional[bool] = None,
kms_key_rotation: Optional[int] = None,
kms_key_version_id: Optional[str] = None,
source: Optional[str] = None,
vault_id: Optional[str] = None)
@overload
def Database(resource_name: str,
args: DatabaseArgs,
opts: Optional[ResourceOptions] = None)
func NewDatabase(ctx *Context, name string, args DatabaseArgs, opts ...ResourceOption) (*Database, error)
public Database(string name, DatabaseArgs args, CustomResourceOptions? opts = null)
public Database(String name, DatabaseArgs args)
public Database(String name, DatabaseArgs args, CustomResourceOptions options)
type: oci:Database:Database
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DatabaseArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DatabaseArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DatabaseArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DatabaseArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DatabaseArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Database Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Database resource accepts the following input properties:
- Database
Name DatabaseDatabase Args (Updatable) Details for creating a database.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- Db
Home stringId The OCID of the Database Home.
- Source string
The source of the database: Use
NONE
for creating a new database. UseDB_BACKUP
for creating a new database by restoring from a backup. The default isNONE
.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Db
Version string A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- Kms
Key stringId The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- Kms
Key boolMigration The value to migrate to the kms version from none. Can only use once by setting value to true. You can not switch back to non-kms once you created or migrated.(https://www.oracle.com/security/cloud-security/key-management/faq/)
- Kms
Key intRotation The value to rotate the key version of current kms_key. Just change this value will trigger the rotation.
- Kms
Key stringVersion Id 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.
- Vault
Id string
- Database
Database
Database Args (Updatable) Details for creating a database.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- Db
Home stringId The OCID of the Database Home.
- Source string
The source of the database: Use
NONE
for creating a new database. UseDB_BACKUP
for creating a new database by restoring from a backup. The default isNONE
.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Db
Version string A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- Kms
Key stringId The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- Kms
Key boolMigration The value to migrate to the kms version from none. Can only use once by setting value to true. You can not switch back to non-kms once you created or migrated.(https://www.oracle.com/security/cloud-security/key-management/faq/)
- Kms
Key intRotation The value to rotate the key version of current kms_key. Just change this value will trigger the rotation.
- Kms
Key stringVersion Id 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.
- Vault
Id string
- database Args
(Updatable) Details for creating a database.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- db
Home StringId The OCID of the Database Home.
- source String
The source of the database: Use
NONE
for creating a new database. UseDB_BACKUP
for creating a new database by restoring from a backup. The default isNONE
.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- db
Version String A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- kms
Key StringId The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms
Key BooleanMigration The value to migrate to the kms version from none. Can only use once by setting value to true. You can not switch back to non-kms once you created or migrated.(https://www.oracle.com/security/cloud-security/key-management/faq/)
- kms
Key IntegerRotation The value to rotate the key version of current kms_key. Just change this value will trigger the rotation.
- kms
Key StringVersion Id 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.
- vault
Id String
- database
Database
Database Args (Updatable) Details for creating a database.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- db
Home stringId The OCID of the Database Home.
- source string
The source of the database: Use
NONE
for creating a new database. UseDB_BACKUP
for creating a new database by restoring from a backup. The default isNONE
.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- db
Version string A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- kms
Key stringId The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms
Key booleanMigration The value to migrate to the kms version from none. Can only use once by setting value to true. You can not switch back to non-kms once you created or migrated.(https://www.oracle.com/security/cloud-security/key-management/faq/)
- kms
Key numberRotation The value to rotate the key version of current kms_key. Just change this value will trigger the rotation.
- kms
Key stringVersion Id 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.
- vault
Id string
- database
Database
Database Args (Updatable) Details for creating a database.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- db_
home_ strid The OCID of the Database Home.
- source str
The source of the database: Use
NONE
for creating a new database. UseDB_BACKUP
for creating a new database by restoring from a backup. The default isNONE
.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- db_
version str A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- kms_
key_ strid The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms_
key_ boolmigration The value to migrate to the kms version from none. Can only use once by setting value to true. You can not switch back to non-kms once you created or migrated.(https://www.oracle.com/security/cloud-security/key-management/faq/)
- kms_
key_ introtation The value to rotate the key version of current kms_key. Just change this value will trigger the rotation.
- kms_
key_ strversion_ id 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.
- vault_
id str
- database Property Map
(Updatable) Details for creating a database.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- db
Home StringId The OCID of the Database Home.
- source String
The source of the database: Use
NONE
for creating a new database. UseDB_BACKUP
for creating a new database by restoring from a backup. The default isNONE
.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- db
Version String A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- kms
Key StringId The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms
Key BooleanMigration The value to migrate to the kms version from none. Can only use once by setting value to true. You can not switch back to non-kms once you created or migrated.(https://www.oracle.com/security/cloud-security/key-management/faq/)
- kms
Key NumberRotation The value to rotate the key version of current kms_key. Just change this value will trigger the rotation.
- kms
Key StringVersion Id 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.
- vault
Id String
Outputs
All input properties are implicitly available as output properties. Additionally, the Database resource produces the following output properties:
- Character
Set string The character set for the database. The default is AL32UTF8. Allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- Compartment
Id string The OCID of the compartment.
- Connection
Strings List<DatabaseConnection String> The Connection strings used to connect to the Oracle Database.
- Database
Management List<DatabaseConfigs Database Management Config> The configuration of the Database Management service.
- Database
Software stringImage Id The database software image OCID
- Db
Backup List<DatabaseConfigs Db Backup Config> (Updatable) 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 string The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
- Db
System stringId The OCID of the DB system.
- Db
Unique stringName The
DB_UNIQUE_NAME
of the Oracle Database being backed up.- Db
Workload 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.
The database workload type.
- Dictionary<string, object>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Dictionary<string, object>
(Updatable) 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 provider-assigned unique ID for this managed resource.
- Is
Cdb bool True if the database is a container database.
- Last
Backup intDuration In Seconds The duration when the latest database backup created.
- Last
Backup stringTimestamp The date and time when the latest database backup was created.
- Last
Failed stringBackup Timestamp The date and time when the latest database backup failed.
- Lifecycle
Details string Additional information about the current lifecycle state.
- Ncharacter
Set string The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- Pdb
Name 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.
- Sid
Prefix string Specifies a prefix for the
Oracle SID
of the database to be created.- Source
Database stringPoint In Time Recovery Timestamp 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.
- Time
Created string The date and time the database was created.
- Vm
Cluster stringId The OCID of the VM cluster.
- Character
Set string The character set for the database. The default is AL32UTF8. Allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- Compartment
Id string The OCID of the compartment.
- Connection
Strings []DatabaseConnection String The Connection strings used to connect to the Oracle Database.
- Database
Management []DatabaseConfigs Database Management Config The configuration of the Database Management service.
- Database
Software stringImage Id The database software image OCID
- Db
Backup []DatabaseConfigs Db Backup Config (Updatable) 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 string The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
- Db
System stringId The OCID of the DB system.
- Db
Unique stringName The
DB_UNIQUE_NAME
of the Oracle Database being backed up.- Db
Workload 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.
The database workload type.
- map[string]interface{}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- map[string]interface{}
(Updatable) 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 provider-assigned unique ID for this managed resource.
- Is
Cdb bool True if the database is a container database.
- Last
Backup intDuration In Seconds The duration when the latest database backup created.
- Last
Backup stringTimestamp The date and time when the latest database backup was created.
- Last
Failed stringBackup Timestamp The date and time when the latest database backup failed.
- Lifecycle
Details string Additional information about the current lifecycle state.
- Ncharacter
Set string The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- Pdb
Name 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.
- Sid
Prefix string Specifies a prefix for the
Oracle SID
of the database to be created.- Source
Database stringPoint In Time Recovery Timestamp 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.
- Time
Created string The date and time the database was created.
- Vm
Cluster stringId The OCID of the VM cluster.
- character
Set String The character set for the database. The default is AL32UTF8. Allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- compartment
Id String The OCID of the compartment.
- connection
Strings List<ConnectionString> The Connection strings used to connect to the Oracle Database.
- database
Management List<ManagementConfigs Config> The configuration of the Database Management service.
- database
Software StringImage Id The database software image OCID
- db
Backup List<DbConfigs Backup Config> (Updatable) 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 String The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
- db
System StringId The OCID of the DB system.
- db
Unique StringName The
DB_UNIQUE_NAME
of the Oracle Database being backed up.- db
Workload 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.
The database workload type.
- Map<String,Object>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Map<String,Object>
(Updatable) 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 provider-assigned unique ID for this managed resource.
- is
Cdb Boolean True if the database is a container database.
- last
Backup IntegerDuration In Seconds The duration when the latest database backup created.
- last
Backup StringTimestamp The date and time when the latest database backup was created.
- last
Failed StringBackup Timestamp The date and time when the latest database backup failed.
- lifecycle
Details String Additional information about the current lifecycle state.
- ncharacter
Set String The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- pdb
Name 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.
- sid
Prefix String Specifies a prefix for the
Oracle SID
of the database to be created.- source
Database StringPoint In Time Recovery Timestamp 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.
- time
Created String The date and time the database was created.
- vm
Cluster StringId The OCID of the VM cluster.
- character
Set string The character set for the database. The default is AL32UTF8. Allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- compartment
Id string The OCID of the compartment.
- connection
Strings DatabaseConnection String[] The Connection strings used to connect to the Oracle Database.
- database
Management DatabaseConfigs Database Management Config[] The configuration of the Database Management service.
- database
Software stringImage Id The database software image OCID
- db
Backup DatabaseConfigs Db Backup Config[] (Updatable) 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 string The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
- db
System stringId The OCID of the DB system.
- db
Unique stringName The
DB_UNIQUE_NAME
of the Oracle Database being backed up.- db
Workload 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.
The database workload type.
- {[key: string]: any}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- {[key: string]: any}
(Updatable) 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 provider-assigned unique ID for this managed resource.
- is
Cdb boolean True if the database is a container database.
- last
Backup numberDuration In Seconds The duration when the latest database backup created.
- last
Backup stringTimestamp The date and time when the latest database backup was created.
- last
Failed stringBackup Timestamp The date and time when the latest database backup failed.
- lifecycle
Details string Additional information about the current lifecycle state.
- ncharacter
Set string The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- pdb
Name 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.
- sid
Prefix string Specifies a prefix for the
Oracle SID
of the database to be created.- source
Database stringPoint In Time Recovery Timestamp 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.
- time
Created string The date and time the database was created.
- vm
Cluster stringId The OCID of the VM cluster.
- character_
set str The character set for the database. The default is AL32UTF8. Allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- compartment_
id str The OCID of the compartment.
- connection_
strings DatabaseConnection String] The Connection strings used to connect to the Oracle Database.
- database_
management_ Databaseconfigs Database Management Config] The configuration of the Database Management service.
- database_
software_ strimage_ id The database software image OCID
- db_
backup_ Databaseconfigs Db Backup Config] (Updatable) 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 display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
- db_
system_ strid The OCID of the DB system.
- db_
unique_ strname The
DB_UNIQUE_NAME
of the Oracle Database being backed up.- 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.
The database workload type.
- Mapping[str, Any]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Mapping[str, Any]
(Updatable) 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 provider-assigned unique ID for this managed resource.
- is_
cdb bool True if the database is a container database.
- last_
backup_ intduration_ in_ seconds The duration when the latest database backup created.
- last_
backup_ strtimestamp The date and time when the latest database backup was created.
- last_
failed_ strbackup_ timestamp 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. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- 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_
database_ strpoint_ in_ time_ recovery_ timestamp 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.
- vm_
cluster_ strid The OCID of the VM cluster.
- character
Set String The character set for the database. The default is AL32UTF8. Allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- compartment
Id String The OCID of the compartment.
- connection
Strings List<Property Map> The Connection strings used to connect to the Oracle Database.
- database
Management List<Property Map>Configs The configuration of the Database Management service.
- database
Software StringImage Id The database software image OCID
- db
Backup List<Property Map>Configs (Updatable) 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 String The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
- db
System StringId The OCID of the DB system.
- db
Unique StringName The
DB_UNIQUE_NAME
of the Oracle Database being backed up.- db
Workload 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.
The database workload type.
- Map<Any>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Map<Any>
(Updatable) 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 provider-assigned unique ID for this managed resource.
- is
Cdb Boolean True if the database is a container database.
- last
Backup NumberDuration In Seconds The duration when the latest database backup created.
- last
Backup StringTimestamp The date and time when the latest database backup was created.
- last
Failed StringBackup Timestamp The date and time when the latest database backup failed.
- lifecycle
Details String Additional information about the current lifecycle state.
- ncharacter
Set String The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- pdb
Name 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.
- sid
Prefix String Specifies a prefix for the
Oracle SID
of the database to be created.- source
Database StringPoint In Time Recovery Timestamp 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.
- time
Created String The date and time the database was created.
- vm
Cluster StringId The OCID of the VM cluster.
Look up Existing Database Resource
Get an existing Database resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: DatabaseState, opts?: CustomResourceOptions): Database
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
character_set: Optional[str] = None,
compartment_id: Optional[str] = None,
connection_strings: Optional[Sequence[_database.DatabaseConnectionStringArgs]] = None,
database: Optional[_database.DatabaseDatabaseArgs] = None,
database_management_configs: Optional[Sequence[_database.DatabaseDatabaseManagementConfigArgs]] = None,
database_software_image_id: Optional[str] = None,
db_backup_configs: Optional[Sequence[_database.DatabaseDbBackupConfigArgs]] = None,
db_home_id: Optional[str] = None,
db_name: Optional[str] = None,
db_system_id: Optional[str] = None,
db_unique_name: Optional[str] = None,
db_version: Optional[str] = None,
db_workload: Optional[str] = None,
defined_tags: Optional[Mapping[str, Any]] = None,
freeform_tags: Optional[Mapping[str, Any]] = None,
is_cdb: Optional[bool] = None,
kms_key_id: Optional[str] = None,
kms_key_migration: Optional[bool] = None,
kms_key_rotation: Optional[int] = None,
kms_key_version_id: Optional[str] = None,
last_backup_duration_in_seconds: Optional[int] = None,
last_backup_timestamp: Optional[str] = None,
last_failed_backup_timestamp: Optional[str] = None,
lifecycle_details: Optional[str] = None,
ncharacter_set: Optional[str] = None,
pdb_name: Optional[str] = None,
sid_prefix: Optional[str] = None,
source: Optional[str] = None,
source_database_point_in_time_recovery_timestamp: Optional[str] = None,
state: Optional[str] = None,
time_created: Optional[str] = None,
vault_id: Optional[str] = None,
vm_cluster_id: Optional[str] = None) -> Database
func GetDatabase(ctx *Context, name string, id IDInput, state *DatabaseState, opts ...ResourceOption) (*Database, error)
public static Database Get(string name, Input<string> id, DatabaseState? state, CustomResourceOptions? opts = null)
public static Database get(String name, Output<String> id, DatabaseState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Character
Set string The character set for the database. The default is AL32UTF8. Allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- Compartment
Id string The OCID of the compartment.
- Connection
Strings List<DatabaseConnection String Args> The Connection strings used to connect to the Oracle Database.
- Database
Management List<DatabaseConfigs Database Management Config Args> The configuration of the Database Management service.
- Database
Name DatabaseDatabase Args (Updatable) Details for creating a database.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- Database
Software stringImage Id The database software image OCID
- Db
Backup List<DatabaseConfigs Db Backup Config Args> (Updatable) 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 stringId The OCID of the Database Home.
- Db
Name string The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
- Db
System stringId The OCID of the DB system.
- Db
Unique stringName The
DB_UNIQUE_NAME
of the Oracle Database being backed up.- Db
Version string A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- Db
Workload 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.
The database workload type.
- Dictionary<string, object>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Dictionary<string, object>
(Updatable) 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
Cdb bool True if the database is a container database.
- Kms
Key stringId The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- Kms
Key boolMigration The value to migrate to the kms version from none. Can only use once by setting value to true. You can not switch back to non-kms once you created or migrated.(https://www.oracle.com/security/cloud-security/key-management/faq/)
- Kms
Key intRotation The value to rotate the key version of current kms_key. Just change this value will trigger the rotation.
- Kms
Key stringVersion Id 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 intDuration In Seconds The duration when the latest database backup created.
- Last
Backup stringTimestamp The date and time when the latest database backup was created.
- Last
Failed stringBackup Timestamp The date and time when the latest database backup failed.
- Lifecycle
Details string Additional information about the current lifecycle state.
- Ncharacter
Set string The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- Pdb
Name 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.
- Sid
Prefix string Specifies a prefix for the
Oracle SID
of the database to be created.- Source string
The source of the database: Use
NONE
for creating a new database. UseDB_BACKUP
for creating a new database by restoring from a backup. The default isNONE
.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Source
Database stringPoint In Time Recovery Timestamp 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.
- Time
Created string The date and time the database was created.
- Vault
Id string - Vm
Cluster stringId The OCID of the VM cluster.
- Character
Set string The character set for the database. The default is AL32UTF8. Allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- Compartment
Id string The OCID of the compartment.
- Connection
Strings []DatabaseConnection String Args The Connection strings used to connect to the Oracle Database.
- Database
Database
Database Args (Updatable) Details for creating a database.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- Database
Management []DatabaseConfigs Database Management Config Args The configuration of the Database Management service.
- Database
Software stringImage Id The database software image OCID
- Db
Backup []DatabaseConfigs Db Backup Config Args (Updatable) 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 stringId The OCID of the Database Home.
- Db
Name string The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
- Db
System stringId The OCID of the DB system.
- Db
Unique stringName The
DB_UNIQUE_NAME
of the Oracle Database being backed up.- Db
Version string A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- Db
Workload 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.
The database workload type.
- map[string]interface{}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- map[string]interface{}
(Updatable) 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
Cdb bool True if the database is a container database.
- Kms
Key stringId The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- Kms
Key boolMigration The value to migrate to the kms version from none. Can only use once by setting value to true. You can not switch back to non-kms once you created or migrated.(https://www.oracle.com/security/cloud-security/key-management/faq/)
- Kms
Key intRotation The value to rotate the key version of current kms_key. Just change this value will trigger the rotation.
- Kms
Key stringVersion Id 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 intDuration In Seconds The duration when the latest database backup created.
- Last
Backup stringTimestamp The date and time when the latest database backup was created.
- Last
Failed stringBackup Timestamp The date and time when the latest database backup failed.
- Lifecycle
Details string Additional information about the current lifecycle state.
- Ncharacter
Set string The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- Pdb
Name 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.
- Sid
Prefix string Specifies a prefix for the
Oracle SID
of the database to be created.- Source string
The source of the database: Use
NONE
for creating a new database. UseDB_BACKUP
for creating a new database by restoring from a backup. The default isNONE
.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Source
Database stringPoint In Time Recovery Timestamp 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.
- Time
Created string The date and time the database was created.
- Vault
Id string - Vm
Cluster stringId The OCID of the VM cluster.
- character
Set String The character set for the database. The default is AL32UTF8. Allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- compartment
Id String The OCID of the compartment.
- connection
Strings List<ConnectionString Args> The Connection strings used to connect to the Oracle Database.
- database Args
(Updatable) Details for creating a database.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- database
Management List<ManagementConfigs Config Args> The configuration of the Database Management service.
- database
Software StringImage Id The database software image OCID
- db
Backup List<DbConfigs Backup Config Args> (Updatable) 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 StringId The OCID of the Database Home.
- db
Name String The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
- db
System StringId The OCID of the DB system.
- db
Unique StringName The
DB_UNIQUE_NAME
of the Oracle Database being backed up.- db
Version String A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- db
Workload 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.
The database workload type.
- Map<String,Object>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Map<String,Object>
(Updatable) 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
Cdb Boolean True if the database is a container database.
- kms
Key StringId The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms
Key BooleanMigration The value to migrate to the kms version from none. Can only use once by setting value to true. You can not switch back to non-kms once you created or migrated.(https://www.oracle.com/security/cloud-security/key-management/faq/)
- kms
Key IntegerRotation The value to rotate the key version of current kms_key. Just change this value will trigger the rotation.
- kms
Key StringVersion Id 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 IntegerDuration In Seconds The duration when the latest database backup created.
- last
Backup StringTimestamp The date and time when the latest database backup was created.
- last
Failed StringBackup Timestamp The date and time when the latest database backup failed.
- lifecycle
Details String Additional information about the current lifecycle state.
- ncharacter
Set String The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- pdb
Name 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.
- sid
Prefix String Specifies a prefix for the
Oracle SID
of the database to be created.- source String
The source of the database: Use
NONE
for creating a new database. UseDB_BACKUP
for creating a new database by restoring from a backup. The default isNONE
.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- source
Database StringPoint In Time Recovery Timestamp 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.
- time
Created String The date and time the database was created.
- vault
Id String - vm
Cluster StringId The OCID of the VM cluster.
- character
Set string The character set for the database. The default is AL32UTF8. Allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- compartment
Id string The OCID of the compartment.
- connection
Strings DatabaseConnection String Args[] The Connection strings used to connect to the Oracle Database.
- database
Database
Database Args (Updatable) Details for creating a database.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- database
Management DatabaseConfigs Database Management Config Args[] The configuration of the Database Management service.
- database
Software stringImage Id The database software image OCID
- db
Backup DatabaseConfigs Db Backup Config Args[] (Updatable) 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 stringId The OCID of the Database Home.
- db
Name string The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
- db
System stringId The OCID of the DB system.
- db
Unique stringName The
DB_UNIQUE_NAME
of the Oracle Database being backed up.- db
Version string A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- db
Workload 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.
The database workload type.
- {[key: string]: any}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- {[key: string]: any}
(Updatable) 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
Cdb boolean True if the database is a container database.
- kms
Key stringId The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms
Key booleanMigration The value to migrate to the kms version from none. Can only use once by setting value to true. You can not switch back to non-kms once you created or migrated.(https://www.oracle.com/security/cloud-security/key-management/faq/)
- kms
Key numberRotation The value to rotate the key version of current kms_key. Just change this value will trigger the rotation.
- kms
Key stringVersion Id 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 numberDuration In Seconds The duration when the latest database backup created.
- last
Backup stringTimestamp The date and time when the latest database backup was created.
- last
Failed stringBackup Timestamp The date and time when the latest database backup failed.
- lifecycle
Details string Additional information about the current lifecycle state.
- ncharacter
Set string The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- pdb
Name 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.
- sid
Prefix string Specifies a prefix for the
Oracle SID
of the database to be created.- source string
The source of the database: Use
NONE
for creating a new database. UseDB_BACKUP
for creating a new database by restoring from a backup. The default isNONE
.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- source
Database stringPoint In Time Recovery Timestamp 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.
- time
Created string The date and time the database was created.
- vault
Id string - vm
Cluster stringId The OCID of the VM cluster.
- character_
set str The character set for the database. The default is AL32UTF8. Allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- compartment_
id str The OCID of the compartment.
- connection_
strings DatabaseConnection String Args] The Connection strings used to connect to the Oracle Database.
- database
Database
Database Args (Updatable) Details for creating a database.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- database_
management_ Databaseconfigs Database Management Config Args] The configuration of the Database Management service.
- database_
software_ strimage_ id The database software image OCID
- db_
backup_ Databaseconfigs Db Backup Config Args] (Updatable) 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_ strid The OCID of the Database Home.
- db_
name str The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
- db_
system_ strid The OCID of the DB system.
- db_
unique_ strname The
DB_UNIQUE_NAME
of the Oracle Database being backed up.- db_
version str A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- 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.
The database workload type.
- Mapping[str, Any]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Mapping[str, Any]
(Updatable) 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_
cdb bool True if the database is a container database.
- kms_
key_ strid The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms_
key_ boolmigration The value to migrate to the kms version from none. Can only use once by setting value to true. You can not switch back to non-kms once you created or migrated.(https://www.oracle.com/security/cloud-security/key-management/faq/)
- kms_
key_ introtation The value to rotate the key version of current kms_key. Just change this value will trigger the rotation.
- kms_
key_ strversion_ id 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_ intduration_ in_ seconds The duration when the latest database backup created.
- last_
backup_ strtimestamp The date and time when the latest database backup was created.
- last_
failed_ strbackup_ timestamp 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. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- 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
The source of the database: Use
NONE
for creating a new database. UseDB_BACKUP
for creating a new database by restoring from a backup. The default isNONE
.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- source_
database_ strpoint_ in_ time_ recovery_ timestamp 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 - vm_
cluster_ strid The OCID of the VM cluster.
- character
Set String The character set for the database. The default is AL32UTF8. Allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- compartment
Id String The OCID of the compartment.
- connection
Strings List<Property Map> The Connection strings used to connect to the Oracle Database.
- database Property Map
(Updatable) Details for creating a database.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- database
Management List<Property Map>Configs The configuration of the Database Management service.
- database
Software StringImage Id The database software image OCID
- db
Backup List<Property Map>Configs (Updatable) 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 StringId The OCID of the Database Home.
- db
Name String The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
- db
System StringId The OCID of the DB system.
- db
Unique StringName The
DB_UNIQUE_NAME
of the Oracle Database being backed up.- db
Version String A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- db
Workload 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.
The database workload type.
- Map<Any>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Map<Any>
(Updatable) 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
Cdb Boolean True if the database is a container database.
- kms
Key StringId The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms
Key BooleanMigration The value to migrate to the kms version from none. Can only use once by setting value to true. You can not switch back to non-kms once you created or migrated.(https://www.oracle.com/security/cloud-security/key-management/faq/)
- kms
Key NumberRotation The value to rotate the key version of current kms_key. Just change this value will trigger the rotation.
- kms
Key StringVersion Id 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 NumberDuration In Seconds The duration when the latest database backup created.
- last
Backup StringTimestamp The date and time when the latest database backup was created.
- last
Failed StringBackup Timestamp The date and time when the latest database backup failed.
- lifecycle
Details String Additional information about the current lifecycle state.
- ncharacter
Set String The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- pdb
Name 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.
- sid
Prefix String Specifies a prefix for the
Oracle SID
of the database to be created.- source String
The source of the database: Use
NONE
for creating a new database. UseDB_BACKUP
for creating a new database by restoring from a backup. The default isNONE
.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- source
Database StringPoint In Time Recovery Timestamp 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.
- time
Created String The date and time the database was created.
- vault
Id String - vm
Cluster StringId The OCID of the VM cluster.
Supporting Types
DatabaseConnectionString
- All
Connection Dictionary<string, object>Strings All connection strings to use to connect to the Database.
- Cdb
Default string Host name based CDB Connection String.
- Cdb
Ip stringDefault IP based CDB Connection String.
- All
Connection map[string]interface{}Strings All connection strings to use to connect to the Database.
- Cdb
Default string Host name based CDB Connection String.
- Cdb
Ip stringDefault IP based CDB Connection String.
- all
Connection Map<String,Object>Strings All connection strings to use to connect to the Database.
- cdb
Default String Host name based CDB Connection String.
- cdb
Ip StringDefault IP based CDB Connection String.
- all
Connection {[key: string]: any}Strings All connection strings to use to connect to the Database.
- cdb
Default string Host name based CDB Connection String.
- cdb
Ip stringDefault IP based CDB Connection String.
- all_
connection_ Mapping[str, Any]strings All connection strings to use to connect to the Database.
- cdb_
default str Host name based CDB Connection String.
- cdb_
ip_ strdefault IP based CDB Connection String.
- all
Connection Map<Any>Strings All connection strings to use to connect to the Database.
- cdb
Default String Host name based CDB Connection String.
- cdb
Ip StringDefault IP based CDB Connection String.
DatabaseDatabase
- Admin
Password string A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.
- Db
Name string The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
- Backup
Id string The backup OCID.
- Backup
Tde stringPassword The password to open the TDE wallet.
- Character
Set string The character set for the database. The default is AL32UTF8. Allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- Database
Software stringImage Id The database software image OCID
- Db
Backup DatabaseConfig Database Db Backup Config (Updatable) 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
Unique stringName The
DB_UNIQUE_NAME
of the Oracle Database being backed up.- Db
Workload 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.
The database workload type.
- Dictionary<string, object>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Dictionary<string, object>
(Updatable) 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 stringId The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- Kms
Key stringVersion Id 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 string The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- Pdb
Name 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.
- Sid
Prefix string Specifies a prefix for the
Oracle SID
of the database to be created.- Tde
Wallet stringPassword The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, #, or -.
- Vault
Id string
- Admin
Password string A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.
- Db
Name string The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
- Backup
Id string The backup OCID.
- Backup
Tde stringPassword The password to open the TDE wallet.
- Character
Set string The character set for the database. The default is AL32UTF8. Allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- Database
Software stringImage Id The database software image OCID
- Db
Backup DatabaseConfig Database Db Backup Config (Updatable) 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
Unique stringName The
DB_UNIQUE_NAME
of the Oracle Database being backed up.- Db
Workload 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.
The database workload type.
- map[string]interface{}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- map[string]interface{}
(Updatable) 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 stringId The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- Kms
Key stringVersion Id 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 string The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- Pdb
Name 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.
- Sid
Prefix string Specifies a prefix for the
Oracle SID
of the database to be created.- Tde
Wallet stringPassword The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, #, or -.
- Vault
Id string
- admin
Password String A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.
- db
Name String The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
- backup
Id String The backup OCID.
- backup
Tde StringPassword The password to open the TDE wallet.
- character
Set String The character set for the database. The default is AL32UTF8. Allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- database
Software StringImage Id The database software image OCID
- db
Backup DbConfig Backup Config (Updatable) 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
Unique StringName The
DB_UNIQUE_NAME
of the Oracle Database being backed up.- db
Workload 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.
The database workload type.
- Map<String,Object>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Map<String,Object>
(Updatable) 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 StringId The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms
Key StringVersion Id 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 String The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- pdb
Name 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.
- sid
Prefix String Specifies a prefix for the
Oracle SID
of the database to be created.- tde
Wallet StringPassword The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, #, or -.
- vault
Id String
- admin
Password string A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.
- db
Name string The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
- backup
Id string The backup OCID.
- backup
Tde stringPassword The password to open the TDE wallet.
- character
Set string The character set for the database. The default is AL32UTF8. Allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- database
Software stringImage Id The database software image OCID
- db
Backup DatabaseConfig Database Db Backup Config (Updatable) 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
Unique stringName The
DB_UNIQUE_NAME
of the Oracle Database being backed up.- db
Workload 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.
The database workload type.
- {[key: string]: any}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- {[key: string]: any}
(Updatable) 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 stringId The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms
Key stringVersion Id 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 string The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- pdb
Name 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.
- sid
Prefix string Specifies a prefix for the
Oracle SID
of the database to be created.- tde
Wallet stringPassword The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, #, or -.
- vault
Id string
- admin_
password str A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.
- db_
name str The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
- backup_
id str The backup OCID.
- backup_
tde_ strpassword The password to open the TDE wallet.
- character_
set str The character set for the database. The default is AL32UTF8. Allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- database_
software_ strimage_ id The database software image OCID
- db_
backup_ Databaseconfig Database Db Backup Config (Updatable) 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_
unique_ strname The
DB_UNIQUE_NAME
of the Oracle Database being backed up.- 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.
The database workload type.
- Mapping[str, Any]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Mapping[str, Any]
(Updatable) 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_ strid The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms_
key_ strversion_ id 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. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- 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_ strpassword The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, #, or -.
- vault_
id str
- admin
Password String A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.
- db
Name String The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
- backup
Id String The backup OCID.
- backup
Tde StringPassword The password to open the TDE wallet.
- character
Set String The character set for the database. The default is AL32UTF8. Allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- database
Software StringImage Id The database software image OCID
- db
Backup Property MapConfig (Updatable) 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
Unique StringName The
DB_UNIQUE_NAME
of the Oracle Database being backed up.- db
Workload 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.
The database workload type.
- Map<Any>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Map<Any>
(Updatable) 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 StringId The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms
Key StringVersion Id 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 String The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- pdb
Name 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.
- sid
Prefix String Specifies a prefix for the
Oracle SID
of the database to be created.- tde
Wallet StringPassword The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, #, or -.
- vault
Id String
DatabaseDatabaseDbBackupConfig
- Auto
Backup boolEnabled (Updatable) 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 stringWindow (Updatable) 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 stringBackup Day 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 stringBackup Window 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 stringPolicy 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 List<DatabaseDetails Database Db Backup Config Backup Destination Detail> Backup destination details.
- Recovery
Window intIn Days (Updatable) 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 boolFull Backup 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 boolEnabled (Updatable) 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 stringWindow (Updatable) 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 stringBackup Day 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 stringBackup Window 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 stringPolicy 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 []DatabaseDetails Database Db Backup Config Backup Destination Detail Backup destination details.
- Recovery
Window intIn Days (Updatable) 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 boolFull Backup 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 BooleanEnabled (Updatable) 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 StringWindow (Updatable) 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 StringBackup Day 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 StringBackup Window 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 StringPolicy 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 List<DbDetails Backup Config Backup Destination Detail> Backup destination details.
- recovery
Window IntegerIn Days (Updatable) 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 BooleanFull Backup 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 booleanEnabled (Updatable) 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 stringWindow (Updatable) 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 stringBackup Day 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 stringBackup Window 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 stringPolicy 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 DatabaseDetails Database Db Backup Config Backup Destination Detail[] Backup destination details.
- recovery
Window numberIn Days (Updatable) 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 booleanFull Backup 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_ boolenabled (Updatable) 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_ strwindow (Updatable) 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_ strbackup_ day 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_ strbackup_ window 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_ strpolicy 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_ Databasedetails Database Db Backup Config Backup Destination Detail] Backup destination details.
- recovery_
window_ intin_ days (Updatable) 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_ boolfull_ backup 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 BooleanEnabled (Updatable) 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 StringWindow (Updatable) 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 StringBackup Day 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 StringBackup Window 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 StringPolicy 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 List<Property Map>Details Backup destination details.
- recovery
Window NumberIn Days (Updatable) 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 BooleanFull Backup If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
DatabaseDatabaseDbBackupConfigBackupDestinationDetail
DatabaseDatabaseManagementConfig
- Management
Status string The status of the Database Management service.
- Management
Type string The Database Management type.
- Management
Status string The status of the Database Management service.
- Management
Type string The Database Management type.
- management
Status String The status of the Database Management service.
- management
Type String The Database Management type.
- management
Status string The status of the Database Management service.
- management
Type string The Database Management type.
- management_
status str The status of the Database Management service.
- management_
type str The Database Management type.
- management
Status String The status of the Database Management service.
- management
Type String The Database Management type.
DatabaseDbBackupConfig
- Auto
Backup boolEnabled (Updatable) 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 stringWindow (Updatable) 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 stringBackup Day 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 stringBackup Window 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 stringPolicy 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 List<DatabaseDetails Db Backup Config Backup Destination Detail> Backup destination details.
- Recovery
Window intIn Days (Updatable) 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 boolFull Backup 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 boolEnabled (Updatable) 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 stringWindow (Updatable) 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 stringBackup Day 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 stringBackup Window 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 stringPolicy 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 []DatabaseDetails Db Backup Config Backup Destination Detail Backup destination details.
- Recovery
Window intIn Days (Updatable) 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 boolFull Backup 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 BooleanEnabled (Updatable) 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 StringWindow (Updatable) 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 StringBackup Day 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 StringBackup Window 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 StringPolicy 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 List<DbDetails Backup Config Backup Destination Detail> Backup destination details.
- recovery
Window IntegerIn Days (Updatable) 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 BooleanFull Backup 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 booleanEnabled (Updatable) 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 stringWindow (Updatable) 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 stringBackup Day 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 stringBackup Window 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 stringPolicy 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 DatabaseDetails Db Backup Config Backup Destination Detail[] Backup destination details.
- recovery
Window numberIn Days (Updatable) 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 booleanFull Backup 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_ boolenabled (Updatable) 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_ strwindow (Updatable) 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_ strbackup_ day 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_ strbackup_ window 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_ strpolicy 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_ Databasedetails Db Backup Config Backup Destination Detail] Backup destination details.
- recovery_
window_ intin_ days (Updatable) 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_ boolfull_ backup 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 BooleanEnabled (Updatable) 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 StringWindow (Updatable) 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 StringBackup Day 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 StringBackup Window 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 StringPolicy 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 List<Property Map>Details Backup destination details.
- recovery
Window NumberIn Days (Updatable) 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 BooleanFull Backup If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
DatabaseDbBackupConfigBackupDestinationDetail
Import
Databases can be imported using the id
, e.g.
$ pulumi import oci:Database/database:Database test_database "id"
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
oci
Terraform Provider.