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}
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[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 string
- The unique name of the resource.
- args DatabaseUpgradeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args DatabaseUpgradeArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DatabaseUpgradeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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",
    },
});
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"),
	},
})
var databaseUpgradeResource = new DatabaseUpgrade("databaseUpgradeResource", DatabaseUpgradeArgs.builder()
    .action("string")
    .databaseId("string")
    .databaseUpgradeSourceDetails(DatabaseUpgradeDatabaseUpgradeSourceDetailsArgs.builder()
        .databaseSoftwareImageId("string")
        .dbVersion("string")
        .options("string")
        .source("string")
        .build())
    .build());
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",
    })
const databaseUpgradeResource = new oci.database.DatabaseUpgrade("databaseUpgradeResource", {
    action: "string",
    databaseId: "string",
    databaseUpgradeSourceDetails: {
        databaseSoftwareImageId: "string",
        dbVersion: "string",
        options: "string",
        source: "string",
    },
});
type: oci:Database:DatabaseUpgrade
properties:
    action: string
    databaseId: string
    databaseUpgradeSourceDetails:
        databaseSoftwareImageId: string
        dbVersion: string
        options: string
        source: string
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 string
- The database upgrade action.
- DatabaseId string
- The database OCID.
- DatabaseUpgrade DatabaseSource Details Upgrade Database Upgrade Source Details 
- Details for the database upgrade source.
- Action string
- The database upgrade action.
- DatabaseId string
- The database OCID.
- DatabaseUpgrade DatabaseSource Details Upgrade Database Upgrade Source Details Args 
- Details for the database upgrade source.
- action String
- The database upgrade action.
- databaseId String
- The database OCID.
- databaseUpgrade UpgradeSource Details Upgrade Source Details 
- Details for the database upgrade source.
- action string
- The database upgrade action.
- databaseId string
- The database OCID.
- databaseUpgrade DatabaseSource Details Upgrade Database Upgrade Source Details 
- Details for the database upgrade source.
- action str
- The database upgrade action.
- database_id str
- The database OCID.
- database_upgrade_ Databasesource_ details Upgrade Database Upgrade Source Details Args 
- Details for the database upgrade source.
- action String
- The database upgrade action.
- databaseId String
- The database OCID.
- databaseUpgrade Property MapSource Details 
- 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<DatabaseUpgrade Connection String> 
- The Connection strings used to connect to the Oracle Database.
- DataGuard List<DatabaseGroups Upgrade Data Guard Group> 
- Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
- DatabaseSoftware stringImage Id 
- The database software image OCID
- DbBackup List<DatabaseConfigs Upgrade Db Backup Config> 
- Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
- DbHome stringId 
- The OCID of the Database Home.
- DbName string
- The database name.
- DbSystem stringId 
- The OCID of the DB system.
- DbUnique stringName 
- A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- 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.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Dictionary<string, string>
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
- Id string
- The provider-assigned unique ID for this managed resource.
- IsCdb bool
- True if the database is a container database.
- KeyStore stringId 
- The OCID of the key store of Oracle Vault.
- KeyStore stringWallet Name 
- The wallet name for Oracle Key Vault.
- KmsKey stringId 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- KmsKey stringVersion Id 
- The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- LastBackup intDuration In Seconds 
- The duration when the latest database backup created.
- LastBackup stringTimestamp 
- The date and time when the latest database backup was created.
- LastFailed stringBackup Timestamp 
- 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 SIDof the database to be created.
- SourceDatabase stringPoint In Time Recovery Timestamp 
- Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
- State string
- The current state of the database.
- TimeCreated string
- The date and time the database was created.
- VaultId string
- The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretIdare required for Customer Managed Keys.
- VmCluster stringId 
- The OCID of the VM cluster.
- CharacterSet string
- The character set for the database.
- CompartmentId string
- The OCID of the compartment.
- ConnectionStrings []DatabaseUpgrade Connection String 
- The Connection strings used to connect to the Oracle Database.
- DataGuard []DatabaseGroups Upgrade Data Guard Group 
- Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
- DatabaseSoftware stringImage Id 
- The database software image OCID
- DbBackup []DatabaseConfigs Upgrade Db Backup Config 
- Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
- DbHome stringId 
- The OCID of the Database Home.
- DbName string
- The database name.
- DbSystem stringId 
- The OCID of the DB system.
- DbUnique stringName 
- A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- 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.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- map[string]string
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
- Id string
- The provider-assigned unique ID for this managed resource.
- IsCdb bool
- True if the database is a container database.
- KeyStore stringId 
- The OCID of the key store of Oracle Vault.
- KeyStore stringWallet Name 
- The wallet name for Oracle Key Vault.
- KmsKey stringId 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- KmsKey stringVersion Id 
- The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- LastBackup intDuration In Seconds 
- The duration when the latest database backup created.
- LastBackup stringTimestamp 
- The date and time when the latest database backup was created.
- LastFailed stringBackup Timestamp 
- 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 SIDof the database to be created.
- SourceDatabase stringPoint In Time Recovery Timestamp 
- Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
- State string
- The current state of the database.
- TimeCreated string
- The date and time the database was created.
- VaultId string
- The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretIdare required for Customer Managed Keys.
- VmCluster stringId 
- The OCID of the VM cluster.
- characterSet String
- The character set for the database.
- compartmentId String
- The OCID of the compartment.
- connectionStrings List<UpgradeConnection String> 
- The Connection strings used to connect to the Oracle Database.
- dataGuard List<UpgradeGroups Data Guard Group> 
- Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
- databaseSoftware StringImage Id 
- The database software image OCID
- dbBackup List<UpgradeConfigs Db Backup Config> 
- Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
- dbHome StringId 
- The OCID of the Database Home.
- dbName String
- The database name.
- dbSystem StringId 
- The OCID of the DB system.
- dbUnique StringName 
- A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- 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.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Map<String,String>
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
- id String
- The provider-assigned unique ID for this managed resource.
- isCdb Boolean
- True if the database is a container database.
- keyStore StringId 
- The OCID of the key store of Oracle Vault.
- keyStore StringWallet Name 
- The wallet name for Oracle Key Vault.
- kmsKey StringId 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kmsKey StringVersion Id 
- The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- lastBackup IntegerDuration In Seconds 
- The duration when the latest database backup created.
- lastBackup StringTimestamp 
- The date and time when the latest database backup was created.
- lastFailed StringBackup Timestamp 
- 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 SIDof the database to be created.
- sourceDatabase StringPoint In Time Recovery Timestamp 
- Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
- state String
- The current state of the database.
- timeCreated String
- The date and time the database was created.
- vaultId String
- The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretIdare required for Customer Managed Keys.
- vmCluster StringId 
- The OCID of the VM cluster.
- characterSet string
- The character set for the database.
- compartmentId string
- The OCID of the compartment.
- connectionStrings DatabaseUpgrade Connection String[] 
- The Connection strings used to connect to the Oracle Database.
- dataGuard DatabaseGroups Upgrade Data Guard Group[] 
- Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
- databaseSoftware stringImage Id 
- The database software image OCID
- dbBackup DatabaseConfigs Upgrade Db Backup Config[] 
- Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
- dbHome stringId 
- The OCID of the Database Home.
- dbName string
- The database name.
- dbSystem stringId 
- The OCID of the DB system.
- dbUnique stringName 
- A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- 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.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- {[key: string]: string}
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
- id string
- The provider-assigned unique ID for this managed resource.
- isCdb boolean
- True if the database is a container database.
- keyStore stringId 
- The OCID of the key store of Oracle Vault.
- keyStore stringWallet Name 
- The wallet name for Oracle Key Vault.
- kmsKey stringId 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kmsKey stringVersion Id 
- The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- lastBackup numberDuration In Seconds 
- The duration when the latest database backup created.
- lastBackup stringTimestamp 
- The date and time when the latest database backup was created.
- lastFailed stringBackup Timestamp 
- 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 SIDof the database to be created.
- sourceDatabase stringPoint In Time Recovery Timestamp 
- Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
- state string
- The current state of the database.
- timeCreated string
- The date and time the database was created.
- vaultId string
- The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretIdare required for Customer Managed Keys.
- vmCluster stringId 
- The OCID of the VM cluster.
- character_set str
- The character set for the database.
- compartment_id str
- The OCID of the compartment.
- connection_strings Sequence[DatabaseUpgrade Connection String] 
- The Connection strings used to connect to the Oracle Database.
- data_guard_ Sequence[Databasegroups Upgrade Data Guard Group] 
- Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
- database_software_ strimage_ id 
- The database software image OCID
- db_backup_ Sequence[Databaseconfigs Upgrade Db Backup Config] 
- Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
- db_home_ strid 
- The OCID of the Database Home.
- db_name str
- The database name.
- db_system_ strid 
- The OCID of the DB system.
- db_unique_ strname 
- A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- db_workload str
- Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
- Mapping[str, str]
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Mapping[str, str]
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
- id str
- The provider-assigned unique ID for this managed resource.
- is_cdb bool
- True if the database is a container database.
- key_store_ strid 
- The OCID of the key store of Oracle Vault.
- key_store_ strwallet_ name 
- The wallet name for Oracle Key Vault.
- kms_key_ strid 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms_key_ strversion_ id 
- The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- last_backup_ intduration_ in_ seconds 
- The duration when the latest database backup created.
- last_backup_ strtimestamp 
- The date and time when the latest database backup was created.
- last_failed_ strbackup_ timestamp 
- The date and time when the latest database backup failed.
- lifecycle_details str
- Additional information about the current lifecycle state.
- ncharacter_set str
- The national character set for the database.
- pdb_name str
- The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
- sid_prefix str
- Specifies a prefix for the Oracle SIDof the database to be created.
- source_database_ strpoint_ in_ time_ recovery_ timestamp 
- Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
- state str
- The current state of the database.
- time_created str
- The date and time the database was created.
- vault_id str
- The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretIdare required for Customer Managed Keys.
- vm_cluster_ strid 
- 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.
- dataGuard List<Property Map>Groups 
- Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
- databaseSoftware StringImage Id 
- The database software image OCID
- dbBackup List<Property Map>Configs 
- Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
- dbHome StringId 
- The OCID of the Database Home.
- dbName String
- The database name.
- dbSystem StringId 
- The OCID of the DB system.
- dbUnique StringName 
- A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- 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.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Map<String>
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
- id String
- The provider-assigned unique ID for this managed resource.
- isCdb Boolean
- True if the database is a container database.
- keyStore StringId 
- The OCID of the key store of Oracle Vault.
- keyStore StringWallet Name 
- The wallet name for Oracle Key Vault.
- kmsKey StringId 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kmsKey StringVersion Id 
- The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- lastBackup NumberDuration In Seconds 
- The duration when the latest database backup created.
- lastBackup StringTimestamp 
- The date and time when the latest database backup was created.
- lastFailed StringBackup Timestamp 
- 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 SIDof the database to be created.
- sourceDatabase StringPoint In Time Recovery Timestamp 
- Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
- state String
- The current state of the database.
- timeCreated String
- The date and time the database was created.
- vaultId String
- The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretIdare required for Customer Managed Keys.
- vmCluster StringId 
- 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[DatabaseUpgradeConnectionStringArgs]] = None,
        data_guard_groups: Optional[Sequence[DatabaseUpgradeDataGuardGroupArgs]] = None,
        database_id: Optional[str] = None,
        database_software_image_id: Optional[str] = None,
        database_upgrade_source_details: Optional[DatabaseUpgradeDatabaseUpgradeSourceDetailsArgs] = None,
        db_backup_configs: Optional[Sequence[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) -> DatabaseUpgradefunc 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Action string
- The database upgrade action.
- CharacterSet string
- The character set for the database.
- CompartmentId string
- The OCID of the compartment.
- ConnectionStrings List<DatabaseUpgrade Connection String> 
- The Connection strings used to connect to the Oracle Database.
- DataGuard List<DatabaseGroups Upgrade Data Guard Group> 
- Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
- DatabaseId string
- The database OCID.
- DatabaseSoftware stringImage Id 
- The database software image OCID
- DatabaseUpgrade DatabaseSource Details Upgrade Database Upgrade Source Details 
- Details for the database upgrade source.
- DbBackup List<DatabaseConfigs Upgrade Db Backup Config> 
- Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
- DbHome stringId 
- The OCID of the Database Home.
- DbName string
- The database name.
- DbSystem stringId 
- The OCID of the DB system.
- DbUnique stringName 
- A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- 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.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Dictionary<string, string>
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
- IsCdb bool
- True if the database is a container database.
- KeyStore stringId 
- The OCID of the key store of Oracle Vault.
- KeyStore stringWallet Name 
- The wallet name for Oracle Key Vault.
- KmsKey stringId 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- KmsKey stringVersion Id 
- The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- LastBackup intDuration In Seconds 
- The duration when the latest database backup created.
- LastBackup stringTimestamp 
- The date and time when the latest database backup was created.
- LastFailed stringBackup Timestamp 
- 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 SIDof the database to be created.
- SourceDatabase stringPoint In Time Recovery Timestamp 
- Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
- State string
- The current state of the database.
- TimeCreated string
- The date and time the database was created.
- VaultId string
- The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretIdare required for Customer Managed Keys.
- VmCluster stringId 
- The OCID of the VM cluster.
- Action string
- The database upgrade action.
- CharacterSet string
- The character set for the database.
- CompartmentId string
- The OCID of the compartment.
- ConnectionStrings []DatabaseUpgrade Connection String Args 
- The Connection strings used to connect to the Oracle Database.
- DataGuard []DatabaseGroups Upgrade Data Guard Group Args 
- Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
- DatabaseId string
- The database OCID.
- DatabaseSoftware stringImage Id 
- The database software image OCID
- DatabaseUpgrade DatabaseSource Details Upgrade Database Upgrade Source Details Args 
- Details for the database upgrade source.
- DbBackup []DatabaseConfigs Upgrade Db Backup Config Args 
- Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
- DbHome stringId 
- The OCID of the Database Home.
- DbName string
- The database name.
- DbSystem stringId 
- The OCID of the DB system.
- DbUnique stringName 
- A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- 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.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- map[string]string
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
- IsCdb bool
- True if the database is a container database.
- KeyStore stringId 
- The OCID of the key store of Oracle Vault.
- KeyStore stringWallet Name 
- The wallet name for Oracle Key Vault.
- KmsKey stringId 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- KmsKey stringVersion Id 
- The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- LastBackup intDuration In Seconds 
- The duration when the latest database backup created.
- LastBackup stringTimestamp 
- The date and time when the latest database backup was created.
- LastFailed stringBackup Timestamp 
- 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 SIDof the database to be created.
- SourceDatabase stringPoint In Time Recovery Timestamp 
- Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
- State string
- The current state of the database.
- TimeCreated string
- The date and time the database was created.
- VaultId string
- The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretIdare required for Customer Managed Keys.
- VmCluster stringId 
- The OCID of the VM cluster.
- action String
- The database upgrade action.
- characterSet String
- The character set for the database.
- compartmentId String
- The OCID of the compartment.
- connectionStrings List<UpgradeConnection String> 
- The Connection strings used to connect to the Oracle Database.
- dataGuard List<UpgradeGroups Data Guard Group> 
- Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
- databaseId String
- The database OCID.
- databaseSoftware StringImage Id 
- The database software image OCID
- databaseUpgrade UpgradeSource Details Upgrade Source Details 
- Details for the database upgrade source.
- dbBackup List<UpgradeConfigs Db Backup Config> 
- Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
- dbHome StringId 
- The OCID of the Database Home.
- dbName String
- The database name.
- dbSystem StringId 
- The OCID of the DB system.
- dbUnique StringName 
- A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- 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.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Map<String,String>
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
- isCdb Boolean
- True if the database is a container database.
- keyStore StringId 
- The OCID of the key store of Oracle Vault.
- keyStore StringWallet Name 
- The wallet name for Oracle Key Vault.
- kmsKey StringId 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kmsKey StringVersion Id 
- The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- lastBackup IntegerDuration In Seconds 
- The duration when the latest database backup created.
- lastBackup StringTimestamp 
- The date and time when the latest database backup was created.
- lastFailed StringBackup Timestamp 
- 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 SIDof the database to be created.
- sourceDatabase StringPoint In Time Recovery Timestamp 
- Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
- state String
- The current state of the database.
- timeCreated String
- The date and time the database was created.
- vaultId String
- The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretIdare required for Customer Managed Keys.
- vmCluster StringId 
- The OCID of the VM cluster.
- action string
- The database upgrade action.
- characterSet string
- The character set for the database.
- compartmentId string
- The OCID of the compartment.
- connectionStrings DatabaseUpgrade Connection String[] 
- The Connection strings used to connect to the Oracle Database.
- dataGuard DatabaseGroups Upgrade Data Guard Group[] 
- Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
- databaseId string
- The database OCID.
- databaseSoftware stringImage Id 
- The database software image OCID
- databaseUpgrade DatabaseSource Details Upgrade Database Upgrade Source Details 
- Details for the database upgrade source.
- dbBackup DatabaseConfigs Upgrade Db Backup Config[] 
- Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
- dbHome stringId 
- The OCID of the Database Home.
- dbName string
- The database name.
- dbSystem stringId 
- The OCID of the DB system.
- dbUnique stringName 
- A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- 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.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- {[key: string]: string}
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
- isCdb boolean
- True if the database is a container database.
- keyStore stringId 
- The OCID of the key store of Oracle Vault.
- keyStore stringWallet Name 
- The wallet name for Oracle Key Vault.
- kmsKey stringId 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kmsKey stringVersion Id 
- The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- lastBackup numberDuration In Seconds 
- The duration when the latest database backup created.
- lastBackup stringTimestamp 
- The date and time when the latest database backup was created.
- lastFailed stringBackup Timestamp 
- 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 SIDof the database to be created.
- sourceDatabase stringPoint In Time Recovery Timestamp 
- Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
- state string
- The current state of the database.
- timeCreated string
- The date and time the database was created.
- vaultId string
- The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretIdare required for Customer Managed Keys.
- vmCluster stringId 
- The OCID of the VM cluster.
- action 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[DatabaseUpgrade Connection String Args] 
- The Connection strings used to connect to the Oracle Database.
- data_guard_ Sequence[Databasegroups Upgrade Data Guard Group Args] 
- Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
- database_id str
- The database OCID.
- database_software_ strimage_ id 
- The database software image OCID
- database_upgrade_ Databasesource_ details Upgrade Database Upgrade Source Details Args 
- Details for the database upgrade source.
- db_backup_ Sequence[Databaseconfigs Upgrade Db Backup Config Args] 
- Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
- db_home_ strid 
- The OCID of the Database Home.
- db_name str
- The database name.
- db_system_ strid 
- The OCID of the DB system.
- db_unique_ strname 
- A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- db_workload str
- Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
- Mapping[str, str]
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Mapping[str, str]
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
- is_cdb bool
- True if the database is a container database.
- key_store_ strid 
- The OCID of the key store of Oracle Vault.
- key_store_ strwallet_ name 
- The wallet name for Oracle Key Vault.
- kms_key_ strid 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms_key_ strversion_ id 
- The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- last_backup_ intduration_ in_ seconds 
- The duration when the latest database backup created.
- last_backup_ strtimestamp 
- The date and time when the latest database backup was created.
- last_failed_ strbackup_ timestamp 
- The date and time when the latest database backup failed.
- lifecycle_details str
- Additional information about the current lifecycle state.
- ncharacter_set str
- The national character set for the database.
- pdb_name str
- The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
- sid_prefix str
- Specifies a prefix for the Oracle SIDof the database to be created.
- source_database_ strpoint_ in_ time_ recovery_ timestamp 
- Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
- state str
- The current state of the database.
- time_created str
- The date and time the database was created.
- vault_id str
- The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretIdare required for Customer Managed Keys.
- vm_cluster_ strid 
- The OCID of the VM cluster.
- action 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.
- dataGuard List<Property Map>Groups 
- Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
- databaseId String
- The database OCID.
- databaseSoftware StringImage Id 
- The database software image OCID
- databaseUpgrade Property MapSource Details 
- Details for the database upgrade source.
- dbBackup List<Property Map>Configs 
- Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
- dbHome StringId 
- The OCID of the Database Home.
- dbName String
- The database name.
- dbSystem StringId 
- The OCID of the DB system.
- dbUnique StringName 
- A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- 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.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Map<String>
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
- isCdb Boolean
- True if the database is a container database.
- keyStore StringId 
- The OCID of the key store of Oracle Vault.
- keyStore StringWallet Name 
- The wallet name for Oracle Key Vault.
- kmsKey StringId 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kmsKey StringVersion Id 
- The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- lastBackup NumberDuration In Seconds 
- The duration when the latest database backup created.
- lastBackup StringTimestamp 
- The date and time when the latest database backup was created.
- lastFailed StringBackup Timestamp 
- 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 SIDof the database to be created.
- sourceDatabase StringPoint In Time Recovery Timestamp 
- Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
- state String
- The current state of the database.
- timeCreated String
- The date and time the database was created.
- vaultId String
- The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretIdare required for Customer Managed Keys.
- vmCluster StringId 
- The OCID of the VM cluster.
Supporting Types
DatabaseUpgradeConnectionString, DatabaseUpgradeConnectionStringArgs        
- AllConnection Dictionary<string, string>Strings 
- All connection strings to use to connect to the Database.
- CdbDefault string
- Host name based CDB Connection String.
- CdbIp stringDefault 
- IP based CDB Connection String.
- AllConnection map[string]stringStrings 
- All connection strings to use to connect to the Database.
- CdbDefault string
- Host name based CDB Connection String.
- CdbIp stringDefault 
- IP based CDB Connection String.
- allConnection Map<String,String>Strings 
- All connection strings to use to connect to the Database.
- cdbDefault String
- Host name based CDB Connection String.
- cdbIp StringDefault 
- IP based CDB Connection String.
- allConnection {[key: string]: string}Strings 
- All connection strings to use to connect to the Database.
- cdbDefault string
- Host name based CDB Connection String.
- cdbIp stringDefault 
- IP based CDB Connection String.
- all_connection_ Mapping[str, str]strings 
- All connection strings to use to connect to the Database.
- cdb_default str
- Host name based CDB Connection String.
- cdb_ip_ strdefault 
- IP based CDB Connection String.
- allConnection Map<String>Strings 
- All connection strings to use to connect to the Database.
- cdbDefault String
- Host name based CDB Connection String.
- cdbIp StringDefault 
- IP based CDB Connection String.
DatabaseUpgradeDataGuardGroup, DatabaseUpgradeDataGuardGroupArgs          
- Members
List<DatabaseUpgrade Data Guard Group Member> 
- 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
[]DatabaseUpgrade Data Guard Group Member 
- 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<UpgradeData Guard Group Member> 
- 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
DatabaseUpgrade Data Guard Group Member[] 
- 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[DatabaseUpgrade Data Guard Group Member] 
- List of Data Guard members, representing each database that is part of Data Guard.
- protection_mode str
- The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.
- members List<Property Map>
- List of Data Guard members, representing each database that is part of Data Guard.
- 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.
- DbSystem stringId 
- The OCID of the DB system.
- IsActive boolData Guard Enabled 
- 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
- TransportLag stringRefresh 
- 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.
- DbSystem stringId 
- The OCID of the DB system.
- IsActive boolData Guard Enabled 
- 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
- TransportLag stringRefresh 
- 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.
- dbSystem StringId 
- The OCID of the DB system.
- isActive BooleanData Guard Enabled 
- 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
- transportLag StringRefresh 
- 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.
- dbSystem stringId 
- The OCID of the DB system.
- isActive booleanData Guard Enabled 
- 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
- transportLag stringRefresh 
- 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_ strid 
- The OCID of the DB system.
- is_active_ booldata_ guard_ enabled 
- True if active Data Guard is enabled.
- role str
- The role of the reporting database in this Data Guard association.
- transport_lag str
- The rate at which redo logs are transported between the associated databases. Example: 1 second
- transport_lag_ strrefresh 
- The date and time when last redo transport has been done.
- transport_type str
- The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:- MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
- MAXIMUM_PERFORMANCE - ASYNC
- MAXIMUM_PROTECTION - SYNC
 
- 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.
- dbSystem StringId 
- The OCID of the DB system.
- isActive BooleanData Guard Enabled 
- 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
- transportLag StringRefresh 
- 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            
- DatabaseSoftware stringImage Id 
- The database software image OCID of the image to be used to upgrade a database.
- DbVersion 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 string
- Additional upgrade options supported by DBUA(Database Upgrade Assistant). Example: "-upgradeTimezone false -keepEvents"
- Source string
- The source of the Oracle Database software to be used for the upgrade. - Use DB_VERSIONto specify a generally-available Oracle Database software version to upgrade the database.
- Use DB_SOFTWARE_IMAGEto 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 
- Use 
- DatabaseSoftware stringImage Id 
- The database software image OCID of the image to be used to upgrade a database.
- DbVersion 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 string
- Additional upgrade options supported by DBUA(Database Upgrade Assistant). Example: "-upgradeTimezone false -keepEvents"
- Source string
- The source of the Oracle Database software to be used for the upgrade. - Use DB_VERSIONto specify a generally-available Oracle Database software version to upgrade the database.
- Use DB_SOFTWARE_IMAGEto 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 
- Use 
- databaseSoftware StringImage Id 
- The database software image OCID of the image to be used to upgrade a database.
- dbVersion 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 String
- Additional upgrade options supported by DBUA(Database Upgrade Assistant). Example: "-upgradeTimezone false -keepEvents"
- source String
- The source of the Oracle Database software to be used for the upgrade. - Use DB_VERSIONto specify a generally-available Oracle Database software version to upgrade the database.
- Use DB_SOFTWARE_IMAGEto 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 
- Use 
- databaseSoftware stringImage Id 
- The database software image OCID of the image to be used to upgrade a database.
- dbVersion 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 string
- Additional upgrade options supported by DBUA(Database Upgrade Assistant). Example: "-upgradeTimezone false -keepEvents"
- source string
- The source of the Oracle Database software to be used for the upgrade. - Use DB_VERSIONto specify a generally-available Oracle Database software version to upgrade the database.
- Use DB_SOFTWARE_IMAGEto 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 
- Use 
- database_software_ strimage_ id 
- The database software image OCID of the image to be used to upgrade a database.
- db_version str
- A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. - This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. 
- options str
- Additional upgrade options supported by DBUA(Database Upgrade Assistant). Example: "-upgradeTimezone false -keepEvents"
- source str
- The source of the Oracle Database software to be used for the upgrade. - Use DB_VERSIONto specify a generally-available Oracle Database software version to upgrade the database.
- Use DB_SOFTWARE_IMAGEto 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 
- Use 
- databaseSoftware StringImage Id 
- The database software image OCID of the image to be used to upgrade a database.
- dbVersion 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 String
- Additional upgrade options supported by DBUA(Database Upgrade Assistant). Example: "-upgradeTimezone false -keepEvents"
- source String
- The source of the Oracle Database software to be used for the upgrade. - Use DB_VERSIONto specify a generally-available Oracle Database software version to upgrade the database.
- Use DB_SOFTWARE_IMAGEto 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 
- Use 
DatabaseUpgradeDbBackupConfig, DatabaseUpgradeDbBackupConfigArgs          
- AutoBackup boolEnabled 
- If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
- AutoBackup stringWindow 
- Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
- AutoFull stringBackup Day 
- Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
- AutoFull stringBackup Window 
- Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
- BackupDeletion stringPolicy 
- This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
- BackupDestination List<DatabaseDetails Upgrade Db Backup Config Backup Destination Detail> 
- Backup destination details.
- RecoveryWindow intIn Days 
- Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
- RunImmediate boolFull Backup 
- If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
- AutoBackup boolEnabled 
- If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
- AutoBackup stringWindow 
- Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
- AutoFull stringBackup Day 
- Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
- AutoFull stringBackup Window 
- Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
- BackupDeletion stringPolicy 
- This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
- BackupDestination []DatabaseDetails Upgrade Db Backup Config Backup Destination Detail 
- Backup destination details.
- RecoveryWindow intIn Days 
- Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
- RunImmediate boolFull Backup 
- If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
- autoBackup BooleanEnabled 
- If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
- autoBackup StringWindow 
- Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
- autoFull StringBackup Day 
- Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
- autoFull StringBackup Window 
- Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
- backupDeletion StringPolicy 
- This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
- backupDestination List<UpgradeDetails Db Backup Config Backup Destination Detail> 
- Backup destination details.
- recoveryWindow IntegerIn Days 
- Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
- runImmediate BooleanFull Backup 
- If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
- autoBackup booleanEnabled 
- If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
- autoBackup stringWindow 
- Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
- autoFull stringBackup Day 
- Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
- autoFull stringBackup Window 
- Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
- backupDeletion stringPolicy 
- This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
- backupDestination DatabaseDetails Upgrade Db Backup Config Backup Destination Detail[] 
- Backup destination details.
- recoveryWindow numberIn Days 
- Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
- runImmediate booleanFull Backup 
- If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
- auto_backup_ boolenabled 
- If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
- auto_backup_ strwindow 
- Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
- auto_full_ strbackup_ day 
- Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
- auto_full_ strbackup_ window 
- Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
- backup_deletion_ strpolicy 
- This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
- backup_destination_ Sequence[Databasedetails Upgrade Db Backup Config Backup Destination Detail] 
- Backup destination details.
- recovery_window_ intin_ days 
- Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
- run_immediate_ boolfull_ backup 
- If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
- autoBackup BooleanEnabled 
- If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
- autoBackup StringWindow 
- Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
- autoFull StringBackup Day 
- Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
- autoFull StringBackup Window 
- Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
- backupDeletion StringPolicy 
- This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
- backupDestination List<Property Map>Details 
- Backup destination details.
- recoveryWindow NumberIn Days 
- Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
- runImmediate BooleanFull Backup 
- If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
DatabaseUpgradeDbBackupConfigBackupDestinationDetail, DatabaseUpgradeDbBackupConfigBackupDestinationDetailArgs                
- DbrsPolicy stringId 
- 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.
- DbrsPolicy stringId 
- 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.
- dbrsPolicy StringId 
- 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.
- dbrsPolicy stringId 
- 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_ strid 
- 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.
- dbrsPolicy StringId 
- 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 ociTerraform Provider.