UpdateAutonomousDatabaseDetails

class oci.database.models.UpdateAutonomousDatabaseDetails(**kwargs)

Bases: object

Details to update an Oracle Autonomous Database.

Notes - To specify OCPU core count, you must use either ocpuCount or cpuCoreCount. You cannot use both parameters at the same time. For Autonomous Database Serverless instances, ocpuCount is not used. - To specify a storage allocation, you must use either dataStorageSizeInGBs or dataStorageSizeInTBs. - See the individual parameter discriptions for more information on the OCPU and storage value parameters. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Attributes

COMPUTE_MODEL_ECPU A constant which can be used with the compute_model property of a UpdateAutonomousDatabaseDetails.
COMPUTE_MODEL_OCPU A constant which can be used with the compute_model property of a UpdateAutonomousDatabaseDetails.
DB_WORKLOAD_AJD A constant which can be used with the db_workload property of a UpdateAutonomousDatabaseDetails.
DB_WORKLOAD_APEX A constant which can be used with the db_workload property of a UpdateAutonomousDatabaseDetails.
DB_WORKLOAD_DW A constant which can be used with the db_workload property of a UpdateAutonomousDatabaseDetails.
DB_WORKLOAD_OLTP A constant which can be used with the db_workload property of a UpdateAutonomousDatabaseDetails.
LICENSE_MODEL_BRING_YOUR_OWN_LICENSE A constant which can be used with the license_model property of a UpdateAutonomousDatabaseDetails.
LICENSE_MODEL_LICENSE_INCLUDED A constant which can be used with the license_model property of a UpdateAutonomousDatabaseDetails.
OPEN_MODE_READ_ONLY A constant which can be used with the open_mode property of a UpdateAutonomousDatabaseDetails.
OPEN_MODE_READ_WRITE A constant which can be used with the open_mode property of a UpdateAutonomousDatabaseDetails.
PERMISSION_LEVEL_RESTRICTED A constant which can be used with the permission_level property of a UpdateAutonomousDatabaseDetails.
PERMISSION_LEVEL_UNRESTRICTED A constant which can be used with the permission_level property of a UpdateAutonomousDatabaseDetails.
REFRESHABLE_MODE_AUTOMATIC A constant which can be used with the refreshable_mode property of a UpdateAutonomousDatabaseDetails.
REFRESHABLE_MODE_MANUAL A constant which can be used with the refreshable_mode property of a UpdateAutonomousDatabaseDetails.
admin_password Gets the admin_password of this UpdateAutonomousDatabaseDetails.
are_primary_whitelisted_ips_used Gets the are_primary_whitelisted_ips_used of this UpdateAutonomousDatabaseDetails.
auto_refresh_frequency_in_seconds Gets the auto_refresh_frequency_in_seconds of this UpdateAutonomousDatabaseDetails.
auto_refresh_point_lag_in_seconds Gets the auto_refresh_point_lag_in_seconds of this UpdateAutonomousDatabaseDetails.
backup_retention_period_in_days Gets the backup_retention_period_in_days of this UpdateAutonomousDatabaseDetails.
compute_count Gets the compute_count of this UpdateAutonomousDatabaseDetails.
compute_model Gets the compute_model of this UpdateAutonomousDatabaseDetails.
cpu_core_count Gets the cpu_core_count of this UpdateAutonomousDatabaseDetails.
customer_contacts Gets the customer_contacts of this UpdateAutonomousDatabaseDetails.
data_storage_size_in_gbs Gets the data_storage_size_in_gbs of this UpdateAutonomousDatabaseDetails.
data_storage_size_in_tbs Gets the data_storage_size_in_tbs of this UpdateAutonomousDatabaseDetails.
database_edition Gets the database_edition of this UpdateAutonomousDatabaseDetails.
db_name Gets the db_name of this UpdateAutonomousDatabaseDetails.
db_tools_details Gets the db_tools_details of this UpdateAutonomousDatabaseDetails.
db_version Gets the db_version of this UpdateAutonomousDatabaseDetails.
db_workload Gets the db_workload of this UpdateAutonomousDatabaseDetails.
defined_tags Gets the defined_tags of this UpdateAutonomousDatabaseDetails.
display_name Gets the display_name of this UpdateAutonomousDatabaseDetails.
freeform_tags Gets the freeform_tags of this UpdateAutonomousDatabaseDetails.
in_memory_percentage Gets the in_memory_percentage of this UpdateAutonomousDatabaseDetails.
is_access_control_enabled Gets the is_access_control_enabled of this UpdateAutonomousDatabaseDetails.
is_auto_scaling_enabled Gets the is_auto_scaling_enabled of this UpdateAutonomousDatabaseDetails.
is_auto_scaling_for_storage_enabled Gets the is_auto_scaling_for_storage_enabled of this UpdateAutonomousDatabaseDetails.
is_data_guard_enabled Gets the is_data_guard_enabled of this UpdateAutonomousDatabaseDetails.
is_dev_tier Gets the is_dev_tier of this UpdateAutonomousDatabaseDetails.
is_free_tier Gets the is_free_tier of this UpdateAutonomousDatabaseDetails.
is_local_data_guard_enabled Gets the is_local_data_guard_enabled of this UpdateAutonomousDatabaseDetails.
is_mtls_connection_required Gets the is_mtls_connection_required of this UpdateAutonomousDatabaseDetails.
is_refreshable_clone Gets the is_refreshable_clone of this UpdateAutonomousDatabaseDetails.
license_model Gets the license_model of this UpdateAutonomousDatabaseDetails.
local_adg_auto_failover_max_data_loss_limit Gets the local_adg_auto_failover_max_data_loss_limit of this UpdateAutonomousDatabaseDetails.
long_term_backup_schedule Gets the long_term_backup_schedule of this UpdateAutonomousDatabaseDetails.
nsg_ids Gets the nsg_ids of this UpdateAutonomousDatabaseDetails.
ocpu_count Gets the ocpu_count of this UpdateAutonomousDatabaseDetails.
open_mode Gets the open_mode of this UpdateAutonomousDatabaseDetails.
peer_db_id Gets the peer_db_id of this UpdateAutonomousDatabaseDetails.
permission_level Gets the permission_level of this UpdateAutonomousDatabaseDetails.
private_endpoint_ip Gets the private_endpoint_ip of this UpdateAutonomousDatabaseDetails.
private_endpoint_label Gets the private_endpoint_label of this UpdateAutonomousDatabaseDetails.
refreshable_mode Gets the refreshable_mode of this UpdateAutonomousDatabaseDetails.
resource_pool_leader_id Gets the resource_pool_leader_id of this UpdateAutonomousDatabaseDetails.
resource_pool_summary Gets the resource_pool_summary of this UpdateAutonomousDatabaseDetails.
scheduled_operations Gets the scheduled_operations of this UpdateAutonomousDatabaseDetails.
secret_id Gets the secret_id of this UpdateAutonomousDatabaseDetails.
secret_version_number Gets the secret_version_number of this UpdateAutonomousDatabaseDetails.
standby_whitelisted_ips Gets the standby_whitelisted_ips of this UpdateAutonomousDatabaseDetails.
subnet_id Gets the subnet_id of this UpdateAutonomousDatabaseDetails.
time_of_auto_refresh_start Gets the time_of_auto_refresh_start of this UpdateAutonomousDatabaseDetails.
whitelisted_ips Gets the whitelisted_ips of this UpdateAutonomousDatabaseDetails.

Methods

__init__(**kwargs) Initializes a new UpdateAutonomousDatabaseDetails object with values from keyword arguments.
COMPUTE_MODEL_ECPU = 'ECPU'

A constant which can be used with the compute_model property of a UpdateAutonomousDatabaseDetails. This constant has a value of “ECPU”

COMPUTE_MODEL_OCPU = 'OCPU'

A constant which can be used with the compute_model property of a UpdateAutonomousDatabaseDetails. This constant has a value of “OCPU”

DB_WORKLOAD_AJD = 'AJD'

A constant which can be used with the db_workload property of a UpdateAutonomousDatabaseDetails. This constant has a value of “AJD”

DB_WORKLOAD_APEX = 'APEX'

A constant which can be used with the db_workload property of a UpdateAutonomousDatabaseDetails. This constant has a value of “APEX”

DB_WORKLOAD_DW = 'DW'

A constant which can be used with the db_workload property of a UpdateAutonomousDatabaseDetails. This constant has a value of “DW”

DB_WORKLOAD_OLTP = 'OLTP'

A constant which can be used with the db_workload property of a UpdateAutonomousDatabaseDetails. This constant has a value of “OLTP”

LICENSE_MODEL_BRING_YOUR_OWN_LICENSE = 'BRING_YOUR_OWN_LICENSE'

A constant which can be used with the license_model property of a UpdateAutonomousDatabaseDetails. This constant has a value of “BRING_YOUR_OWN_LICENSE”

LICENSE_MODEL_LICENSE_INCLUDED = 'LICENSE_INCLUDED'

A constant which can be used with the license_model property of a UpdateAutonomousDatabaseDetails. This constant has a value of “LICENSE_INCLUDED”

OPEN_MODE_READ_ONLY = 'READ_ONLY'

A constant which can be used with the open_mode property of a UpdateAutonomousDatabaseDetails. This constant has a value of “READ_ONLY”

OPEN_MODE_READ_WRITE = 'READ_WRITE'

A constant which can be used with the open_mode property of a UpdateAutonomousDatabaseDetails. This constant has a value of “READ_WRITE”

PERMISSION_LEVEL_RESTRICTED = 'RESTRICTED'

A constant which can be used with the permission_level property of a UpdateAutonomousDatabaseDetails. This constant has a value of “RESTRICTED”

PERMISSION_LEVEL_UNRESTRICTED = 'UNRESTRICTED'

A constant which can be used with the permission_level property of a UpdateAutonomousDatabaseDetails. This constant has a value of “UNRESTRICTED”

REFRESHABLE_MODE_AUTOMATIC = 'AUTOMATIC'

A constant which can be used with the refreshable_mode property of a UpdateAutonomousDatabaseDetails. This constant has a value of “AUTOMATIC”

REFRESHABLE_MODE_MANUAL = 'MANUAL'

A constant which can be used with the refreshable_mode property of a UpdateAutonomousDatabaseDetails. This constant has a value of “MANUAL”

__init__(**kwargs)

Initializes a new UpdateAutonomousDatabaseDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • backup_retention_period_in_days (int) – The value to assign to the backup_retention_period_in_days property of this UpdateAutonomousDatabaseDetails.
  • compute_model (str) – The value to assign to the compute_model property of this UpdateAutonomousDatabaseDetails. Allowed values for this property are: “ECPU”, “OCPU”
  • in_memory_percentage (int) – The value to assign to the in_memory_percentage property of this UpdateAutonomousDatabaseDetails.
  • local_adg_auto_failover_max_data_loss_limit (int) – The value to assign to the local_adg_auto_failover_max_data_loss_limit property of this UpdateAutonomousDatabaseDetails.
  • cpu_core_count (int) – The value to assign to the cpu_core_count property of this UpdateAutonomousDatabaseDetails.
  • long_term_backup_schedule (oci.database.models.LongTermBackUpScheduleDetails) – The value to assign to the long_term_backup_schedule property of this UpdateAutonomousDatabaseDetails.
  • is_dev_tier (bool) – The value to assign to the is_dev_tier property of this UpdateAutonomousDatabaseDetails.
  • compute_count (float) – The value to assign to the compute_count property of this UpdateAutonomousDatabaseDetails.
  • ocpu_count (float) – The value to assign to the ocpu_count property of this UpdateAutonomousDatabaseDetails.
  • data_storage_size_in_tbs (int) – The value to assign to the data_storage_size_in_tbs property of this UpdateAutonomousDatabaseDetails.
  • data_storage_size_in_gbs (int) – The value to assign to the data_storage_size_in_gbs property of this UpdateAutonomousDatabaseDetails.
  • display_name (str) – The value to assign to the display_name property of this UpdateAutonomousDatabaseDetails.
  • is_free_tier (bool) – The value to assign to the is_free_tier property of this UpdateAutonomousDatabaseDetails.
  • admin_password (str) – The value to assign to the admin_password property of this UpdateAutonomousDatabaseDetails.
  • db_name (str) – The value to assign to the db_name property of this UpdateAutonomousDatabaseDetails.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateAutonomousDatabaseDetails.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateAutonomousDatabaseDetails.
  • db_workload (str) – The value to assign to the db_workload property of this UpdateAutonomousDatabaseDetails. Allowed values for this property are: “OLTP”, “DW”, “AJD”, “APEX”
  • license_model (str) – The value to assign to the license_model property of this UpdateAutonomousDatabaseDetails. Allowed values for this property are: “LICENSE_INCLUDED”, “BRING_YOUR_OWN_LICENSE”
  • is_access_control_enabled (bool) – The value to assign to the is_access_control_enabled property of this UpdateAutonomousDatabaseDetails.
  • whitelisted_ips (list[str]) – The value to assign to the whitelisted_ips property of this UpdateAutonomousDatabaseDetails.
  • are_primary_whitelisted_ips_used (bool) – The value to assign to the are_primary_whitelisted_ips_used property of this UpdateAutonomousDatabaseDetails.
  • standby_whitelisted_ips (list[str]) – The value to assign to the standby_whitelisted_ips property of this UpdateAutonomousDatabaseDetails.
  • is_auto_scaling_enabled (bool) – The value to assign to the is_auto_scaling_enabled property of this UpdateAutonomousDatabaseDetails.
  • is_refreshable_clone (bool) – The value to assign to the is_refreshable_clone property of this UpdateAutonomousDatabaseDetails.
  • refreshable_mode (str) – The value to assign to the refreshable_mode property of this UpdateAutonomousDatabaseDetails. Allowed values for this property are: “AUTOMATIC”, “MANUAL”
  • is_local_data_guard_enabled (bool) – The value to assign to the is_local_data_guard_enabled property of this UpdateAutonomousDatabaseDetails.
  • is_data_guard_enabled (bool) – The value to assign to the is_data_guard_enabled property of this UpdateAutonomousDatabaseDetails.
  • peer_db_id (str) – The value to assign to the peer_db_id property of this UpdateAutonomousDatabaseDetails.
  • db_version (str) – The value to assign to the db_version property of this UpdateAutonomousDatabaseDetails.
  • open_mode (str) – The value to assign to the open_mode property of this UpdateAutonomousDatabaseDetails. Allowed values for this property are: “READ_ONLY”, “READ_WRITE”
  • permission_level (str) – The value to assign to the permission_level property of this UpdateAutonomousDatabaseDetails. Allowed values for this property are: “RESTRICTED”, “UNRESTRICTED”
  • subnet_id (str) – The value to assign to the subnet_id property of this UpdateAutonomousDatabaseDetails.
  • private_endpoint_label (str) – The value to assign to the private_endpoint_label property of this UpdateAutonomousDatabaseDetails.
  • private_endpoint_ip (str) – The value to assign to the private_endpoint_ip property of this UpdateAutonomousDatabaseDetails.
  • nsg_ids (list[str]) – The value to assign to the nsg_ids property of this UpdateAutonomousDatabaseDetails.
  • auto_refresh_frequency_in_seconds (int) – The value to assign to the auto_refresh_frequency_in_seconds property of this UpdateAutonomousDatabaseDetails.
  • auto_refresh_point_lag_in_seconds (int) – The value to assign to the auto_refresh_point_lag_in_seconds property of this UpdateAutonomousDatabaseDetails.
  • time_of_auto_refresh_start (datetime) – The value to assign to the time_of_auto_refresh_start property of this UpdateAutonomousDatabaseDetails.
  • customer_contacts (list[oci.database.models.CustomerContact]) – The value to assign to the customer_contacts property of this UpdateAutonomousDatabaseDetails.
  • is_mtls_connection_required (bool) – The value to assign to the is_mtls_connection_required property of this UpdateAutonomousDatabaseDetails.
  • resource_pool_leader_id (str) – The value to assign to the resource_pool_leader_id property of this UpdateAutonomousDatabaseDetails.
  • resource_pool_summary (oci.database.models.ResourcePoolSummary) – The value to assign to the resource_pool_summary property of this UpdateAutonomousDatabaseDetails.
  • scheduled_operations (list[oci.database.models.ScheduledOperationDetails]) – The value to assign to the scheduled_operations property of this UpdateAutonomousDatabaseDetails.
  • is_auto_scaling_for_storage_enabled (bool) – The value to assign to the is_auto_scaling_for_storage_enabled property of this UpdateAutonomousDatabaseDetails.
  • database_edition (str) – The value to assign to the database_edition property of this UpdateAutonomousDatabaseDetails.
  • db_tools_details (list[oci.database.models.DatabaseTool]) – The value to assign to the db_tools_details property of this UpdateAutonomousDatabaseDetails.
  • secret_id (str) – The value to assign to the secret_id property of this UpdateAutonomousDatabaseDetails.
  • secret_version_number (int) – The value to assign to the secret_version_number property of this UpdateAutonomousDatabaseDetails.
admin_password

Gets the admin_password of this UpdateAutonomousDatabaseDetails. The password must be between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (”) or the username “admin”, regardless of casing. It must be different from the last four passwords and it must not be a password used within the last 24 hours.

This cannot be used in conjunction with with OCI vault secrets (secretId).

This cannot be updated in parallel with any of the following: licenseModel, dbEdition, whitelistedIps, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, or isFreeTier.

Returns:The admin_password of this UpdateAutonomousDatabaseDetails.
Return type:str
are_primary_whitelisted_ips_used

Gets the are_primary_whitelisted_ips_used of this UpdateAutonomousDatabaseDetails. This field will be null if the Autonomous Database is not Data Guard enabled or Access Control is disabled. TRUE if the Autonomous Database has Data Guard and Access Control enabled, and the Autonomous Database uses the primary’s IP access control list (ACL) for standby. FALSE if the Autonomous Database has Data Guard and Access Control enabled, and the Autonomous Database uses a different IP access control list (ACL) for standby compared to primary.

Returns:The are_primary_whitelisted_ips_used of this UpdateAutonomousDatabaseDetails.
Return type:bool
auto_refresh_frequency_in_seconds

Gets the auto_refresh_frequency_in_seconds of this UpdateAutonomousDatabaseDetails. The frequency a refreshable clone is refreshed after auto-refresh is enabled. The minimum is 1 hour. The maximum is 7 days. The date and time that auto-refresh is enabled is controlled by the timeOfAutoRefreshStart parameter.

Returns:The auto_refresh_frequency_in_seconds of this UpdateAutonomousDatabaseDetails.
Return type:int
auto_refresh_point_lag_in_seconds

Gets the auto_refresh_point_lag_in_seconds of this UpdateAutonomousDatabaseDetails. The time, in seconds, the data of the refreshable clone lags the primary database at the point of refresh. The minimum is 0 minutes (0 mins means refresh to the latest available timestamp). The maximum is 7 days. The lag time increases after refreshing until the next data refresh happens.

Returns:The auto_refresh_point_lag_in_seconds of this UpdateAutonomousDatabaseDetails.
Return type:int
backup_retention_period_in_days

Gets the backup_retention_period_in_days of this UpdateAutonomousDatabaseDetails. Retention period, in days, for long-term backups

Returns:The backup_retention_period_in_days of this UpdateAutonomousDatabaseDetails.
Return type:int
compute_count

Gets the compute_count of this UpdateAutonomousDatabaseDetails. The compute amount (CPUs) available to the database. Minimum and maximum values depend on the compute model and whether the database is an Autonomous Database Serverless instance or an Autonomous Database on Dedicated Exadata Infrastructure. For an Autonomous Database Serverless instance, the ‘ECPU’ compute model requires a minimum value of one, for databases in the elastic resource pool and minimum value of two, otherwise. Required when using the computeModel parameter. When using cpuCoreCount parameter, it is an error to specify computeCount to a non-null value. Providing computeModel and computeCount is the preferred method for both OCPU and ECPU.

This cannot be updated in parallel with any of the following: licenseModel, databaseEdition, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

Returns:The compute_count of this UpdateAutonomousDatabaseDetails.
Return type:float
compute_model

Gets the compute_model of this UpdateAutonomousDatabaseDetails. The compute model of the Autonomous Database. This is required if using the computeCount parameter. If using cpuCoreCount then it is an error to specify computeModel to a non-null value. ECPU compute model is the recommended model and OCPU compute model is legacy.

Allowed values for this property are: “ECPU”, “OCPU”

Returns:The compute_model of this UpdateAutonomousDatabaseDetails.
Return type:str
cpu_core_count

Gets the cpu_core_count of this UpdateAutonomousDatabaseDetails. The number of CPUs to be made available to the Autonomous Database.<br> For Autonomous Databases on Dedicated Exadata Infrastructure: - The CPU type (OCPUs or ECPUs) is determined by the parent Autonomous Exadata VM Cluster’s compute model. - It is suggested to use ‘computeCount’ parameter if you want to use fractional value to provision less than 1 core.

Note: This parameter cannot be used with the ocpuCount or computeCount parameter.

This cannot be updated in parallel with any of the following: licenseModel, databaseEdition, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

Returns:The cpu_core_count of this UpdateAutonomousDatabaseDetails.
Return type:int
customer_contacts

Gets the customer_contacts of this UpdateAutonomousDatabaseDetails. Customer Contacts. Setting this to an empty list removes all customer contacts of an Oracle

This cannot be updated in parallel with any of the following: isMTLSConnectionRequired, scheduledOperations, or dbToolsDetails.

Returns:The customer_contacts of this UpdateAutonomousDatabaseDetails.
Return type:list[oci.database.models.CustomerContact]
data_storage_size_in_gbs

Gets the data_storage_size_in_gbs of this UpdateAutonomousDatabaseDetails. Applies to dedicated Exadata infrastructure only.

The size, in gigabytes, of the data volume that will be created and attached to the database. The maximum storage value depends on the system shape. See Characteristics of Infrastructure Shapes for shape details.

Note: This parameter cannot be used with the dataStorageSizeInTBs parameter.

Returns:The data_storage_size_in_gbs of this UpdateAutonomousDatabaseDetails.
Return type:int
data_storage_size_in_tbs

Gets the data_storage_size_in_tbs of this UpdateAutonomousDatabaseDetails. The size, in terabytes, of the data volume that will be created and attached to the database. For Autonomous Databases on dedicated Exadata infrastructure, the maximum storage value is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details. A full Exadata service is allocated when the Autonomous Database size is set to the upper limit (384 TB).

Note: This parameter cannot be used with the dataStorageSizeInGBs parameter.

This cannot be updated in parallel with any of the following: licenseModel, databaseEdition, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

Returns:The data_storage_size_in_tbs of this UpdateAutonomousDatabaseDetails.
Return type:int
database_edition

Gets the database_edition of this UpdateAutonomousDatabaseDetails. The Oracle Database Edition that applies to the Autonomous databases.

This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

Returns:The database_edition of this UpdateAutonomousDatabaseDetails.
Return type:str
db_name

Gets the db_name of this UpdateAutonomousDatabaseDetails. New name for this Autonomous Database. For Autonomous Databases on Dedicated Exadata Infrastructure, the name must begin with an alphabetic character, and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. For Autonomous Database Serverless instances, the name must begin with an alphabetic character, and can contain a maximum of 30 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy.

This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails.

Returns:The db_name of this UpdateAutonomousDatabaseDetails.
Return type:str
db_tools_details

Gets the db_tools_details of this UpdateAutonomousDatabaseDetails. The list of database tools details.

This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, isLocalDataGuardEnabled, or isFreeTier.

Returns:The db_tools_details of this UpdateAutonomousDatabaseDetails.
Return type:list[oci.database.models.DatabaseTool]
db_version

Gets the db_version of this UpdateAutonomousDatabaseDetails. A valid Oracle Database version for Autonomous Database.

Returns:The db_version of this UpdateAutonomousDatabaseDetails.
Return type:str
db_workload

Gets the db_workload of this UpdateAutonomousDatabaseDetails. The Autonomous Database workload type. The following values are valid:

  • OLTP - indicates an Autonomous Transaction Processing database
  • DW - indicates an Autonomous Data Warehouse database
  • AJD - indicates an Autonomous JSON Database
  • APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type.

This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

Allowed values for this property are: “OLTP”, “DW”, “AJD”, “APEX”

Returns:The db_workload of this UpdateAutonomousDatabaseDetails.
Return type:str
defined_tags

Gets the defined_tags of this UpdateAutonomousDatabaseDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Returns:The defined_tags of this UpdateAutonomousDatabaseDetails.
Return type:dict(str, dict(str, object))
display_name

Gets the display_name of this UpdateAutonomousDatabaseDetails. The user-friendly name for the Autonomous Database. The name does not have to be unique. The display name can only be updated for Autonomous Databases using dedicated Exadata Infrastructure. This parameter may not be updated in parallel with dbVersion.

Returns:The display_name of this UpdateAutonomousDatabaseDetails.
Return type:str
freeform_tags

Gets the freeform_tags of this UpdateAutonomousDatabaseDetails. 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”}

Returns:The freeform_tags of this UpdateAutonomousDatabaseDetails.
Return type:dict(str, str)
in_memory_percentage

Gets the in_memory_percentage of this UpdateAutonomousDatabaseDetails. The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous Database. This property is applicable only to Autonomous Databases on the Exadata Cloud@Customer platform.

Returns:The in_memory_percentage of this UpdateAutonomousDatabaseDetails.
Return type:int
is_access_control_enabled

Gets the is_access_control_enabled of this UpdateAutonomousDatabaseDetails. Indicates if the database-level access control is enabled. If disabled, database access is defined by the network security rules. If enabled, database access is restricted to the IP addresses defined by the rules specified with the whitelistedIps property. While specifying whitelistedIps rules is optional,

if database-level access control is enabled and no rules are specified, the database will become inaccessible. The rules can be added later using the UpdateAutonomousDatabase API operation or edit option in console.

When creating a database clone, the desired access control setting should be specified. By default, database-level access control will be disabled for the clone.

This property is applicable only to Autonomous Databases on the Exadata Cloud@Customer platform. For Autonomous Database Serverless instances, whitelistedIps is used.

Returns:The is_access_control_enabled of this UpdateAutonomousDatabaseDetails.
Return type:bool
is_auto_scaling_enabled

Gets the is_auto_scaling_enabled of this UpdateAutonomousDatabaseDetails. Indicates whether auto scaling is enabled for the Autonomous Database CPU core count. Setting to TRUE enables auto scaling. Setting to FALSE disables auto scaling. The default value is TRUE. Auto scaling is only available for Autonomous Database Serverless instances.

Returns:The is_auto_scaling_enabled of this UpdateAutonomousDatabaseDetails.
Return type:bool
is_auto_scaling_for_storage_enabled

Gets the is_auto_scaling_for_storage_enabled of this UpdateAutonomousDatabaseDetails. Indicates if auto scaling is enabled for the Autonomous Database storage. The default value is FALSE.

Returns:The is_auto_scaling_for_storage_enabled of this UpdateAutonomousDatabaseDetails.
Return type:bool
is_data_guard_enabled

Gets the is_data_guard_enabled of this UpdateAutonomousDatabaseDetails. ** Deprecated. ** Indicates whether the Autonomous Database has a local (in-region) standby database. Not applicable when creating a cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.

To create a local standby, set to TRUE. To delete a local standby, set to FALSE. For more information on using Autonomous Data Guard on an Autonomous Database Serverless instance (local and cross-region) , see About Standby Databases

To enable cross-region Autonomous Data Guard on an Autonomous Database Serverless instance, see Enable Autonomous Data Guard.

To delete a cross-region standby database, provide the peerDbId for the standby database in a remote region, and set isDataGuardEnabled to FALSE.

Returns:The is_data_guard_enabled of this UpdateAutonomousDatabaseDetails.
Return type:bool
is_dev_tier

Gets the is_dev_tier of this UpdateAutonomousDatabaseDetails. This project introduces Autonomous Database for Developers (ADB-Dev), a free tier on dedicated infrastructure, and Cloud@Customer for database development purposes. ADB-Dev enables ExaDB customers to experiment with ADB for free and incentivizes enterprises to use ADB for new development projects.Note that ADB-Dev have 4 CPU and 20GB of memory. For ADB-Dev , memory and CPU cannot be scaled

Returns:The is_dev_tier of this UpdateAutonomousDatabaseDetails.
Return type:bool
is_free_tier

Gets the is_free_tier of this UpdateAutonomousDatabaseDetails. Indicates if this is an Always Free resource. The default value is false. Note that Always Free Autonomous Databases have 1 CPU and 20GB of memory. For Always Free databases, memory and CPU cannot be scaled.

This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isLocalDataGuardEnabled

Returns:The is_free_tier of this UpdateAutonomousDatabaseDetails.
Return type:bool
is_local_data_guard_enabled

Gets the is_local_data_guard_enabled of this UpdateAutonomousDatabaseDetails. Indicates whether the Autonomous Database has a local (in-region) standby database. Not applicable when creating a cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.

To create a local standby, set to TRUE. To delete a local standby, set to FALSE. For more information on using Autonomous Data Guard on an Autonomous Database Serverless instance (local and cross-region) , see About Standby Databases

To enable cross-region Autonomous Data Guard on an Autonomous Database Serverless instance, see Enable Autonomous Data Guard.

This cannot be updated in parallel with any of the following: isMTLSRequired, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

Returns:The is_local_data_guard_enabled of this UpdateAutonomousDatabaseDetails.
Return type:bool
is_mtls_connection_required

Gets the is_mtls_connection_required of this UpdateAutonomousDatabaseDetails. Specifies if the Autonomous Database requires mTLS connections.

This may not be updated in parallel with any of the following: licenseModel, databaseEdition, cpuCoreCount, computeCount, dataStorageSizeInTBs, whitelistedIps, openMode, permissionLevel, db-workload, privateEndpointLabel, nsgIds, customerContacts, dbVersion, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

Service Change: The default value of the isMTLSConnectionRequired attribute will change from true to false on July 1, 2023 in the following APIs: - CreateAutonomousDatabase - GetAutonomousDatabase - UpdateAutonomousDatabase Details: Prior to the July 1, 2023 change, the isMTLSConnectionRequired attribute default value was true. This applies to Autonomous Database Serverless. Does this impact me? If you use or maintain custom scripts or Terraform scripts referencing the CreateAutonomousDatabase, GetAutonomousDatabase, or UpdateAutonomousDatabase APIs, you want to check, and possibly modify, the scripts for the changed default value of the attribute. Should you choose not to leave your scripts unchanged, the API calls containing this attribute will continue to work, but the default value will switch from true to false. How do I make this change? Using either OCI SDKs or command line tools, update your custom scripts to explicitly set the isMTLSConnectionRequired attribute to true.

Returns:The is_mtls_connection_required of this UpdateAutonomousDatabaseDetails.
Return type:bool
is_refreshable_clone

Gets the is_refreshable_clone of this UpdateAutonomousDatabaseDetails. Indicates if the Autonomous Database is a refreshable clone.

This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

Returns:The is_refreshable_clone of this UpdateAutonomousDatabaseDetails.
Return type:bool
license_model

Gets the license_model of this UpdateAutonomousDatabaseDetails. The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. License Included allows you to subscribe to new Oracle Database software licenses and the Oracle Database service. Note that when provisioning an Autonomous Database on dedicated Exadata infrastructure, this attribute must be null. It is already set at the Autonomous Exadata Infrastructure level. When provisioning an Autonomous Database Serverless] database, if a value is not specified, the system defaults the value to BRING_YOUR_OWN_LICENSE. Bring your own license (BYOL) also allows you to select the DB edition using the optional parameter.

This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

Allowed values for this property are: “LICENSE_INCLUDED”, “BRING_YOUR_OWN_LICENSE”

Returns:The license_model of this UpdateAutonomousDatabaseDetails.
Return type:str
local_adg_auto_failover_max_data_loss_limit

Gets the local_adg_auto_failover_max_data_loss_limit of this UpdateAutonomousDatabaseDetails. Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard

Returns:The local_adg_auto_failover_max_data_loss_limit of this UpdateAutonomousDatabaseDetails.
Return type:int
long_term_backup_schedule

Gets the long_term_backup_schedule of this UpdateAutonomousDatabaseDetails.

Returns:The long_term_backup_schedule of this UpdateAutonomousDatabaseDetails.
Return type:oci.database.models.LongTermBackUpScheduleDetails
nsg_ids

Gets the nsg_ids of this UpdateAutonomousDatabaseDetails. 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.

Returns:The nsg_ids of this UpdateAutonomousDatabaseDetails.
Return type:list[str]
ocpu_count

Gets the ocpu_count of this UpdateAutonomousDatabaseDetails. The number of OCPU cores to be made available to the Autonomous Database.

For Autonomous Databases on Dedicated Exadata Infrastructure, you can specify a fractional value for this parameter. Fractional values are not supported for Autonomous Database Serverless instances. For Autonomous Database Serverless instances, this parameter is not used.

To provision less than 1 core, enter a fractional value in an increment of 0.1. To provision 1 or more cores, you must enter an integer between 1 and the maximum number of cores available to the infrastructure shape. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. Likewise, you can provision 2 cores or 3 cores, but not 2.5 cores. The maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.

Note: This parameter cannot be used with the cpuCoreCount parameter.

Returns:The ocpu_count of this UpdateAutonomousDatabaseDetails.
Return type:float
open_mode

Gets the open_mode of this UpdateAutonomousDatabaseDetails. Indicates the Autonomous Database mode. The database can be opened in READ_ONLY or READ_WRITE mode.

This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

Allowed values for this property are: “READ_ONLY”, “READ_WRITE”

Returns:The open_mode of this UpdateAutonomousDatabaseDetails.
Return type:str
peer_db_id

Gets the peer_db_id of this UpdateAutonomousDatabaseDetails. The database OCID(/Content/General/Concepts/identifiers.htm) of the Disaster Recovery peer (source Primary) database, which is located in a different (remote) region from the current peer database.

To create or delete a local (in-region) standby, see the isDataGuardEnabled parameter.

Returns:The peer_db_id of this UpdateAutonomousDatabaseDetails.
Return type:str
permission_level

Gets the permission_level of this UpdateAutonomousDatabaseDetails. The Autonomous Database permission level. Restricted mode allows access only by admin users.

This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

Allowed values for this property are: “RESTRICTED”, “UNRESTRICTED”

Returns:The permission_level of this UpdateAutonomousDatabaseDetails.
Return type:str
private_endpoint_ip

Gets the private_endpoint_ip of this UpdateAutonomousDatabaseDetails. The private endpoint Ip address for the resource.

Returns:The private_endpoint_ip of this UpdateAutonomousDatabaseDetails.
Return type:str
private_endpoint_label

Gets the private_endpoint_label of this UpdateAutonomousDatabaseDetails. The resource’s private endpoint label. - Setting the endpoint label to a non-empty string creates a private endpoint database. - Resetting the endpoint label to an empty string, after the creation of the private endpoint database, changes the private endpoint database to a public endpoint database. - Setting the endpoint label to a non-empty string value, updates to a new private endpoint database, when the database is disabled and re-enabled.

This setting cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

Returns:The private_endpoint_label of this UpdateAutonomousDatabaseDetails.
Return type:str
refreshable_mode

Gets the refreshable_mode of this UpdateAutonomousDatabaseDetails. The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous Database.

Allowed values for this property are: “AUTOMATIC”, “MANUAL”

Returns:The refreshable_mode of this UpdateAutonomousDatabaseDetails.
Return type:str
resource_pool_leader_id

Gets the resource_pool_leader_id of this UpdateAutonomousDatabaseDetails. The unique identifier for leader autonomous database OCID OCID.

Returns:The resource_pool_leader_id of this UpdateAutonomousDatabaseDetails.
Return type:str
resource_pool_summary

Gets the resource_pool_summary of this UpdateAutonomousDatabaseDetails.

Returns:The resource_pool_summary of this UpdateAutonomousDatabaseDetails.
Return type:oci.database.models.ResourcePoolSummary
scheduled_operations

Gets the scheduled_operations of this UpdateAutonomousDatabaseDetails. The list of scheduled operations. Consists of values such as dayOfWeek, scheduledStartTime, scheduledStopTime.

This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

Returns:The scheduled_operations of this UpdateAutonomousDatabaseDetails.
Return type:list[oci.database.models.ScheduledOperationDetails]
secret_id

Gets the secret_id of this UpdateAutonomousDatabaseDetails. The OCI vault secret [/Content/General/Concepts/identifiers.htm]OCID. This cannot be used in conjunction with adminPassword.

Returns:The secret_id of this UpdateAutonomousDatabaseDetails.
Return type:str
secret_version_number

Gets the secret_version_number of this UpdateAutonomousDatabaseDetails. The version of the vault secret. If no version is specified, the latest version will be used.

Returns:The secret_version_number of this UpdateAutonomousDatabaseDetails.
Return type:int
standby_whitelisted_ips

Gets the standby_whitelisted_ips of this UpdateAutonomousDatabaseDetails. The client IP access control list (ACL). This feature is available for Autonomous Database Serverless] and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. If arePrimaryWhitelistedIpsUsed is ‘TRUE’ then Autonomous Database uses this primary’s IP access control list (ACL) for the disaster recovery peer called standbywhitelistedips.

For Autonomous Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Multiple IPs and VCN OCIDs should be separate strings separated by commas, but if it’s other configurations that need multiple pieces of information then its each piece is connected with semicolon (;) as a delimiter. Example: [“1.1.1.1”,”1.1.1.0/24”,”ocid1.vcn.oc1.sea.<unique_id>”,”ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1”,”ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16”] For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: [“1.1.1.1”,”1.1.1.0/24”,”1.1.2.25”]

For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry.

This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

Returns:The standby_whitelisted_ips of this UpdateAutonomousDatabaseDetails.
Return type:list[str]
subnet_id

Gets the subnet_id of this UpdateAutonomousDatabaseDetails. The OCID of the subnet the resource 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 systems, do not use a subnet that overlaps with 192.168.128.0/20. - For Autonomous Database, setting this will disable public secure access to the database.

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.

Returns:The subnet_id of this UpdateAutonomousDatabaseDetails.
Return type:str
time_of_auto_refresh_start

Gets the time_of_auto_refresh_start of this UpdateAutonomousDatabaseDetails. The the date and time that auto-refreshing will begin for an Autonomous Database refreshable clone. This value controls only the start time for the first refresh operation. Subsequent (ongoing) refresh operations have start times controlled by the value of the autoRefreshFrequencyInSeconds parameter.

Returns:The time_of_auto_refresh_start of this UpdateAutonomousDatabaseDetails.
Return type:datetime
whitelisted_ips

Gets the whitelisted_ips of this UpdateAutonomousDatabaseDetails. The client IP access control list (ACL). This feature is available for Autonomous Database Serverless] and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. If arePrimaryWhitelistedIpsUsed is ‘TRUE’ then Autonomous Database uses this primary’s IP access control list (ACL) for the disaster recovery peer called standbywhitelistedips.

For Autonomous Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Multiple IPs and VCN OCIDs should be separate strings separated by commas, but if it’s other configurations that need multiple pieces of information then its each piece is connected with semicolon (;) as a delimiter. Example: [“1.1.1.1”,”1.1.1.0/24”,”ocid1.vcn.oc1.sea.<unique_id>”,”ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1”,”ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16”] For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: [“1.1.1.1”,”1.1.1.0/24”,”1.1.2.25”]

For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry.

This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

Returns:The whitelisted_ips of this UpdateAutonomousDatabaseDetails.
Return type:list[str]