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!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Database.DatabaseUpgrade;
import com.pulumi.oci.Database.DatabaseUpgradeArgs;
import com.pulumi.oci.Database.inputs.DatabaseUpgradeDatabaseUpgradeSourceDetailsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var testDatabaseUpgrade = new DatabaseUpgrade("testDatabaseUpgrade", DatabaseUpgradeArgs.builder()
.action(databaseUpgradeAction)
.databaseId(testDatabase.id())
.databaseUpgradeSourceDetails(DatabaseUpgradeDatabaseUpgradeSourceDetailsArgs.builder()
.databaseSoftwareImageId(testDatabaseSoftwareImage.id())
.dbHomeId(testDbHome.id())
.dbVersion(databaseUpgradeDatabaseUpgradeSourceDetailsDbVersion)
.options(databaseUpgradeDatabaseUpgradeSourceDetailsOptions)
.source(databaseUpgradeDatabaseUpgradeSourceDetailsSource)
.build())
.build());
}
}
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[_database.DatabaseUpgradeDatabaseUpgradeSourceDetailsArgs] = None)
func NewDatabaseUpgrade(ctx *Context, name string, args DatabaseUpgradeArgs, opts ...ResourceOption) (*DatabaseUpgrade, error)
public DatabaseUpgrade(string name, DatabaseUpgradeArgs args, CustomResourceOptions? opts = null)
public DatabaseUpgrade(String name, DatabaseUpgradeArgs args)
public DatabaseUpgrade(String name, DatabaseUpgradeArgs args, CustomResourceOptions options)
type: oci:Database:DatabaseUpgrade
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name 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.
- Database
Id string - The database OCID.
- Database
Upgrade DatabaseSource Details Upgrade Database Upgrade Source Details - Details for the database upgrade source.
- Action string
- The database upgrade action.
- Database
Id string - 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.
- database
Id String - The database OCID.
- database
Upgrade UpgradeSource Details Upgrade Source Details - Details for the database upgrade source.
- action string
- The database upgrade action.
- database
Id string - The database OCID.
- database
Upgrade 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_ database.source_ details Database Upgrade Database Upgrade Source Details Args - Details for the database upgrade source.
- action String
- The database upgrade action.
- database
Id String - The database OCID.
- database
Upgrade 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:
- Character
Set string - The character set for the database.
- Compartment
Id string - The OCID of the compartment.
- Connection
Strings List<DatabaseUpgrade Connection String> - The Connection strings used to connect to the Oracle Database.
- Database
Software stringImage Id - The database software image OCID
- Db
Backup 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.
- Db
Home stringId - The OCID of the Database Home.
- Db
Name string - The database name.
- Db
System stringId - The OCID of the DB system.
- Db
Unique stringName - A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- Db
Workload string - Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Dictionary<string, string>
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- Id string
- The provider-assigned unique ID for this managed resource.
- Is
Cdb bool - True if the database is a container database.
- Key
Store stringId - The OCID of the key store of Oracle Vault.
- Key
Store stringWallet Name - The wallet name for Oracle Key Vault.
- Kms
Key stringId - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- Kms
Key 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.
- Last
Backup intDuration In Seconds - The duration when the latest database backup created.
- Last
Backup stringTimestamp - The date and time when the latest database backup was created.
- Last
Failed stringBackup Timestamp - The date and time when the latest database backup failed.
- Lifecycle
Details string - Additional information about the current lifecycle state.
- Ncharacter
Set string - The national character set for the database.
- Pdb
Name string - The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
- Sid
Prefix string - Specifies a prefix for the
Oracle SID
of the database to be created. - Source
Database stringPoint In Time Recovery Timestamp - Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
- State string
- The current state of the database.
- Time
Created string - The date and time the database was created.
- Vault
Id string - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys. - Vm
Cluster stringId - The OCID of the VM cluster.
- Character
Set string - The character set for the database.
- Compartment
Id string - The OCID of the compartment.
- Connection
Strings []DatabaseUpgrade Connection String - The Connection strings used to connect to the Oracle Database.
- Database
Software stringImage Id - The database software image OCID
- Db
Backup []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 stringId - The OCID of the Database Home.
- Db
Name string - The database name.
- Db
System stringId - The OCID of the DB system.
- Db
Unique stringName - A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- Db
Workload string - Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- map[string]string
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- Id string
- The provider-assigned unique ID for this managed resource.
- Is
Cdb bool - True if the database is a container database.
- Key
Store stringId - The OCID of the key store of Oracle Vault.
- Key
Store stringWallet Name - The wallet name for Oracle Key Vault.
- Kms
Key stringId - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- Kms
Key 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.
- Last
Backup intDuration In Seconds - The duration when the latest database backup created.
- Last
Backup stringTimestamp - The date and time when the latest database backup was created.
- Last
Failed stringBackup Timestamp - The date and time when the latest database backup failed.
- Lifecycle
Details string - Additional information about the current lifecycle state.
- Ncharacter
Set string - The national character set for the database.
- Pdb
Name string - The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
- Sid
Prefix string - Specifies a prefix for the
Oracle SID
of the database to be created. - Source
Database stringPoint In Time Recovery Timestamp - Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
- State string
- The current state of the database.
- Time
Created string - The date and time the database was created.
- Vault
Id string - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys. - Vm
Cluster stringId - The OCID of the VM cluster.
- character
Set String - The character set for the database.
- compartment
Id String - The OCID of the compartment.
- connection
Strings List<UpgradeConnection String> - The Connection strings used to connect to the Oracle Database.
- database
Software StringImage Id - The database software image OCID
- db
Backup 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.
- db
Home StringId - The OCID of the Database Home.
- db
Name String - The database name.
- db
System StringId - The OCID of the DB system.
- db
Unique StringName - A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- db
Workload String - Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Map<String,String>
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- id String
- The provider-assigned unique ID for this managed resource.
- is
Cdb Boolean - True if the database is a container database.
- key
Store StringId - The OCID of the key store of Oracle Vault.
- key
Store StringWallet Name - The wallet name for Oracle Key Vault.
- kms
Key StringId - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms
Key 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.
- last
Backup IntegerDuration In Seconds - The duration when the latest database backup created.
- last
Backup StringTimestamp - The date and time when the latest database backup was created.
- last
Failed StringBackup Timestamp - The date and time when the latest database backup failed.
- lifecycle
Details String - Additional information about the current lifecycle state.
- ncharacter
Set String - The national character set for the database.
- pdb
Name String - The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
- sid
Prefix String - Specifies a prefix for the
Oracle SID
of the database to be created. - source
Database StringPoint In Time Recovery Timestamp - Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
- state String
- The current state of the database.
- time
Created String - The date and time the database was created.
- vault
Id String - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys. - vm
Cluster StringId - The OCID of the VM cluster.
- character
Set string - The character set for the database.
- compartment
Id string - The OCID of the compartment.
- connection
Strings DatabaseUpgrade Connection String[] - The Connection strings used to connect to the Oracle Database.
- database
Software stringImage Id - The database software image OCID
- db
Backup 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 stringId - The OCID of the Database Home.
- db
Name string - The database name.
- db
System stringId - The OCID of the DB system.
- db
Unique stringName - A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- db
Workload string - Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- {[key: string]: string}
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- id string
- The provider-assigned unique ID for this managed resource.
- is
Cdb boolean - True if the database is a container database.
- key
Store stringId - The OCID of the key store of Oracle Vault.
- key
Store stringWallet Name - The wallet name for Oracle Key Vault.
- kms
Key stringId - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms
Key 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.
- last
Backup numberDuration In Seconds - The duration when the latest database backup created.
- last
Backup stringTimestamp - The date and time when the latest database backup was created.
- last
Failed stringBackup Timestamp - The date and time when the latest database backup failed.
- lifecycle
Details string - Additional information about the current lifecycle state.
- ncharacter
Set string - The national character set for the database.
- pdb
Name string - The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
- sid
Prefix string - Specifies a prefix for the
Oracle SID
of the database to be created. - source
Database stringPoint In Time Recovery Timestamp - Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
- state string
- The current state of the database.
- time
Created string - The date and time the database was created.
- vault
Id string - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys. - vm
Cluster stringId - The OCID of the VM cluster.
- character_
set str - The character set for the database.
- compartment_
id str - The OCID of the compartment.
- connection_
strings Sequence[database.Database Upgrade Connection String] - The Connection strings used to connect to the Oracle Database.
- database_
software_ strimage_ id - The database software image OCID
- db_
backup_ Sequence[database.configs Database 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 SID
of the database to be created. - source_
database_ strpoint_ in_ time_ recovery_ timestamp - Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
- state str
- The current state of the database.
- time_
created str - The date and time the database was created.
- vault_
id str - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys. - vm_
cluster_ strid - The OCID of the VM cluster.
- character
Set String - The character set for the database.
- compartment
Id String - The OCID of the compartment.
- connection
Strings List<Property Map> - The Connection strings used to connect to the Oracle Database.
- database
Software StringImage Id - The database software image OCID
- db
Backup List<Property Map>Configs - Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
- db
Home StringId - The OCID of the Database Home.
- db
Name String - The database name.
- db
System StringId - The OCID of the DB system.
- db
Unique StringName - A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- db
Workload String - Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Map<String>
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- id String
- The provider-assigned unique ID for this managed resource.
- is
Cdb Boolean - True if the database is a container database.
- key
Store StringId - The OCID of the key store of Oracle Vault.
- key
Store StringWallet Name - The wallet name for Oracle Key Vault.
- kms
Key StringId - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms
Key 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.
- last
Backup NumberDuration In Seconds - The duration when the latest database backup created.
- last
Backup StringTimestamp - The date and time when the latest database backup was created.
- last
Failed StringBackup Timestamp - The date and time when the latest database backup failed.
- lifecycle
Details String - Additional information about the current lifecycle state.
- ncharacter
Set String - The national character set for the database.
- pdb
Name String - The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
- sid
Prefix String - Specifies a prefix for the
Oracle SID
of the database to be created. - source
Database StringPoint In Time Recovery Timestamp - Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
- state String
- The current state of the database.
- time
Created String - The date and time the database was created.
- vault
Id String - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys. - vm
Cluster StringId - The OCID of the VM cluster.
Look up Existing DatabaseUpgrade Resource
Get an existing DatabaseUpgrade resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: DatabaseUpgradeState, opts?: CustomResourceOptions): DatabaseUpgrade
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
action: Optional[str] = None,
character_set: Optional[str] = None,
compartment_id: Optional[str] = None,
connection_strings: Optional[Sequence[_database.DatabaseUpgradeConnectionStringArgs]] = None,
database_id: Optional[str] = None,
database_software_image_id: Optional[str] = None,
database_upgrade_source_details: Optional[_database.DatabaseUpgradeDatabaseUpgradeSourceDetailsArgs] = None,
db_backup_configs: Optional[Sequence[_database.DatabaseUpgradeDbBackupConfigArgs]] = None,
db_home_id: Optional[str] = None,
db_name: Optional[str] = None,
db_system_id: Optional[str] = None,
db_unique_name: Optional[str] = None,
db_workload: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
is_cdb: Optional[bool] = None,
key_store_id: Optional[str] = None,
key_store_wallet_name: Optional[str] = None,
kms_key_id: Optional[str] = None,
kms_key_version_id: Optional[str] = None,
last_backup_duration_in_seconds: Optional[int] = None,
last_backup_timestamp: Optional[str] = None,
last_failed_backup_timestamp: Optional[str] = None,
lifecycle_details: Optional[str] = None,
ncharacter_set: Optional[str] = None,
pdb_name: Optional[str] = None,
sid_prefix: Optional[str] = None,
source_database_point_in_time_recovery_timestamp: Optional[str] = None,
state: Optional[str] = None,
time_created: Optional[str] = None,
vault_id: Optional[str] = None,
vm_cluster_id: Optional[str] = None) -> DatabaseUpgrade
func GetDatabaseUpgrade(ctx *Context, name string, id IDInput, state *DatabaseUpgradeState, opts ...ResourceOption) (*DatabaseUpgrade, error)
public static DatabaseUpgrade Get(string name, Input<string> id, DatabaseUpgradeState? state, CustomResourceOptions? opts = null)
public static DatabaseUpgrade get(String name, Output<String> id, DatabaseUpgradeState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Action string
- The database upgrade action.
- Character
Set string - The character set for the database.
- Compartment
Id string - The OCID of the compartment.
- Connection
Strings List<DatabaseUpgrade Connection String> - The Connection strings used to connect to the Oracle Database.
- Database
Id string - The database OCID.
- Database
Software stringImage Id - The database software image OCID
- Database
Upgrade DatabaseSource Details Upgrade Database Upgrade Source Details - Details for the database upgrade source.
- Db
Backup 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.
- Db
Home stringId - The OCID of the Database Home.
- Db
Name string - The database name.
- Db
System stringId - The OCID of the DB system.
- Db
Unique stringName - A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- Db
Workload string - Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Dictionary<string, string>
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- Is
Cdb bool - True if the database is a container database.
- Key
Store stringId - The OCID of the key store of Oracle Vault.
- Key
Store stringWallet Name - The wallet name for Oracle Key Vault.
- Kms
Key stringId - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- Kms
Key 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.
- Last
Backup intDuration In Seconds - The duration when the latest database backup created.
- Last
Backup stringTimestamp - The date and time when the latest database backup was created.
- Last
Failed stringBackup Timestamp - The date and time when the latest database backup failed.
- Lifecycle
Details string - Additional information about the current lifecycle state.
- Ncharacter
Set string - The national character set for the database.
- Pdb
Name string - The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
- Sid
Prefix string - Specifies a prefix for the
Oracle SID
of the database to be created. - Source
Database stringPoint In Time Recovery Timestamp - Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
- State string
- The current state of the database.
- Time
Created string - The date and time the database was created.
- Vault
Id string - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys. - Vm
Cluster stringId - The OCID of the VM cluster.
- Action string
- The database upgrade action.
- Character
Set string - The character set for the database.
- Compartment
Id string - The OCID of the compartment.
- Connection
Strings []DatabaseUpgrade Connection String Args - The Connection strings used to connect to the Oracle Database.
- Database
Id string - The database OCID.
- Database
Software stringImage Id - The database software image OCID
- Database
Upgrade DatabaseSource Details Upgrade Database Upgrade Source Details Args - Details for the database upgrade source.
- Db
Backup []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 stringId - The OCID of the Database Home.
- Db
Name string - The database name.
- Db
System stringId - The OCID of the DB system.
- Db
Unique stringName - A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- Db
Workload string - Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- map[string]string
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- Is
Cdb bool - True if the database is a container database.
- Key
Store stringId - The OCID of the key store of Oracle Vault.
- Key
Store stringWallet Name - The wallet name for Oracle Key Vault.
- Kms
Key stringId - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- Kms
Key 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.
- Last
Backup intDuration In Seconds - The duration when the latest database backup created.
- Last
Backup stringTimestamp - The date and time when the latest database backup was created.
- Last
Failed stringBackup Timestamp - The date and time when the latest database backup failed.
- Lifecycle
Details string - Additional information about the current lifecycle state.
- Ncharacter
Set string - The national character set for the database.
- Pdb
Name string - The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
- Sid
Prefix string - Specifies a prefix for the
Oracle SID
of the database to be created. - Source
Database stringPoint In Time Recovery Timestamp - Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
- State string
- The current state of the database.
- Time
Created string - The date and time the database was created.
- Vault
Id string - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys. - Vm
Cluster stringId - The OCID of the VM cluster.
- action String
- The database upgrade action.
- character
Set String - The character set for the database.
- compartment
Id String - The OCID of the compartment.
- connection
Strings List<UpgradeConnection String> - The Connection strings used to connect to the Oracle Database.
- database
Id String - The database OCID.
- database
Software StringImage Id - The database software image OCID
- database
Upgrade UpgradeSource Details Upgrade Source Details - Details for the database upgrade source.
- db
Backup 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.
- db
Home StringId - The OCID of the Database Home.
- db
Name String - The database name.
- db
System StringId - The OCID of the DB system.
- db
Unique StringName - A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- db
Workload String - Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Map<String,String>
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- is
Cdb Boolean - True if the database is a container database.
- key
Store StringId - The OCID of the key store of Oracle Vault.
- key
Store StringWallet Name - The wallet name for Oracle Key Vault.
- kms
Key StringId - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms
Key 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.
- last
Backup IntegerDuration In Seconds - The duration when the latest database backup created.
- last
Backup StringTimestamp - The date and time when the latest database backup was created.
- last
Failed StringBackup Timestamp - The date and time when the latest database backup failed.
- lifecycle
Details String - Additional information about the current lifecycle state.
- ncharacter
Set String - The national character set for the database.
- pdb
Name String - The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
- sid
Prefix String - Specifies a prefix for the
Oracle SID
of the database to be created. - source
Database StringPoint In Time Recovery Timestamp - Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
- state String
- The current state of the database.
- time
Created String - The date and time the database was created.
- vault
Id String - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys. - vm
Cluster StringId - The OCID of the VM cluster.
- action string
- The database upgrade action.
- character
Set string - The character set for the database.
- compartment
Id string - The OCID of the compartment.
- connection
Strings DatabaseUpgrade Connection String[] - The Connection strings used to connect to the Oracle Database.
- database
Id string - The database OCID.
- database
Software stringImage Id - The database software image OCID
- database
Upgrade DatabaseSource Details Upgrade Database Upgrade Source Details - Details for the database upgrade source.
- db
Backup 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 stringId - The OCID of the Database Home.
- db
Name string - The database name.
- db
System stringId - The OCID of the DB system.
- db
Unique stringName - A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- db
Workload string - Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- {[key: string]: string}
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- is
Cdb boolean - True if the database is a container database.
- key
Store stringId - The OCID of the key store of Oracle Vault.
- key
Store stringWallet Name - The wallet name for Oracle Key Vault.
- kms
Key stringId - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms
Key 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.
- last
Backup numberDuration In Seconds - The duration when the latest database backup created.
- last
Backup stringTimestamp - The date and time when the latest database backup was created.
- last
Failed stringBackup Timestamp - The date and time when the latest database backup failed.
- lifecycle
Details string - Additional information about the current lifecycle state.
- ncharacter
Set string - The national character set for the database.
- pdb
Name string - The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
- sid
Prefix string - Specifies a prefix for the
Oracle SID
of the database to be created. - source
Database stringPoint In Time Recovery Timestamp - Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
- state string
- The current state of the database.
- time
Created string - The date and time the database was created.
- vault
Id string - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys. - vm
Cluster stringId - The OCID of the VM cluster.
- action str
- The database upgrade action.
- character_
set str - The character set for the database.
- compartment_
id str - The OCID of the compartment.
- connection_
strings Sequence[database.Database Upgrade Connection String Args] - The Connection strings used to connect to the Oracle Database.
- database_
id str - The database OCID.
- database_
software_ strimage_ id - The database software image OCID
- database_
upgrade_ database.source_ details Database Upgrade Database Upgrade Source Details Args - Details for the database upgrade source.
- db_
backup_ Sequence[database.configs Database 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 SID
of the database to be created. - source_
database_ strpoint_ in_ time_ recovery_ timestamp - Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
- state str
- The current state of the database.
- time_
created str - The date and time the database was created.
- vault_
id str - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys. - vm_
cluster_ strid - The OCID of the VM cluster.
- action String
- The database upgrade action.
- character
Set String - The character set for the database.
- compartment
Id String - The OCID of the compartment.
- connection
Strings List<Property Map> - The Connection strings used to connect to the Oracle Database.
- database
Id String - The database OCID.
- database
Software StringImage Id - The database software image OCID
- database
Upgrade Property MapSource Details - Details for the database upgrade source.
- db
Backup List<Property Map>Configs - Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
- db
Home StringId - The OCID of the Database Home.
- db
Name String - The database name.
- db
System StringId - The OCID of the DB system.
- db
Unique StringName - A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
- db
Workload String - Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Map<String>
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- is
Cdb Boolean - True if the database is a container database.
- key
Store StringId - The OCID of the key store of Oracle Vault.
- key
Store StringWallet Name - The wallet name for Oracle Key Vault.
- kms
Key StringId - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms
Key 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.
- last
Backup NumberDuration In Seconds - The duration when the latest database backup created.
- last
Backup StringTimestamp - The date and time when the latest database backup was created.
- last
Failed StringBackup Timestamp - The date and time when the latest database backup failed.
- lifecycle
Details String - Additional information about the current lifecycle state.
- ncharacter
Set String - The national character set for the database.
- pdb
Name String - The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
- sid
Prefix String - Specifies a prefix for the
Oracle SID
of the database to be created. - source
Database StringPoint In Time Recovery Timestamp - Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
- state String
- The current state of the database.
- time
Created String - The date and time the database was created.
- vault
Id String - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys. - vm
Cluster StringId - The OCID of the VM cluster.
Supporting Types
DatabaseUpgradeConnectionString, DatabaseUpgradeConnectionStringArgs
- All
Connection Dictionary<string, string>Strings - All connection strings to use to connect to the Database.
- Cdb
Default string - Host name based CDB Connection String.
- Cdb
Ip stringDefault - IP based CDB Connection String.
- All
Connection map[string]stringStrings - All connection strings to use to connect to the Database.
- Cdb
Default string - Host name based CDB Connection String.
- Cdb
Ip stringDefault - IP based CDB Connection String.
- all
Connection Map<String,String>Strings - All connection strings to use to connect to the Database.
- cdb
Default String - Host name based CDB Connection String.
- cdb
Ip StringDefault - IP based CDB Connection String.
- all
Connection {[key: string]: string}Strings - All connection strings to use to connect to the Database.
- cdb
Default string - Host name based CDB Connection String.
- cdb
Ip stringDefault - IP based CDB Connection String.
- all_
connection_ Mapping[str, str]strings - All connection strings to use to connect to the Database.
- cdb_
default str - Host name based CDB Connection String.
- cdb_
ip_ strdefault - IP based CDB Connection String.
- all
Connection Map<String>Strings - All connection strings to use to connect to the Database.
- cdb
Default String - Host name based CDB Connection String.
- cdb
Ip StringDefault - IP based CDB Connection String.
DatabaseUpgradeDatabaseUpgradeSourceDetails, DatabaseUpgradeDatabaseUpgradeSourceDetailsArgs
- Database
Software stringImage Id - The database software image OCID of the image to be used to upgrade a database.
- Db
Version string A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- 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_VERSION
to specify a generally-available Oracle Database software version to upgrade the database. - Use
DB_SOFTWARE_IMAGE
to specify a database software image to upgrade the database.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Use
- Database
Software stringImage Id - The database software image OCID of the image to be used to upgrade a database.
- Db
Version string A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- 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_VERSION
to specify a generally-available Oracle Database software version to upgrade the database. - Use
DB_SOFTWARE_IMAGE
to specify a database software image to upgrade the database.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Use
- database
Software StringImage Id - The database software image OCID of the image to be used to upgrade a database.
- db
Version String A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- 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_VERSION
to specify a generally-available Oracle Database software version to upgrade the database. - Use
DB_SOFTWARE_IMAGE
to specify a database software image to upgrade the database.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Use
- database
Software stringImage Id - The database software image OCID of the image to be used to upgrade a database.
- db
Version string A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- 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_VERSION
to specify a generally-available Oracle Database software version to upgrade the database. - Use
DB_SOFTWARE_IMAGE
to specify a database software image to upgrade the database.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- 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_VERSION
to specify a generally-available Oracle Database software version to upgrade the database. - Use
DB_SOFTWARE_IMAGE
to specify a database software image to upgrade the database.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Use
- database
Software StringImage Id - The database software image OCID of the image to be used to upgrade a database.
- db
Version String A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- 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_VERSION
to specify a generally-available Oracle Database software version to upgrade the database. - Use
DB_SOFTWARE_IMAGE
to specify a database software image to upgrade the database.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Use
DatabaseUpgradeDbBackupConfig, DatabaseUpgradeDbBackupConfigArgs
- Auto
Backup boolEnabled - If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
- Auto
Backup stringWindow - Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example:
SLOT_TWO
- Auto
Full stringBackup Day - Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
- Auto
Full stringBackup Window - Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example:
SLOT_TWO
- Backup
Deletion stringPolicy - This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
- Backup
Destination List<DatabaseDetails 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.
- Auto
Backup boolEnabled - If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
- Auto
Backup stringWindow - Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example:
SLOT_TWO
- Auto
Full stringBackup Day - Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
- Auto
Full stringBackup Window - Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example:
SLOT_TWO
- Backup
Deletion stringPolicy - This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
- Backup
Destination []DatabaseDetails 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.
- auto
Backup BooleanEnabled - If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
- auto
Backup StringWindow - Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example:
SLOT_TWO
- auto
Full StringBackup Day - Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
- auto
Full StringBackup Window - Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example:
SLOT_TWO
- backup
Deletion StringPolicy - This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
- backup
Destination List<UpgradeDetails Db Backup Config Backup Destination Detail> - Backup destination details.
- recovery
Window IntegerIn Days - Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
- run
Immediate BooleanFull Backup - If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
- auto
Backup booleanEnabled - If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
- auto
Backup stringWindow - Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example:
SLOT_TWO
- auto
Full stringBackup Day - Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
- auto
Full stringBackup Window - Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example:
SLOT_TWO
- backup
Deletion stringPolicy - This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
- backup
Destination DatabaseDetails Upgrade Db Backup Config Backup Destination Detail[] - Backup destination details.
- recovery
Window numberIn Days - Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
- run
Immediate booleanFull Backup - If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
- auto_
backup_ boolenabled - If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
- auto_
backup_ strwindow - Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example:
SLOT_TWO
- auto_
full_ strbackup_ day - Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
- auto_
full_ strbackup_ window - Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example:
SLOT_TWO
- backup_
deletion_ strpolicy - This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
- backup_
destination_ Sequence[database.details Database 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.
- auto
Backup BooleanEnabled - If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
- auto
Backup StringWindow - Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example:
SLOT_TWO
- auto
Full StringBackup Day - Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
- auto
Full StringBackup Window - Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example:
SLOT_TWO
- backup
Deletion StringPolicy - This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
- backup
Destination List<Property Map>Details - Backup destination details.
- recovery
Window NumberIn Days - Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
- run
Immediate BooleanFull Backup - If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
DatabaseUpgradeDbBackupConfigBackupDestinationDetail, DatabaseUpgradeDbBackupConfigBackupDestinationDetailArgs
- Dbrs
Policy stringId - The OCID of the DBRS policy used for backup.
- Id string
- The OCID of the database.
- Internet
Proxy string - Proxy URL to connect to object store.
- Type string
- Type of the database backup destination.
- Vpc
Password string - For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
- Vpc
User string - For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.
- Dbrs
Policy stringId - The OCID of the DBRS policy used for backup.
- Id string
- The OCID of the database.
- Internet
Proxy string - Proxy URL to connect to object store.
- Type string
- Type of the database backup destination.
- Vpc
Password string - For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
- Vpc
User string - For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.
- dbrs
Policy StringId - The OCID of the DBRS policy used for backup.
- id String
- The OCID of the database.
- internet
Proxy String - Proxy URL to connect to object store.
- type String
- Type of the database backup destination.
- vpc
Password String - For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
- vpc
User String - For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.
- dbrs
Policy stringId - The OCID of the DBRS policy used for backup.
- id string
- The OCID of the database.
- internet
Proxy string - Proxy URL to connect to object store.
- type string
- Type of the database backup destination.
- vpc
Password string - For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
- vpc
User 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.
- dbrs
Policy StringId - The OCID of the DBRS policy used for backup.
- id String
- The OCID of the database.
- internet
Proxy String - Proxy URL to connect to object store.
- type String
- Type of the database backup destination.
- vpc
Password String - For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
- vpc
User String - For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.
Import
Import is not supported for this resource.
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.