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
Create Database Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Database(name: string, args: DatabaseArgs, opts?: CustomResourceOptions);
@overload
def Database(resource_name: str,
args: DatabaseArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Database(resource_name: str,
opts: Optional[ResourceOptions] = None,
database: Optional[DatabaseDatabaseArgs] = None,
db_home_id: Optional[str] = None,
source: Optional[str] = None,
action_trigger: Optional[int] = None,
data_guard_action: Optional[str] = None,
db_version: Optional[str] = None,
key_store_id: 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,
vault_id: Optional[str] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var databaseResource = new Oci.Database.Database("databaseResource", new()
{
DatabaseName = new Oci.Database.Inputs.DatabaseDatabaseArgs
{
AdminPassword = "string",
BackupId = "string",
BackupTdePassword = "string",
CharacterSet = "string",
DatabaseAdminPassword = "string",
DatabaseSoftwareImageId = "string",
DbBackupConfig = new Oci.Database.Inputs.DatabaseDatabaseDbBackupConfigArgs
{
AutoBackupEnabled = false,
AutoBackupWindow = "string",
AutoFullBackupDay = "string",
AutoFullBackupWindow = "string",
BackupDeletionPolicy = "string",
BackupDestinationDetails = new[]
{
new Oci.Database.Inputs.DatabaseDatabaseDbBackupConfigBackupDestinationDetailArgs
{
DbrsPolicyId = "string",
Id = "string",
Type = "string",
VpcUser = "string",
},
},
RecoveryWindowInDays = 0,
RunImmediateFullBackup = false,
},
DbName = "string",
DbUniqueName = "string",
DbWorkload = "string",
DefinedTags =
{
{ "string", "string" },
},
EncryptionKeyLocationDetails = new Oci.Database.Inputs.DatabaseDatabaseEncryptionKeyLocationDetailsArgs
{
HsmPassword = "string",
ProviderType = "string",
},
FreeformTags =
{
{ "string", "string" },
},
IsActiveDataGuardEnabled = false,
KmsKeyId = "string",
KmsKeyVersionId = "string",
NcharacterSet = "string",
PdbName = "string",
PluggableDatabases = new[]
{
"string",
},
ProtectionMode = "string",
SidPrefix = "string",
SourceDatabaseId = "string",
SourceEncryptionKeyLocationDetails = new Oci.Database.Inputs.DatabaseDatabaseSourceEncryptionKeyLocationDetailsArgs
{
HsmPassword = "string",
ProviderType = "string",
},
SourceTdeWalletPassword = "string",
TdeWalletPassword = "string",
TransportType = "string",
VaultId = "string",
},
DbHomeId = "string",
Source = "string",
ActionTrigger = 0,
DataGuardAction = "string",
DbVersion = "string",
KeyStoreId = "string",
KmsKeyId = "string",
KmsKeyMigration = false,
KmsKeyRotation = 0,
KmsKeyVersionId = "string",
VaultId = "string",
});
example, err := database.NewDatabase(ctx, "databaseResource", &database.DatabaseArgs{
Database: &database.DatabaseDatabaseArgs{
AdminPassword: pulumi.String("string"),
BackupId: pulumi.String("string"),
BackupTdePassword: pulumi.String("string"),
CharacterSet: pulumi.String("string"),
DatabaseAdminPassword: pulumi.String("string"),
DatabaseSoftwareImageId: pulumi.String("string"),
DbBackupConfig: &database.DatabaseDatabaseDbBackupConfigArgs{
AutoBackupEnabled: pulumi.Bool(false),
AutoBackupWindow: pulumi.String("string"),
AutoFullBackupDay: pulumi.String("string"),
AutoFullBackupWindow: pulumi.String("string"),
BackupDeletionPolicy: pulumi.String("string"),
BackupDestinationDetails: database.DatabaseDatabaseDbBackupConfigBackupDestinationDetailArray{
&database.DatabaseDatabaseDbBackupConfigBackupDestinationDetailArgs{
DbrsPolicyId: pulumi.String("string"),
Id: pulumi.String("string"),
Type: pulumi.String("string"),
VpcUser: pulumi.String("string"),
},
},
RecoveryWindowInDays: pulumi.Int(0),
RunImmediateFullBackup: pulumi.Bool(false),
},
DbName: pulumi.String("string"),
DbUniqueName: pulumi.String("string"),
DbWorkload: pulumi.String("string"),
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
EncryptionKeyLocationDetails: &database.DatabaseDatabaseEncryptionKeyLocationDetailsArgs{
HsmPassword: pulumi.String("string"),
ProviderType: pulumi.String("string"),
},
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
IsActiveDataGuardEnabled: pulumi.Bool(false),
KmsKeyId: pulumi.String("string"),
KmsKeyVersionId: pulumi.String("string"),
NcharacterSet: pulumi.String("string"),
PdbName: pulumi.String("string"),
PluggableDatabases: pulumi.StringArray{
pulumi.String("string"),
},
ProtectionMode: pulumi.String("string"),
SidPrefix: pulumi.String("string"),
SourceDatabaseId: pulumi.String("string"),
SourceEncryptionKeyLocationDetails: &database.DatabaseDatabaseSourceEncryptionKeyLocationDetailsArgs{
HsmPassword: pulumi.String("string"),
ProviderType: pulumi.String("string"),
},
SourceTdeWalletPassword: pulumi.String("string"),
TdeWalletPassword: pulumi.String("string"),
TransportType: pulumi.String("string"),
VaultId: pulumi.String("string"),
},
DbHomeId: pulumi.String("string"),
Source: pulumi.String("string"),
ActionTrigger: pulumi.Int(0),
DataGuardAction: pulumi.String("string"),
DbVersion: pulumi.String("string"),
KeyStoreId: pulumi.String("string"),
KmsKeyId: pulumi.String("string"),
KmsKeyMigration: pulumi.Bool(false),
KmsKeyRotation: pulumi.Int(0),
KmsKeyVersionId: pulumi.String("string"),
VaultId: pulumi.String("string"),
})
var databaseResource = new Database("databaseResource", DatabaseArgs.builder()
.database(DatabaseDatabaseArgs.builder()
.adminPassword("string")
.backupId("string")
.backupTdePassword("string")
.characterSet("string")
.databaseAdminPassword("string")
.databaseSoftwareImageId("string")
.dbBackupConfig(DatabaseDatabaseDbBackupConfigArgs.builder()
.autoBackupEnabled(false)
.autoBackupWindow("string")
.autoFullBackupDay("string")
.autoFullBackupWindow("string")
.backupDeletionPolicy("string")
.backupDestinationDetails(DatabaseDatabaseDbBackupConfigBackupDestinationDetailArgs.builder()
.dbrsPolicyId("string")
.id("string")
.type("string")
.vpcUser("string")
.build())
.recoveryWindowInDays(0)
.runImmediateFullBackup(false)
.build())
.dbName("string")
.dbUniqueName("string")
.dbWorkload("string")
.definedTags(Map.of("string", "string"))
.encryptionKeyLocationDetails(DatabaseDatabaseEncryptionKeyLocationDetailsArgs.builder()
.hsmPassword("string")
.providerType("string")
.build())
.freeformTags(Map.of("string", "string"))
.isActiveDataGuardEnabled(false)
.kmsKeyId("string")
.kmsKeyVersionId("string")
.ncharacterSet("string")
.pdbName("string")
.pluggableDatabases("string")
.protectionMode("string")
.sidPrefix("string")
.sourceDatabaseId("string")
.sourceEncryptionKeyLocationDetails(DatabaseDatabaseSourceEncryptionKeyLocationDetailsArgs.builder()
.hsmPassword("string")
.providerType("string")
.build())
.sourceTdeWalletPassword("string")
.tdeWalletPassword("string")
.transportType("string")
.vaultId("string")
.build())
.dbHomeId("string")
.source("string")
.actionTrigger(0)
.dataGuardAction("string")
.dbVersion("string")
.keyStoreId("string")
.kmsKeyId("string")
.kmsKeyMigration(false)
.kmsKeyRotation(0)
.kmsKeyVersionId("string")
.vaultId("string")
.build());
database_resource = oci.database.Database("databaseResource",
database={
"admin_password": "string",
"backup_id": "string",
"backup_tde_password": "string",
"character_set": "string",
"database_admin_password": "string",
"database_software_image_id": "string",
"db_backup_config": {
"auto_backup_enabled": False,
"auto_backup_window": "string",
"auto_full_backup_day": "string",
"auto_full_backup_window": "string",
"backup_deletion_policy": "string",
"backup_destination_details": [{
"dbrs_policy_id": "string",
"id": "string",
"type": "string",
"vpc_user": "string",
}],
"recovery_window_in_days": 0,
"run_immediate_full_backup": False,
},
"db_name": "string",
"db_unique_name": "string",
"db_workload": "string",
"defined_tags": {
"string": "string",
},
"encryption_key_location_details": {
"hsm_password": "string",
"provider_type": "string",
},
"freeform_tags": {
"string": "string",
},
"is_active_data_guard_enabled": False,
"kms_key_id": "string",
"kms_key_version_id": "string",
"ncharacter_set": "string",
"pdb_name": "string",
"pluggable_databases": ["string"],
"protection_mode": "string",
"sid_prefix": "string",
"source_database_id": "string",
"source_encryption_key_location_details": {
"hsm_password": "string",
"provider_type": "string",
},
"source_tde_wallet_password": "string",
"tde_wallet_password": "string",
"transport_type": "string",
"vault_id": "string",
},
db_home_id="string",
source="string",
action_trigger=0,
data_guard_action="string",
db_version="string",
key_store_id="string",
kms_key_id="string",
kms_key_migration=False,
kms_key_rotation=0,
kms_key_version_id="string",
vault_id="string")
const databaseResource = new oci.database.Database("databaseResource", {
database: {
adminPassword: "string",
backupId: "string",
backupTdePassword: "string",
characterSet: "string",
databaseAdminPassword: "string",
databaseSoftwareImageId: "string",
dbBackupConfig: {
autoBackupEnabled: false,
autoBackupWindow: "string",
autoFullBackupDay: "string",
autoFullBackupWindow: "string",
backupDeletionPolicy: "string",
backupDestinationDetails: [{
dbrsPolicyId: "string",
id: "string",
type: "string",
vpcUser: "string",
}],
recoveryWindowInDays: 0,
runImmediateFullBackup: false,
},
dbName: "string",
dbUniqueName: "string",
dbWorkload: "string",
definedTags: {
string: "string",
},
encryptionKeyLocationDetails: {
hsmPassword: "string",
providerType: "string",
},
freeformTags: {
string: "string",
},
isActiveDataGuardEnabled: false,
kmsKeyId: "string",
kmsKeyVersionId: "string",
ncharacterSet: "string",
pdbName: "string",
pluggableDatabases: ["string"],
protectionMode: "string",
sidPrefix: "string",
sourceDatabaseId: "string",
sourceEncryptionKeyLocationDetails: {
hsmPassword: "string",
providerType: "string",
},
sourceTdeWalletPassword: "string",
tdeWalletPassword: "string",
transportType: "string",
vaultId: "string",
},
dbHomeId: "string",
source: "string",
actionTrigger: 0,
dataGuardAction: "string",
dbVersion: "string",
keyStoreId: "string",
kmsKeyId: "string",
kmsKeyMigration: false,
kmsKeyRotation: 0,
kmsKeyVersionId: "string",
vaultId: "string",
});
type: oci:Database:Database
properties:
actionTrigger: 0
dataGuardAction: string
database:
adminPassword: string
backupId: string
backupTdePassword: string
characterSet: string
databaseAdminPassword: string
databaseSoftwareImageId: string
dbBackupConfig:
autoBackupEnabled: false
autoBackupWindow: string
autoFullBackupDay: string
autoFullBackupWindow: string
backupDeletionPolicy: string
backupDestinationDetails:
- dbrsPolicyId: string
id: string
type: string
vpcUser: string
recoveryWindowInDays: 0
runImmediateFullBackup: false
dbName: string
dbUniqueName: string
dbWorkload: string
definedTags:
string: string
encryptionKeyLocationDetails:
hsmPassword: string
providerType: string
freeformTags:
string: string
isActiveDataGuardEnabled: false
kmsKeyId: string
kmsKeyVersionId: string
ncharacterSet: string
pdbName: string
pluggableDatabases:
- string
protectionMode: string
sidPrefix: string
sourceDatabaseId: string
sourceEncryptionKeyLocationDetails:
hsmPassword: string
providerType: string
sourceTdeWalletPassword: string
tdeWalletPassword: string
transportType: string
vaultId: string
dbHomeId: string
dbVersion: string
keyStoreId: string
kmsKeyId: string
kmsKeyMigration: false
kmsKeyRotation: 0
kmsKeyVersionId: string
source: string
vaultId: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Database resource accepts the following input properties:
- Database
Name DatabaseDatabase (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. UseDATAGUARD
for creating a new STANDBY database for a Data Guard setup. The default isNONE
. - Action
Trigger int - (Applicable when source=DATAGUARD) An optional property when incremented triggers Data Guard operations such as Failover, Switchover, Reinstate, Data Guard Configuration Update and Convert Standby Database to Standalone . Could be set to any integer value.
- Data
Guard stringAction Describes the Data Guard operation to be triggered. Could be set to a string value ('Switchover', 'Failover', 'Reinstate', 'DgConfig', "ConvertToStandalone').
** 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.
- Key
Store stringId - The OCID of the key store of Oracle Vault.
- 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 - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys.
- 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. UseDATAGUARD
for creating a new STANDBY database for a Data Guard setup. The default isNONE
. - Action
Trigger int - (Applicable when source=DATAGUARD) An optional property when incremented triggers Data Guard operations such as Failover, Switchover, Reinstate, Data Guard Configuration Update and Convert Standby Database to Standalone . Could be set to any integer value.
- Data
Guard stringAction Describes the Data Guard operation to be triggered. Could be set to a string value ('Switchover', 'Failover', 'Reinstate', 'DgConfig', "ConvertToStandalone').
** 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.
- Key
Store stringId - The OCID of the key store of Oracle Vault.
- 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 - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys.
- database DatabaseDatabaseArgs
(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. UseDATAGUARD
for creating a new STANDBY database for a Data Guard setup. The default isNONE
. - action
Trigger Integer - (Applicable when source=DATAGUARD) An optional property when incremented triggers Data Guard operations such as Failover, Switchover, Reinstate, Data Guard Configuration Update and Convert Standby Database to Standalone . Could be set to any integer value.
- data
Guard StringAction Describes the Data Guard operation to be triggered. Could be set to a string value ('Switchover', 'Failover', 'Reinstate', 'DgConfig', "ConvertToStandalone').
** 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.
- key
Store StringId - The OCID of the key store of Oracle Vault.
- 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 - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys.
- database
Database
Database (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. UseDATAGUARD
for creating a new STANDBY database for a Data Guard setup. The default isNONE
. - action
Trigger number - (Applicable when source=DATAGUARD) An optional property when incremented triggers Data Guard operations such as Failover, Switchover, Reinstate, Data Guard Configuration Update and Convert Standby Database to Standalone . Could be set to any integer value.
- data
Guard stringAction Describes the Data Guard operation to be triggered. Could be set to a string value ('Switchover', 'Failover', 'Reinstate', 'DgConfig', "ConvertToStandalone').
** 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.
- key
Store stringId - The OCID of the key store of Oracle Vault.
- 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 - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys.
- 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. UseDATAGUARD
for creating a new STANDBY database for a Data Guard setup. The default isNONE
. - action_
trigger int - (Applicable when source=DATAGUARD) An optional property when incremented triggers Data Guard operations such as Failover, Switchover, Reinstate, Data Guard Configuration Update and Convert Standby Database to Standalone . Could be set to any integer value.
- data_
guard_ straction Describes the Data Guard operation to be triggered. Could be set to a string value ('Switchover', 'Failover', 'Reinstate', 'DgConfig', "ConvertToStandalone').
** 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.
- key_
store_ strid - The OCID of the key store of Oracle Vault.
- 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 - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys.
- 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. UseDATAGUARD
for creating a new STANDBY database for a Data Guard setup. The default isNONE
. - action
Trigger Number - (Applicable when source=DATAGUARD) An optional property when incremented triggers Data Guard operations such as Failover, Switchover, Reinstate, Data Guard Configuration Update and Convert Standby Database to Standalone . Could be set to any integer value.
- data
Guard StringAction Describes the Data Guard operation to be triggered. Could be set to a string value ('Switchover', 'Failover', 'Reinstate', 'DgConfig', "ConvertToStandalone').
** 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.
- key
Store StringId - The OCID of the key store of Oracle Vault.
- 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 - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys.
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.
- Compartment
Id string - The OCID of the compartment.
- Connection
Strings List<DatabaseConnection String> - The Connection strings used to connect to the Oracle Database.
- Data
Guard List<DatabaseGroups Data Guard Group> - Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
- Database
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> - 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 database name.
- Db
System stringId - The OCID of the DB system.
- Db
Unique stringName - A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- Db
Workload 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.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Dictionary<string, string>
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- Id string
- The provider-assigned unique ID for this managed resource.
- Is
Cdb bool - True if the database is a container database.
- Key
Store stringWallet Name - The wallet name for Oracle Key Vault.
- 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.
- 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.
- Compartment
Id string - The OCID of the compartment.
- Connection
Strings []DatabaseConnection String - The Connection strings used to connect to the Oracle Database.
- Data
Guard []DatabaseGroups Data Guard Group - Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
- Database
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 - 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 database name.
- Db
System stringId - The OCID of the DB system.
- Db
Unique stringName - A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- Db
Workload 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.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- map[string]string
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- Id string
- The provider-assigned unique ID for this managed resource.
- Is
Cdb bool - True if the database is a container database.
- Key
Store stringWallet Name - The wallet name for Oracle Key Vault.
- 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.
- 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.
- compartment
Id String - The OCID of the compartment.
- connection
Strings List<ConnectionString> - The Connection strings used to connect to the Oracle Database.
- data
Guard List<DataGroups Guard Group> - Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
- database
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> - 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 database name.
- db
System StringId - The OCID of the DB system.
- db
Unique StringName - A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- db
Workload 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.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Map<String,String>
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- id String
- The provider-assigned unique ID for this managed resource.
- is
Cdb Boolean - True if the database is a container database.
- key
Store StringWallet Name - The wallet name for Oracle Key Vault.
- 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.
- 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.
- compartment
Id string - The OCID of the compartment.
- connection
Strings DatabaseConnection String[] - The Connection strings used to connect to the Oracle Database.
- data
Guard DatabaseGroups Data Guard Group[] - Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
- database
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[] - 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 database name.
- db
System stringId - The OCID of the DB system.
- db
Unique stringName - A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- db
Workload 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.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- {[key: string]: string}
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- id string
- The provider-assigned unique ID for this managed resource.
- is
Cdb boolean - True if the database is a container database.
- key
Store stringWallet Name - The wallet name for Oracle Key Vault.
- 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.
- 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.
- compartment_
id str - The OCID of the compartment.
- connection_
strings Sequence[DatabaseConnection String] - The Connection strings used to connect to the Oracle Database.
- data_
guard_ Sequence[Databasegroups Data Guard Group] - Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
- database_
management_ Sequence[Databaseconfigs Database Management Config] - The configuration of the Database Management service.
- database_
software_ strimage_ id - The database software image OCID
- db_
backup_ Sequence[Databaseconfigs Db Backup Config] - Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
- db_
name str - The database name.
- db_
system_ strid - The OCID of the DB system.
- db_
unique_ strname - A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- db_
workload str - 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.
- Mapping[str, str]
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Mapping[str, str]
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- id str
- The provider-assigned unique ID for this managed resource.
- is_
cdb bool - True if the database is a container database.
- key_
store_ strwallet_ name - The wallet name for Oracle Key Vault.
- 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.
- 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.
- compartment
Id String - The OCID of the compartment.
- connection
Strings List<Property Map> - The Connection strings used to connect to the Oracle Database.
- data
Guard List<Property Map>Groups - Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
- database
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 - 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 database name.
- db
System StringId - The OCID of the DB system.
- db
Unique StringName - A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- db
Workload 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.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Map<String>
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- id String
- The provider-assigned unique ID for this managed resource.
- is
Cdb Boolean - True if the database is a container database.
- key
Store StringWallet Name - The wallet name for Oracle Key Vault.
- 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.
- 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,
action_trigger: Optional[int] = None,
character_set: Optional[str] = None,
compartment_id: Optional[str] = None,
connection_strings: Optional[Sequence[DatabaseConnectionStringArgs]] = None,
data_guard_action: Optional[str] = None,
data_guard_groups: Optional[Sequence[DatabaseDataGuardGroupArgs]] = None,
database: Optional[DatabaseDatabaseArgs] = None,
database_management_configs: Optional[Sequence[DatabaseDatabaseManagementConfigArgs]] = None,
database_software_image_id: Optional[str] = None,
db_backup_configs: Optional[Sequence[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, str]] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
is_cdb: Optional[bool] = None,
key_store_id: Optional[str] = None,
key_store_wallet_name: 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,
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)
resources: _: type: oci:Database:Database get: id: ${id}
- 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.
- Action
Trigger int - (Applicable when source=DATAGUARD) An optional property when incremented triggers Data Guard operations such as Failover, Switchover, Reinstate, Data Guard Configuration Update and Convert Standby Database to Standalone . Could be set to any integer value.
- Character
Set string - The character set for the database.
- Compartment
Id string - The OCID of the compartment.
- Connection
Strings List<DatabaseConnection String> - The Connection strings used to connect to the Oracle Database.
- Data
Guard stringAction Describes the Data Guard operation to be triggered. Could be set to a string value ('Switchover', 'Failover', 'Reinstate', 'DgConfig', "ConvertToStandalone').
** 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
- Data
Guard List<DatabaseGroups Data Guard Group> - Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
- Database
Management List<DatabaseConfigs Database Management Config> - The configuration of the Database Management service.
- Database
Name DatabaseDatabase (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> - 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 database name.
- Db
System stringId - The OCID of the DB system.
- Db
Unique stringName - A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- Db
Version 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.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Dictionary<string, string>
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- Is
Cdb bool - True if the database is a container database.
- Key
Store stringId - The OCID of the key store of Oracle Vault.
- Key
Store stringWallet Name - The wallet name for Oracle Key Vault.
- 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.
- 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. UseDATAGUARD
for creating a new STANDBY database for a Data Guard setup. The default isNONE
. - 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 - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys. - Vm
Cluster stringId - The OCID of the VM cluster.
- Action
Trigger int - (Applicable when source=DATAGUARD) An optional property when incremented triggers Data Guard operations such as Failover, Switchover, Reinstate, Data Guard Configuration Update and Convert Standby Database to Standalone . Could be set to any integer value.
- Character
Set string - The character set for the database.
- Compartment
Id string - The OCID of the compartment.
- Connection
Strings []DatabaseConnection String Args - The Connection strings used to connect to the Oracle Database.
- Data
Guard stringAction Describes the Data Guard operation to be triggered. Could be set to a string value ('Switchover', 'Failover', 'Reinstate', 'DgConfig', "ConvertToStandalone').
** 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
- Data
Guard []DatabaseGroups Data Guard Group Args - Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
- Database
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 - 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 database name.
- Db
System stringId - The OCID of the DB system.
- Db
Unique stringName - A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- Db
Version 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.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- map[string]string
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- Is
Cdb bool - True if the database is a container database.
- Key
Store stringId - The OCID of the key store of Oracle Vault.
- Key
Store stringWallet Name - The wallet name for Oracle Key Vault.
- 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.
- 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. UseDATAGUARD
for creating a new STANDBY database for a Data Guard setup. The default isNONE
. - 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 - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys. - Vm
Cluster stringId - The OCID of the VM cluster.
- action
Trigger Integer - (Applicable when source=DATAGUARD) An optional property when incremented triggers Data Guard operations such as Failover, Switchover, Reinstate, Data Guard Configuration Update and Convert Standby Database to Standalone . Could be set to any integer value.
- character
Set String - The character set for the database.
- compartment
Id String - The OCID of the compartment.
- connection
Strings List<ConnectionString> - The Connection strings used to connect to the Oracle Database.
- data
Guard StringAction Describes the Data Guard operation to be triggered. Could be set to a string value ('Switchover', 'Failover', 'Reinstate', 'DgConfig', "ConvertToStandalone').
** 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
- data
Guard List<DataGroups Guard Group> - Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
- database DatabaseDatabaseArgs
(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> - The configuration of the Database Management service.
- database
Software StringImage Id - The database software image OCID
- db
Backup List<DbConfigs Backup Config> - 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 database name.
- db
System StringId - The OCID of the DB system.
- db
Unique StringName - A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- db
Version 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.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Map<String,String>
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- is
Cdb Boolean - True if the database is a container database.
- key
Store StringId - The OCID of the key store of Oracle Vault.
- key
Store StringWallet Name - The wallet name for Oracle Key Vault.
- 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.
- 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. UseDATAGUARD
for creating a new STANDBY database for a Data Guard setup. The default isNONE
. - 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 - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys. - vm
Cluster StringId - The OCID of the VM cluster.
- action
Trigger number - (Applicable when source=DATAGUARD) An optional property when incremented triggers Data Guard operations such as Failover, Switchover, Reinstate, Data Guard Configuration Update and Convert Standby Database to Standalone . Could be set to any integer value.
- character
Set string - The character set for the database.
- compartment
Id string - The OCID of the compartment.
- connection
Strings DatabaseConnection String[] - The Connection strings used to connect to the Oracle Database.
- data
Guard stringAction Describes the Data Guard operation to be triggered. Could be set to a string value ('Switchover', 'Failover', 'Reinstate', 'DgConfig', "ConvertToStandalone').
** 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
- data
Guard DatabaseGroups Data Guard Group[] - Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
- database
Database
Database (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[] - The configuration of the Database Management service.
- database
Software stringImage Id - The database software image OCID
- db
Backup DatabaseConfigs Db Backup Config[] - 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 database name.
- db
System stringId - The OCID of the DB system.
- db
Unique stringName - A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- db
Version 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.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- {[key: string]: string}
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- is
Cdb boolean - True if the database is a container database.
- key
Store stringId - The OCID of the key store of Oracle Vault.
- key
Store stringWallet Name - The wallet name for Oracle Key Vault.
- 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.
- 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. UseDATAGUARD
for creating a new STANDBY database for a Data Guard setup. The default isNONE
. - 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 - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys. - vm
Cluster stringId - The OCID of the VM cluster.
- action_
trigger int - (Applicable when source=DATAGUARD) An optional property when incremented triggers Data Guard operations such as Failover, Switchover, Reinstate, Data Guard Configuration Update and Convert Standby Database to Standalone . Could be set to any integer value.
- character_
set str - The character set for the database.
- compartment_
id str - The OCID of the compartment.
- connection_
strings Sequence[DatabaseConnection String Args] - The Connection strings used to connect to the Oracle Database.
- data_
guard_ straction Describes the Data Guard operation to be triggered. Could be set to a string value ('Switchover', 'Failover', 'Reinstate', 'DgConfig', "ConvertToStandalone').
** 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
- data_
guard_ Sequence[Databasegroups Data Guard Group Args] - Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
- database
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_ Sequence[Databaseconfigs Database Management Config Args] - The configuration of the Database Management service.
- database_
software_ strimage_ id - The database software image OCID
- db_
backup_ Sequence[Databaseconfigs Db Backup Config Args] - 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 database name.
- db_
system_ strid - The OCID of the DB system.
- db_
unique_ strname - A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- db_
version str 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.
- Mapping[str, str]
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Mapping[str, str]
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- is_
cdb bool - True if the database is a container database.
- key_
store_ strid - The OCID of the key store of Oracle Vault.
- key_
store_ strwallet_ name - The wallet name for Oracle Key Vault.
- 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.
- 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. UseDATAGUARD
for creating a new STANDBY database for a Data Guard setup. The default isNONE
. - 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 - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys. - vm_
cluster_ strid - The OCID of the VM cluster.
- action
Trigger Number - (Applicable when source=DATAGUARD) An optional property when incremented triggers Data Guard operations such as Failover, Switchover, Reinstate, Data Guard Configuration Update and Convert Standby Database to Standalone . Could be set to any integer value.
- character
Set String - The character set for the database.
- compartment
Id String - The OCID of the compartment.
- connection
Strings List<Property Map> - The Connection strings used to connect to the Oracle Database.
- data
Guard StringAction Describes the Data Guard operation to be triggered. Could be set to a string value ('Switchover', 'Failover', 'Reinstate', 'DgConfig', "ConvertToStandalone').
** 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
- data
Guard List<Property Map>Groups - Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
- database 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 - 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 database name.
- db
System StringId - The OCID of the DB system.
- db
Unique StringName - A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- db
Version 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.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Map<String>
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- is
Cdb Boolean - True if the database is a container database.
- key
Store StringId - The OCID of the key store of Oracle Vault.
- key
Store StringWallet Name - The wallet name for Oracle Key Vault.
- 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.
- 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. UseDATAGUARD
for creating a new STANDBY database for a Data Guard setup. The default isNONE
. - 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 - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys. - vm
Cluster StringId - The OCID of the VM cluster.
Supporting Types
DatabaseConnectionString, DatabaseConnectionStringArgs
- All
Connection Dictionary<string, string>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]stringStrings - 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,String>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]: string}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, str]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<String>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.
DatabaseDataGuardGroup, DatabaseDataGuardGroupArgs
- Members
List<Database
Data Guard Group Member> - List of Data Guard members, representing each database that is part of Data Guard.
- Protection
Mode string - The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.
- Members
[]Database
Data Guard Group Member - List of Data Guard members, representing each database that is part of Data Guard.
- Protection
Mode string - The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.
- members
List<Data
Guard Group Member> - List of Data Guard members, representing each database that is part of Data Guard.
- protection
Mode String - The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.
- members
Database
Data Guard Group Member[] - List of Data Guard members, representing each database that is part of Data Guard.
- protection
Mode string - The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.
- members
Sequence[Database
Data Guard Group Member] - List of Data Guard members, representing each database that is part of Data Guard.
- protection_
mode str - The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.
- members List<Property Map>
- List of Data Guard members, representing each database that is part of Data Guard.
- protection
Mode String - The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.
DatabaseDataGuardGroupMember, DatabaseDataGuardGroupMemberArgs
- Apply
Lag string - The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example:
1 second
- Apply
Rate string - The rate at which redo logs are synced between the associated databases. Example:
102.96 MByte/s
- Database
Id string - The OCID of the Database.
- Db
System stringId - The OCID of the DB system.
- Is
Active boolData Guard Enabled - True if active Data Guard is enabled.
- Role string
- The role of the reporting database in this Data Guard association.
- Transport
Lag string - The rate at which redo logs are transported between the associated databases. Example:
1 second
- Transport
Lag stringRefresh - The date and time when last redo transport has been done.
- Transport
Type string - The redo transport type to use for this Data Guard association. Valid values depend on the specified
protectionMode
:- MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
- MAXIMUM_PERFORMANCE - ASYNC
- MAXIMUM_PROTECTION - SYNC
- Apply
Lag string - The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example:
1 second
- Apply
Rate string - The rate at which redo logs are synced between the associated databases. Example:
102.96 MByte/s
- Database
Id string - The OCID of the Database.
- Db
System stringId - The OCID of the DB system.
- Is
Active boolData Guard Enabled - True if active Data Guard is enabled.
- Role string
- The role of the reporting database in this Data Guard association.
- Transport
Lag string - The rate at which redo logs are transported between the associated databases. Example:
1 second
- Transport
Lag stringRefresh - The date and time when last redo transport has been done.
- Transport
Type string - The redo transport type to use for this Data Guard association. Valid values depend on the specified
protectionMode
:- MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
- MAXIMUM_PERFORMANCE - ASYNC
- MAXIMUM_PROTECTION - SYNC
- apply
Lag String - The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example:
1 second
- apply
Rate String - The rate at which redo logs are synced between the associated databases. Example:
102.96 MByte/s
- database
Id String - The OCID of the Database.
- db
System StringId - The OCID of the DB system.
- is
Active BooleanData Guard Enabled - True if active Data Guard is enabled.
- role String
- The role of the reporting database in this Data Guard association.
- transport
Lag String - The rate at which redo logs are transported between the associated databases. Example:
1 second
- transport
Lag StringRefresh - The date and time when last redo transport has been done.
- transport
Type String - The redo transport type to use for this Data Guard association. Valid values depend on the specified
protectionMode
:- MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
- MAXIMUM_PERFORMANCE - ASYNC
- MAXIMUM_PROTECTION - SYNC
- apply
Lag string - The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example:
1 second
- apply
Rate string - The rate at which redo logs are synced between the associated databases. Example:
102.96 MByte/s
- database
Id string - The OCID of the Database.
- db
System stringId - The OCID of the DB system.
- is
Active booleanData Guard Enabled - True if active Data Guard is enabled.
- role string
- The role of the reporting database in this Data Guard association.
- transport
Lag string - The rate at which redo logs are transported between the associated databases. Example:
1 second
- transport
Lag stringRefresh - The date and time when last redo transport has been done.
- transport
Type string - The redo transport type to use for this Data Guard association. Valid values depend on the specified
protectionMode
:- MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
- MAXIMUM_PERFORMANCE - ASYNC
- MAXIMUM_PROTECTION - SYNC
- apply_
lag str - The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example:
1 second
- apply_
rate str - The rate at which redo logs are synced between the associated databases. Example:
102.96 MByte/s
- database_
id str - The OCID of the Database.
- db_
system_ strid - The OCID of the DB system.
- is_
active_ booldata_ guard_ enabled - True if active Data Guard is enabled.
- role str
- The role of the reporting database in this Data Guard association.
- transport_
lag str - The rate at which redo logs are transported between the associated databases. Example:
1 second
- transport_
lag_ strrefresh - The date and time when last redo transport has been done.
- transport_
type str - The redo transport type to use for this Data Guard association. Valid values depend on the specified
protectionMode
:- MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
- MAXIMUM_PERFORMANCE - ASYNC
- MAXIMUM_PROTECTION - SYNC
- apply
Lag String - The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example:
1 second
- apply
Rate String - The rate at which redo logs are synced between the associated databases. Example:
102.96 MByte/s
- database
Id String - The OCID of the Database.
- db
System StringId - The OCID of the DB system.
- is
Active BooleanData Guard Enabled - True if active Data Guard is enabled.
- role String
- The role of the reporting database in this Data Guard association.
- transport
Lag String - The rate at which redo logs are transported between the associated databases. Example:
1 second
- transport
Lag StringRefresh - The date and time when last redo transport has been done.
- transport
Type String - The redo transport type to use for this Data Guard association. Valid values depend on the specified
protectionMode
:- MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
- MAXIMUM_PERFORMANCE - ASYNC
- MAXIMUM_PROTECTION - SYNC
DatabaseDatabase, DatabaseDatabaseArgs
- 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 -.
- 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
Admin stringPassword The administrator password of the primary database in this Data Guard association.
The password MUST be the same as the primary admin password.
- 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
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
Unique stringName - Specifies the
DB_UNIQUE_NAME
of the peer database to be created. - 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, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Encryption
Key DatabaseLocation Details Database Encryption Key Location Details - Types of providers supported for managing database encryption keys
- Dictionary<string, string>
- (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
Active boolData Guard Enabled - True if active Data Guard is enabled.
- 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. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- 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.
- Pluggable
Databases List<string> - The list of pluggable databases that needs to be restored into new database.
- Protection
Mode string - The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.
- Sid
Prefix string - Specifies a prefix for the
Oracle SID
of the database to be created. - Source
Database stringId - The OCID of the source database.
- Source
Encryption DatabaseKey Location Details Database Source Encryption Key Location Details - Types of providers supported for managing database encryption keys
- Source
Tde stringWallet Password - The TDE wallet password of the source database specified by 'sourceDatabaseId'.
- 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 -.
- Transport
Type string The redo transport type to use for this Data Guard association. Valid values depend on the specified
protectionMode
:- MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
- MAXIMUM_PERFORMANCE - ASYNC
- MAXIMUM_PROTECTION - SYNC
For more information, see Redo Transport Services in the Oracle Data Guard documentation.
IMPORTANT - The only transport type currently supported by the Database service is ASYNC.
- Vault
Id string - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys.
- 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 -.
- 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
Admin stringPassword The administrator password of the primary database in this Data Guard association.
The password MUST be the same as the primary admin password.
- 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
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
Unique stringName - Specifies the
DB_UNIQUE_NAME
of the peer database to be created. - 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]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Encryption
Key DatabaseLocation Details Database Encryption Key Location Details - Types of providers supported for managing database encryption keys
- map[string]string
- (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
Active boolData Guard Enabled - True if active Data Guard is enabled.
- 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. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- 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.
- Pluggable
Databases []string - The list of pluggable databases that needs to be restored into new database.
- Protection
Mode string - The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.
- Sid
Prefix string - Specifies a prefix for the
Oracle SID
of the database to be created. - Source
Database stringId - The OCID of the source database.
- Source
Encryption DatabaseKey Location Details Database Source Encryption Key Location Details - Types of providers supported for managing database encryption keys
- Source
Tde stringWallet Password - The TDE wallet password of the source database specified by 'sourceDatabaseId'.
- 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 -.
- Transport
Type string The redo transport type to use for this Data Guard association. Valid values depend on the specified
protectionMode
:- MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
- MAXIMUM_PERFORMANCE - ASYNC
- MAXIMUM_PROTECTION - SYNC
For more information, see Redo Transport Services in the Oracle Data Guard documentation.
IMPORTANT - The only transport type currently supported by the Database service is ASYNC.
- Vault
Id string - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys.
- 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 -.
- 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
Admin StringPassword The administrator password of the primary database in this Data Guard association.
The password MUST be the same as the primary admin password.
- 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
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
Unique StringName - Specifies the
DB_UNIQUE_NAME
of the peer database to be created. - 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,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- encryption
Key EncryptionLocation Details Key Location Details - Types of providers supported for managing database encryption keys
- Map<String,String>
- (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
Active BooleanData Guard Enabled - True if active Data Guard is enabled.
- 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. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- 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.
- pluggable
Databases List<String> - The list of pluggable databases that needs to be restored into new database.
- protection
Mode String - The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.
- sid
Prefix String - Specifies a prefix for the
Oracle SID
of the database to be created. - source
Database StringId - The OCID of the source database.
- source
Encryption SourceKey Location Details Encryption Key Location Details - Types of providers supported for managing database encryption keys
- source
Tde StringWallet Password - The TDE wallet password of the source database specified by 'sourceDatabaseId'.
- 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 -.
- transport
Type String The redo transport type to use for this Data Guard association. Valid values depend on the specified
protectionMode
:- MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
- MAXIMUM_PERFORMANCE - ASYNC
- MAXIMUM_PROTECTION - SYNC
For more information, see Redo Transport Services in the Oracle Data Guard documentation.
IMPORTANT - The only transport type currently supported by the Database service is ASYNC.
- vault
Id String - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys.
- 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 -.
- 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
Admin stringPassword The administrator password of the primary database in this Data Guard association.
The password MUST be the same as the primary admin password.
- 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
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
Unique stringName - Specifies the
DB_UNIQUE_NAME
of the peer database to be created. - 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]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- encryption
Key DatabaseLocation Details Database Encryption Key Location Details - Types of providers supported for managing database encryption keys
- {[key: string]: string}
- (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
Active booleanData Guard Enabled - True if active Data Guard is enabled.
- 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. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- 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.
- pluggable
Databases string[] - The list of pluggable databases that needs to be restored into new database.
- protection
Mode string - The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.
- sid
Prefix string - Specifies a prefix for the
Oracle SID
of the database to be created. - source
Database stringId - The OCID of the source database.
- source
Encryption DatabaseKey Location Details Database Source Encryption Key Location Details - Types of providers supported for managing database encryption keys
- source
Tde stringWallet Password - The TDE wallet password of the source database specified by 'sourceDatabaseId'.
- 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 -.
- transport
Type string The redo transport type to use for this Data Guard association. Valid values depend on the specified
protectionMode
:- MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
- MAXIMUM_PERFORMANCE - ASYNC
- MAXIMUM_PROTECTION - SYNC
For more information, see Redo Transport Services in the Oracle Data Guard documentation.
IMPORTANT - The only transport type currently supported by the Database service is ASYNC.
- vault
Id string - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys.
- 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 -.
- 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_
admin_ strpassword The administrator password of the primary database in this Data Guard association.
The password MUST be the same as the primary admin password.
- 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_
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_
unique_ strname - Specifies the
DB_UNIQUE_NAME
of the peer database to be created. - 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, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- encryption_
key_ Databaselocation_ details Database Encryption Key Location Details - Types of providers supported for managing database encryption keys
- Mapping[str, str]
- (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_
active_ booldata_ guard_ enabled - True if active Data Guard is enabled.
- 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. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- 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.
- pluggable_
databases Sequence[str] - The list of pluggable databases that needs to be restored into new database.
- protection_
mode str - The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.
- sid_
prefix str - Specifies a prefix for the
Oracle SID
of the database to be created. - source_
database_ strid - The OCID of the source database.
- source_
encryption_ Databasekey_ location_ details Database Source Encryption Key Location Details - Types of providers supported for managing database encryption keys
- source_
tde_ strwallet_ password - The TDE wallet password of the source database specified by 'sourceDatabaseId'.
- 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 -.
- transport_
type str The redo transport type to use for this Data Guard association. Valid values depend on the specified
protectionMode
:- MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
- MAXIMUM_PERFORMANCE - ASYNC
- MAXIMUM_PROTECTION - SYNC
For more information, see Redo Transport Services in the Oracle Data Guard documentation.
IMPORTANT - The only transport type currently supported by the Database service is ASYNC.
- vault_
id str - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys.
- 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 -.
- 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
Admin StringPassword The administrator password of the primary database in this Data Guard association.
The password MUST be the same as the primary admin password.
- 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
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
Unique StringName - Specifies the
DB_UNIQUE_NAME
of the peer database to be created. - 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>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- encryption
Key Property MapLocation Details - Types of providers supported for managing database encryption keys
- Map<String>
- (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
Active BooleanData Guard Enabled - True if active Data Guard is enabled.
- 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. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- 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.
- pluggable
Databases List<String> - The list of pluggable databases that needs to be restored into new database.
- protection
Mode String - The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.
- sid
Prefix String - Specifies a prefix for the
Oracle SID
of the database to be created. - source
Database StringId - The OCID of the source database.
- source
Encryption Property MapKey Location Details - Types of providers supported for managing database encryption keys
- source
Tde StringWallet Password - The TDE wallet password of the source database specified by 'sourceDatabaseId'.
- 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 -.
- transport
Type String The redo transport type to use for this Data Guard association. Valid values depend on the specified
protectionMode
:- MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
- MAXIMUM_PERFORMANCE - ASYNC
- MAXIMUM_PROTECTION - SYNC
For more information, see Redo Transport Services in the Oracle Data Guard documentation.
IMPORTANT - The only transport type currently supported by the Database service is ASYNC.
- vault
Id String - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys.
DatabaseDatabaseDbBackupConfig, DatabaseDatabaseDbBackupConfigArgs
- 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_ Sequence[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, DatabaseDatabaseDbBackupConfigBackupDestinationDetailArgs
DatabaseDatabaseEncryptionKeyLocationDetails, DatabaseDatabaseEncryptionKeyLocationDetailsArgs
- Hsm
Password string - Provide the HSM password as you would in RDBMS for External HSM.
- Provider
Type string - Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.
- Hsm
Password string - Provide the HSM password as you would in RDBMS for External HSM.
- Provider
Type string - Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.
- hsm
Password String - Provide the HSM password as you would in RDBMS for External HSM.
- provider
Type String - Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.
- hsm
Password string - Provide the HSM password as you would in RDBMS for External HSM.
- provider
Type string - Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.
- hsm_
password str - Provide the HSM password as you would in RDBMS for External HSM.
- provider_
type str - Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.
- hsm
Password String - Provide the HSM password as you would in RDBMS for External HSM.
- provider
Type String - Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.
DatabaseDatabaseManagementConfig, DatabaseDatabaseManagementConfigArgs
- 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.
DatabaseDatabaseSourceEncryptionKeyLocationDetails, DatabaseDatabaseSourceEncryptionKeyLocationDetailsArgs
- Hsm
Password string - Provide the HSM password as you would in RDBMS for External HSM.
- Provider
Type string - Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.
- Hsm
Password string - Provide the HSM password as you would in RDBMS for External HSM.
- Provider
Type string - Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.
- hsm
Password String - Provide the HSM password as you would in RDBMS for External HSM.
- provider
Type String - Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.
- hsm
Password string - Provide the HSM password as you would in RDBMS for External HSM.
- provider
Type string - Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.
- hsm_
password str - Provide the HSM password as you would in RDBMS for External HSM.
- provider_
type str - Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.
- hsm
Password String - Provide the HSM password as you would in RDBMS for External HSM.
- provider
Type String - Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.
DatabaseDbBackupConfig, DatabaseDbBackupConfigArgs
- Auto
Backup boolEnabled - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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_ Sequence[Databasedetails Db Backup Config Backup Destination Detail] - Backup destination details.
- recovery_
window_ intin_ days - 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 - 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 - 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 - 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, DatabaseDbBackupConfigBackupDestinationDetailArgs
Import
Databases can be imported using the id
, e.g.
$ pulumi import oci:Database/database:Database test_database "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.