oracle / oracle.oci / 5.0.0 / module / oci_database_autonomous_database_actions Perform actions on an AutonomousDatabase resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_database_autonomous_database_actions (5.0.0) — module
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections: - name: oracle.oci version: 5.0.0
Perform actions on an AutonomousDatabase resource in Oracle Cloud Infrastructure
For I(action=autonomous_database_manual_refresh), initiates a data refresh for an Autonomous Database refreshable clone. Data is refreshed from the source database to the point of a specified timestamp.
For I(action=change_compartment), move the Autonomous Database and its dependent resources to the specified compartment. For more information about moving Autonomous Databases, see L(Moving Database Resources to a Different Compartment,https://docs.cloud.oracle.com/Content/Database/Concepts/databaseoverview.htm#moveRes).
For I(action=change_disaster_recovery_configuration), this operation updates the cross-region disaster recovery (DR) details of the standby Autonomous Database Serverless database, and must be run on the standby side.
For I(action=configure_autonomous_database_vault_key), configures the Autonomous Database Vault service L(key,https://docs.cloud.oracle.com/Content/KeyManagement/Concepts/keyoverview.htm#concepts).
For I(action=deregister_autonomous_database_data_safe), asynchronously deregisters this Autonomous Database with Data Safe.
For I(action=disable_autonomous_database_management), disables Database Management for the Autonomous Database resource.
For I(action=disable_autonomous_database_operations_insights), disables Operations Insights for the Autonomous Database resource.
For I(action=enable_autonomous_database_management), enables Database Management for Autonomous Database.
For I(action=enable_autonomous_database_operations_insights), enables the specified Autonomous Database with Operations Insights.
For I(action=fail_over), initiates a failover of the specified Autonomous Database to the associated peer database. Applicable only to databases with Disaster Recovery enabled. This API should be called in the remote region where the peer database resides. Below parameter is optional: - `peerDbId` Use this parameter to specify the database OCID of the Disaster Recovery peer, which is located in a different (remote) region from the current peer database. If this parameter is not provided, the failover will happen in the same region.
For I(action=generate_autonomous_database_wallet), creates and downloads a wallet for the specified Autonomous Database.
For I(action=register_autonomous_database_data_safe), asynchronously registers this Autonomous Database with Data Safe.
For I(action=restart), restarts the specified Autonomous Database.
For I(action=restore), restores an Autonomous Database based on the provided request parameters.
For I(action=rotate_autonomous_database_encryption_key), rotate existing AutonomousDatabase L(Vault service,https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm) key.
For I(action=shrink), this operation shrinks the current allocated storage down to the current actual used data storage (actualUsedDataStorageSizeInTBs). The if the base storage value for the database (dataStorageSizeInTBs) is larger than the actualUsedDataStorageSizeInTBs value, you are billed for the base storage value.
For I(action=start), starts the specified Autonomous Database.
For I(action=stop), stops the specified Autonomous Database.
For I(action=switchover), initiates a switchover of the specified Autonomous Database to the associated peer database. Applicable only to databases with Disaster Recovery enabled. This API should be called in the remote region where the peer database resides. Below parameter is optional: - `peerDbId` Use this parameter to specify the database OCID of the Disaster Recovery peer, which is located in a different (remote) region from the current peer database. If this parameter is not provided, the switchover will happen in the same region.
- name: Perform action autonomous_database_manual_refresh on autonomous_database oci_database_autonomous_database_actions: # required autonomous_database_id: "ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx" action: autonomous_database_manual_refresh # optional time_refresh_cutoff: time_refresh_cutoff_example
- name: Perform action change_compartment on autonomous_database oci_database_autonomous_database_actions: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" autonomous_database_id: "ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx" action: change_compartment
- name: Perform action change_disaster_recovery_configuration on autonomous_database oci_database_autonomous_database_actions: # required autonomous_database_id: "ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx" action: change_disaster_recovery_configuration # optional disaster_recovery_type: ADG time_snapshot_standby_enabled_till: time_snapshot_standby_enabled_till_example is_snapshot_standby: true
- name: Perform action configure_autonomous_database_vault_key on autonomous_database oci_database_autonomous_database_actions: # required autonomous_database_id: "ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx" action: configure_autonomous_database_vault_key # optional kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx" vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx" is_using_oracle_managed_keys: true
- name: Perform action deregister_autonomous_database_data_safe on autonomous_database oci_database_autonomous_database_actions: # required pdb_admin_password: example-password autonomous_database_id: "ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx" action: deregister_autonomous_database_data_safe
- name: Perform action disable_autonomous_database_management on autonomous_database oci_database_autonomous_database_actions: # required autonomous_database_id: "ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx" action: disable_autonomous_database_management
- name: Perform action disable_autonomous_database_operations_insights on autonomous_database oci_database_autonomous_database_actions: # required autonomous_database_id: "ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx" action: disable_autonomous_database_operations_insights
- name: Perform action enable_autonomous_database_management on autonomous_database oci_database_autonomous_database_actions: # required autonomous_database_id: "ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx" action: enable_autonomous_database_management
- name: Perform action enable_autonomous_database_operations_insights on autonomous_database oci_database_autonomous_database_actions: # required autonomous_database_id: "ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx" action: enable_autonomous_database_operations_insights
- name: Perform action fail_over on autonomous_database oci_database_autonomous_database_actions: # required autonomous_database_id: "ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx" action: fail_over # optional peer_db_id: "ocid1.peerdb.oc1..xxxxxxEXAMPLExxxxxx"
- name: Perform action generate_autonomous_database_wallet on autonomous_database oci_database_autonomous_database_actions: # required wallet_file: /tmp/atp_wallet.zip password: example-password autonomous_database_id: "ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx" action: generate_autonomous_database_wallet # optional force: true generate_type: ALL
- name: Perform action register_autonomous_database_data_safe on autonomous_database oci_database_autonomous_database_actions: # required pdb_admin_password: example-password autonomous_database_id: "ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx" action: register_autonomous_database_data_safe
- name: Perform action restart on autonomous_database oci_database_autonomous_database_actions: # required autonomous_database_id: "ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx" action: restart
- name: Perform action restore on autonomous_database oci_database_autonomous_database_actions: # required timestamp: timestamp_example autonomous_database_id: "ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx" action: restore # optional database_scn: database_scn_example latest: true
- name: Perform action rotate_autonomous_database_encryption_key on autonomous_database oci_database_autonomous_database_actions: # required autonomous_database_id: "ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx" action: rotate_autonomous_database_encryption_key
- name: Perform action shrink on autonomous_database oci_database_autonomous_database_actions: # required autonomous_database_id: "ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx" action: shrink
- name: Perform action start on autonomous_database oci_database_autonomous_database_actions: # required autonomous_database_id: "ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx" action: start
- name: Perform action stop on autonomous_database oci_database_autonomous_database_actions: # required autonomous_database_id: "ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx" action: stop
- name: Perform action switchover on autonomous_database oci_database_autonomous_database_actions: # required autonomous_database_id: "ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx" action: switchover # optional peer_db_id: "ocid1.peerdb.oc1..xxxxxxEXAMPLExxxxxx"
wait: default: true description: Whether to wait for create or delete operation to complete. type: bool force: aliases: - overwrite default: 'true' description: - Force overwriting existing wallet file when downloading wallet. - Applicable only for I(action=generate_autonomous_database_wallet). type: bool action: choices: - autonomous_database_manual_refresh - change_compartment - change_disaster_recovery_configuration - configure_autonomous_database_vault_key - deregister_autonomous_database_data_safe - disable_autonomous_database_management - disable_autonomous_database_operations_insights - enable_autonomous_database_management - enable_autonomous_database_operations_insights - fail_over - generate_autonomous_database_wallet - register_autonomous_database_data_safe - restart - restore - rotate_autonomous_database_encryption_key - shrink - start - stop - switchover description: - The action to perform on the AutonomousDatabase. required: true type: str latest: description: - Restores to the last known good state with the least possible data loss. - Applicable only for I(action=restore). type: bool region: description: - The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See C(config_file_location)). Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm) for more information on OCI regions. type: str tenancy: description: - OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See C(config_file_location)). To get the tenancy OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm) type: str api_user: description: - The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See C(config_file_location)). To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str password: description: - The password to encrypt the keys inside the wallet. The password must be at least 8 characters long and must include at least 1 letter and either 1 numeric character or 1 special character. - Required for I(action=generate_autonomous_database_wallet). type: str vault_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure L(vault,https://docs.cloud.oracle.com/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. - Applicable only for I(action=configure_autonomous_database_vault_key). type: str auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal - security_token default: api_key description: - The type of authentication to use for making API requests. By default C(auth_type="api_key") based authentication is performed and the API key (see I(api_user_key_file)) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use C(auth_type="instance_principal") to use instance principal based authentication when running ansible playbooks within an OCI compute instance. type: str timestamp: description: - The time to restore the database to. - Required for I(action=restore). type: str kms_key_id: description: - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. - Applicable only for I(action=configure_autonomous_database_vault_key). type: str peer_db_id: description: - 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. - Applicable only for I(action=fail_over)I(action=switchover). type: str cert_bundle: description: - The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used. type: str wallet_file: description: - The destination file path with file name when downloading wallet. The file must have 'zip' extension. I(wallet_file) is required if I(state='generate_wallet'). - Required for I(action=generate_autonomous_database_wallet). type: str auth_purpose: choices: - service_principal description: - The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None. type: str database_scn: description: - Restores using the backup with the System Change Number (SCN) specified. - Applicable only for I(action=restore). type: str wait_timeout: description: Time, in seconds, to wait when I(wait=yes). Defaults to 1200 for most of the services but some services might have a longer wait timeout. type: int generate_type: choices: - ALL - SINGLE description: - The type of wallet to generate. - '**Serverless instance usage:** * `SINGLE` - used to generate a wallet for a single database * `ALL` - used to generate wallet for all databases in the region' - '**Dedicated Exadata infrastructure usage:** Value must be `NULL` if attribute is used.' - Applicable only for I(action=generate_autonomous_database_wallet). type: str compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the resource to. - Required for I(action=change_compartment). type: str api_user_key_file: description: - Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See C(config_file_location)). If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option must also be provided. type: str pdb_admin_password: description: - The admin password provided during the creation of the database. This password is 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. - Required for I(action=deregister_autonomous_database_data_safe), I(action=register_autonomous_database_data_safe). type: str config_profile_name: description: - The profile to load from the config file referenced by C(config_file_location). If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in C(config_file_location). type: str is_snapshot_standby: description: - 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. - Applicable only for I(action=change_disaster_recovery_configuration). type: bool time_refresh_cutoff: description: - The timestamp to which the Autonomous Database refreshable clone will be refreshed. Changes made in the primary database after this timestamp are not part of the data refresh. - Applicable only for I(action=autonomous_database_manual_refresh). type: str api_user_fingerprint: description: - Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See C(config_file_location)). To get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str config_file_location: description: - Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config. type: str autonomous_database_id: aliases: - id description: - The database L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). required: true type: str disaster_recovery_type: choices: - ADG - BACKUP_BASED description: - 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. - Applicable only for I(action=change_disaster_recovery_configuration). type: str api_user_key_pass_phrase: description: - Passphrase used by the key referenced in C(api_user_key_file), if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See C(config_file_location)). type: str is_using_oracle_managed_keys: description: - True if disable Customer Managed Keys and use Oracle Managed Keys. - Applicable only for I(action=configure_autonomous_database_vault_key). type: bool time_snapshot_standby_enabled_till: description: - 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. - Applicable only for I(action=change_disaster_recovery_configuration). type: str realm_specific_endpoint_template_enabled: description: - Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used. type: bool
autonomous_database: contains: actual_used_data_storage_size_in_tbs: description: - The current amount of storage in use for user and system data, in terabytes (TB). returned: on success sample: 1.2 type: float allocated_storage_size_in_tbs: description: - 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.' returned: on success sample: 1.2 type: float apex_details: contains: apex_version: description: - The Oracle APEX Application Development version. returned: on success sample: apex_version_example type: str ords_version: description: - The Oracle REST Data Services (ORDS) version. returned: on success sample: ords_version_example type: str description: - Information about Oracle APEX Application Development. returned: on success type: complex are_primary_whitelisted_ips_used: description: - 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. returned: on success sample: true type: bool autonomous_container_database_id: description: - The Autonomous Container Database L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). Used only by Autonomous Database on Dedicated Exadata Infrastructure. returned: on success sample: ocid1.autonomouscontainerdatabase.oc1..xxxxxxEXAMPLExxxxxx type: str autonomous_maintenance_schedule_type: description: - 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 returned: on success sample: EARLY type: str available_upgrade_versions: description: - List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty. returned: on success sample: [] type: list backup_config: contains: manual_backup_bucket_name: description: - Name of L(Object Storage,https://docs.cloud.oracle.com/Content/Object/Concepts/objectstorageoverview.htm) bucket to use for storing manual backups. returned: on success sample: manual_backup_bucket_name_example type: str manual_backup_type: description: - The manual backup destination type. returned: on success sample: NONE type: str description: - '' returned: on success type: complex backup_retention_period_in_days: description: - Retention period, in days, for long-term backups returned: on success sample: 56 type: int character_set: description: - '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 returned: on success sample: character_set_example type: str compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment. returned: on success sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx type: str compute_count: description: - 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. returned: on success sample: 3.4 type: float compute_model: description: - 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. returned: on success sample: ECPU type: str connection_strings: contains: all_connection_strings: description: - Returns all connection strings that can be used to connect to the Autonomous Database. For more information, please see L(Predefined Database Service Names for Autonomous Transaction Processing,https://docs.oracle.com/en/cloud/paas/atp-cloud/atpug/connect-predefined.html#GUID-9747539B-FD46-44F1-8FF8-F5AC650F15BE) returned: on success sample: {} type: dict dedicated: description: - The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. returned: on success sample: dedicated_example type: str high: description: - 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. returned: on success sample: high_example type: str low: description: - The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. returned: on success sample: low_example type: str medium: description: - 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. returned: on success sample: medium_example type: str profiles: contains: consumer_group: description: - Consumer group used by the connection. returned: on success sample: HIGH type: str display_name: description: - A user-friendly name for the connection. returned: on success sample: display_name_example type: str host_format: description: - Host format used in connection string. returned: on success sample: FQDN type: str protocol: description: - Protocol used by the connection. returned: on success sample: TCP type: str session_mode: description: - 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. returned: on success sample: DIRECT type: str syntax_format: description: - 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. returned: on success sample: LONG type: str tls_authentication: description: - Specifies whether the TLS handshake is using one-way (`SERVER`) or mutual (`MUTUAL`) authentication. returned: on success sample: SERVER type: str value: description: - Connection string value. returned: on success sample: value_example type: str description: - A list of connection string profiles to allow clients to group, filter and select connection string values based on structured metadata. returned: on success type: complex description: - 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. returned: on success type: complex connection_urls: contains: apex_url: description: - Oracle Application Express (APEX) URL. returned: on success sample: apex_url_example type: str database_transforms_url: description: - The URL of the Database Transforms for the Autonomous Database. returned: on success sample: database_transforms_url_example type: str graph_studio_url: description: - The URL of the Graph Studio for the Autonomous Database. returned: on success sample: graph_studio_url_example type: str machine_learning_notebook_url: description: - The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database. returned: on success sample: machine_learning_notebook_url_example type: str machine_learning_user_management_url: description: - Oracle Machine Learning user management URL. returned: on success sample: machine_learning_user_management_url_example type: str mongo_db_url: description: - The URL of the MongoDB API for the Autonomous Database. returned: on success sample: mongo_db_url_example type: str ords_url: description: - The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database. returned: on success sample: ords_url_example type: str sql_dev_web_url: description: - Oracle SQL Developer Web URL. returned: on success sample: sql_dev_web_url_example type: str description: - '' returned: on success type: complex cpu_core_count: description: - 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 L(Characteristics of Infrastructure Shapes,https://www.oracle.com/pls/topic/lookup?ctx=en/cloud/paas/autonomous-database&id=ATPFG- GUID-B0F033C1-CC5A-42F0-B2E7-3CECFEDA1FD1) for shape details. - '**Note:** This parameter cannot be used with the `ocpuCount` parameter.' returned: on success sample: 56 type: int customer_contacts: contains: email: description: - The email address used by Oracle to send notifications regarding databases and infrastructure. returned: on success sample: email_example type: str description: - Customer Contacts. returned: on success type: complex data_safe_status: description: - Status of the Data Safe registration for this Autonomous Database. returned: on success sample: REGISTERING type: str data_storage_size_in_gbs: description: - The quantity of data in the database, in gigabytes. returned: on success sample: 56 type: int data_storage_size_in_tbs: description: - The quantity of data in the database, in terabytes. returned: on success sample: 56 type: int database_edition: description: - The Oracle Database Edition that applies to the Autonomous databases. returned: on success sample: STANDARD_EDITION type: str database_management_status: description: - Status of Database Management for this Autonomous Database. returned: on success sample: ENABLING type: str dataguard_region_type: description: - 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. returned: on success sample: PRIMARY_DG_REGION type: str db_name: description: - The database name. returned: on success sample: db_name_example type: str db_tools_details: contains: compute_count: description: - Compute used by database tools. returned: on success sample: 3.4 type: float is_enabled: description: - Indicates whether tool is enabled. returned: on success sample: true type: bool max_idle_time_in_minutes: description: - The max idle time, in minutes, after which the VM used by database tools will be terminated. returned: on success sample: 56 type: int name: description: - Name of database tool. returned: on success sample: APEX type: str description: - 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.' returned: on success type: complex db_version: description: - A valid Oracle Database version for Autonomous Database. returned: on success sample: db_version_example type: str db_workload: description: - '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.' returned: on success sample: OLTP type: str defined_tags: description: - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). returned: on success sample: Operations: CostCenter: US type: dict disaster_recovery_region_type: description: - 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. returned: on success sample: PRIMARY type: str display_name: description: - The user-friendly name for the Autonomous Database. The name does not have to be unique. returned: on success sample: display_name_example type: str failed_data_recovery_in_seconds: description: - Indicates the number of seconds of data loss for a Data Guard failover. returned: on success sample: 56 type: int freeform_tags: description: - 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 L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). - 'Example: `{"Department": "Finance"}`' returned: on success sample: Department: Finance type: dict id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Autonomous Database. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str in_memory_area_in_gbs: description: - The area assigned to In-Memory tables in Autonomous Database. returned: on success sample: 56 type: int in_memory_percentage: description: - 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. returned: on success sample: 56 type: int infrastructure_type: description: - The infrastructure type this resource belongs to. returned: on success sample: CLOUD type: str is_access_control_enabled: description: - 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. returned: on success sample: true type: bool is_auto_scaling_enabled: description: - Indicates if auto scaling is enabled for the Autonomous Database CPU core count. The default value is `TRUE`. returned: on success sample: true type: bool is_auto_scaling_for_storage_enabled: description: - Indicates if auto scaling is enabled for the Autonomous Database storage. The default value is `FALSE`. returned: on success sample: true type: bool is_data_guard_enabled: description: - '**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.' returned: on success sample: true type: bool is_dedicated: description: - True if the database uses L(dedicated Exadata infrastructure,https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html). returned: on success sample: true type: bool is_free_tier: description: - 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' returned: on success sample: true type: bool is_local_data_guard_enabled: description: - 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. returned: on success sample: true type: bool is_mtls_connection_required: description: - 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.' returned: on success sample: true type: bool is_preview: description: - Indicates if the Autonomous Database version is a preview version. returned: on success sample: true type: bool is_reconnect_clone_enabled: description: - Indicates if the refreshable clone can be reconnected to its source database. returned: on success sample: true type: bool is_refreshable_clone: description: - 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.' returned: on success sample: true type: bool is_remote_data_guard_enabled: description: - 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. returned: on success sample: true type: bool key_history_entry: contains: id: description: - The id of the Autonomous Database L(Vault,https://docs.cloud.oracle.com/Content/KeyManagement/Concepts/keyoverview.htm#concepts) service key management history entry. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str kms_key_version_id: description: - 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. returned: on success sample: ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx type: str time_activated: description: - The date and time the kms key activated. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str vault_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure L(vault,https://docs.cloud.oracle.com/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. returned: on success sample: ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx type: str description: - Key History Entry. returned: on success type: complex key_store_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the key store of Oracle Vault. returned: on success sample: ocid1.keystore.oc1..xxxxxxEXAMPLExxxxxx type: str key_store_wallet_name: description: - The wallet name for Oracle Key Vault. returned: on success sample: key_store_wallet_name_example type: str kms_key_id: description: - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. returned: on success sample: ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx type: str kms_key_lifecycle_details: description: - KMS key lifecycle details. returned: on success sample: kms_key_lifecycle_details_example type: str kms_key_version_id: description: - 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. returned: on success sample: ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx type: str license_model: description: - 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 L(Autonomous Database on dedicated Exadata infrastructure,https://docs.oracle.com/en/cloud/paas/autonomous- database/index.html), this attribute must be null. It is already set at the Autonomous Exadata Infrastructure level. When provisioning an L(Autonomous Database Serverless],https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) 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.' returned: on success sample: LICENSE_INCLUDED type: str lifecycle_details: description: - Information about the current lifecycle state. returned: on success sample: lifecycle_details_example type: str lifecycle_state: description: - The current state of the Autonomous Database. returned: on success sample: PROVISIONING type: str local_adg_auto_failover_max_data_loss_limit: description: - 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 returned: on success sample: 56 type: int local_disaster_recovery_type: description: - 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. returned: on success sample: local_disaster_recovery_type_example type: str local_standby_db: contains: lag_time_in_seconds: description: - 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. returned: on success sample: 56 type: int lifecycle_details: description: - Additional information about the current lifecycle state. returned: on success sample: lifecycle_details_example type: str lifecycle_state: description: - The current state of the Autonomous Database. returned: on success sample: PROVISIONING type: str time_data_guard_role_changed: description: - The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_disaster_recovery_role_changed: description: - The date and time the Disaster Recovery role was switched for the standby Autonomous Database. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str description: - '' returned: on success type: complex long_term_backup_schedule: contains: is_disabled: description: - Indicates if the long-term backup schedule should be deleted. The default value is `FALSE`. returned: on success sample: true type: bool repeat_cadence: description: - The frequency of the long-term backup schedule returned: on success sample: ONE_TIME type: str retention_period_in_days: description: - Retention period, in days, for long-term backups returned: on success sample: 56 type: int time_of_backup: description: - 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. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str description: - '' returned: on success type: complex memory_per_oracle_compute_unit_in_gbs: description: - The amount of memory (in GBs) enabled per ECPU or OCPU. returned: on success sample: 56 type: int ncharacter_set: description: - 'The national character set for the autonomous database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.' returned: on success sample: ncharacter_set_example type: str next_long_term_backup_time_stamp: description: - The date and time when the next long-term backup would be created. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str nsg_ids: description: - The list of L(OCIDs,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) 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 L(Security Rules,https://docs.cloud.oracle.com/Content/Network/Concepts/securityrules.htm). **NsgIds restrictions:** - A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty. returned: on success sample: [] type: list ocpu_count: description: - 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 L(Characteristics of Infrastructure Shapes,https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/index.html) for shape details. - '**Note:** This parameter cannot be used with the `cpuCoreCount` parameter.' returned: on success sample: 3.4 type: float open_mode: description: - 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.' returned: on success sample: READ_ONLY type: str operations_insights_status: description: - Status of Operations Insights for this Autonomous Database. returned: on success sample: ENABLING type: str peer_db_ids: description: - The list of L(OCIDs,https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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. returned: on success sample: [] type: list permission_level: description: - 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.' returned: on success sample: RESTRICTED type: str private_endpoint: description: - The private endpoint for the resource. returned: on success sample: private_endpoint_example type: str private_endpoint_ip: description: - The private endpoint Ip address for the resource. returned: on success sample: private_endpoint_ip_example type: str private_endpoint_label: description: - 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.' returned: on success sample: private_endpoint_label_example type: str provisionable_cpus: description: - An array of CPU values that an Autonomous Database can be scaled to. returned: on success sample: [] type: list refreshable_mode: description: - The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous Database. returned: on success sample: AUTOMATIC type: str refreshable_status: description: - The refresh status of the clone. REFRESHING indicates that the clone is currently being refreshed with data from the source Autonomous Database. returned: on success sample: REFRESHING type: str remote_disaster_recovery_configuration: contains: disaster_recovery_type: description: - 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. returned: on success sample: ADG type: str is_snapshot_standby: description: - 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. returned: on success sample: true type: bool time_snapshot_standby_enabled_till: description: - 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. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str description: - '' returned: on success type: complex resource_pool_leader_id: description: - The unique identifier for leader autonomous database OCID L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). returned: on success sample: ocid1.resourcepoolleader.oc1..xxxxxxEXAMPLExxxxxx type: str resource_pool_summary: contains: is_disabled: description: - Indicates if the resource pool should be deleted for the Autonomous Database. returned: on success sample: true type: bool pool_size: description: - Resource pool size. returned: on success sample: 56 type: int description: - '' returned: on success type: complex role: description: - The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled. returned: on success sample: PRIMARY type: str scheduled_operations: contains: day_of_week: contains: name: description: - Name of the day of the week. returned: on success sample: MONDAY type: str description: - '' returned: on success type: complex scheduled_start_time: description: - auto start time. value must be of ISO-8601 format "HH:mm" returned: on success sample: scheduled_start_time_example type: str scheduled_stop_time: description: - auto stop time. value must be of ISO-8601 format "HH:mm" returned: on success sample: scheduled_stop_time_example type: str description: - 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.' returned: on success type: complex service_console_url: description: - The URL of the Service Console for the Autonomous Database. returned: on success sample: service_console_url_example type: str source_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the source Autonomous Database that was cloned to create the current Autonomous Database. returned: on success sample: ocid1.source.oc1..xxxxxxEXAMPLExxxxxx type: str standby_db: contains: lag_time_in_seconds: description: - 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. returned: on success sample: 56 type: int lifecycle_details: description: - Additional information about the current lifecycle state. returned: on success sample: lifecycle_details_example type: str lifecycle_state: description: - The current state of the Autonomous Database. returned: on success sample: PROVISIONING type: str time_data_guard_role_changed: description: - The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_disaster_recovery_role_changed: description: - The date and time the Disaster Recovery role was switched for the standby Autonomous Database. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str description: - '**Deprecated** Autonomous Data Guard standby database details.' returned: on success type: complex standby_whitelisted_ips: description: - The client IP access control list (ACL). This feature is available for L(Autonomous Database Serverless],https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) 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.se a.<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.' returned: on success sample: [] type: list subnet_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) 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. returned: on success sample: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx type: str supported_regions_to_clone_to: description: - The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database. returned: on success sample: [] type: list system_tags: description: - System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). returned: on success sample: {} type: dict time_created: description: - The date and time the Autonomous Database was created. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_data_guard_role_changed: description: - 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. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_deletion_of_free_autonomous_database: description: - 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. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_disaster_recovery_role_changed: description: - The date and time the Disaster Recovery role was switched for the standby Autonomous Database. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_local_data_guard_enabled: description: - 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. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_maintenance_begin: description: - The date and time when maintenance will begin. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_maintenance_end: description: - The date and time when maintenance will end. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_of_joining_resource_pool: description: - The time the member joined the resource pool. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_of_last_failover: description: - The timestamp of the last failover operation. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_of_last_refresh: description: - The date and time when last refresh happened. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_of_last_refresh_point: description: - 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. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_of_last_switchover: description: - The timestamp of the last switchover operation for the Autonomous Database. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_of_next_refresh: description: - The date and time of next refresh. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_reclamation_of_free_autonomous_database: description: - 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. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_until_reconnect_clone_enabled: description: - 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. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str total_backup_storage_size_in_gbs: description: - The backup storage to the database. returned: on success sample: 1.2 type: float used_data_storage_size_in_gbs: description: - The storage space consumed by Autonomous Database in GBs. returned: on success sample: 56 type: int used_data_storage_size_in_tbs: description: - The amount of storage that has been used, in terabytes. returned: on success sample: 56 type: int vault_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure L(vault,https://docs.cloud.oracle.com/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. returned: on success sample: ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx type: str whitelisted_ips: description: - The client IP access control list (ACL). This feature is available for L(Autonomous Database Serverless],https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) 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.se a.<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.' returned: on success sample: [] type: list description: - Details of the AutonomousDatabase resource acted upon by the current operation returned: on success sample: actual_used_data_storage_size_in_tbs: 1.2 allocated_storage_size_in_tbs: 1.2 apex_details: apex_version: apex_version_example ords_version: ords_version_example are_primary_whitelisted_ips_used: true autonomous_container_database_id: ocid1.autonomouscontainerdatabase.oc1..xxxxxxEXAMPLExxxxxx autonomous_maintenance_schedule_type: EARLY available_upgrade_versions: [] backup_config: manual_backup_bucket_name: manual_backup_bucket_name_example manual_backup_type: NONE backup_retention_period_in_days: 56 character_set: character_set_example compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx compute_count: 3.4 compute_model: ECPU connection_strings: all_connection_strings: {} dedicated: dedicated_example high: high_example low: low_example medium: medium_example profiles: - consumer_group: HIGH display_name: display_name_example host_format: FQDN protocol: TCP session_mode: DIRECT syntax_format: LONG tls_authentication: SERVER value: value_example connection_urls: apex_url: apex_url_example database_transforms_url: database_transforms_url_example graph_studio_url: graph_studio_url_example machine_learning_notebook_url: machine_learning_notebook_url_example machine_learning_user_management_url: machine_learning_user_management_url_example mongo_db_url: mongo_db_url_example ords_url: ords_url_example sql_dev_web_url: sql_dev_web_url_example cpu_core_count: 56 customer_contacts: - email: email_example data_safe_status: REGISTERING data_storage_size_in_gbs: 56 data_storage_size_in_tbs: 56 database_edition: STANDARD_EDITION database_management_status: ENABLING dataguard_region_type: PRIMARY_DG_REGION db_name: db_name_example db_tools_details: - compute_count: 3.4 is_enabled: true max_idle_time_in_minutes: 56 name: APEX db_version: db_version_example db_workload: OLTP defined_tags: Operations: CostCenter: US disaster_recovery_region_type: PRIMARY display_name: display_name_example failed_data_recovery_in_seconds: 56 freeform_tags: Department: Finance id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx in_memory_area_in_gbs: 56 in_memory_percentage: 56 infrastructure_type: CLOUD is_access_control_enabled: true is_auto_scaling_enabled: true is_auto_scaling_for_storage_enabled: true is_data_guard_enabled: true is_dedicated: true is_free_tier: true is_local_data_guard_enabled: true is_mtls_connection_required: true is_preview: true is_reconnect_clone_enabled: true is_refreshable_clone: true is_remote_data_guard_enabled: true key_history_entry: - id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx kms_key_version_id: ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx time_activated: '2013-10-20T19:20:30+01:00' vault_id: ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx key_store_id: ocid1.keystore.oc1..xxxxxxEXAMPLExxxxxx key_store_wallet_name: key_store_wallet_name_example kms_key_id: ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx kms_key_lifecycle_details: kms_key_lifecycle_details_example kms_key_version_id: ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx license_model: LICENSE_INCLUDED lifecycle_details: lifecycle_details_example lifecycle_state: PROVISIONING local_adg_auto_failover_max_data_loss_limit: 56 local_disaster_recovery_type: local_disaster_recovery_type_example local_standby_db: lag_time_in_seconds: 56 lifecycle_details: lifecycle_details_example lifecycle_state: PROVISIONING time_data_guard_role_changed: '2013-10-20T19:20:30+01:00' time_disaster_recovery_role_changed: '2013-10-20T19:20:30+01:00' long_term_backup_schedule: is_disabled: true repeat_cadence: ONE_TIME retention_period_in_days: 56 time_of_backup: '2013-10-20T19:20:30+01:00' memory_per_oracle_compute_unit_in_gbs: 56 ncharacter_set: ncharacter_set_example next_long_term_backup_time_stamp: '2013-10-20T19:20:30+01:00' nsg_ids: [] ocpu_count: 3.4 open_mode: READ_ONLY operations_insights_status: ENABLING peer_db_ids: [] permission_level: RESTRICTED private_endpoint: private_endpoint_example private_endpoint_ip: private_endpoint_ip_example private_endpoint_label: private_endpoint_label_example provisionable_cpus: [] refreshable_mode: AUTOMATIC refreshable_status: REFRESHING remote_disaster_recovery_configuration: disaster_recovery_type: ADG is_snapshot_standby: true time_snapshot_standby_enabled_till: '2013-10-20T19:20:30+01:00' resource_pool_leader_id: ocid1.resourcepoolleader.oc1..xxxxxxEXAMPLExxxxxx resource_pool_summary: is_disabled: true pool_size: 56 role: PRIMARY scheduled_operations: - day_of_week: name: MONDAY scheduled_start_time: scheduled_start_time_example scheduled_stop_time: scheduled_stop_time_example service_console_url: service_console_url_example source_id: ocid1.source.oc1..xxxxxxEXAMPLExxxxxx standby_db: lag_time_in_seconds: 56 lifecycle_details: lifecycle_details_example lifecycle_state: PROVISIONING time_data_guard_role_changed: '2013-10-20T19:20:30+01:00' time_disaster_recovery_role_changed: '2013-10-20T19:20:30+01:00' standby_whitelisted_ips: [] subnet_id: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx supported_regions_to_clone_to: [] system_tags: {} time_created: '2013-10-20T19:20:30+01:00' time_data_guard_role_changed: '2013-10-20T19:20:30+01:00' time_deletion_of_free_autonomous_database: '2013-10-20T19:20:30+01:00' time_disaster_recovery_role_changed: '2013-10-20T19:20:30+01:00' time_local_data_guard_enabled: '2013-10-20T19:20:30+01:00' time_maintenance_begin: '2013-10-20T19:20:30+01:00' time_maintenance_end: '2013-10-20T19:20:30+01:00' time_of_joining_resource_pool: '2013-10-20T19:20:30+01:00' time_of_last_failover: '2013-10-20T19:20:30+01:00' time_of_last_refresh: '2013-10-20T19:20:30+01:00' time_of_last_refresh_point: '2013-10-20T19:20:30+01:00' time_of_last_switchover: '2013-10-20T19:20:30+01:00' time_of_next_refresh: '2013-10-20T19:20:30+01:00' time_reclamation_of_free_autonomous_database: '2013-10-20T19:20:30+01:00' time_until_reconnect_clone_enabled: '2013-10-20T19:20:30+01:00' total_backup_storage_size_in_gbs: 1.2 used_data_storage_size_in_gbs: 56 used_data_storage_size_in_tbs: 56 vault_id: ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx whitelisted_ips: [] type: complex