oci.Database.DbSystem
Explore with Pulumi AI
This resource provides the Db System resource in Oracle Cloud Infrastructure Database service.
Creates a new DB system in the specified compartment and availability domain. The Oracle Database edition that you specify applies to all the databases on that DB system. The selected edition cannot be changed.
An initial database is created on the DB system based on the request parameters you provide and some default options. For detailed information about default options, see Bare metal and virtual machine DB system default options.
Note: Deprecated for Exadata Cloud Service systems. Use the new resource model APIs instead.
For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See Switching an Exadata DB System to the New Resource Model and APIs for details on converting existing Exadata DB systems to the new resource model.
Use the CreateCloudExadataInfrastructure and CreateCloudVmCluster APIs to provision a new Exadata Cloud Service instance.
Important: When auto_backup_enabled
is not present in the configuration or set to true, the auto_backup_window
and auto_full_backup_window
will be ignored
Create DbSystem Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DbSystem(name: string, args: DbSystemArgs, opts?: CustomResourceOptions);
@overload
def DbSystem(resource_name: str,
args: DbSystemArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DbSystem(resource_name: str,
opts: Optional[ResourceOptions] = None,
db_home: Optional[_database.DbSystemDbHomeArgs] = None,
subnet_id: Optional[str] = None,
ssh_public_keys: Optional[Sequence[str]] = None,
shape: Optional[str] = None,
compartment_id: Optional[str] = None,
hostname: Optional[str] = None,
availability_domain: Optional[str] = None,
fault_domains: Optional[Sequence[str]] = None,
kms_key_version_id: Optional[str] = None,
database_edition: Optional[str] = None,
data_storage_percentage: Optional[int] = None,
db_system_options: Optional[_database.DbSystemDbSystemOptionsArgs] = None,
defined_tags: Optional[Mapping[str, str]] = None,
disk_redundancy: Optional[str] = None,
display_name: Optional[str] = None,
domain: Optional[str] = None,
data_collection_options: Optional[_database.DbSystemDataCollectionOptionsArgs] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
cpu_core_count: Optional[int] = None,
kms_key_id: Optional[str] = None,
data_storage_size_in_gb: Optional[int] = None,
license_model: Optional[str] = None,
maintenance_window_details: Optional[_database.DbSystemMaintenanceWindowDetailsArgs] = None,
node_count: Optional[int] = None,
nsg_ids: Optional[Sequence[str]] = None,
private_ip: Optional[str] = None,
reco_storage_size_in_gb: Optional[int] = None,
cluster_name: Optional[str] = None,
source: Optional[str] = None,
source_db_system_id: Optional[str] = None,
sparse_diskgroup: Optional[bool] = None,
backup_subnet_id: Optional[str] = None,
storage_volume_performance_mode: Optional[str] = None,
backup_network_nsg_ids: Optional[Sequence[str]] = None,
time_zone: Optional[str] = None)
func NewDbSystem(ctx *Context, name string, args DbSystemArgs, opts ...ResourceOption) (*DbSystem, error)
public DbSystem(string name, DbSystemArgs args, CustomResourceOptions? opts = null)
public DbSystem(String name, DbSystemArgs args)
public DbSystem(String name, DbSystemArgs args, CustomResourceOptions options)
type: oci:Database:DbSystem
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 DbSystemArgs
- 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 DbSystemArgs
- 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 DbSystemArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DbSystemArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DbSystemArgs
- 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 dbSystemResource = new Oci.Database.DbSystem("dbSystemResource", new()
{
DbHome = new Oci.Database.Inputs.DbSystemDbHomeArgs
{
Database = new Oci.Database.Inputs.DbSystemDbHomeDatabaseArgs
{
AdminPassword = "string",
BackupId = "string",
BackupTdePassword = "string",
CharacterSet = "string",
ConnectionStrings = new[]
{
new Oci.Database.Inputs.DbSystemDbHomeDatabaseConnectionStringArgs
{
AllConnectionStrings =
{
{ "string", "string" },
},
CdbDefault = "string",
CdbIpDefault = "string",
},
},
DatabaseId = "string",
DatabaseSoftwareImageId = "string",
DbBackupConfig = new Oci.Database.Inputs.DbSystemDbHomeDatabaseDbBackupConfigArgs
{
AutoBackupEnabled = false,
AutoBackupWindow = "string",
AutoFullBackupDay = "string",
AutoFullBackupWindow = "string",
BackupDeletionPolicy = "string",
BackupDestinationDetails = new[]
{
new Oci.Database.Inputs.DbSystemDbHomeDatabaseDbBackupConfigBackupDestinationDetailArgs
{
DbrsPolicyId = "string",
Id = "string",
Type = "string",
},
},
RecoveryWindowInDays = 0,
RunImmediateFullBackup = false,
},
DbDomain = "string",
DbName = "string",
DbUniqueName = "string",
DbWorkload = "string",
DefinedTags =
{
{ "string", "string" },
},
FreeformTags =
{
{ "string", "string" },
},
Id = "string",
KmsKeyId = "string",
KmsKeyVersionId = "string",
LifecycleDetails = "string",
NcharacterSet = "string",
PdbName = "string",
PluggableDatabases = new[]
{
"string",
},
State = "string",
TdeWalletPassword = "string",
TimeCreated = "string",
TimeStampForPointInTimeRecovery = "string",
VaultId = "string",
},
DisplayName = "string",
DatabaseSoftwareImageId = "string",
DbHomeLocation = "string",
DbVersion = "string",
DefinedTags =
{
{ "string", "string" },
},
CreateAsync = false,
FreeformTags =
{
{ "string", "string" },
},
Id = "string",
LastPatchHistoryEntryId = "string",
LifecycleDetails = "string",
State = "string",
TimeCreated = "string",
},
SubnetId = "string",
SshPublicKeys = new[]
{
"string",
},
Shape = "string",
CompartmentId = "string",
Hostname = "string",
AvailabilityDomain = "string",
FaultDomains = new[]
{
"string",
},
KmsKeyVersionId = "string",
DatabaseEdition = "string",
DataStoragePercentage = 0,
DbSystemOptions = new Oci.Database.Inputs.DbSystemDbSystemOptionsArgs
{
StorageManagement = "string",
},
DefinedTags =
{
{ "string", "string" },
},
DiskRedundancy = "string",
DisplayName = "string",
Domain = "string",
DataCollectionOptions = new Oci.Database.Inputs.DbSystemDataCollectionOptionsArgs
{
IsDiagnosticsEventsEnabled = false,
IsHealthMonitoringEnabled = false,
IsIncidentLogsEnabled = false,
},
FreeformTags =
{
{ "string", "string" },
},
CpuCoreCount = 0,
KmsKeyId = "string",
DataStorageSizeInGb = 0,
LicenseModel = "string",
MaintenanceWindowDetails = new Oci.Database.Inputs.DbSystemMaintenanceWindowDetailsArgs
{
CustomActionTimeoutInMins = 0,
DaysOfWeeks = new[]
{
new Oci.Database.Inputs.DbSystemMaintenanceWindowDetailsDaysOfWeekArgs
{
Name = "string",
},
},
HoursOfDays = new[]
{
0,
},
IsCustomActionTimeoutEnabled = false,
IsMonthlyPatchingEnabled = false,
LeadTimeInWeeks = 0,
Months = new[]
{
new Oci.Database.Inputs.DbSystemMaintenanceWindowDetailsMonthArgs
{
Name = "string",
},
},
PatchingMode = "string",
Preference = "string",
SkipRus = new[]
{
false,
},
WeeksOfMonths = new[]
{
0,
},
},
NodeCount = 0,
NsgIds = new[]
{
"string",
},
PrivateIp = "string",
RecoStorageSizeInGb = 0,
ClusterName = "string",
Source = "string",
SourceDbSystemId = "string",
SparseDiskgroup = false,
BackupSubnetId = "string",
StorageVolumePerformanceMode = "string",
BackupNetworkNsgIds = new[]
{
"string",
},
TimeZone = "string",
});
example, err := Database.NewDbSystem(ctx, "dbSystemResource", &Database.DbSystemArgs{
DbHome: &database.DbSystemDbHomeArgs{
Database: &database.DbSystemDbHomeDatabaseArgs{
AdminPassword: pulumi.String("string"),
BackupId: pulumi.String("string"),
BackupTdePassword: pulumi.String("string"),
CharacterSet: pulumi.String("string"),
ConnectionStrings: database.DbSystemDbHomeDatabaseConnectionStringArray{
&database.DbSystemDbHomeDatabaseConnectionStringArgs{
AllConnectionStrings: pulumi.StringMap{
"string": pulumi.String("string"),
},
CdbDefault: pulumi.String("string"),
CdbIpDefault: pulumi.String("string"),
},
},
DatabaseId: pulumi.String("string"),
DatabaseSoftwareImageId: pulumi.String("string"),
DbBackupConfig: &database.DbSystemDbHomeDatabaseDbBackupConfigArgs{
AutoBackupEnabled: pulumi.Bool(false),
AutoBackupWindow: pulumi.String("string"),
AutoFullBackupDay: pulumi.String("string"),
AutoFullBackupWindow: pulumi.String("string"),
BackupDeletionPolicy: pulumi.String("string"),
BackupDestinationDetails: database.DbSystemDbHomeDatabaseDbBackupConfigBackupDestinationDetailArray{
&database.DbSystemDbHomeDatabaseDbBackupConfigBackupDestinationDetailArgs{
DbrsPolicyId: pulumi.String("string"),
Id: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
RecoveryWindowInDays: pulumi.Int(0),
RunImmediateFullBackup: pulumi.Bool(false),
},
DbDomain: pulumi.String("string"),
DbName: pulumi.String("string"),
DbUniqueName: pulumi.String("string"),
DbWorkload: pulumi.String("string"),
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Id: pulumi.String("string"),
KmsKeyId: pulumi.String("string"),
KmsKeyVersionId: pulumi.String("string"),
LifecycleDetails: pulumi.String("string"),
NcharacterSet: pulumi.String("string"),
PdbName: pulumi.String("string"),
PluggableDatabases: pulumi.StringArray{
pulumi.String("string"),
},
State: pulumi.String("string"),
TdeWalletPassword: pulumi.String("string"),
TimeCreated: pulumi.String("string"),
TimeStampForPointInTimeRecovery: pulumi.String("string"),
VaultId: pulumi.String("string"),
},
DisplayName: pulumi.String("string"),
DatabaseSoftwareImageId: pulumi.String("string"),
DbHomeLocation: pulumi.String("string"),
DbVersion: pulumi.String("string"),
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
CreateAsync: pulumi.Bool(false),
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Id: pulumi.String("string"),
LastPatchHistoryEntryId: pulumi.String("string"),
LifecycleDetails: pulumi.String("string"),
State: pulumi.String("string"),
TimeCreated: pulumi.String("string"),
},
SubnetId: pulumi.String("string"),
SshPublicKeys: pulumi.StringArray{
pulumi.String("string"),
},
Shape: pulumi.String("string"),
CompartmentId: pulumi.String("string"),
Hostname: pulumi.String("string"),
AvailabilityDomain: pulumi.String("string"),
FaultDomains: pulumi.StringArray{
pulumi.String("string"),
},
KmsKeyVersionId: pulumi.String("string"),
DatabaseEdition: pulumi.String("string"),
DataStoragePercentage: pulumi.Int(0),
DbSystemOptions: &database.DbSystemDbSystemOptionsArgs{
StorageManagement: pulumi.String("string"),
},
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
DiskRedundancy: pulumi.String("string"),
DisplayName: pulumi.String("string"),
Domain: pulumi.String("string"),
DataCollectionOptions: &database.DbSystemDataCollectionOptionsArgs{
IsDiagnosticsEventsEnabled: pulumi.Bool(false),
IsHealthMonitoringEnabled: pulumi.Bool(false),
IsIncidentLogsEnabled: pulumi.Bool(false),
},
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
CpuCoreCount: pulumi.Int(0),
KmsKeyId: pulumi.String("string"),
DataStorageSizeInGb: pulumi.Int(0),
LicenseModel: pulumi.String("string"),
MaintenanceWindowDetails: &database.DbSystemMaintenanceWindowDetailsArgs{
CustomActionTimeoutInMins: pulumi.Int(0),
DaysOfWeeks: database.DbSystemMaintenanceWindowDetailsDaysOfWeekArray{
&database.DbSystemMaintenanceWindowDetailsDaysOfWeekArgs{
Name: pulumi.String("string"),
},
},
HoursOfDays: pulumi.IntArray{
pulumi.Int(0),
},
IsCustomActionTimeoutEnabled: pulumi.Bool(false),
IsMonthlyPatchingEnabled: pulumi.Bool(false),
LeadTimeInWeeks: pulumi.Int(0),
Months: database.DbSystemMaintenanceWindowDetailsMonthArray{
&database.DbSystemMaintenanceWindowDetailsMonthArgs{
Name: pulumi.String("string"),
},
},
PatchingMode: pulumi.String("string"),
Preference: pulumi.String("string"),
SkipRus: pulumi.BoolArray{
pulumi.Bool(false),
},
WeeksOfMonths: pulumi.IntArray{
pulumi.Int(0),
},
},
NodeCount: pulumi.Int(0),
NsgIds: pulumi.StringArray{
pulumi.String("string"),
},
PrivateIp: pulumi.String("string"),
RecoStorageSizeInGb: pulumi.Int(0),
ClusterName: pulumi.String("string"),
Source: pulumi.String("string"),
SourceDbSystemId: pulumi.String("string"),
SparseDiskgroup: pulumi.Bool(false),
BackupSubnetId: pulumi.String("string"),
StorageVolumePerformanceMode: pulumi.String("string"),
BackupNetworkNsgIds: pulumi.StringArray{
pulumi.String("string"),
},
TimeZone: pulumi.String("string"),
})
var dbSystemResource = new DbSystem("dbSystemResource", DbSystemArgs.builder()
.dbHome(DbSystemDbHomeArgs.builder()
.database(DbSystemDbHomeDatabaseArgs.builder()
.adminPassword("string")
.backupId("string")
.backupTdePassword("string")
.characterSet("string")
.connectionStrings(DbSystemDbHomeDatabaseConnectionStringArgs.builder()
.allConnectionStrings(Map.of("string", "string"))
.cdbDefault("string")
.cdbIpDefault("string")
.build())
.databaseId("string")
.databaseSoftwareImageId("string")
.dbBackupConfig(DbSystemDbHomeDatabaseDbBackupConfigArgs.builder()
.autoBackupEnabled(false)
.autoBackupWindow("string")
.autoFullBackupDay("string")
.autoFullBackupWindow("string")
.backupDeletionPolicy("string")
.backupDestinationDetails(DbSystemDbHomeDatabaseDbBackupConfigBackupDestinationDetailArgs.builder()
.dbrsPolicyId("string")
.id("string")
.type("string")
.build())
.recoveryWindowInDays(0)
.runImmediateFullBackup(false)
.build())
.dbDomain("string")
.dbName("string")
.dbUniqueName("string")
.dbWorkload("string")
.definedTags(Map.of("string", "string"))
.freeformTags(Map.of("string", "string"))
.id("string")
.kmsKeyId("string")
.kmsKeyVersionId("string")
.lifecycleDetails("string")
.ncharacterSet("string")
.pdbName("string")
.pluggableDatabases("string")
.state("string")
.tdeWalletPassword("string")
.timeCreated("string")
.timeStampForPointInTimeRecovery("string")
.vaultId("string")
.build())
.displayName("string")
.databaseSoftwareImageId("string")
.dbHomeLocation("string")
.dbVersion("string")
.definedTags(Map.of("string", "string"))
.createAsync(false)
.freeformTags(Map.of("string", "string"))
.id("string")
.lastPatchHistoryEntryId("string")
.lifecycleDetails("string")
.state("string")
.timeCreated("string")
.build())
.subnetId("string")
.sshPublicKeys("string")
.shape("string")
.compartmentId("string")
.hostname("string")
.availabilityDomain("string")
.faultDomains("string")
.kmsKeyVersionId("string")
.databaseEdition("string")
.dataStoragePercentage(0)
.dbSystemOptions(DbSystemDbSystemOptionsArgs.builder()
.storageManagement("string")
.build())
.definedTags(Map.of("string", "string"))
.diskRedundancy("string")
.displayName("string")
.domain("string")
.dataCollectionOptions(DbSystemDataCollectionOptionsArgs.builder()
.isDiagnosticsEventsEnabled(false)
.isHealthMonitoringEnabled(false)
.isIncidentLogsEnabled(false)
.build())
.freeformTags(Map.of("string", "string"))
.cpuCoreCount(0)
.kmsKeyId("string")
.dataStorageSizeInGb(0)
.licenseModel("string")
.maintenanceWindowDetails(DbSystemMaintenanceWindowDetailsArgs.builder()
.customActionTimeoutInMins(0)
.daysOfWeeks(DbSystemMaintenanceWindowDetailsDaysOfWeekArgs.builder()
.name("string")
.build())
.hoursOfDays(0)
.isCustomActionTimeoutEnabled(false)
.isMonthlyPatchingEnabled(false)
.leadTimeInWeeks(0)
.months(DbSystemMaintenanceWindowDetailsMonthArgs.builder()
.name("string")
.build())
.patchingMode("string")
.preference("string")
.skipRus(false)
.weeksOfMonths(0)
.build())
.nodeCount(0)
.nsgIds("string")
.privateIp("string")
.recoStorageSizeInGb(0)
.clusterName("string")
.source("string")
.sourceDbSystemId("string")
.sparseDiskgroup(false)
.backupSubnetId("string")
.storageVolumePerformanceMode("string")
.backupNetworkNsgIds("string")
.timeZone("string")
.build());
db_system_resource = oci.database.DbSystem("dbSystemResource",
db_home={
"database": {
"admin_password": "string",
"backup_id": "string",
"backup_tde_password": "string",
"character_set": "string",
"connection_strings": [{
"all_connection_strings": {
"string": "string",
},
"cdb_default": "string",
"cdb_ip_default": "string",
}],
"database_id": "string",
"database_software_image_id": "string",
"db_backup_config": {
"auto_backup_enabled": False,
"auto_backup_window": "string",
"auto_full_backup_day": "string",
"auto_full_backup_window": "string",
"backup_deletion_policy": "string",
"backup_destination_details": [{
"dbrs_policy_id": "string",
"id": "string",
"type": "string",
}],
"recovery_window_in_days": 0,
"run_immediate_full_backup": False,
},
"db_domain": "string",
"db_name": "string",
"db_unique_name": "string",
"db_workload": "string",
"defined_tags": {
"string": "string",
},
"freeform_tags": {
"string": "string",
},
"id": "string",
"kms_key_id": "string",
"kms_key_version_id": "string",
"lifecycle_details": "string",
"ncharacter_set": "string",
"pdb_name": "string",
"pluggable_databases": ["string"],
"state": "string",
"tde_wallet_password": "string",
"time_created": "string",
"time_stamp_for_point_in_time_recovery": "string",
"vault_id": "string",
},
"display_name": "string",
"database_software_image_id": "string",
"db_home_location": "string",
"db_version": "string",
"defined_tags": {
"string": "string",
},
"create_async": False,
"freeform_tags": {
"string": "string",
},
"id": "string",
"last_patch_history_entry_id": "string",
"lifecycle_details": "string",
"state": "string",
"time_created": "string",
},
subnet_id="string",
ssh_public_keys=["string"],
shape="string",
compartment_id="string",
hostname="string",
availability_domain="string",
fault_domains=["string"],
kms_key_version_id="string",
database_edition="string",
data_storage_percentage=0,
db_system_options={
"storage_management": "string",
},
defined_tags={
"string": "string",
},
disk_redundancy="string",
display_name="string",
domain="string",
data_collection_options={
"is_diagnostics_events_enabled": False,
"is_health_monitoring_enabled": False,
"is_incident_logs_enabled": False,
},
freeform_tags={
"string": "string",
},
cpu_core_count=0,
kms_key_id="string",
data_storage_size_in_gb=0,
license_model="string",
maintenance_window_details={
"custom_action_timeout_in_mins": 0,
"days_of_weeks": [{
"name": "string",
}],
"hours_of_days": [0],
"is_custom_action_timeout_enabled": False,
"is_monthly_patching_enabled": False,
"lead_time_in_weeks": 0,
"months": [{
"name": "string",
}],
"patching_mode": "string",
"preference": "string",
"skip_rus": [False],
"weeks_of_months": [0],
},
node_count=0,
nsg_ids=["string"],
private_ip="string",
reco_storage_size_in_gb=0,
cluster_name="string",
source="string",
source_db_system_id="string",
sparse_diskgroup=False,
backup_subnet_id="string",
storage_volume_performance_mode="string",
backup_network_nsg_ids=["string"],
time_zone="string")
const dbSystemResource = new oci.database.DbSystem("dbSystemResource", {
dbHome: {
database: {
adminPassword: "string",
backupId: "string",
backupTdePassword: "string",
characterSet: "string",
connectionStrings: [{
allConnectionStrings: {
string: "string",
},
cdbDefault: "string",
cdbIpDefault: "string",
}],
databaseId: "string",
databaseSoftwareImageId: "string",
dbBackupConfig: {
autoBackupEnabled: false,
autoBackupWindow: "string",
autoFullBackupDay: "string",
autoFullBackupWindow: "string",
backupDeletionPolicy: "string",
backupDestinationDetails: [{
dbrsPolicyId: "string",
id: "string",
type: "string",
}],
recoveryWindowInDays: 0,
runImmediateFullBackup: false,
},
dbDomain: "string",
dbName: "string",
dbUniqueName: "string",
dbWorkload: "string",
definedTags: {
string: "string",
},
freeformTags: {
string: "string",
},
id: "string",
kmsKeyId: "string",
kmsKeyVersionId: "string",
lifecycleDetails: "string",
ncharacterSet: "string",
pdbName: "string",
pluggableDatabases: ["string"],
state: "string",
tdeWalletPassword: "string",
timeCreated: "string",
timeStampForPointInTimeRecovery: "string",
vaultId: "string",
},
displayName: "string",
databaseSoftwareImageId: "string",
dbHomeLocation: "string",
dbVersion: "string",
definedTags: {
string: "string",
},
createAsync: false,
freeformTags: {
string: "string",
},
id: "string",
lastPatchHistoryEntryId: "string",
lifecycleDetails: "string",
state: "string",
timeCreated: "string",
},
subnetId: "string",
sshPublicKeys: ["string"],
shape: "string",
compartmentId: "string",
hostname: "string",
availabilityDomain: "string",
faultDomains: ["string"],
kmsKeyVersionId: "string",
databaseEdition: "string",
dataStoragePercentage: 0,
dbSystemOptions: {
storageManagement: "string",
},
definedTags: {
string: "string",
},
diskRedundancy: "string",
displayName: "string",
domain: "string",
dataCollectionOptions: {
isDiagnosticsEventsEnabled: false,
isHealthMonitoringEnabled: false,
isIncidentLogsEnabled: false,
},
freeformTags: {
string: "string",
},
cpuCoreCount: 0,
kmsKeyId: "string",
dataStorageSizeInGb: 0,
licenseModel: "string",
maintenanceWindowDetails: {
customActionTimeoutInMins: 0,
daysOfWeeks: [{
name: "string",
}],
hoursOfDays: [0],
isCustomActionTimeoutEnabled: false,
isMonthlyPatchingEnabled: false,
leadTimeInWeeks: 0,
months: [{
name: "string",
}],
patchingMode: "string",
preference: "string",
skipRus: [false],
weeksOfMonths: [0],
},
nodeCount: 0,
nsgIds: ["string"],
privateIp: "string",
recoStorageSizeInGb: 0,
clusterName: "string",
source: "string",
sourceDbSystemId: "string",
sparseDiskgroup: false,
backupSubnetId: "string",
storageVolumePerformanceMode: "string",
backupNetworkNsgIds: ["string"],
timeZone: "string",
});
type: oci:Database:DbSystem
properties:
availabilityDomain: string
backupNetworkNsgIds:
- string
backupSubnetId: string
clusterName: string
compartmentId: string
cpuCoreCount: 0
dataCollectionOptions:
isDiagnosticsEventsEnabled: false
isHealthMonitoringEnabled: false
isIncidentLogsEnabled: false
dataStoragePercentage: 0
dataStorageSizeInGb: 0
databaseEdition: string
dbHome:
createAsync: false
database:
adminPassword: string
backupId: string
backupTdePassword: string
characterSet: string
connectionStrings:
- allConnectionStrings:
string: string
cdbDefault: string
cdbIpDefault: string
databaseId: string
databaseSoftwareImageId: string
dbBackupConfig:
autoBackupEnabled: false
autoBackupWindow: string
autoFullBackupDay: string
autoFullBackupWindow: string
backupDeletionPolicy: string
backupDestinationDetails:
- dbrsPolicyId: string
id: string
type: string
recoveryWindowInDays: 0
runImmediateFullBackup: false
dbDomain: string
dbName: string
dbUniqueName: string
dbWorkload: string
definedTags:
string: string
freeformTags:
string: string
id: string
kmsKeyId: string
kmsKeyVersionId: string
lifecycleDetails: string
ncharacterSet: string
pdbName: string
pluggableDatabases:
- string
state: string
tdeWalletPassword: string
timeCreated: string
timeStampForPointInTimeRecovery: string
vaultId: string
databaseSoftwareImageId: string
dbHomeLocation: string
dbVersion: string
definedTags:
string: string
displayName: string
freeformTags:
string: string
id: string
lastPatchHistoryEntryId: string
lifecycleDetails: string
state: string
timeCreated: string
dbSystemOptions:
storageManagement: string
definedTags:
string: string
diskRedundancy: string
displayName: string
domain: string
faultDomains:
- string
freeformTags:
string: string
hostname: string
kmsKeyId: string
kmsKeyVersionId: string
licenseModel: string
maintenanceWindowDetails:
customActionTimeoutInMins: 0
daysOfWeeks:
- name: string
hoursOfDays:
- 0
isCustomActionTimeoutEnabled: false
isMonthlyPatchingEnabled: false
leadTimeInWeeks: 0
months:
- name: string
patchingMode: string
preference: string
skipRus:
- false
weeksOfMonths:
- 0
nodeCount: 0
nsgIds:
- string
privateIp: string
recoStorageSizeInGb: 0
shape: string
source: string
sourceDbSystemId: string
sparseDiskgroup: false
sshPublicKeys:
- string
storageVolumePerformanceMode: string
subnetId: string
timeZone: string
DbSystem 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 DbSystem resource accepts the following input properties:
- Availability
Domain string - The availability domain where the DB system is located.
- Compartment
Id string - (Updatable) The OCID of the compartment the DB system belongs in.
- Db
Home DbSystem Db Home (Updatable) Details for creating a Database Home if you are creating a database by restoring from a database backup.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- Hostname string
The hostname for the DB system. The hostname must begin with an alphabetic character, and can contain alphanumeric characters and hyphens (-). The maximum length of the hostname is 16 characters for bare metal and virtual machine DB systems, and 12 characters for Exadata DB systems.
The maximum length of the combined hostname and domain is 63 characters.
Note: The hostname must be unique within the subnet. If it is not unique, the DB system will fail to provision.
- Shape string
(Updatable) The shape of the DB system. The shape determines resources allocated to the DB system.
- For virtual machine shapes, the number of CPU cores and memory
- For bare metal and Exadata shapes, the number of CPU cores, memory, and storage
To get a list of shapes, use the ListDbSystemShapes operation.
- Ssh
Public List<string>Keys - (Updatable) The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.
- Subnet
Id string The OCID of the subnet the DB system is associated with.
Subnet Restrictions:
- For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
- For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20.
These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.
- Backup
Network List<string>Nsg Ids - (Updatable) A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.
- Backup
Subnet stringId The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.
Subnet Restrictions: See the subnet restrictions information for subnetId.
- Cluster
Name string - The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.
- Cpu
Core intCount (Updatable) The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape:
- BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36.
- BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52.
- Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.
- Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.
- Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.
- Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.
- Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.
- Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.
- Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.
- VM.Standard.E4.Flex - Specify any thing from 1 to 64.
This parameter is not used for INTEL virtual machine DB systems because virtual machine DB systems have a set number of cores for each shape. For information about the number of cores for a virtual machine DB system shape, see Virtual Machine DB Systems
- Data
Collection DbOptions System Data Collection Options - (Updatable) Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.
- Data
Storage intPercentage - The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Specify 80 or 40. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. Required for BMDBs.
- Data
Storage intSize In Gb - (Updatable) Size (in GB) of the initial data volume that will be created and attached to a virtual machine DB system. You can scale up storage after provisioning, as needed. Note that the total storage size attached will be more than the amount you specify to allow for REDO/RECO space and software volume. Required for VMDBs.
- Database
Edition string - The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
- Db
System DbOptions System Db System Options - The DB system options.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Disk
Redundancy string - The type of redundancy configured for the DB system. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems.
- Display
Name string - The user-friendly name for the DB system. The name does not have to be unique.
- Domain string
- A domain name used for the DB system. If the Oracle-provided Internet and VCN Resolver is enabled for the specified subnet, the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted.
- Fault
Domains List<string> A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains.
If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.
If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node.
To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.
Example:
FAULT-DOMAIN-1
- Dictionary<string, string>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- 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.
- License
Model string - (Updatable) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.
- Maintenance
Window DbDetails System Maintenance Window Details - (Updatable) The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
- Node
Count int - The number of nodes to launch for a 2-node RAC virtual machine DB system. Specify either 1 or 2.
- Nsg
Ids List<string> - (Updatable) The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:
- A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
- Private
Ip string - A private IP address of your choice. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. Supported for VM BM shape.
- Reco
Storage intSize In Gb - The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.
- Source string
- The source of the database: Use
NONE
for creating a new database. UseDB_BACKUP
for creating a new database by restoring from a backup. UseDATABASE
for creating a new database from an existing database, including archive redo log data. The default isNONE
. - Source
Db stringSystem Id - The OCID of the DB system.
- Sparse
Diskgroup bool - If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured. Only applied for Exadata shape.
- Storage
Volume stringPerformance Mode - The block storage volume performance level. Valid values are
BALANCED
andHIGH_PERFORMANCE
. See Block Volume Performance for more information. - Time
Zone string The time zone to use for the DB system. For details, see DB System Time Zones.
** 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
- Availability
Domain string - The availability domain where the DB system is located.
- Compartment
Id string - (Updatable) The OCID of the compartment the DB system belongs in.
- Db
Home DbSystem Db Home Args (Updatable) Details for creating a Database Home if you are creating a database by restoring from a database backup.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- Hostname string
The hostname for the DB system. The hostname must begin with an alphabetic character, and can contain alphanumeric characters and hyphens (-). The maximum length of the hostname is 16 characters for bare metal and virtual machine DB systems, and 12 characters for Exadata DB systems.
The maximum length of the combined hostname and domain is 63 characters.
Note: The hostname must be unique within the subnet. If it is not unique, the DB system will fail to provision.
- Shape string
(Updatable) The shape of the DB system. The shape determines resources allocated to the DB system.
- For virtual machine shapes, the number of CPU cores and memory
- For bare metal and Exadata shapes, the number of CPU cores, memory, and storage
To get a list of shapes, use the ListDbSystemShapes operation.
- Ssh
Public []stringKeys - (Updatable) The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.
- Subnet
Id string The OCID of the subnet the DB system is associated with.
Subnet Restrictions:
- For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
- For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20.
These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.
- Backup
Network []stringNsg Ids - (Updatable) A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.
- Backup
Subnet stringId The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.
Subnet Restrictions: See the subnet restrictions information for subnetId.
- Cluster
Name string - The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.
- Cpu
Core intCount (Updatable) The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape:
- BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36.
- BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52.
- Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.
- Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.
- Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.
- Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.
- Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.
- Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.
- Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.
- VM.Standard.E4.Flex - Specify any thing from 1 to 64.
This parameter is not used for INTEL virtual machine DB systems because virtual machine DB systems have a set number of cores for each shape. For information about the number of cores for a virtual machine DB system shape, see Virtual Machine DB Systems
- Data
Collection DbOptions System Data Collection Options Args - (Updatable) Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.
- Data
Storage intPercentage - The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Specify 80 or 40. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. Required for BMDBs.
- Data
Storage intSize In Gb - (Updatable) Size (in GB) of the initial data volume that will be created and attached to a virtual machine DB system. You can scale up storage after provisioning, as needed. Note that the total storage size attached will be more than the amount you specify to allow for REDO/RECO space and software volume. Required for VMDBs.
- Database
Edition string - The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
- Db
System DbOptions System Db System Options Args - The DB system options.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Disk
Redundancy string - The type of redundancy configured for the DB system. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems.
- Display
Name string - The user-friendly name for the DB system. The name does not have to be unique.
- Domain string
- A domain name used for the DB system. If the Oracle-provided Internet and VCN Resolver is enabled for the specified subnet, the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted.
- Fault
Domains []string A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains.
If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.
If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node.
To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.
Example:
FAULT-DOMAIN-1
- map[string]string
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- 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.
- License
Model string - (Updatable) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.
- Maintenance
Window DbDetails System Maintenance Window Details Args - (Updatable) The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
- Node
Count int - The number of nodes to launch for a 2-node RAC virtual machine DB system. Specify either 1 or 2.
- Nsg
Ids []string - (Updatable) The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:
- A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
- Private
Ip string - A private IP address of your choice. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. Supported for VM BM shape.
- Reco
Storage intSize In Gb - The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.
- Source string
- The source of the database: Use
NONE
for creating a new database. UseDB_BACKUP
for creating a new database by restoring from a backup. UseDATABASE
for creating a new database from an existing database, including archive redo log data. The default isNONE
. - Source
Db stringSystem Id - The OCID of the DB system.
- Sparse
Diskgroup bool - If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured. Only applied for Exadata shape.
- Storage
Volume stringPerformance Mode - The block storage volume performance level. Valid values are
BALANCED
andHIGH_PERFORMANCE
. See Block Volume Performance for more information. - Time
Zone string The time zone to use for the DB system. For details, see DB System Time Zones.
** 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
- availability
Domain String - The availability domain where the DB system is located.
- compartment
Id String - (Updatable) The OCID of the compartment the DB system belongs in.
- db
Home DbSystem Db Home (Updatable) Details for creating a Database Home if you are creating a database by restoring from a database backup.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- hostname String
The hostname for the DB system. The hostname must begin with an alphabetic character, and can contain alphanumeric characters and hyphens (-). The maximum length of the hostname is 16 characters for bare metal and virtual machine DB systems, and 12 characters for Exadata DB systems.
The maximum length of the combined hostname and domain is 63 characters.
Note: The hostname must be unique within the subnet. If it is not unique, the DB system will fail to provision.
- shape String
(Updatable) The shape of the DB system. The shape determines resources allocated to the DB system.
- For virtual machine shapes, the number of CPU cores and memory
- For bare metal and Exadata shapes, the number of CPU cores, memory, and storage
To get a list of shapes, use the ListDbSystemShapes operation.
- ssh
Public List<String>Keys - (Updatable) The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.
- subnet
Id String The OCID of the subnet the DB system is associated with.
Subnet Restrictions:
- For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
- For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20.
These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.
- backup
Network List<String>Nsg Ids - (Updatable) A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.
- backup
Subnet StringId The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.
Subnet Restrictions: See the subnet restrictions information for subnetId.
- cluster
Name String - The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.
- cpu
Core IntegerCount (Updatable) The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape:
- BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36.
- BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52.
- Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.
- Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.
- Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.
- Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.
- Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.
- Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.
- Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.
- VM.Standard.E4.Flex - Specify any thing from 1 to 64.
This parameter is not used for INTEL virtual machine DB systems because virtual machine DB systems have a set number of cores for each shape. For information about the number of cores for a virtual machine DB system shape, see Virtual Machine DB Systems
- data
Collection DbOptions System Data Collection Options - (Updatable) Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.
- data
Storage IntegerPercentage - The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Specify 80 or 40. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. Required for BMDBs.
- data
Storage IntegerSize In Gb - (Updatable) Size (in GB) of the initial data volume that will be created and attached to a virtual machine DB system. You can scale up storage after provisioning, as needed. Note that the total storage size attached will be more than the amount you specify to allow for REDO/RECO space and software volume. Required for VMDBs.
- database
Edition String - The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
- db
System DbOptions System Db System Options - The DB system options.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- disk
Redundancy String - The type of redundancy configured for the DB system. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems.
- display
Name String - The user-friendly name for the DB system. The name does not have to be unique.
- domain String
- A domain name used for the DB system. If the Oracle-provided Internet and VCN Resolver is enabled for the specified subnet, the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted.
- fault
Domains List<String> A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains.
If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.
If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node.
To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.
Example:
FAULT-DOMAIN-1
- Map<String,String>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- 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.
- license
Model String - (Updatable) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.
- maintenance
Window DbDetails System Maintenance Window Details - (Updatable) The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
- node
Count Integer - The number of nodes to launch for a 2-node RAC virtual machine DB system. Specify either 1 or 2.
- nsg
Ids List<String> - (Updatable) The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:
- A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
- private
Ip String - A private IP address of your choice. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. Supported for VM BM shape.
- reco
Storage IntegerSize In Gb - The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.
- source String
- The source of the database: Use
NONE
for creating a new database. UseDB_BACKUP
for creating a new database by restoring from a backup. UseDATABASE
for creating a new database from an existing database, including archive redo log data. The default isNONE
. - source
Db StringSystem Id - The OCID of the DB system.
- sparse
Diskgroup Boolean - If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured. Only applied for Exadata shape.
- storage
Volume StringPerformance Mode - The block storage volume performance level. Valid values are
BALANCED
andHIGH_PERFORMANCE
. See Block Volume Performance for more information. - time
Zone String The time zone to use for the DB system. For details, see DB System Time Zones.
** 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
- availability
Domain string - The availability domain where the DB system is located.
- compartment
Id string - (Updatable) The OCID of the compartment the DB system belongs in.
- db
Home DbSystem Db Home (Updatable) Details for creating a Database Home if you are creating a database by restoring from a database backup.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- hostname string
The hostname for the DB system. The hostname must begin with an alphabetic character, and can contain alphanumeric characters and hyphens (-). The maximum length of the hostname is 16 characters for bare metal and virtual machine DB systems, and 12 characters for Exadata DB systems.
The maximum length of the combined hostname and domain is 63 characters.
Note: The hostname must be unique within the subnet. If it is not unique, the DB system will fail to provision.
- shape string
(Updatable) The shape of the DB system. The shape determines resources allocated to the DB system.
- For virtual machine shapes, the number of CPU cores and memory
- For bare metal and Exadata shapes, the number of CPU cores, memory, and storage
To get a list of shapes, use the ListDbSystemShapes operation.
- ssh
Public string[]Keys - (Updatable) The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.
- subnet
Id string The OCID of the subnet the DB system is associated with.
Subnet Restrictions:
- For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
- For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20.
These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.
- backup
Network string[]Nsg Ids - (Updatable) A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.
- backup
Subnet stringId The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.
Subnet Restrictions: See the subnet restrictions information for subnetId.
- cluster
Name string - The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.
- cpu
Core numberCount (Updatable) The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape:
- BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36.
- BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52.
- Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.
- Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.
- Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.
- Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.
- Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.
- Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.
- Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.
- VM.Standard.E4.Flex - Specify any thing from 1 to 64.
This parameter is not used for INTEL virtual machine DB systems because virtual machine DB systems have a set number of cores for each shape. For information about the number of cores for a virtual machine DB system shape, see Virtual Machine DB Systems
- data
Collection DbOptions System Data Collection Options - (Updatable) Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.
- data
Storage numberPercentage - The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Specify 80 or 40. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. Required for BMDBs.
- data
Storage numberSize In Gb - (Updatable) Size (in GB) of the initial data volume that will be created and attached to a virtual machine DB system. You can scale up storage after provisioning, as needed. Note that the total storage size attached will be more than the amount you specify to allow for REDO/RECO space and software volume. Required for VMDBs.
- database
Edition string - The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
- db
System DbOptions System Db System Options - The DB system options.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- disk
Redundancy string - The type of redundancy configured for the DB system. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems.
- display
Name string - The user-friendly name for the DB system. The name does not have to be unique.
- domain string
- A domain name used for the DB system. If the Oracle-provided Internet and VCN Resolver is enabled for the specified subnet, the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted.
- fault
Domains string[] A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains.
If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.
If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node.
To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.
Example:
FAULT-DOMAIN-1
- {[key: string]: string}
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- 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.
- license
Model string - (Updatable) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.
- maintenance
Window DbDetails System Maintenance Window Details - (Updatable) The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
- node
Count number - The number of nodes to launch for a 2-node RAC virtual machine DB system. Specify either 1 or 2.
- nsg
Ids string[] - (Updatable) The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:
- A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
- private
Ip string - A private IP address of your choice. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. Supported for VM BM shape.
- reco
Storage numberSize In Gb - The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.
- source string
- The source of the database: Use
NONE
for creating a new database. UseDB_BACKUP
for creating a new database by restoring from a backup. UseDATABASE
for creating a new database from an existing database, including archive redo log data. The default isNONE
. - source
Db stringSystem Id - The OCID of the DB system.
- sparse
Diskgroup boolean - If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured. Only applied for Exadata shape.
- storage
Volume stringPerformance Mode - The block storage volume performance level. Valid values are
BALANCED
andHIGH_PERFORMANCE
. See Block Volume Performance for more information. - time
Zone string The time zone to use for the DB system. For details, see DB System Time Zones.
** 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
- availability_
domain str - The availability domain where the DB system is located.
- compartment_
id str - (Updatable) The OCID of the compartment the DB system belongs in.
- db_
home database.Db System Db Home Args (Updatable) Details for creating a Database Home if you are creating a database by restoring from a database backup.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- hostname str
The hostname for the DB system. The hostname must begin with an alphabetic character, and can contain alphanumeric characters and hyphens (-). The maximum length of the hostname is 16 characters for bare metal and virtual machine DB systems, and 12 characters for Exadata DB systems.
The maximum length of the combined hostname and domain is 63 characters.
Note: The hostname must be unique within the subnet. If it is not unique, the DB system will fail to provision.
- shape str
(Updatable) The shape of the DB system. The shape determines resources allocated to the DB system.
- For virtual machine shapes, the number of CPU cores and memory
- For bare metal and Exadata shapes, the number of CPU cores, memory, and storage
To get a list of shapes, use the ListDbSystemShapes operation.
- ssh_
public_ Sequence[str]keys - (Updatable) The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.
- subnet_
id str The OCID of the subnet the DB system is associated with.
Subnet Restrictions:
- For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
- For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20.
These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.
- backup_
network_ Sequence[str]nsg_ ids - (Updatable) A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.
- backup_
subnet_ strid The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.
Subnet Restrictions: See the subnet restrictions information for subnetId.
- cluster_
name str - The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.
- cpu_
core_ intcount (Updatable) The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape:
- BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36.
- BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52.
- Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.
- Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.
- Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.
- Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.
- Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.
- Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.
- Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.
- VM.Standard.E4.Flex - Specify any thing from 1 to 64.
This parameter is not used for INTEL virtual machine DB systems because virtual machine DB systems have a set number of cores for each shape. For information about the number of cores for a virtual machine DB system shape, see Virtual Machine DB Systems
- data_
collection_ database.options Db System Data Collection Options Args - (Updatable) Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.
- data_
storage_ intpercentage - The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Specify 80 or 40. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. Required for BMDBs.
- data_
storage_ intsize_ in_ gb - (Updatable) Size (in GB) of the initial data volume that will be created and attached to a virtual machine DB system. You can scale up storage after provisioning, as needed. Note that the total storage size attached will be more than the amount you specify to allow for REDO/RECO space and software volume. Required for VMDBs.
- database_
edition str - The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
- db_
system_ database.options Db System Db System Options Args - The DB system options.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- disk_
redundancy str - The type of redundancy configured for the DB system. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems.
- display_
name str - The user-friendly name for the DB system. The name does not have to be unique.
- domain str
- A domain name used for the DB system. If the Oracle-provided Internet and VCN Resolver is enabled for the specified subnet, the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted.
- fault_
domains Sequence[str] A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains.
If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.
If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node.
To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.
Example:
FAULT-DOMAIN-1
- Mapping[str, str]
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- 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.
- license_
model str - (Updatable) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.
- maintenance_
window_ database.details Db System Maintenance Window Details Args - (Updatable) The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
- node_
count int - The number of nodes to launch for a 2-node RAC virtual machine DB system. Specify either 1 or 2.
- nsg_
ids Sequence[str] - (Updatable) The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:
- A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
- private_
ip str - A private IP address of your choice. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. Supported for VM BM shape.
- reco_
storage_ intsize_ in_ gb - The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.
- source str
- The source of the database: Use
NONE
for creating a new database. UseDB_BACKUP
for creating a new database by restoring from a backup. UseDATABASE
for creating a new database from an existing database, including archive redo log data. The default isNONE
. - source_
db_ strsystem_ id - The OCID of the DB system.
- sparse_
diskgroup bool - If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured. Only applied for Exadata shape.
- storage_
volume_ strperformance_ mode - The block storage volume performance level. Valid values are
BALANCED
andHIGH_PERFORMANCE
. See Block Volume Performance for more information. - time_
zone str The time zone to use for the DB system. For details, see DB System Time Zones.
** 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
- availability
Domain String - The availability domain where the DB system is located.
- compartment
Id String - (Updatable) The OCID of the compartment the DB system belongs in.
- db
Home Property Map (Updatable) Details for creating a Database Home if you are creating a database by restoring from a database backup.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- hostname String
The hostname for the DB system. The hostname must begin with an alphabetic character, and can contain alphanumeric characters and hyphens (-). The maximum length of the hostname is 16 characters for bare metal and virtual machine DB systems, and 12 characters for Exadata DB systems.
The maximum length of the combined hostname and domain is 63 characters.
Note: The hostname must be unique within the subnet. If it is not unique, the DB system will fail to provision.
- shape String
(Updatable) The shape of the DB system. The shape determines resources allocated to the DB system.
- For virtual machine shapes, the number of CPU cores and memory
- For bare metal and Exadata shapes, the number of CPU cores, memory, and storage
To get a list of shapes, use the ListDbSystemShapes operation.
- ssh
Public List<String>Keys - (Updatable) The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.
- subnet
Id String The OCID of the subnet the DB system is associated with.
Subnet Restrictions:
- For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
- For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20.
These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.
- backup
Network List<String>Nsg Ids - (Updatable) A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.
- backup
Subnet StringId The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.
Subnet Restrictions: See the subnet restrictions information for subnetId.
- cluster
Name String - The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.
- cpu
Core NumberCount (Updatable) The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape:
- BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36.
- BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52.
- Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.
- Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.
- Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.
- Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.
- Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.
- Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.
- Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.
- VM.Standard.E4.Flex - Specify any thing from 1 to 64.
This parameter is not used for INTEL virtual machine DB systems because virtual machine DB systems have a set number of cores for each shape. For information about the number of cores for a virtual machine DB system shape, see Virtual Machine DB Systems
- data
Collection Property MapOptions - (Updatable) Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.
- data
Storage NumberPercentage - The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Specify 80 or 40. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. Required for BMDBs.
- data
Storage NumberSize In Gb - (Updatable) Size (in GB) of the initial data volume that will be created and attached to a virtual machine DB system. You can scale up storage after provisioning, as needed. Note that the total storage size attached will be more than the amount you specify to allow for REDO/RECO space and software volume. Required for VMDBs.
- database
Edition String - The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
- db
System Property MapOptions - The DB system options.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- disk
Redundancy String - The type of redundancy configured for the DB system. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems.
- display
Name String - The user-friendly name for the DB system. The name does not have to be unique.
- domain String
- A domain name used for the DB system. If the Oracle-provided Internet and VCN Resolver is enabled for the specified subnet, the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted.
- fault
Domains List<String> A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains.
If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.
If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node.
To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.
Example:
FAULT-DOMAIN-1
- Map<String>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- 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.
- license
Model String - (Updatable) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.
- maintenance
Window Property MapDetails - (Updatable) The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
- node
Count Number - The number of nodes to launch for a 2-node RAC virtual machine DB system. Specify either 1 or 2.
- nsg
Ids List<String> - (Updatable) The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:
- A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
- private
Ip String - A private IP address of your choice. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. Supported for VM BM shape.
- reco
Storage NumberSize In Gb - The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.
- source String
- The source of the database: Use
NONE
for creating a new database. UseDB_BACKUP
for creating a new database by restoring from a backup. UseDATABASE
for creating a new database from an existing database, including archive redo log data. The default isNONE
. - source
Db StringSystem Id - The OCID of the DB system.
- sparse
Diskgroup Boolean - If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured. Only applied for Exadata shape.
- storage
Volume StringPerformance Mode - The block storage volume performance level. Valid values are
BALANCED
andHIGH_PERFORMANCE
. See Block Volume Performance for more information. - time
Zone String The time zone to use for the DB system. For details, see DB System Time Zones.
** 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
Outputs
All input properties are implicitly available as output properties. Additionally, the DbSystem resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Iorm
Config List<DbCaches System Iorm Config Cach> - The IORM settings of the Exadata DB system.
- Last
Maintenance stringRun Id - The OCID of the last maintenance run.
- Last
Patch stringHistory Entry Id - The OCID of the last patch history. This value is updated as soon as a patch operation starts.
- Lifecycle
Details string - Additional information about the current lifecycle state.
- Listener
Port int - The port number configured for the listener on the DB system.
- Maintenance
Windows List<DbSystem Maintenance Window> - The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
- Memory
Size intIn Gbs - Memory allocated to the DB system, in gigabytes.
- Next
Maintenance stringRun Id - The OCID of the next maintenance run.
- Os
Version string - The most recent OS Patch Version applied on the DB system.
- Point
In stringTime Data Disk Clone Timestamp - The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.
- Scan
Dns stringName - The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.
- Scan
Dns stringRecord Id - The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.
- Scan
Ip List<string>Ids - The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
- State string
- The current state of the DB system.
- Time
Created string - The date and time the DB system was created.
- Version string
- The Oracle Database version of the DB system.
- Vip
Ids List<string> - The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
- Zone
Id string - The OCID of the zone the DB system is associated with.
- Id string
- The provider-assigned unique ID for this managed resource.
- Iorm
Config []DbCaches System Iorm Config Cach - The IORM settings of the Exadata DB system.
- Last
Maintenance stringRun Id - The OCID of the last maintenance run.
- Last
Patch stringHistory Entry Id - The OCID of the last patch history. This value is updated as soon as a patch operation starts.
- Lifecycle
Details string - Additional information about the current lifecycle state.
- Listener
Port int - The port number configured for the listener on the DB system.
- Maintenance
Windows []DbSystem Maintenance Window - The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
- Memory
Size intIn Gbs - Memory allocated to the DB system, in gigabytes.
- Next
Maintenance stringRun Id - The OCID of the next maintenance run.
- Os
Version string - The most recent OS Patch Version applied on the DB system.
- Point
In stringTime Data Disk Clone Timestamp - The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.
- Scan
Dns stringName - The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.
- Scan
Dns stringRecord Id - The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.
- Scan
Ip []stringIds - The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
- State string
- The current state of the DB system.
- Time
Created string - The date and time the DB system was created.
- Version string
- The Oracle Database version of the DB system.
- Vip
Ids []string - The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
- Zone
Id string - The OCID of the zone the DB system is associated with.
- id String
- The provider-assigned unique ID for this managed resource.
- iorm
Config List<DbCaches System Iorm Config Cach> - The IORM settings of the Exadata DB system.
- last
Maintenance StringRun Id - The OCID of the last maintenance run.
- last
Patch StringHistory Entry Id - The OCID of the last patch history. This value is updated as soon as a patch operation starts.
- lifecycle
Details String - Additional information about the current lifecycle state.
- listener
Port Integer - The port number configured for the listener on the DB system.
- maintenance
Windows List<DbSystem Maintenance Window> - The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
- memory
Size IntegerIn Gbs - Memory allocated to the DB system, in gigabytes.
- next
Maintenance StringRun Id - The OCID of the next maintenance run.
- os
Version String - The most recent OS Patch Version applied on the DB system.
- point
In StringTime Data Disk Clone Timestamp - The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.
- scan
Dns StringName - The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.
- scan
Dns StringRecord Id - The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.
- scan
Ip List<String>Ids - The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
- state String
- The current state of the DB system.
- time
Created String - The date and time the DB system was created.
- version String
- The Oracle Database version of the DB system.
- vip
Ids List<String> - The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
- zone
Id String - The OCID of the zone the DB system is associated with.
- id string
- The provider-assigned unique ID for this managed resource.
- iorm
Config DbCaches System Iorm Config Cach[] - The IORM settings of the Exadata DB system.
- last
Maintenance stringRun Id - The OCID of the last maintenance run.
- last
Patch stringHistory Entry Id - The OCID of the last patch history. This value is updated as soon as a patch operation starts.
- lifecycle
Details string - Additional information about the current lifecycle state.
- listener
Port number - The port number configured for the listener on the DB system.
- maintenance
Windows DbSystem Maintenance Window[] - The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
- memory
Size numberIn Gbs - Memory allocated to the DB system, in gigabytes.
- next
Maintenance stringRun Id - The OCID of the next maintenance run.
- os
Version string - The most recent OS Patch Version applied on the DB system.
- point
In stringTime Data Disk Clone Timestamp - The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.
- scan
Dns stringName - The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.
- scan
Dns stringRecord Id - The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.
- scan
Ip string[]Ids - The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
- state string
- The current state of the DB system.
- time
Created string - The date and time the DB system was created.
- version string
- The Oracle Database version of the DB system.
- vip
Ids string[] - The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
- zone
Id string - The OCID of the zone the DB system is associated with.
- id str
- The provider-assigned unique ID for this managed resource.
- iorm_
config_ Sequence[database.caches Db System Iorm Config Cach] - The IORM settings of the Exadata DB system.
- last_
maintenance_ strrun_ id - The OCID of the last maintenance run.
- last_
patch_ strhistory_ entry_ id - The OCID of the last patch history. This value is updated as soon as a patch operation starts.
- lifecycle_
details str - Additional information about the current lifecycle state.
- listener_
port int - The port number configured for the listener on the DB system.
- maintenance_
windows Sequence[database.Db System Maintenance Window] - The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
- memory_
size_ intin_ gbs - Memory allocated to the DB system, in gigabytes.
- next_
maintenance_ strrun_ id - The OCID of the next maintenance run.
- os_
version str - The most recent OS Patch Version applied on the DB system.
- point_
in_ strtime_ data_ disk_ clone_ timestamp - The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.
- scan_
dns_ strname - The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.
- scan_
dns_ strrecord_ id - The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.
- scan_
ip_ Sequence[str]ids - The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
- state str
- The current state of the DB system.
- time_
created str - The date and time the DB system was created.
- version str
- The Oracle Database version of the DB system.
- vip_
ids Sequence[str] - The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
- zone_
id str - The OCID of the zone the DB system is associated with.
- id String
- The provider-assigned unique ID for this managed resource.
- iorm
Config List<Property Map>Caches - The IORM settings of the Exadata DB system.
- last
Maintenance StringRun Id - The OCID of the last maintenance run.
- last
Patch StringHistory Entry Id - The OCID of the last patch history. This value is updated as soon as a patch operation starts.
- lifecycle
Details String - Additional information about the current lifecycle state.
- listener
Port Number - The port number configured for the listener on the DB system.
- maintenance
Windows List<Property Map> - The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
- memory
Size NumberIn Gbs - Memory allocated to the DB system, in gigabytes.
- next
Maintenance StringRun Id - The OCID of the next maintenance run.
- os
Version String - The most recent OS Patch Version applied on the DB system.
- point
In StringTime Data Disk Clone Timestamp - The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.
- scan
Dns StringName - The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.
- scan
Dns StringRecord Id - The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.
- scan
Ip List<String>Ids - The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
- state String
- The current state of the DB system.
- time
Created String - The date and time the DB system was created.
- version String
- The Oracle Database version of the DB system.
- vip
Ids List<String> - The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
- zone
Id String - The OCID of the zone the DB system is associated with.
Look up Existing DbSystem Resource
Get an existing DbSystem 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?: DbSystemState, opts?: CustomResourceOptions): DbSystem
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
availability_domain: Optional[str] = None,
backup_network_nsg_ids: Optional[Sequence[str]] = None,
backup_subnet_id: Optional[str] = None,
cluster_name: Optional[str] = None,
compartment_id: Optional[str] = None,
cpu_core_count: Optional[int] = None,
data_collection_options: Optional[_database.DbSystemDataCollectionOptionsArgs] = None,
data_storage_percentage: Optional[int] = None,
data_storage_size_in_gb: Optional[int] = None,
database_edition: Optional[str] = None,
db_home: Optional[_database.DbSystemDbHomeArgs] = None,
db_system_options: Optional[_database.DbSystemDbSystemOptionsArgs] = None,
defined_tags: Optional[Mapping[str, str]] = None,
disk_redundancy: Optional[str] = None,
display_name: Optional[str] = None,
domain: Optional[str] = None,
fault_domains: Optional[Sequence[str]] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
hostname: Optional[str] = None,
iorm_config_caches: Optional[Sequence[_database.DbSystemIormConfigCachArgs]] = None,
kms_key_id: Optional[str] = None,
kms_key_version_id: Optional[str] = None,
last_maintenance_run_id: Optional[str] = None,
last_patch_history_entry_id: Optional[str] = None,
license_model: Optional[str] = None,
lifecycle_details: Optional[str] = None,
listener_port: Optional[int] = None,
maintenance_window_details: Optional[_database.DbSystemMaintenanceWindowDetailsArgs] = None,
maintenance_windows: Optional[Sequence[_database.DbSystemMaintenanceWindowArgs]] = None,
memory_size_in_gbs: Optional[int] = None,
next_maintenance_run_id: Optional[str] = None,
node_count: Optional[int] = None,
nsg_ids: Optional[Sequence[str]] = None,
os_version: Optional[str] = None,
point_in_time_data_disk_clone_timestamp: Optional[str] = None,
private_ip: Optional[str] = None,
reco_storage_size_in_gb: Optional[int] = None,
scan_dns_name: Optional[str] = None,
scan_dns_record_id: Optional[str] = None,
scan_ip_ids: Optional[Sequence[str]] = None,
shape: Optional[str] = None,
source: Optional[str] = None,
source_db_system_id: Optional[str] = None,
sparse_diskgroup: Optional[bool] = None,
ssh_public_keys: Optional[Sequence[str]] = None,
state: Optional[str] = None,
storage_volume_performance_mode: Optional[str] = None,
subnet_id: Optional[str] = None,
time_created: Optional[str] = None,
time_zone: Optional[str] = None,
version: Optional[str] = None,
vip_ids: Optional[Sequence[str]] = None,
zone_id: Optional[str] = None) -> DbSystem
func GetDbSystem(ctx *Context, name string, id IDInput, state *DbSystemState, opts ...ResourceOption) (*DbSystem, error)
public static DbSystem Get(string name, Input<string> id, DbSystemState? state, CustomResourceOptions? opts = null)
public static DbSystem get(String name, Output<String> id, DbSystemState 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.
- Availability
Domain string - The availability domain where the DB system is located.
- Backup
Network List<string>Nsg Ids - (Updatable) A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.
- Backup
Subnet stringId The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.
Subnet Restrictions: See the subnet restrictions information for subnetId.
- Cluster
Name string - The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.
- Compartment
Id string - (Updatable) The OCID of the compartment the DB system belongs in.
- Cpu
Core intCount (Updatable) The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape:
- BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36.
- BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52.
- Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.
- Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.
- Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.
- Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.
- Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.
- Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.
- Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.
- VM.Standard.E4.Flex - Specify any thing from 1 to 64.
This parameter is not used for INTEL virtual machine DB systems because virtual machine DB systems have a set number of cores for each shape. For information about the number of cores for a virtual machine DB system shape, see Virtual Machine DB Systems
- Data
Collection DbOptions System Data Collection Options - (Updatable) Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.
- Data
Storage intPercentage - The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Specify 80 or 40. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. Required for BMDBs.
- Data
Storage intSize In Gb - (Updatable) Size (in GB) of the initial data volume that will be created and attached to a virtual machine DB system. You can scale up storage after provisioning, as needed. Note that the total storage size attached will be more than the amount you specify to allow for REDO/RECO space and software volume. Required for VMDBs.
- Database
Edition string - The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
- Db
Home DbSystem Db Home (Updatable) Details for creating a Database Home if you are creating a database by restoring from a database backup.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- Db
System DbOptions System Db System Options - The DB system options.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Disk
Redundancy string - The type of redundancy configured for the DB system. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems.
- Display
Name string - The user-friendly name for the DB system. The name does not have to be unique.
- Domain string
- A domain name used for the DB system. If the Oracle-provided Internet and VCN Resolver is enabled for the specified subnet, the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted.
- Fault
Domains List<string> A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains.
If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.
If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node.
To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.
Example:
FAULT-DOMAIN-1
- Dictionary<string, string>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- Hostname string
The hostname for the DB system. The hostname must begin with an alphabetic character, and can contain alphanumeric characters and hyphens (-). The maximum length of the hostname is 16 characters for bare metal and virtual machine DB systems, and 12 characters for Exadata DB systems.
The maximum length of the combined hostname and domain is 63 characters.
Note: The hostname must be unique within the subnet. If it is not unique, the DB system will fail to provision.
- Iorm
Config List<DbCaches System Iorm Config Cach> - The IORM settings of the Exadata DB system.
- 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
Maintenance stringRun Id - The OCID of the last maintenance run.
- Last
Patch stringHistory Entry Id - The OCID of the last patch history. This value is updated as soon as a patch operation starts.
- License
Model string - (Updatable) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.
- Lifecycle
Details string - Additional information about the current lifecycle state.
- Listener
Port int - The port number configured for the listener on the DB system.
- Maintenance
Window DbDetails System Maintenance Window Details - (Updatable) The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
- Maintenance
Windows List<DbSystem Maintenance Window> - The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
- Memory
Size intIn Gbs - Memory allocated to the DB system, in gigabytes.
- Next
Maintenance stringRun Id - The OCID of the next maintenance run.
- Node
Count int - The number of nodes to launch for a 2-node RAC virtual machine DB system. Specify either 1 or 2.
- Nsg
Ids List<string> - (Updatable) The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:
- A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
- Os
Version string - The most recent OS Patch Version applied on the DB system.
- Point
In stringTime Data Disk Clone Timestamp - The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.
- Private
Ip string - A private IP address of your choice. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. Supported for VM BM shape.
- Reco
Storage intSize In Gb - The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.
- Scan
Dns stringName - The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.
- Scan
Dns stringRecord Id - The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.
- Scan
Ip List<string>Ids - The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
- Shape string
(Updatable) The shape of the DB system. The shape determines resources allocated to the DB system.
- For virtual machine shapes, the number of CPU cores and memory
- For bare metal and Exadata shapes, the number of CPU cores, memory, and storage
To get a list of shapes, use the ListDbSystemShapes operation.
- Source string
- The source of the database: Use
NONE
for creating a new database. UseDB_BACKUP
for creating a new database by restoring from a backup. UseDATABASE
for creating a new database from an existing database, including archive redo log data. The default isNONE
. - Source
Db stringSystem Id - The OCID of the DB system.
- Sparse
Diskgroup bool - If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured. Only applied for Exadata shape.
- Ssh
Public List<string>Keys - (Updatable) The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.
- State string
- The current state of the DB system.
- Storage
Volume stringPerformance Mode - The block storage volume performance level. Valid values are
BALANCED
andHIGH_PERFORMANCE
. See Block Volume Performance for more information. - Subnet
Id string The OCID of the subnet the DB system is associated with.
Subnet Restrictions:
- For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
- For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20.
These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.
- Time
Created string - The date and time the DB system was created.
- Time
Zone string The time zone to use for the DB system. For details, see DB System Time Zones.
** 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
- Version string
- The Oracle Database version of the DB system.
- Vip
Ids List<string> - The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
- Zone
Id string - The OCID of the zone the DB system is associated with.
- Availability
Domain string - The availability domain where the DB system is located.
- Backup
Network []stringNsg Ids - (Updatable) A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.
- Backup
Subnet stringId The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.
Subnet Restrictions: See the subnet restrictions information for subnetId.
- Cluster
Name string - The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.
- Compartment
Id string - (Updatable) The OCID of the compartment the DB system belongs in.
- Cpu
Core intCount (Updatable) The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape:
- BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36.
- BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52.
- Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.
- Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.
- Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.
- Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.
- Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.
- Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.
- Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.
- VM.Standard.E4.Flex - Specify any thing from 1 to 64.
This parameter is not used for INTEL virtual machine DB systems because virtual machine DB systems have a set number of cores for each shape. For information about the number of cores for a virtual machine DB system shape, see Virtual Machine DB Systems
- Data
Collection DbOptions System Data Collection Options Args - (Updatable) Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.
- Data
Storage intPercentage - The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Specify 80 or 40. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. Required for BMDBs.
- Data
Storage intSize In Gb - (Updatable) Size (in GB) of the initial data volume that will be created and attached to a virtual machine DB system. You can scale up storage after provisioning, as needed. Note that the total storage size attached will be more than the amount you specify to allow for REDO/RECO space and software volume. Required for VMDBs.
- Database
Edition string - The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
- Db
Home DbSystem Db Home Args (Updatable) Details for creating a Database Home if you are creating a database by restoring from a database backup.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- Db
System DbOptions System Db System Options Args - The DB system options.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Disk
Redundancy string - The type of redundancy configured for the DB system. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems.
- Display
Name string - The user-friendly name for the DB system. The name does not have to be unique.
- Domain string
- A domain name used for the DB system. If the Oracle-provided Internet and VCN Resolver is enabled for the specified subnet, the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted.
- Fault
Domains []string A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains.
If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.
If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node.
To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.
Example:
FAULT-DOMAIN-1
- map[string]string
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- Hostname string
The hostname for the DB system. The hostname must begin with an alphabetic character, and can contain alphanumeric characters and hyphens (-). The maximum length of the hostname is 16 characters for bare metal and virtual machine DB systems, and 12 characters for Exadata DB systems.
The maximum length of the combined hostname and domain is 63 characters.
Note: The hostname must be unique within the subnet. If it is not unique, the DB system will fail to provision.
- Iorm
Config []DbCaches System Iorm Config Cach Args - The IORM settings of the Exadata DB system.
- 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
Maintenance stringRun Id - The OCID of the last maintenance run.
- Last
Patch stringHistory Entry Id - The OCID of the last patch history. This value is updated as soon as a patch operation starts.
- License
Model string - (Updatable) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.
- Lifecycle
Details string - Additional information about the current lifecycle state.
- Listener
Port int - The port number configured for the listener on the DB system.
- Maintenance
Window DbDetails System Maintenance Window Details Args - (Updatable) The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
- Maintenance
Windows []DbSystem Maintenance Window Args - The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
- Memory
Size intIn Gbs - Memory allocated to the DB system, in gigabytes.
- Next
Maintenance stringRun Id - The OCID of the next maintenance run.
- Node
Count int - The number of nodes to launch for a 2-node RAC virtual machine DB system. Specify either 1 or 2.
- Nsg
Ids []string - (Updatable) The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:
- A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
- Os
Version string - The most recent OS Patch Version applied on the DB system.
- Point
In stringTime Data Disk Clone Timestamp - The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.
- Private
Ip string - A private IP address of your choice. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. Supported for VM BM shape.
- Reco
Storage intSize In Gb - The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.
- Scan
Dns stringName - The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.
- Scan
Dns stringRecord Id - The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.
- Scan
Ip []stringIds - The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
- Shape string
(Updatable) The shape of the DB system. The shape determines resources allocated to the DB system.
- For virtual machine shapes, the number of CPU cores and memory
- For bare metal and Exadata shapes, the number of CPU cores, memory, and storage
To get a list of shapes, use the ListDbSystemShapes operation.
- Source string
- The source of the database: Use
NONE
for creating a new database. UseDB_BACKUP
for creating a new database by restoring from a backup. UseDATABASE
for creating a new database from an existing database, including archive redo log data. The default isNONE
. - Source
Db stringSystem Id - The OCID of the DB system.
- Sparse
Diskgroup bool - If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured. Only applied for Exadata shape.
- Ssh
Public []stringKeys - (Updatable) The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.
- State string
- The current state of the DB system.
- Storage
Volume stringPerformance Mode - The block storage volume performance level. Valid values are
BALANCED
andHIGH_PERFORMANCE
. See Block Volume Performance for more information. - Subnet
Id string The OCID of the subnet the DB system is associated with.
Subnet Restrictions:
- For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
- For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20.
These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.
- Time
Created string - The date and time the DB system was created.
- Time
Zone string The time zone to use for the DB system. For details, see DB System Time Zones.
** 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
- Version string
- The Oracle Database version of the DB system.
- Vip
Ids []string - The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
- Zone
Id string - The OCID of the zone the DB system is associated with.
- availability
Domain String - The availability domain where the DB system is located.
- backup
Network List<String>Nsg Ids - (Updatable) A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.
- backup
Subnet StringId The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.
Subnet Restrictions: See the subnet restrictions information for subnetId.
- cluster
Name String - The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.
- compartment
Id String - (Updatable) The OCID of the compartment the DB system belongs in.
- cpu
Core IntegerCount (Updatable) The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape:
- BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36.
- BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52.
- Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.
- Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.
- Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.
- Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.
- Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.
- Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.
- Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.
- VM.Standard.E4.Flex - Specify any thing from 1 to 64.
This parameter is not used for INTEL virtual machine DB systems because virtual machine DB systems have a set number of cores for each shape. For information about the number of cores for a virtual machine DB system shape, see Virtual Machine DB Systems
- data
Collection DbOptions System Data Collection Options - (Updatable) Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.
- data
Storage IntegerPercentage - The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Specify 80 or 40. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. Required for BMDBs.
- data
Storage IntegerSize In Gb - (Updatable) Size (in GB) of the initial data volume that will be created and attached to a virtual machine DB system. You can scale up storage after provisioning, as needed. Note that the total storage size attached will be more than the amount you specify to allow for REDO/RECO space and software volume. Required for VMDBs.
- database
Edition String - The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
- db
Home DbSystem Db Home (Updatable) Details for creating a Database Home if you are creating a database by restoring from a database backup.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- db
System DbOptions System Db System Options - The DB system options.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- disk
Redundancy String - The type of redundancy configured for the DB system. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems.
- display
Name String - The user-friendly name for the DB system. The name does not have to be unique.
- domain String
- A domain name used for the DB system. If the Oracle-provided Internet and VCN Resolver is enabled for the specified subnet, the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted.
- fault
Domains List<String> A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains.
If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.
If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node.
To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.
Example:
FAULT-DOMAIN-1
- Map<String,String>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- hostname String
The hostname for the DB system. The hostname must begin with an alphabetic character, and can contain alphanumeric characters and hyphens (-). The maximum length of the hostname is 16 characters for bare metal and virtual machine DB systems, and 12 characters for Exadata DB systems.
The maximum length of the combined hostname and domain is 63 characters.
Note: The hostname must be unique within the subnet. If it is not unique, the DB system will fail to provision.
- iorm
Config List<DbCaches System Iorm Config Cach> - The IORM settings of the Exadata DB system.
- 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
Maintenance StringRun Id - The OCID of the last maintenance run.
- last
Patch StringHistory Entry Id - The OCID of the last patch history. This value is updated as soon as a patch operation starts.
- license
Model String - (Updatable) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.
- lifecycle
Details String - Additional information about the current lifecycle state.
- listener
Port Integer - The port number configured for the listener on the DB system.
- maintenance
Window DbDetails System Maintenance Window Details - (Updatable) The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
- maintenance
Windows List<DbSystem Maintenance Window> - The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
- memory
Size IntegerIn Gbs - Memory allocated to the DB system, in gigabytes.
- next
Maintenance StringRun Id - The OCID of the next maintenance run.
- node
Count Integer - The number of nodes to launch for a 2-node RAC virtual machine DB system. Specify either 1 or 2.
- nsg
Ids List<String> - (Updatable) The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:
- A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
- os
Version String - The most recent OS Patch Version applied on the DB system.
- point
In StringTime Data Disk Clone Timestamp - The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.
- private
Ip String - A private IP address of your choice. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. Supported for VM BM shape.
- reco
Storage IntegerSize In Gb - The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.
- scan
Dns StringName - The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.
- scan
Dns StringRecord Id - The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.
- scan
Ip List<String>Ids - The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
- shape String
(Updatable) The shape of the DB system. The shape determines resources allocated to the DB system.
- For virtual machine shapes, the number of CPU cores and memory
- For bare metal and Exadata shapes, the number of CPU cores, memory, and storage
To get a list of shapes, use the ListDbSystemShapes operation.
- source String
- The source of the database: Use
NONE
for creating a new database. UseDB_BACKUP
for creating a new database by restoring from a backup. UseDATABASE
for creating a new database from an existing database, including archive redo log data. The default isNONE
. - source
Db StringSystem Id - The OCID of the DB system.
- sparse
Diskgroup Boolean - If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured. Only applied for Exadata shape.
- ssh
Public List<String>Keys - (Updatable) The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.
- state String
- The current state of the DB system.
- storage
Volume StringPerformance Mode - The block storage volume performance level. Valid values are
BALANCED
andHIGH_PERFORMANCE
. See Block Volume Performance for more information. - subnet
Id String The OCID of the subnet the DB system is associated with.
Subnet Restrictions:
- For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
- For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20.
These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.
- time
Created String - The date and time the DB system was created.
- time
Zone String The time zone to use for the DB system. For details, see DB System Time Zones.
** 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
- version String
- The Oracle Database version of the DB system.
- vip
Ids List<String> - The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
- zone
Id String - The OCID of the zone the DB system is associated with.
- availability
Domain string - The availability domain where the DB system is located.
- backup
Network string[]Nsg Ids - (Updatable) A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.
- backup
Subnet stringId The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.
Subnet Restrictions: See the subnet restrictions information for subnetId.
- cluster
Name string - The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.
- compartment
Id string - (Updatable) The OCID of the compartment the DB system belongs in.
- cpu
Core numberCount (Updatable) The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape:
- BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36.
- BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52.
- Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.
- Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.
- Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.
- Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.
- Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.
- Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.
- Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.
- VM.Standard.E4.Flex - Specify any thing from 1 to 64.
This parameter is not used for INTEL virtual machine DB systems because virtual machine DB systems have a set number of cores for each shape. For information about the number of cores for a virtual machine DB system shape, see Virtual Machine DB Systems
- data
Collection DbOptions System Data Collection Options - (Updatable) Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.
- data
Storage numberPercentage - The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Specify 80 or 40. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. Required for BMDBs.
- data
Storage numberSize In Gb - (Updatable) Size (in GB) of the initial data volume that will be created and attached to a virtual machine DB system. You can scale up storage after provisioning, as needed. Note that the total storage size attached will be more than the amount you specify to allow for REDO/RECO space and software volume. Required for VMDBs.
- database
Edition string - The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
- db
Home DbSystem Db Home (Updatable) Details for creating a Database Home if you are creating a database by restoring from a database backup.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- db
System DbOptions System Db System Options - The DB system options.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- disk
Redundancy string - The type of redundancy configured for the DB system. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems.
- display
Name string - The user-friendly name for the DB system. The name does not have to be unique.
- domain string
- A domain name used for the DB system. If the Oracle-provided Internet and VCN Resolver is enabled for the specified subnet, the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted.
- fault
Domains string[] A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains.
If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.
If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node.
To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.
Example:
FAULT-DOMAIN-1
- {[key: string]: string}
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- hostname string
The hostname for the DB system. The hostname must begin with an alphabetic character, and can contain alphanumeric characters and hyphens (-). The maximum length of the hostname is 16 characters for bare metal and virtual machine DB systems, and 12 characters for Exadata DB systems.
The maximum length of the combined hostname and domain is 63 characters.
Note: The hostname must be unique within the subnet. If it is not unique, the DB system will fail to provision.
- iorm
Config DbCaches System Iorm Config Cach[] - The IORM settings of the Exadata DB system.
- 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
Maintenance stringRun Id - The OCID of the last maintenance run.
- last
Patch stringHistory Entry Id - The OCID of the last patch history. This value is updated as soon as a patch operation starts.
- license
Model string - (Updatable) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.
- lifecycle
Details string - Additional information about the current lifecycle state.
- listener
Port number - The port number configured for the listener on the DB system.
- maintenance
Window DbDetails System Maintenance Window Details - (Updatable) The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
- maintenance
Windows DbSystem Maintenance Window[] - The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
- memory
Size numberIn Gbs - Memory allocated to the DB system, in gigabytes.
- next
Maintenance stringRun Id - The OCID of the next maintenance run.
- node
Count number - The number of nodes to launch for a 2-node RAC virtual machine DB system. Specify either 1 or 2.
- nsg
Ids string[] - (Updatable) The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:
- A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
- os
Version string - The most recent OS Patch Version applied on the DB system.
- point
In stringTime Data Disk Clone Timestamp - The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.
- private
Ip string - A private IP address of your choice. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. Supported for VM BM shape.
- reco
Storage numberSize In Gb - The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.
- scan
Dns stringName - The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.
- scan
Dns stringRecord Id - The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.
- scan
Ip string[]Ids - The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
- shape string
(Updatable) The shape of the DB system. The shape determines resources allocated to the DB system.
- For virtual machine shapes, the number of CPU cores and memory
- For bare metal and Exadata shapes, the number of CPU cores, memory, and storage
To get a list of shapes, use the ListDbSystemShapes operation.
- source string
- The source of the database: Use
NONE
for creating a new database. UseDB_BACKUP
for creating a new database by restoring from a backup. UseDATABASE
for creating a new database from an existing database, including archive redo log data. The default isNONE
. - source
Db stringSystem Id - The OCID of the DB system.
- sparse
Diskgroup boolean - If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured. Only applied for Exadata shape.
- ssh
Public string[]Keys - (Updatable) The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.
- state string
- The current state of the DB system.
- storage
Volume stringPerformance Mode - The block storage volume performance level. Valid values are
BALANCED
andHIGH_PERFORMANCE
. See Block Volume Performance for more information. - subnet
Id string The OCID of the subnet the DB system is associated with.
Subnet Restrictions:
- For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
- For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20.
These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.
- time
Created string - The date and time the DB system was created.
- time
Zone string The time zone to use for the DB system. For details, see DB System Time Zones.
** 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
- version string
- The Oracle Database version of the DB system.
- vip
Ids string[] - The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
- zone
Id string - The OCID of the zone the DB system is associated with.
- availability_
domain str - The availability domain where the DB system is located.
- backup_
network_ Sequence[str]nsg_ ids - (Updatable) A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.
- backup_
subnet_ strid The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.
Subnet Restrictions: See the subnet restrictions information for subnetId.
- cluster_
name str - The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.
- compartment_
id str - (Updatable) The OCID of the compartment the DB system belongs in.
- cpu_
core_ intcount (Updatable) The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape:
- BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36.
- BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52.
- Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.
- Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.
- Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.
- Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.
- Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.
- Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.
- Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.
- VM.Standard.E4.Flex - Specify any thing from 1 to 64.
This parameter is not used for INTEL virtual machine DB systems because virtual machine DB systems have a set number of cores for each shape. For information about the number of cores for a virtual machine DB system shape, see Virtual Machine DB Systems
- data_
collection_ database.options Db System Data Collection Options Args - (Updatable) Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.
- data_
storage_ intpercentage - The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Specify 80 or 40. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. Required for BMDBs.
- data_
storage_ intsize_ in_ gb - (Updatable) Size (in GB) of the initial data volume that will be created and attached to a virtual machine DB system. You can scale up storage after provisioning, as needed. Note that the total storage size attached will be more than the amount you specify to allow for REDO/RECO space and software volume. Required for VMDBs.
- database_
edition str - The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
- db_
home database.Db System Db Home Args (Updatable) Details for creating a Database Home if you are creating a database by restoring from a database backup.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- db_
system_ database.options Db System Db System Options Args - The DB system options.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- disk_
redundancy str - The type of redundancy configured for the DB system. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems.
- display_
name str - The user-friendly name for the DB system. The name does not have to be unique.
- domain str
- A domain name used for the DB system. If the Oracle-provided Internet and VCN Resolver is enabled for the specified subnet, the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted.
- fault_
domains Sequence[str] A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains.
If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.
If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node.
To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.
Example:
FAULT-DOMAIN-1
- Mapping[str, str]
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- hostname str
The hostname for the DB system. The hostname must begin with an alphabetic character, and can contain alphanumeric characters and hyphens (-). The maximum length of the hostname is 16 characters for bare metal and virtual machine DB systems, and 12 characters for Exadata DB systems.
The maximum length of the combined hostname and domain is 63 characters.
Note: The hostname must be unique within the subnet. If it is not unique, the DB system will fail to provision.
- iorm_
config_ Sequence[database.caches Db System Iorm Config Cach Args] - The IORM settings of the Exadata DB system.
- 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_
maintenance_ strrun_ id - The OCID of the last maintenance run.
- last_
patch_ strhistory_ entry_ id - The OCID of the last patch history. This value is updated as soon as a patch operation starts.
- license_
model str - (Updatable) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.
- lifecycle_
details str - Additional information about the current lifecycle state.
- listener_
port int - The port number configured for the listener on the DB system.
- maintenance_
window_ database.details Db System Maintenance Window Details Args - (Updatable) The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
- maintenance_
windows Sequence[database.Db System Maintenance Window Args] - The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
- memory_
size_ intin_ gbs - Memory allocated to the DB system, in gigabytes.
- next_
maintenance_ strrun_ id - The OCID of the next maintenance run.
- node_
count int - The number of nodes to launch for a 2-node RAC virtual machine DB system. Specify either 1 or 2.
- nsg_
ids Sequence[str] - (Updatable) The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:
- A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
- os_
version str - The most recent OS Patch Version applied on the DB system.
- point_
in_ strtime_ data_ disk_ clone_ timestamp - The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.
- private_
ip str - A private IP address of your choice. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. Supported for VM BM shape.
- reco_
storage_ intsize_ in_ gb - The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.
- scan_
dns_ strname - The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.
- scan_
dns_ strrecord_ id - The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.
- scan_
ip_ Sequence[str]ids - The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
- shape str
(Updatable) The shape of the DB system. The shape determines resources allocated to the DB system.
- For virtual machine shapes, the number of CPU cores and memory
- For bare metal and Exadata shapes, the number of CPU cores, memory, and storage
To get a list of shapes, use the ListDbSystemShapes operation.
- source str
- The source of the database: Use
NONE
for creating a new database. UseDB_BACKUP
for creating a new database by restoring from a backup. UseDATABASE
for creating a new database from an existing database, including archive redo log data. The default isNONE
. - source_
db_ strsystem_ id - The OCID of the DB system.
- sparse_
diskgroup bool - If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured. Only applied for Exadata shape.
- ssh_
public_ Sequence[str]keys - (Updatable) The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.
- state str
- The current state of the DB system.
- storage_
volume_ strperformance_ mode - The block storage volume performance level. Valid values are
BALANCED
andHIGH_PERFORMANCE
. See Block Volume Performance for more information. - subnet_
id str The OCID of the subnet the DB system is associated with.
Subnet Restrictions:
- For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
- For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20.
These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.
- time_
created str - The date and time the DB system was created.
- time_
zone str The time zone to use for the DB system. For details, see DB System Time Zones.
** 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
- version str
- The Oracle Database version of the DB system.
- vip_
ids Sequence[str] - The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
- zone_
id str - The OCID of the zone the DB system is associated with.
- availability
Domain String - The availability domain where the DB system is located.
- backup
Network List<String>Nsg Ids - (Updatable) A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.
- backup
Subnet StringId The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.
Subnet Restrictions: See the subnet restrictions information for subnetId.
- cluster
Name String - The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.
- compartment
Id String - (Updatable) The OCID of the compartment the DB system belongs in.
- cpu
Core NumberCount (Updatable) The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape:
- BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36.
- BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52.
- Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.
- Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.
- Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.
- Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.
- Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.
- Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.
- Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.
- VM.Standard.E4.Flex - Specify any thing from 1 to 64.
This parameter is not used for INTEL virtual machine DB systems because virtual machine DB systems have a set number of cores for each shape. For information about the number of cores for a virtual machine DB system shape, see Virtual Machine DB Systems
- data
Collection Property MapOptions - (Updatable) Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.
- data
Storage NumberPercentage - The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Specify 80 or 40. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. Required for BMDBs.
- data
Storage NumberSize In Gb - (Updatable) Size (in GB) of the initial data volume that will be created and attached to a virtual machine DB system. You can scale up storage after provisioning, as needed. Note that the total storage size attached will be more than the amount you specify to allow for REDO/RECO space and software volume. Required for VMDBs.
- database
Edition String - The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
- db
Home Property Map (Updatable) Details for creating a Database Home if you are creating a database by restoring from a database backup.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- db
System Property MapOptions - The DB system options.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- disk
Redundancy String - The type of redundancy configured for the DB system. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems.
- display
Name String - The user-friendly name for the DB system. The name does not have to be unique.
- domain String
- A domain name used for the DB system. If the Oracle-provided Internet and VCN Resolver is enabled for the specified subnet, the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted.
- fault
Domains List<String> A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains.
If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.
If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node.
To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.
Example:
FAULT-DOMAIN-1
- Map<String>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- hostname String
The hostname for the DB system. The hostname must begin with an alphabetic character, and can contain alphanumeric characters and hyphens (-). The maximum length of the hostname is 16 characters for bare metal and virtual machine DB systems, and 12 characters for Exadata DB systems.
The maximum length of the combined hostname and domain is 63 characters.
Note: The hostname must be unique within the subnet. If it is not unique, the DB system will fail to provision.
- iorm
Config List<Property Map>Caches - The IORM settings of the Exadata DB system.
- 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
Maintenance StringRun Id - The OCID of the last maintenance run.
- last
Patch StringHistory Entry Id - The OCID of the last patch history. This value is updated as soon as a patch operation starts.
- license
Model String - (Updatable) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.
- lifecycle
Details String - Additional information about the current lifecycle state.
- listener
Port Number - The port number configured for the listener on the DB system.
- maintenance
Window Property MapDetails - (Updatable) The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
- maintenance
Windows List<Property Map> - The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
- memory
Size NumberIn Gbs - Memory allocated to the DB system, in gigabytes.
- next
Maintenance StringRun Id - The OCID of the next maintenance run.
- node
Count Number - The number of nodes to launch for a 2-node RAC virtual machine DB system. Specify either 1 or 2.
- nsg
Ids List<String> - (Updatable) The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:
- A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
- os
Version String - The most recent OS Patch Version applied on the DB system.
- point
In StringTime Data Disk Clone Timestamp - The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.
- private
Ip String - A private IP address of your choice. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. Supported for VM BM shape.
- reco
Storage NumberSize In Gb - The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.
- scan
Dns StringName - The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.
- scan
Dns StringRecord Id - The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.
- scan
Ip List<String>Ids - The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
- shape String
(Updatable) The shape of the DB system. The shape determines resources allocated to the DB system.
- For virtual machine shapes, the number of CPU cores and memory
- For bare metal and Exadata shapes, the number of CPU cores, memory, and storage
To get a list of shapes, use the ListDbSystemShapes operation.
- source String
- The source of the database: Use
NONE
for creating a new database. UseDB_BACKUP
for creating a new database by restoring from a backup. UseDATABASE
for creating a new database from an existing database, including archive redo log data. The default isNONE
. - source
Db StringSystem Id - The OCID of the DB system.
- sparse
Diskgroup Boolean - If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured. Only applied for Exadata shape.
- ssh
Public List<String>Keys - (Updatable) The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.
- state String
- The current state of the DB system.
- storage
Volume StringPerformance Mode - The block storage volume performance level. Valid values are
BALANCED
andHIGH_PERFORMANCE
. See Block Volume Performance for more information. - subnet
Id String The OCID of the subnet the DB system is associated with.
Subnet Restrictions:
- For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
- For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20.
These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.
- time
Created String - The date and time the DB system was created.
- time
Zone String The time zone to use for the DB system. For details, see DB System Time Zones.
** 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
- version String
- The Oracle Database version of the DB system.
- vip
Ids List<String> - The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
- zone
Id String - The OCID of the zone the DB system is associated with.
Supporting Types
DbSystemDataCollectionOptions, DbSystemDataCollectionOptionsArgs
- Is
Diagnostics boolEvents Enabled - (Updatable) Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the
UpdateVmCluster
orupdateCloudVmCluster
API. - Is
Health boolMonitoring Enabled - (Updatable) Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the
UpdateVmCluster
,UpdateCloudVmCluster
orupdateDbsystem
API. - Is
Incident boolLogs Enabled - (Updatable) Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the
UpdateVmCluster
,updateCloudVmCluster
orupdateDbsystem
API.
- Is
Diagnostics boolEvents Enabled - (Updatable) Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the
UpdateVmCluster
orupdateCloudVmCluster
API. - Is
Health boolMonitoring Enabled - (Updatable) Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the
UpdateVmCluster
,UpdateCloudVmCluster
orupdateDbsystem
API. - Is
Incident boolLogs Enabled - (Updatable) Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the
UpdateVmCluster
,updateCloudVmCluster
orupdateDbsystem
API.
- is
Diagnostics BooleanEvents Enabled - (Updatable) Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the
UpdateVmCluster
orupdateCloudVmCluster
API. - is
Health BooleanMonitoring Enabled - (Updatable) Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the
UpdateVmCluster
,UpdateCloudVmCluster
orupdateDbsystem
API. - is
Incident BooleanLogs Enabled - (Updatable) Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the
UpdateVmCluster
,updateCloudVmCluster
orupdateDbsystem
API.
- is
Diagnostics booleanEvents Enabled - (Updatable) Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the
UpdateVmCluster
orupdateCloudVmCluster
API. - is
Health booleanMonitoring Enabled - (Updatable) Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the
UpdateVmCluster
,UpdateCloudVmCluster
orupdateDbsystem
API. - is
Incident booleanLogs Enabled - (Updatable) Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the
UpdateVmCluster
,updateCloudVmCluster
orupdateDbsystem
API.
- is_
diagnostics_ boolevents_ enabled - (Updatable) Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the
UpdateVmCluster
orupdateCloudVmCluster
API. - is_
health_ boolmonitoring_ enabled - (Updatable) Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the
UpdateVmCluster
,UpdateCloudVmCluster
orupdateDbsystem
API. - is_
incident_ boollogs_ enabled - (Updatable) Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the
UpdateVmCluster
,updateCloudVmCluster
orupdateDbsystem
API.
- is
Diagnostics BooleanEvents Enabled - (Updatable) Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the
UpdateVmCluster
orupdateCloudVmCluster
API. - is
Health BooleanMonitoring Enabled - (Updatable) Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the
UpdateVmCluster
,UpdateCloudVmCluster
orupdateDbsystem
API. - is
Incident BooleanLogs Enabled - (Updatable) Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the
UpdateVmCluster
,updateCloudVmCluster
orupdateDbsystem
API.
DbSystemDbHome, DbSystemDbHomeArgs
- Database
Db
System Db Home Database (Updatable) Details for creating a database by restoring from a source database system.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- Create
Async bool - Database
Software stringImage Id - The database software image OCID of the image to be used to restore a database.
- Db
Home stringLocation - 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.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Display
Name string - The user-provided name of the Database Home.
- 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 OCID of the DB system.
- Last
Patch stringHistory Entry Id - The OCID of the last patch history. This value is updated as soon as a patch operation starts.
- Lifecycle
Details string - Additional information about the current lifecycle state.
- State string
- The current state of the DB system.
- Time
Created string - The date and time the DB system was created.
- Database
Db
System Db Home Database (Updatable) Details for creating a database by restoring from a source database system.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- Create
Async bool - Database
Software stringImage Id - The database software image OCID of the image to be used to restore a database.
- Db
Home stringLocation - 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.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Display
Name string - The user-provided name of the Database Home.
- 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 OCID of the DB system.
- Last
Patch stringHistory Entry Id - The OCID of the last patch history. This value is updated as soon as a patch operation starts.
- Lifecycle
Details string - Additional information about the current lifecycle state.
- State string
- The current state of the DB system.
- Time
Created string - The date and time the DB system was created.
- database
Db
System Db Home (Updatable) Details for creating a database by restoring from a source database system.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- create
Async Boolean - database
Software StringImage Id - The database software image OCID of the image to be used to restore a database.
- db
Home StringLocation - 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.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- display
Name String - The user-provided name of the Database Home.
- 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 OCID of the DB system.
- last
Patch StringHistory Entry Id - The OCID of the last patch history. This value is updated as soon as a patch operation starts.
- lifecycle
Details String - Additional information about the current lifecycle state.
- state String
- The current state of the DB system.
- time
Created String - The date and time the DB system was created.
- database
Db
System Db Home Database (Updatable) Details for creating a database by restoring from a source database system.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- create
Async boolean - database
Software stringImage Id - The database software image OCID of the image to be used to restore a database.
- db
Home stringLocation - db
Version string A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- display
Name string - The user-provided name of the Database Home.
- {[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 OCID of the DB system.
- last
Patch stringHistory Entry Id - The OCID of the last patch history. This value is updated as soon as a patch operation starts.
- lifecycle
Details string - Additional information about the current lifecycle state.
- state string
- The current state of the DB system.
- time
Created string - The date and time the DB system was created.
- database
database.
Db System Db Home Database (Updatable) Details for creating a database by restoring from a source database system.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- create_
async bool - database_
software_ strimage_ id - The database software image OCID of the image to be used to restore a database.
- db_
home_ strlocation - 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.
- Mapping[str, str]
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- display_
name str - The user-provided name of the Database Home.
- 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 OCID of the DB system.
- last_
patch_ strhistory_ entry_ id - The OCID of the last patch history. This value is updated as soon as a patch operation starts.
- lifecycle_
details str - Additional information about the current lifecycle state.
- state str
- The current state of the DB system.
- time_
created str - The date and time the DB system was created.
- database Property Map
(Updatable) Details for creating a database by restoring from a source database system.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- create
Async Boolean - database
Software StringImage Id - The database software image OCID of the image to be used to restore a database.
- db
Home StringLocation - 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.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- display
Name String - The user-provided name of the Database Home.
- 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 OCID of the DB system.
- last
Patch StringHistory Entry Id - The OCID of the last patch history. This value is updated as soon as a patch operation starts.
- lifecycle
Details String - Additional information about the current lifecycle state.
- state String
- The current state of the DB system.
- time
Created String - The date and time the DB system was created.
DbSystemDbHomeDatabase, DbSystemDbHomeDatabaseArgs
- Admin
Password string - A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.
- Backup
Id string - The backup OCID.
- Backup
Tde stringPassword - The password to open the TDE wallet.
- Character
Set string The character set for the database. The default is AL32UTF8. Allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- Connection
Strings List<DbSystem Db Home Database Connection String> - Database
Id string - The database OCID.
- Database
Software stringImage Id - The database software image OCID
- Db
Backup DbConfig System Db Home Database Db Backup Config - (Updatable) Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
- Db
Domain string - The database domain. In a distributed database system, DB_DOMAIN specifies the logical location of the database within the network structure.
- Db
Name string - The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
- Db
Unique stringName - The
DB_UNIQUE_NAME
of the Oracle Database. - Db
Workload string Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
The database workload type.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Dictionary<string, string>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- Id string
- The OCID of the DB system.
- 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.
- Lifecycle
Details string - Additional information about the current lifecycle state.
- Ncharacter
Set string - The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- Pdb
Name string - The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
- Pluggable
Databases List<string> - The list of pluggable databases that needs to be restored into new database.
- State string
- The current state of the DB system.
- Tde
Wallet stringPassword - The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, #, or -.
- Time
Created string - The date and time the DB system was created.
- Time
Stamp stringFor Point In Time Recovery - The point in time of the original database from which the new database is created. If not specifed, the latest backup is used to create the database.
- Vault
Id string - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys.
- Admin
Password string - A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.
- Backup
Id string - The backup OCID.
- Backup
Tde stringPassword - The password to open the TDE wallet.
- Character
Set string The character set for the database. The default is AL32UTF8. Allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- Connection
Strings []DbSystem Db Home Database Connection String - Database
Id string - The database OCID.
- Database
Software stringImage Id - The database software image OCID
- Db
Backup DbConfig System Db Home Database Db Backup Config - (Updatable) Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
- Db
Domain string - The database domain. In a distributed database system, DB_DOMAIN specifies the logical location of the database within the network structure.
- Db
Name string - The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
- Db
Unique stringName - The
DB_UNIQUE_NAME
of the Oracle Database. - Db
Workload string Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
The database workload type.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- map[string]string
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- Id string
- The OCID of the DB system.
- 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.
- Lifecycle
Details string - Additional information about the current lifecycle state.
- Ncharacter
Set string - The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- Pdb
Name string - The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
- Pluggable
Databases []string - The list of pluggable databases that needs to be restored into new database.
- State string
- The current state of the DB system.
- Tde
Wallet stringPassword - The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, #, or -.
- Time
Created string - The date and time the DB system was created.
- Time
Stamp stringFor Point In Time Recovery - The point in time of the original database from which the new database is created. If not specifed, the latest backup is used to create the database.
- Vault
Id string - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys.
- admin
Password String - A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.
- backup
Id String - The backup OCID.
- backup
Tde StringPassword - The password to open the TDE wallet.
- character
Set String The character set for the database. The default is AL32UTF8. Allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- connection
Strings List<DbSystem Db Home Connection String> - database
Id String - The database OCID.
- database
Software StringImage Id - The database software image OCID
- db
Backup DbConfig System Db Home Db Backup Config - (Updatable) Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
- db
Domain String - The database domain. In a distributed database system, DB_DOMAIN specifies the logical location of the database within the network structure.
- db
Name String - The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
- db
Unique StringName - The
DB_UNIQUE_NAME
of the Oracle Database. - db
Workload String Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
The database workload type.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Map<String,String>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- id String
- The OCID of the DB system.
- 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.
- lifecycle
Details String - Additional information about the current lifecycle state.
- ncharacter
Set String - The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- pdb
Name String - The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
- pluggable
Databases List<String> - The list of pluggable databases that needs to be restored into new database.
- state String
- The current state of the DB system.
- tde
Wallet StringPassword - The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, #, or -.
- time
Created String - The date and time the DB system was created.
- time
Stamp StringFor Point In Time Recovery - The point in time of the original database from which the new database is created. If not specifed, the latest backup is used to create the database.
- vault
Id String - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys.
- admin
Password string - A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.
- backup
Id string - The backup OCID.
- backup
Tde stringPassword - The password to open the TDE wallet.
- character
Set string The character set for the database. The default is AL32UTF8. Allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- connection
Strings DbSystem Db Home Database Connection String[] - database
Id string - The database OCID.
- database
Software stringImage Id - The database software image OCID
- db
Backup DbConfig System Db Home Database Db Backup Config - (Updatable) Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
- db
Domain string - The database domain. In a distributed database system, DB_DOMAIN specifies the logical location of the database within the network structure.
- db
Name string - The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
- db
Unique stringName - The
DB_UNIQUE_NAME
of the Oracle Database. - db
Workload string Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
The database workload type.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- {[key: string]: string}
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- id string
- The OCID of the DB system.
- 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.
- lifecycle
Details string - Additional information about the current lifecycle state.
- ncharacter
Set string - The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- pdb
Name string - The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
- pluggable
Databases string[] - The list of pluggable databases that needs to be restored into new database.
- state string
- The current state of the DB system.
- tde
Wallet stringPassword - The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, #, or -.
- time
Created string - The date and time the DB system was created.
- time
Stamp stringFor Point In Time Recovery - The point in time of the original database from which the new database is created. If not specifed, the latest backup is used to create the database.
- vault
Id string - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys.
- admin_
password str - A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.
- backup_
id str - The backup OCID.
- backup_
tde_ strpassword - The password to open the TDE wallet.
- character_
set str The character set for the database. The default is AL32UTF8. Allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- connection_
strings Sequence[database.Db System Db Home Database Connection String] - database_
id str - The database OCID.
- database_
software_ strimage_ id - The database software image OCID
- db_
backup_ database.config Db System Db Home Database Db Backup Config - (Updatable) Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
- db_
domain str - The database domain. In a distributed database system, DB_DOMAIN specifies the logical location of the database within the network structure.
- db_
name str - The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
- db_
unique_ strname - The
DB_UNIQUE_NAME
of the Oracle Database. - db_
workload str Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
The database workload type.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Mapping[str, str]
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- id str
- The OCID of the DB system.
- 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.
- lifecycle_
details str - Additional information about the current lifecycle state.
- ncharacter_
set str - The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- pdb_
name str - The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
- pluggable_
databases Sequence[str] - The list of pluggable databases that needs to be restored into new database.
- state str
- The current state of the DB system.
- tde_
wallet_ strpassword - The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, #, or -.
- time_
created str - The date and time the DB system was created.
- time_
stamp_ strfor_ point_ in_ time_ recovery - The point in time of the original database from which the new database is created. If not specifed, the latest backup is used to create the database.
- vault_
id str - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys.
- admin
Password String - A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.
- backup
Id String - The backup OCID.
- backup
Tde StringPassword - The password to open the TDE wallet.
- character
Set String The character set for the database. The default is AL32UTF8. Allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- connection
Strings List<Property Map> - database
Id String - The database OCID.
- database
Software StringImage Id - The database software image OCID
- db
Backup Property MapConfig - (Updatable) Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
- db
Domain String - The database domain. In a distributed database system, DB_DOMAIN specifies the logical location of the database within the network structure.
- db
Name String - The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
- db
Unique StringName - The
DB_UNIQUE_NAME
of the Oracle Database. - db
Workload String Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
The database workload type.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Map<String>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- id String
- The OCID of the DB system.
- 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.
- lifecycle
Details String - Additional information about the current lifecycle state.
- ncharacter
Set String - The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- pdb
Name String - The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
- pluggable
Databases List<String> - The list of pluggable databases that needs to be restored into new database.
- state String
- The current state of the DB system.
- tde
Wallet StringPassword - The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, #, or -.
- time
Created String - The date and time the DB system was created.
- time
Stamp StringFor Point In Time Recovery - The point in time of the original database from which the new database is created. If not specifed, the latest backup is used to create the database.
- vault
Id String - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
secretId
are required for Customer Managed Keys.
DbSystemDbHomeDatabaseConnectionString, DbSystemDbHomeDatabaseConnectionStringArgs
- All
Connection Dictionary<string, string>Strings - Cdb
Default string - Cdb
Ip stringDefault
- All
Connection map[string]stringStrings - Cdb
Default string - Cdb
Ip stringDefault
- all
Connection Map<String,String>Strings - cdb
Default String - cdb
Ip StringDefault
- all
Connection {[key: string]: string}Strings - cdb
Default string - cdb
Ip stringDefault
- all_
connection_ Mapping[str, str]strings - cdb_
default str - cdb_
ip_ strdefault
- all
Connection Map<String>Strings - cdb
Default String - cdb
Ip StringDefault
DbSystemDbHomeDatabaseDbBackupConfig, DbSystemDbHomeDatabaseDbBackupConfigArgs
- Auto
Backup boolEnabled - (Updatable) If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
- Auto
Backup stringWindow - (Updatable) Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example:
SLOT_TWO
- Auto
Full stringBackup Day - Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
- Auto
Full stringBackup Window - Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example:
SLOT_TWO
- Backup
Deletion stringPolicy - This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
- Backup
Destination List<DbDetails System Db Home Database Db Backup Config Backup Destination Detail> - (Updatable) Backup destination details.
- Recovery
Window intIn Days - (Updatable) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
- Run
Immediate boolFull Backup - If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
- Auto
Backup boolEnabled - (Updatable) If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
- Auto
Backup stringWindow - (Updatable) Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example:
SLOT_TWO
- Auto
Full stringBackup Day - Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
- Auto
Full stringBackup Window - Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example:
SLOT_TWO
- Backup
Deletion stringPolicy - This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
- Backup
Destination []DbDetails System Db Home Database Db Backup Config Backup Destination Detail - (Updatable) Backup destination details.
- Recovery
Window intIn Days - (Updatable) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
- Run
Immediate boolFull Backup - If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
- auto
Backup BooleanEnabled - (Updatable) If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
- auto
Backup StringWindow - (Updatable) Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example:
SLOT_TWO
- auto
Full StringBackup Day - Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
- auto
Full StringBackup Window - Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example:
SLOT_TWO
- backup
Deletion StringPolicy - This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
- backup
Destination List<DbDetails System Db Home Db Backup Config Backup Destination Detail> - (Updatable) Backup destination details.
- recovery
Window IntegerIn Days - (Updatable) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
- run
Immediate BooleanFull Backup - If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
- auto
Backup booleanEnabled - (Updatable) If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
- auto
Backup stringWindow - (Updatable) Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example:
SLOT_TWO
- auto
Full stringBackup Day - Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
- auto
Full stringBackup Window - Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example:
SLOT_TWO
- backup
Deletion stringPolicy - This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
- backup
Destination DbDetails System Db Home Database Db Backup Config Backup Destination Detail[] - (Updatable) Backup destination details.
- recovery
Window numberIn Days - (Updatable) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
- run
Immediate booleanFull Backup - If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
- auto_
backup_ boolenabled - (Updatable) If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
- auto_
backup_ strwindow - (Updatable) Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example:
SLOT_TWO
- auto_
full_ strbackup_ day - Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
- auto_
full_ strbackup_ window - Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example:
SLOT_TWO
- backup_
deletion_ strpolicy - This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
- backup_
destination_ Sequence[database.details Db System Db Home Database Db Backup Config Backup Destination Detail] - (Updatable) Backup destination details.
- recovery_
window_ intin_ days - (Updatable) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
- run_
immediate_ boolfull_ backup - If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
- auto
Backup BooleanEnabled - (Updatable) If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
- auto
Backup StringWindow - (Updatable) Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example:
SLOT_TWO
- auto
Full StringBackup Day - Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
- auto
Full StringBackup Window - Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example:
SLOT_TWO
- backup
Deletion StringPolicy - This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
- backup
Destination List<Property Map>Details - (Updatable) Backup destination details.
- recovery
Window NumberIn Days - (Updatable) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
- run
Immediate BooleanFull Backup - If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
DbSystemDbHomeDatabaseDbBackupConfigBackupDestinationDetail, DbSystemDbHomeDatabaseDbBackupConfigBackupDestinationDetailArgs
- Dbrs
Policy stringId - The OCID of the DBRS policy used for backup.
- Id string
- The OCID of the backup destination.
- Type string
- Type of the database backup destination.
- Dbrs
Policy stringId - The OCID of the DBRS policy used for backup.
- Id string
- The OCID of the backup destination.
- Type string
- Type of the database backup destination.
- dbrs
Policy StringId - The OCID of the DBRS policy used for backup.
- id String
- The OCID of the backup destination.
- type String
- Type of the database backup destination.
- dbrs
Policy stringId - The OCID of the DBRS policy used for backup.
- id string
- The OCID of the backup destination.
- type string
- Type of the database backup destination.
- dbrs_
policy_ strid - The OCID of the DBRS policy used for backup.
- id str
- The OCID of the backup destination.
- type str
- Type of the database backup destination.
- dbrs
Policy StringId - The OCID of the DBRS policy used for backup.
- id String
- The OCID of the backup destination.
- type String
- Type of the database backup destination.
DbSystemDbSystemOptions, DbSystemDbSystemOptionsArgs
- Storage
Management string - The storage option used in DB system. ASM - Automatic storage management LVM - Logical Volume management
- Storage
Management string - The storage option used in DB system. ASM - Automatic storage management LVM - Logical Volume management
- storage
Management String - The storage option used in DB system. ASM - Automatic storage management LVM - Logical Volume management
- storage
Management string - The storage option used in DB system. ASM - Automatic storage management LVM - Logical Volume management
- storage_
management str - The storage option used in DB system. ASM - Automatic storage management LVM - Logical Volume management
- storage
Management String - The storage option used in DB system. ASM - Automatic storage management LVM - Logical Volume management
DbSystemIormConfigCach, DbSystemIormConfigCachArgs
- Db
Plans List<DbSystem Iorm Config Cach Db Plan> - An array of IORM settings for all the database in the Exadata DB system.
- Db
System stringId - Lifecycle
Details string - Additional information about the current lifecycle state.
- Objective string
- The current value for the IORM objective. The default is
AUTO
. - State string
- The current state of the DB system.
- Db
Plans []DbSystem Iorm Config Cach Db Plan - An array of IORM settings for all the database in the Exadata DB system.
- Db
System stringId - Lifecycle
Details string - Additional information about the current lifecycle state.
- Objective string
- The current value for the IORM objective. The default is
AUTO
. - State string
- The current state of the DB system.
- db
Plans List<DbSystem Iorm Config Cach Db Plan> - An array of IORM settings for all the database in the Exadata DB system.
- db
System StringId - lifecycle
Details String - Additional information about the current lifecycle state.
- objective String
- The current value for the IORM objective. The default is
AUTO
. - state String
- The current state of the DB system.
- db
Plans DbSystem Iorm Config Cach Db Plan[] - An array of IORM settings for all the database in the Exadata DB system.
- db
System stringId - lifecycle
Details string - Additional information about the current lifecycle state.
- objective string
- The current value for the IORM objective. The default is
AUTO
. - state string
- The current state of the DB system.
- db_
plans Sequence[database.Db System Iorm Config Cach Db Plan] - An array of IORM settings for all the database in the Exadata DB system.
- db_
system_ strid - lifecycle_
details str - Additional information about the current lifecycle state.
- objective str
- The current value for the IORM objective. The default is
AUTO
. - state str
- The current state of the DB system.
- db
Plans List<Property Map> - An array of IORM settings for all the database in the Exadata DB system.
- db
System StringId - lifecycle
Details String - Additional information about the current lifecycle state.
- objective String
- The current value for the IORM objective. The default is
AUTO
. - state String
- The current state of the DB system.
DbSystemIormConfigCachDbPlan, DbSystemIormConfigCachDbPlanArgs
- Db
Name string - The database name. For the default
DbPlan
, thedbName
isdefault
. - Flash
Cache stringLimit - The flash cache limit for this database. This value is internally configured based on the share value assigned to the database.
- int
- The relative priority of this database.
- Db
Name string - The database name. For the default
DbPlan
, thedbName
isdefault
. - Flash
Cache stringLimit - The flash cache limit for this database. This value is internally configured based on the share value assigned to the database.
- int
- The relative priority of this database.
- db
Name String - The database name. For the default
DbPlan
, thedbName
isdefault
. - flash
Cache StringLimit - The flash cache limit for this database. This value is internally configured based on the share value assigned to the database.
- Integer
- The relative priority of this database.
- db
Name string - The database name. For the default
DbPlan
, thedbName
isdefault
. - flash
Cache stringLimit - The flash cache limit for this database. This value is internally configured based on the share value assigned to the database.
- number
- The relative priority of this database.
- db_
name str - The database name. For the default
DbPlan
, thedbName
isdefault
. - flash_
cache_ strlimit - The flash cache limit for this database. This value is internally configured based on the share value assigned to the database.
- int
- The relative priority of this database.
- db
Name String - The database name. For the default
DbPlan
, thedbName
isdefault
. - flash
Cache StringLimit - The flash cache limit for this database. This value is internally configured based on the share value assigned to the database.
- Number
- The relative priority of this database.
DbSystemMaintenanceWindow, DbSystemMaintenanceWindowArgs
- Custom
Action intTimeout In Mins - Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).
- Days
Of List<DbWeeks System Maintenance Window Days Of Week> - Days during the week when maintenance should be performed.
- Hours
Of List<int>Days - The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are
- 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC
- Is
Custom boolAction Timeout Enabled - If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.
- Is
Monthly boolPatching Enabled - If true, enables the monthly patching option.
- Lead
Time intIn Weeks - Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.
- Months
List<Db
System Maintenance Window Month> - Months during the year when maintenance should be performed.
- Patching
Mode string - Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.
- Preference string
- The maintenance window scheduling preference.
- Skip
Rus List<bool> - If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter.
- Weeks
Of List<int>Months - Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.
- Custom
Action intTimeout In Mins - Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).
- Days
Of []DbWeeks System Maintenance Window Days Of Week - Days during the week when maintenance should be performed.
- Hours
Of []intDays - The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are
- 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC
- Is
Custom boolAction Timeout Enabled - If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.
- Is
Monthly boolPatching Enabled - If true, enables the monthly patching option.
- Lead
Time intIn Weeks - Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.
- Months
[]Db
System Maintenance Window Month - Months during the year when maintenance should be performed.
- Patching
Mode string - Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.
- Preference string
- The maintenance window scheduling preference.
- Skip
Rus []bool - If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter.
- Weeks
Of []intMonths - Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.
- custom
Action IntegerTimeout In Mins - Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).
- days
Of List<DbWeeks System Maintenance Window Days Of Week> - Days during the week when maintenance should be performed.
- hours
Of List<Integer>Days - The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are
- 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC
- is
Custom BooleanAction Timeout Enabled - If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.
- is
Monthly BooleanPatching Enabled - If true, enables the monthly patching option.
- lead
Time IntegerIn Weeks - Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.
- months
List<Db
System Maintenance Window Month> - Months during the year when maintenance should be performed.
- patching
Mode String - Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.
- preference String
- The maintenance window scheduling preference.
- skip
Rus List<Boolean> - If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter.
- weeks
Of List<Integer>Months - Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.
- custom
Action numberTimeout In Mins - Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).
- days
Of DbWeeks System Maintenance Window Days Of Week[] - Days during the week when maintenance should be performed.
- hours
Of number[]Days - The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are
- 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC
- is
Custom booleanAction Timeout Enabled - If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.
- is
Monthly booleanPatching Enabled - If true, enables the monthly patching option.
- lead
Time numberIn Weeks - Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.
- months
Db
System Maintenance Window Month[] - Months during the year when maintenance should be performed.
- patching
Mode string - Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.
- preference string
- The maintenance window scheduling preference.
- skip
Rus boolean[] - If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter.
- weeks
Of number[]Months - Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.
- custom_
action_ inttimeout_ in_ mins - Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).
- days_
of_ Sequence[database.weeks Db System Maintenance Window Days Of Week] - Days during the week when maintenance should be performed.
- hours_
of_ Sequence[int]days - The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are
- 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC
- is_
custom_ boolaction_ timeout_ enabled - If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.
- is_
monthly_ boolpatching_ enabled - If true, enables the monthly patching option.
- lead_
time_ intin_ weeks - Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.
- months
Sequence[database.
Db System Maintenance Window Month] - Months during the year when maintenance should be performed.
- patching_
mode str - Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.
- preference str
- The maintenance window scheduling preference.
- skip_
rus Sequence[bool] - If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter.
- weeks_
of_ Sequence[int]months - Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.
- custom
Action NumberTimeout In Mins - Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).
- days
Of List<Property Map>Weeks - Days during the week when maintenance should be performed.
- hours
Of List<Number>Days - The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are
- 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC
- is
Custom BooleanAction Timeout Enabled - If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.
- is
Monthly BooleanPatching Enabled - If true, enables the monthly patching option.
- lead
Time NumberIn Weeks - Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.
- months List<Property Map>
- Months during the year when maintenance should be performed.
- patching
Mode String - Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.
- preference String
- The maintenance window scheduling preference.
- skip
Rus List<Boolean> - If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter.
- weeks
Of List<Number>Months - Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.
DbSystemMaintenanceWindowDaysOfWeek, DbSystemMaintenanceWindowDaysOfWeekArgs
- Name string
- Name of the month of the year.
- Name string
- Name of the month of the year.
- name String
- Name of the month of the year.
- name string
- Name of the month of the year.
- name str
- Name of the month of the year.
- name String
- Name of the month of the year.
DbSystemMaintenanceWindowDetails, DbSystemMaintenanceWindowDetailsArgs
- Custom
Action intTimeout In Mins - (Updatable) Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).
- Days
Of List<DbWeeks System Maintenance Window Details Days Of Week> - (Updatable) Days during the week when maintenance should be performed.
- Hours
Of List<int>Days - (Updatable) The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are
- 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC
- Is
Custom boolAction Timeout Enabled - (Updatable) If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.
- Is
Monthly boolPatching Enabled - (Updatable) If true, enables the monthly patching option.
- Lead
Time intIn Weeks - (Updatable) Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.
- Months
List<Db
System Maintenance Window Details Month> - (Updatable) Months during the year when maintenance should be performed.
- Patching
Mode string (Updatable) Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.
IMPORTANT: Non-rolling infrastructure patching involves system down time. See Oracle-Managed Infrastructure Maintenance Updates for more information.
- Preference string
- (Updatable) The maintenance window scheduling preference.
- Skip
Rus List<bool> - (Updatable) If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter.
- Weeks
Of List<int>Months - (Updatable) Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.
- Custom
Action intTimeout In Mins - (Updatable) Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).
- Days
Of []DbWeeks System Maintenance Window Details Days Of Week - (Updatable) Days during the week when maintenance should be performed.
- Hours
Of []intDays - (Updatable) The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are
- 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC
- Is
Custom boolAction Timeout Enabled - (Updatable) If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.
- Is
Monthly boolPatching Enabled - (Updatable) If true, enables the monthly patching option.
- Lead
Time intIn Weeks - (Updatable) Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.
- Months
[]Db
System Maintenance Window Details Month - (Updatable) Months during the year when maintenance should be performed.
- Patching
Mode string (Updatable) Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.
IMPORTANT: Non-rolling infrastructure patching involves system down time. See Oracle-Managed Infrastructure Maintenance Updates for more information.
- Preference string
- (Updatable) The maintenance window scheduling preference.
- Skip
Rus []bool - (Updatable) If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter.
- Weeks
Of []intMonths - (Updatable) Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.
- custom
Action IntegerTimeout In Mins - (Updatable) Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).
- days
Of List<DbWeeks System Maintenance Window Details Days Of Week> - (Updatable) Days during the week when maintenance should be performed.
- hours
Of List<Integer>Days - (Updatable) The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are
- 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC
- is
Custom BooleanAction Timeout Enabled - (Updatable) If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.
- is
Monthly BooleanPatching Enabled - (Updatable) If true, enables the monthly patching option.
- lead
Time IntegerIn Weeks - (Updatable) Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.
- months
List<Db
System Maintenance Window Details Month> - (Updatable) Months during the year when maintenance should be performed.
- patching
Mode String (Updatable) Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.
IMPORTANT: Non-rolling infrastructure patching involves system down time. See Oracle-Managed Infrastructure Maintenance Updates for more information.
- preference String
- (Updatable) The maintenance window scheduling preference.
- skip
Rus List<Boolean> - (Updatable) If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter.
- weeks
Of List<Integer>Months - (Updatable) Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.
- custom
Action numberTimeout In Mins - (Updatable) Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).
- days
Of DbWeeks System Maintenance Window Details Days Of Week[] - (Updatable) Days during the week when maintenance should be performed.
- hours
Of number[]Days - (Updatable) The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are
- 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC
- is
Custom booleanAction Timeout Enabled - (Updatable) If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.
- is
Monthly booleanPatching Enabled - (Updatable) If true, enables the monthly patching option.
- lead
Time numberIn Weeks - (Updatable) Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.
- months
Db
System Maintenance Window Details Month[] - (Updatable) Months during the year when maintenance should be performed.
- patching
Mode string (Updatable) Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.
IMPORTANT: Non-rolling infrastructure patching involves system down time. See Oracle-Managed Infrastructure Maintenance Updates for more information.
- preference string
- (Updatable) The maintenance window scheduling preference.
- skip
Rus boolean[] - (Updatable) If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter.
- weeks
Of number[]Months - (Updatable) Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.
- custom_
action_ inttimeout_ in_ mins - (Updatable) Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).
- days_
of_ Sequence[database.weeks Db System Maintenance Window Details Days Of Week] - (Updatable) Days during the week when maintenance should be performed.
- hours_
of_ Sequence[int]days - (Updatable) The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are
- 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC
- is_
custom_ boolaction_ timeout_ enabled - (Updatable) If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.
- is_
monthly_ boolpatching_ enabled - (Updatable) If true, enables the monthly patching option.
- lead_
time_ intin_ weeks - (Updatable) Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.
- months
Sequence[database.
Db System Maintenance Window Details Month] - (Updatable) Months during the year when maintenance should be performed.
- patching_
mode str (Updatable) Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.
IMPORTANT: Non-rolling infrastructure patching involves system down time. See Oracle-Managed Infrastructure Maintenance Updates for more information.
- preference str
- (Updatable) The maintenance window scheduling preference.
- skip_
rus Sequence[bool] - (Updatable) If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter.
- weeks_
of_ Sequence[int]months - (Updatable) Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.
- custom
Action NumberTimeout In Mins - (Updatable) Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).
- days
Of List<Property Map>Weeks - (Updatable) Days during the week when maintenance should be performed.
- hours
Of List<Number>Days - (Updatable) The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are
- 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC
- is
Custom BooleanAction Timeout Enabled - (Updatable) If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.
- is
Monthly BooleanPatching Enabled - (Updatable) If true, enables the monthly patching option.
- lead
Time NumberIn Weeks - (Updatable) Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.
- months List<Property Map>
- (Updatable) Months during the year when maintenance should be performed.
- patching
Mode String (Updatable) Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.
IMPORTANT: Non-rolling infrastructure patching involves system down time. See Oracle-Managed Infrastructure Maintenance Updates for more information.
- preference String
- (Updatable) The maintenance window scheduling preference.
- skip
Rus List<Boolean> - (Updatable) If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter.
- weeks
Of List<Number>Months - (Updatable) Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.
DbSystemMaintenanceWindowDetailsDaysOfWeek, DbSystemMaintenanceWindowDetailsDaysOfWeekArgs
- Name string
- (Updatable) Name of the day of the week.
- Name string
- (Updatable) Name of the day of the week.
- name String
- (Updatable) Name of the day of the week.
- name string
- (Updatable) Name of the day of the week.
- name str
- (Updatable) Name of the day of the week.
- name String
- (Updatable) Name of the day of the week.
DbSystemMaintenanceWindowDetailsMonth, DbSystemMaintenanceWindowDetailsMonthArgs
- Name string
- (Updatable) Name of the month of the year.
- Name string
- (Updatable) Name of the month of the year.
- name String
- (Updatable) Name of the month of the year.
- name string
- (Updatable) Name of the month of the year.
- name str
- (Updatable) Name of the month of the year.
- name String
- (Updatable) Name of the month of the year.
DbSystemMaintenanceWindowMonth, DbSystemMaintenanceWindowMonthArgs
- Name string
- Name of the month of the year.
- Name string
- Name of the month of the year.
- name String
- Name of the month of the year.
- name string
- Name of the month of the year.
- name str
- Name of the month of the year.
- name String
- Name of the month of the year.
Import
DbSystems can be imported using the id
, e.g.
$ pulumi import oci:Database/dbSystem:DbSystem test_db_system "id"
Import is only supported for source=NONE
db_home.0.database.0.admin_password
is not returned by the service for security reasons. To avoid a force new of the db_home on the next apply, add the following to the resource:
lifecycle {
ignore_changes = ["db_home.0.database.0.admin_password"]
}
You may also need to add hostname
to the ignore_changes list if you see a diff on a subsequent apply
If the oci_database_db_system being imported is missing a primary db_home, an empty placeholder for db_home
will be set in the Terraform state.
To keep configurations consistent with the imported state, add an empty placeholder for db_home
to your configuration like this:
Add this placeholder into your oci_database_db_system configuration to indicate that the primary db home is empty.
db_home {
database {
admin_password = ""
}
}
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.