Data Source: oci_database_autonomous_databases

This data source provides the list of Autonomous Databases in Oracle Cloud Infrastructure Database service.

Gets a list of Autonomous Databases based on the query parameters specified.

Example Usage

data "oci_database_autonomous_databases" "test_autonomous_databases" {
	#Required
	compartment_id = var.compartment_id

	#Optional
	autonomous_container_database_id = oci_database_autonomous_container_database.test_autonomous_container_database.id
	db_version = var.autonomous_database_db_version
	db_workload = var.autonomous_database_db_workload
	display_name = var.autonomous_database_display_name
	infrastructure_type = var.autonomous_database_infrastructure_type
	is_data_guard_enabled = var.autonomous_database_is_data_guard_enabled
	is_free_tier = var.autonomous_database_is_free_tier
	is_refreshable_clone = var.autonomous_database_is_refreshable_clone
	is_resource_pool_leader = var.autonomous_database_is_resource_pool_leader
	lifecycle_state_not_equal_to = var.autonomous_database_lifecycle_state_not_equal_to
	resource_pool_leader_id = oci_database_resource_pool_leader.test_resource_pool_leader.id
	state = var.autonomous_database_state
}

Argument Reference

The following arguments are supported:

• autonomous_container_database_id - (Optional) The Autonomous Container Database OCID.
• compartment_id - (Required) The compartment OCID.
• db_version - (Optional) A filter to return only autonomous database resources that match the specified dbVersion.
• db_workload - (Optional) A filter to return only autonomous database resources that match the specified workload type.
• display_name - (Optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
• infrastructure_type - (Optional) A filter to return only resources that match the given Infrastructure Type.
• is_data_guard_enabled - (Optional) A filter to return only resources that have Data Guard enabled.
• is_free_tier - (Optional) Filter on the value of the resource’s ‘isFreeTier’ property. A value of true returns only Always Free resources. A value of false excludes Always Free resources from the returned results. Omitting this parameter returns both Always Free and paid resources.
• is_refreshable_clone - (Optional) Filter on the value of the resource’s ‘isRefreshableClone’ property. A value of true returns only refreshable clones. A value of false excludes refreshable clones from the returned results. Omitting this parameter returns both refreshable clones and databases that are not refreshable clones.
• is_resource_pool_leader - (Optional) Filter if the resource is the resource pool leader. A value of true returns only resource pool leader.
• lifecycle_state_not_equal_to - (Optional) A filter to return only resources that not match the given lifecycle state.
• resource_pool_leader_id - (Optional) The database OCID of the resourcepool Leader Autonomous Database.
• state - (Optional) A filter to return only resources that match the given lifecycle state exactly.

Attributes Reference

The following attributes are exported:

• autonomous_databases - The list of autonomous_databases.

AutonomousDatabase Reference

The following attributes are exported:

• actual_used_data_storage_size_in_tbs - The current amount of storage in use for user and system data, in terabytes (TB).

• allocated_storage_size_in_tbs - The amount of storage currently allocated for the database tables and billed for, rounded up. When auto-scaling is not enabled, this value is equal to the dataStorageSizeInTBs value. You can compare this value to the actualUsedDataStorageSizeInTBs value to determine if a manual shrink operation is appropriate for your allocated storage.

  Note: Auto-scaling does not automatically decrease allocated storage when data is deleted from the database.

• apex_details - Information about Oracle APEX Application Development.

  • apex_version - The Oracle APEX Application Development version.
  • ords_version - The Oracle REST Data Services (ORDS) version.

• are_primary_whitelisted_ips_used - This field will be null if the Autonomous Database is not Data Guard enabled or Access Control is disabled. It’s value would be TRUE if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses primary IP access control list (ACL) for standby. It’s value would be FALSE if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses different IP access control list (ACL) for standby compared to primary.

• auto_refresh_frequency_in_seconds - 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.

• auto_refresh_point_lag_in_seconds - 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.

• autonomous_container_database_id - The Autonomous Container Database OCID. Used only by Autonomous Database on Dedicated Exadata Infrastructure.

• autonomous_maintenance_schedule_type - The maintenance schedule type of the Autonomous Database Serverless. An EARLY maintenance schedule follows a schedule applying patches prior to the REGULAR schedule. A REGULAR maintenance schedule follows the normal cycle

• availability_domain - The availability domain where the Autonomous Database Serverless instance is located.

• available_upgrade_versions - List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty.

• backup_config - Autonomous Database configuration details for storing manual backups in the Object Storage service.

  • manual_backup_bucket_name - Name of Object Storage bucket to use for storing manual backups.
  • manual_backup_type - The manual backup destination type.

• backup_retention_period_in_days - Retention period, in days, for long-term backups

• byol_compute_count_limit - The maximum number of CPUs allowed with a Bring Your Own License (BYOL), including those used for auto-scaling, disaster recovery, tools, etc. Any CPU usage above this limit is considered as License Included and billed.

• character_set - The character set for the autonomous 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

• clone_table_space_list - A list of the source Autonomous Database’s table space number(s) used to create this partial clone from the backup.

• cluster_placement_group_id - The OCID of the cluster placement group of the Autonomous Serverless Database.

• compartment_id - The OCID of the compartment.

• compute_count - 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. 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.

• compute_model - 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.

• connection_strings - The connection string used to connect to the Autonomous Database. The username for the Service Console is ADMIN. Use the password you entered when creating the Autonomous Database for the password value.

  • all_connection_strings - Returns all connection strings that can be used to connect to the Autonomous Database. For more information, please see Predefined Database Service Names for Autonomous Transaction Processing
  • dedicated - The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.
  • high - The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements.
  • low - The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.
  • medium - The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements.
  • profiles - A list of connection string profiles to allow clients to group, filter and select connection string values based on structured metadata.
    • consumer_group - Consumer group used by the connection.
    • display_name - A user-friendly name for the connection.
    • host_format - Host format used in connection string.
    • is_regional - True for a regional connection string, applicable to cross-region DG only.
    • protocol - Protocol used by the connection.
    • session_mode - Specifies whether the listener performs a direct hand-off of the session, or redirects the session. In RAC deployments where SCAN is used, sessions are redirected to a Node VIP. Use DIRECT for direct hand-offs. Use REDIRECT to redirect the session.
    • syntax_format - Specifies whether the connection string is using the long (LONG), Easy Connect (EZCONNECT), or Easy Connect Plus (EZCONNECTPLUS) format. Autonomous Database Serverless instances always use the long format.
    • tls_authentication - Specifies whether the TLS handshake is using one-way (SERVER) or mutual (MUTUAL) authentication.
    • value - Connection string value.

• connection_urls - The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN. Note that these URLs are provided by the console only for databases on dedicated Exadata infrastructure. Example: {"sqlDevWebUrl": "https://<hostname>/ords...", "apexUrl", "https://<hostname>/ords..."}

  • apex_url - Oracle Application Express (APEX) URL.
  • database_transforms_url - The URL of the Database Transforms for the Autonomous Database.
  • graph_studio_url - The URL of the Graph Studio for the Autonomous Database.
  • machine_learning_notebook_url - The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database.
  • machine_learning_user_management_url - Oracle Machine Learning user management URL.
  • mongo_db_url - The URL of the MongoDB API for the Autonomous Database.
  • ords_url - The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database.
  • sql_dev_web_url - Oracle SQL Developer Web URL.

• cpu_core_count - The number of CPU cores to be made available to the database. When the ECPU is selected, the value for cpuCoreCount is 0. For Autonomous Database on Dedicated Exadata infrastructure, 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 ocpuCount parameter.

• customer_contacts - Customer Contacts.

  • email - The email address used by Oracle to send notifications regarding databases and infrastructure.

• data_safe_status - Status of the Data Safe registration for this Autonomous Database. Could be REGISTERED or NOT_REGISTERED.

• data_storage_size_in_gb - The quantity of data in the database, in gigabytes.

  For Autonomous Transaction Processing databases using ECPUs on Serverless Infrastructure, this value is always populated. In all the other cases, this value will be null and dataStorageSizeInTBs will be populated instead.

• data_storage_size_in_tbs - The quantity of data in the database, in terabytes.

  The following points apply to Autonomous Databases on Serverless Infrastructure:

  • This is an integer field whose value remains null when the data size is in GBs and cannot be converted to TBs (by dividing the GB value by 1024) without rounding error.
  • To get the exact value of data storage size without rounding error, please see dataStorageSizeInGBs of Autonomous Database.

• database_edition - The Oracle Database Edition that applies to the Autonomous databases.

• database_management_status - Status of Database Management for this Autonomous Database.

• dataguard_region_type - Deprecated. The Autonomous Data Guard region type of the Autonomous Database. For Autonomous Database Serverless, Autonomous Data Guard associations have designated primary and standby regions, and these region types do not change when the database changes roles. The standby regions in Autonomous Data Guard associations can be the same region designated as the primary region, or they can be remote regions. Certain database administrative operations may be available only in the primary region of the Autonomous Data Guard association, and cannot be performed when the database using the primary role is operating in a remote Autonomous Data Guard standby region.

• db_name - The database name.

• db_tools_details - 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.

  • compute_count - Compute used by database tools.
  • is_enabled - Indicates whether tool is enabled.
  • max_idle_time_in_minutes - The max idle time, in minutes, after which the VM used by database tools will be terminated.
  • name - Name of database tool.

• db_version - A valid Oracle Database version for Autonomous Database.

• db_workload - 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.

• defined_tags - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

• disaster_recovery_region_type - Deprecated. The disaster recovery (DR) region type of the Autonomous Database. For Autonomous Database Serverless instances, DR associations have designated primary and standby regions. These region types do not change when the database changes roles. The standby region in DR associations can be the same region as the primary region, or they can be in a remote regions. Some database administration operations may be available only in the primary region of the DR association, and cannot be performed when the database using the primary role is operating in a remote region.

• display_name - The user-friendly name for the Autonomous Database. The name does not have to be unique.

• encryption_key - Details of the Autonomous Database encryption key.

  • arn_role - AWS ARN role
  • autonomous_database_provider - The provider for the Autonomous Database encryption key.
  • certificate_directory_name - OKV certificate directory name
  • certificate_id - OKV certificate id
  • directory_name - OKV wallet directory name
  • external_id - AWS external ID
  • key_arn - AWS key ARN
  • key_name - Azure key name
  • kms_key_id - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
  • okv_kms_key - UUID of OKV KMS Key
  • okv_uri - URI of OKV server
  • service_endpoint_uri - AWS key service endpoint URI
  • vault_id - The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
  • vault_uri - Azure vault URI

• encryption_key_history_entry - Key History Entry.

  • encryption_key - Details of the Autonomous Database encryption key.
    • arn_role - AWS ARN role
    • autonomous_database_provider - The provider for the Autonomous Database encryption key.
    • certificate_directory_name - OKV certificate directory name
    • certificate_id - OKV certificate id
    • directory_name - OKV wallet directory name
    • external_id - AWS external ID
    • key_arn - AWS key ARN
    • key_name - Azure key name
    • kms_key_id - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
    • okv_kms_key - UUID of OKV KMS Key
    • okv_uri - URI of OKV server
    • service_endpoint_uri - AWS key service endpoint URI
    • vault_id - The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
    • vault_uri - Azure vault URI
  • time_activated - The date and time the encryption key was activated.

• failed_data_recovery_in_seconds - Indicates the number of seconds of data loss for a Data Guard failover.

• freeform_tags - 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 - The OCID of the Autonomous Database.

• in_memory_area_in_gbs - The area assigned to In-Memory tables in Autonomous Database.

• in_memory_percentage - 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.

• infrastructure_type - The infrastructure type this resource belongs to.

• is_access_control_enabled - 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.

• is_auto_scaling_enabled - Indicates if auto scaling is enabled for the Autonomous Database CPU core count. The default value is TRUE.

• is_auto_scaling_for_storage_enabled - Indicates if auto scaling is enabled for the Autonomous Database storage. The default value is FALSE.

• is_backup_retention_locked - Indicates if the Autonomous Database is backup retention locked.

• is_data_guard_enabled - Deprecated. Indicates whether the Autonomous Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.

• is_dedicated - True if the database uses dedicated Exadata infrastructure.

• is_dev_tier - Autonomous Database for Developers are fixed-shape Autonomous Databases that developers can use to build and test new applications. On Serverless, these are low-cost and billed per instance, on Dedicated and Cloud@Customer there is no additional cost to create Developer databases. Developer databases come with limited resources and is not intended for large-scale testing and production deployments. When you need more compute or storage resources, you may upgrade to a full paid production database.

• is_free_tier - 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

• is_local_data_guard_enabled - Indicates whether the Autonomous Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.

• is_mtls_connection_required - 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 Oracle Cloud Infrastructure SDKs or command line tools, update your custom scripts to explicitly set the isMTLSConnectionRequired attribute to true.

• is_preview - Indicates if the Autonomous Database version is a preview version.

• is_reconnect_clone_enabled - Indicates if the refreshable clone can be reconnected to its source database.

• is_refreshable_clone - 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.

• is_remote_data_guard_enabled - Indicates whether the Autonomous Database has Cross Region Data Guard enabled. Not applicable to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.

• key_history_entry - Key History Entry.

  • id - The id of the Autonomous Database Vault service key management history entry.
  • kms_key_version_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.
  • time_activated - The date and time the kms key activated.
  • vault_id - The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

• key_store_id - The OCID of the key store of Oracle Vault.

• key_store_wallet_name - The wallet name for Oracle Key Vault.

• kms_key_id - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

• kms_key_lifecycle_details - KMS key lifecycle details.

• kms_key_version_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 - 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.

• lifecycle_details - Information about the current lifecycle state.

• local_adg_auto_failover_max_data_loss_limit - 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

• local_disaster_recovery_type - Indicates the local disaster recovery (DR) type of the Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover.

• local_standby_db - Autonomous Data Guard standby database details.

  • availability_domain - The availability domain of a local Autonomous Data Guard standby database of an Autonomous Database Serverless instance.
  • lag_time_in_seconds - The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover.
  • lifecycle_details - Additional information about the current lifecycle state.
  • maintenance_target_component - The component chosen for maintenance.
  • state - The current state of the Autonomous Database.
  • time_data_guard_role_changed - The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database.
  • time_disaster_recovery_role_changed - The date and time the Disaster Recovery role was switched for the standby Autonomous Database.
  • time_maintenance_begin - The date and time when maintenance will begin.
  • time_maintenance_end - The date and time when maintenance will end.

• long_term_backup_schedule - Details for the long-term backup schedule.

  • is_disabled - Indicates if the long-term backup schedule should be deleted. The default value is FALSE.
  • repeat_cadence - The frequency of the long-term backup schedule
  • retention_period_in_days - Retention period, in days, for long-term backups
  • time_of_backup - The timestamp for the long-term backup schedule. For a MONTHLY cadence, months having fewer days than the provided date will have the backup taken on the last day of that month.

• maintenance_target_component - The component chosen for maintenance.

• memory_per_oracle_compute_unit_in_gbs - The amount of memory (in GBs) enabled per ECPU or OCPU.

• ncharacter_set - The national character set for the autonomous database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

• net_services_architecture - Enabling SHARED server architecture enables a database server to allow many client processes to share very few server processes, thereby increasing the number of supported users.

• next_long_term_backup_time_stamp - The date and time when the next long-term backup would be created.

• nsg_ids - 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.

• ocpu_count - The number of OCPU cores to be made available to the database.

  The following points apply:

  • For Autonomous Databases on Dedicated Exadata Infrastructure, to provision less than 1 core, enter a fractional value in an increment of 0.1. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. (Note that fractional OCPU values are not supported for Autonomous Database Serverless instances.)
  • To provision cores, enter an integer between 1 and the maximum number of cores available for the infrastructure shape. For example, you can provision 2 cores or 3 cores, but not 2.5 cores. This applies to Autonomous Databases on both serverless and dedicated Exadata infrastructure.
  • For Autonomous Database Serverless instances, this parameter is not used.

  For Autonomous Databases on Dedicated Exadata Infrastructure, 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.

• open_mode - 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.

• operations_insights_status - Status of Operations Insights for this Autonomous Database.

• peer_db_ids - The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for Autonomous Database Serverless instances, standby databases located in the same region as the source primary database do not have OCIDs.

• permission_level - 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.

• private_endpoint - The private endpoint for the resource.

• private_endpoint_ip - The private endpoint Ip address for the resource.

• private_endpoint_label - The private endpoint label for the resource.

• provisionable_cpus - An array of CPU values that an Autonomous Database can be scaled to.

• public_connection_urls - The Public URLs of Private Endpoint database for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN.

  • apex_url - Oracle Application Express (APEX) URL.
  • database_transforms_url - The URL of the Database Transforms for the Autonomous Database.
  • graph_studio_url - The URL of the Graph Studio for the Autonomous Database.
  • machine_learning_notebook_url - The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database.
  • machine_learning_user_management_url - Oracle Machine Learning user management URL.
  • mongo_db_url - The URL of the MongoDB API for the Autonomous Database.
  • ords_url - The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database.
  • sql_dev_web_url - Oracle SQL Developer Web URL.

• public_endpoint - The public endpoint for the private endpoint enabled resource.

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

• refreshable_status - The refresh status of the clone. REFRESHING indicates that the clone is currently being refreshed with data from the source Autonomous Database.

• remote_disaster_recovery_configuration - Configurations of a Disaster Recovery.

  • disaster_recovery_type - Indicates the disaster recovery (DR) type of the Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover.
  • is_replicate_automatic_backups - If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database.
  • is_snapshot_standby - Indicates if user wants to convert to a snapshot standby. For example, true would set a standby database to snapshot standby database. False would set a snapshot standby database back to regular standby database.
  • time_snapshot_standby_enabled_till - Time and date stored as an RFC 3339 formatted timestamp string. For example, 2022-01-01T12:00:00.000Z would set a limit for the snapshot standby to be converted back to a cross-region standby database.

• resource_pool_leader_id - The unique identifier for leader autonomous database OCID OCID.

• resource_pool_summary - The configuration details for resource pool

  • is_disabled - Indicates if the resource pool should be deleted for the Autonomous Database.
    
  • pool_size - Resource pool size.

• role - The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.

• scheduled_operations - 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.

  • day_of_week - Day of the week.
    • name - Name of the day of the week.
  • scheduled_start_time - auto start time. value must be of ISO-8601 format “HH:mm”
  • scheduled_stop_time - auto stop time. value must be of ISO-8601 format “HH:mm”

• security_attributes - Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}

• service_console_url - The URL of the Service Console for the Autonomous Database.

• source_id - The OCID of the source Autonomous Database that was cloned to create the current Autonomous Database.

• standby_db - Deprecated Autonomous Data Guard standby database details.

  • availability_domain - The availability domain of a local Autonomous Data Guard standby database of an Autonomous Database Serverless instance.
  • lag_time_in_seconds - The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover.
  • lifecycle_details - Additional information about the current lifecycle state.
  • maintenance_target_component - The component chosen for maintenance.
  • state - The current state of the Autonomous Database.
  • time_data_guard_role_changed - The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database.
  • time_disaster_recovery_role_changed - The date and time the Disaster Recovery role was switched for the standby Autonomous Database.
  • time_maintenance_begin - The date and time when maintenance will begin.
  • time_maintenance_end - The date and time when maintenance will end.

• standby_whitelisted_ips - 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.

• state - The current state of the Autonomous Database.

• subnet_id - 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.¹⁶⁄₂₈.
  • 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.

• subscription_id - The OCID of the subscription with which resource needs to be associated with.

• supported_regions_to_clone_to - The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database.

• system_tags - System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

• time_created - The date and time the Autonomous Database was created.

• time_data_guard_role_changed - The date and time the Autonomous Data Guard role was switched for the Autonomous Database. For databases that have standbys in both the primary Data Guard region and a remote Data Guard standby region, this is the latest timestamp of either the database using the “primary” role in the primary Data Guard region, or database located in the remote Data Guard standby region.

• time_deletion_of_free_autonomous_database - The date and time the Always Free database will be automatically deleted because of inactivity. If the database is in the STOPPED state and without activity until this time, it will be deleted.

• time_disaster_recovery_role_changed - The date and time the Disaster Recovery role was switched for the standby Autonomous Database.

• time_earliest_available_db_version_upgrade - The earliest(min) date and time the Autonomous Database can be scheduled to upgrade to 23ai.

• time_latest_available_db_version_upgrade - The max date and time the Autonomous Database can be scheduled to upgrade to 23ai.

• time_local_data_guard_enabled - The date and time that Autonomous Data Guard was enabled for an Autonomous Database where the standby was provisioned in the same region as the primary database.

• time_maintenance_begin - The date and time when maintenance will begin.

• time_maintenance_end - The date and time when maintenance will end.

• time_of_auto_refresh_start - 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.

• time_of_joining_resource_pool - The time the member joined the resource pool.

• time_of_last_failover - The timestamp of the last failover operation.

• time_of_last_refresh - The date and time when last refresh happened.

• time_of_last_refresh_point - The refresh point timestamp (UTC). The refresh point is the time to which the database was most recently refreshed. Data created after the refresh point is not included in the refresh.

• time_of_last_switchover - The timestamp of the last switchover operation for the Autonomous Database.

• time_of_next_refresh - The date and time of next refresh.

• time_reclamation_of_free_autonomous_database - The date and time the Always Free database will be stopped because of inactivity. If this time is reached without any database activity, the database will automatically be put into the STOPPED state.

• time_scheduled_db_version_upgrade - The date and time the Autonomous Database scheduled to upgrade to 23ai.

• time_undeleted - The date and time the Autonomous Database was most recently undeleted.

• time_until_reconnect_clone_enabled - The time and date as an RFC3339 formatted string, e.g., 2022-01-01T12:00:00.000Z, to set the limit for a refreshable clone to be reconnected to its source database.

• total_backup_storage_size_in_gbs - The backup storage to the database.

• used_data_storage_size_in_gbs - The storage space consumed by Autonomous Database in GBs.

• used_data_storage_size_in_tbs - The amount of storage that has been used for Autonomous Databases in dedicated infrastructure, in terabytes.

• vault_id - The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

• whitelisted_ips - 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.