1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Database
  5. DatabaseUpgrade
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.Database.DatabaseUpgrade

Explore with Pulumi AI

This resource provides the Database Upgrade resource in Oracle Cloud Infrastructure Database service.

Upgrades the specified Oracle Database instance.

Database upgrade requires source to be DB_VERSION or DB_SOFTWARE_IMAGE. db_home.0.db_version is updated to target DB version specified in the upgrade request. To avoid a force new create of the db_home on the next apply, add the following to the resource lifecycle { ignore_changes = [ db_home.0.db_version, ] }

Example Usage

Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
resources:
  testDatabaseUpgrade:
    type: oci:Database:DatabaseUpgrade
    name: test_database_upgrade
    properties:
      action: ${databaseUpgradeAction}
      databaseId: ${testDatabase.id}
      databaseUpgradeSourceDetails:
        databaseSoftwareImageId: ${testDatabaseSoftwareImage.id}
        dbHomeId: ${testDbHome.id}
        dbVersion: ${databaseUpgradeDatabaseUpgradeSourceDetailsDbVersion}
        options: ${databaseUpgradeDatabaseUpgradeSourceDetailsOptions}
        source: ${databaseUpgradeDatabaseUpgradeSourceDetailsSource}
Copy

Create DatabaseUpgrade Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new DatabaseUpgrade(name: string, args: DatabaseUpgradeArgs, opts?: CustomResourceOptions);
@overload
def DatabaseUpgrade(resource_name: str,
                    args: DatabaseUpgradeArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def DatabaseUpgrade(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    action: Optional[str] = None,
                    database_id: Optional[str] = None,
                    database_upgrade_source_details: Optional[_database.DatabaseUpgradeDatabaseUpgradeSourceDetailsArgs] = None)
func NewDatabaseUpgrade(ctx *Context, name string, args DatabaseUpgradeArgs, opts ...ResourceOption) (*DatabaseUpgrade, error)
public DatabaseUpgrade(string name, DatabaseUpgradeArgs args, CustomResourceOptions? opts = null)
public DatabaseUpgrade(String name, DatabaseUpgradeArgs args)
public DatabaseUpgrade(String name, DatabaseUpgradeArgs args, CustomResourceOptions options)
type: oci:Database:DatabaseUpgrade
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DatabaseUpgradeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DatabaseUpgradeArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DatabaseUpgradeArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DatabaseUpgradeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DatabaseUpgradeArgs
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 databaseUpgradeResource = new Oci.Database.DatabaseUpgrade("databaseUpgradeResource", new()
{
    Action = "string",
    DatabaseId = "string",
    DatabaseUpgradeSourceDetails = new Oci.Database.Inputs.DatabaseUpgradeDatabaseUpgradeSourceDetailsArgs
    {
        DatabaseSoftwareImageId = "string",
        DbVersion = "string",
        Options = "string",
        Source = "string",
    },
});
Copy
example, err := Database.NewDatabaseUpgrade(ctx, "databaseUpgradeResource", &Database.DatabaseUpgradeArgs{
	Action:     pulumi.String("string"),
	DatabaseId: pulumi.String("string"),
	DatabaseUpgradeSourceDetails: &database.DatabaseUpgradeDatabaseUpgradeSourceDetailsArgs{
		DatabaseSoftwareImageId: pulumi.String("string"),
		DbVersion:               pulumi.String("string"),
		Options:                 pulumi.String("string"),
		Source:                  pulumi.String("string"),
	},
})
Copy
var databaseUpgradeResource = new DatabaseUpgrade("databaseUpgradeResource", DatabaseUpgradeArgs.builder()
    .action("string")
    .databaseId("string")
    .databaseUpgradeSourceDetails(DatabaseUpgradeDatabaseUpgradeSourceDetailsArgs.builder()
        .databaseSoftwareImageId("string")
        .dbVersion("string")
        .options("string")
        .source("string")
        .build())
    .build());
Copy
database_upgrade_resource = oci.database.DatabaseUpgrade("databaseUpgradeResource",
    action="string",
    database_id="string",
    database_upgrade_source_details={
        "database_software_image_id": "string",
        "db_version": "string",
        "options": "string",
        "source": "string",
    })
Copy
const databaseUpgradeResource = new oci.database.DatabaseUpgrade("databaseUpgradeResource", {
    action: "string",
    databaseId: "string",
    databaseUpgradeSourceDetails: {
        databaseSoftwareImageId: "string",
        dbVersion: "string",
        options: "string",
        source: "string",
    },
});
Copy
type: oci:Database:DatabaseUpgrade
properties:
    action: string
    databaseId: string
    databaseUpgradeSourceDetails:
        databaseSoftwareImageId: string
        dbVersion: string
        options: string
        source: string
Copy

DatabaseUpgrade 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 DatabaseUpgrade resource accepts the following input properties:

Action
This property is required.
Changes to this property will trigger replacement.
string
The database upgrade action.
DatabaseId
This property is required.
Changes to this property will trigger replacement.
string
The database OCID.
DatabaseUpgradeSourceDetails Changes to this property will trigger replacement. DatabaseUpgradeDatabaseUpgradeSourceDetails
Details for the database upgrade source.
Action
This property is required.
Changes to this property will trigger replacement.
string
The database upgrade action.
DatabaseId
This property is required.
Changes to this property will trigger replacement.
string
The database OCID.
DatabaseUpgradeSourceDetails Changes to this property will trigger replacement. DatabaseUpgradeDatabaseUpgradeSourceDetailsArgs
Details for the database upgrade source.
action
This property is required.
Changes to this property will trigger replacement.
String
The database upgrade action.
databaseId
This property is required.
Changes to this property will trigger replacement.
String
The database OCID.
databaseUpgradeSourceDetails Changes to this property will trigger replacement. UpgradeUpgradeSourceDetails
Details for the database upgrade source.
action
This property is required.
Changes to this property will trigger replacement.
string
The database upgrade action.
databaseId
This property is required.
Changes to this property will trigger replacement.
string
The database OCID.
databaseUpgradeSourceDetails Changes to this property will trigger replacement. DatabaseUpgradeDatabaseUpgradeSourceDetails
Details for the database upgrade source.
action
This property is required.
Changes to this property will trigger replacement.
str
The database upgrade action.
database_id
This property is required.
Changes to this property will trigger replacement.
str
The database OCID.
database_upgrade_source_details Changes to this property will trigger replacement. database.DatabaseUpgradeDatabaseUpgradeSourceDetailsArgs
Details for the database upgrade source.
action
This property is required.
Changes to this property will trigger replacement.
String
The database upgrade action.
databaseId
This property is required.
Changes to this property will trigger replacement.
String
The database OCID.
databaseUpgradeSourceDetails Changes to this property will trigger replacement. Property Map
Details for the database upgrade source.

Outputs

All input properties are implicitly available as output properties. Additionally, the DatabaseUpgrade resource produces the following output properties:

CharacterSet string
The character set for the database.
CompartmentId string
The OCID of the compartment.
ConnectionStrings List<DatabaseUpgradeConnectionString>
The Connection strings used to connect to the Oracle Database.
DataGuardGroups List<DatabaseUpgradeDataGuardGroup>
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.
DatabaseSoftwareImageId string
The database software image OCID
DbBackupConfigs List<DatabaseUpgradeDbBackupConfig>
Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
DbHomeId string
The OCID of the Database Home.
DbName string
The database name.
DbSystemId string
The OCID of the DB system.
DbUniqueName string
A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
DbWorkload string
Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
DefinedTags Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
FreeformTags Dictionary<string, string>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string
The provider-assigned unique ID for this managed resource.
IsCdb bool
True if the database is a container database.
KeyStoreId string
The OCID of the key store of Oracle Vault.
KeyStoreWalletName string
The wallet name for Oracle Key Vault.
KmsKeyId string
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
KmsKeyVersionId string
The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
LastBackupDurationInSeconds int
The duration when the latest database backup created.
LastBackupTimestamp string
The date and time when the latest database backup was created.
LastFailedBackupTimestamp string
The date and time when the latest database backup failed.
LifecycleDetails string
Additional information about the current lifecycle state.
NcharacterSet string
The national character set for the database.
PdbName string
The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
SidPrefix string
Specifies a prefix for the Oracle SID of the database to be created.
SourceDatabasePointInTimeRecoveryTimestamp string
Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
State string
The current state of the database.
TimeCreated string
The date and time the database was created.
VaultId string
The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
VmClusterId string
The OCID of the VM cluster.
CharacterSet string
The character set for the database.
CompartmentId string
The OCID of the compartment.
ConnectionStrings []DatabaseUpgradeConnectionString
The Connection strings used to connect to the Oracle Database.
DataGuardGroups []DatabaseUpgradeDataGuardGroup
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.
DatabaseSoftwareImageId string
The database software image OCID
DbBackupConfigs []DatabaseUpgradeDbBackupConfig
Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
DbHomeId string
The OCID of the Database Home.
DbName string
The database name.
DbSystemId string
The OCID of the DB system.
DbUniqueName string
A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
DbWorkload string
Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
DefinedTags map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
FreeformTags map[string]string
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string
The provider-assigned unique ID for this managed resource.
IsCdb bool
True if the database is a container database.
KeyStoreId string
The OCID of the key store of Oracle Vault.
KeyStoreWalletName string
The wallet name for Oracle Key Vault.
KmsKeyId string
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
KmsKeyVersionId string
The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
LastBackupDurationInSeconds int
The duration when the latest database backup created.
LastBackupTimestamp string
The date and time when the latest database backup was created.
LastFailedBackupTimestamp string
The date and time when the latest database backup failed.
LifecycleDetails string
Additional information about the current lifecycle state.
NcharacterSet string
The national character set for the database.
PdbName string
The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
SidPrefix string
Specifies a prefix for the Oracle SID of the database to be created.
SourceDatabasePointInTimeRecoveryTimestamp string
Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
State string
The current state of the database.
TimeCreated string
The date and time the database was created.
VaultId string
The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
VmClusterId string
The OCID of the VM cluster.
characterSet String
The character set for the database.
compartmentId String
The OCID of the compartment.
connectionStrings List<UpgradeConnectionString>
The Connection strings used to connect to the Oracle Database.
dataGuardGroups List<UpgradeDataGuardGroup>
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.
databaseSoftwareImageId String
The database software image OCID
dbBackupConfigs List<UpgradeDbBackupConfig>
Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
dbHomeId String
The OCID of the Database Home.
dbName String
The database name.
dbSystemId String
The OCID of the DB system.
dbUniqueName String
A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
dbWorkload String
Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
definedTags Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
freeformTags Map<String,String>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String
The provider-assigned unique ID for this managed resource.
isCdb Boolean
True if the database is a container database.
keyStoreId String
The OCID of the key store of Oracle Vault.
keyStoreWalletName String
The wallet name for Oracle Key Vault.
kmsKeyId String
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId String
The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
lastBackupDurationInSeconds Integer
The duration when the latest database backup created.
lastBackupTimestamp String
The date and time when the latest database backup was created.
lastFailedBackupTimestamp String
The date and time when the latest database backup failed.
lifecycleDetails String
Additional information about the current lifecycle state.
ncharacterSet String
The national character set for the database.
pdbName String
The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
sidPrefix String
Specifies a prefix for the Oracle SID of the database to be created.
sourceDatabasePointInTimeRecoveryTimestamp String
Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
state String
The current state of the database.
timeCreated String
The date and time the database was created.
vaultId String
The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
vmClusterId String
The OCID of the VM cluster.
characterSet string
The character set for the database.
compartmentId string
The OCID of the compartment.
connectionStrings DatabaseUpgradeConnectionString[]
The Connection strings used to connect to the Oracle Database.
dataGuardGroups DatabaseUpgradeDataGuardGroup[]
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.
databaseSoftwareImageId string
The database software image OCID
dbBackupConfigs DatabaseUpgradeDbBackupConfig[]
Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
dbHomeId string
The OCID of the Database Home.
dbName string
The database name.
dbSystemId string
The OCID of the DB system.
dbUniqueName string
A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
dbWorkload string
Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
definedTags {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
freeformTags {[key: string]: string}
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id string
The provider-assigned unique ID for this managed resource.
isCdb boolean
True if the database is a container database.
keyStoreId string
The OCID of the key store of Oracle Vault.
keyStoreWalletName string
The wallet name for Oracle Key Vault.
kmsKeyId string
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId string
The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
lastBackupDurationInSeconds number
The duration when the latest database backup created.
lastBackupTimestamp string
The date and time when the latest database backup was created.
lastFailedBackupTimestamp string
The date and time when the latest database backup failed.
lifecycleDetails string
Additional information about the current lifecycle state.
ncharacterSet string
The national character set for the database.
pdbName string
The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
sidPrefix string
Specifies a prefix for the Oracle SID of the database to be created.
sourceDatabasePointInTimeRecoveryTimestamp string
Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
state string
The current state of the database.
timeCreated string
The date and time the database was created.
vaultId string
The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
vmClusterId string
The OCID of the VM cluster.
character_set str
The character set for the database.
compartment_id str
The OCID of the compartment.
connection_strings Sequence[database.DatabaseUpgradeConnectionString]
The Connection strings used to connect to the Oracle Database.
data_guard_groups Sequence[database.DatabaseUpgradeDataGuardGroup]
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_software_image_id str
The database software image OCID
db_backup_configs Sequence[database.DatabaseUpgradeDbBackupConfig]
Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
db_home_id str
The OCID of the Database Home.
db_name str
The database name.
db_system_id str
The OCID of the DB system.
db_unique_name str
A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
db_workload str
Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
defined_tags Mapping[str, str]
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
freeform_tags Mapping[str, str]
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id str
The provider-assigned unique ID for this managed resource.
is_cdb bool
True if the database is a container database.
key_store_id str
The OCID of the key store of Oracle Vault.
key_store_wallet_name str
The wallet name for Oracle Key Vault.
kms_key_id str
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kms_key_version_id str
The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
last_backup_duration_in_seconds int
The duration when the latest database backup created.
last_backup_timestamp str
The date and time when the latest database backup was created.
last_failed_backup_timestamp str
The date and time when the latest database backup failed.
lifecycle_details str
Additional information about the current lifecycle state.
ncharacter_set str
The national character set for the database.
pdb_name str
The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
sid_prefix str
Specifies a prefix for the Oracle SID of the database to be created.
source_database_point_in_time_recovery_timestamp str
Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
state str
The current state of the database.
time_created str
The date and time the database was created.
vault_id str
The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
vm_cluster_id str
The OCID of the VM cluster.
characterSet String
The character set for the database.
compartmentId String
The OCID of the compartment.
connectionStrings List<Property Map>
The Connection strings used to connect to the Oracle Database.
dataGuardGroups List<Property Map>
Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
databaseSoftwareImageId String
The database software image OCID
dbBackupConfigs List<Property Map>
Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
dbHomeId String
The OCID of the Database Home.
dbName String
The database name.
dbSystemId String
The OCID of the DB system.
dbUniqueName String
A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
dbWorkload String
Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
definedTags Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
freeformTags Map<String>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String
The provider-assigned unique ID for this managed resource.
isCdb Boolean
True if the database is a container database.
keyStoreId String
The OCID of the key store of Oracle Vault.
keyStoreWalletName String
The wallet name for Oracle Key Vault.
kmsKeyId String
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId String
The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
lastBackupDurationInSeconds Number
The duration when the latest database backup created.
lastBackupTimestamp String
The date and time when the latest database backup was created.
lastFailedBackupTimestamp String
The date and time when the latest database backup failed.
lifecycleDetails String
Additional information about the current lifecycle state.
ncharacterSet String
The national character set for the database.
pdbName String
The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
sidPrefix String
Specifies a prefix for the Oracle SID of the database to be created.
sourceDatabasePointInTimeRecoveryTimestamp String
Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
state String
The current state of the database.
timeCreated String
The date and time the database was created.
vaultId String
The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
vmClusterId String
The OCID of the VM cluster.

Look up Existing DatabaseUpgrade Resource

Get an existing DatabaseUpgrade 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?: DatabaseUpgradeState, opts?: CustomResourceOptions): DatabaseUpgrade
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[str] = None,
        character_set: Optional[str] = None,
        compartment_id: Optional[str] = None,
        connection_strings: Optional[Sequence[_database.DatabaseUpgradeConnectionStringArgs]] = None,
        data_guard_groups: Optional[Sequence[_database.DatabaseUpgradeDataGuardGroupArgs]] = None,
        database_id: Optional[str] = None,
        database_software_image_id: Optional[str] = None,
        database_upgrade_source_details: Optional[_database.DatabaseUpgradeDatabaseUpgradeSourceDetailsArgs] = None,
        db_backup_configs: Optional[Sequence[_database.DatabaseUpgradeDbBackupConfigArgs]] = 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_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_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_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) -> DatabaseUpgrade
func GetDatabaseUpgrade(ctx *Context, name string, id IDInput, state *DatabaseUpgradeState, opts ...ResourceOption) (*DatabaseUpgrade, error)
public static DatabaseUpgrade Get(string name, Input<string> id, DatabaseUpgradeState? state, CustomResourceOptions? opts = null)
public static DatabaseUpgrade get(String name, Output<String> id, DatabaseUpgradeState state, CustomResourceOptions options)
resources:  _:    type: oci:Database:DatabaseUpgrade    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
The following state arguments are supported:
Action Changes to this property will trigger replacement. string
The database upgrade action.
CharacterSet string
The character set for the database.
CompartmentId string
The OCID of the compartment.
ConnectionStrings List<DatabaseUpgradeConnectionString>
The Connection strings used to connect to the Oracle Database.
DataGuardGroups List<DatabaseUpgradeDataGuardGroup>
Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
DatabaseId Changes to this property will trigger replacement. string
The database OCID.
DatabaseSoftwareImageId string
The database software image OCID
DatabaseUpgradeSourceDetails Changes to this property will trigger replacement. DatabaseUpgradeDatabaseUpgradeSourceDetails
Details for the database upgrade source.
DbBackupConfigs List<DatabaseUpgradeDbBackupConfig>
Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
DbHomeId string
The OCID of the Database Home.
DbName string
The database name.
DbSystemId string
The OCID of the DB system.
DbUniqueName string
A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
DbWorkload string
Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
DefinedTags Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
FreeformTags Dictionary<string, string>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
IsCdb bool
True if the database is a container database.
KeyStoreId string
The OCID of the key store of Oracle Vault.
KeyStoreWalletName string
The wallet name for Oracle Key Vault.
KmsKeyId string
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
KmsKeyVersionId string
The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
LastBackupDurationInSeconds int
The duration when the latest database backup created.
LastBackupTimestamp string
The date and time when the latest database backup was created.
LastFailedBackupTimestamp string
The date and time when the latest database backup failed.
LifecycleDetails string
Additional information about the current lifecycle state.
NcharacterSet string
The national character set for the database.
PdbName string
The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
SidPrefix string
Specifies a prefix for the Oracle SID of the database to be created.
SourceDatabasePointInTimeRecoveryTimestamp string
Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
State string
The current state of the database.
TimeCreated string
The date and time the database was created.
VaultId string
The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
VmClusterId string
The OCID of the VM cluster.
Action Changes to this property will trigger replacement. string
The database upgrade action.
CharacterSet string
The character set for the database.
CompartmentId string
The OCID of the compartment.
ConnectionStrings []DatabaseUpgradeConnectionStringArgs
The Connection strings used to connect to the Oracle Database.
DataGuardGroups []DatabaseUpgradeDataGuardGroupArgs
Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
DatabaseId Changes to this property will trigger replacement. string
The database OCID.
DatabaseSoftwareImageId string
The database software image OCID
DatabaseUpgradeSourceDetails Changes to this property will trigger replacement. DatabaseUpgradeDatabaseUpgradeSourceDetailsArgs
Details for the database upgrade source.
DbBackupConfigs []DatabaseUpgradeDbBackupConfigArgs
Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
DbHomeId string
The OCID of the Database Home.
DbName string
The database name.
DbSystemId string
The OCID of the DB system.
DbUniqueName string
A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
DbWorkload string
Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
DefinedTags map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
FreeformTags map[string]string
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
IsCdb bool
True if the database is a container database.
KeyStoreId string
The OCID of the key store of Oracle Vault.
KeyStoreWalletName string
The wallet name for Oracle Key Vault.
KmsKeyId string
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
KmsKeyVersionId string
The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
LastBackupDurationInSeconds int
The duration when the latest database backup created.
LastBackupTimestamp string
The date and time when the latest database backup was created.
LastFailedBackupTimestamp string
The date and time when the latest database backup failed.
LifecycleDetails string
Additional information about the current lifecycle state.
NcharacterSet string
The national character set for the database.
PdbName string
The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
SidPrefix string
Specifies a prefix for the Oracle SID of the database to be created.
SourceDatabasePointInTimeRecoveryTimestamp string
Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
State string
The current state of the database.
TimeCreated string
The date and time the database was created.
VaultId string
The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
VmClusterId string
The OCID of the VM cluster.
action Changes to this property will trigger replacement. String
The database upgrade action.
characterSet String
The character set for the database.
compartmentId String
The OCID of the compartment.
connectionStrings List<UpgradeConnectionString>
The Connection strings used to connect to the Oracle Database.
dataGuardGroups List<UpgradeDataGuardGroup>
Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
databaseId Changes to this property will trigger replacement. String
The database OCID.
databaseSoftwareImageId String
The database software image OCID
databaseUpgradeSourceDetails Changes to this property will trigger replacement. UpgradeUpgradeSourceDetails
Details for the database upgrade source.
dbBackupConfigs List<UpgradeDbBackupConfig>
Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
dbHomeId String
The OCID of the Database Home.
dbName String
The database name.
dbSystemId String
The OCID of the DB system.
dbUniqueName String
A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
dbWorkload String
Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
definedTags Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
freeformTags Map<String,String>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
isCdb Boolean
True if the database is a container database.
keyStoreId String
The OCID of the key store of Oracle Vault.
keyStoreWalletName String
The wallet name for Oracle Key Vault.
kmsKeyId String
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId String
The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
lastBackupDurationInSeconds Integer
The duration when the latest database backup created.
lastBackupTimestamp String
The date and time when the latest database backup was created.
lastFailedBackupTimestamp String
The date and time when the latest database backup failed.
lifecycleDetails String
Additional information about the current lifecycle state.
ncharacterSet String
The national character set for the database.
pdbName String
The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
sidPrefix String
Specifies a prefix for the Oracle SID of the database to be created.
sourceDatabasePointInTimeRecoveryTimestamp String
Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
state String
The current state of the database.
timeCreated String
The date and time the database was created.
vaultId String
The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
vmClusterId String
The OCID of the VM cluster.
action Changes to this property will trigger replacement. string
The database upgrade action.
characterSet string
The character set for the database.
compartmentId string
The OCID of the compartment.
connectionStrings DatabaseUpgradeConnectionString[]
The Connection strings used to connect to the Oracle Database.
dataGuardGroups DatabaseUpgradeDataGuardGroup[]
Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
databaseId Changes to this property will trigger replacement. string
The database OCID.
databaseSoftwareImageId string
The database software image OCID
databaseUpgradeSourceDetails Changes to this property will trigger replacement. DatabaseUpgradeDatabaseUpgradeSourceDetails
Details for the database upgrade source.
dbBackupConfigs DatabaseUpgradeDbBackupConfig[]
Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
dbHomeId string
The OCID of the Database Home.
dbName string
The database name.
dbSystemId string
The OCID of the DB system.
dbUniqueName string
A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
dbWorkload string
Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
definedTags {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
freeformTags {[key: string]: string}
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
isCdb boolean
True if the database is a container database.
keyStoreId string
The OCID of the key store of Oracle Vault.
keyStoreWalletName string
The wallet name for Oracle Key Vault.
kmsKeyId string
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId string
The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
lastBackupDurationInSeconds number
The duration when the latest database backup created.
lastBackupTimestamp string
The date and time when the latest database backup was created.
lastFailedBackupTimestamp string
The date and time when the latest database backup failed.
lifecycleDetails string
Additional information about the current lifecycle state.
ncharacterSet string
The national character set for the database.
pdbName string
The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
sidPrefix string
Specifies a prefix for the Oracle SID of the database to be created.
sourceDatabasePointInTimeRecoveryTimestamp string
Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
state string
The current state of the database.
timeCreated string
The date and time the database was created.
vaultId string
The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
vmClusterId string
The OCID of the VM cluster.
action Changes to this property will trigger replacement. str
The database upgrade action.
character_set str
The character set for the database.
compartment_id str
The OCID of the compartment.
connection_strings Sequence[database.DatabaseUpgradeConnectionStringArgs]
The Connection strings used to connect to the Oracle Database.
data_guard_groups Sequence[database.DatabaseUpgradeDataGuardGroupArgs]
Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
database_id Changes to this property will trigger replacement. str
The database OCID.
database_software_image_id str
The database software image OCID
database_upgrade_source_details Changes to this property will trigger replacement. database.DatabaseUpgradeDatabaseUpgradeSourceDetailsArgs
Details for the database upgrade source.
db_backup_configs Sequence[database.DatabaseUpgradeDbBackupConfigArgs]
Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
db_home_id str
The OCID of the Database Home.
db_name str
The database name.
db_system_id str
The OCID of the DB system.
db_unique_name str
A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
db_workload str
Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
defined_tags Mapping[str, str]
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
freeform_tags Mapping[str, str]
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
is_cdb bool
True if the database is a container database.
key_store_id str
The OCID of the key store of Oracle Vault.
key_store_wallet_name str
The wallet name for Oracle Key Vault.
kms_key_id str
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kms_key_version_id str
The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
last_backup_duration_in_seconds int
The duration when the latest database backup created.
last_backup_timestamp str
The date and time when the latest database backup was created.
last_failed_backup_timestamp str
The date and time when the latest database backup failed.
lifecycle_details str
Additional information about the current lifecycle state.
ncharacter_set str
The national character set for the database.
pdb_name str
The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
sid_prefix str
Specifies a prefix for the Oracle SID of the database to be created.
source_database_point_in_time_recovery_timestamp str
Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
state str
The current state of the database.
time_created str
The date and time the database was created.
vault_id str
The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
vm_cluster_id str
The OCID of the VM cluster.
action Changes to this property will trigger replacement. String
The database upgrade action.
characterSet String
The character set for the database.
compartmentId String
The OCID of the compartment.
connectionStrings List<Property Map>
The Connection strings used to connect to the Oracle Database.
dataGuardGroups List<Property Map>
Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
databaseId Changes to this property will trigger replacement. String
The database OCID.
databaseSoftwareImageId String
The database software image OCID
databaseUpgradeSourceDetails Changes to this property will trigger replacement. Property Map
Details for the database upgrade source.
dbBackupConfigs List<Property Map>
Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
dbHomeId String
The OCID of the Database Home.
dbName String
The database name.
dbSystemId String
The OCID of the DB system.
dbUniqueName String
A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
dbWorkload String
Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
definedTags Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
freeformTags Map<String>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
isCdb Boolean
True if the database is a container database.
keyStoreId String
The OCID of the key store of Oracle Vault.
keyStoreWalletName String
The wallet name for Oracle Key Vault.
kmsKeyId String
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId String
The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
lastBackupDurationInSeconds Number
The duration when the latest database backup created.
lastBackupTimestamp String
The date and time when the latest database backup was created.
lastFailedBackupTimestamp String
The date and time when the latest database backup failed.
lifecycleDetails String
Additional information about the current lifecycle state.
ncharacterSet String
The national character set for the database.
pdbName String
The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
sidPrefix String
Specifies a prefix for the Oracle SID of the database to be created.
sourceDatabasePointInTimeRecoveryTimestamp String
Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
state String
The current state of the database.
timeCreated String
The date and time the database was created.
vaultId String
The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
vmClusterId String
The OCID of the VM cluster.

Supporting Types

DatabaseUpgradeConnectionString
, DatabaseUpgradeConnectionStringArgs

AllConnectionStrings Dictionary<string, string>
All connection strings to use to connect to the Database.
CdbDefault string
Host name based CDB Connection String.
CdbIpDefault string
IP based CDB Connection String.
AllConnectionStrings map[string]string
All connection strings to use to connect to the Database.
CdbDefault string
Host name based CDB Connection String.
CdbIpDefault string
IP based CDB Connection String.
allConnectionStrings Map<String,String>
All connection strings to use to connect to the Database.
cdbDefault String
Host name based CDB Connection String.
cdbIpDefault String
IP based CDB Connection String.
allConnectionStrings {[key: string]: string}
All connection strings to use to connect to the Database.
cdbDefault string
Host name based CDB Connection String.
cdbIpDefault string
IP based CDB Connection String.
all_connection_strings Mapping[str, str]
All connection strings to use to connect to the Database.
cdb_default str
Host name based CDB Connection String.
cdb_ip_default str
IP based CDB Connection String.
allConnectionStrings Map<String>
All connection strings to use to connect to the Database.
cdbDefault String
Host name based CDB Connection String.
cdbIpDefault String
IP based CDB Connection String.

DatabaseUpgradeDataGuardGroup
, DatabaseUpgradeDataGuardGroupArgs

Members List<DatabaseUpgradeDataGuardGroupMember>
List of Data Guard members, representing each database that is part of Data Guard.
ProtectionMode string
The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.
Members []DatabaseUpgradeDataGuardGroupMember
List of Data Guard members, representing each database that is part of Data Guard.
ProtectionMode string
The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.
members List<UpgradeDataGuardGroupMember>
List of Data Guard members, representing each database that is part of Data Guard.
protectionMode String
The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.
members DatabaseUpgradeDataGuardGroupMember[]
List of Data Guard members, representing each database that is part of Data Guard.
protectionMode string
The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.
members Sequence[database.DatabaseUpgradeDataGuardGroupMember]
List of Data Guard members, representing each database that is part of Data Guard.
protection_mode str
The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.
members List<Property Map>
List of Data Guard members, representing each database that is part of Data Guard.
protectionMode String
The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

DatabaseUpgradeDataGuardGroupMember
, DatabaseUpgradeDataGuardGroupMemberArgs

ApplyLag string
The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 1 second
ApplyRate string
The rate at which redo logs are synced between the associated databases. Example: 102.96 MByte/s
DatabaseId string
The database OCID.
DbSystemId string
The OCID of the DB system.
IsActiveDataGuardEnabled bool
True if active Data Guard is enabled.
Role string
The role of the reporting database in this Data Guard association.
TransportLag string
The rate at which redo logs are transported between the associated databases. Example: 1 second
TransportLagRefresh string
The date and time when last redo transport has been done.
TransportType string
The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

  • MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
  • MAXIMUM_PERFORMANCE - ASYNC
  • MAXIMUM_PROTECTION - SYNC
ApplyLag string
The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 1 second
ApplyRate string
The rate at which redo logs are synced between the associated databases. Example: 102.96 MByte/s
DatabaseId string
The database OCID.
DbSystemId string
The OCID of the DB system.
IsActiveDataGuardEnabled bool
True if active Data Guard is enabled.
Role string
The role of the reporting database in this Data Guard association.
TransportLag string
The rate at which redo logs are transported between the associated databases. Example: 1 second
TransportLagRefresh string
The date and time when last redo transport has been done.
TransportType string
The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

  • MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
  • MAXIMUM_PERFORMANCE - ASYNC
  • MAXIMUM_PROTECTION - SYNC
applyLag String
The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 1 second
applyRate String
The rate at which redo logs are synced between the associated databases. Example: 102.96 MByte/s
databaseId String
The database OCID.
dbSystemId String
The OCID of the DB system.
isActiveDataGuardEnabled Boolean
True if active Data Guard is enabled.
role String
The role of the reporting database in this Data Guard association.
transportLag String
The rate at which redo logs are transported between the associated databases. Example: 1 second
transportLagRefresh String
The date and time when last redo transport has been done.
transportType String
The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

  • MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
  • MAXIMUM_PERFORMANCE - ASYNC
  • MAXIMUM_PROTECTION - SYNC
applyLag string
The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 1 second
applyRate string
The rate at which redo logs are synced between the associated databases. Example: 102.96 MByte/s
databaseId string
The database OCID.
dbSystemId string
The OCID of the DB system.
isActiveDataGuardEnabled boolean
True if active Data Guard is enabled.
role string
The role of the reporting database in this Data Guard association.
transportLag string
The rate at which redo logs are transported between the associated databases. Example: 1 second
transportLagRefresh string
The date and time when last redo transport has been done.
transportType string
The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

  • MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
  • MAXIMUM_PERFORMANCE - ASYNC
  • MAXIMUM_PROTECTION - SYNC
apply_lag str
The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 1 second
apply_rate str
The rate at which redo logs are synced between the associated databases. Example: 102.96 MByte/s
database_id str
The database OCID.
db_system_id str
The OCID of the DB system.
is_active_data_guard_enabled bool
True if active Data Guard is enabled.
role str
The role of the reporting database in this Data Guard association.
transport_lag str
The rate at which redo logs are transported between the associated databases. Example: 1 second
transport_lag_refresh str
The date and time when last redo transport has been done.
transport_type str
The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

  • MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
  • MAXIMUM_PERFORMANCE - ASYNC
  • MAXIMUM_PROTECTION - SYNC
applyLag String
The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 1 second
applyRate String
The rate at which redo logs are synced between the associated databases. Example: 102.96 MByte/s
databaseId String
The database OCID.
dbSystemId String
The OCID of the DB system.
isActiveDataGuardEnabled Boolean
True if active Data Guard is enabled.
role String
The role of the reporting database in this Data Guard association.
transportLag String
The rate at which redo logs are transported between the associated databases. Example: 1 second
transportLagRefresh String
The date and time when last redo transport has been done.
transportType String
The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

  • MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
  • MAXIMUM_PERFORMANCE - ASYNC
  • MAXIMUM_PROTECTION - SYNC

DatabaseUpgradeDatabaseUpgradeSourceDetails
, DatabaseUpgradeDatabaseUpgradeSourceDetailsArgs

DatabaseSoftwareImageId Changes to this property will trigger replacement. string
The database software image OCID of the image to be used to upgrade a database.
DbVersion Changes to this property will trigger replacement. 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.

Options Changes to this property will trigger replacement. string
Additional upgrade options supported by DBUA(Database Upgrade Assistant). Example: "-upgradeTimezone false -keepEvents"
Source Changes to this property will trigger replacement. string

The source of the Oracle Database software to be used for the upgrade.

  • Use DB_VERSION to specify a generally-available Oracle Database software version to upgrade the database.
  • Use DB_SOFTWARE_IMAGE to specify a database software image to upgrade the database.

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

DatabaseSoftwareImageId Changes to this property will trigger replacement. string
The database software image OCID of the image to be used to upgrade a database.
DbVersion Changes to this property will trigger replacement. 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.

Options Changes to this property will trigger replacement. string
Additional upgrade options supported by DBUA(Database Upgrade Assistant). Example: "-upgradeTimezone false -keepEvents"
Source Changes to this property will trigger replacement. string

The source of the Oracle Database software to be used for the upgrade.

  • Use DB_VERSION to specify a generally-available Oracle Database software version to upgrade the database.
  • Use DB_SOFTWARE_IMAGE to specify a database software image to upgrade the database.

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

databaseSoftwareImageId Changes to this property will trigger replacement. String
The database software image OCID of the image to be used to upgrade a database.
dbVersion Changes to this property will trigger replacement. 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.

options Changes to this property will trigger replacement. String
Additional upgrade options supported by DBUA(Database Upgrade Assistant). Example: "-upgradeTimezone false -keepEvents"
source Changes to this property will trigger replacement. String

The source of the Oracle Database software to be used for the upgrade.

  • Use DB_VERSION to specify a generally-available Oracle Database software version to upgrade the database.
  • Use DB_SOFTWARE_IMAGE to specify a database software image to upgrade the database.

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

databaseSoftwareImageId Changes to this property will trigger replacement. string
The database software image OCID of the image to be used to upgrade a database.
dbVersion Changes to this property will trigger replacement. 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.

options Changes to this property will trigger replacement. string
Additional upgrade options supported by DBUA(Database Upgrade Assistant). Example: "-upgradeTimezone false -keepEvents"
source Changes to this property will trigger replacement. string

The source of the Oracle Database software to be used for the upgrade.

  • Use DB_VERSION to specify a generally-available Oracle Database software version to upgrade the database.
  • Use DB_SOFTWARE_IMAGE to specify a database software image to upgrade the database.

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

database_software_image_id Changes to this property will trigger replacement. str
The database software image OCID of the image to be used to upgrade a database.
db_version Changes to this property will trigger replacement. 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.

options Changes to this property will trigger replacement. str
Additional upgrade options supported by DBUA(Database Upgrade Assistant). Example: "-upgradeTimezone false -keepEvents"
source Changes to this property will trigger replacement. str

The source of the Oracle Database software to be used for the upgrade.

  • Use DB_VERSION to specify a generally-available Oracle Database software version to upgrade the database.
  • Use DB_SOFTWARE_IMAGE to specify a database software image to upgrade the database.

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

databaseSoftwareImageId Changes to this property will trigger replacement. String
The database software image OCID of the image to be used to upgrade a database.
dbVersion Changes to this property will trigger replacement. 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.

options Changes to this property will trigger replacement. String
Additional upgrade options supported by DBUA(Database Upgrade Assistant). Example: "-upgradeTimezone false -keepEvents"
source Changes to this property will trigger replacement. String

The source of the Oracle Database software to be used for the upgrade.

  • Use DB_VERSION to specify a generally-available Oracle Database software version to upgrade the database.
  • Use DB_SOFTWARE_IMAGE to specify a database software image to upgrade the database.

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

DatabaseUpgradeDbBackupConfig
, DatabaseUpgradeDbBackupConfigArgs

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

DatabaseUpgradeDbBackupConfigBackupDestinationDetail
, DatabaseUpgradeDbBackupConfigBackupDestinationDetailArgs

DbrsPolicyId string
The OCID of the DBRS policy used for backup.
Id string
The OCID of the database.
InternetProxy string
Proxy URL to connect to object store.
Type string
Type of the database backup destination.
VpcPassword string
For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
VpcUser string
For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.
DbrsPolicyId string
The OCID of the DBRS policy used for backup.
Id string
The OCID of the database.
InternetProxy string
Proxy URL to connect to object store.
Type string
Type of the database backup destination.
VpcPassword string
For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
VpcUser string
For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.
dbrsPolicyId String
The OCID of the DBRS policy used for backup.
id String
The OCID of the database.
internetProxy String
Proxy URL to connect to object store.
type String
Type of the database backup destination.
vpcPassword String
For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
vpcUser String
For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.
dbrsPolicyId string
The OCID of the DBRS policy used for backup.
id string
The OCID of the database.
internetProxy string
Proxy URL to connect to object store.
type string
Type of the database backup destination.
vpcPassword string
For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
vpcUser string
For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.
dbrs_policy_id str
The OCID of the DBRS policy used for backup.
id str
The OCID of the database.
internet_proxy str
Proxy URL to connect to object store.
type str
Type of the database backup destination.
vpc_password str
For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
vpc_user str
For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.
dbrsPolicyId String
The OCID of the DBRS policy used for backup.
id String
The OCID of the database.
internetProxy String
Proxy URL to connect to object store.
type String
Type of the database backup destination.
vpcPassword String
For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
vpcUser String
For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.

Import

Import is not supported for this resource.

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.