Oracle Cloud Infrastructure Documentation

Database Common Types

DBMS_CLOUD_OCI_DATABASE_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_varchar2_tbl FORCE IS TABLE OF (varchar2(32767)) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_ACD_AVM_RESOURCE_STATS_T Type

Resource usage by autonomous container database in a particular VM.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_acd_avm_resource_stats_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  provisioned_cpus number,
  used_cpus number,
  reserved_cpus number,
  reclaimable_cpus number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_acd_avm_resource_stats_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_acd_avm_resource_stats_t (
    id varchar2,
    display_name varchar2,
    provisioned_cpus number,
    used_cpus number,
    reserved_cpus number,
    reclaimable_cpus number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) The OCID of the Autonomous VM.

display_name

(optional) The user-friendly name for the Autonomous VM. The name does not need to be unique.

provisioned_cpus

(optional) CPUs/cores assigned to Autonomous Databases for the ACD instance in given Autonomus VM.

used_cpus

(optional) CPUs/cores assigned to the ACD instance in given Autonomous VM. Sum of provisioned, reserved and reclaimable CPUs/ cores to the ACD instance.

reserved_cpus

(optional) CPUs/cores reserved for scalability, resilliency and other overheads. This includes failover, autoscaling and idle instance overhead.

reclaimable_cpus

(optional) CPUs/cores that continue to be included in the count of OCPUs available to the Autonomous Container Database in given Autonomous VM, even after one of its Autonomous Database is terminated or scaled down. You can release them to the available OCPUs at its parent AVMC level by restarting the Autonomous Container Database.

DBMS_CLOUD_OCI_DATABASE_ACTIVATE_EXADATA_INFRASTRUCTURE_DETAILS_T Type

The activation details for the Exadata Cloud@Customer infrastructure. Applies to Exadata Cloud@Customer instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_activate_exadata_infrastructure_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  activation_file clob,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_activate_exadata_infrastructure_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_activate_exadata_infrastructure_details_t (
    activation_file clob
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

activation_file

(required) The activation zip file.

DBMS_CLOUD_OCI_DATABASE_CLOUD_DB_SERVER_DETAILS_T Type

Details of the ExaDB-D DB server. Applies to Exadata Cloud instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_cloud_db_server_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  db_server_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_cloud_db_server_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_cloud_db_server_details_t (
    db_server_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

db_server_id

(required) The OCID of ExaDB-D DB server.

DBMS_CLOUD_OCI_DATABASE_CLOUD_DB_SERVER_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_database_cloud_db_server_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_cloud_db_server_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_cloud_db_server_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_ADD_VIRTUAL_MACHINE_TO_CLOUD_VM_CLUSTER_DETAILS_T Type

Details of adding Virtual Machines to the Cloud VM Cluster. Applies to Exadata Cloud instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_add_virtual_machine_to_cloud_vm_cluster_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  db_servers dbms_cloud_oci_database_cloud_db_server_details_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_add_virtual_machine_to_cloud_vm_cluster_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_add_virtual_machine_to_cloud_vm_cluster_details_t (
    db_servers dbms_cloud_oci_database_cloud_db_server_details_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

db_servers

(required) The list of ExaCS DB servers for the cluster to be added.

DBMS_CLOUD_OCI_DATABASE_DB_SERVER_DETAILS_T Type

Details of the Exacc Db server. Applies to Exadata Cloud@Customer instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_db_server_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  db_server_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_server_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_server_details_t (
    db_server_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

db_server_id

(required) The OCID of Exacc Db server.

DBMS_CLOUD_OCI_DATABASE_DB_SERVER_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_database_db_server_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_db_server_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_db_server_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_ADD_VIRTUAL_MACHINE_TO_VM_CLUSTER_DETAILS_T Type

Details of adding Virtual Machines to the VM Cluster. Applies to Exadata Cloud@Customer instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_add_virtual_machine_to_vm_cluster_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  db_servers dbms_cloud_oci_database_db_server_details_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_add_virtual_machine_to_vm_cluster_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_add_virtual_machine_to_vm_cluster_details_t (
    db_servers dbms_cloud_oci_database_db_server_details_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

db_servers

(required) The list of Exacc DB servers for the cluster to be added.

DBMS_CLOUD_OCI_DATABASE_APP_VERSION_SUMMARY_T Type

The version details specific to an app.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_app_version_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  release_date varchar2(32767),
  end_of_support varchar2(32767),
  supported_app_name varchar2(32767),
  is_certified number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_app_version_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_app_version_summary_t (
    release_date varchar2,
    end_of_support varchar2,
    supported_app_name varchar2,
    is_certified number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

release_date

(required) The Autonomous Container Database version release date.

end_of_support

(required) The Autonomous Container Database version end of support date.

supported_app_name

(required) The name of the supported application.

is_certified

(required) Indicates if the image is certified.

DBMS_CLOUD_OCI_DATABASE_APPLICATION_VIP_T Type

Details of an application virtual IP (VIP) address.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_application_vip_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  cloud_vm_cluster_id varchar2(32767),
  compartment_id varchar2(32767),
  subnet_id varchar2(32767),
  ip_address varchar2(32767),
  hostname_label varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_assigned timestamp with time zone,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_application_vip_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_application_vip_t (
    id varchar2,
    cloud_vm_cluster_id varchar2,
    compartment_id varchar2,
    subnet_id varchar2,
    ip_address varchar2,
    hostname_label varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_assigned timestamp with time zone,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the application virtual IP (VIP) address.

cloud_vm_cluster_id

(required) The OCID of the cloud VM cluster associated with the application virtual IP (VIP) address.

compartment_id

(optional) The OCID of the compartment.

subnet_id

(optional) The OCID of the subnet associated with the application virtual IP (VIP) address.

ip_address

(optional) The application virtual IP (VIP) address.

hostname_label

(required) The hostname of the application virtual IP (VIP) address.

lifecycle_state

(required) The current lifecycle state of the application virtual IP (VIP) address.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'TERMINATING', 'TERMINATED', 'FAILED'

lifecycle_details

(optional) Additional information about the current lifecycle state of the application virtual IP (VIP) address.

time_assigned

(required) The date and time when the create operation for the application virtual IP (VIP) address completed.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_APPLICATION_VIP_SUMMARY_T Type

Details of an application virtual IP (VIP) address.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_application_vip_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  cloud_vm_cluster_id varchar2(32767),
  compartment_id varchar2(32767),
  subnet_id varchar2(32767),
  ip_address varchar2(32767),
  hostname_label varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_assigned timestamp with time zone,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_application_vip_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_application_vip_summary_t (
    id varchar2,
    cloud_vm_cluster_id varchar2,
    compartment_id varchar2,
    subnet_id varchar2,
    ip_address varchar2,
    hostname_label varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_assigned timestamp with time zone,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the application virtual IP (VIP) address.

cloud_vm_cluster_id

(required) The OCID of the cloud VM cluster associated with the application virtual IP (VIP) address.

compartment_id

(optional) The OCID of the compartment.

subnet_id

(optional) The OCID of the subnet associated with the application virtual IP (VIP) address.

ip_address

(optional) The application virtual IP (VIP) address.

hostname_label

(required) The hostname of the application virtual IP (VIP) address.

lifecycle_state

(required) The current lifecycle state of the application virtual IP (VIP) address.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'TERMINATING', 'TERMINATED', 'FAILED'

lifecycle_details

(optional) Additional information about the current lifecycle state of the application virtual IP (VIP) address.

time_assigned

(required) The date and time when the create operation for the application virtual IP (VIP) address completed.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_ASSOCIATED_DATABASE_DETAILS_T Type

Databases associated with a backup destination

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_associated_database_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  db_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_associated_database_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_associated_database_details_t (
    id varchar2,
    db_name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) The database OCID.

db_name

(optional) The display name of the database that is associated with the backup destination.

DBMS_CLOUD_OCI_DATABASE_MOUNT_TYPE_DETAILS_T Type

Mount type details for backup destination.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_mount_type_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  mount_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_mount_type_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_mount_type_details_t (
    mount_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

mount_type

(required) Mount type for backup destination.

Allowed values are: 'SELF_MOUNT', 'AUTOMATED_MOUNT'

DBMS_CLOUD_OCI_DATABASE_AUTOMATED_MOUNT_DETAILS_T Type

Used for creating NFS Auto Mount backup destinations for autonomous on ExaCC.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_automated_mount_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_mount_type_details_t (
  nfs_server dbms_cloud_oci_database_varchar2_tbl,
  nfs_server_export varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_automated_mount_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_automated_mount_details_t (
    mount_type varchar2,
    nfs_server dbms_cloud_oci_database_varchar2_tbl,
    nfs_server_export varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_automated_mount_details_t is a subtype of the dbms_cloud_oci_database_mount_type_details_t type.

Fields

Field Description

nfs_server

(required) IP addresses for NFS Auto mount.

nfs_server_export

(required) Specifies the directory on which to mount the file system

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_DATABASE_KEY_HISTORY_ENTRY_T Type

The Autonomous Database Vault service key management history entry.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_database_key_history_entry_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  kms_key_version_id varchar2(32767),
  vault_id varchar2(32767),
  time_activated timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_key_history_entry_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_key_history_entry_t (
    id varchar2,
    kms_key_version_id varchar2,
    vault_id varchar2,
    time_activated timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The id of the Autonomous Database Vault service key management history entry.

kms_key_version_id

(optional) 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.

vault_id

(optional) The OCID of the Oracle Cloud Infrastructure vault.

time_activated

(optional) The date and time the kms key activated.

DBMS_CLOUD_OCI_DATABASE_MONTH_T Type

Month of the year.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_month_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_month_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_month_t (
    name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) Name of the month of the year.

Allowed values are: 'JANUARY', 'FEBRUARY', 'MARCH', 'APRIL', 'MAY', 'JUNE', 'JULY', 'AUGUST', 'SEPTEMBER', 'OCTOBER', 'NOVEMBER', 'DECEMBER'

DBMS_CLOUD_OCI_DATABASE_DAY_OF_WEEK_T Type

Day of the week.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_day_of_week_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_day_of_week_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_day_of_week_t (
    name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) Name of the day of the week.

Allowed values are: 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY'

DBMS_CLOUD_OCI_DATABASE_MONTH_TBL Type

Nested table type of dbms_cloud_oci_database_month_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_month_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_month_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_NUMBER_TBL Type

Nested table type of number.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_number_tbl FORCE IS TABLE OF (number) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_DAY_OF_WEEK_TBL Type

Nested table type of dbms_cloud_oci_database_day_of_week_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_day_of_week_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_day_of_week_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_MAINTENANCE_WINDOW_T Type

The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_maintenance_window_t FORCE AUTHID CURRENT_USER IS OBJECT (
  preference varchar2(32767),
  patching_mode varchar2(32767),
  is_custom_action_timeout_enabled number,
  custom_action_timeout_in_mins number,
  is_monthly_patching_enabled number,
  months dbms_cloud_oci_database_month_tbl,
  weeks_of_month dbms_cloud_oci_database_number_tbl,
  days_of_week dbms_cloud_oci_database_day_of_week_tbl,
  hours_of_day dbms_cloud_oci_database_number_tbl,
  lead_time_in_weeks number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_maintenance_window_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_maintenance_window_t (
    preference varchar2,
    patching_mode varchar2,
    is_custom_action_timeout_enabled number,
    custom_action_timeout_in_mins number,
    is_monthly_patching_enabled number,
    months dbms_cloud_oci_database_month_tbl,
    weeks_of_month dbms_cloud_oci_database_number_tbl,
    days_of_week dbms_cloud_oci_database_day_of_week_tbl,
    hours_of_day dbms_cloud_oci_database_number_tbl,
    lead_time_in_weeks number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

preference

(optional) The maintenance window scheduling preference.

Allowed values are: 'NO_PREFERENCE', 'CUSTOM_PREFERENCE'

patching_mode

(optional) Cloud Exadata infrastructure node patching method, either \"ROLLING\" or \"NONROLLING\". Default value is ROLLING. *IMPORTANT*: Non-rolling infrastructure patching involves system down time. See Oracle-Managed Infrastructure Maintenance Updates for more information.

Allowed values are: 'ROLLING', 'NONROLLING'

is_custom_action_timeout_enabled

(optional) If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.

custom_action_timeout_in_mins

(optional) Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).

is_monthly_patching_enabled

(optional) If true, enables the monthly patching option.

months

(optional) Months during the year when maintenance should be performed.

weeks_of_month

(optional) Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.

days_of_week

(optional) Days during the week when maintenance should be performed.

hours_of_day

(optional) The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC

lead_time_in_weeks

(optional) Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.

DBMS_CLOUD_OCI_DATABASE_BACKUP_DESTINATION_DETAILS_T Type

Backup destination details

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_backup_destination_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  l_type varchar2(32767),
  id varchar2(32767),
  vpc_user varchar2(32767),
  vpc_password varchar2(32767),
  internet_proxy varchar2(32767),
  dbrs_policy_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_backup_destination_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_backup_destination_details_t (
    l_type varchar2,
    id varchar2,
    vpc_user varchar2,
    vpc_password varchar2,
    internet_proxy varchar2,
    dbrs_policy_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

l_type

(required) Type of the database backup destination.

Allowed values are: 'NFS', 'RECOVERY_APPLIANCE', 'OBJECT_STORE', 'LOCAL', 'DBRS'

id

(optional) The OCID of the backup destination.

vpc_user

(optional) For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.

vpc_password

(optional) For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.

internet_proxy

(optional) Proxy URL to connect to object store.

dbrs_policy_id

(optional) The OCID of the DBRS policy used for backup.

DBMS_CLOUD_OCI_DATABASE_BACKUP_DESTINATION_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_database_backup_destination_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_backup_destination_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_backup_destination_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_CONTAINER_DATABASE_BACKUP_CONFIG_T Type

Backup options for the Autonomous Container Database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_container_database_backup_config_t FORCE AUTHID CURRENT_USER IS OBJECT (
  backup_destination_details dbms_cloud_oci_database_backup_destination_details_tbl,
  recovery_window_in_days number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_container_database_backup_config_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_container_database_backup_config_t (
    backup_destination_details dbms_cloud_oci_database_backup_destination_details_tbl,
    recovery_window_in_days number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

backup_destination_details

(optional) Backup destination details.

recovery_window_in_days

(optional) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups. If the number of specified days is 0 then there will be no backups.

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_DATABASE_KEY_HISTORY_ENTRY_TBL Type

Nested table type of dbms_cloud_oci_database_autonomous_database_key_history_entry_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_database_key_history_entry_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_autonomous_database_key_history_entry_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_CONTAINER_DATABASE_T Type

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_container_database_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  db_unique_name varchar2(32767),
  db_name varchar2(32767),
  service_level_agreement_type varchar2(32767),
  autonomous_exadata_infrastructure_id varchar2(32767),
  autonomous_vm_cluster_id varchar2(32767),
  infrastructure_type varchar2(32767),
  cloud_autonomous_vm_cluster_id varchar2(32767),
  kms_key_id varchar2(32767),
  vault_id varchar2(32767),
  kms_key_version_id varchar2(32767),
  key_history_entry dbms_cloud_oci_database_autonomous_database_key_history_entry_tbl,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_created timestamp with time zone,
  time_snapshot_standby_revert timestamp with time zone,
  patch_model varchar2(32767),
  patch_id varchar2(32767),
  last_maintenance_run_id varchar2(32767),
  next_maintenance_run_id varchar2(32767),
  maintenance_window dbms_cloud_oci_database_maintenance_window_t,
  standby_maintenance_buffer_in_days number,
  version_preference varchar2(32767),
  is_dst_file_update_enabled number,
  dst_file_version varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  role varchar2(32767),
  availability_domain varchar2(32767),
  db_version varchar2(32767),
  backup_config dbms_cloud_oci_database_autonomous_container_database_backup_config_t,
  key_store_id varchar2(32767),
  key_store_wallet_name varchar2(32767),
  memory_per_oracle_compute_unit_in_g_bs number,
  available_cpus number,
  total_cpus number,
  reclaimable_cpus number,
  provisionable_cpus dbms_cloud_oci_database_number_tbl,
  compute_model varchar2(32767),
  provisioned_cpus number,
  reserved_cpus number,
  largest_provisionable_autonomous_database_in_cpus number,
  time_of_last_backup timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_container_database_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_container_database_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    db_unique_name varchar2,
    db_name varchar2,
    service_level_agreement_type varchar2,
    autonomous_exadata_infrastructure_id varchar2,
    autonomous_vm_cluster_id varchar2,
    infrastructure_type varchar2,
    cloud_autonomous_vm_cluster_id varchar2,
    kms_key_id varchar2,
    vault_id varchar2,
    kms_key_version_id varchar2,
    key_history_entry dbms_cloud_oci_database_autonomous_database_key_history_entry_tbl,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_created timestamp with time zone,
    time_snapshot_standby_revert timestamp with time zone,
    patch_model varchar2,
    patch_id varchar2,
    last_maintenance_run_id varchar2,
    next_maintenance_run_id varchar2,
    maintenance_window dbms_cloud_oci_database_maintenance_window_t,
    standby_maintenance_buffer_in_days number,
    version_preference varchar2,
    is_dst_file_update_enabled number,
    dst_file_version varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    role varchar2,
    availability_domain varchar2,
    db_version varchar2,
    backup_config dbms_cloud_oci_database_autonomous_container_database_backup_config_t,
    key_store_id varchar2,
    key_store_wallet_name varchar2,
    memory_per_oracle_compute_unit_in_g_bs number,
    available_cpus number,
    total_cpus number,
    reclaimable_cpus number,
    provisionable_cpus dbms_cloud_oci_database_number_tbl,
    compute_model varchar2,
    provisioned_cpus number,
    reserved_cpus number,
    largest_provisionable_autonomous_database_in_cpus number,
    time_of_last_backup timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Autonomous Container Database.

compartment_id

(required) The OCID of the compartment.

display_name

(required) The user-provided name for the Autonomous Container Database.

db_unique_name

(optional) **Deprecated.** The `DB_UNIQUE_NAME` value is set by Oracle Cloud Infrastructure. Do not specify a value for this parameter. Specifying a value for this field will cause Terraform operations to fail.

db_name

(optional) The Database name for the Autonomous Container Database. The name must be unique within the Cloud Autonomous VM Cluster, starting with an alphabetic character, followed by 1 to 7 alphanumeric characters.

service_level_agreement_type

(required) The service level agreement type of the container database. The default is STANDARD.

Allowed values are: 'STANDARD', 'MISSION_CRITICAL', 'AUTONOMOUS_DATAGUARD'

autonomous_exadata_infrastructure_id

(optional) **No longer used.** For Autonomous Database on dedicated Exadata infrastructure, the container database is created within a specified `cloudAutonomousVmCluster`.

autonomous_vm_cluster_id

(optional) The OCID of the Autonomous VM Cluster.

infrastructure_type

(optional) The infrastructure type this resource belongs to.

Allowed values are: 'CLOUD', 'CLOUD_AT_CUSTOMER'

cloud_autonomous_vm_cluster_id

(optional) The OCID of the cloud Autonomous Exadata VM Cluster.

kms_key_id

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

vault_id

(optional) The OCID of the Oracle Cloud Infrastructure vault.

kms_key_version_id

(optional) 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.

key_history_entry

(optional) Key History Entry.

lifecycle_state

(required) The current state of the Autonomous Container Database.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED', 'BACKUP_IN_PROGRESS', 'RESTORING', 'RESTORE_FAILED', 'RESTARTING', 'MAINTENANCE_IN_PROGRESS', 'ROLE_CHANGE_IN_PROGRESS', 'ENABLING_AUTONOMOUS_DATA_GUARD', 'UNAVAILABLE'

lifecycle_details

(optional) Additional information about the current lifecycle state.

time_created

(optional) The date and time the Autonomous Container Database was created.

time_snapshot_standby_revert

(optional) The date and time the Autonomous Container Database will be reverted to Standby from Snapshot Standby.

patch_model

(required) Database patch model preference.

Allowed values are: 'RELEASE_UPDATES', 'RELEASE_UPDATE_REVISIONS'

patch_id

(optional) The OCID of the last patch applied on the system.

last_maintenance_run_id

(optional) The OCID of the last maintenance run.

next_maintenance_run_id

(optional) The OCID of the next maintenance run.

maintenance_window

(optional)

standby_maintenance_buffer_in_days

(optional) The scheduling detail for the quarterly maintenance window of the standby Autonomous Container Database. This value represents the number of days before scheduled maintenance of the primary database.

version_preference

(optional) The next maintenance version preference.

Allowed values are: 'NEXT_RELEASE_UPDATE', 'LATEST_RELEASE_UPDATE'

is_dst_file_update_enabled

(optional) Indicates if an automatic DST Time Zone file update is enabled for the Autonomous Container Database. If enabled along with Release Update, patching will be done in a Non-Rolling manner.

dst_file_version

(optional) DST Time Zone File version of the Autonomous Container Database.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

role

(optional) The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.

Allowed values are: 'PRIMARY', 'STANDBY', 'DISABLED_STANDBY', 'BACKUP_COPY', 'SNAPSHOT_STANDBY'

availability_domain

(optional) The availability domain of the Autonomous Container Database.

db_version

(optional) Oracle Database version of the Autonomous Container Database.

backup_config

(optional)

key_store_id

(optional) The OCID of the key store.

key_store_wallet_name

(optional) The wallet name for Oracle Key Vault.

memory_per_oracle_compute_unit_in_g_bs

(optional) The amount of memory (in GBs) enabled per OCPU or ECPU in the Autonomous VM Cluster.

available_cpus

(optional) Sum of CPUs available on the Autonomous VM Cluster + Sum of reclaimable CPUs available in the Autonomous Container Database.<br> For Autonomous Databases on Dedicated Exadata Infrastructure, the CPU type (OCPUs or ECPUs) is determined by the parent Autonomous Exadata VM Cluster's compute model.

total_cpus

(optional) The number of CPUs allocated to the Autonomous VM cluster.<br> For Autonomous Databases on Dedicated Exadata Infrastructure, the CPU type (OCPUs or ECPUs) is determined by the parent Autonomous Exadata VM Cluster's compute model.

reclaimable_cpus

(optional) For Autonomous Databases on Dedicated Exadata Infrastructure: - These are the CPUs that continue to be included in the count of CPUs available to the Autonomous Container Database even after one of its Autonomous Database is terminated or scaled down. You can release them to the available CPUs at its parent Autonomous VM Cluster level by restarting the Autonomous Container Database. - The CPU type (OCPUs or ECPUs) is determined by the parent Autonomous Exadata VM Cluster's compute model.

provisionable_cpus

(optional) An array of CPU values that can be used to successfully provision a single Autonomous Database.\\ For Autonomous Database on Dedicated Exadata Infrastructure, the CPU type (OCPUs or ECPUs) is determined by the parent Autonomous Exadata VM Cluster's compute model.

compute_model

(optional) The compute model of the Autonomous VM Cluster.

Allowed values are: 'ECPU', 'OCPU'

provisioned_cpus

(optional) The number of CPUs provisioned in an Autonomous Container Database.

reserved_cpus

(optional) The number of CPUs reserved in an Autonomous Container Database.

largest_provisionable_autonomous_database_in_cpus

(optional) The largest Autonomous Database (CPU) that can be created in a new Autonomous Container Database.

time_of_last_backup

(optional) The timestamp of last successful backup. Here NULL value represents either there are no successful backups or backups are not configured for this Autonomous Container Database.

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_CONTAINER_DATABASE_DATAGUARD_ASSOCIATION_T Type

The properties that define Autonomous Data Guard association between two different Autonomous Container Databases.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_container_database_dataguard_association_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  autonomous_container_database_id varchar2(32767),
  role varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  peer_autonomous_container_database_dataguard_association_id varchar2(32767),
  peer_autonomous_container_database_id varchar2(32767),
  peer_role varchar2(32767),
  peer_lifecycle_state varchar2(32767),
  protection_mode varchar2(32767),
  fast_start_fail_over_lag_limit_in_seconds number,
  apply_lag varchar2(32767),
  apply_rate varchar2(32767),
  is_automatic_failover_enabled number,
  transport_lag varchar2(32767),
  time_last_synced timestamp with time zone,
  time_created timestamp with time zone,
  time_last_role_changed timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_container_database_dataguard_association_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_container_database_dataguard_association_t (
    id varchar2,
    autonomous_container_database_id varchar2,
    role varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    peer_autonomous_container_database_dataguard_association_id varchar2,
    peer_autonomous_container_database_id varchar2,
    peer_role varchar2,
    peer_lifecycle_state varchar2,
    protection_mode varchar2,
    fast_start_fail_over_lag_limit_in_seconds number,
    apply_lag varchar2,
    apply_rate varchar2,
    is_automatic_failover_enabled number,
    transport_lag varchar2,
    time_last_synced timestamp with time zone,
    time_created timestamp with time zone,
    time_last_role_changed timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Autonomous Data Guard created for a given Autonomous Container Database.

autonomous_container_database_id

(required) The OCID of the Autonomous Container Database that has a relationship with the peer Autonomous Container Database.

role

(required) The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.

Allowed values are: 'PRIMARY', 'STANDBY', 'DISABLED_STANDBY', 'BACKUP_COPY', 'SNAPSHOT_STANDBY'

lifecycle_state

(required) The current state of Autonomous Data Guard.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'ROLE_CHANGE_IN_PROGRESS', 'TERMINATING', 'TERMINATED', 'FAILED', 'UNAVAILABLE', 'UPDATING'

lifecycle_details

(optional) Additional information about the current lifecycleState, if available.

peer_autonomous_container_database_dataguard_association_id

(optional) The OCID of the peer Autonomous Container Database-Autonomous Data Guard association.

peer_autonomous_container_database_id

(optional) The OCID of the peer Autonomous Container Database.

peer_role

(required) The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.

Allowed values are: 'PRIMARY', 'STANDBY', 'DISABLED_STANDBY', 'BACKUP_COPY', 'SNAPSHOT_STANDBY'

peer_lifecycle_state

(optional) The current state of Autonomous Data Guard.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'ROLE_CHANGE_IN_PROGRESS', 'TERMINATING', 'TERMINATED', 'FAILED', 'UNAVAILABLE', 'UPDATING'

protection_mode

(optional) The protection mode of this Autonomous Data Guard association. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

Allowed values are: 'MAXIMUM_AVAILABILITY', 'MAXIMUM_PERFORMANCE'

fast_start_fail_over_lag_limit_in_seconds

(optional) The lag time for my preference based on data loss tolerance in seconds.

apply_lag

(optional) The lag time between updates to the primary Autonomous Container Database and application of the redo data on the standby Autonomous Container Database, as computed by the reporting database. Example: `9 seconds`

apply_rate

(optional) The rate at which redo logs are synchronized between the associated Autonomous Container Databases. Example: `180 Mb per second`

is_automatic_failover_enabled

(optional) Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association

transport_lag

(optional) The approximate number of seconds of redo data not yet available on the standby Autonomous Container Database, as computed by the reporting database. Example: `7 seconds`

time_last_synced

(optional) The date and time of the last update to the apply lag, apply rate, and transport lag values.

time_created

(optional) The date and time the Autonomous DataGuard association was created.

time_last_role_changed

(optional) The date and time when the last role change action happened.

DBMS_CLOUD_OCI_DATABASE_ACD_AVM_RESOURCE_STATS_TBL Type

Nested table type of dbms_cloud_oci_database_acd_avm_resource_stats_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_acd_avm_resource_stats_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_acd_avm_resource_stats_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_CONTAINER_DATABASE_RESOURCE_USAGE_T Type

Associated autonomous container databases usages.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_container_database_resource_usage_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  reclaimable_cpus number,
  available_cpus number,
  largest_provisionable_autonomous_database_in_cpus number,
  provisioned_cpus number,
  reserved_cpus number,
  used_cpus number,
  provisionable_cpus dbms_cloud_oci_database_number_tbl,
  autonomous_container_database_vm_usage dbms_cloud_oci_database_acd_avm_resource_stats_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_container_database_resource_usage_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_container_database_resource_usage_t (
    id varchar2,
    display_name varchar2,
    reclaimable_cpus number,
    available_cpus number,
    largest_provisionable_autonomous_database_in_cpus number,
    provisioned_cpus number,
    reserved_cpus number,
    used_cpus number,
    provisionable_cpus dbms_cloud_oci_database_number_tbl,
    autonomous_container_database_vm_usage dbms_cloud_oci_database_acd_avm_resource_stats_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) The OCID of the Autonomous Container Database.

display_name

(required) The user-friendly name for the Autonomous Container Database. The name does not need to be unique.

reclaimable_cpus

(optional) CPUs / cores reclaimable or released to cluster on Autonomous Container Database restart.

available_cpus

(optional) CPUs / cores available for ADB provisioning or scaling in the Autonomous Container Database.

largest_provisionable_autonomous_database_in_cpus

(optional) Largest provisionable ADB in the Autonomous Container Database.

provisioned_cpus

(optional) CPUs / cores assigned to ADBs in the Autonomous Container Database.

reserved_cpus

(optional) CPUs / cores reserved for scalability, resilliency and other overheads. This includes failover, autoscaling and idle instance overhead.

used_cpus

(optional) CPUs / cores assigned to the Autonomous Container Database. Sum of provisioned, reserved and reclaimable CPUs/ cores.

provisionable_cpus

(optional) Valid list of provisionable CPUs / cores for ADB creation.

autonomous_container_database_vm_usage

(optional) List of autonomous container database resource usage per autonomous virtual machine.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_CONTAINER_DATABASE_SUMMARY_T Type

An Autonomous Container Database is a container database service that enables the customer to host one or more databases within the container database. A basic container database runs on a single Autonomous Exadata Infrastructure from an availability domain without the Extreme Availability features enabled.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_container_database_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  db_unique_name varchar2(32767),
  db_name varchar2(32767),
  service_level_agreement_type varchar2(32767),
  autonomous_exadata_infrastructure_id varchar2(32767),
  autonomous_vm_cluster_id varchar2(32767),
  infrastructure_type varchar2(32767),
  cloud_autonomous_vm_cluster_id varchar2(32767),
  kms_key_id varchar2(32767),
  vault_id varchar2(32767),
  kms_key_version_id varchar2(32767),
  key_history_entry dbms_cloud_oci_database_autonomous_database_key_history_entry_tbl,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_created timestamp with time zone,
  time_snapshot_standby_revert timestamp with time zone,
  patch_model varchar2(32767),
  patch_id varchar2(32767),
  last_maintenance_run_id varchar2(32767),
  next_maintenance_run_id varchar2(32767),
  maintenance_window dbms_cloud_oci_database_maintenance_window_t,
  standby_maintenance_buffer_in_days number,
  version_preference varchar2(32767),
  is_dst_file_update_enabled number,
  dst_file_version varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  role varchar2(32767),
  availability_domain varchar2(32767),
  db_version varchar2(32767),
  backup_config dbms_cloud_oci_database_autonomous_container_database_backup_config_t,
  key_store_id varchar2(32767),
  key_store_wallet_name varchar2(32767),
  memory_per_oracle_compute_unit_in_g_bs number,
  available_cpus number,
  total_cpus number,
  reclaimable_cpus number,
  provisionable_cpus dbms_cloud_oci_database_number_tbl,
  compute_model varchar2(32767),
  provisioned_cpus number,
  reserved_cpus number,
  largest_provisionable_autonomous_database_in_cpus number,
  time_of_last_backup timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_container_database_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_container_database_summary_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    db_unique_name varchar2,
    db_name varchar2,
    service_level_agreement_type varchar2,
    autonomous_exadata_infrastructure_id varchar2,
    autonomous_vm_cluster_id varchar2,
    infrastructure_type varchar2,
    cloud_autonomous_vm_cluster_id varchar2,
    kms_key_id varchar2,
    vault_id varchar2,
    kms_key_version_id varchar2,
    key_history_entry dbms_cloud_oci_database_autonomous_database_key_history_entry_tbl,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_created timestamp with time zone,
    time_snapshot_standby_revert timestamp with time zone,
    patch_model varchar2,
    patch_id varchar2,
    last_maintenance_run_id varchar2,
    next_maintenance_run_id varchar2,
    maintenance_window dbms_cloud_oci_database_maintenance_window_t,
    standby_maintenance_buffer_in_days number,
    version_preference varchar2,
    is_dst_file_update_enabled number,
    dst_file_version varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    role varchar2,
    availability_domain varchar2,
    db_version varchar2,
    backup_config dbms_cloud_oci_database_autonomous_container_database_backup_config_t,
    key_store_id varchar2,
    key_store_wallet_name varchar2,
    memory_per_oracle_compute_unit_in_g_bs number,
    available_cpus number,
    total_cpus number,
    reclaimable_cpus number,
    provisionable_cpus dbms_cloud_oci_database_number_tbl,
    compute_model varchar2,
    provisioned_cpus number,
    reserved_cpus number,
    largest_provisionable_autonomous_database_in_cpus number,
    time_of_last_backup timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Autonomous Container Database.

compartment_id

(required) The OCID of the compartment.

display_name

(required) The user-provided name for the Autonomous Container Database.

db_unique_name

(optional) **Deprecated.** The `DB_UNIQUE_NAME` value is set by Oracle Cloud Infrastructure. Do not specify a value for this parameter. Specifying a value for this field will cause Terraform operations to fail.

db_name

(optional) The Database name for the Autonomous Container Database. The name must be unique within the Cloud Autonomous VM Cluster, starting with an alphabetic character, followed by 1 to 7 alphanumeric characters.

service_level_agreement_type

(required) The service level agreement type of the container database. The default is STANDARD.

Allowed values are: 'STANDARD', 'MISSION_CRITICAL', 'AUTONOMOUS_DATAGUARD'

autonomous_exadata_infrastructure_id

(optional) **No longer used.** For Autonomous Database on dedicated Exadata infrastructure, the container database is created within a specified `cloudAutonomousVmCluster`.

autonomous_vm_cluster_id

(optional) The OCID of the Autonomous VM Cluster.

infrastructure_type

(optional) The infrastructure type this resource belongs to.

Allowed values are: 'CLOUD', 'CLOUD_AT_CUSTOMER'

cloud_autonomous_vm_cluster_id

(optional) The OCID of the cloud Autonomous Exadata VM Cluster.

kms_key_id

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

vault_id

(optional) The OCID of the Oracle Cloud Infrastructure vault.

kms_key_version_id

(optional) 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.

key_history_entry

(optional) Key History Entry.

lifecycle_state

(required) The current state of the Autonomous Container Database.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED', 'BACKUP_IN_PROGRESS', 'RESTORING', 'RESTORE_FAILED', 'RESTARTING', 'MAINTENANCE_IN_PROGRESS', 'ROLE_CHANGE_IN_PROGRESS', 'ENABLING_AUTONOMOUS_DATA_GUARD', 'UNAVAILABLE'

lifecycle_details

(optional) Additional information about the current lifecycle state.

time_created

(optional) The date and time the Autonomous Container Database was created.

time_snapshot_standby_revert

(optional) The date and time the Autonomous Container Database will be reverted to Standby from Snapshot Standby.

patch_model

(required) Database patch model preference.

Allowed values are: 'RELEASE_UPDATES', 'RELEASE_UPDATE_REVISIONS'

patch_id

(optional) The OCID of the last patch applied on the system.

last_maintenance_run_id

(optional) The OCID of the last maintenance run.

next_maintenance_run_id

(optional) The OCID of the next maintenance run.

maintenance_window

(optional)

standby_maintenance_buffer_in_days

(optional) The scheduling detail for the quarterly maintenance window of the standby Autonomous Container Database. This value represents the number of days before scheduled maintenance of the primary database.

version_preference

(optional) The next maintenance version preference.

Allowed values are: 'NEXT_RELEASE_UPDATE', 'LATEST_RELEASE_UPDATE'

is_dst_file_update_enabled

(optional) Indicates if an automatic DST Time Zone file update is enabled for the Autonomous Container Database. If enabled along with Release Update, patching will be done in a Non-Rolling manner.

dst_file_version

(optional) DST Time Zone File version of the Autonomous Container Database.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

role

(optional) The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.

Allowed values are: 'PRIMARY', 'STANDBY', 'DISABLED_STANDBY', 'BACKUP_COPY', 'SNAPSHOT_STANDBY'

availability_domain

(optional) The availability domain of the Autonomous Container Database.

db_version

(optional) Oracle Database version of the Autonomous Container Database.

backup_config

(optional)

key_store_id

(optional) The OCID of the key store.

key_store_wallet_name

(optional) The wallet name for Oracle Key Vault.

memory_per_oracle_compute_unit_in_g_bs

(optional) The amount of memory (in GBs) enabled per OCPU or ECPU in the Autonomous VM Cluster.

available_cpus

(optional) Sum of CPUs available on the Autonomous VM Cluster + Sum of reclaimable CPUs available in the Autonomous Container Database.<br> For Autonomous Databases on Dedicated Exadata Infrastructure, the CPU type (OCPUs or ECPUs) is determined by the parent Autonomous Exadata VM Cluster's compute model.

total_cpus

(optional) The number of CPUs allocated to the Autonomous VM cluster.<br> For Autonomous Databases on Dedicated Exadata Infrastructure, the CPU type (OCPUs or ECPUs) is determined by the parent Autonomous Exadata VM Cluster's compute model.

reclaimable_cpus

(optional) For Autonomous Databases on Dedicated Exadata Infrastructure: - These are the CPUs that continue to be included in the count of CPUs available to the Autonomous Container Database even after one of its Autonomous Database is terminated or scaled down. You can release them to the available CPUs at its parent Autonomous VM Cluster level by restarting the Autonomous Container Database. - The CPU type (OCPUs or ECPUs) is determined by the parent Autonomous Exadata VM Cluster's compute model.

provisionable_cpus

(optional) An array of CPU values that can be used to successfully provision a single Autonomous Database.\\ For Autonomous Database on Dedicated Exadata Infrastructure, the CPU type (OCPUs or ECPUs) is determined by the parent Autonomous Exadata VM Cluster's compute model.

compute_model

(optional) The compute model of the Autonomous VM Cluster.

Allowed values are: 'ECPU', 'OCPU'

provisioned_cpus

(optional) The number of CPUs provisioned in an Autonomous Container Database.

reserved_cpus

(optional) The number of CPUs reserved in an Autonomous Container Database.

largest_provisionable_autonomous_database_in_cpus

(optional) The largest Autonomous Database (CPU) that can be created in a new Autonomous Container Database.

time_of_last_backup

(optional) The timestamp of last successful backup. Here NULL value represents either there are no successful backups or backups are not configured for this Autonomous Container Database.

DBMS_CLOUD_OCI_DATABASE_APP_VERSION_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_database_app_version_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_app_version_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_app_version_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_CONTAINER_DATABASE_VERSION_SUMMARY_T Type

The supported Autonomous Database version.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_container_database_version_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  version varchar2(32767),
  details varchar2(32767),
  supported_apps dbms_cloud_oci_database_app_version_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_container_database_version_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_container_database_version_summary_t (
    version varchar2,
    details varchar2,
    supported_apps dbms_cloud_oci_database_app_version_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

version

(required) A valid Oracle Database version for provisioning an Autonomous Container Database.

details

(optional) A URL that points to a detailed description of the Autonomous Container Database version.

supported_apps

(required) The list of applications supported for the given version.

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_DATA_WAREHOUSE_CONNECTION_STRINGS_T Type

**Deprecated.** For information about connection strings to connect to an Oracle Autonomous Data Warehouse, see AUTONOMOUS_DATABASE_CONNECTION_STRINGS Function.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_data_warehouse_connection_strings_t FORCE AUTHID CURRENT_USER IS OBJECT (
  high varchar2(32767),
  medium varchar2(32767),
  low varchar2(32767),
  all_connection_strings json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_data_warehouse_connection_strings_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_data_warehouse_connection_strings_t (
    high varchar2,
    medium varchar2,
    low varchar2,
    all_connection_strings json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

high

(optional) 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.

medium

(optional) 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.

low

(optional) The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.

all_connection_strings

(optional) Returns all connection strings that can be used to connect to the Autonomous Data Warehouse.

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_DATA_WAREHOUSE_T Type

**Deprecated.** See AUTONOMOUS_DATABASE Type for reference information about Autonomous Databases with the warehouse workload type.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_data_warehouse_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  db_name varchar2(32767),
  cpu_core_count number,
  data_storage_size_in_t_bs number,
  time_created timestamp with time zone,
  display_name varchar2(32767),
  service_console_url varchar2(32767),
  connection_strings dbms_cloud_oci_database_autonomous_data_warehouse_connection_strings_t,
  license_model varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  db_version varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_data_warehouse_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_data_warehouse_t (
    id varchar2,
    compartment_id varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    db_name varchar2,
    cpu_core_count number,
    data_storage_size_in_t_bs number,
    time_created timestamp with time zone,
    display_name varchar2,
    service_console_url varchar2,
    connection_strings dbms_cloud_oci_database_autonomous_data_warehouse_connection_strings_t,
    license_model varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    db_version varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Autonomous Data Warehouse.

compartment_id

(required) The OCID of the compartment.

lifecycle_state

(required) The current state of the database.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'STOPPING', 'STOPPED', 'STARTING', 'TERMINATING', 'TERMINATED', 'UNAVAILABLE', 'RESTORE_IN_PROGRESS', 'BACKUP_IN_PROGRESS', 'SCALE_IN_PROGRESS', 'AVAILABLE_NEEDS_ATTENTION', 'UPDATING'

lifecycle_details

(optional) Information about the current lifecycle state.

db_name

(required) The database name.

cpu_core_count

(required) The number of CPU cores to be made available to the database.

data_storage_size_in_t_bs

(required) The quantity of data in the database, in terabytes.

time_created

(optional) The date and time the database was created.

display_name

(optional) The user-friendly name for the Autonomous Data Warehouse. The name does not have to be unique.

service_console_url

(optional) The URL of the Service Console for the Data Warehouse.

connection_strings

(optional) The connection string used to connect to the Data Warehouse. The username for the Service Console is ADMIN. Use the password you entered when creating the Autonomous Data Warehouse for the password value.

license_model

(optional) The Oracle license model that applies to the Oracle Autonomous Data Warehouse. The default is BRING_YOUR_OWN_LICENSE.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

db_version

(optional) A valid Oracle Database version for Autonomous Data Warehouse.

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_DATA_WAREHOUSE_SUMMARY_T Type

**Deprecated.** See AUTONOMOUS_DATABASE Function for reference information about Autonomous Databases with the warehouse workload type. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_data_warehouse_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  db_name varchar2(32767),
  cpu_core_count number,
  data_storage_size_in_t_bs number,
  time_created timestamp with time zone,
  display_name varchar2(32767),
  service_console_url varchar2(32767),
  connection_strings dbms_cloud_oci_database_autonomous_data_warehouse_connection_strings_t,
  license_model varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  db_version varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_data_warehouse_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_data_warehouse_summary_t (
    id varchar2,
    compartment_id varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    db_name varchar2,
    cpu_core_count number,
    data_storage_size_in_t_bs number,
    time_created timestamp with time zone,
    display_name varchar2,
    service_console_url varchar2,
    connection_strings dbms_cloud_oci_database_autonomous_data_warehouse_connection_strings_t,
    license_model varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    db_version varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Autonomous Data Warehouse.

compartment_id

(required) The OCID of the compartment.

lifecycle_state

(required) The current state of the database.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'STOPPING', 'STOPPED', 'STARTING', 'TERMINATING', 'TERMINATED', 'UNAVAILABLE', 'RESTORE_IN_PROGRESS', 'BACKUP_IN_PROGRESS', 'SCALE_IN_PROGRESS', 'AVAILABLE_NEEDS_ATTENTION', 'UPDATING'

lifecycle_details

(optional) Information about the current lifecycle state.

db_name

(required) The database name.

cpu_core_count

(required) The number of CPU cores to be made available to the database.

data_storage_size_in_t_bs

(required) The quantity of data in the database, in terabytes.

time_created

(optional) The date and time the database was created.

display_name

(optional) The user-friendly name for the Autonomous Data Warehouse. The name does not have to be unique.

service_console_url

(optional) The URL of the Service Console for the Data Warehouse.

connection_strings

(optional) The connection string used to connect to the Data Warehouse. The username for the Service Console is ADMIN. Use the password you entered when creating the Autonomous Data Warehouse for the password value.

license_model

(optional) The Oracle license model that applies to the Oracle Autonomous Data Warehouse. The default is BRING_YOUR_OWN_LICENSE.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

db_version

(optional) A valid Oracle Database version for Autonomous Data Warehouse.

DBMS_CLOUD_OCI_DATABASE_LONG_TERM_BACK_UP_SCHEDULE_DETAILS_T Type

Details for the long-term backup schedule.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_long_term_back_up_schedule_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  repeat_cadence varchar2(32767),
  time_of_backup timestamp with time zone,
  retention_period_in_days number,
  is_disabled number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_long_term_back_up_schedule_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_long_term_back_up_schedule_details_t (
    repeat_cadence varchar2,
    time_of_backup timestamp with time zone,
    retention_period_in_days number,
    is_disabled number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

repeat_cadence

(optional) The frequency of the long-term backup schedule

Allowed values are: 'ONE_TIME', 'WEEKLY', 'MONTHLY', 'YEARLY'

time_of_backup

(optional) 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.

retention_period_in_days

(optional) Retention period, in days, for long-term backups

is_disabled

(optional) Indicates if the long-term backup schedule should be deleted. The default value is `FALSE`.

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_DATABASE_BACKUP_CONFIG_T Type

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

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_database_backup_config_t FORCE AUTHID CURRENT_USER IS OBJECT (
  manual_backup_bucket_name varchar2(32767),
  manual_backup_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_backup_config_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_backup_config_t (
    manual_backup_bucket_name varchar2,
    manual_backup_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

manual_backup_bucket_name

(optional) Name of Object Storage bucket to use for storing manual backups.

manual_backup_type

(optional) The manual backup destination type.

Allowed values are: 'NONE', 'OBJECT_STORE'

DBMS_CLOUD_OCI_DATABASE_DATABASE_CONNECTION_STRING_PROFILE_T Type

The connection string profile to allow clients to group, filter and select connection string values based on structured metadata.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_database_connection_string_profile_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  value varchar2(32767),
  consumer_group varchar2(32767),
  protocol varchar2(32767),
  tls_authentication varchar2(32767),
  host_format varchar2(32767),
  session_mode varchar2(32767),
  syntax_format varchar2(32767),
  is_regional number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_connection_string_profile_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_connection_string_profile_t (
    display_name varchar2,
    value varchar2,
    consumer_group varchar2,
    protocol varchar2,
    tls_authentication varchar2,
    host_format varchar2,
    session_mode varchar2,
    syntax_format varchar2,
    is_regional number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(required) A user-friendly name for the connection.

value

(required) Connection string value.

consumer_group

(optional) Consumer group used by the connection.

Allowed values are: 'HIGH', 'MEDIUM', 'LOW', 'TP', 'TPURGENT'

protocol

(required) Protocol used by the connection.

Allowed values are: 'TCP', 'TCPS'

tls_authentication

(optional) Specifies whether the TLS handshake is using one-way (`SERVER`) or mutual (`MUTUAL`) authentication.

Allowed values are: 'SERVER', 'MUTUAL'

host_format

(required) Host format used in connection string.

Allowed values are: 'FQDN', 'IP'

session_mode

(required) 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.

Allowed values are: 'DIRECT', 'REDIRECT'

syntax_format

(required) 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.

Allowed values are: 'LONG', 'EZCONNECT', 'EZCONNECTPLUS'

is_regional

(optional) True for a regional connection string, applicable to cross-region DG only.

DBMS_CLOUD_OCI_DATABASE_DATABASE_CONNECTION_STRING_PROFILE_TBL Type

Nested table type of dbms_cloud_oci_database_database_connection_string_profile_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_database_connection_string_profile_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_database_connection_string_profile_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_DATABASE_CONNECTION_STRINGS_T Type

Connection strings to connect to an Oracle Autonomous Database. Example output for connection strings. See DATABASE_CONNECTION_STRING_PROFILE Function for additional details: \"connectionStrings\": { \"allConnectionStrings\": { \"HIGH\": \"adb.region.oraclecloud.com:1522/unique_id_databasename_high.adwc.oraclecloud.com\", \"LOW\": \"adb.region.oraclecloud.com:1522/unique_id_databasename_low.adwc.oraclecloud.com\", \"MEDIUM\": \"adb.region.oraclecloud.com:1522/unique_id_databasename_medium.adwc.oraclecloud.com\" }, \"profiles\": [ { \"displayName\": \"databasename_high\", \"value\": \"(description= (retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=adb.region.oraclecloud.com))(connect_data=(service_name=unique_id_databasename_high.adwc.oraclecloud.com))(security=(ssl_server_cert_dn=\"CN=adwc.uscom-east-1.oraclecloud.com,OU=Oracle BMCS US,O=Oracle Corporation,L=Redwood City,ST=California,C=US\")))\", \"consumerGroup\": \"HIGH\", \"protocol\": \"TCPS\", \"tlsAuthentication\": \"MUTUAL\", \"hostFormat\": \"FQDN\", \"sessionMode\": \"DIRECT\", \"syntaxFormat\": \"LONG\" }, { \"displayName\": \"databasename_low\", \"value\": \"(description= (retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=adb.region.oraclecloud.com))(connect_data=(service_name=unique_id_databasename_low.adwc.oraclecloud.com))(security=(ssl_server_cert_dn=\"CN=adwc.uscom-east-1.oraclecloud.com,OU=Oracle BMCS US,O=Oracle Corporation,L=Redwood City,ST=California,C=US\")))\", \"consumerGroup\": \"LOW\", \"protocol\": \"TCPS\", \"tlsAuthentication\": \"MUTUAL\", \"hostFormat\": \"FQDN\", \"sessionMode\": \"DIRECT\", \"syntaxFormat\": \"LONG\" }, { \"displayName\": \"databasename_medium\", \"value\": \"(description= (retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=adb.region.oraclecloud.com))(connect_data=(service_name=unique_id_databasename_medium.adwc.oraclecloud.com))(security=(ssl_server_cert_dn=\"CN=adwc.uscom-east-1.oraclecloud.com,OU=Oracle BMCS US,O=Oracle Corporation,L=Redwood City,ST=California,C=US\")))\", \"consumerGroup\": \"MEDIUM\", \"protocol\": \"TCPS\", \"tlsAuthentication\": \"MUTUAL\", \"hostFormat\": \"FQDN\", \"sessionMode\": \"DIRECT\", \"syntaxFormat\": \"LONG\" } ], \"dedicated\": null, \"high\": \"adb.region.oraclecloud.com:1522/unique_id_databasename_high.adwc.oraclecloud.com\", \"low\": \"adb.region.oraclecloud.com:1522/unique_id_databasename_low.adwc.oraclecloud.com\", \"medium\": \"adb.region.oraclecloud.com:1522/unique_id_databasename_medium.adwc.oraclecloud.com\" }

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_database_connection_strings_t FORCE AUTHID CURRENT_USER IS OBJECT (
  high varchar2(32767),
  medium varchar2(32767),
  low varchar2(32767),
  dedicated varchar2(32767),
  all_connection_strings json_element_t,
  profiles dbms_cloud_oci_database_database_connection_string_profile_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_connection_strings_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_connection_strings_t (
    high varchar2,
    medium varchar2,
    low varchar2,
    dedicated varchar2,
    all_connection_strings json_element_t,
    profiles dbms_cloud_oci_database_database_connection_string_profile_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

high

(optional) 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.

medium

(optional) 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.

low

(optional) The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.

dedicated

(optional) The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.

all_connection_strings

(optional) Returns all connection strings that can be used to connect to the Autonomous Database.

profiles

(optional) A list of connection string profiles to allow clients to group, filter and select connection string values based on structured metadata.

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_DATABASE_CONNECTION_URLS_T Type

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...\"}`

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_database_connection_urls_t FORCE AUTHID CURRENT_USER IS OBJECT (
  sql_dev_web_url varchar2(32767),
  apex_url varchar2(32767),
  machine_learning_user_management_url varchar2(32767),
  graph_studio_url varchar2(32767),
  mongo_db_url varchar2(32767),
  machine_learning_notebook_url varchar2(32767),
  ords_url varchar2(32767),
  database_transforms_url varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_connection_urls_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_connection_urls_t (
    sql_dev_web_url varchar2,
    apex_url varchar2,
    machine_learning_user_management_url varchar2,
    graph_studio_url varchar2,
    mongo_db_url varchar2,
    machine_learning_notebook_url varchar2,
    ords_url varchar2,
    database_transforms_url varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

sql_dev_web_url

(optional) Oracle SQL Developer Web URL.

apex_url

(optional) Oracle Application Express (APEX) URL.

machine_learning_user_management_url

(optional) Oracle Machine Learning user management URL.

graph_studio_url

(optional) The URL of the Graph Studio for the Autonomous Database.

mongo_db_url

(optional) The URL of the MongoDB API for the Autonomous Database.

machine_learning_notebook_url

(optional) The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database.

ords_url

(optional) The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database.

database_transforms_url

(optional) The URL of the Database Transforms for the Autonomous Database.

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_DATABASE_APEX_T Type

Oracle APEX Application Development is a low-code development platform that enables you to build scalable, secure enterprise apps, with world-class features. Autonomous Database with the APEX workload type is optimized to support APEX development.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_database_apex_t FORCE AUTHID CURRENT_USER IS OBJECT (
  apex_version varchar2(32767),
  ords_version varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_apex_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_apex_t (
    apex_version varchar2,
    ords_version varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

apex_version

(optional) The Oracle APEX Application Development version.

ords_version

(optional) The Oracle REST Data Services (ORDS) version.

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_DATABASE_STANDBY_SUMMARY_T Type

Autonomous Data Guard standby database details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_database_standby_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  lag_time_in_seconds number,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_data_guard_role_changed timestamp with time zone,
  time_disaster_recovery_role_changed timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_standby_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_standby_summary_t (
    lag_time_in_seconds number,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_data_guard_role_changed timestamp with time zone,
    time_disaster_recovery_role_changed timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

lag_time_in_seconds

(optional) 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_state

(optional) The current state of the Autonomous Database.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'STOPPING', 'STOPPED', 'STARTING', 'TERMINATING', 'TERMINATED', 'UNAVAILABLE', 'RESTORE_IN_PROGRESS', 'RESTORE_FAILED', 'BACKUP_IN_PROGRESS', 'SCALE_IN_PROGRESS', 'AVAILABLE_NEEDS_ATTENTION', 'UPDATING', 'MAINTENANCE_IN_PROGRESS', 'RESTARTING', 'RECREATING', 'ROLE_CHANGE_IN_PROGRESS', 'UPGRADING', 'INACCESSIBLE', 'STANDBY'

lifecycle_details

(optional) Additional information about the current lifecycle state.

time_data_guard_role_changed

(optional) The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database.

time_disaster_recovery_role_changed

(optional) The date and time the Disaster Recovery role was switched for the standby Autonomous Database.

DBMS_CLOUD_OCI_DATABASE_CUSTOMER_CONTACT_T Type

Customer contact information that will be used by Oracle to provide notifications needed by database and infrastructure administrators.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_customer_contact_t FORCE AUTHID CURRENT_USER IS OBJECT (
  email varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_customer_contact_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_customer_contact_t (
    email varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

email

(optional) The email address used by Oracle to send notifications regarding databases and infrastructure.

DBMS_CLOUD_OCI_DATABASE_RESOURCE_POOL_SUMMARY_T Type

The configuration details for resource pool

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_resource_pool_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  pool_size number,
  is_disabled number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_resource_pool_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_resource_pool_summary_t (
    pool_size number,
    is_disabled number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

pool_size

(optional) Resource pool size.

is_disabled

(optional) Indicates if the resource pool should be deleted for the Autonomous Database.

DBMS_CLOUD_OCI_DATABASE_SCHEDULED_OPERATION_DETAILS_T Type

Details of scheduled operation.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_scheduled_operation_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  day_of_week dbms_cloud_oci_database_day_of_week_t,
  scheduled_start_time varchar2(32767),
  scheduled_stop_time varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_scheduled_operation_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_scheduled_operation_details_t (
    day_of_week dbms_cloud_oci_database_day_of_week_t,
    scheduled_start_time varchar2,
    scheduled_stop_time varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

day_of_week

(required)

scheduled_start_time

(optional) auto start time. value must be of ISO-8601 format \"HH:mm\"

scheduled_stop_time

(optional) auto stop time. value must be of ISO-8601 format \"HH:mm\"

DBMS_CLOUD_OCI_DATABASE_DATABASE_TOOL_T Type

Summary of database tools of autonomous database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_database_tool_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  is_enabled number,
  compute_count number,
  max_idle_time_in_minutes number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_tool_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_tool_t (
    name varchar2,
    is_enabled number,
    compute_count number,
    max_idle_time_in_minutes number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) Name of database tool.

Allowed values are: 'APEX', 'DATABASE_ACTIONS', 'GRAPH_STUDIO', 'OML', 'DATA_TRANSFORMS', 'ORDS', 'MONGODB_API'

is_enabled

(optional) Indicates whether tool is enabled.

compute_count

(optional) Compute used by database tools.

max_idle_time_in_minutes

(optional) The max idle time, in minutes, after which the VM used by database tools will be terminated.

DBMS_CLOUD_OCI_DATABASE_DISASTER_RECOVERY_CONFIGURATION_T Type

Configurations of a Disaster Recovery.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_disaster_recovery_configuration_t FORCE AUTHID CURRENT_USER IS OBJECT (
  disaster_recovery_type varchar2(32767),
  time_snapshot_standby_enabled_till timestamp with time zone,
  is_snapshot_standby number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_disaster_recovery_configuration_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_disaster_recovery_configuration_t (
    disaster_recovery_type varchar2,
    time_snapshot_standby_enabled_till timestamp with time zone,
    is_snapshot_standby number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

disaster_recovery_type

(optional) 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.

Allowed values are: 'ADG', 'BACKUP_BASED'

time_snapshot_standby_enabled_till

(optional) 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.

is_snapshot_standby

(optional) 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.

DBMS_CLOUD_OCI_DATABASE_CUSTOMER_CONTACT_TBL Type

Nested table type of dbms_cloud_oci_database_customer_contact_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_customer_contact_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_customer_contact_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_SCHEDULED_OPERATION_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_database_scheduled_operation_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_scheduled_operation_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_scheduled_operation_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_DATABASE_TOOL_TBL Type

Nested table type of dbms_cloud_oci_database_database_tool_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_database_tool_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_database_tool_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_DATABASE_T Type

An Oracle Autonomous Database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_database_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  kms_key_id varchar2(32767),
  vault_id varchar2(32767),
  kms_key_lifecycle_details varchar2(32767),
  kms_key_version_id varchar2(32767),
  db_name varchar2(32767),
  character_set varchar2(32767),
  ncharacter_set varchar2(32767),
  in_memory_percentage number,
  in_memory_area_in_g_bs number,
  next_long_term_backup_time_stamp timestamp with time zone,
  long_term_backup_schedule dbms_cloud_oci_database_long_term_back_up_schedule_details_t,
  is_free_tier number,
  system_tags json_element_t,
  time_reclamation_of_free_autonomous_database timestamp with time zone,
  time_deletion_of_free_autonomous_database timestamp with time zone,
  backup_config dbms_cloud_oci_database_autonomous_database_backup_config_t,
  key_history_entry dbms_cloud_oci_database_autonomous_database_key_history_entry_tbl,
  cpu_core_count number,
  local_adg_auto_failover_max_data_loss_limit number,
  compute_model varchar2(32767),
  compute_count number,
  backup_retention_period_in_days number,
  total_backup_storage_size_in_g_bs number,
  ocpu_count number,
  provisionable_cpus dbms_cloud_oci_database_number_tbl,
  data_storage_size_in_t_bs number,
  memory_per_oracle_compute_unit_in_g_bs number,
  data_storage_size_in_g_bs number,
  used_data_storage_size_in_g_bs number,
  infrastructure_type varchar2(32767),
  is_dedicated number,
  autonomous_container_database_id varchar2(32767),
  time_created timestamp with time zone,
  display_name varchar2(32767),
  service_console_url varchar2(32767),
  connection_strings dbms_cloud_oci_database_autonomous_database_connection_strings_t,
  connection_urls dbms_cloud_oci_database_autonomous_database_connection_urls_t,
  license_model varchar2(32767),
  used_data_storage_size_in_t_bs number,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  subnet_id varchar2(32767),
  nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  private_endpoint varchar2(32767),
  private_endpoint_label varchar2(32767),
  private_endpoint_ip varchar2(32767),
  db_version varchar2(32767),
  is_preview number,
  db_workload varchar2(32767),
  is_access_control_enabled number,
  whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
  are_primary_whitelisted_ips_used number,
  standby_whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
  apex_details dbms_cloud_oci_database_autonomous_database_apex_t,
  is_auto_scaling_enabled number,
  data_safe_status varchar2(32767),
  operations_insights_status varchar2(32767),
  database_management_status varchar2(32767),
  time_maintenance_begin timestamp with time zone,
  time_maintenance_end timestamp with time zone,
  is_refreshable_clone number,
  time_of_last_refresh timestamp with time zone,
  time_of_last_refresh_point timestamp with time zone,
  time_of_next_refresh timestamp with time zone,
  open_mode varchar2(32767),
  refreshable_status varchar2(32767),
  refreshable_mode varchar2(32767),
  source_id varchar2(32767),
  permission_level varchar2(32767),
  time_of_last_switchover timestamp with time zone,
  time_of_last_failover timestamp with time zone,
  is_data_guard_enabled number,
  failed_data_recovery_in_seconds number,
  standby_db dbms_cloud_oci_database_autonomous_database_standby_summary_t,
  is_local_data_guard_enabled number,
  is_remote_data_guard_enabled number,
  local_standby_db dbms_cloud_oci_database_autonomous_database_standby_summary_t,
  role varchar2(32767),
  available_upgrade_versions dbms_cloud_oci_database_varchar2_tbl,
  key_store_id varchar2(32767),
  key_store_wallet_name varchar2(32767),
  supported_regions_to_clone_to dbms_cloud_oci_database_varchar2_tbl,
  customer_contacts dbms_cloud_oci_database_customer_contact_tbl,
  time_local_data_guard_enabled timestamp with time zone,
  dataguard_region_type varchar2(32767),
  time_data_guard_role_changed timestamp with time zone,
  peer_db_ids dbms_cloud_oci_database_varchar2_tbl,
  is_mtls_connection_required number,
  time_of_joining_resource_pool timestamp with time zone,
  resource_pool_leader_id varchar2(32767),
  resource_pool_summary dbms_cloud_oci_database_resource_pool_summary_t,
  is_reconnect_clone_enabled number,
  time_until_reconnect_clone_enabled timestamp with time zone,
  autonomous_maintenance_schedule_type varchar2(32767),
  scheduled_operations dbms_cloud_oci_database_scheduled_operation_details_tbl,
  is_auto_scaling_for_storage_enabled number,
  allocated_storage_size_in_t_bs number,
  actual_used_data_storage_size_in_t_bs number,
  max_cpu_core_count number,
  database_edition varchar2(32767),
  db_tools_details dbms_cloud_oci_database_database_tool_tbl,
  local_disaster_recovery_type varchar2(32767),
  disaster_recovery_region_type varchar2(32767),
  time_disaster_recovery_role_changed timestamp with time zone,
  remote_disaster_recovery_configuration dbms_cloud_oci_database_disaster_recovery_configuration_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_t (
    id varchar2,
    compartment_id varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    kms_key_id varchar2,
    vault_id varchar2,
    kms_key_lifecycle_details varchar2,
    kms_key_version_id varchar2,
    db_name varchar2,
    character_set varchar2,
    ncharacter_set varchar2,
    in_memory_percentage number,
    in_memory_area_in_g_bs number,
    next_long_term_backup_time_stamp timestamp with time zone,
    long_term_backup_schedule dbms_cloud_oci_database_long_term_back_up_schedule_details_t,
    is_free_tier number,
    system_tags json_element_t,
    time_reclamation_of_free_autonomous_database timestamp with time zone,
    time_deletion_of_free_autonomous_database timestamp with time zone,
    backup_config dbms_cloud_oci_database_autonomous_database_backup_config_t,
    key_history_entry dbms_cloud_oci_database_autonomous_database_key_history_entry_tbl,
    cpu_core_count number,
    local_adg_auto_failover_max_data_loss_limit number,
    compute_model varchar2,
    compute_count number,
    backup_retention_period_in_days number,
    total_backup_storage_size_in_g_bs number,
    ocpu_count number,
    provisionable_cpus dbms_cloud_oci_database_number_tbl,
    data_storage_size_in_t_bs number,
    memory_per_oracle_compute_unit_in_g_bs number,
    data_storage_size_in_g_bs number,
    used_data_storage_size_in_g_bs number,
    infrastructure_type varchar2,
    is_dedicated number,
    autonomous_container_database_id varchar2,
    time_created timestamp with time zone,
    display_name varchar2,
    service_console_url varchar2,
    connection_strings dbms_cloud_oci_database_autonomous_database_connection_strings_t,
    connection_urls dbms_cloud_oci_database_autonomous_database_connection_urls_t,
    license_model varchar2,
    used_data_storage_size_in_t_bs number,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    subnet_id varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    private_endpoint varchar2,
    private_endpoint_label varchar2,
    private_endpoint_ip varchar2,
    db_version varchar2,
    is_preview number,
    db_workload varchar2,
    is_access_control_enabled number,
    whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
    are_primary_whitelisted_ips_used number,
    standby_whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
    apex_details dbms_cloud_oci_database_autonomous_database_apex_t,
    is_auto_scaling_enabled number,
    data_safe_status varchar2,
    operations_insights_status varchar2,
    database_management_status varchar2,
    time_maintenance_begin timestamp with time zone,
    time_maintenance_end timestamp with time zone,
    is_refreshable_clone number,
    time_of_last_refresh timestamp with time zone,
    time_of_last_refresh_point timestamp with time zone,
    time_of_next_refresh timestamp with time zone,
    open_mode varchar2,
    refreshable_status varchar2,
    refreshable_mode varchar2,
    source_id varchar2,
    permission_level varchar2,
    time_of_last_switchover timestamp with time zone,
    time_of_last_failover timestamp with time zone,
    is_data_guard_enabled number,
    failed_data_recovery_in_seconds number,
    standby_db dbms_cloud_oci_database_autonomous_database_standby_summary_t,
    is_local_data_guard_enabled number,
    is_remote_data_guard_enabled number,
    local_standby_db dbms_cloud_oci_database_autonomous_database_standby_summary_t,
    role varchar2,
    available_upgrade_versions dbms_cloud_oci_database_varchar2_tbl,
    key_store_id varchar2,
    key_store_wallet_name varchar2,
    supported_regions_to_clone_to dbms_cloud_oci_database_varchar2_tbl,
    customer_contacts dbms_cloud_oci_database_customer_contact_tbl,
    time_local_data_guard_enabled timestamp with time zone,
    dataguard_region_type varchar2,
    time_data_guard_role_changed timestamp with time zone,
    peer_db_ids dbms_cloud_oci_database_varchar2_tbl,
    is_mtls_connection_required number,
    time_of_joining_resource_pool timestamp with time zone,
    resource_pool_leader_id varchar2,
    resource_pool_summary dbms_cloud_oci_database_resource_pool_summary_t,
    is_reconnect_clone_enabled number,
    time_until_reconnect_clone_enabled timestamp with time zone,
    autonomous_maintenance_schedule_type varchar2,
    scheduled_operations dbms_cloud_oci_database_scheduled_operation_details_tbl,
    is_auto_scaling_for_storage_enabled number,
    allocated_storage_size_in_t_bs number,
    actual_used_data_storage_size_in_t_bs number,
    max_cpu_core_count number,
    database_edition varchar2,
    db_tools_details dbms_cloud_oci_database_database_tool_tbl,
    local_disaster_recovery_type varchar2,
    disaster_recovery_region_type varchar2,
    time_disaster_recovery_role_changed timestamp with time zone,
    remote_disaster_recovery_configuration dbms_cloud_oci_database_disaster_recovery_configuration_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Autonomous Database.

compartment_id

(required) The OCID of the compartment.

lifecycle_state

(required) The current state of the Autonomous Database.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'STOPPING', 'STOPPED', 'STARTING', 'TERMINATING', 'TERMINATED', 'UNAVAILABLE', 'RESTORE_IN_PROGRESS', 'RESTORE_FAILED', 'BACKUP_IN_PROGRESS', 'SCALE_IN_PROGRESS', 'AVAILABLE_NEEDS_ATTENTION', 'UPDATING', 'MAINTENANCE_IN_PROGRESS', 'RESTARTING', 'RECREATING', 'ROLE_CHANGE_IN_PROGRESS', 'UPGRADING', 'INACCESSIBLE', 'STANDBY'

lifecycle_details

(optional) Information about the current lifecycle state.

kms_key_id

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

vault_id

(optional) The OCID of the Oracle Cloud Infrastructure vault.

kms_key_lifecycle_details

(optional) KMS key lifecycle details.

kms_key_version_id

(optional) 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.

db_name

(required) The database name.

character_set

(optional) 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

ncharacter_set

(optional) The national character set for the autonomous database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

in_memory_percentage

(optional) The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous Database.

in_memory_area_in_g_bs

(optional) The area assigned to In-Memory tables in Autonomous Database.

next_long_term_backup_time_stamp

(optional) The date and time when the next long-term backup would be created.

long_term_backup_schedule

(optional)

is_free_tier

(optional) 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

system_tags

(optional) System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

time_reclamation_of_free_autonomous_database

(optional) 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_deletion_of_free_autonomous_database

(optional) 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.

backup_config

(optional)

key_history_entry

(optional) Key History Entry.

cpu_core_count

(optional) The number of OCPU cores to be made available to the database. When the ECPU is selected, the value for cpuCoreCount is 0. 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 `ocpuCount` parameter.

local_adg_auto_failover_max_data_loss_limit

(optional) 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

compute_model

(optional) 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.

Allowed values are: 'ECPU', 'OCPU'

compute_count

(optional) The compute amount 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 values in multiples of two. Required when using the `computeModel` parameter. When using `cpuCoreCount` parameter, it is an error to specify computeCount to a non-null value.

backup_retention_period_in_days

(optional) Retention period, in days, for long-term backups

total_backup_storage_size_in_g_bs

(optional) The backup storage to the database.

ocpu_count

(optional) 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 1 or more cores, you must 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 shared and dedicated Exadata infrastructure. 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.

provisionable_cpus

(optional) An array of CPU values that an Autonomous Database can be scaled to.

data_storage_size_in_t_bs

(required) The quantity of data in the database, in terabytes.

memory_per_oracle_compute_unit_in_g_bs

(optional) The amount of memory (in GBs) enabled per OCPU or ECPU.

data_storage_size_in_g_bs

(optional) The quantity of data in the database, in gigabytes.

used_data_storage_size_in_g_bs

(optional) The storage space consumed by Autonomous Database in GBs.

infrastructure_type

(optional) The infrastructure type this resource belongs to.

Allowed values are: 'CLOUD', 'CLOUD_AT_CUSTOMER'

is_dedicated

(optional) True if the database uses dedicated Exadata infrastructure.

autonomous_container_database_id

(optional) The Autonomous Container Database OCID.

time_created

(optional) The date and time the Autonomous Database was created.

display_name

(optional) The user-friendly name for the Autonomous Database. The name does not have to be unique.

service_console_url

(optional) The URL of the Service Console for the Autonomous Database.

connection_strings

(optional) 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.

connection_urls

(optional)

license_model

(optional) 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`. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, maxCpuCoreCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

used_data_storage_size_in_t_bs

(optional) The amount of storage that has been used, in terabytes.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

subnet_id

(optional) The OCID of the subnet the resource is associated with. **Subnet Restrictions:** - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. - For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20. - For Autonomous Database, setting this will disable public secure access to the database. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.

nsg_ids

(optional) The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. **NsgIds restrictions:** - A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

private_endpoint

(optional) The private endpoint for the resource.

private_endpoint_label

(optional) The resource's private endpoint label. Setting this to an empty string, after the creation of the private endpoint database, changes the private endpoint database to a public endpoint database. 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.

private_endpoint_ip

(optional) The private endpoint Ip address for the resource.

db_version

(optional) A valid Oracle Database version for Autonomous Database.

is_preview

(optional) Indicates if the Autonomous Database version is a preview version.

db_workload

(optional) The Autonomous Database workload type. The following values are valid: - OLTP - indicates an Autonomous Transaction Processing database - DW - indicates an Autonomous Data Warehouse database - AJD - indicates an Autonomous JSON Database - APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

Allowed values are: 'OLTP', 'DW', 'AJD', 'APEX'

is_access_control_enabled

(optional) 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.

whitelisted_ips

(optional) 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. 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). Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. 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.

are_primary_whitelisted_ips_used

(optional) 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.

standby_whitelisted_ips

(optional) 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. 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). Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. 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.

apex_details

(optional) Information about Oracle APEX Application Development.

is_auto_scaling_enabled

(optional) Indicates if auto scaling is enabled for the Autonomous Database CPU core count.

data_safe_status

(optional) Status of the Data Safe registration for this Autonomous Database.

Allowed values are: 'REGISTERING', 'REGISTERED', 'DEREGISTERING', 'NOT_REGISTERED', 'FAILED'

operations_insights_status

(optional) Status of Operations Insights for this Autonomous Database.

Allowed values are: 'ENABLING', 'ENABLED', 'DISABLING', 'NOT_ENABLED', 'FAILED_ENABLING', 'FAILED_DISABLING'

database_management_status

(optional) Status of Database Management for this Autonomous Database.

Allowed values are: 'ENABLING', 'ENABLED', 'DISABLING', 'NOT_ENABLED', 'FAILED_ENABLING', 'FAILED_DISABLING'

time_maintenance_begin

(optional) The date and time when maintenance will begin.

time_maintenance_end

(optional) The date and time when maintenance will end.

is_refreshable_clone

(optional) 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.

time_of_last_refresh

(optional) The date and time when last refresh happened.

time_of_last_refresh_point

(optional) 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_next_refresh

(optional) The date and time of next refresh.

open_mode

(optional) Indicates the Autonomous Database mode. The database can be opened in `READ_ONLY` or `READ_WRITE` mode. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

Allowed values are: 'READ_ONLY', 'READ_WRITE'

refreshable_status

(optional) The refresh status of the clone. REFRESHING indicates that the clone is currently being refreshed with data from the source Autonomous Database.

Allowed values are: 'REFRESHING', 'NOT_REFRESHING'

refreshable_mode

(optional) The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous Database.

Allowed values are: 'AUTOMATIC', 'MANUAL'

source_id

(optional) The OCID of the source Autonomous Database that was cloned to create the current Autonomous Database.

permission_level

(optional) The Autonomous Database permission level. Restricted mode allows access only by admin users. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

Allowed values are: 'RESTRICTED', 'UNRESTRICTED'

time_of_last_switchover

(optional) The timestamp of the last switchover operation for the Autonomous Database.

time_of_last_failover

(optional) The timestamp of the last failover operation.

is_data_guard_enabled

(optional) **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.

failed_data_recovery_in_seconds

(optional) Indicates the number of seconds of data loss for a Data Guard failover.

standby_db

(optional) **Deprecated** Autonomous Data Guard standby database details.

is_local_data_guard_enabled

(optional) 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_remote_data_guard_enabled

(optional) 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.

local_standby_db

(optional)

role

(optional) The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.

Allowed values are: 'PRIMARY', 'STANDBY', 'DISABLED_STANDBY', 'BACKUP_COPY', 'SNAPSHOT_STANDBY'

available_upgrade_versions

(optional) List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty.

key_store_id

(optional) The OCID of the key store.

key_store_wallet_name

(optional) The wallet name for Oracle Key Vault.

supported_regions_to_clone_to

(optional) The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database.

customer_contacts

(optional) Customer Contacts.

time_local_data_guard_enabled

(optional) 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.

dataguard_region_type

(optional) 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.

Allowed values are: 'PRIMARY_DG_REGION', 'REMOTE_STANDBY_DG_REGION'

time_data_guard_role_changed

(optional) 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.

peer_db_ids

(optional) 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.

is_mtls_connection_required

(optional) Specifies if the Autonomous Database requires mTLS connections. This may not be updated in parallel with any of the following: licenseModel, databaseEdition, cpuCoreCount, computeCount, maxCpuCoreCount, 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.

time_of_joining_resource_pool

(optional) The time the member joined the resource pool.

resource_pool_leader_id

(optional) The unique identifier for leader autonomous database OCID OCID.

resource_pool_summary

(optional)

is_reconnect_clone_enabled

(optional) Indicates if the refreshable clone can be reconnected to its source database.

time_until_reconnect_clone_enabled

(optional) 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.

autonomous_maintenance_schedule_type

(optional) 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

Allowed values are: 'EARLY', 'REGULAR'

scheduled_operations

(optional) The list of scheduled operations. 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.

is_auto_scaling_for_storage_enabled

(optional) Indicates if auto scaling is enabled for the Autonomous Database storage. The default value is `FALSE`.

allocated_storage_size_in_t_bs

(optional) 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.

actual_used_data_storage_size_in_t_bs

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

max_cpu_core_count

(optional) The number of Max OCPU cores to be made available to the autonomous database with auto scaling of cpu enabled.

database_edition

(optional) The Oracle Database Edition that applies to the Autonomous databases.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION'

db_tools_details

(optional) 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.

local_disaster_recovery_type

(optional) 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.

disaster_recovery_region_type

(optional) 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.

Allowed values are: 'PRIMARY', 'REMOTE'

time_disaster_recovery_role_changed

(optional) The date and time the Disaster Recovery role was switched for the standby Autonomous Database.

remote_disaster_recovery_configuration

(optional)

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_DATABASE_BACKUP_T Type

An Autonomous Database backup.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_database_backup_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  autonomous_database_id varchar2(32767),
  display_name varchar2(32767),
  l_type varchar2(32767),
  is_automatic number,
  time_started timestamp with time zone,
  time_ended timestamp with time zone,
  lifecycle_details varchar2(32767),
  database_size_in_t_bs number,
  lifecycle_state varchar2(32767),
  is_restorable number,
  key_store_id varchar2(32767),
  key_store_wallet_name varchar2(32767),
  kms_key_id varchar2(32767),
  vault_id varchar2(32767),
  kms_key_version_id varchar2(32767),
  retention_period_in_days number,
  time_available_till timestamp with time zone,
  db_version varchar2(32767),
  size_in_t_bs number,
  backup_destination_details dbms_cloud_oci_database_backup_destination_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_backup_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_backup_t (
    id varchar2,
    compartment_id varchar2,
    autonomous_database_id varchar2,
    display_name varchar2,
    l_type varchar2,
    is_automatic number,
    time_started timestamp with time zone,
    time_ended timestamp with time zone,
    lifecycle_details varchar2,
    database_size_in_t_bs number,
    lifecycle_state varchar2,
    is_restorable number,
    key_store_id varchar2,
    key_store_wallet_name varchar2,
    kms_key_id varchar2,
    vault_id varchar2,
    kms_key_version_id varchar2,
    retention_period_in_days number,
    time_available_till timestamp with time zone,
    db_version varchar2,
    size_in_t_bs number,
    backup_destination_details dbms_cloud_oci_database_backup_destination_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Autonomous Database backup.

compartment_id

(required) The OCID of the compartment.

autonomous_database_id

(required) The OCID of the Autonomous Database.

display_name

(required) The user-friendly name for the backup. The name does not have to be unique.

l_type

(required) The type of backup.

Allowed values are: 'INCREMENTAL', 'FULL', 'LONGTERM'

is_automatic

(required) Indicates whether the backup is user-initiated or automatic.

time_started

(optional) The date and time the backup started.

time_ended

(optional) The date and time the backup completed.

lifecycle_details

(optional) Additional information about the current lifecycle state.

database_size_in_t_bs

(optional) The size of the database in terabytes at the time the backup was taken.

lifecycle_state

(required) The current state of the backup.

Allowed values are: 'CREATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED', 'UPDATING'

is_restorable

(optional) Indicates whether the backup can be used to restore the associated Autonomous Database.

key_store_id

(optional) The OCID of the key store.

key_store_wallet_name

(optional) The wallet name for Oracle Key Vault.

kms_key_id

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

vault_id

(optional) The OCID of the Oracle Cloud Infrastructure vault.

kms_key_version_id

(optional) 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.

retention_period_in_days

(optional) Retention period, in days, for long-term backups

time_available_till

(optional) Timestamp until when the backup will be available

db_version

(optional) A valid Oracle Database version for Autonomous Database.

size_in_t_bs

(optional) The backup size in terrabytes (TB).

backup_destination_details

(optional)

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_DATABASE_BACKUP_SUMMARY_T Type

An Autonomous Database backup. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_database_backup_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  autonomous_database_id varchar2(32767),
  display_name varchar2(32767),
  l_type varchar2(32767),
  is_automatic number,
  time_started timestamp with time zone,
  time_ended timestamp with time zone,
  lifecycle_details varchar2(32767),
  database_size_in_t_bs number,
  lifecycle_state varchar2(32767),
  is_restorable number,
  key_store_id varchar2(32767),
  key_store_wallet_name varchar2(32767),
  kms_key_id varchar2(32767),
  vault_id varchar2(32767),
  kms_key_version_id varchar2(32767),
  retention_period_in_days number,
  time_available_till timestamp with time zone,
  db_version varchar2(32767),
  size_in_t_bs number,
  backup_destination_details dbms_cloud_oci_database_backup_destination_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_backup_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_backup_summary_t (
    id varchar2,
    compartment_id varchar2,
    autonomous_database_id varchar2,
    display_name varchar2,
    l_type varchar2,
    is_automatic number,
    time_started timestamp with time zone,
    time_ended timestamp with time zone,
    lifecycle_details varchar2,
    database_size_in_t_bs number,
    lifecycle_state varchar2,
    is_restorable number,
    key_store_id varchar2,
    key_store_wallet_name varchar2,
    kms_key_id varchar2,
    vault_id varchar2,
    kms_key_version_id varchar2,
    retention_period_in_days number,
    time_available_till timestamp with time zone,
    db_version varchar2,
    size_in_t_bs number,
    backup_destination_details dbms_cloud_oci_database_backup_destination_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Autonomous Database backup.

compartment_id

(required) The OCID of the compartment.

autonomous_database_id

(required) The OCID of the Autonomous Database.

display_name

(required) The user-friendly name for the backup. The name does not have to be unique.

l_type

(required) The type of backup.

Allowed values are: 'INCREMENTAL', 'FULL', 'LONGTERM'

is_automatic

(required) Indicates whether the backup is user-initiated or automatic.

time_started

(optional) The date and time the backup started.

time_ended

(optional) The date and time the backup completed.

lifecycle_details

(optional) Additional information about the current lifecycle state.

database_size_in_t_bs

(optional) The size of the database in terabytes at the time the backup was taken.

lifecycle_state

(required) The current state of the backup.

Allowed values are: 'CREATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED', 'UPDATING'

is_restorable

(optional) Indicates whether the backup can be used to restore the associated Autonomous Database.

key_store_id

(optional) The OCID of the key store.

key_store_wallet_name

(optional) The wallet name for Oracle Key Vault.

kms_key_id

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

vault_id

(optional) The OCID of the Oracle Cloud Infrastructure vault.

kms_key_version_id

(optional) 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.

retention_period_in_days

(optional) Retention period, in days, for long-term backups

time_available_till

(optional) Timestamp until when the backup will be available

db_version

(optional) A valid Oracle Database version for Autonomous Database.

size_in_t_bs

(optional) The backup size in terrabytes (TB).

backup_destination_details

(optional)

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_DATABASE_CHARACTER_SETS_T Type

The Oracle Autonomous Database supported character sets. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_database_character_sets_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_character_sets_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_character_sets_t (
    name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(optional) A valid Oracle character set.

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_DATABASE_CONSOLE_TOKEN_DETAILS_T Type

The token that allows the OCI Console to access the Autonomous Database Service Console.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_database_console_token_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  token varchar2(32767),
  login_url varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_console_token_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_console_token_details_t (
    token varchar2,
    login_url varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

token

(optional) The token that allows the OCI Console to access the Autonomous Transaction Processing Service Console.

login_url

(optional) The login URL that allows the OCI Console to access the Autonomous Transaction Processing Service Console.

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_DATABASE_DATAGUARD_ASSOCIATION_T Type

The properties that define dataguard association between two different Autonomous Databases. Note that Autonomous Databases inherit DataGuard association from parent Autonomous Container Database. No actions can be taken on AutonomousDatabaseDataguardAssociation, usage is strictly informational.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_database_dataguard_association_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  autonomous_database_id varchar2(32767),
  role varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  peer_role varchar2(32767),
  peer_autonomous_database_id varchar2(32767),
  peer_autonomous_database_life_cycle_state varchar2(32767),
  protection_mode varchar2(32767),
  apply_lag varchar2(32767),
  apply_rate varchar2(32767),
  is_automatic_failover_enabled number,
  transport_lag varchar2(32767),
  time_last_synced timestamp with time zone,
  time_created timestamp with time zone,
  time_last_role_changed timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_dataguard_association_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_dataguard_association_t (
    id varchar2,
    autonomous_database_id varchar2,
    role varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    peer_role varchar2,
    peer_autonomous_database_id varchar2,
    peer_autonomous_database_life_cycle_state varchar2,
    protection_mode varchar2,
    apply_lag varchar2,
    apply_rate varchar2,
    is_automatic_failover_enabled number,
    transport_lag varchar2,
    time_last_synced timestamp with time zone,
    time_created timestamp with time zone,
    time_last_role_changed timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Autonomous Dataguard created for Autonomous Container Database where given Autonomous Database resides in.

autonomous_database_id

(required) The OCID of the Autonomous Database that has a relationship with the peer Autonomous Database.

role

(required) The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.

Allowed values are: 'PRIMARY', 'STANDBY', 'DISABLED_STANDBY', 'BACKUP_COPY', 'SNAPSHOT_STANDBY'

lifecycle_state

(required) The current state of Autonomous Data Guard.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'ROLE_CHANGE_IN_PROGRESS', 'TERMINATING', 'TERMINATED', 'FAILED', 'UNAVAILABLE', 'UPDATING'

lifecycle_details

(optional) Additional information about the current lifecycleState, if available.

peer_role

(required) The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.

Allowed values are: 'PRIMARY', 'STANDBY', 'DISABLED_STANDBY', 'BACKUP_COPY', 'SNAPSHOT_STANDBY'

peer_autonomous_database_id

(optional) The OCID of the peer Autonomous Database.

peer_autonomous_database_life_cycle_state

(optional) The current state of Autonomous Data Guard.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'ROLE_CHANGE_IN_PROGRESS', 'TERMINATING', 'TERMINATED', 'FAILED', 'UNAVAILABLE', 'UPDATING'

protection_mode

(optional) The protection mode of this Autonomous Data Guard association. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

Allowed values are: 'MAXIMUM_AVAILABILITY', 'MAXIMUM_PERFORMANCE'

apply_lag

(optional) The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: `9 seconds`

apply_rate

(optional) The rate at which redo logs are synced between the associated databases. Example: `180 Mb per second`

is_automatic_failover_enabled

(optional) Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association

transport_lag

(optional) The approximate number of seconds of redo data not yet available on the standby Autonomous Container Database, as computed by the reporting database. Example: `7 seconds`

time_last_synced

(optional) The date and time of the last update to the apply lag, apply rate, and transport lag values.

time_created

(optional) The date and time the Data Guard association was created.

time_last_role_changed

(optional) The date and time when the last role change action happened.

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_DATABASE_MANUAL_REFRESH_DETAILS_T Type

Details of manual refresh for an Autonomous Database refreshable clone.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_database_manual_refresh_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  time_refresh_cutoff timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_manual_refresh_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_manual_refresh_details_t (
    time_refresh_cutoff timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

time_refresh_cutoff

(optional) 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.

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_DATABASE_SUMMARY_T Type

An Oracle Autonomous Database. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_database_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  kms_key_id varchar2(32767),
  vault_id varchar2(32767),
  kms_key_lifecycle_details varchar2(32767),
  kms_key_version_id varchar2(32767),
  db_name varchar2(32767),
  character_set varchar2(32767),
  ncharacter_set varchar2(32767),
  in_memory_percentage number,
  in_memory_area_in_g_bs number,
  next_long_term_backup_time_stamp timestamp with time zone,
  long_term_backup_schedule dbms_cloud_oci_database_long_term_back_up_schedule_details_t,
  is_free_tier number,
  system_tags json_element_t,
  time_reclamation_of_free_autonomous_database timestamp with time zone,
  time_deletion_of_free_autonomous_database timestamp with time zone,
  backup_config dbms_cloud_oci_database_autonomous_database_backup_config_t,
  key_history_entry dbms_cloud_oci_database_autonomous_database_key_history_entry_tbl,
  cpu_core_count number,
  local_adg_auto_failover_max_data_loss_limit number,
  compute_model varchar2(32767),
  compute_count number,
  backup_retention_period_in_days number,
  total_backup_storage_size_in_g_bs number,
  ocpu_count number,
  provisionable_cpus dbms_cloud_oci_database_number_tbl,
  data_storage_size_in_t_bs number,
  memory_per_oracle_compute_unit_in_g_bs number,
  data_storage_size_in_g_bs number,
  used_data_storage_size_in_g_bs number,
  infrastructure_type varchar2(32767),
  is_dedicated number,
  autonomous_container_database_id varchar2(32767),
  time_created timestamp with time zone,
  display_name varchar2(32767),
  service_console_url varchar2(32767),
  connection_strings dbms_cloud_oci_database_autonomous_database_connection_strings_t,
  connection_urls dbms_cloud_oci_database_autonomous_database_connection_urls_t,
  license_model varchar2(32767),
  used_data_storage_size_in_t_bs number,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  subnet_id varchar2(32767),
  nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  private_endpoint varchar2(32767),
  private_endpoint_label varchar2(32767),
  private_endpoint_ip varchar2(32767),
  db_version varchar2(32767),
  is_preview number,
  db_workload varchar2(32767),
  is_access_control_enabled number,
  whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
  are_primary_whitelisted_ips_used number,
  standby_whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
  apex_details dbms_cloud_oci_database_autonomous_database_apex_t,
  is_auto_scaling_enabled number,
  data_safe_status varchar2(32767),
  operations_insights_status varchar2(32767),
  database_management_status varchar2(32767),
  time_maintenance_begin timestamp with time zone,
  time_maintenance_end timestamp with time zone,
  is_refreshable_clone number,
  time_of_last_refresh timestamp with time zone,
  time_of_last_refresh_point timestamp with time zone,
  time_of_next_refresh timestamp with time zone,
  open_mode varchar2(32767),
  refreshable_status varchar2(32767),
  refreshable_mode varchar2(32767),
  source_id varchar2(32767),
  permission_level varchar2(32767),
  time_of_last_switchover timestamp with time zone,
  time_of_last_failover timestamp with time zone,
  is_data_guard_enabled number,
  failed_data_recovery_in_seconds number,
  standby_db dbms_cloud_oci_database_autonomous_database_standby_summary_t,
  is_local_data_guard_enabled number,
  is_remote_data_guard_enabled number,
  local_standby_db dbms_cloud_oci_database_autonomous_database_standby_summary_t,
  role varchar2(32767),
  available_upgrade_versions dbms_cloud_oci_database_varchar2_tbl,
  key_store_id varchar2(32767),
  key_store_wallet_name varchar2(32767),
  supported_regions_to_clone_to dbms_cloud_oci_database_varchar2_tbl,
  customer_contacts dbms_cloud_oci_database_customer_contact_tbl,
  time_local_data_guard_enabled timestamp with time zone,
  dataguard_region_type varchar2(32767),
  time_data_guard_role_changed timestamp with time zone,
  peer_db_ids dbms_cloud_oci_database_varchar2_tbl,
  is_mtls_connection_required number,
  time_of_joining_resource_pool timestamp with time zone,
  resource_pool_leader_id varchar2(32767),
  resource_pool_summary dbms_cloud_oci_database_resource_pool_summary_t,
  is_reconnect_clone_enabled number,
  time_until_reconnect_clone_enabled timestamp with time zone,
  autonomous_maintenance_schedule_type varchar2(32767),
  scheduled_operations dbms_cloud_oci_database_scheduled_operation_details_tbl,
  is_auto_scaling_for_storage_enabled number,
  allocated_storage_size_in_t_bs number,
  actual_used_data_storage_size_in_t_bs number,
  max_cpu_core_count number,
  database_edition varchar2(32767),
  db_tools_details dbms_cloud_oci_database_database_tool_tbl,
  local_disaster_recovery_type varchar2(32767),
  disaster_recovery_region_type varchar2(32767),
  time_disaster_recovery_role_changed timestamp with time zone,
  remote_disaster_recovery_configuration dbms_cloud_oci_database_disaster_recovery_configuration_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_summary_t (
    id varchar2,
    compartment_id varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    kms_key_id varchar2,
    vault_id varchar2,
    kms_key_lifecycle_details varchar2,
    kms_key_version_id varchar2,
    db_name varchar2,
    character_set varchar2,
    ncharacter_set varchar2,
    in_memory_percentage number,
    in_memory_area_in_g_bs number,
    next_long_term_backup_time_stamp timestamp with time zone,
    long_term_backup_schedule dbms_cloud_oci_database_long_term_back_up_schedule_details_t,
    is_free_tier number,
    system_tags json_element_t,
    time_reclamation_of_free_autonomous_database timestamp with time zone,
    time_deletion_of_free_autonomous_database timestamp with time zone,
    backup_config dbms_cloud_oci_database_autonomous_database_backup_config_t,
    key_history_entry dbms_cloud_oci_database_autonomous_database_key_history_entry_tbl,
    cpu_core_count number,
    local_adg_auto_failover_max_data_loss_limit number,
    compute_model varchar2,
    compute_count number,
    backup_retention_period_in_days number,
    total_backup_storage_size_in_g_bs number,
    ocpu_count number,
    provisionable_cpus dbms_cloud_oci_database_number_tbl,
    data_storage_size_in_t_bs number,
    memory_per_oracle_compute_unit_in_g_bs number,
    data_storage_size_in_g_bs number,
    used_data_storage_size_in_g_bs number,
    infrastructure_type varchar2,
    is_dedicated number,
    autonomous_container_database_id varchar2,
    time_created timestamp with time zone,
    display_name varchar2,
    service_console_url varchar2,
    connection_strings dbms_cloud_oci_database_autonomous_database_connection_strings_t,
    connection_urls dbms_cloud_oci_database_autonomous_database_connection_urls_t,
    license_model varchar2,
    used_data_storage_size_in_t_bs number,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    subnet_id varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    private_endpoint varchar2,
    private_endpoint_label varchar2,
    private_endpoint_ip varchar2,
    db_version varchar2,
    is_preview number,
    db_workload varchar2,
    is_access_control_enabled number,
    whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
    are_primary_whitelisted_ips_used number,
    standby_whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
    apex_details dbms_cloud_oci_database_autonomous_database_apex_t,
    is_auto_scaling_enabled number,
    data_safe_status varchar2,
    operations_insights_status varchar2,
    database_management_status varchar2,
    time_maintenance_begin timestamp with time zone,
    time_maintenance_end timestamp with time zone,
    is_refreshable_clone number,
    time_of_last_refresh timestamp with time zone,
    time_of_last_refresh_point timestamp with time zone,
    time_of_next_refresh timestamp with time zone,
    open_mode varchar2,
    refreshable_status varchar2,
    refreshable_mode varchar2,
    source_id varchar2,
    permission_level varchar2,
    time_of_last_switchover timestamp with time zone,
    time_of_last_failover timestamp with time zone,
    is_data_guard_enabled number,
    failed_data_recovery_in_seconds number,
    standby_db dbms_cloud_oci_database_autonomous_database_standby_summary_t,
    is_local_data_guard_enabled number,
    is_remote_data_guard_enabled number,
    local_standby_db dbms_cloud_oci_database_autonomous_database_standby_summary_t,
    role varchar2,
    available_upgrade_versions dbms_cloud_oci_database_varchar2_tbl,
    key_store_id varchar2,
    key_store_wallet_name varchar2,
    supported_regions_to_clone_to dbms_cloud_oci_database_varchar2_tbl,
    customer_contacts dbms_cloud_oci_database_customer_contact_tbl,
    time_local_data_guard_enabled timestamp with time zone,
    dataguard_region_type varchar2,
    time_data_guard_role_changed timestamp with time zone,
    peer_db_ids dbms_cloud_oci_database_varchar2_tbl,
    is_mtls_connection_required number,
    time_of_joining_resource_pool timestamp with time zone,
    resource_pool_leader_id varchar2,
    resource_pool_summary dbms_cloud_oci_database_resource_pool_summary_t,
    is_reconnect_clone_enabled number,
    time_until_reconnect_clone_enabled timestamp with time zone,
    autonomous_maintenance_schedule_type varchar2,
    scheduled_operations dbms_cloud_oci_database_scheduled_operation_details_tbl,
    is_auto_scaling_for_storage_enabled number,
    allocated_storage_size_in_t_bs number,
    actual_used_data_storage_size_in_t_bs number,
    max_cpu_core_count number,
    database_edition varchar2,
    db_tools_details dbms_cloud_oci_database_database_tool_tbl,
    local_disaster_recovery_type varchar2,
    disaster_recovery_region_type varchar2,
    time_disaster_recovery_role_changed timestamp with time zone,
    remote_disaster_recovery_configuration dbms_cloud_oci_database_disaster_recovery_configuration_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Autonomous Database.

compartment_id

(required) The OCID of the compartment.

lifecycle_state

(required) The current state of the Autonomous Database.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'STOPPING', 'STOPPED', 'STARTING', 'TERMINATING', 'TERMINATED', 'UNAVAILABLE', 'RESTORE_IN_PROGRESS', 'RESTORE_FAILED', 'BACKUP_IN_PROGRESS', 'SCALE_IN_PROGRESS', 'AVAILABLE_NEEDS_ATTENTION', 'UPDATING', 'MAINTENANCE_IN_PROGRESS', 'RESTARTING', 'RECREATING', 'ROLE_CHANGE_IN_PROGRESS', 'UPGRADING', 'INACCESSIBLE', 'STANDBY'

lifecycle_details

(optional) Information about the current lifecycle state.

kms_key_id

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

vault_id

(optional) The OCID of the Oracle Cloud Infrastructure vault.

kms_key_lifecycle_details

(optional) KMS key lifecycle details.

kms_key_version_id

(optional) 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.

db_name

(required) The database name.

character_set

(optional) 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

ncharacter_set

(optional) The national character set for the autonomous database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

in_memory_percentage

(optional) The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous Database.

in_memory_area_in_g_bs

(optional) The area assigned to In-Memory tables in Autonomous Database.

next_long_term_backup_time_stamp

(optional) The date and time when the next long-term backup would be created.

long_term_backup_schedule

(optional)

is_free_tier

(optional) 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

system_tags

(optional) System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

time_reclamation_of_free_autonomous_database

(optional) 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_deletion_of_free_autonomous_database

(optional) 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.

backup_config

(optional)

key_history_entry

(optional) Key History Entry.

cpu_core_count

(optional) The number of OCPU cores to be made available to the database. When the ECPU is selected, the value for cpuCoreCount is 0. 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 `ocpuCount` parameter.

local_adg_auto_failover_max_data_loss_limit

(optional) 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

compute_model

(optional) 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.

Allowed values are: 'ECPU', 'OCPU'

compute_count

(optional) The compute amount 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 values in multiples of two. Required when using the `computeModel` parameter. When using `cpuCoreCount` parameter, it is an error to specify computeCount to a non-null value.

backup_retention_period_in_days

(optional) Retention period, in days, for long-term backups

total_backup_storage_size_in_g_bs

(optional) The backup storage to the database.

ocpu_count

(optional) 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 1 or more cores, you must 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 shared and dedicated Exadata infrastructure. 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.

provisionable_cpus

(optional) An array of CPU values that an Autonomous Database can be scaled to.

data_storage_size_in_t_bs

(required) The quantity of data in the database, in terabytes.

memory_per_oracle_compute_unit_in_g_bs

(optional) The amount of memory (in GBs) enabled per OCPU or ECPU.

data_storage_size_in_g_bs

(optional) The quantity of data in the database, in gigabytes.

used_data_storage_size_in_g_bs

(optional) The storage space consumed by Autonomous Database in GBs.

infrastructure_type

(optional) The infrastructure type this resource belongs to.

Allowed values are: 'CLOUD', 'CLOUD_AT_CUSTOMER'

is_dedicated

(optional) True if the database uses dedicated Exadata infrastructure.

autonomous_container_database_id

(optional) The Autonomous Container Database OCID.

time_created

(optional) The date and time the Autonomous Database was created.

display_name

(optional) The user-friendly name for the Autonomous Database. The name does not have to be unique.

service_console_url

(optional) The URL of the Service Console for the Autonomous Database.

connection_strings

(optional) 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.

connection_urls

(optional)

license_model

(optional) 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`. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, maxCpuCoreCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

used_data_storage_size_in_t_bs

(optional) The amount of storage that has been used, in terabytes.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

subnet_id

(optional) The OCID of the subnet the resource is associated with. **Subnet Restrictions:** - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. - For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20. - For Autonomous Database, setting this will disable public secure access to the database. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.

nsg_ids

(optional) The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. **NsgIds restrictions:** - A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

private_endpoint

(optional) The private endpoint for the resource.

private_endpoint_label

(optional) The resource's private endpoint label. Setting this to an empty string, after the creation of the private endpoint database, changes the private endpoint database to a public endpoint database. 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.

private_endpoint_ip

(optional) The private endpoint Ip address for the resource.

db_version

(optional) A valid Oracle Database version for Autonomous Database.

is_preview

(optional) Indicates if the Autonomous Database version is a preview version.

db_workload

(optional) The Autonomous Database workload type. The following values are valid: - OLTP - indicates an Autonomous Transaction Processing database - DW - indicates an Autonomous Data Warehouse database - AJD - indicates an Autonomous JSON Database - APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

Allowed values are: 'OLTP', 'DW', 'AJD', 'APEX'

is_access_control_enabled

(optional) 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.

whitelisted_ips

(optional) 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. 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). Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. 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.

are_primary_whitelisted_ips_used

(optional) 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.

standby_whitelisted_ips

(optional) 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. 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). Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. 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.

apex_details

(optional) Information about Oracle APEX Application Development.

is_auto_scaling_enabled

(optional) Indicates if auto scaling is enabled for the Autonomous Database CPU core count.

data_safe_status

(optional) Status of the Data Safe registration for this Autonomous Database.

Allowed values are: 'REGISTERING', 'REGISTERED', 'DEREGISTERING', 'NOT_REGISTERED', 'FAILED'

operations_insights_status

(optional) Status of Operations Insights for this Autonomous Database.

Allowed values are: 'ENABLING', 'ENABLED', 'DISABLING', 'NOT_ENABLED', 'FAILED_ENABLING', 'FAILED_DISABLING'

database_management_status

(optional) Status of Database Management for this Autonomous Database.

Allowed values are: 'ENABLING', 'ENABLED', 'DISABLING', 'NOT_ENABLED', 'FAILED_ENABLING', 'FAILED_DISABLING'

time_maintenance_begin

(optional) The date and time when maintenance will begin.

time_maintenance_end

(optional) The date and time when maintenance will end.

is_refreshable_clone

(optional) 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.

time_of_last_refresh

(optional) The date and time when last refresh happened.

time_of_last_refresh_point

(optional) 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_next_refresh

(optional) The date and time of next refresh.

open_mode

(optional) Indicates the Autonomous Database mode. The database can be opened in `READ_ONLY` or `READ_WRITE` mode. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

Allowed values are: 'READ_ONLY', 'READ_WRITE'

refreshable_status

(optional) The refresh status of the clone. REFRESHING indicates that the clone is currently being refreshed with data from the source Autonomous Database.

Allowed values are: 'REFRESHING', 'NOT_REFRESHING'

refreshable_mode

(optional) The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous Database.

Allowed values are: 'AUTOMATIC', 'MANUAL'

source_id

(optional) The OCID of the source Autonomous Database that was cloned to create the current Autonomous Database.

permission_level

(optional) The Autonomous Database permission level. Restricted mode allows access only by admin users. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

Allowed values are: 'RESTRICTED', 'UNRESTRICTED'

time_of_last_switchover

(optional) The timestamp of the last switchover operation for the Autonomous Database.

time_of_last_failover

(optional) The timestamp of the last failover operation.

is_data_guard_enabled

(optional) **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.

failed_data_recovery_in_seconds

(optional) Indicates the number of seconds of data loss for a Data Guard failover.

standby_db

(optional) **Deprecated** Autonomous Data Guard standby database details.

is_local_data_guard_enabled

(optional) 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_remote_data_guard_enabled

(optional) 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.

local_standby_db

(optional)

role

(optional) The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.

Allowed values are: 'PRIMARY', 'STANDBY', 'DISABLED_STANDBY', 'BACKUP_COPY', 'SNAPSHOT_STANDBY'

available_upgrade_versions

(optional) List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty.

key_store_id

(optional) The OCID of the key store.

key_store_wallet_name

(optional) The wallet name for Oracle Key Vault.

supported_regions_to_clone_to

(optional) The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database.

customer_contacts

(optional) Customer Contacts.

time_local_data_guard_enabled

(optional) 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.

dataguard_region_type

(optional) 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.

Allowed values are: 'PRIMARY_DG_REGION', 'REMOTE_STANDBY_DG_REGION'

time_data_guard_role_changed

(optional) 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.

peer_db_ids

(optional) 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.

is_mtls_connection_required

(optional) Specifies if the Autonomous Database requires mTLS connections. This may not be updated in parallel with any of the following: licenseModel, databaseEdition, cpuCoreCount, computeCount, maxCpuCoreCount, 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.

time_of_joining_resource_pool

(optional) The time the member joined the resource pool.

resource_pool_leader_id

(optional) The unique identifier for leader autonomous database OCID OCID.

resource_pool_summary

(optional)

is_reconnect_clone_enabled

(optional) Indicates if the refreshable clone can be reconnected to its source database.

time_until_reconnect_clone_enabled

(optional) 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.

autonomous_maintenance_schedule_type

(optional) 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

Allowed values are: 'EARLY', 'REGULAR'

scheduled_operations

(optional) The list of scheduled operations. 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.

is_auto_scaling_for_storage_enabled

(optional) Indicates if auto scaling is enabled for the Autonomous Database storage. The default value is `FALSE`.

allocated_storage_size_in_t_bs

(optional) 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.

actual_used_data_storage_size_in_t_bs

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

max_cpu_core_count

(optional) The number of Max OCPU cores to be made available to the autonomous database with auto scaling of cpu enabled.

database_edition

(optional) The Oracle Database Edition that applies to the Autonomous databases.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION'

db_tools_details

(optional) 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.

local_disaster_recovery_type

(optional) 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.

disaster_recovery_region_type

(optional) 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.

Allowed values are: 'PRIMARY', 'REMOTE'

time_disaster_recovery_role_changed

(optional) The date and time the Disaster Recovery role was switched for the standby Autonomous Database.

remote_disaster_recovery_configuration

(optional)

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_DATABASE_WALLET_T Type

The Autonomous Database wallet details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_database_wallet_t FORCE AUTHID CURRENT_USER IS OBJECT (
  lifecycle_state varchar2(32767),
  time_rotated timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_wallet_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_database_wallet_t (
    lifecycle_state varchar2,
    time_rotated timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

lifecycle_state

(optional) The current lifecycle state of the Autonomous Database wallet.

Allowed values are: 'ACTIVE', 'UPDATING'

time_rotated

(optional) The date and time the wallet was last rotated.

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_DB_PREVIEW_VERSION_SUMMARY_T Type

The Autonomous Database preview version. Note that preview version software is only available for Autonomous Database Serverless instances.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_db_preview_version_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  version varchar2(32767),
  time_preview_begin timestamp with time zone,
  time_preview_end timestamp with time zone,
  db_workload varchar2(32767),
  details varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_db_preview_version_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_db_preview_version_summary_t (
    version varchar2,
    time_preview_begin timestamp with time zone,
    time_preview_end timestamp with time zone,
    db_workload varchar2,
    details varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

version

(required) A valid Autonomous Database preview version.

time_preview_begin

(optional) The date and time when the preview version availability begins.

time_preview_end

(optional) The date and time when the preview version availability ends.

db_workload

(optional) The Autonomous Database workload type. The following values are valid: - OLTP - indicates an Autonomous Transaction Processing database - DW - indicates an Autonomous Data Warehouse database - AJD - indicates an Autonomous JSON Database - APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

Allowed values are: 'OLTP', 'DW', 'AJD', 'APEX'

details

(optional) A URL that points to a detailed description of the preview version.

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_DB_VERSION_SUMMARY_T Type

The supported Autonomous Database version.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_db_version_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  version varchar2(32767),
  db_workload varchar2(32767),
  is_dedicated number,
  details varchar2(32767),
  is_free_tier_enabled number,
  is_paid_enabled number,
  is_default_for_free number,
  is_default_for_paid number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_db_version_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_db_version_summary_t (
    version varchar2,
    db_workload varchar2,
    is_dedicated number,
    details varchar2,
    is_free_tier_enabled number,
    is_paid_enabled number,
    is_default_for_free number,
    is_default_for_paid number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

version

(required) A valid Oracle Database version for Autonomous Database.

db_workload

(optional) The Autonomous Database workload type. The following values are valid: - OLTP - indicates an Autonomous Transaction Processing database - DW - indicates an Autonomous Data Warehouse database - AJD - indicates an Autonomous JSON Database - APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

Allowed values are: 'OLTP', 'DW', 'AJD', 'APEX'

is_dedicated

(optional) True if the database uses dedicated Exadata infrastructure.

details

(optional) A URL that points to a detailed description of the Autonomous Database version.

is_free_tier_enabled

(optional) True if this version of the Oracle Database software can be used for Always-Free Autonomous Databases.

is_paid_enabled

(optional) True if this version of the Oracle Database software has payments enabled.

is_default_for_free

(optional) True if this version of the Oracle Database software's default is free.

is_default_for_paid

(optional) True if this version of the Oracle Database software's default is paid.

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_EXADATA_INFRASTRUCTURE_T Type

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_exadata_infrastructure_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  availability_domain varchar2(32767),
  subnet_id varchar2(32767),
  nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  shape varchar2(32767),
  hostname varchar2(32767),
  domain varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  license_model varchar2(32767),
  time_created timestamp with time zone,
  maintenance_window dbms_cloud_oci_database_maintenance_window_t,
  last_maintenance_run_id varchar2(32767),
  next_maintenance_run_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  scan_dns_name varchar2(32767),
  zone_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_exadata_infrastructure_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_exadata_infrastructure_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    availability_domain varchar2,
    subnet_id varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    shape varchar2,
    hostname varchar2,
    domain varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    license_model varchar2,
    time_created timestamp with time zone,
    maintenance_window dbms_cloud_oci_database_maintenance_window_t,
    last_maintenance_run_id varchar2,
    next_maintenance_run_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    scan_dns_name varchar2,
    zone_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Autonomous Exadata Infrastructure.

compartment_id

(required) The OCID of the compartment.

display_name

(required) The user-friendly name for the Autonomous Exadata Infrastructure.

availability_domain

(required) The name of the availability domain that the Autonomous Exadata Infrastructure is located in.

subnet_id

(required) The OCID of the subnet the Autonomous Exadata Infrastructure is associated with. **Subnet Restrictions:** - For Autonomous Databases with Autonomous Exadata Infrastructure, do not use a subnet that overlaps with 192.168.128.0/20 These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

nsg_ids

(optional) 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.

shape

(required) The shape of the Autonomous Exadata Infrastructure. The shape determines resources to allocate to the Autonomous Exadata Infrastructure (CPU cores, memory and storage).

hostname

(required) The host name for the Autonomous Exadata Infrastructure node.

domain

(required) The domain name for the Autonomous Exadata Infrastructure.

lifecycle_state

(required) The current lifecycle state of the Autonomous Exadata Infrastructure.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED', 'MAINTENANCE_IN_PROGRESS'

lifecycle_details

(optional) Additional information about the current lifecycle state of the Autonomous Exadata Infrastructure.

license_model

(optional) The Oracle license model that applies to all databases in the Autonomous Exadata Infrastructure. The default is BRING_YOUR_OWN_LICENSE.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

time_created

(optional) The date and time the Autonomous Exadata Infrastructure was created.

maintenance_window

(required)

last_maintenance_run_id

(optional) The OCID of the last maintenance run.

next_maintenance_run_id

(optional) The OCID of the next maintenance run.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

scan_dns_name

(optional) The FQDN of the DNS record for the SCAN IP addresses that are associated with the Autonomous Exadata Infrastructure.

zone_id

(optional) The OCID of the zone the Autonomous Exadata Infrastructure is associated with.

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_EXADATA_INFRASTRUCTURE_SHAPE_SUMMARY_T Type

The shape of the Autonomous Exadata Infrastructure. The shape determines resources to allocate to the Autonomous Exadata Infrastructure (CPU cores, memory and storage). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_exadata_infrastructure_shape_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  available_core_count number,
  minimum_core_count number,
  core_count_increment number,
  minimum_node_count number,
  maximum_node_count number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_exadata_infrastructure_shape_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_exadata_infrastructure_shape_summary_t (
    name varchar2,
    available_core_count number,
    minimum_core_count number,
    core_count_increment number,
    minimum_node_count number,
    maximum_node_count number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) The name of the shape used for the Autonomous Exadata Infrastructure.

available_core_count

(required) The maximum number of CPU cores that can be enabled on the Autonomous Exadata Infrastructure.

minimum_core_count

(optional) The minimum number of CPU cores that can be enabled on the Autonomous Exadata Infrastructure.

core_count_increment

(optional) The increment in which core count can be increased or decreased.

minimum_node_count

(optional) The minimum number of nodes available for the shape.

maximum_node_count

(optional) The maximum number of nodes available for the shape.

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_EXADATA_INFRASTRUCTURE_SUMMARY_T Type

**Deprecated** These APIs are deprecated with the introduction of the Autonomous Exadata VM Cluster resource and a shift to a common Exadata Infrastructure resource for all Exadata Cloud-based services, including Autonomous Database on dedicated Exadata infrastructure. For more details, see Latest Resource Model. Infrastructure that enables the running of multiple Autonomous Databases within a dedicated DB system. For more information about Autonomous Exadata Infrastructure, see Oracle Autonomous Database. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies. For information about access control and compartments, see Overview of the Identity Service. For information about availability domains, see Regions and Availability Domains. To get a list of availability domains, use the ListAvailabilityDomains operation in the Identity service API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_exadata_infrastructure_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  availability_domain varchar2(32767),
  subnet_id varchar2(32767),
  nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  shape varchar2(32767),
  hostname varchar2(32767),
  domain varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  license_model varchar2(32767),
  time_created timestamp with time zone,
  maintenance_window dbms_cloud_oci_database_maintenance_window_t,
  last_maintenance_run_id varchar2(32767),
  next_maintenance_run_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  scan_dns_name varchar2(32767),
  zone_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_exadata_infrastructure_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_exadata_infrastructure_summary_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    availability_domain varchar2,
    subnet_id varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    shape varchar2,
    hostname varchar2,
    domain varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    license_model varchar2,
    time_created timestamp with time zone,
    maintenance_window dbms_cloud_oci_database_maintenance_window_t,
    last_maintenance_run_id varchar2,
    next_maintenance_run_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    scan_dns_name varchar2,
    zone_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Autonomous Exadata Infrastructure.

compartment_id

(required) The OCID of the compartment.

display_name

(required) The user-friendly name for the Autonomous Exadata Infrastructure.

availability_domain

(required) The name of the availability domain that the Autonomous Exadata Infrastructure is located in.

subnet_id

(required) The OCID of the subnet the Autonomous Exadata Infrastructure is associated with. **Subnet Restrictions:** - For Autonomous Databases with Autonomous Exadata Infrastructure, do not use a subnet that overlaps with 192.168.128.0/20 These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

nsg_ids

(optional) 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.

shape

(required) The shape of the Autonomous Exadata Infrastructure. The shape determines resources to allocate to the Autonomous Exadata Infrastructure (CPU cores, memory and storage).

hostname

(required) The host name for the Autonomous Exadata Infrastructure node.

domain

(required) The domain name for the Autonomous Exadata Infrastructure.

lifecycle_state

(required) The current lifecycle state of the Autonomous Exadata Infrastructure.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED', 'MAINTENANCE_IN_PROGRESS'

lifecycle_details

(optional) Additional information about the current lifecycle state of the Autonomous Exadata Infrastructure.

license_model

(optional) The Oracle license model that applies to all databases in the Autonomous Exadata Infrastructure. The default is BRING_YOUR_OWN_LICENSE.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

time_created

(optional) The date and time the Autonomous Exadata Infrastructure was created.

maintenance_window

(required)

last_maintenance_run_id

(optional) The OCID of the last maintenance run.

next_maintenance_run_id

(optional) The OCID of the next maintenance run.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

scan_dns_name

(optional) The FQDN of the DNS record for the SCAN IP addresses that are associated with the Autonomous Exadata Infrastructure.

zone_id

(optional) The OCID of the zone the Autonomous Exadata Infrastructure is associated with.

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_PATCH_T Type

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_patch_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  description varchar2(32767),
  l_type varchar2(32767),
  lifecycle_details varchar2(32767),
  lifecycle_state varchar2(32767),
  time_released timestamp with time zone,
  version varchar2(32767),
  patch_model varchar2(32767),
  quarter varchar2(32767),
  year varchar2(32767),
  autonomous_patch_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_patch_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_patch_t (
    id varchar2,
    description varchar2,
    l_type varchar2,
    lifecycle_details varchar2,
    lifecycle_state varchar2,
    time_released timestamp with time zone,
    version varchar2,
    patch_model varchar2,
    quarter varchar2,
    year varchar2,
    autonomous_patch_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the patch.

description

(required) The text describing this patch package.

l_type

(required) The type of patch. BUNDLE is one example.

lifecycle_details

(optional) A descriptive text associated with the lifecycleState. Typically can contain additional displayable text.

lifecycle_state

(optional) The current state of the patch as a result of lastAction.

Allowed values are: 'AVAILABLE', 'SUCCESS', 'IN_PROGRESS', 'FAILED'

time_released

(required) The date and time that the patch was released.

version

(required) The version of this patch package.

patch_model

(optional) Database patching model preference. See My Oracle Support note 2285040.1 for information on the Release Update (RU) and Release Update Revision (RUR) patching models.

Allowed values are: 'RELEASE_UPDATES', 'RELEASE_UPDATE_REVISIONS'

quarter

(optional) First month of the quarter in which the patch was released.

year

(optional) Year in which the patch was released.

autonomous_patch_type

(optional) Maintenance run type, either \"QUARTERLY\" or \"TIMEZONE\".

Allowed values are: 'QUARTERLY', 'TIMEZONE'

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_PATCH_SUMMARY_T Type

A patch for an Autonomous Exadata Infrastructure or Autonomous Container Database. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_patch_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  description varchar2(32767),
  l_type varchar2(32767),
  lifecycle_details varchar2(32767),
  lifecycle_state varchar2(32767),
  time_released timestamp with time zone,
  version varchar2(32767),
  patch_model varchar2(32767),
  quarter varchar2(32767),
  year varchar2(32767),
  autonomous_patch_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_patch_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_patch_summary_t (
    id varchar2,
    description varchar2,
    l_type varchar2,
    lifecycle_details varchar2,
    lifecycle_state varchar2,
    time_released timestamp with time zone,
    version varchar2,
    patch_model varchar2,
    quarter varchar2,
    year varchar2,
    autonomous_patch_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the patch.

description

(required) The text describing this patch package.

l_type

(required) The type of patch. BUNDLE is one example.

lifecycle_details

(optional) A descriptive text associated with the lifecycleState. Typically can contain additional displayable text.

lifecycle_state

(optional) The current state of the patch as a result of lastAction.

Allowed values are: 'AVAILABLE', 'SUCCESS', 'IN_PROGRESS', 'FAILED'

time_released

(required) The date and time that the patch was released.

version

(required) The version of this patch package.

patch_model

(optional) Database patching model preference. See My Oracle Support note 2285040.1 for information on the Release Update (RU) and Release Update Revision (RUR) patching models.

Allowed values are: 'RELEASE_UPDATES', 'RELEASE_UPDATE_REVISIONS'

quarter

(optional) First month of the quarter in which the patch was released.

year

(optional) Year in which the patch was released.

autonomous_patch_type

(optional) Maintenance run type, either \"QUARTERLY\" or \"TIMEZONE\".

Allowed values are: 'QUARTERLY', 'TIMEZONE'

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_VIRTUAL_MACHINE_T Type

Autonomous Virtual Machine details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_virtual_machine_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  vm_name varchar2(32767),
  db_server_id varchar2(32767),
  db_server_display_name varchar2(32767),
  cpu_core_count number,
  memory_size_in_g_bs number,
  db_node_storage_size_in_g_bs number,
  lifecycle_state varchar2(32767),
  client_ip_address varchar2(32767),
  compartment_id varchar2(32767),
  autonomous_vm_cluster_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  cloud_autonomous_vm_cluster_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_virtual_machine_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_virtual_machine_t (
    id varchar2,
    vm_name varchar2,
    db_server_id varchar2,
    db_server_display_name varchar2,
    cpu_core_count number,
    memory_size_in_g_bs number,
    db_node_storage_size_in_g_bs number,
    lifecycle_state varchar2,
    client_ip_address varchar2,
    compartment_id varchar2,
    autonomous_vm_cluster_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    cloud_autonomous_vm_cluster_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Autonomous Virtual Machine.

vm_name

(optional) The name of the Autonomous Virtual Machine.

db_server_id

(optional) The OCID of the Db server associated with the Autonomous Virtual Machine.

db_server_display_name

(optional) The display name of the dbServer associated with the Autonomous Virtual Machine.

cpu_core_count

(optional) The number of CPU cores enabled on the Autonomous Virtual Machine.

memory_size_in_g_bs

(optional) The allocated memory in GBs on the Autonomous Virtual Machine.

db_node_storage_size_in_g_bs

(optional) The allocated local node storage in GBs on the Autonomous Virtual Machine.

lifecycle_state

(required) The current state of the Autonomous Virtual Machine.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED', 'MAINTENANCE_IN_PROGRESS'

client_ip_address

(optional) Client IP Address.

compartment_id

(optional) The OCID of the compartment.

autonomous_vm_cluster_id

(optional) The OCID of the Autonomous VM Cluster associated with the Autonomous Virtual Machine.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

cloud_autonomous_vm_cluster_id

(optional) The OCID of the Cloud Autonomous VM Cluster associated with the Autonomous Virtual Machine.

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_VIRTUAL_MACHINE_SUMMARY_T Type

Details of the Autonomous Virtual Machine.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_virtual_machine_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  vm_name varchar2(32767),
  db_server_id varchar2(32767),
  db_server_display_name varchar2(32767),
  cpu_core_count number,
  memory_size_in_g_bs number,
  db_node_storage_size_in_g_bs number,
  lifecycle_state varchar2(32767),
  client_ip_address varchar2(32767),
  compartment_id varchar2(32767),
  autonomous_vm_cluster_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  cloud_autonomous_vm_cluster_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_virtual_machine_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_virtual_machine_summary_t (
    id varchar2,
    vm_name varchar2,
    db_server_id varchar2,
    db_server_display_name varchar2,
    cpu_core_count number,
    memory_size_in_g_bs number,
    db_node_storage_size_in_g_bs number,
    lifecycle_state varchar2,
    client_ip_address varchar2,
    compartment_id varchar2,
    autonomous_vm_cluster_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    cloud_autonomous_vm_cluster_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Autonomous Virtual Machine.

vm_name

(optional) The name of the Autonomous Virtual Machine.

db_server_id

(optional) The OCID of the Db server associated with the Autonomous Virtual Machine.

db_server_display_name

(optional) The display name of the dbServer associated with the Autonomous Virtual Machine.

cpu_core_count

(optional) The number of CPU cores enabled on the Autonomous Virtual Machine.

memory_size_in_g_bs

(optional) The allocated memory in GBs on the Autonomous Virtual Machine.

db_node_storage_size_in_g_bs

(optional) The allocated local node storage in GBs on the Autonomous Virtual Machine.

lifecycle_state

(required) The current state of the Autonomous Virtual Machine.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED', 'MAINTENANCE_IN_PROGRESS'

client_ip_address

(optional) Client IP Address.

compartment_id

(optional) The OCID of the compartment.

autonomous_vm_cluster_id

(optional) The OCID of the Autonomous VM Cluster associated with the Autonomous Virtual Machine.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

cloud_autonomous_vm_cluster_id

(optional) The OCID of the Cloud Autonomous VM Cluster associated with the Autonomous Virtual Machine.

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_VM_CLUSTER_T Type

Details of the Autonomous VM cluster.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_vm_cluster_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  time_created timestamp with time zone,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_zone varchar2(32767),
  exadata_infrastructure_id varchar2(32767),
  vm_cluster_network_id varchar2(32767),
  is_local_backup_enabled number,
  cpus_enabled number,
  compute_model varchar2(32767),
  ocpus_enabled number,
  available_cpus number,
  total_container_databases number,
  memory_per_oracle_compute_unit_in_g_bs number,
  cpu_core_count_per_node number,
  autonomous_data_storage_size_in_t_bs number,
  maintenance_window dbms_cloud_oci_database_maintenance_window_t,
  last_maintenance_run_id varchar2(32767),
  next_maintenance_run_id varchar2(32767),
  cpu_percentage number,
  autonomous_data_storage_percentage number,
  provisioned_cpus number,
  total_autonomous_data_storage_in_t_bs number,
  reserved_cpus number,
  provisionable_autonomous_container_databases number,
  provisioned_autonomous_container_databases number,
  non_provisionable_autonomous_container_databases number,
  memory_size_in_g_bs number,
  db_node_storage_size_in_g_bs number,
  data_storage_size_in_t_bs number,
  data_storage_size_in_g_bs number,
  available_data_storage_size_in_t_bs number,
  node_count number,
  license_model varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  db_servers dbms_cloud_oci_database_varchar2_tbl,
  reclaimable_cpus number,
  available_container_databases number,
  available_autonomous_data_storage_size_in_t_bs number,
  scan_listener_port_tls number,
  scan_listener_port_non_tls number,
  is_mtls_enabled number,
  time_database_ssl_certificate_expires timestamp with time zone,
  time_ords_certificate_expires timestamp with time zone,
  exadata_storage_in_t_bs_lowest_scaled_value number,
  cpus_lowest_scaled_value number,
  max_acds_lowest_scaled_value number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_vm_cluster_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_vm_cluster_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    time_created timestamp with time zone,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_zone varchar2,
    exadata_infrastructure_id varchar2,
    vm_cluster_network_id varchar2,
    is_local_backup_enabled number,
    cpus_enabled number,
    compute_model varchar2,
    ocpus_enabled number,
    available_cpus number,
    total_container_databases number,
    memory_per_oracle_compute_unit_in_g_bs number,
    cpu_core_count_per_node number,
    autonomous_data_storage_size_in_t_bs number,
    maintenance_window dbms_cloud_oci_database_maintenance_window_t,
    last_maintenance_run_id varchar2,
    next_maintenance_run_id varchar2,
    cpu_percentage number,
    autonomous_data_storage_percentage number,
    provisioned_cpus number,
    total_autonomous_data_storage_in_t_bs number,
    reserved_cpus number,
    provisionable_autonomous_container_databases number,
    provisioned_autonomous_container_databases number,
    non_provisionable_autonomous_container_databases number,
    memory_size_in_g_bs number,
    db_node_storage_size_in_g_bs number,
    data_storage_size_in_t_bs number,
    data_storage_size_in_g_bs number,
    available_data_storage_size_in_t_bs number,
    node_count number,
    license_model varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    db_servers dbms_cloud_oci_database_varchar2_tbl,
    reclaimable_cpus number,
    available_container_databases number,
    available_autonomous_data_storage_size_in_t_bs number,
    scan_listener_port_tls number,
    scan_listener_port_non_tls number,
    is_mtls_enabled number,
    time_database_ssl_certificate_expires timestamp with time zone,
    time_ords_certificate_expires timestamp with time zone,
    exadata_storage_in_t_bs_lowest_scaled_value number,
    cpus_lowest_scaled_value number,
    max_acds_lowest_scaled_value number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Autonomous VM cluster.

compartment_id

(required) The OCID of the compartment.

display_name

(required) The user-friendly name for the Autonomous VM cluster. The name does not need to be unique.

time_created

(optional) The date and time that the Autonomous VM cluster was created.

lifecycle_state

(required) The current state of the Autonomous VM cluster.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED', 'MAINTENANCE_IN_PROGRESS'

lifecycle_details

(optional) Additional information about the current lifecycle state.

time_zone

(optional) The time zone to use for the Autonomous VM cluster. For details, see DB System Time Zones.

exadata_infrastructure_id

(required) The OCID of the Exadata infrastructure.

vm_cluster_network_id

(required) The OCID of the VM cluster network.

is_local_backup_enabled

(optional) If true, database backup on local Exadata storage is configured for the Autonomous VM cluster. If false, database backup on local Exadata storage is not available in the Autonomous VM cluster.

cpus_enabled

(optional) The number of enabled CPU cores.

compute_model

(optional) The compute model of the Autonomous VM Cluster.

Allowed values are: 'ECPU', 'OCPU'

ocpus_enabled

(optional) The number of enabled OCPU cores.

available_cpus

(optional) The numnber of CPU cores available.

total_container_databases

(optional) The total number of Autonomous Container Databases that can be created.

memory_per_oracle_compute_unit_in_g_bs

(optional) The amount of memory (in GBs) to be enabled per OCPU or ECPU.

cpu_core_count_per_node

(optional) The number of CPU cores enabled per VM cluster node.

autonomous_data_storage_size_in_t_bs

(optional) The data disk group size allocated for Autonomous Databases, in TBs.

maintenance_window

(optional)

last_maintenance_run_id

(optional) The OCID of the last maintenance run.

next_maintenance_run_id

(optional) The OCID of the next maintenance run.

cpu_percentage

(optional) The percentage of total number of CPUs used in an Autonomous VM Cluster.

autonomous_data_storage_percentage

(optional) The percentage of the data storage used for the Autonomous Databases in an Autonomous VM Cluster.

provisioned_cpus

(optional) The number of CPUs provisioned in an Autonomous VM Cluster.

total_autonomous_data_storage_in_t_bs

(optional) The total data disk group size for Autonomous Databases, in TBs.

reserved_cpus

(optional) The number of CPUs reserved in an Autonomous VM Cluster.

provisionable_autonomous_container_databases

(optional) The number of provisionable Autonomous Container Databases in an Autonomous VM Cluster.

provisioned_autonomous_container_databases

(optional) The number of provisioned Autonomous Container Databases in an Autonomous VM Cluster.

non_provisionable_autonomous_container_databases

(optional) The number of non-provisionable Autonomous Container Databases in an Autonomous VM Cluster.

memory_size_in_g_bs

(optional) The memory allocated in GBs.

db_node_storage_size_in_g_bs

(optional) The local node storage allocated in GBs.

data_storage_size_in_t_bs

(optional) The total data storage allocated in TBs

data_storage_size_in_g_bs

(optional) The total data storage allocated in GBs.

available_data_storage_size_in_t_bs

(optional) **Deprecated.** Use `availableAutonomousDataStorageSizeInTBs` for Autonomous Databases' data storage availability in TBs.

node_count

(optional) The number of nodes in the Autonomous VM Cluster.

license_model

(optional) The Oracle license model that applies to the Autonomous VM cluster. The default is LICENSE_INCLUDED.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

db_servers

(optional) The list of OCIDs of the Db servers.

reclaimable_cpus

(optional) For Autonomous Databases on Dedicated Exadata Infrastructure: - These are the CPUs that continue to be included in the count of CPUs available to the Autonomous Container Database even after one of its Autonomous Database is terminated or scaled down. You can release them to the available CPUs at its parent Autonomous VM Cluster level by restarting the Autonomous Container Database. - The CPU type (OCPUs or ECPUs) is determined by the parent Autonomous Exadata VM Cluster's compute model.

available_container_databases

(optional) The number of Autonomous Container Databases that can be created with the currently available local storage.

available_autonomous_data_storage_size_in_t_bs

(optional) The data disk group size available for Autonomous Databases, in TBs.

scan_listener_port_tls

(optional) The SCAN Listener TLS port number. Default value is 2484.

scan_listener_port_non_tls

(optional) The SCAN Listener Non TLS port number. Default value is 1521.

is_mtls_enabled

(optional) Enable mutual TLS(mTLS) authentication for database while provisioning a VMCluster. Default is TLS.

time_database_ssl_certificate_expires

(optional) The date and time of the Database SSL certificate expiration.

time_ords_certificate_expires

(optional) The date and time of the ORDS certificate expiration.

exadata_storage_in_t_bs_lowest_scaled_value

(optional) The lowest value to which exadataStorage in TBs can be scaled down.

cpus_lowest_scaled_value

(optional) The lowest value to which cpus can be scaled down.

max_acds_lowest_scaled_value

(optional) The lowest value to which ACDs can be scaled down.

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_VM_CLUSTER_RESOURCE_DETAILS_T Type

Unallocated resource details of the AVM

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_vm_cluster_resource_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  un_allocated_adb_storage_in_t_bs number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_vm_cluster_resource_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_vm_cluster_resource_details_t (
    id varchar2,
    un_allocated_adb_storage_in_t_bs number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Exadata infrastructure.

un_allocated_adb_storage_in_t_bs

(required) Total unallocated autonomous data storage in the AVM in TBs.

DBMS_CLOUD_OCI_DATABASE_AVM_ACD_RESOURCE_STATS_T Type

Associated autonomous container databases usages.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_avm_acd_resource_stats_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  provisioned_cpus number,
  available_cpus number,
  used_cpus number,
  reserved_cpus number,
  reclaimable_cpus number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_avm_acd_resource_stats_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_avm_acd_resource_stats_t (
    id varchar2,
    display_name varchar2,
    provisioned_cpus number,
    available_cpus number,
    used_cpus number,
    reserved_cpus number,
    reclaimable_cpus number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) The OCID of the Autonomous Container Database.

display_name

(required) The user-friendly name for the Autonomous Container Database. The name does not need to be unique.

provisioned_cpus

(optional) CPUs/cores assigned to Autonomous Databases in the ACD instances.

available_cpus

(optional) The number of CPU cores available.

used_cpus

(optional) CPUs/cores assigned to the ACD instance. Sum of provisioned, reserved and reclaimable CPUs/ cores to the ACD instance.

reserved_cpus

(optional) CPUs/cores reserved for scalability, resilliency and other overheads. This includes failover, autoscaling and idle instance overhead.

reclaimable_cpus

(optional) CPUs/cores that continue to be included in the count of OCPUs available to the Autonomous Container Database even after one of its Autonomous Database is terminated or scaled down. You can release them to the available OCPUs at its parent AVMC level by restarting the Autonomous Container Database.

DBMS_CLOUD_OCI_DATABASE_AVM_ACD_RESOURCE_STATS_TBL Type

Nested table type of dbms_cloud_oci_database_avm_acd_resource_stats_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_avm_acd_resource_stats_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_avm_acd_resource_stats_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_VM_RESOURCE_USAGE_T Type

Autonomous VM usage statistics.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_vm_resource_usage_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  used_cpus number,
  available_cpus number,
  reclaimable_cpus number,
  provisioned_cpus number,
  reserved_cpus number,
  autonomous_container_database_usage dbms_cloud_oci_database_avm_acd_resource_stats_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_vm_resource_usage_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_vm_resource_usage_t (
    id varchar2,
    display_name varchar2,
    used_cpus number,
    available_cpus number,
    reclaimable_cpus number,
    provisioned_cpus number,
    reserved_cpus number,
    autonomous_container_database_usage dbms_cloud_oci_database_avm_acd_resource_stats_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) The OCID of the Autonomous VM Cluster.

display_name

(required) The user-friendly name for the Autonomous VM cluster. The name does not need to be unique.

used_cpus

(optional) The number of CPU cores alloted to the Autonomous Container Databases in an Cloud Autonomous VM cluster.

available_cpus

(optional) The number of CPU cores available.

reclaimable_cpus

(optional) CPU cores that continue to be included in the count of OCPUs available to the Autonomous Container Database even after one of its Autonomous Database is terminated or scaled down. You can release them to the available OCPUs at its parent AVMC level by restarting the Autonomous Container Database.

provisioned_cpus

(optional) The number of CPUs provisioned in an Autonomous VM Cluster.

reserved_cpus

(optional) The number of CPUs reserved in an Autonomous VM Cluster.

autonomous_container_database_usage

(optional) Associated Autonomous Container Database Usages.

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_VM_RESOURCE_USAGE_TBL Type

Nested table type of dbms_cloud_oci_database_autonomous_vm_resource_usage_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_vm_resource_usage_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_autonomous_vm_resource_usage_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_VM_CLUSTER_RESOURCE_USAGE_T Type

Autonomous VM Cluster usage details, including the Autonomous Container Databases usage.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_vm_cluster_resource_usage_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  id varchar2(32767),
  autonomous_data_storage_size_in_t_bs number,
  db_node_storage_size_in_g_bs number,
  memory_size_in_g_bs number,
  total_container_databases number,
  available_autonomous_data_storage_size_in_t_bs number,
  used_autonomous_data_storage_size_in_t_bs number,
  is_local_backup_enabled number,
  exadata_storage_in_t_bs number,
  memory_per_oracle_compute_unit_in_g_bs number,
  total_cpus number,
  used_cpus number,
  available_cpus number,
  reclaimable_cpus number,
  provisioned_cpus number,
  reserved_cpus number,
  provisionable_autonomous_container_databases number,
  provisioned_autonomous_container_databases number,
  non_provisionable_autonomous_container_databases number,
  autonomous_vm_resource_usage dbms_cloud_oci_database_autonomous_vm_resource_usage_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_vm_cluster_resource_usage_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_vm_cluster_resource_usage_t (
    display_name varchar2,
    id varchar2,
    autonomous_data_storage_size_in_t_bs number,
    db_node_storage_size_in_g_bs number,
    memory_size_in_g_bs number,
    total_container_databases number,
    available_autonomous_data_storage_size_in_t_bs number,
    used_autonomous_data_storage_size_in_t_bs number,
    is_local_backup_enabled number,
    exadata_storage_in_t_bs number,
    memory_per_oracle_compute_unit_in_g_bs number,
    total_cpus number,
    used_cpus number,
    available_cpus number,
    reclaimable_cpus number,
    provisioned_cpus number,
    reserved_cpus number,
    provisionable_autonomous_container_databases number,
    provisioned_autonomous_container_databases number,
    non_provisionable_autonomous_container_databases number,
    autonomous_vm_resource_usage dbms_cloud_oci_database_autonomous_vm_resource_usage_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(required) The user-friendly name for the Autonomous VM cluster. The name does not need to be unique.

id

(optional) The OCID of the Autonomous VM cluster.

autonomous_data_storage_size_in_t_bs

(optional) The data disk group size allocated for Autonomous Databases, in TBs.

db_node_storage_size_in_g_bs

(optional) The local node storage allocated in GBs.

memory_size_in_g_bs

(optional) The memory allocated in GBs.

total_container_databases

(optional) The total number of Autonomous Container Databases that can be created.

available_autonomous_data_storage_size_in_t_bs

(optional) The data disk group size available for Autonomous Databases, in TBs.

used_autonomous_data_storage_size_in_t_bs

(optional) The data disk group size used for Autonomous Databases, in TBs.

is_local_backup_enabled

(optional) If true, database backup on local Exadata storage is configured for the Autonomous VM cluster. If false, database backup on local Exadata storage is not available in the Autonomous VM cluster.

exadata_storage_in_t_bs

(optional) Total exadata storage allocated for the Autonomous VM Cluster. DATA + RECOVERY + SPARSE + any overhead in TBs.

memory_per_oracle_compute_unit_in_g_bs

(optional) The amount of memory (in GBs) to be enabled per each CPU core.

total_cpus

(optional) The number of CPU cores enabled on the Autonomous VM cluster.

used_cpus

(optional) The number of CPU cores alloted to the Autonomous Container Databases in an Autonomous VM cluster.

available_cpus

(optional) The number of CPU cores available.

reclaimable_cpus

(optional) CPU cores that continue to be included in the count of OCPUs available to the Autonomous Container Database even after one of its Autonomous Database is terminated or scaled down. You can release them to the available OCPUs at its parent AVMC level by restarting the Autonomous Container Database.

provisioned_cpus

(optional) The number of CPUs provisioned in an Autonomous VM Cluster.

reserved_cpus

(optional) The number of CPUs reserved in an Autonomous VM Cluster.

provisionable_autonomous_container_databases

(optional) The number of provisionable Autonomous Container Databases in an Autonomous VM Cluster.

provisioned_autonomous_container_databases

(optional) The number of provisioned Autonomous Container Databases in an Autonomous VM Cluster.

non_provisionable_autonomous_container_databases

(optional) The number of non-provisionable Autonomous Container Databases in an Autonomous VM Cluster.

autonomous_vm_resource_usage

(optional) List of autonomous vm cluster resource usages.

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_VM_CLUSTER_SUMMARY_T Type

Details of the Autonomous VM cluster.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_vm_cluster_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  time_created timestamp with time zone,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_zone varchar2(32767),
  exadata_infrastructure_id varchar2(32767),
  vm_cluster_network_id varchar2(32767),
  is_local_backup_enabled number,
  cpus_enabled number,
  compute_model varchar2(32767),
  ocpus_enabled number,
  available_cpus number,
  total_container_databases number,
  memory_per_oracle_compute_unit_in_g_bs number,
  cpu_core_count_per_node number,
  autonomous_data_storage_size_in_t_bs number,
  maintenance_window dbms_cloud_oci_database_maintenance_window_t,
  last_maintenance_run_id varchar2(32767),
  next_maintenance_run_id varchar2(32767),
  cpu_percentage number,
  autonomous_data_storage_percentage number,
  provisioned_cpus number,
  total_autonomous_data_storage_in_t_bs number,
  reserved_cpus number,
  provisionable_autonomous_container_databases number,
  provisioned_autonomous_container_databases number,
  non_provisionable_autonomous_container_databases number,
  memory_size_in_g_bs number,
  db_node_storage_size_in_g_bs number,
  data_storage_size_in_t_bs number,
  data_storage_size_in_g_bs number,
  available_data_storage_size_in_t_bs number,
  node_count number,
  license_model varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  db_servers dbms_cloud_oci_database_varchar2_tbl,
  reclaimable_cpus number,
  available_container_databases number,
  available_autonomous_data_storage_size_in_t_bs number,
  scan_listener_port_tls number,
  scan_listener_port_non_tls number,
  is_mtls_enabled number,
  time_database_ssl_certificate_expires timestamp with time zone,
  time_ords_certificate_expires timestamp with time zone,
  exadata_storage_in_t_bs_lowest_scaled_value number,
  cpus_lowest_scaled_value number,
  max_acds_lowest_scaled_value number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_vm_cluster_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_autonomous_vm_cluster_summary_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    time_created timestamp with time zone,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_zone varchar2,
    exadata_infrastructure_id varchar2,
    vm_cluster_network_id varchar2,
    is_local_backup_enabled number,
    cpus_enabled number,
    compute_model varchar2,
    ocpus_enabled number,
    available_cpus number,
    total_container_databases number,
    memory_per_oracle_compute_unit_in_g_bs number,
    cpu_core_count_per_node number,
    autonomous_data_storage_size_in_t_bs number,
    maintenance_window dbms_cloud_oci_database_maintenance_window_t,
    last_maintenance_run_id varchar2,
    next_maintenance_run_id varchar2,
    cpu_percentage number,
    autonomous_data_storage_percentage number,
    provisioned_cpus number,
    total_autonomous_data_storage_in_t_bs number,
    reserved_cpus number,
    provisionable_autonomous_container_databases number,
    provisioned_autonomous_container_databases number,
    non_provisionable_autonomous_container_databases number,
    memory_size_in_g_bs number,
    db_node_storage_size_in_g_bs number,
    data_storage_size_in_t_bs number,
    data_storage_size_in_g_bs number,
    available_data_storage_size_in_t_bs number,
    node_count number,
    license_model varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    db_servers dbms_cloud_oci_database_varchar2_tbl,
    reclaimable_cpus number,
    available_container_databases number,
    available_autonomous_data_storage_size_in_t_bs number,
    scan_listener_port_tls number,
    scan_listener_port_non_tls number,
    is_mtls_enabled number,
    time_database_ssl_certificate_expires timestamp with time zone,
    time_ords_certificate_expires timestamp with time zone,
    exadata_storage_in_t_bs_lowest_scaled_value number,
    cpus_lowest_scaled_value number,
    max_acds_lowest_scaled_value number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Autonomous VM cluster.

compartment_id

(required) The OCID of the compartment.

display_name

(required) The user-friendly name for the Autonomous VM cluster. The name does not need to be unique.

time_created

(optional) The date and time that the Autonomous VM cluster was created.

lifecycle_state

(required) The current state of the Autonomous VM cluster.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED', 'MAINTENANCE_IN_PROGRESS'

lifecycle_details

(optional) Additional information about the current lifecycle state.

time_zone

(optional) The time zone to use for the Autonomous VM cluster. For details, see DB System Time Zones.

exadata_infrastructure_id

(required) The OCID of the Exadata infrastructure.

vm_cluster_network_id

(required) The OCID of the VM cluster network.

is_local_backup_enabled

(optional) If true, database backup on local Exadata storage is configured for the Autonomous VM cluster. If false, database backup on local Exadata storage is not available in the Autonomous VM cluster.

cpus_enabled

(optional) The number of enabled CPU cores.

compute_model

(optional) The compute model of the Autonomous VM Cluster.

Allowed values are: 'ECPU', 'OCPU'

ocpus_enabled

(optional) The number of enabled OCPU cores.

available_cpus

(optional) The numnber of CPU cores available.

total_container_databases

(optional) The total number of Autonomous Container Databases that can be created.

memory_per_oracle_compute_unit_in_g_bs

(optional) The amount of memory (in GBs) to be enabled per OCPU or ECPU.

cpu_core_count_per_node

(optional) The number of CPU cores enabled per VM cluster node.

autonomous_data_storage_size_in_t_bs

(optional) The data disk group size allocated for Autonomous Databases, in TBs.

maintenance_window

(optional)

last_maintenance_run_id

(optional) The OCID of the last maintenance run.

next_maintenance_run_id

(optional) The OCID of the next maintenance run.

cpu_percentage

(optional) The percentage of total number of CPUs used in an Autonomous VM Cluster.

autonomous_data_storage_percentage

(optional) The percentage of the data storage used for the Autonomous Databases in an Autonomous VM Cluster.

provisioned_cpus

(optional) The number of CPUs provisioned in an Autonomous VM Cluster.

total_autonomous_data_storage_in_t_bs

(optional) The total data disk group size for Autonomous Databases, in TBs.

reserved_cpus

(optional) The number of CPUs reserved in an Autonomous VM Cluster.

provisionable_autonomous_container_databases

(optional) The number of provisionable Autonomous Container Databases in an Autonomous VM Cluster.

provisioned_autonomous_container_databases

(optional) The number of provisioned Autonomous Container Databases in an Autonomous VM Cluster.

non_provisionable_autonomous_container_databases

(optional) The number of non-provisionable Autonomous Container Databases in an Autonomous VM Cluster.

memory_size_in_g_bs

(optional) The memory allocated in GBs.

db_node_storage_size_in_g_bs

(optional) The local node storage allocated in GBs.

data_storage_size_in_t_bs

(optional) The total data storage allocated in TBs

data_storage_size_in_g_bs

(optional) The total data storage allocated in GBs.

available_data_storage_size_in_t_bs

(optional) **Deprecated.** Use `availableAutonomousDataStorageSizeInTBs` for Autonomous Databases' data storage availability in TBs.

node_count

(optional) The number of nodes in the Autonomous VM Cluster.

license_model

(optional) The Oracle license model that applies to the Autonomous VM cluster. The default is LICENSE_INCLUDED.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

db_servers

(optional) The list of OCIDs of the Db servers.

reclaimable_cpus

(optional) For Autonomous Databases on Dedicated Exadata Infrastructure: - These are the CPUs that continue to be included in the count of CPUs available to the Autonomous Container Database even after one of its Autonomous Database is terminated or scaled down. You can release them to the available CPUs at its parent Autonomous VM Cluster level by restarting the Autonomous Container Database. - The CPU type (OCPUs or ECPUs) is determined by the parent Autonomous Exadata VM Cluster's compute model.

available_container_databases

(optional) The number of Autonomous Container Databases that can be created with the currently available local storage.

available_autonomous_data_storage_size_in_t_bs

(optional) The data disk group size available for Autonomous Databases, in TBs.

scan_listener_port_tls

(optional) The SCAN Listener TLS port number. Default value is 2484.

scan_listener_port_non_tls

(optional) The SCAN Listener Non TLS port number. Default value is 1521.

is_mtls_enabled

(optional) Enable mutual TLS(mTLS) authentication for database while provisioning a VMCluster. Default is TLS.

time_database_ssl_certificate_expires

(optional) The date and time of the Database SSL certificate expiration.

time_ords_certificate_expires

(optional) The date and time of the ORDS certificate expiration.

exadata_storage_in_t_bs_lowest_scaled_value

(optional) The lowest value to which exadataStorage in TBs can be scaled down.

cpus_lowest_scaled_value

(optional) The lowest value to which cpus can be scaled down.

max_acds_lowest_scaled_value

(optional) The lowest value to which ACDs can be scaled down.

DBMS_CLOUD_OCI_DATABASE_BACKUP_T Type

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_backup_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  database_id varchar2(32767),
  display_name varchar2(32767),
  l_type varchar2(32767),
  time_started timestamp with time zone,
  time_ended timestamp with time zone,
  lifecycle_details varchar2(32767),
  availability_domain varchar2(32767),
  lifecycle_state varchar2(32767),
  database_edition varchar2(32767),
  database_size_in_g_bs number,
  shape varchar2(32767),
  version varchar2(32767),
  kms_key_id varchar2(32767),
  kms_key_version_id varchar2(32767),
  vault_id varchar2(32767),
  key_store_id varchar2(32767),
  key_store_wallet_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_backup_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_backup_t (
    id varchar2,
    compartment_id varchar2,
    database_id varchar2,
    display_name varchar2,
    l_type varchar2,
    time_started timestamp with time zone,
    time_ended timestamp with time zone,
    lifecycle_details varchar2,
    availability_domain varchar2,
    lifecycle_state varchar2,
    database_edition varchar2,
    database_size_in_g_bs number,
    shape varchar2,
    version varchar2,
    kms_key_id varchar2,
    kms_key_version_id varchar2,
    vault_id varchar2,
    key_store_id varchar2,
    key_store_wallet_name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) The OCID of the backup.

compartment_id

(optional) The OCID of the compartment.

database_id

(optional) The OCID of the database.

display_name

(optional) The user-friendly name for the backup. The name does not have to be unique.

l_type

(optional) The type of backup.

Allowed values are: 'INCREMENTAL', 'FULL', 'VIRTUAL_FULL'

time_started

(optional) The date and time the backup started.

time_ended

(optional) The date and time the backup was completed.

lifecycle_details

(optional) Additional information about the current lifecycle state.

availability_domain

(optional) The name of the availability domain where the database backup is stored.

lifecycle_state

(optional) The current state of the backup.

Allowed values are: 'CREATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED', 'RESTORING', 'CANCELING', 'CANCELED'

database_edition

(optional) The Oracle Database edition of the DB system from which the database backup was taken.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION', 'ENTERPRISE_EDITION_HIGH_PERFORMANCE', 'ENTERPRISE_EDITION_EXTREME_PERFORMANCE'

database_size_in_g_bs

(optional) The size of the database in gigabytes at the time the backup was taken.

shape

(optional) Shape of the backup's source database.

version

(optional) Version of the backup's source database

kms_key_id

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

kms_key_version_id

(optional) 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.

vault_id

(optional) The OCID of the Oracle Cloud Infrastructure vault.

key_store_id

(optional) The OCID of the key store.

key_store_wallet_name

(optional) The wallet name for Oracle Key Vault.

DBMS_CLOUD_OCI_DATABASE_ASSOCIATED_DATABASE_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_database_associated_database_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_associated_database_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_associated_database_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_BACKUP_DESTINATION_T Type

Backup destination details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_backup_destination_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  l_type varchar2(32767),
  associated_databases dbms_cloud_oci_database_associated_database_details_tbl,
  connection_string varchar2(32767),
  vpc_users dbms_cloud_oci_database_varchar2_tbl,
  local_mount_point_path varchar2(32767),
  nfs_mount_type varchar2(32767),
  nfs_server dbms_cloud_oci_database_varchar2_tbl,
  nfs_server_export varchar2(32767),
  lifecycle_state varchar2(32767),
  time_created timestamp with time zone,
  lifecycle_details varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_backup_destination_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_backup_destination_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    l_type varchar2,
    associated_databases dbms_cloud_oci_database_associated_database_details_tbl,
    connection_string varchar2,
    vpc_users dbms_cloud_oci_database_varchar2_tbl,
    local_mount_point_path varchar2,
    nfs_mount_type varchar2,
    nfs_server dbms_cloud_oci_database_varchar2_tbl,
    nfs_server_export varchar2,
    lifecycle_state varchar2,
    time_created timestamp with time zone,
    lifecycle_details varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) The OCID of the backup destination.

display_name

(optional) The user-provided name of the backup destination.

compartment_id

(optional) The OCID of the compartment.

l_type

(optional) Type of the backup destination.

Allowed values are: 'NFS', 'RECOVERY_APPLIANCE'

associated_databases

(optional) List of databases associated with the backup destination.

connection_string

(optional) For a RECOVERY_APPLIANCE backup destination, the connection string for connecting to the Recovery Appliance.

vpc_users

(optional) For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance.

local_mount_point_path

(optional) The local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes.

nfs_mount_type

(optional) NFS Mount type for backup destination.

Allowed values are: 'SELF_MOUNT', 'AUTOMATED_MOUNT'

nfs_server

(optional) Host names or IP addresses for NFS Auto mount.

nfs_server_export

(optional) Specifies the directory on which to mount the file system

lifecycle_state

(optional) The current lifecycle state of the backup destination.

Allowed values are: 'ACTIVE', 'FAILED', 'DELETED'

time_created

(optional) The date and time the backup destination was created.

lifecycle_details

(optional) A descriptive text associated with the lifecycleState. Typically contains additional displayable text

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_BACKUP_DESTINATION_SUMMARY_T Type

Backup destination details, including the list of databases using the backup destination.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_backup_destination_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  l_type varchar2(32767),
  associated_databases dbms_cloud_oci_database_associated_database_details_tbl,
  connection_string varchar2(32767),
  vpc_users dbms_cloud_oci_database_varchar2_tbl,
  local_mount_point_path varchar2(32767),
  nfs_mount_type varchar2(32767),
  nfs_server dbms_cloud_oci_database_varchar2_tbl,
  nfs_server_export varchar2(32767),
  lifecycle_state varchar2(32767),
  time_created timestamp with time zone,
  lifecycle_details varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_backup_destination_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_backup_destination_summary_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    l_type varchar2,
    associated_databases dbms_cloud_oci_database_associated_database_details_tbl,
    connection_string varchar2,
    vpc_users dbms_cloud_oci_database_varchar2_tbl,
    local_mount_point_path varchar2,
    nfs_mount_type varchar2,
    nfs_server dbms_cloud_oci_database_varchar2_tbl,
    nfs_server_export varchar2,
    lifecycle_state varchar2,
    time_created timestamp with time zone,
    lifecycle_details varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) The OCID of the backup destination.

display_name

(optional) The user-provided name of the backup destination.

compartment_id

(optional) The OCID of the compartment.

l_type

(optional) Type of the backup destination.

Allowed values are: 'NFS', 'RECOVERY_APPLIANCE'

associated_databases

(optional) List of databases associated with the backup destination.

connection_string

(optional) For a RECOVERY_APPLIANCE backup destination, the connection string for connecting to the Recovery Appliance.

vpc_users

(optional) For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance.

local_mount_point_path

(optional) The local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes.

nfs_mount_type

(optional) NFS Mount type for backup destination.

Allowed values are: 'SELF_MOUNT', 'AUTOMATED_MOUNT'

nfs_server

(optional) Host names or IP addresses for NFS Auto mount.

nfs_server_export

(optional) Specifies the directory on which to mount the file system

lifecycle_state

(optional) The current lifecycle state of the backup destination.

Allowed values are: 'ACTIVE', 'FAILED', 'DELETED'

time_created

(optional) The date and time the backup destination was created.

lifecycle_details

(optional) A descriptive text associated with the lifecycleState. Typically contains additional displayable text

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_BACKUP_SUMMARY_T Type

A database backup. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_backup_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  database_id varchar2(32767),
  display_name varchar2(32767),
  l_type varchar2(32767),
  time_started timestamp with time zone,
  time_ended timestamp with time zone,
  lifecycle_details varchar2(32767),
  availability_domain varchar2(32767),
  lifecycle_state varchar2(32767),
  database_edition varchar2(32767),
  database_size_in_g_bs number,
  shape varchar2(32767),
  version varchar2(32767),
  kms_key_id varchar2(32767),
  kms_key_version_id varchar2(32767),
  vault_id varchar2(32767),
  key_store_id varchar2(32767),
  key_store_wallet_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_backup_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_backup_summary_t (
    id varchar2,
    compartment_id varchar2,
    database_id varchar2,
    display_name varchar2,
    l_type varchar2,
    time_started timestamp with time zone,
    time_ended timestamp with time zone,
    lifecycle_details varchar2,
    availability_domain varchar2,
    lifecycle_state varchar2,
    database_edition varchar2,
    database_size_in_g_bs number,
    shape varchar2,
    version varchar2,
    kms_key_id varchar2,
    kms_key_version_id varchar2,
    vault_id varchar2,
    key_store_id varchar2,
    key_store_wallet_name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) The OCID of the backup.

compartment_id

(optional) The OCID of the compartment.

database_id

(optional) The OCID of the database.

display_name

(optional) The user-friendly name for the backup. The name does not have to be unique.

l_type

(optional) The type of backup.

Allowed values are: 'INCREMENTAL', 'FULL', 'VIRTUAL_FULL'

time_started

(optional) The date and time the backup started.

time_ended

(optional) The date and time the backup was completed.

lifecycle_details

(optional) Additional information about the current lifecycle state.

availability_domain

(optional) The name of the availability domain where the database backup is stored.

lifecycle_state

(optional) The current state of the backup.

Allowed values are: 'CREATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED', 'RESTORING', 'CANCELING', 'CANCELED'

database_edition

(optional) The Oracle Database edition of the DB system from which the database backup was taken.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION', 'ENTERPRISE_EDITION_HIGH_PERFORMANCE', 'ENTERPRISE_EDITION_EXTREME_PERFORMANCE'

database_size_in_g_bs

(optional) The size of the database in gigabytes at the time the backup was taken.

shape

(optional) Shape of the backup's source database.

version

(optional) Version of the backup's source database

kms_key_id

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

kms_key_version_id

(optional) 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.

vault_id

(optional) The OCID of the Oracle Cloud Infrastructure vault.

key_store_id

(optional) The OCID of the key store.

key_store_wallet_name

(optional) The wallet name for Oracle Key Vault.

DBMS_CLOUD_OCI_DATABASE_CHANGE_AUTONOMOUS_VM_CLUSTER_COMPARTMENT_DETAILS_T Type

The configuration details for moving the Autonomous VM cluster.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_change_autonomous_vm_cluster_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_change_autonomous_vm_cluster_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_change_autonomous_vm_cluster_compartment_details_t (
    compartment_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment to move the Autonomous VM cluster to.

DBMS_CLOUD_OCI_DATABASE_CHANGE_CLOUD_AUTONOMOUS_VM_CLUSTER_COMPARTMENT_DETAILS_T Type

The configuration details for moving the cloud Autonomous VM cluster.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_change_cloud_autonomous_vm_cluster_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_change_cloud_autonomous_vm_cluster_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_change_cloud_autonomous_vm_cluster_compartment_details_t (
    compartment_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment.

DBMS_CLOUD_OCI_DATABASE_CHANGE_CLOUD_EXADATA_INFRASTRUCTURE_COMPARTMENT_DETAILS_T Type

The configuration details for moving the cloud Exadata infrastructure resource to another compartment. Applies to Exadata Cloud Service instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_change_cloud_exadata_infrastructure_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_change_cloud_exadata_infrastructure_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_change_cloud_exadata_infrastructure_compartment_details_t (
    compartment_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment.

DBMS_CLOUD_OCI_DATABASE_CHANGE_CLOUD_VM_CLUSTER_COMPARTMENT_DETAILS_T Type

The configuration details for moving the cloud VM cluster to another compartment. Applies to Exadata Cloud Service instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_change_cloud_vm_cluster_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_change_cloud_vm_cluster_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_change_cloud_vm_cluster_compartment_details_t (
    compartment_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment.

DBMS_CLOUD_OCI_DATABASE_CHANGE_COMPARTMENT_DETAILS_T Type

The configuration details for moving the resource.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_change_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_change_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_change_compartment_details_t (
    compartment_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment to move the resource to.

DBMS_CLOUD_OCI_DATABASE_CHANGE_DATAGUARD_ROLE_DETAILS_T Type

The configuration details for change Autonomous Container Database Dataguard role

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_change_dataguard_role_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  role varchar2(32767),
  autonomous_container_database_dataguard_association_id varchar2(32767),
  connection_strings_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_change_dataguard_role_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_change_dataguard_role_details_t (
    role varchar2,
    autonomous_container_database_dataguard_association_id varchar2,
    connection_strings_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

role

(required) The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.

Allowed values are: 'PRIMARY', 'STANDBY', 'DISABLED_STANDBY', 'BACKUP_COPY', 'SNAPSHOT_STANDBY'

autonomous_container_database_dataguard_association_id

(required) The Autonomous Container Database-Autonomous Data Guard association OCID.

connection_strings_type

(optional) type of connection strings when converting database to snapshot mode

Allowed values are: 'SNAPSHOT_SERVICES', 'PRIMARY_SERVICES'

DBMS_CLOUD_OCI_DATABASE_CHANGE_DISASTER_RECOVERY_CONFIGURATION_DETAILS_T Type

Details to update the cross-region disaster recovery (DR) details of the standby Autonomous Database Serverless instance.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_change_disaster_recovery_configuration_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  disaster_recovery_type varchar2(32767),
  time_snapshot_standby_enabled_till timestamp with time zone,
  is_snapshot_standby number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_change_disaster_recovery_configuration_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_change_disaster_recovery_configuration_details_t (
    disaster_recovery_type varchar2,
    time_snapshot_standby_enabled_till timestamp with time zone,
    is_snapshot_standby number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

disaster_recovery_type

(optional) 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.

Allowed values are: 'ADG', 'BACKUP_BASED'

time_snapshot_standby_enabled_till

(optional) 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.

is_snapshot_standby

(optional) 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.

DBMS_CLOUD_OCI_DATABASE_CHANGE_EXADATA_INFRASTRUCTURE_COMPARTMENT_DETAILS_T Type

The configuration details for moving the resource.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_change_exadata_infrastructure_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_change_exadata_infrastructure_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_change_exadata_infrastructure_compartment_details_t (
    compartment_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment to move the resource to.

DBMS_CLOUD_OCI_DATABASE_CHANGE_KEY_STORE_COMPARTMENT_DETAILS_T Type

The configuration details for moving the key store.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_change_key_store_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_change_key_store_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_change_key_store_compartment_details_t (
    compartment_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment to move the key store to.

DBMS_CLOUD_OCI_DATABASE_CHANGE_KEY_STORE_TYPE_DETAILS_T Type

Request details to change the source of the encryption key for the database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_change_key_store_type_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  key_store_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_change_key_store_type_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_change_key_store_type_details_t (
    key_store_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

key_store_id

(required) The OCID of the key store.

DBMS_CLOUD_OCI_DATABASE_CHANGE_VM_CLUSTER_COMPARTMENT_DETAILS_T Type

The configuration details for moving the VM cluster.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_change_vm_cluster_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_change_vm_cluster_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_change_vm_cluster_compartment_details_t (
    compartment_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment to move the VM cluster to.

DBMS_CLOUD_OCI_DATABASE_CLOUD_AUTONOMOUS_VM_CLUSTER_T Type

Details of the cloud Autonomous VM cluster.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_cloud_autonomous_vm_cluster_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  description varchar2(32767),
  availability_domain varchar2(32767),
  subnet_id varchar2(32767),
  nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  last_update_history_entry_id varchar2(32767),
  lifecycle_state varchar2(32767),
  display_name varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  cluster_time_zone varchar2(32767),
  lifecycle_details varchar2(32767),
  hostname varchar2(32767),
  domain varchar2(32767),
  cloud_exadata_infrastructure_id varchar2(32767),
  shape varchar2(32767),
  node_count number,
  data_storage_size_in_t_bs number,
  data_storage_size_in_g_bs number,
  cpu_core_count number,
  ocpu_count number,
  compute_model varchar2(32767),
  is_mtls_enabled_vm_cluster number,
  cpu_core_count_per_node number,
  memory_size_in_g_bs number,
  license_model varchar2(32767),
  last_maintenance_run_id varchar2(32767),
  next_maintenance_run_id varchar2(32767),
  maintenance_window dbms_cloud_oci_database_maintenance_window_t,
  scan_listener_port_tls number,
  scan_listener_port_non_tls number,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  time_database_ssl_certificate_expires timestamp with time zone,
  time_ords_certificate_expires timestamp with time zone,
  available_cpus number,
  reclaimable_cpus number,
  available_container_databases number,
  total_container_databases number,
  available_autonomous_data_storage_size_in_t_bs number,
  autonomous_data_storage_size_in_t_bs number,
  db_node_storage_size_in_g_bs number,
  memory_per_oracle_compute_unit_in_g_bs number,
  db_servers dbms_cloud_oci_database_varchar2_tbl,
  cpu_percentage number,
  autonomous_data_storage_percentage number,
  provisioned_cpus number,
  total_cpus number,
  total_autonomous_data_storage_in_t_bs number,
  reserved_cpus number,
  provisionable_autonomous_container_databases number,
  provisioned_autonomous_container_databases number,
  non_provisionable_autonomous_container_databases number,
  exadata_storage_in_t_bs_lowest_scaled_value number,
  ocpus_lowest_scaled_value number,
  max_acds_lowest_scaled_value number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_cloud_autonomous_vm_cluster_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_cloud_autonomous_vm_cluster_t (
    id varchar2,
    compartment_id varchar2,
    description varchar2,
    availability_domain varchar2,
    subnet_id varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    last_update_history_entry_id varchar2,
    lifecycle_state varchar2,
    display_name varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    cluster_time_zone varchar2,
    lifecycle_details varchar2,
    hostname varchar2,
    domain varchar2,
    cloud_exadata_infrastructure_id varchar2,
    shape varchar2,
    node_count number,
    data_storage_size_in_t_bs number,
    data_storage_size_in_g_bs number,
    cpu_core_count number,
    ocpu_count number,
    compute_model varchar2,
    is_mtls_enabled_vm_cluster number,
    cpu_core_count_per_node number,
    memory_size_in_g_bs number,
    license_model varchar2,
    last_maintenance_run_id varchar2,
    next_maintenance_run_id varchar2,
    maintenance_window dbms_cloud_oci_database_maintenance_window_t,
    scan_listener_port_tls number,
    scan_listener_port_non_tls number,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    time_database_ssl_certificate_expires timestamp with time zone,
    time_ords_certificate_expires timestamp with time zone,
    available_cpus number,
    reclaimable_cpus number,
    available_container_databases number,
    total_container_databases number,
    available_autonomous_data_storage_size_in_t_bs number,
    autonomous_data_storage_size_in_t_bs number,
    db_node_storage_size_in_g_bs number,
    memory_per_oracle_compute_unit_in_g_bs number,
    db_servers dbms_cloud_oci_database_varchar2_tbl,
    cpu_percentage number,
    autonomous_data_storage_percentage number,
    provisioned_cpus number,
    total_cpus number,
    total_autonomous_data_storage_in_t_bs number,
    reserved_cpus number,
    provisionable_autonomous_container_databases number,
    provisioned_autonomous_container_databases number,
    non_provisionable_autonomous_container_databases number,
    exadata_storage_in_t_bs_lowest_scaled_value number,
    ocpus_lowest_scaled_value number,
    max_acds_lowest_scaled_value number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Cloud Autonomous VM cluster.

compartment_id

(required) The OCID of the compartment.

description

(optional) User defined description of the cloud Autonomous VM cluster.

availability_domain

(required) The name of the availability domain that the cloud Autonomous VM cluster is located in.

subnet_id

(required) The OCID of the subnet the cloud Autonomous VM Cluster is associated with. **Subnet Restrictions:** - For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

nsg_ids

(optional) 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.

last_update_history_entry_id

(optional) The OCID of the last maintenance update history. This value is updated when a maintenance update starts.

lifecycle_state

(required) The current state of the cloud Autonomous VM cluster.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED', 'MAINTENANCE_IN_PROGRESS'

display_name

(required) The user-friendly name for the cloud Autonomous VM cluster. The name does not need to be unique.

time_created

(optional) The date and time that the cloud Autonomous VM cluster was created.

time_updated

(optional) The last date and time that the cloud Autonomous VM cluster was updated.

cluster_time_zone

(optional) The time zone of the Cloud Autonomous VM Cluster.

lifecycle_details

(optional) Additional information about the current lifecycle state.

hostname

(optional) The hostname for the cloud Autonomous VM cluster.

domain

(optional) The domain name for the cloud Autonomous VM cluster.

cloud_exadata_infrastructure_id

(required) The OCID of the cloud Exadata infrastructure.

shape

(optional) The model name of the Exadata hardware running the cloud Autonomous VM cluster.

node_count

(optional) The number of database servers in the cloud VM cluster.

data_storage_size_in_t_bs

(optional) The total data storage allocated, in terabytes (TB).

data_storage_size_in_g_bs

(optional) The total data storage allocated, in gigabytes (GB).

cpu_core_count

(optional) The number of CPU cores on the cloud Autonomous VM cluster.

ocpu_count

(optional) The number of CPU cores on the cloud Autonomous VM cluster. Only 1 decimal place is allowed for the fractional part.

compute_model

(optional) The compute model of the Cloud Autonomous VM Cluster.

Allowed values are: 'ECPU', 'OCPU'

is_mtls_enabled_vm_cluster

(optional) Enable mutual TLS(mTLS) authentication for database at time of provisioning a VMCluster. This is applicable to database TLS Certificates only. Default is TLS

cpu_core_count_per_node

(optional) The number of CPU cores enabled per VM cluster node.

memory_size_in_g_bs

(optional) The memory allocated in GBs.

license_model

(optional) 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`. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, maxCpuCoreCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

last_maintenance_run_id

(optional) The OCID of the last maintenance run.

next_maintenance_run_id

(optional) The OCID of the next maintenance run.

maintenance_window

(optional)

scan_listener_port_tls

(optional) The SCAN Listenenr TLS port. Default is 2484.

scan_listener_port_non_tls

(optional) The SCAN Listener Non TLS port. Default is 1521.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

time_database_ssl_certificate_expires

(optional) The date and time of Database SSL certificate expiration.

time_ords_certificate_expires

(optional) The date and time of ORDS certificate expiration.

available_cpus

(optional) CPU cores available for allocation to Autonomous Databases.

reclaimable_cpus

(optional) For Autonomous Databases on Dedicated Exadata Infrastructure: - These are the CPUs that continue to be included in the count of CPUs available to the Autonomous Container Database even after one of its Autonomous Database is terminated or scaled down. You can release them to the available CPUs at its parent Autonomous VM Cluster level by restarting the Autonomous Container Database. - The CPU type (OCPUs or ECPUs) is determined by the parent Autonomous Exadata VM Cluster's compute model.

available_container_databases

(optional) The number of Autonomous Container Databases that can be created with the currently available local storage.

total_container_databases

(optional) The total number of Autonomous Container Databases that can be created with the allocated local storage.

available_autonomous_data_storage_size_in_t_bs

(optional) The data disk group size available for Autonomous Databases, in TBs.

autonomous_data_storage_size_in_t_bs

(optional) The data disk group size allocated for Autonomous Databases, in TBs.

db_node_storage_size_in_g_bs

(optional) The local node storage allocated in GBs.

memory_per_oracle_compute_unit_in_g_bs

(optional) The amount of memory (in GBs) enabled per OCPU or ECPU.

db_servers

(optional) The list of OCIDs of the Db servers.

cpu_percentage

(optional) The percentage of total number of CPUs used in an Autonomous VM Cluster.

autonomous_data_storage_percentage

(optional) The percentage of the data storage used for the Autonomous Databases in an Autonomous VM Cluster.

provisioned_cpus

(optional) The number of CPUs provisioned in an Autonomous VM Cluster.

total_cpus

(optional) The total number of CPUs in an Autonomous VM Cluster.

total_autonomous_data_storage_in_t_bs

(optional) The total data disk group size for Autonomous Databases, in TBs.

reserved_cpus

(optional) The number of CPUs reserved in an Autonomous VM Cluster.

provisionable_autonomous_container_databases

(optional) The number of provisionable Autonomous Container Databases in an Autonomous VM Cluster.

provisioned_autonomous_container_databases

(optional) The number of provisioned Autonomous Container Databases in an Autonomous VM Cluster.

non_provisionable_autonomous_container_databases

(optional) The number of non-provisionable Autonomous Container Databases in an Autonomous VM Cluster.

exadata_storage_in_t_bs_lowest_scaled_value

(optional) The lowest value to which exadataStorage in TBs can be scaled down.

ocpus_lowest_scaled_value

(optional) The lowest value to which ocpus can be scaled down.

max_acds_lowest_scaled_value

(optional) The lowest value to which ACDs can be scaled down.

DBMS_CLOUD_OCI_DATABASE_CLOUD_AUTONOMOUS_VM_CLUSTER_RESOURCE_DETAILS_T Type

Unallocated resource details of the Cloud Autonomous VM Cluster.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_cloud_autonomous_vm_cluster_resource_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  un_allocated_adb_storage_in_t_bs number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_cloud_autonomous_vm_cluster_resource_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_cloud_autonomous_vm_cluster_resource_details_t (
    id varchar2,
    un_allocated_adb_storage_in_t_bs number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Cloud Exadata infrastructure.

un_allocated_adb_storage_in_t_bs

(required) Total unallocated autonomous data storage in the Cloud Autonomous VM Cluster in TBs.

DBMS_CLOUD_OCI_DATABASE_CLOUD_AUTONOMOUS_VM_CLUSTER_RESOURCE_USAGE_T Type

Cloud Autonomous VM Cluster usage details, including the Autonomous Container Databases usage.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_cloud_autonomous_vm_cluster_resource_usage_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  id varchar2(32767),
  autonomous_data_storage_size_in_t_bs number,
  db_node_storage_size_in_g_bs number,
  memory_size_in_g_bs number,
  total_container_databases number,
  available_autonomous_data_storage_size_in_t_bs number,
  used_autonomous_data_storage_size_in_t_bs number,
  memory_per_oracle_compute_unit_in_g_bs number,
  exadata_storage_in_t_bs number,
  total_cpus number,
  used_cpus number,
  available_cpus number,
  reclaimable_cpus number,
  provisioned_cpus number,
  reserved_cpus number,
  provisionable_autonomous_container_databases number,
  provisioned_autonomous_container_databases number,
  non_provisionable_autonomous_container_databases number,
  autonomous_vm_resource_usage dbms_cloud_oci_database_autonomous_vm_resource_usage_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_cloud_autonomous_vm_cluster_resource_usage_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_cloud_autonomous_vm_cluster_resource_usage_t (
    display_name varchar2,
    id varchar2,
    autonomous_data_storage_size_in_t_bs number,
    db_node_storage_size_in_g_bs number,
    memory_size_in_g_bs number,
    total_container_databases number,
    available_autonomous_data_storage_size_in_t_bs number,
    used_autonomous_data_storage_size_in_t_bs number,
    memory_per_oracle_compute_unit_in_g_bs number,
    exadata_storage_in_t_bs number,
    total_cpus number,
    used_cpus number,
    available_cpus number,
    reclaimable_cpus number,
    provisioned_cpus number,
    reserved_cpus number,
    provisionable_autonomous_container_databases number,
    provisioned_autonomous_container_databases number,
    non_provisionable_autonomous_container_databases number,
    autonomous_vm_resource_usage dbms_cloud_oci_database_autonomous_vm_resource_usage_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(required) The user-friendly name for the Autonomous VM cluster. The name does not need to be unique.

id

(optional) The OCID of the Cloud Autonomous VM cluster.

autonomous_data_storage_size_in_t_bs

(optional) The data disk group size allocated for Autonomous Databases, in TBs.

db_node_storage_size_in_g_bs

(optional) The local node storage allocated in GBs.

memory_size_in_g_bs

(optional) The memory allocated in GBs.

total_container_databases

(optional) The total number of Autonomous Container Databases that can be created.

available_autonomous_data_storage_size_in_t_bs

(optional) The data disk group size available for Autonomous Databases, in TBs.

used_autonomous_data_storage_size_in_t_bs

(optional) The data disk group size used for Autonomous Databases, in TBs.

memory_per_oracle_compute_unit_in_g_bs

(optional) The amount of memory (in GBs) to be enabled per each CPU core.

exadata_storage_in_t_bs

(optional) Total exadata storage allocated for the Autonomous VM Cluster. DATA + RECOVERY + SPARSE + any overhead in TBs.

total_cpus

(optional) The number of CPU cores enabled on the Cloud Autonomous VM cluster.

used_cpus

(optional) The number of CPU cores alloted to the Autonomous Container Databases in an Cloud Autonomous VM cluster.

available_cpus

(optional) The number of CPU cores available.

reclaimable_cpus

(optional) CPU cores that continue to be included in the count of OCPUs available to the Autonomous Container Database even after one of its Autonomous Database is terminated or scaled down. You can release them to the available OCPUs at its parent AVMC level by restarting the Autonomous Container Database.

provisioned_cpus

(optional) The number of CPUs provisioned in an Autonomous VM Cluster.

reserved_cpus

(optional) The number of CPUs reserved in an Autonomous VM Cluster.

provisionable_autonomous_container_databases

(optional) The number of provisionable Autonomous Container Databases in an Autonomous VM Cluster.

provisioned_autonomous_container_databases

(optional) The number of provisioned Autonomous Container Databases in an Autonomous VM Cluster.

non_provisionable_autonomous_container_databases

(optional) The number of non-provisionable Autonomous Container Databases in an Autonomous VM Cluster.

autonomous_vm_resource_usage

(optional) List of Autonomous VM resource usages.

DBMS_CLOUD_OCI_DATABASE_CLOUD_AUTONOMOUS_VM_CLUSTER_SUMMARY_T Type

Details of the cloud Autonomous VM cluster.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_cloud_autonomous_vm_cluster_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  description varchar2(32767),
  availability_domain varchar2(32767),
  subnet_id varchar2(32767),
  nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  last_update_history_entry_id varchar2(32767),
  lifecycle_state varchar2(32767),
  display_name varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  cluster_time_zone varchar2(32767),
  lifecycle_details varchar2(32767),
  hostname varchar2(32767),
  domain varchar2(32767),
  cloud_exadata_infrastructure_id varchar2(32767),
  shape varchar2(32767),
  node_count number,
  data_storage_size_in_t_bs number,
  data_storage_size_in_g_bs number,
  cpu_core_count number,
  ocpu_count number,
  compute_model varchar2(32767),
  is_mtls_enabled_vm_cluster number,
  cpu_core_count_per_node number,
  memory_size_in_g_bs number,
  license_model varchar2(32767),
  last_maintenance_run_id varchar2(32767),
  next_maintenance_run_id varchar2(32767),
  maintenance_window dbms_cloud_oci_database_maintenance_window_t,
  scan_listener_port_tls number,
  scan_listener_port_non_tls number,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  time_database_ssl_certificate_expires timestamp with time zone,
  time_ords_certificate_expires timestamp with time zone,
  available_cpus number,
  reclaimable_cpus number,
  available_container_databases number,
  total_container_databases number,
  available_autonomous_data_storage_size_in_t_bs number,
  autonomous_data_storage_size_in_t_bs number,
  db_node_storage_size_in_g_bs number,
  memory_per_oracle_compute_unit_in_g_bs number,
  db_servers dbms_cloud_oci_database_varchar2_tbl,
  cpu_percentage number,
  autonomous_data_storage_percentage number,
  provisioned_cpus number,
  total_cpus number,
  total_autonomous_data_storage_in_t_bs number,
  reserved_cpus number,
  provisionable_autonomous_container_databases number,
  provisioned_autonomous_container_databases number,
  non_provisionable_autonomous_container_databases number,
  exadata_storage_in_t_bs_lowest_scaled_value number,
  ocpus_lowest_scaled_value number,
  max_acds_lowest_scaled_value number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_cloud_autonomous_vm_cluster_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_cloud_autonomous_vm_cluster_summary_t (
    id varchar2,
    compartment_id varchar2,
    description varchar2,
    availability_domain varchar2,
    subnet_id varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    last_update_history_entry_id varchar2,
    lifecycle_state varchar2,
    display_name varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    cluster_time_zone varchar2,
    lifecycle_details varchar2,
    hostname varchar2,
    domain varchar2,
    cloud_exadata_infrastructure_id varchar2,
    shape varchar2,
    node_count number,
    data_storage_size_in_t_bs number,
    data_storage_size_in_g_bs number,
    cpu_core_count number,
    ocpu_count number,
    compute_model varchar2,
    is_mtls_enabled_vm_cluster number,
    cpu_core_count_per_node number,
    memory_size_in_g_bs number,
    license_model varchar2,
    last_maintenance_run_id varchar2,
    next_maintenance_run_id varchar2,
    maintenance_window dbms_cloud_oci_database_maintenance_window_t,
    scan_listener_port_tls number,
    scan_listener_port_non_tls number,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    time_database_ssl_certificate_expires timestamp with time zone,
    time_ords_certificate_expires timestamp with time zone,
    available_cpus number,
    reclaimable_cpus number,
    available_container_databases number,
    total_container_databases number,
    available_autonomous_data_storage_size_in_t_bs number,
    autonomous_data_storage_size_in_t_bs number,
    db_node_storage_size_in_g_bs number,
    memory_per_oracle_compute_unit_in_g_bs number,
    db_servers dbms_cloud_oci_database_varchar2_tbl,
    cpu_percentage number,
    autonomous_data_storage_percentage number,
    provisioned_cpus number,
    total_cpus number,
    total_autonomous_data_storage_in_t_bs number,
    reserved_cpus number,
    provisionable_autonomous_container_databases number,
    provisioned_autonomous_container_databases number,
    non_provisionable_autonomous_container_databases number,
    exadata_storage_in_t_bs_lowest_scaled_value number,
    ocpus_lowest_scaled_value number,
    max_acds_lowest_scaled_value number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Cloud Autonomous VM cluster.

compartment_id

(required) The OCID of the compartment.

description

(optional) User defined description of the cloud Autonomous VM cluster.

availability_domain

(required) The name of the availability domain that the cloud Autonomous VM cluster is located in.

subnet_id

(required) The OCID of the subnet the cloud Autonomous VM Cluster is associated with. **Subnet Restrictions:** - For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

nsg_ids

(optional) 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.

last_update_history_entry_id

(optional) The OCID of the last maintenance update history. This value is updated when a maintenance update starts.

lifecycle_state

(required) The current state of the cloud Autonomous VM cluster.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED', 'MAINTENANCE_IN_PROGRESS'

display_name

(required) The user-friendly name for the cloud Autonomous VM cluster. The name does not need to be unique.

time_created

(optional) The date and time that the cloud Autonomous VM cluster was created.

time_updated

(optional) The last date and time that the cloud Autonomous VM cluster was updated.

cluster_time_zone

(optional) The time zone of the Cloud Autonomous VM Cluster.

lifecycle_details

(optional) Additional information about the current lifecycle state.

hostname

(optional) The hostname for the cloud Autonomous VM cluster.

domain

(optional) The domain name for the cloud Autonomous VM cluster.

cloud_exadata_infrastructure_id

(required) The OCID of the cloud Exadata infrastructure.

shape

(optional) The model name of the Exadata hardware running the cloud Autonomous VM cluster.

node_count

(optional) The number of database servers in the cloud VM cluster.

data_storage_size_in_t_bs

(optional) The total data storage allocated, in terabytes (TB).

data_storage_size_in_g_bs

(optional) The total data storage allocated, in gigabytes (GB).

cpu_core_count

(optional) The number of CPU cores on the cloud Autonomous VM cluster.

ocpu_count

(optional) The number of CPU cores on the cloud Autonomous VM cluster. Only 1 decimal place is allowed for the fractional part.

compute_model

(optional) The compute model of the Cloud Autonomous VM Cluster.

Allowed values are: 'ECPU', 'OCPU'

is_mtls_enabled_vm_cluster

(optional) Enable mutual TLS(mTLS) authentication for database at time of provisioning a VMCluster. This is applicable to database TLS Certificates only. Default is TLS

cpu_core_count_per_node

(optional) The number of CPU cores enabled per VM cluster node.

memory_size_in_g_bs

(optional) The memory allocated in GBs.

license_model

(optional) 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`. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, maxCpuCoreCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

last_maintenance_run_id

(optional) The OCID of the last maintenance run.

next_maintenance_run_id

(optional) The OCID of the next maintenance run.

maintenance_window

(optional)

scan_listener_port_tls

(optional) The SCAN Listenenr TLS port. Default is 2484.

scan_listener_port_non_tls

(optional) The SCAN Listener Non TLS port. Default is 1521.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

time_database_ssl_certificate_expires

(optional) The date and time of Database SSL certificate expiration.

time_ords_certificate_expires

(optional) The date and time of ORDS certificate expiration.

available_cpus

(optional) CPU cores available for allocation to Autonomous Databases.

reclaimable_cpus

(optional) For Autonomous Databases on Dedicated Exadata Infrastructure: - These are the CPUs that continue to be included in the count of CPUs available to the Autonomous Container Database even after one of its Autonomous Database is terminated or scaled down. You can release them to the available CPUs at its parent Autonomous VM Cluster level by restarting the Autonomous Container Database. - The CPU type (OCPUs or ECPUs) is determined by the parent Autonomous Exadata VM Cluster's compute model.

available_container_databases

(optional) The number of Autonomous Container Databases that can be created with the currently available local storage.

total_container_databases

(optional) The total number of Autonomous Container Databases that can be created with the allocated local storage.

available_autonomous_data_storage_size_in_t_bs

(optional) The data disk group size available for Autonomous Databases, in TBs.

autonomous_data_storage_size_in_t_bs

(optional) The data disk group size allocated for Autonomous Databases, in TBs.

db_node_storage_size_in_g_bs

(optional) The local node storage allocated in GBs.

memory_per_oracle_compute_unit_in_g_bs

(optional) The amount of memory (in GBs) enabled per OCPU or ECPU.

db_servers

(optional) The list of OCIDs of the Db servers.

cpu_percentage

(optional) The percentage of total number of CPUs used in an Autonomous VM Cluster.

autonomous_data_storage_percentage

(optional) The percentage of the data storage used for the Autonomous Databases in an Autonomous VM Cluster.

provisioned_cpus

(optional) The number of CPUs provisioned in an Autonomous VM Cluster.

total_cpus

(optional) The total number of CPUs in an Autonomous VM Cluster.

total_autonomous_data_storage_in_t_bs

(optional) The total data disk group size for Autonomous Databases, in TBs.

reserved_cpus

(optional) The number of CPUs reserved in an Autonomous VM Cluster.

provisionable_autonomous_container_databases

(optional) The number of provisionable Autonomous Container Databases in an Autonomous VM Cluster.

provisioned_autonomous_container_databases

(optional) The number of provisioned Autonomous Container Databases in an Autonomous VM Cluster.

non_provisionable_autonomous_container_databases

(optional) The number of non-provisionable Autonomous Container Databases in an Autonomous VM Cluster.

exadata_storage_in_t_bs_lowest_scaled_value

(optional) The lowest value to which exadataStorage in TBs can be scaled down.

ocpus_lowest_scaled_value

(optional) The lowest value to which ocpus can be scaled down.

max_acds_lowest_scaled_value

(optional) The lowest value to which ACDs can be scaled down.

DBMS_CLOUD_OCI_DATABASE_CLOUD_DATABASE_MANAGEMENT_CONFIG_T Type

The configuration of the Database Management service.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_cloud_database_management_config_t FORCE AUTHID CURRENT_USER IS OBJECT (
  management_status varchar2(32767),
  management_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_cloud_database_management_config_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_cloud_database_management_config_t (
    management_status varchar2,
    management_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

management_status

(required) The status of the Database Management service.

Allowed values are: 'ENABLING', 'ENABLED', 'DISABLING', 'DISABLED', 'UPDATING', 'FAILED_ENABLING', 'FAILED_DISABLING', 'FAILED_UPDATING'

management_type

(required) The Database Management type.

Allowed values are: 'BASIC', 'ADVANCED'

DBMS_CLOUD_OCI_DATABASE_CLOUD_EXADATA_INFRASTRUCTURE_T Type

Details of the cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_cloud_exadata_infrastructure_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  lifecycle_state varchar2(32767),
  display_name varchar2(32767),
  shape varchar2(32767),
  availability_domain varchar2(32767),
  compute_count number,
  storage_count number,
  total_storage_size_in_g_bs number,
  available_storage_size_in_g_bs number,
  cpu_count number,
  max_cpu_count number,
  memory_size_in_g_bs number,
  max_memory_in_g_bs number,
  db_node_storage_size_in_g_bs number,
  max_db_node_storage_in_g_bs number,
  data_storage_size_in_t_bs number,
  max_data_storage_in_t_bs number,
  additional_storage_count number,
  activated_storage_count number,
  time_created timestamp with time zone,
  lifecycle_details varchar2(32767),
  maintenance_window dbms_cloud_oci_database_maintenance_window_t,
  last_maintenance_run_id varchar2(32767),
  next_maintenance_run_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  customer_contacts dbms_cloud_oci_database_customer_contact_tbl,
  storage_server_version varchar2(32767),
  db_server_version varchar2(32767),
  monthly_storage_server_version varchar2(32767),
  monthly_db_server_version varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_cloud_exadata_infrastructure_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_cloud_exadata_infrastructure_t (
    id varchar2,
    compartment_id varchar2,
    lifecycle_state varchar2,
    display_name varchar2,
    shape varchar2,
    availability_domain varchar2,
    compute_count number,
    storage_count number,
    total_storage_size_in_g_bs number,
    available_storage_size_in_g_bs number,
    cpu_count number,
    max_cpu_count number,
    memory_size_in_g_bs number,
    max_memory_in_g_bs number,
    db_node_storage_size_in_g_bs number,
    max_db_node_storage_in_g_bs number,
    data_storage_size_in_t_bs number,
    max_data_storage_in_t_bs number,
    additional_storage_count number,
    activated_storage_count number,
    time_created timestamp with time zone,
    lifecycle_details varchar2,
    maintenance_window dbms_cloud_oci_database_maintenance_window_t,
    last_maintenance_run_id varchar2,
    next_maintenance_run_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    customer_contacts dbms_cloud_oci_database_customer_contact_tbl,
    storage_server_version varchar2,
    db_server_version varchar2,
    monthly_storage_server_version varchar2,
    monthly_db_server_version varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the cloud Exadata infrastructure resource.

compartment_id

(required) The OCID of the compartment.

lifecycle_state

(required) The current lifecycle state of the cloud Exadata infrastructure resource.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED', 'MAINTENANCE_IN_PROGRESS'

display_name

(required) The user-friendly name for the cloud Exadata infrastructure resource. The name does not need to be unique.

shape

(required) The model name of the cloud Exadata infrastructure resource.

availability_domain

(required) The name of the availability domain that the cloud Exadata infrastructure resource is located in.

compute_count

(optional) The number of compute servers for the cloud Exadata infrastructure.

storage_count

(optional) The number of storage servers for the cloud Exadata infrastructure.

total_storage_size_in_g_bs

(optional) The total storage allocated to the cloud Exadata infrastructure resource, in gigabytes (GB).

available_storage_size_in_g_bs

(optional) The available storage can be allocated to the cloud Exadata infrastructure resource, in gigabytes (GB).

cpu_count

(optional) The total number of CPU cores allocated.

max_cpu_count

(optional) The total number of CPU cores available.

memory_size_in_g_bs

(optional) The memory allocated in GBs.

max_memory_in_g_bs

(optional) The total memory available in GBs.

db_node_storage_size_in_g_bs

(optional) The local node storage allocated in GBs.

max_db_node_storage_in_g_bs

(optional) The total local node storage available in GBs.

data_storage_size_in_t_bs

(optional) Size, in terabytes, of the DATA disk group.

max_data_storage_in_t_bs

(optional) The total available DATA disk group size.

additional_storage_count

(optional) The requested number of additional storage servers for the Exadata infrastructure.

activated_storage_count

(optional) The requested number of additional storage servers activated for the Exadata infrastructure.

time_created

(optional) The date and time the cloud Exadata infrastructure resource was created.

lifecycle_details

(optional) Additional information about the current lifecycle state.

maintenance_window

(optional)

last_maintenance_run_id

(optional) The OCID of the last maintenance run.

next_maintenance_run_id

(optional) The OCID of the next maintenance run.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

customer_contacts

(optional) The list of customer email addresses that receive information from Oracle about the specified OCI Database service resource. Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. Up to 10 email addresses can be added to the customer contacts for a cloud Exadata infrastructure instance.

storage_server_version

(optional) The software version of the storage servers (cells) in the cloud Exadata infrastructure. Example: 20.1.15

db_server_version

(optional) The software version of the database servers (dom0) in the cloud Exadata infrastructure. Example: 20.1.15

monthly_storage_server_version

(optional) The monthly software version of the storage servers (cells) in the cloud Exadata infrastructure. Example: 20.1.15

monthly_db_server_version

(optional) The monthly software version of the database servers (dom0) in the cloud Exadata infrastructure. Example: 20.1.15

DBMS_CLOUD_OCI_DATABASE_CLOUD_EXADATA_INFRASTRUCTURE_SUMMARY_T Type

Details of the cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_cloud_exadata_infrastructure_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  lifecycle_state varchar2(32767),
  display_name varchar2(32767),
  shape varchar2(32767),
  availability_domain varchar2(32767),
  compute_count number,
  storage_count number,
  total_storage_size_in_g_bs number,
  available_storage_size_in_g_bs number,
  cpu_count number,
  max_cpu_count number,
  memory_size_in_g_bs number,
  max_memory_in_g_bs number,
  db_node_storage_size_in_g_bs number,
  max_db_node_storage_in_g_bs number,
  data_storage_size_in_t_bs number,
  max_data_storage_in_t_bs number,
  additional_storage_count number,
  activated_storage_count number,
  time_created timestamp with time zone,
  lifecycle_details varchar2(32767),
  maintenance_window dbms_cloud_oci_database_maintenance_window_t,
  last_maintenance_run_id varchar2(32767),
  next_maintenance_run_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  customer_contacts dbms_cloud_oci_database_customer_contact_tbl,
  storage_server_version varchar2(32767),
  db_server_version varchar2(32767),
  monthly_storage_server_version varchar2(32767),
  monthly_db_server_version varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_cloud_exadata_infrastructure_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_cloud_exadata_infrastructure_summary_t (
    id varchar2,
    compartment_id varchar2,
    lifecycle_state varchar2,
    display_name varchar2,
    shape varchar2,
    availability_domain varchar2,
    compute_count number,
    storage_count number,
    total_storage_size_in_g_bs number,
    available_storage_size_in_g_bs number,
    cpu_count number,
    max_cpu_count number,
    memory_size_in_g_bs number,
    max_memory_in_g_bs number,
    db_node_storage_size_in_g_bs number,
    max_db_node_storage_in_g_bs number,
    data_storage_size_in_t_bs number,
    max_data_storage_in_t_bs number,
    additional_storage_count number,
    activated_storage_count number,
    time_created timestamp with time zone,
    lifecycle_details varchar2,
    maintenance_window dbms_cloud_oci_database_maintenance_window_t,
    last_maintenance_run_id varchar2,
    next_maintenance_run_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    customer_contacts dbms_cloud_oci_database_customer_contact_tbl,
    storage_server_version varchar2,
    db_server_version varchar2,
    monthly_storage_server_version varchar2,
    monthly_db_server_version varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the cloud Exadata infrastructure resource.

compartment_id

(required) The OCID of the compartment.

lifecycle_state

(required) The current lifecycle state of the cloud Exadata infrastructure resource.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED', 'MAINTENANCE_IN_PROGRESS'

display_name

(required) The user-friendly name for the cloud Exadata infrastructure resource. The name does not need to be unique.

shape

(required) The model name of the cloud Exadata infrastructure resource.

availability_domain

(required) The name of the availability domain that the cloud Exadata infrastructure resource is located in.

compute_count

(optional) The number of compute servers for the cloud Exadata infrastructure.

storage_count

(optional) The number of storage servers for the cloud Exadata infrastructure.

total_storage_size_in_g_bs

(optional) The total storage allocated to the cloud Exadata infrastructure resource, in gigabytes (GB).

available_storage_size_in_g_bs

(optional) The available storage can be allocated to the cloud Exadata infrastructure resource, in gigabytes (GB).

cpu_count

(optional) The total number of CPU cores allocated.

max_cpu_count

(optional) The total number of CPU cores available.

memory_size_in_g_bs

(optional) The memory allocated in GBs.

max_memory_in_g_bs

(optional) The total memory available in GBs.

db_node_storage_size_in_g_bs

(optional) The local node storage allocated in GBs.

max_db_node_storage_in_g_bs

(optional) The total local node storage available in GBs.

data_storage_size_in_t_bs

(optional) Size, in terabytes, of the DATA disk group.

max_data_storage_in_t_bs

(optional) The total available DATA disk group size.

additional_storage_count

(optional) The requested number of additional storage servers for the Exadata infrastructure.

activated_storage_count

(optional) The requested number of additional storage servers activated for the Exadata infrastructure.

time_created

(optional) The date and time the cloud Exadata infrastructure resource was created.

lifecycle_details

(optional) Additional information about the current lifecycle state.

maintenance_window

(optional)

last_maintenance_run_id

(optional) The OCID of the last maintenance run.

next_maintenance_run_id

(optional) The OCID of the next maintenance run.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

customer_contacts

(optional) The list of customer email addresses that receive information from Oracle about the specified OCI Database service resource. Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. Up to 10 email addresses can be added to the customer contacts for a cloud Exadata infrastructure instance.

storage_server_version

(optional) The software version of the storage servers (cells) in the cloud Exadata infrastructure. Example: 20.1.15

db_server_version

(optional) The software version of the database servers (dom0) in the cloud Exadata infrastructure. Example: 20.1.15

monthly_storage_server_version

(optional) The monthly software version of the storage servers (cells) in the cloud Exadata infrastructure. Example: 20.1.15

monthly_db_server_version

(optional) The monthly software version of the database servers (dom0) in the cloud Exadata infrastructure. Example: 20.1.15

DBMS_CLOUD_OCI_DATABASE_CLOUD_AUTONOMOUS_VM_CLUSTER_RESOURCE_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_database_cloud_autonomous_vm_cluster_resource_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_cloud_autonomous_vm_cluster_resource_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_cloud_autonomous_vm_cluster_resource_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_CLOUD_EXADATA_INFRASTRUCTURE_UNALLOCATED_RESOURCES_T Type

Details of unallocated resources of the Cloud Exadata infrastructure. Applies to Cloud Exadata infrastructure instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_cloud_exadata_infrastructure_unallocated_resources_t FORCE AUTHID CURRENT_USER IS OBJECT (
  cloud_exadata_infrastructure_id varchar2(32767),
  cloud_exadata_infrastructure_display_name varchar2(32767),
  local_storage_in_gbs number,
  ocpus number,
  memory_in_g_bs number,
  exadata_storage_in_t_bs number,
  cloud_autonomous_vm_clusters dbms_cloud_oci_database_cloud_autonomous_vm_cluster_resource_details_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_cloud_exadata_infrastructure_unallocated_resources_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_cloud_exadata_infrastructure_unallocated_resources_t (
    cloud_exadata_infrastructure_id varchar2,
    cloud_exadata_infrastructure_display_name varchar2,
    local_storage_in_gbs number,
    ocpus number,
    memory_in_g_bs number,
    exadata_storage_in_t_bs number,
    cloud_autonomous_vm_clusters dbms_cloud_oci_database_cloud_autonomous_vm_cluster_resource_details_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

cloud_exadata_infrastructure_id

(required) The OCID of the Cloud Exadata infrastructure.

cloud_exadata_infrastructure_display_name

(required) The user-friendly name for the Cloud Exadata infrastructure. The name does not need to be unique.

local_storage_in_gbs

(optional) The minimum amount of unallocated storage available across all nodes in the infrastructure.

ocpus

(optional) The minimum amount of unallocated ocpus available across all nodes in the infrastructure.

memory_in_g_bs

(optional) The minimum amount of unallocated memory available across all nodes in the infrastructure.

exadata_storage_in_t_bs

(optional) Total unallocated exadata storage in the infrastructure in TBs.

cloud_autonomous_vm_clusters

(optional) The list of Cloud Autonomous VM Clusters on the Infrastructure and their associated unallocated resources details.

DBMS_CLOUD_OCI_DATABASE_DB_IORM_CONFIG_T Type

The IORM configuration settings for the database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_db_iorm_config_t FORCE AUTHID CURRENT_USER IS OBJECT (
  db_name varchar2(32767),
  l_share number,
  flash_cache_limit varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_iorm_config_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_iorm_config_t (
    db_name varchar2,
    l_share number,
    flash_cache_limit varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

db_name

(optional) The database name. For the default `DbPlan`, the `dbName` is `default`.

l_share

(optional) The relative priority of this database.

flash_cache_limit

(optional) The flash cache limit for this database. This value is internally configured based on the share value assigned to the database.

DBMS_CLOUD_OCI_DATABASE_DB_IORM_CONFIG_TBL Type

Nested table type of dbms_cloud_oci_database_db_iorm_config_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_db_iorm_config_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_db_iorm_config_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_EXADATA_IORM_CONFIG_T Type

The IORM settings of the Exadata DB system.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_exadata_iorm_config_t FORCE AUTHID CURRENT_USER IS OBJECT (
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  objective varchar2(32767),
  db_plans dbms_cloud_oci_database_db_iorm_config_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_exadata_iorm_config_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_exadata_iorm_config_t (
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    objective varchar2,
    db_plans dbms_cloud_oci_database_db_iorm_config_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

lifecycle_state

(optional) The current state of IORM configuration for the Exadata DB system.

Allowed values are: 'BOOTSTRAPPING', 'ENABLED', 'DISABLED', 'UPDATING', 'FAILED'

lifecycle_details

(optional) Additional information about the current `lifecycleState`.

objective

(optional) The current value for the IORM objective. The default is `AUTO`.

Allowed values are: 'LOW_LATENCY', 'HIGH_THROUGHPUT', 'BALANCED', 'AUTO', 'BASIC'

db_plans

(optional) An array of IORM settings for all the database in the Exadata DB system.

DBMS_CLOUD_OCI_DATABASE_DATA_COLLECTION_OPTIONS_T Type

Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_data_collection_options_t FORCE AUTHID CURRENT_USER IS OBJECT (
  is_diagnostics_events_enabled number,
  is_health_monitoring_enabled number,
  is_incident_logs_enabled number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_data_collection_options_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_data_collection_options_t (
    is_diagnostics_events_enabled number,
    is_health_monitoring_enabled number,
    is_incident_logs_enabled number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

is_diagnostics_events_enabled

(optional) Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` or `updateCloudVmCluster` API.

is_health_monitoring_enabled

(optional) Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster`, `UpdateCloudVmCluster` or `updateDbsystem` API.

is_incident_logs_enabled

(optional) Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster`, `updateCloudVmCluster` or `updateDbsystem` API.

DBMS_CLOUD_OCI_DATABASE_CLOUD_VM_CLUSTER_T Type

Details of the cloud VM cluster. Applies to Exadata Cloud Service instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_cloud_vm_cluster_t FORCE AUTHID CURRENT_USER IS OBJECT (
  iorm_config_cache dbms_cloud_oci_database_exadata_iorm_config_t,
  id varchar2(32767),
  compartment_id varchar2(32767),
  availability_domain varchar2(32767),
  subnet_id varchar2(32767),
  backup_subnet_id varchar2(32767),
  nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  backup_network_nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  last_update_history_entry_id varchar2(32767),
  shape varchar2(32767),
  listener_port number,
  lifecycle_state varchar2(32767),
  node_count number,
  storage_size_in_g_bs number,
  display_name varchar2(32767),
  time_created timestamp with time zone,
  lifecycle_details varchar2(32767),
  time_zone varchar2(32767),
  hostname varchar2(32767),
  domain varchar2(32767),
  cpu_core_count number,
  ocpu_count number,
  memory_size_in_g_bs number,
  db_node_storage_size_in_g_bs number,
  data_storage_size_in_t_bs number,
  db_servers dbms_cloud_oci_database_varchar2_tbl,
  cluster_name varchar2(32767),
  data_storage_percentage number,
  is_local_backup_enabled number,
  cloud_exadata_infrastructure_id varchar2(32767),
  is_sparse_diskgroup_enabled number,
  gi_version varchar2(32767),
  system_version varchar2(32767),
  ssh_public_keys dbms_cloud_oci_database_varchar2_tbl,
  license_model varchar2(32767),
  disk_redundancy varchar2(32767),
  scan_ip_ids dbms_cloud_oci_database_varchar2_tbl,
  vip_ids dbms_cloud_oci_database_varchar2_tbl,
  scan_dns_record_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  scan_dns_name varchar2(32767),
  zone_id varchar2(32767),
  scan_listener_port_tcp number,
  scan_listener_port_tcp_ssl number,
  data_collection_options dbms_cloud_oci_database_data_collection_options_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_cloud_vm_cluster_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_cloud_vm_cluster_t (
    iorm_config_cache dbms_cloud_oci_database_exadata_iorm_config_t,
    id varchar2,
    compartment_id varchar2,
    availability_domain varchar2,
    subnet_id varchar2,
    backup_subnet_id varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    backup_network_nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    last_update_history_entry_id varchar2,
    shape varchar2,
    listener_port number,
    lifecycle_state varchar2,
    node_count number,
    storage_size_in_g_bs number,
    display_name varchar2,
    time_created timestamp with time zone,
    lifecycle_details varchar2,
    time_zone varchar2,
    hostname varchar2,
    domain varchar2,
    cpu_core_count number,
    ocpu_count number,
    memory_size_in_g_bs number,
    db_node_storage_size_in_g_bs number,
    data_storage_size_in_t_bs number,
    db_servers dbms_cloud_oci_database_varchar2_tbl,
    cluster_name varchar2,
    data_storage_percentage number,
    is_local_backup_enabled number,
    cloud_exadata_infrastructure_id varchar2,
    is_sparse_diskgroup_enabled number,
    gi_version varchar2,
    system_version varchar2,
    ssh_public_keys dbms_cloud_oci_database_varchar2_tbl,
    license_model varchar2,
    disk_redundancy varchar2,
    scan_ip_ids dbms_cloud_oci_database_varchar2_tbl,
    vip_ids dbms_cloud_oci_database_varchar2_tbl,
    scan_dns_record_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    scan_dns_name varchar2,
    zone_id varchar2,
    scan_listener_port_tcp number,
    scan_listener_port_tcp_ssl number,
    data_collection_options dbms_cloud_oci_database_data_collection_options_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

iorm_config_cache

(optional)

id

(required) The OCID of the cloud VM cluster.

compartment_id

(required) The OCID of the compartment.

availability_domain

(required) The name of the availability domain that the cloud Exadata infrastructure resource is located in.

subnet_id

(required) The OCID of the subnet associated with the cloud VM cluster. **Subnet Restrictions:** - For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

backup_subnet_id

(optional) The OCID of the backup network subnet associated with the cloud VM cluster. **Subnet Restriction:** See the subnet restrictions information for **subnetId**.

nsg_ids

(optional) 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.

backup_network_nsg_ids

(optional) A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

last_update_history_entry_id

(optional) The OCID of the last maintenance update history entry. This value is updated when a maintenance update starts.

shape

(required) The model name of the Exadata hardware running the cloud VM cluster.

listener_port

(optional) The port number configured for the listener on the cloud VM cluster.

lifecycle_state

(required) The current state of the cloud VM cluster.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED', 'MAINTENANCE_IN_PROGRESS'

node_count

(optional) The number of nodes in the cloud VM cluster.

storage_size_in_g_bs

(optional) The storage allocation for the disk group, in gigabytes (GB).

display_name

(required) The user-friendly name for the cloud VM cluster. The name does not need to be unique.

time_created

(optional) The date and time that the cloud VM cluster was created.

lifecycle_details

(optional) Additional information about the current lifecycle state.

time_zone

(optional) The time zone of the cloud VM cluster. For details, see Exadata Infrastructure Time Zones.

hostname

(required) The hostname for the cloud VM cluster.

domain

(required) The domain name for the cloud VM cluster.

cpu_core_count

(required) The number of CPU cores enabled on the cloud VM cluster.

ocpu_count

(optional) The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part.

memory_size_in_g_bs

(optional) The memory to be allocated in GBs.

db_node_storage_size_in_g_bs

(optional) The local node storage to be allocated in GBs.

data_storage_size_in_t_bs

(optional) The data disk group size to be allocated in TBs.

db_servers

(optional) The list of DB servers.

cluster_name

(optional) The cluster name for cloud VM cluster. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.

data_storage_percentage

(optional) The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 35, 40, 60 and 80. The default is 80 percent assigned to DATA storage. See Storage Configuration in the Exadata documentation for details on the impact of the configuration settings on storage.

is_local_backup_enabled

(optional) If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster.

cloud_exadata_infrastructure_id

(required) The OCID of the cloud Exadata infrastructure.

is_sparse_diskgroup_enabled

(optional) If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created.

gi_version

(optional) A valid Oracle Grid Infrastructure (GI) software version.

system_version

(optional) Operating system version of the image.

ssh_public_keys

(required) The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.

license_model

(optional) The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

disk_redundancy

(optional) The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.

Allowed values are: 'HIGH', 'NORMAL'

scan_ip_ids

(optional) The OCID of the Single Client Access Name (SCAN) IP addresses associated with the cloud VM cluster. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster. **Note:** For a single-node DB system, this list is empty.

vip_ids

(optional) The OCID of the virtual IP (VIP) addresses associated with the cloud VM cluster. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty.

scan_dns_record_id

(optional) The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

scan_dns_name

(optional) The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.

zone_id

(optional) The OCID of the zone the cloud VM cluster is associated with.

scan_listener_port_tcp

(optional) The TCP Single Client Access Name (SCAN) port. The default port is 1521.

scan_listener_port_tcp_ssl

(optional) The TCPS Single Client Access Name (SCAN) port. The default port is 2484.

data_collection_options

(optional)

DBMS_CLOUD_OCI_DATABASE_CLOUD_VM_CLUSTER_SUMMARY_T Type

Details of the cloud VM cluster. Applies to Exadata Cloud Service instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_cloud_vm_cluster_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  availability_domain varchar2(32767),
  subnet_id varchar2(32767),
  backup_subnet_id varchar2(32767),
  nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  backup_network_nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  last_update_history_entry_id varchar2(32767),
  shape varchar2(32767),
  listener_port number,
  lifecycle_state varchar2(32767),
  node_count number,
  storage_size_in_g_bs number,
  display_name varchar2(32767),
  time_created timestamp with time zone,
  lifecycle_details varchar2(32767),
  time_zone varchar2(32767),
  hostname varchar2(32767),
  domain varchar2(32767),
  cpu_core_count number,
  ocpu_count number,
  memory_size_in_g_bs number,
  db_node_storage_size_in_g_bs number,
  data_storage_size_in_t_bs number,
  db_servers dbms_cloud_oci_database_varchar2_tbl,
  cluster_name varchar2(32767),
  data_storage_percentage number,
  is_local_backup_enabled number,
  cloud_exadata_infrastructure_id varchar2(32767),
  is_sparse_diskgroup_enabled number,
  gi_version varchar2(32767),
  system_version varchar2(32767),
  ssh_public_keys dbms_cloud_oci_database_varchar2_tbl,
  license_model varchar2(32767),
  disk_redundancy varchar2(32767),
  scan_ip_ids dbms_cloud_oci_database_varchar2_tbl,
  vip_ids dbms_cloud_oci_database_varchar2_tbl,
  scan_dns_record_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  scan_dns_name varchar2(32767),
  zone_id varchar2(32767),
  scan_listener_port_tcp number,
  scan_listener_port_tcp_ssl number,
  data_collection_options dbms_cloud_oci_database_data_collection_options_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_cloud_vm_cluster_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_cloud_vm_cluster_summary_t (
    id varchar2,
    compartment_id varchar2,
    availability_domain varchar2,
    subnet_id varchar2,
    backup_subnet_id varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    backup_network_nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    last_update_history_entry_id varchar2,
    shape varchar2,
    listener_port number,
    lifecycle_state varchar2,
    node_count number,
    storage_size_in_g_bs number,
    display_name varchar2,
    time_created timestamp with time zone,
    lifecycle_details varchar2,
    time_zone varchar2,
    hostname varchar2,
    domain varchar2,
    cpu_core_count number,
    ocpu_count number,
    memory_size_in_g_bs number,
    db_node_storage_size_in_g_bs number,
    data_storage_size_in_t_bs number,
    db_servers dbms_cloud_oci_database_varchar2_tbl,
    cluster_name varchar2,
    data_storage_percentage number,
    is_local_backup_enabled number,
    cloud_exadata_infrastructure_id varchar2,
    is_sparse_diskgroup_enabled number,
    gi_version varchar2,
    system_version varchar2,
    ssh_public_keys dbms_cloud_oci_database_varchar2_tbl,
    license_model varchar2,
    disk_redundancy varchar2,
    scan_ip_ids dbms_cloud_oci_database_varchar2_tbl,
    vip_ids dbms_cloud_oci_database_varchar2_tbl,
    scan_dns_record_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    scan_dns_name varchar2,
    zone_id varchar2,
    scan_listener_port_tcp number,
    scan_listener_port_tcp_ssl number,
    data_collection_options dbms_cloud_oci_database_data_collection_options_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the cloud VM cluster.

compartment_id

(required) The OCID of the compartment.

availability_domain

(required) The name of the availability domain that the cloud Exadata infrastructure resource is located in.

subnet_id

(required) The OCID of the subnet associated with the cloud VM cluster. **Subnet Restrictions:** - For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

backup_subnet_id

(optional) The OCID of the backup network subnet associated with the cloud VM cluster. **Subnet Restriction:** See the subnet restrictions information for **subnetId**.

nsg_ids

(optional) 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.

backup_network_nsg_ids

(optional) A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

last_update_history_entry_id

(optional) The OCID of the last maintenance update history entry. This value is updated when a maintenance update starts.

shape

(required) The model name of the Exadata hardware running the cloud VM cluster.

listener_port

(optional) The port number configured for the listener on the cloud VM cluster.

lifecycle_state

(required) The current state of the cloud VM cluster.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED', 'MAINTENANCE_IN_PROGRESS'

node_count

(optional) The number of nodes in the cloud VM cluster.

storage_size_in_g_bs

(optional) The storage allocation for the disk group, in gigabytes (GB).

display_name

(required) The user-friendly name for the cloud VM cluster. The name does not need to be unique.

time_created

(optional) The date and time that the cloud VM cluster was created.

lifecycle_details

(optional) Additional information about the current lifecycle state.

time_zone

(optional) The time zone of the cloud VM cluster. For details, see Exadata Infrastructure Time Zones.

hostname

(required) The hostname for the cloud VM cluster.

domain

(required) The domain name for the cloud VM cluster.

cpu_core_count

(required) The number of CPU cores enabled on the cloud VM cluster.

ocpu_count

(optional) The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part.

memory_size_in_g_bs

(optional) The memory to be allocated in GBs.

db_node_storage_size_in_g_bs

(optional) The local node storage to be allocated in GBs.

data_storage_size_in_t_bs

(optional) The data disk group size to be allocated in TBs.

db_servers

(optional) The list of DB servers.

cluster_name

(optional) The cluster name for cloud VM cluster. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.

data_storage_percentage

(optional) The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 35, 40, 60 and 80. The default is 80 percent assigned to DATA storage. See Storage Configuration in the Exadata documentation for details on the impact of the configuration settings on storage.

is_local_backup_enabled

(optional) If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster.

cloud_exadata_infrastructure_id

(required) The OCID of the cloud Exadata infrastructure.

is_sparse_diskgroup_enabled

(optional) If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created.

gi_version

(optional) A valid Oracle Grid Infrastructure (GI) software version.

system_version

(optional) Operating system version of the image.

ssh_public_keys

(required) The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.

license_model

(optional) The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

disk_redundancy

(optional) The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.

Allowed values are: 'HIGH', 'NORMAL'

scan_ip_ids

(optional) The OCID of the Single Client Access Name (SCAN) IP addresses associated with the cloud VM cluster. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster. **Note:** For a single-node DB system, this list is empty.

vip_ids

(optional) The OCID of the virtual IP (VIP) addresses associated with the cloud VM cluster. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty.

scan_dns_record_id

(optional) The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

scan_dns_name

(optional) The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.

zone_id

(optional) The OCID of the zone the cloud VM cluster is associated with.

scan_listener_port_tcp

(optional) The TCP Single Client Access Name (SCAN) port. The default port is 1521.

scan_listener_port_tcp_ssl

(optional) The TCPS Single Client Access Name (SCAN) port. The default port is 2484.

data_collection_options

(optional)

DBMS_CLOUD_OCI_DATABASE_COMPLETE_EXTERNAL_BACKUP_JOB_DETAILS_T Type

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_complete_external_backup_job_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  tde_wallet_path varchar2(32767),
  cf_backup_handle varchar2(32767),
  spf_backup_handle varchar2(32767),
  sql_patches dbms_cloud_oci_database_varchar2_tbl,
  data_size number,
  redo_size number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_complete_external_backup_job_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_complete_external_backup_job_details_t (
    tde_wallet_path varchar2,
    cf_backup_handle varchar2,
    spf_backup_handle varchar2,
    sql_patches dbms_cloud_oci_database_varchar2_tbl,
    data_size number,
    redo_size number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

tde_wallet_path

(optional) If the database being backed up is TDE enabled, this will be the path to the associated TDE wallet in Object Storage.

cf_backup_handle

(optional) The handle of the control file backup.

spf_backup_handle

(optional) The handle of the spfile backup.

sql_patches

(optional) The list of SQL patches that need to be applied to the backup during the restore.

data_size

(optional) The size of the data in the database, in megabytes.

redo_size

(optional) The size of the redo in the database, in megabytes.

DBMS_CLOUD_OCI_DATABASE_COMPUTE_PERFORMANCE_SUMMARY_T Type

Parameters detailing the compute performance for a specified DB system shape.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_compute_performance_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  cpu_core_count number,
  memory_in_g_bs number,
  network_bandwidth_in_gbps number,
  network_iops number,
  network_throughput_in_mbps number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_compute_performance_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_compute_performance_summary_t (
    cpu_core_count number,
    memory_in_g_bs number,
    network_bandwidth_in_gbps number,
    network_iops number,
    network_throughput_in_mbps number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

cpu_core_count

(required) The number of OCPU cores available.

memory_in_g_bs

(required) The amount of memory allocated for the VMDB System.

network_bandwidth_in_gbps

(required) The network bandwidth of the VMDB system in gbps.

network_iops

(required) IOPS for the VMDB System.

network_throughput_in_mbps

(required) Network throughput for the VMDB System.

DBMS_CLOUD_OCI_DATABASE_CONFIGURE_AUTONOMOUS_DATABASE_VAULT_KEY_DETAILS_T Type

Configuration details for the Autonomous Database vault key.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_configure_autonomous_database_vault_key_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  kms_key_id varchar2(32767),
  vault_id varchar2(32767),
  is_using_oracle_managed_keys number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_configure_autonomous_database_vault_key_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_configure_autonomous_database_vault_key_details_t (
    kms_key_id varchar2,
    vault_id varchar2,
    is_using_oracle_managed_keys number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

kms_key_id

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

vault_id

(optional) The OCID of the Oracle Cloud Infrastructure vault.

is_using_oracle_managed_keys

(optional) True if disable Customer Managed Keys and use Oracle Managed Keys.

DBMS_CLOUD_OCI_DATABASE_CONFIGURE_SAAS_ADMIN_USER_DETAILS_T Type

Details to update SaaS administrative user configuration.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_configure_saas_admin_user_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  password varchar2(32767),
  secret_id varchar2(32767),
  secret_version_number number,
  duration number,
  is_enabled number,
  access_type varchar2(32767),
  time_saas_admin_user_enabled timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_configure_saas_admin_user_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_configure_saas_admin_user_details_t (
    password varchar2,
    secret_id varchar2,
    secret_version_number number,
    duration number,
    is_enabled number,
    access_type varchar2,
    time_saas_admin_user_enabled timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

password

(optional) A strong password for SaaS administrative user. The password must be a minimum of nine (9) characters and contain a minimum of two (2) uppercase, two (2) lowercase, two (2) numbers, and two (2) special characters from _ (underscore), \\# (hashtag), or - (dash).

secret_id

(optional) The OCID of the Oracle Cloud Infrastructure secret.

secret_version_number

(optional) The version of the vault secret. If no version is specified, the latest version will be used.

duration

(optional) How long, in hours, the SaaS administrative user will stay enabled. If no duration is specified, the default value 1 will be used.

is_enabled

(optional) Indicates if the SaaS administrative user is enabled for the Autonomous Database.

access_type

(optional) The access type for the SaaS administrative user. If no access type is specified, the READ_ONLY access type is used.

Allowed values are: 'READ_ONLY', 'READ_WRITE', 'ADMIN'

time_saas_admin_user_enabled

(optional) The date and time the SaaS administrative user was enabled at, for the Autonomous Database.

DBMS_CLOUD_OCI_DATABASE_CONSOLE_CONNECTION_T Type

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_console_connection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  db_node_id varchar2(32767),
  connection_string varchar2(32767),
  fingerprint varchar2(32767),
  service_host_key_fingerprint varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  lifecycle_details varchar2(32767),
  lifecycle_state varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_console_connection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_console_connection_t (
    id varchar2,
    compartment_id varchar2,
    db_node_id varchar2,
    connection_string varchar2,
    fingerprint varchar2,
    service_host_key_fingerprint varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    lifecycle_details varchar2,
    lifecycle_state varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the console connection.

compartment_id

(required) The OCID of the compartment to contain the console connection.

db_node_id

(required) The OCID of the database node.

connection_string

(required) The SSH connection string for the console connection.

fingerprint

(required) The SSH public key fingerprint for the console connection.

service_host_key_fingerprint

(optional) The SSH public key's fingerprint for the console connection service host.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

lifecycle_details

(optional) Information about the current lifecycle state.

lifecycle_state

(required) The current state of the console connection.

Allowed values are: 'ACTIVE', 'CREATING', 'DELETED', 'DELETING', 'FAILED'

DBMS_CLOUD_OCI_DATABASE_CONSOLE_CONNECTION_SUMMARY_T Type

The `InstanceConsoleConnection` API provides you with console access to dbnode enabling you to troubleshoot malfunctioning dbnode.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_console_connection_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  db_node_id varchar2(32767),
  connection_string varchar2(32767),
  fingerprint varchar2(32767),
  service_host_key_fingerprint varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  lifecycle_details varchar2(32767),
  lifecycle_state varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_console_connection_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_console_connection_summary_t (
    id varchar2,
    compartment_id varchar2,
    db_node_id varchar2,
    connection_string varchar2,
    fingerprint varchar2,
    service_host_key_fingerprint varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    lifecycle_details varchar2,
    lifecycle_state varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the console connection.

compartment_id

(required) The OCID of the compartment to contain the console connection.

db_node_id

(required) The OCID of the database node.

connection_string

(required) The SSH connection string for the console connection.

fingerprint

(required) The SSH public key fingerprint for the console connection.

service_host_key_fingerprint

(optional) The SSH public key's fingerprint for the console connection service host.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

lifecycle_details

(optional) Information about the current lifecycle state.

lifecycle_state

(required) The current state of the console connection.

Allowed values are: 'ACTIVE', 'CREATING', 'DELETED', 'DELETING', 'FAILED'

DBMS_CLOUD_OCI_DATABASE_CONSOLE_HISTORY_T Type

The details of the Db Node console history.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_console_history_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  db_node_id varchar2(32767),
  display_name varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_created timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_console_history_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_console_history_t (
    id varchar2,
    compartment_id varchar2,
    db_node_id varchar2,
    display_name varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_created timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the console history.

compartment_id

(required) The OCID of the compartment containing the console history.

db_node_id

(required) The OCID of the database node.

display_name

(optional) The user-friendly name for the console history. The name does not need to be unique.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

lifecycle_state

(required) The current state of the console history.

Allowed values are: 'REQUESTED', 'GETTING_HISTORY', 'SUCCEEDED', 'FAILED', 'DELETED', 'DELETING'

lifecycle_details

(optional) Additional information about the current lifecycle state.

time_created

(required) The date and time the console history was created.

DBMS_CLOUD_OCI_DATABASE_CONSOLE_HISTORY_SUMMARY_T Type

The details of the Db Node console history.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_console_history_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  db_node_id varchar2(32767),
  display_name varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_created timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_console_history_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_console_history_summary_t (
    id varchar2,
    compartment_id varchar2,
    db_node_id varchar2,
    display_name varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_created timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the console history.

compartment_id

(required) The OCID of the compartment containing the console history.

db_node_id

(required) The OCID of the database node.

display_name

(optional) The user-friendly name for the console history. The name does not need to be unique.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

lifecycle_state

(required) The current state of the console history.

Allowed values are: 'REQUESTED', 'GETTING_HISTORY', 'SUCCEEDED', 'FAILED', 'DELETED', 'DELETING'

lifecycle_details

(optional) Additional information about the current lifecycle state.

time_created

(required) The date and time the console history was created.

DBMS_CLOUD_OCI_DATABASE_CONSOLE_HISTORY_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_database_console_history_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_console_history_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_console_history_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_CONSOLE_HISTORY_COLLECTION_T Type

Results of the Db Node console history lists. Contains ConsoleHistorySummary items.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_console_history_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_database_console_history_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_console_history_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_console_history_collection_t (
    items dbms_cloud_oci_database_console_history_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of Db Node console histories.

DBMS_CLOUD_OCI_DATABASE_CONVERT_TO_PDB_TARGET_BASE_T Type

Details of the container database in which the converted pluggable database will be located.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_convert_to_pdb_target_base_t FORCE AUTHID CURRENT_USER IS OBJECT (
  target varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_convert_to_pdb_target_base_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_convert_to_pdb_target_base_t (
    target varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

target

(optional) The target container database of the pluggable database created by the database conversion operation. Currently, the database conversion operation only supports creating the pluggable database in a new container database. - Use `NEW_DATABASE` to specify that the pluggable database be created within a new container database in the same database home.

Allowed values are: 'NEW_DATABASE'

DBMS_CLOUD_OCI_DATABASE_CONVERT_TO_PDB_DETAILS_T Type

Details for converting a non-container database to pluggable database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_convert_to_pdb_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  action varchar2(32767),
  convert_to_pdb_target_details dbms_cloud_oci_database_convert_to_pdb_target_base_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_convert_to_pdb_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_convert_to_pdb_details_t (
    action varchar2,
    convert_to_pdb_target_details dbms_cloud_oci_database_convert_to_pdb_target_base_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

action

(required) The operations used to convert a non-container database to a pluggable database. - Use `PRECHECK` to run a pre-check operation on non-container database prior to converting it into a pluggable database. - Use `CONVERT` to convert a non-container database into a pluggable database. - Use `SYNC` if the non-container database was manually converted into a pluggable database using the dbcli command-line utility. Databases may need to be converted manually if the CONVERT action fails when converting a non-container database using the API. - Use `SYNC_ROLLBACK` if the conversion of a non-container database into a pluggable database was manually rolled back using the dbcli command line utility. Conversions may need to be manually rolled back if the CONVERT action fails when converting a non-container database using the API.

Allowed values are: 'PRECHECK', 'CONVERT', 'SYNC', 'SYNC_ROLLBACK'

convert_to_pdb_target_details

(optional)

DBMS_CLOUD_OCI_DATABASE_CONVERT_TO_REGULAR_PLUGGABLE_DATABASE_DETAILS_T Type

Parameters for converting Refreshable Clone Pluggable Database into Regular Pluggable Database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_convert_to_regular_pluggable_database_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  should_create_pdb_backup number,
  container_database_admin_password varchar2(32767),
  tde_wallet_password varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_convert_to_regular_pluggable_database_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_convert_to_regular_pluggable_database_details_t (
    should_create_pdb_backup number,
    container_database_admin_password varchar2,
    tde_wallet_password varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

should_create_pdb_backup

(optional) Indicates whether to take Pluggable Database Backup after the operation.

container_database_admin_password

(optional) The DB system administrator password of the Container Database.

tde_wallet_password

(optional) The existing TDE wallet password of the Container Database.

DBMS_CLOUD_OCI_DATABASE_CREATE_APPLICATION_VIP_DETAILS_T Type

Details to create an application virtual IP (VIP) address on a cloud VM cluster.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_application_vip_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  hostname_label varchar2(32767),
  db_node_id varchar2(32767),
  cloud_vm_cluster_id varchar2(32767),
  subnet_id varchar2(32767),
  ip_address varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_application_vip_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_application_vip_details_t (
    hostname_label varchar2,
    db_node_id varchar2,
    cloud_vm_cluster_id varchar2,
    subnet_id varchar2,
    ip_address varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

hostname_label

(required) The hostname of the application virtual IP (VIP) address.

db_node_id

(optional) The OCID of the DB node associated with the application virtual IP (VIP) address.

cloud_vm_cluster_id

(required) The OCID of the cloud VM cluster associated with the application virtual IP (VIP) address.

subnet_id

(required) The OCID of the subnet associated with the application virtual IP (VIP) address.

ip_address

(optional) The application virtual IP (VIP) address.

DBMS_CLOUD_OCI_DATABASE_PEER_AUTONOMOUS_CONTAINER_DATABASE_BACKUP_CONFIG_T Type

Backup options for the standby Autonomous Container Database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_peer_autonomous_container_database_backup_config_t FORCE AUTHID CURRENT_USER IS OBJECT (
  backup_destination_details dbms_cloud_oci_database_backup_destination_details_tbl,
  recovery_window_in_days number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_peer_autonomous_container_database_backup_config_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_peer_autonomous_container_database_backup_config_t (
    backup_destination_details dbms_cloud_oci_database_backup_destination_details_tbl,
    recovery_window_in_days number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

backup_destination_details

(optional) Backup destination details.

recovery_window_in_days

(optional) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups. If the number of specified days is 0 then there will be no backups.

DBMS_CLOUD_OCI_DATABASE_CREATE_AUTONOMOUS_CONTAINER_DATABASE_DATAGUARD_ASSOCIATION_DETAILS_T Type

Create Autonomous Dataguard Association to an existing Autonomous Container Database

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_autonomous_container_database_dataguard_association_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  peer_autonomous_container_database_display_name varchar2(32767),
  peer_autonomous_container_database_compartment_id varchar2(32767),
  peer_cloud_autonomous_vm_cluster_id varchar2(32767),
  peer_autonomous_container_database_backup_config dbms_cloud_oci_database_peer_autonomous_container_database_backup_config_t,
  is_automatic_failover_enabled number,
  protection_mode varchar2(32767),
  fast_start_fail_over_lag_limit_in_seconds number,
  standby_maintenance_buffer_in_days number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_autonomous_container_database_dataguard_association_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_autonomous_container_database_dataguard_association_details_t (
    peer_autonomous_container_database_display_name varchar2,
    peer_autonomous_container_database_compartment_id varchar2,
    peer_cloud_autonomous_vm_cluster_id varchar2,
    peer_autonomous_container_database_backup_config dbms_cloud_oci_database_peer_autonomous_container_database_backup_config_t,
    is_automatic_failover_enabled number,
    protection_mode varchar2,
    fast_start_fail_over_lag_limit_in_seconds number,
    standby_maintenance_buffer_in_days number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

peer_autonomous_container_database_display_name

(required) The display name for the peer Autonomous Container Database.

peer_autonomous_container_database_compartment_id

(optional) The OCID of the compartment where the standby Autonomous Container Database will be created.

peer_cloud_autonomous_vm_cluster_id

(required) The OCID of the peer cloud Autonomous Exadata VM Cluster.

peer_autonomous_container_database_backup_config

(optional)

is_automatic_failover_enabled

(optional) Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association

protection_mode

(required) The protection mode of this Autonomous Data Guard association. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

Allowed values are: 'MAXIMUM_AVAILABILITY', 'MAXIMUM_PERFORMANCE'

fast_start_fail_over_lag_limit_in_seconds

(optional) The lag time for my preference based on data loss tolerance in seconds.

standby_maintenance_buffer_in_days

(optional) The scheduling detail for the quarterly maintenance window of the standby Autonomous Container Database. This value represents the number of days before scheduled maintenance of the primary database.

DBMS_CLOUD_OCI_DATABASE_CREATE_AUTONOMOUS_CONTAINER_DATABASE_DETAILS_T Type

Describes the required parameters for the creation of an Autonomous Container Database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_autonomous_container_database_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  db_unique_name varchar2(32767),
  db_name varchar2(32767),
  service_level_agreement_type varchar2(32767),
  autonomous_exadata_infrastructure_id varchar2(32767),
  db_version varchar2(32767),
  peer_autonomous_exadata_infrastructure_id varchar2(32767),
  peer_autonomous_container_database_display_name varchar2(32767),
  protection_mode varchar2(32767),
  fast_start_fail_over_lag_limit_in_seconds number,
  is_automatic_failover_enabled number,
  peer_cloud_autonomous_vm_cluster_id varchar2(32767),
  peer_autonomous_vm_cluster_id varchar2(32767),
  peer_autonomous_container_database_compartment_id varchar2(32767),
  peer_autonomous_container_database_backup_config dbms_cloud_oci_database_peer_autonomous_container_database_backup_config_t,
  peer_db_unique_name varchar2(32767),
  autonomous_vm_cluster_id varchar2(32767),
  cloud_autonomous_vm_cluster_id varchar2(32767),
  compartment_id varchar2(32767),
  patch_model varchar2(32767),
  maintenance_window_details dbms_cloud_oci_database_maintenance_window_t,
  standby_maintenance_buffer_in_days number,
  version_preference varchar2(32767),
  is_dst_file_update_enabled number,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  backup_config dbms_cloud_oci_database_autonomous_container_database_backup_config_t,
  kms_key_id varchar2(32767),
  kms_key_version_id varchar2(32767),
  vault_id varchar2(32767),
  key_store_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_autonomous_container_database_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_autonomous_container_database_details_t (
    display_name varchar2,
    db_unique_name varchar2,
    db_name varchar2,
    service_level_agreement_type varchar2,
    autonomous_exadata_infrastructure_id varchar2,
    db_version varchar2,
    peer_autonomous_exadata_infrastructure_id varchar2,
    peer_autonomous_container_database_display_name varchar2,
    protection_mode varchar2,
    fast_start_fail_over_lag_limit_in_seconds number,
    is_automatic_failover_enabled number,
    peer_cloud_autonomous_vm_cluster_id varchar2,
    peer_autonomous_vm_cluster_id varchar2,
    peer_autonomous_container_database_compartment_id varchar2,
    peer_autonomous_container_database_backup_config dbms_cloud_oci_database_peer_autonomous_container_database_backup_config_t,
    peer_db_unique_name varchar2,
    autonomous_vm_cluster_id varchar2,
    cloud_autonomous_vm_cluster_id varchar2,
    compartment_id varchar2,
    patch_model varchar2,
    maintenance_window_details dbms_cloud_oci_database_maintenance_window_t,
    standby_maintenance_buffer_in_days number,
    version_preference varchar2,
    is_dst_file_update_enabled number,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    backup_config dbms_cloud_oci_database_autonomous_container_database_backup_config_t,
    kms_key_id varchar2,
    kms_key_version_id varchar2,
    vault_id varchar2,
    key_store_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(required) The display name for the Autonomous Container Database.

db_unique_name

(optional) **Deprecated.** The `DB_UNIQUE_NAME` value is set by Oracle Cloud Infrastructure. Do not specify a value for this parameter. Specifying a value for this field will cause Terraform operations to fail.

db_name

(optional) The Database name for the Autonomous Container Database. The name must be unique within the Cloud Autonomous VM Cluster, starting with an alphabetic character, followed by 1 to 7 alphanumeric characters.

service_level_agreement_type

(optional) The service level agreement type of the Autonomous Container Database. The default is STANDARD. For an autonomous dataguard Autonomous Container Database, the specified Autonomous Exadata Infrastructure must be associated with a remote Autonomous Exadata Infrastructure.

Allowed values are: 'STANDARD', 'AUTONOMOUS_DATAGUARD'

autonomous_exadata_infrastructure_id

(optional) **No longer used.** This parameter is no longer used for Autonomous Database on dedicated Exadata infrasture. Specify a `cloudAutonomousVmClusterId` instead. Using this parameter will cause the operation to fail.

db_version

(optional) The base version for the Autonomous Container Database.

peer_autonomous_exadata_infrastructure_id

(optional) *No longer used.* This parameter is no longer used for Autonomous Database on dedicated Exadata infrasture. Specify a `peerCloudAutonomousVmClusterId` instead. Using this parameter will cause the operation to fail.

peer_autonomous_container_database_display_name

(optional) The display name for the peer Autonomous Container Database.

protection_mode

(optional) The protection mode of this Autonomous Data Guard association. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

Allowed values are: 'MAXIMUM_AVAILABILITY', 'MAXIMUM_PERFORMANCE'

fast_start_fail_over_lag_limit_in_seconds

(optional) The lag time for my preference based on data loss tolerance in seconds.

is_automatic_failover_enabled

(optional) Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association

peer_cloud_autonomous_vm_cluster_id

(optional) The OCID of the peer cloud Autonomous Exadata VM Cluster.

peer_autonomous_vm_cluster_id

(optional) The OCID of the peer Autonomous VM cluster for Autonomous Data Guard. Required to enable Data Guard.

peer_autonomous_container_database_compartment_id

(optional) The OCID of the compartment where the standby Autonomous Container Database will be created.

peer_autonomous_container_database_backup_config

(optional)

peer_db_unique_name

(optional) **Deprecated.** The `DB_UNIQUE_NAME` of the peer Autonomous Container Database in a Data Guard association is set by Oracle Cloud Infrastructure. Do not specify a value for this parameter. Specifying a value for this field will cause Terraform operations to fail.

autonomous_vm_cluster_id

(optional) The OCID of the Autonomous VM Cluster.

cloud_autonomous_vm_cluster_id

(optional) The OCID of the cloud Autonomous Exadata VM Cluster.

compartment_id

(optional) The OCID of the compartment containing the Autonomous Container Database.

patch_model

(required) Database Patch model preference.

Allowed values are: 'RELEASE_UPDATES', 'RELEASE_UPDATE_REVISIONS'

maintenance_window_details

(optional)

standby_maintenance_buffer_in_days

(optional) The scheduling detail for the quarterly maintenance window of the standby Autonomous Container Database. This value represents the number of days before scheduled maintenance of the primary database.

version_preference

(optional) The next maintenance version preference.

Allowed values are: 'NEXT_RELEASE_UPDATE', 'LATEST_RELEASE_UPDATE'

is_dst_file_update_enabled

(optional) Indicates if an automatic DST Time Zone file update is enabled for the Autonomous Container Database. If enabled along with Release Update, patching will be done in a Non-Rolling manner.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

backup_config

(optional)

kms_key_id

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

kms_key_version_id

(optional) 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.

vault_id

(optional) The OCID of the Oracle Cloud Infrastructure vault.

key_store_id

(optional) The OCID of the key store.

DBMS_CLOUD_OCI_DATABASE_CREATE_AUTONOMOUS_DATABASE_BACKUP_DETAILS_T Type

Details to create an Oracle Autonomous Database backup. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_autonomous_database_backup_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  autonomous_database_id varchar2(32767),
  retention_period_in_days number,
  is_long_term_backup number,
  backup_destination_details dbms_cloud_oci_database_backup_destination_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_autonomous_database_backup_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_autonomous_database_backup_details_t (
    display_name varchar2,
    autonomous_database_id varchar2,
    retention_period_in_days number,
    is_long_term_backup number,
    backup_destination_details dbms_cloud_oci_database_backup_destination_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) The user-friendly name for the backup. The name does not have to be unique.

autonomous_database_id

(required) The OCID of the Autonomous Database backup.

retention_period_in_days

(optional) Retention period, in days, for long-term backups

is_long_term_backup

(optional) Indicates whether the backup is long-term

backup_destination_details

(optional)

DBMS_CLOUD_OCI_DATABASE_CREATE_AUTONOMOUS_DATABASE_BASE_T Type

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

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_autonomous_database_base_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  character_set varchar2(32767),
  ncharacter_set varchar2(32767),
  db_name varchar2(32767),
  cpu_core_count number,
  backup_retention_period_in_days number,
  compute_model varchar2(32767),
  compute_count number,
  ocpu_count number,
  db_workload varchar2(32767),
  data_storage_size_in_t_bs number,
  data_storage_size_in_g_bs number,
  is_free_tier number,
  kms_key_id varchar2(32767),
  vault_id varchar2(32767),
  admin_password varchar2(32767),
  display_name varchar2(32767),
  license_model varchar2(32767),
  is_preview_version_with_service_terms_accepted number,
  is_auto_scaling_enabled number,
  is_dedicated number,
  autonomous_container_database_id varchar2(32767),
  in_memory_percentage number,
  is_access_control_enabled number,
  whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
  are_primary_whitelisted_ips_used number,
  standby_whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
  is_data_guard_enabled number,
  is_local_data_guard_enabled number,
  subnet_id varchar2(32767),
  nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  private_endpoint_label varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  private_endpoint_ip varchar2(32767),
  db_version varchar2(32767),
  source varchar2(32767),
  customer_contacts dbms_cloud_oci_database_customer_contact_tbl,
  is_mtls_connection_required number,
  resource_pool_leader_id varchar2(32767),
  resource_pool_summary dbms_cloud_oci_database_resource_pool_summary_t,
  autonomous_maintenance_schedule_type varchar2(32767),
  scheduled_operations dbms_cloud_oci_database_scheduled_operation_details_tbl,
  is_auto_scaling_for_storage_enabled number,
  max_cpu_core_count number,
  database_edition varchar2(32767),
  db_tools_details dbms_cloud_oci_database_database_tool_tbl,
  secret_id varchar2(32767),
  secret_version_number number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_autonomous_database_base_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_autonomous_database_base_t (
    compartment_id varchar2,
    character_set varchar2,
    ncharacter_set varchar2,
    db_name varchar2,
    cpu_core_count number,
    backup_retention_period_in_days number,
    compute_model varchar2,
    compute_count number,
    ocpu_count number,
    db_workload varchar2,
    data_storage_size_in_t_bs number,
    data_storage_size_in_g_bs number,
    is_free_tier number,
    kms_key_id varchar2,
    vault_id varchar2,
    admin_password varchar2,
    display_name varchar2,
    license_model varchar2,
    is_preview_version_with_service_terms_accepted number,
    is_auto_scaling_enabled number,
    is_dedicated number,
    autonomous_container_database_id varchar2,
    in_memory_percentage number,
    is_access_control_enabled number,
    whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
    are_primary_whitelisted_ips_used number,
    standby_whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
    is_data_guard_enabled number,
    is_local_data_guard_enabled number,
    subnet_id varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    private_endpoint_label varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    private_endpoint_ip varchar2,
    db_version varchar2,
    source varchar2,
    customer_contacts dbms_cloud_oci_database_customer_contact_tbl,
    is_mtls_connection_required number,
    resource_pool_leader_id varchar2,
    resource_pool_summary dbms_cloud_oci_database_resource_pool_summary_t,
    autonomous_maintenance_schedule_type varchar2,
    scheduled_operations dbms_cloud_oci_database_scheduled_operation_details_tbl,
    is_auto_scaling_for_storage_enabled number,
    max_cpu_core_count number,
    database_edition varchar2,
    db_tools_details dbms_cloud_oci_database_database_tool_tbl,
    secret_id varchar2,
    secret_version_number number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

compartment_id

(required) The OCID of the compartment of the Autonomous Database.

character_set

(optional) The character set for the autonomous database. The default is AL32UTF8. Allowed values for an Autonomous Database Serverless instance as as returned by List Autonomous Database Character Sets For an Autonomous Database on dedicated infrastructure, the 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

ncharacter_set

(optional) The character set for the Autonomous Database. The default is AL32UTF8. Use List Autonomous Database Character Sets to list the allowed values for an Autonomous Database Serverless instance. For an Autonomous Database on dedicated Exadata infrastructure, the allowed values are: AL16UTF16 or UTF8.

db_name

(optional) The database name. The name must begin with an alphabetic character and can contain a maximum of 14 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy. It is required in all cases except when creating a cross-region Autonomous Data Guard standby instance or a cross-region disaster recovery standby instance.

cpu_core_count

(optional) The number of OCPU cores to be made available to the database. 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 `ocpuCount` parameter.

backup_retention_period_in_days

(optional) Retention period, in days, for long-term backups

compute_model

(optional) 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.

Allowed values are: 'ECPU', 'OCPU'

compute_count

(optional) The compute amount 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 values in multiples of two. Required when using the `computeModel` parameter. When using `cpuCoreCount` parameter, it is an error to specify computeCount to a non-null value.

ocpu_count

(optional) 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 1 or more cores, you must 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 an Autonomous Database Serverless instance or an Autonomous Database on Dedicated Exadata Infrastructure. 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.

db_workload

(optional) The Autonomous Database workload type. The following values are valid: - OLTP - indicates an Autonomous Transaction Processing database - DW - indicates an Autonomous Data Warehouse database - AJD - indicates an Autonomous JSON Database - APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

Allowed values are: 'OLTP', 'DW', 'AJD', 'APEX'

data_storage_size_in_t_bs

(optional) The size, in terabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. For Autonomous Databases on dedicated Exadata infrastructure, the maximum storage value is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details. A full Exadata service is allocated when the Autonomous Database size is set to the upper limit (384 TB). **Note:** This parameter cannot be used with the `dataStorageSizeInGBs` parameter.

data_storage_size_in_g_bs

(optional) The size, in gigabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. The maximum storage value is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details. **Notes** - This parameter is only supported for dedicated Exadata infrastructure. - This parameter cannot be used with the `dataStorageSizeInTBs` parameter.

is_free_tier

(optional) 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

kms_key_id

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

vault_id

(optional) The OCID of the Oracle Cloud Infrastructure vault.

admin_password

(optional) **Important** The `adminPassword` or `secretId` must be specified for all Autonomous Databases except for refreshable clones. The password must be between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (\") or the username \"admin\", regardless of casing. This cannot be used in conjunction with with OCI vault secrets (secretId).

display_name

(optional) The user-friendly name for the Autonomous Database. The name does not have to be unique.

license_model

(optional) 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`. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, maxCpuCoreCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

is_preview_version_with_service_terms_accepted

(optional) If set to `TRUE`, indicates that an Autonomous Database preview version is being provisioned, and that the preview version's terms of service have been accepted. Note that preview version software is only available for Autonomous Database Serverless instances.

is_auto_scaling_enabled

(optional) Indicates if auto scaling is enabled for the Autonomous Database OCPU core count. The default value is `FALSE`.

is_dedicated

(optional) True if the database is on dedicated Exadata infrastructure.

autonomous_container_database_id

(optional) The Autonomous Container Database OCID.

in_memory_percentage

(optional) The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous Database.

is_access_control_enabled

(optional) 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.

whitelisted_ips

(optional) 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. 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). Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. 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.

are_primary_whitelisted_ips_used

(optional) 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.

standby_whitelisted_ips

(optional) 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. 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). Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. 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.

is_data_guard_enabled

(optional) **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_local_data_guard_enabled

(optional) 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.

subnet_id

(optional) The OCID of the subnet the resource is associated with. **Subnet Restrictions:** - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. - For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20. - For Autonomous Database, setting this will disable public secure access to the database. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.

nsg_ids

(optional) The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. **NsgIds restrictions:** - A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

private_endpoint_label

(optional) The resource's private endpoint label. Setting this to an empty string, after the creation of the private endpoint database, changes the private endpoint database to a public endpoint database. 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.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

private_endpoint_ip

(optional) The private endpoint Ip address for the resource.

db_version

(optional) A valid Oracle Database version for Autonomous Database.

source

(optional) The source of the database: Use `NONE` for creating a new Autonomous Database. Use `DATABASE` for creating a new Autonomous Database by cloning an existing Autonomous Database. Use `CROSS_REGION_DATAGUARD` to create a standby Data Guard database in another region. For Autonomous Database Serverless instances, the following cloning options are available: Use `BACKUP_FROM_ID` for creating a new Autonomous Database from a specified backup. Use `BACKUP_FROM_TIMESTAMP` for creating a point-in-time Autonomous Database clone using backups. For more information, see Cloning and Moving an Autonomous Database.

Allowed values are: 'NONE', 'DATABASE', 'BACKUP_FROM_ID', 'BACKUP_FROM_TIMESTAMP', 'CLONE_TO_REFRESHABLE', 'CROSS_REGION_DATAGUARD', 'CROSS_REGION_DISASTER_RECOVERY'

customer_contacts

(optional) Customer Contacts.

is_mtls_connection_required

(optional) Specifies if the Autonomous Database requires mTLS connections. This may not be updated in parallel with any of the following: licenseModel, databaseEdition, cpuCoreCount, computeCount, maxCpuCoreCount, 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.

resource_pool_leader_id

(optional) The unique identifier for leader autonomous database OCID OCID.

resource_pool_summary

(optional)

autonomous_maintenance_schedule_type

(optional) 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

Allowed values are: 'EARLY', 'REGULAR'

scheduled_operations

(optional) The list of scheduled operations. 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.

is_auto_scaling_for_storage_enabled

(optional) Indicates if auto scaling is enabled for the Autonomous Database storage. The default value is `FALSE`.

max_cpu_core_count

(optional) The number of Max OCPU cores to be made available to the autonomous database with auto scaling of cpu enabled.

database_edition

(optional) The Oracle Database Edition that applies to the Autonomous databases.

db_tools_details

(optional) 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.

secret_id

(optional) The OCI vault secret [/Content/General/Concepts/identifiers.htm]OCID. This cannot be used in conjunction with adminPassword.

secret_version_number

(optional) The version of the vault secret. If no version is specified, the latest version will be used.

DBMS_CLOUD_OCI_DATABASE_CREATE_AUTONOMOUS_DATABASE_CLONE_DETAILS_T Type

Details to create an Oracle Autonomous Database by cloning an existing Autonomous Database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_autonomous_database_clone_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_create_autonomous_database_base_t (
  source_id varchar2(32767),
  clone_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_autonomous_database_clone_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_autonomous_database_clone_details_t (
    compartment_id varchar2,
    character_set varchar2,
    ncharacter_set varchar2,
    db_name varchar2,
    cpu_core_count number,
    backup_retention_period_in_days number,
    compute_model varchar2,
    compute_count number,
    ocpu_count number,
    db_workload varchar2,
    data_storage_size_in_t_bs number,
    data_storage_size_in_g_bs number,
    is_free_tier number,
    kms_key_id varchar2,
    vault_id varchar2,
    admin_password varchar2,
    display_name varchar2,
    license_model varchar2,
    is_preview_version_with_service_terms_accepted number,
    is_auto_scaling_enabled number,
    is_dedicated number,
    autonomous_container_database_id varchar2,
    in_memory_percentage number,
    is_access_control_enabled number,
    whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
    are_primary_whitelisted_ips_used number,
    standby_whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
    is_data_guard_enabled number,
    is_local_data_guard_enabled number,
    subnet_id varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    private_endpoint_label varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    private_endpoint_ip varchar2,
    db_version varchar2,
    source varchar2,
    customer_contacts dbms_cloud_oci_database_customer_contact_tbl,
    is_mtls_connection_required number,
    resource_pool_leader_id varchar2,
    resource_pool_summary dbms_cloud_oci_database_resource_pool_summary_t,
    autonomous_maintenance_schedule_type varchar2,
    scheduled_operations dbms_cloud_oci_database_scheduled_operation_details_tbl,
    is_auto_scaling_for_storage_enabled number,
    max_cpu_core_count number,
    database_edition varchar2,
    db_tools_details dbms_cloud_oci_database_database_tool_tbl,
    secret_id varchar2,
    secret_version_number number,
    source_id varchar2,
    clone_type varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_create_autonomous_database_clone_details_t is a subtype of the dbms_cloud_oci_database_create_autonomous_database_base_t type.

Fields

Field Description

source_id

(required) The OCID of the source Autonomous Database that you will clone to create a new Autonomous Database.

clone_type

(required) The Autonomous Database clone type.

Allowed values are: 'FULL', 'METADATA'

DBMS_CLOUD_OCI_DATABASE_CREATE_AUTONOMOUS_DATABASE_DETAILS_T Type

Details to create an Oracle Autonomous Database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_autonomous_database_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_create_autonomous_database_base_t (
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_autonomous_database_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_autonomous_database_details_t (
    compartment_id varchar2,
    character_set varchar2,
    ncharacter_set varchar2,
    db_name varchar2,
    cpu_core_count number,
    backup_retention_period_in_days number,
    compute_model varchar2,
    compute_count number,
    ocpu_count number,
    db_workload varchar2,
    data_storage_size_in_t_bs number,
    data_storage_size_in_g_bs number,
    is_free_tier number,
    kms_key_id varchar2,
    vault_id varchar2,
    admin_password varchar2,
    display_name varchar2,
    license_model varchar2,
    is_preview_version_with_service_terms_accepted number,
    is_auto_scaling_enabled number,
    is_dedicated number,
    autonomous_container_database_id varchar2,
    in_memory_percentage number,
    is_access_control_enabled number,
    whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
    are_primary_whitelisted_ips_used number,
    standby_whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
    is_data_guard_enabled number,
    is_local_data_guard_enabled number,
    subnet_id varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    private_endpoint_label varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    private_endpoint_ip varchar2,
    db_version varchar2,
    source varchar2,
    customer_contacts dbms_cloud_oci_database_customer_contact_tbl,
    is_mtls_connection_required number,
    resource_pool_leader_id varchar2,
    resource_pool_summary dbms_cloud_oci_database_resource_pool_summary_t,
    autonomous_maintenance_schedule_type varchar2,
    scheduled_operations dbms_cloud_oci_database_scheduled_operation_details_tbl,
    is_auto_scaling_for_storage_enabled number,
    max_cpu_core_count number,
    database_edition varchar2,
    db_tools_details dbms_cloud_oci_database_database_tool_tbl,
    secret_id varchar2,
    secret_version_number number
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_create_autonomous_database_details_t is a subtype of the dbms_cloud_oci_database_create_autonomous_database_base_t type.

DBMS_CLOUD_OCI_DATABASE_CREATE_AUTONOMOUS_DATABASE_FROM_BACKUP_DETAILS_T Type

Details to create an Oracle Autonomous Database by cloning from a backup of an existing Autonomous Database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_autonomous_database_from_backup_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_create_autonomous_database_base_t (
  autonomous_database_backup_id varchar2(32767),
  clone_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_autonomous_database_from_backup_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_autonomous_database_from_backup_details_t (
    compartment_id varchar2,
    character_set varchar2,
    ncharacter_set varchar2,
    db_name varchar2,
    cpu_core_count number,
    backup_retention_period_in_days number,
    compute_model varchar2,
    compute_count number,
    ocpu_count number,
    db_workload varchar2,
    data_storage_size_in_t_bs number,
    data_storage_size_in_g_bs number,
    is_free_tier number,
    kms_key_id varchar2,
    vault_id varchar2,
    admin_password varchar2,
    display_name varchar2,
    license_model varchar2,
    is_preview_version_with_service_terms_accepted number,
    is_auto_scaling_enabled number,
    is_dedicated number,
    autonomous_container_database_id varchar2,
    in_memory_percentage number,
    is_access_control_enabled number,
    whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
    are_primary_whitelisted_ips_used number,
    standby_whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
    is_data_guard_enabled number,
    is_local_data_guard_enabled number,
    subnet_id varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    private_endpoint_label varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    private_endpoint_ip varchar2,
    db_version varchar2,
    source varchar2,
    customer_contacts dbms_cloud_oci_database_customer_contact_tbl,
    is_mtls_connection_required number,
    resource_pool_leader_id varchar2,
    resource_pool_summary dbms_cloud_oci_database_resource_pool_summary_t,
    autonomous_maintenance_schedule_type varchar2,
    scheduled_operations dbms_cloud_oci_database_scheduled_operation_details_tbl,
    is_auto_scaling_for_storage_enabled number,
    max_cpu_core_count number,
    database_edition varchar2,
    db_tools_details dbms_cloud_oci_database_database_tool_tbl,
    secret_id varchar2,
    secret_version_number number,
    autonomous_database_backup_id varchar2,
    clone_type varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_create_autonomous_database_from_backup_details_t is a subtype of the dbms_cloud_oci_database_create_autonomous_database_base_t type.

Fields

Field Description

autonomous_database_backup_id

(required) The OCID of the source Autonomous Database Backup that you will clone to create a new Autonomous Database.

clone_type

(required) The Autonomous Database clone type.

Allowed values are: 'FULL', 'METADATA'

DBMS_CLOUD_OCI_DATABASE_CREATE_AUTONOMOUS_DATABASE_FROM_BACKUP_TIMESTAMP_DETAILS_T Type

Details to create a point-in-time clone of an Oracle Autonomous Database by specifying a timestamp. Point-in-time clones use backups as the source of the data for the clone.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_autonomous_database_from_backup_timestamp_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_create_autonomous_database_base_t (
  autonomous_database_id varchar2(32767),
  l_timestamp timestamp with time zone,
  clone_type varchar2(32767),
  use_latest_available_backup_time_stamp number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_autonomous_database_from_backup_timestamp_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_autonomous_database_from_backup_timestamp_details_t (
    compartment_id varchar2,
    character_set varchar2,
    ncharacter_set varchar2,
    db_name varchar2,
    cpu_core_count number,
    backup_retention_period_in_days number,
    compute_model varchar2,
    compute_count number,
    ocpu_count number,
    db_workload varchar2,
    data_storage_size_in_t_bs number,
    data_storage_size_in_g_bs number,
    is_free_tier number,
    kms_key_id varchar2,
    vault_id varchar2,
    admin_password varchar2,
    display_name varchar2,
    license_model varchar2,
    is_preview_version_with_service_terms_accepted number,
    is_auto_scaling_enabled number,
    is_dedicated number,
    autonomous_container_database_id varchar2,
    in_memory_percentage number,
    is_access_control_enabled number,
    whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
    are_primary_whitelisted_ips_used number,
    standby_whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
    is_data_guard_enabled number,
    is_local_data_guard_enabled number,
    subnet_id varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    private_endpoint_label varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    private_endpoint_ip varchar2,
    db_version varchar2,
    source varchar2,
    customer_contacts dbms_cloud_oci_database_customer_contact_tbl,
    is_mtls_connection_required number,
    resource_pool_leader_id varchar2,
    resource_pool_summary dbms_cloud_oci_database_resource_pool_summary_t,
    autonomous_maintenance_schedule_type varchar2,
    scheduled_operations dbms_cloud_oci_database_scheduled_operation_details_tbl,
    is_auto_scaling_for_storage_enabled number,
    max_cpu_core_count number,
    database_edition varchar2,
    db_tools_details dbms_cloud_oci_database_database_tool_tbl,
    secret_id varchar2,
    secret_version_number number,
    autonomous_database_id varchar2,
    l_timestamp timestamp with time zone,
    clone_type varchar2,
    use_latest_available_backup_time_stamp number
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_create_autonomous_database_from_backup_timestamp_details_t is a subtype of the dbms_cloud_oci_database_create_autonomous_database_base_t type.

Fields

Field Description

autonomous_database_id

(required) The OCID of the source Autonomous Database that you will clone to create a new Autonomous Database.

l_timestamp

(optional) The timestamp specified for the point-in-time clone of the source Autonomous Database. The timestamp must be in the past.

clone_type

(required) The Autonomous Database clone type.

Allowed values are: 'FULL', 'METADATA'

use_latest_available_backup_time_stamp

(optional) Clone from latest available backup timestamp.

DBMS_CLOUD_OCI_DATABASE_CREATE_AUTONOMOUS_VM_CLUSTER_DETAILS_T Type

Details for the create Autonomous VM cluster operation.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_autonomous_vm_cluster_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  exadata_infrastructure_id varchar2(32767),
  vm_cluster_network_id varchar2(32767),
  time_zone varchar2(32767),
  is_local_backup_enabled number,
  license_model varchar2(32767),
  total_container_databases number,
  cpu_core_count_per_node number,
  compute_model varchar2(32767),
  memory_per_oracle_compute_unit_in_g_bs number,
  autonomous_data_storage_size_in_t_bs number,
  maintenance_window_details dbms_cloud_oci_database_maintenance_window_t,
  db_servers dbms_cloud_oci_database_varchar2_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  scan_listener_port_tls number,
  scan_listener_port_non_tls number,
  is_mtls_enabled number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_autonomous_vm_cluster_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_autonomous_vm_cluster_details_t (
    compartment_id varchar2,
    display_name varchar2,
    exadata_infrastructure_id varchar2,
    vm_cluster_network_id varchar2,
    time_zone varchar2,
    is_local_backup_enabled number,
    license_model varchar2,
    total_container_databases number,
    cpu_core_count_per_node number,
    compute_model varchar2,
    memory_per_oracle_compute_unit_in_g_bs number,
    autonomous_data_storage_size_in_t_bs number,
    maintenance_window_details dbms_cloud_oci_database_maintenance_window_t,
    db_servers dbms_cloud_oci_database_varchar2_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    scan_listener_port_tls number,
    scan_listener_port_non_tls number,
    is_mtls_enabled number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment.

display_name

(required) The user-friendly name for the Autonomous VM cluster. The name does not need to be unique.

exadata_infrastructure_id

(required) The OCID of the Exadata infrastructure.

vm_cluster_network_id

(required) The OCID of the VM cluster network.

time_zone

(optional) The time zone to use for the Autonomous VM cluster. For details, see DB System Time Zones.

is_local_backup_enabled

(optional) If true, database backup on local Exadata storage is configured for the Autonomous VM cluster. If false, database backup on local Exadata storage is not available in the Autonomous VM cluster.

license_model

(optional) The Oracle license model that applies to the Autonomous VM cluster. The default is BRING_YOUR_OWN_LICENSE.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

total_container_databases

(optional) The total number of Autonomous Container Databases that can be created.

cpu_core_count_per_node

(optional) The number of CPU cores to enable per VM cluster node.

compute_model

(optional) The compute model of the Autonomous VM Cluster.

Allowed values are: 'ECPU', 'OCPU'

memory_per_oracle_compute_unit_in_g_bs

(optional) The amount of memory (in GBs) to be enabled per OCPU or ECPU.

autonomous_data_storage_size_in_t_bs

(optional) The data disk group size to be allocated for Autonomous Databases, in TBs.

maintenance_window_details

(optional)

db_servers

(optional) The list of OCIDs of the Db servers.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

scan_listener_port_tls

(optional) The SCAN Listener TLS port number. Default value is 2484.

scan_listener_port_non_tls

(optional) The SCAN Listener Non TLS port number. Default value is 1521.

is_mtls_enabled

(optional) Enable mutual TLS(mTLS) authentication for database while provisioning a VMCluster. Default is TLS.

DBMS_CLOUD_OCI_DATABASE_CREATE_BACKUP_DESTINATION_DETAILS_T Type

Details for creating a backup destination.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_backup_destination_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  l_type varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_backup_destination_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_backup_destination_details_t (
    display_name varchar2,
    compartment_id varchar2,
    l_type varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

display_name

(required) The user-provided name of the backup destination.

compartment_id

(required) The OCID of the compartment.

l_type

(required) Type of the backup destination.

Allowed values are: 'NFS', 'RECOVERY_APPLIANCE'

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_CREATE_BACKUP_DETAILS_T Type

Details for creating a database backup. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_backup_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  database_id varchar2(32767),
  display_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_backup_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_backup_details_t (
    database_id varchar2,
    display_name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

database_id

(required) The OCID of the database.

display_name

(required) The user-friendly name for the backup. The name does not have to be unique.

DBMS_CLOUD_OCI_DATABASE_CREATE_CLOUD_AUTONOMOUS_VM_CLUSTER_DETAILS_T Type

Details for the create cloud Autonomous VM cluster operation.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_cloud_autonomous_vm_cluster_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  description varchar2(32767),
  subnet_id varchar2(32767),
  display_name varchar2(32767),
  cloud_exadata_infrastructure_id varchar2(32767),
  total_container_databases number,
  cpu_core_count_per_node number,
  memory_per_oracle_compute_unit_in_g_bs number,
  autonomous_data_storage_size_in_t_bs number,
  cluster_time_zone varchar2(32767),
  compute_model varchar2(32767),
  is_mtls_enabled_vm_cluster number,
  db_servers dbms_cloud_oci_database_varchar2_tbl,
  maintenance_window_details dbms_cloud_oci_database_maintenance_window_t,
  scan_listener_port_tls number,
  scan_listener_port_non_tls number,
  license_model varchar2(32767),
  nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_cloud_autonomous_vm_cluster_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_cloud_autonomous_vm_cluster_details_t (
    compartment_id varchar2,
    description varchar2,
    subnet_id varchar2,
    display_name varchar2,
    cloud_exadata_infrastructure_id varchar2,
    total_container_databases number,
    cpu_core_count_per_node number,
    memory_per_oracle_compute_unit_in_g_bs number,
    autonomous_data_storage_size_in_t_bs number,
    cluster_time_zone varchar2,
    compute_model varchar2,
    is_mtls_enabled_vm_cluster number,
    db_servers dbms_cloud_oci_database_varchar2_tbl,
    maintenance_window_details dbms_cloud_oci_database_maintenance_window_t,
    scan_listener_port_tls number,
    scan_listener_port_non_tls number,
    license_model varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment.

description

(optional) User defined description of the cloud Autonomous VM cluster.

subnet_id

(required) The OCID of the subnet the cloud Autonomous VM Cluster is associated with.

display_name

(required) The user-friendly name for the cloud Autonomous VM cluster. The name does not need to be unique.

cloud_exadata_infrastructure_id

(required) The OCID of the cloud Exadata infrastructure.

total_container_databases

(optional) The total number of Autonomous Container Databases that can be created.

cpu_core_count_per_node

(optional) The number of CPU cores to be enabled per VM cluster node.

memory_per_oracle_compute_unit_in_g_bs

(optional) The amount of memory (in GBs) to be enabled per OCPU or ECPU.

autonomous_data_storage_size_in_t_bs

(optional) The data disk group size to be allocated for Autonomous Databases, in TBs.

cluster_time_zone

(optional) The time zone to use for the Cloud Autonomous VM cluster. For details, see DB System Time Zones.

compute_model

(optional) The compute model of the Cloud Autonomous VM Cluster.

Allowed values are: 'ECPU', 'OCPU'

is_mtls_enabled_vm_cluster

(optional) Enable mutual TLS(mTLS) authentication for database at time of provisioning a VMCluster. This is applicable to database TLS Certificates only. Default is TLS

db_servers

(optional) The list of database servers.

maintenance_window_details

(optional)

scan_listener_port_tls

(optional) The SCAN Listener TLS port. Default is 2484.

scan_listener_port_non_tls

(optional) The SCAN Listener Non TLS port. Default is 1521.

license_model

(optional) 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`. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, maxCpuCoreCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

nsg_ids

(optional) 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.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_CREATE_CLOUD_EXADATA_INFRASTRUCTURE_DETAILS_T Type

Request to create cloud Exadata infrastructure. Applies to Exadata Cloud Service instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_cloud_exadata_infrastructure_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  availability_domain varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  shape varchar2(32767),
  compute_count number,
  storage_count number,
  maintenance_window dbms_cloud_oci_database_maintenance_window_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  customer_contacts dbms_cloud_oci_database_customer_contact_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_cloud_exadata_infrastructure_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_cloud_exadata_infrastructure_details_t (
    availability_domain varchar2,
    compartment_id varchar2,
    display_name varchar2,
    shape varchar2,
    compute_count number,
    storage_count number,
    maintenance_window dbms_cloud_oci_database_maintenance_window_t,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    customer_contacts dbms_cloud_oci_database_customer_contact_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

availability_domain

(required) The availability domain where the cloud Exadata infrastructure is located.

compartment_id

(required) The OCID of the compartment.

display_name

(required) The user-friendly name for the cloud Exadata infrastructure resource. The name does not need to be unique.

shape

(required) The shape of the cloud Exadata infrastructure resource.

compute_count

(optional) The number of compute servers for the cloud Exadata infrastructure.

storage_count

(optional) The number of storage servers for the cloud Exadata infrastructure.

maintenance_window

(optional)

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

customer_contacts

(optional) Customer contacts.

DBMS_CLOUD_OCI_DATABASE_CREATE_CLOUD_VM_CLUSTER_DETAILS_T Type

Details for the create cloud VM cluster operation. Applies to Exadata Cloud Service instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_cloud_vm_cluster_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  subnet_id varchar2(32767),
  backup_subnet_id varchar2(32767),
  cpu_core_count number,
  ocpu_count number,
  memory_size_in_g_bs number,
  db_node_storage_size_in_g_bs number,
  data_storage_size_in_t_bs number,
  db_servers dbms_cloud_oci_database_varchar2_tbl,
  cluster_name varchar2(32767),
  data_storage_percentage number,
  display_name varchar2(32767),
  cloud_exadata_infrastructure_id varchar2(32767),
  hostname varchar2(32767),
  domain varchar2(32767),
  ssh_public_keys dbms_cloud_oci_database_varchar2_tbl,
  license_model varchar2(32767),
  is_sparse_diskgroup_enabled number,
  is_local_backup_enabled number,
  time_zone varchar2(32767),
  scan_listener_port_tcp number,
  scan_listener_port_tcp_ssl number,
  private_zone_id varchar2(32767),
  nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  backup_network_nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  gi_version varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  data_collection_options dbms_cloud_oci_database_data_collection_options_t,
  system_version varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_cloud_vm_cluster_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_cloud_vm_cluster_details_t (
    compartment_id varchar2,
    subnet_id varchar2,
    backup_subnet_id varchar2,
    cpu_core_count number,
    ocpu_count number,
    memory_size_in_g_bs number,
    db_node_storage_size_in_g_bs number,
    data_storage_size_in_t_bs number,
    db_servers dbms_cloud_oci_database_varchar2_tbl,
    cluster_name varchar2,
    data_storage_percentage number,
    display_name varchar2,
    cloud_exadata_infrastructure_id varchar2,
    hostname varchar2,
    domain varchar2,
    ssh_public_keys dbms_cloud_oci_database_varchar2_tbl,
    license_model varchar2,
    is_sparse_diskgroup_enabled number,
    is_local_backup_enabled number,
    time_zone varchar2,
    scan_listener_port_tcp number,
    scan_listener_port_tcp_ssl number,
    private_zone_id varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    backup_network_nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    gi_version varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    data_collection_options dbms_cloud_oci_database_data_collection_options_t,
    system_version varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment.

subnet_id

(required) The OCID of the subnet associated with the cloud VM cluster.

backup_subnet_id

(required) The OCID of the backup network subnet associated with the cloud VM cluster.

cpu_core_count

(required) The number of CPU cores to enable for a cloud VM cluster. Valid values depend on the specified shape: - Exadata.Base.48 - Specify a multiple of 2, from 0 to 48. - Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84. - Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168. - Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336. - Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92. - Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184. - Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.

ocpu_count

(optional) The number of OCPU cores to enable for a cloud VM cluster. Only 1 decimal place is allowed for the fractional part.

memory_size_in_g_bs

(optional) The memory to be allocated in GBs.

db_node_storage_size_in_g_bs

(optional) The local node storage to be allocated in GBs.

data_storage_size_in_t_bs

(optional) The data disk group size to be allocated in TBs.

db_servers

(optional) The list of DB servers.

cluster_name

(optional) The cluster name for cloud VM cluster. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.

data_storage_percentage

(optional) The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 35, 40, 60 and 80. The default is 80 percent assigned to DATA storage. See Storage Configuration in the Exadata documentation for details on the impact of the configuration settings on storage.

display_name

(required) The user-friendly name for the cloud VM cluster. The name does not need to be unique.

cloud_exadata_infrastructure_id

(required) The OCID of the cloud Exadata infrastructure resource.

hostname

(required) The hostname for the cloud VM cluster. The hostname must begin with an alphabetic character, and can contain alphanumeric characters and hyphens (-). The maximum length of the hostname is 16 characters for bare metal and virtual machine DB systems, and 12 characters for Exadata systems. The maximum length of the combined hostname and domain is 63 characters. **Note:** The hostname must be unique within the subnet. If it is not unique, the cloud VM Cluster will fail to provision.

domain

(optional) A domain name used for the cloud VM cluster. If the Oracle-provided internet and VCN resolver is enabled for the specified subnet, the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. Applies to Exadata Cloud Service instances only.

ssh_public_keys

(required) The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.

license_model

(optional) The Oracle license model that applies to the cloud VM cluster. The default is BRING_YOUR_OWN_LICENSE.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

is_sparse_diskgroup_enabled

(optional) If true, the sparse disk group is configured for the cloud VM cluster. If false, the sparse disk group is not created.

is_local_backup_enabled

(optional) If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster.

time_zone

(optional) The time zone to use for the cloud VM cluster. For details, see Time Zones.

scan_listener_port_tcp

(optional) The TCP Single Client Access Name (SCAN) port. The default port is 1521.

scan_listener_port_tcp_ssl

(optional) The TCPS Single Client Access Name (SCAN) port. The default port is 2484.

private_zone_id

(optional) The private zone id in which DNS records need to be created.

nsg_ids

(optional) 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.

backup_network_nsg_ids

(optional) A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

gi_version

(required) A valid Oracle Grid Infrastructure (GI) software version.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

data_collection_options

(optional)

system_version

(optional) Operating system version of the image.

DBMS_CLOUD_OCI_DATABASE_CREATE_CONSOLE_CONNECTION_DETAILS_T Type

The details for creating a Db node console connection. The Db node console connection is created in the same compartment as the dbNode.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_console_connection_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  public_key varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_console_connection_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_console_connection_details_t (
    public_key varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

public_key

(required) The SSH public key used to authenticate the console connection.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_CREATE_CONSOLE_HISTORY_DETAILS_T Type

The details for creating a Db node console history. The Db node console history is created in the same compartment as the dbNode.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_console_history_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  freeform_tags json_element_t,
  defined_tags json_element_t,
  display_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_console_history_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_console_history_details_t (
    freeform_tags json_element_t,
    defined_tags json_element_t,
    display_name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

display_name

(required) The user-friendly name for the console history. The name does not need to be unique.

DBMS_CLOUD_OCI_DATABASE_CREATE_CROSS_REGION_AUTONOMOUS_DATABASE_DATA_GUARD_DETAILS_T Type

Details to create an Autonomous Data Guard association for an existing Autonomous Database where the standby is in a different (remote) region from the source primary database. *IMPORTANT* Note the following for creating standby databases in cross-region Autonomous Data Guard associations: - To create your standby database in a region different from the region of the primary, use the API endpoint of the region in which the standby will be located. For example, if the primary database is in the IAD region, and you want to create the standby in the PHX region, make the API call using the PHX endpoint (https://database.us-phoenix-1.oraclecloud.com). See API Endpoints for the list of Database Service API endpoints. - In the request to create the standby database, the `sourceId` value should be the OCID of the primary database. The following parameters are optional for the cross-region standby database. If included in the request, these parameters contain the same values as the source Autonomous Database: - customerContacts - scheduledOperations - isAutoScalingForStorageEnabled - definedTags - freeformTags - licenseModel - whitelistedIps - isMtlsConnectionRequired - dbName - adminPassword - cpuCoreCount - dataStorageSizeInTB - dbVersion Example I - Creating a cross-region standby with required parameters only, with OCPU: `{ \"compartmentId\": \"ocid.compartment.oc1..<var>&lt;unique_ID&gt;</var>\", \"cpuCoreCount\": 1, \"dbName\": \"adatabasedb1\", \"sourceId\": \"ocid1.autonomousdatabase.oc1.phx..<var>&lt;unique_ID&gt;</var>\", \"dataStorageSizeInTBs\": 1, \"source\": \"CROSS_REGION_DATAGUARD\", \"adminPassword\" : \"<var>&lt;password&gt;</var>\", }` Example II - Creating a cross-region standby that specifies optional parameters in addition to the required parameters, with ECPU: `{ \"compartmentId\": \"ocid.compartment.oc1..<var>&lt;unique_ID&gt;</var>\", \"computeModel\": \"ECPU\", \"computeCount\": 2, \"dbName\": \"adatabasedb1\", \"sourceId\": \"ocid1.autonomousdatabase.oc1.phx..<var>&lt;unique_ID&gt;</var>\", \"dataStorageSizeInTBs\": 1, \"source\": \"CROSS_REGION_DATAGUARD\", \"adminPassword\" : \"<var>&lt;password&gt;</var>\", \"dbVersion\": \"19c\", \"licenseModel\": \"LICENSE_INCLUDED\", \"isAutoScalingForStorageEnabled\": \"true\" }`

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_cross_region_autonomous_database_data_guard_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_create_autonomous_database_base_t (
  source_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_cross_region_autonomous_database_data_guard_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_cross_region_autonomous_database_data_guard_details_t (
    compartment_id varchar2,
    character_set varchar2,
    ncharacter_set varchar2,
    db_name varchar2,
    cpu_core_count number,
    backup_retention_period_in_days number,
    compute_model varchar2,
    compute_count number,
    ocpu_count number,
    db_workload varchar2,
    data_storage_size_in_t_bs number,
    data_storage_size_in_g_bs number,
    is_free_tier number,
    kms_key_id varchar2,
    vault_id varchar2,
    admin_password varchar2,
    display_name varchar2,
    license_model varchar2,
    is_preview_version_with_service_terms_accepted number,
    is_auto_scaling_enabled number,
    is_dedicated number,
    autonomous_container_database_id varchar2,
    in_memory_percentage number,
    is_access_control_enabled number,
    whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
    are_primary_whitelisted_ips_used number,
    standby_whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
    is_data_guard_enabled number,
    is_local_data_guard_enabled number,
    subnet_id varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    private_endpoint_label varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    private_endpoint_ip varchar2,
    db_version varchar2,
    source varchar2,
    customer_contacts dbms_cloud_oci_database_customer_contact_tbl,
    is_mtls_connection_required number,
    resource_pool_leader_id varchar2,
    resource_pool_summary dbms_cloud_oci_database_resource_pool_summary_t,
    autonomous_maintenance_schedule_type varchar2,
    scheduled_operations dbms_cloud_oci_database_scheduled_operation_details_tbl,
    is_auto_scaling_for_storage_enabled number,
    max_cpu_core_count number,
    database_edition varchar2,
    db_tools_details dbms_cloud_oci_database_database_tool_tbl,
    secret_id varchar2,
    secret_version_number number,
    source_id varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_create_cross_region_autonomous_database_data_guard_details_t is a subtype of the dbms_cloud_oci_database_create_autonomous_database_base_t type.

Fields

Field Description

source_id

(required) The OCID of the source Autonomous Database that will be used to create a new standby database for the Data Guard association.

DBMS_CLOUD_OCI_DATABASE_CREATE_CROSS_REGION_DISASTER_RECOVERY_DETAILS_T Type

The following are the details necessary to create a disaster recovery (DR) association for an existing Autonomous Database with a standby in a remote region. *IMPORTANT* For creating a standby databases in a cross-region DR association: - To create the standby database in a remote region, use the API endpoint in the region where the standby is located. For example, if the primary database is in the IAD region and the standby is in the PHX region, make the API call using the PHX endpoint (https://database.us-phoenix-1.oraclecloud.com). See API Endpoints for the list of Database Service API endpoints. - To create the request in the standby database, the sourceId value must be the OCID of the primary database. The following parameters are required for the cross-region standby database and must contain the same values as the source Autonomous Database: - remoteDisasterRecoveryType The following parameters are optional for the cross-region standby database. If included in the request, these parameters must contain the same values as the source Autonomous Database: - dbName - dbVersion - ecpuCount - dataStorageSizeInTB - customerContacts - scheduledOperations - isAutoScalingForStorageEnabled - definedTags - freeformTags - licenseModel - whitelistedIps - isMtlsConnectionRequired Example I - Creating a cross-region standby with required parameters only: `{ \"compartmentId\": \"ocid.compartment.oc1..<var>&lt;unique_ID&gt;</var>\", \"sourceId\": \"ocid1.autonomousdatabase.oc1.phx..<var>&lt;unique_ID&gt;</var>\", \"source\": \"CROSS_REGION_DISASTER_RECOVERY\", \"remoteDisasterRecoveryType\": \"BACKUP_BASED\" }` Example II - Creating a cross-region standby that specifies optional parameters in addition to the required parameters: `{ \"compartmentId\": \"ocid.compartment.oc1..<var>&lt;unique_ID&gt;</var>\", \"ecpuCount\": 2, \"dbName\": \"adatabasedb1\", \"sourceId\": \"ocid1.autonomousdatabase.oc1.phx..<var>&lt;unique_ID&gt;</var>\", \"dataStorageSizeInTBs\": 1, \"source\": \"CROSS_REGION_DISASTER_RECOVERY\", \"adminPassword\" : \"<var>&lt;password&gt;</var>\", \"dbVersion\": \"19c\", \"licenseModel\": \"LICENSE_INCLUDED\", \"isAutoScalingForStorageEnabled\": \"true\", \"remoteDisasterRecoveryType\": \"BACKUP_BASED\" }`

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_cross_region_disaster_recovery_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_create_autonomous_database_base_t (
  source_id varchar2(32767),
  remote_disaster_recovery_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_cross_region_disaster_recovery_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_cross_region_disaster_recovery_details_t (
    compartment_id varchar2,
    character_set varchar2,
    ncharacter_set varchar2,
    db_name varchar2,
    cpu_core_count number,
    backup_retention_period_in_days number,
    compute_model varchar2,
    compute_count number,
    ocpu_count number,
    db_workload varchar2,
    data_storage_size_in_t_bs number,
    data_storage_size_in_g_bs number,
    is_free_tier number,
    kms_key_id varchar2,
    vault_id varchar2,
    admin_password varchar2,
    display_name varchar2,
    license_model varchar2,
    is_preview_version_with_service_terms_accepted number,
    is_auto_scaling_enabled number,
    is_dedicated number,
    autonomous_container_database_id varchar2,
    in_memory_percentage number,
    is_access_control_enabled number,
    whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
    are_primary_whitelisted_ips_used number,
    standby_whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
    is_data_guard_enabled number,
    is_local_data_guard_enabled number,
    subnet_id varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    private_endpoint_label varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    private_endpoint_ip varchar2,
    db_version varchar2,
    source varchar2,
    customer_contacts dbms_cloud_oci_database_customer_contact_tbl,
    is_mtls_connection_required number,
    resource_pool_leader_id varchar2,
    resource_pool_summary dbms_cloud_oci_database_resource_pool_summary_t,
    autonomous_maintenance_schedule_type varchar2,
    scheduled_operations dbms_cloud_oci_database_scheduled_operation_details_tbl,
    is_auto_scaling_for_storage_enabled number,
    max_cpu_core_count number,
    database_edition varchar2,
    db_tools_details dbms_cloud_oci_database_database_tool_tbl,
    secret_id varchar2,
    secret_version_number number,
    source_id varchar2,
    remote_disaster_recovery_type varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_create_cross_region_disaster_recovery_details_t is a subtype of the dbms_cloud_oci_database_create_autonomous_database_base_t type.

Fields

Field Description

source_id

(required) The OCID of the source Autonomous Database that will be used to create a new standby database for the DR association.

remote_disaster_recovery_type

(required) Indicates the cross-region disaster recovery (DR) type of the standby 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.

DBMS_CLOUD_OCI_DATABASE_CREATE_DATA_GUARD_ASSOCIATION_DETAILS_T Type

The configuration details for creating a Data Guard association between databases. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_data_guard_association_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  database_software_image_id varchar2(32767),
  database_admin_password varchar2(32767),
  protection_mode varchar2(32767),
  transport_type varchar2(32767),
  creation_type varchar2(32767),
  is_active_data_guard_enabled number,
  peer_db_unique_name varchar2(32767),
  peer_sid_prefix varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_data_guard_association_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_data_guard_association_details_t (
    database_software_image_id varchar2,
    database_admin_password varchar2,
    protection_mode varchar2,
    transport_type varchar2,
    creation_type varchar2,
    is_active_data_guard_enabled number,
    peer_db_unique_name varchar2,
    peer_sid_prefix varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

database_software_image_id

(optional) The database software image OCID

database_admin_password

(required) A strong password for the `SYS`, `SYSTEM`, and `PDB Admin` users to apply during standby creation. The password must contain no fewer than nine characters and include: * At least two uppercase characters. * At least two lowercase characters. * At least two numeric characters. * At least two special characters. Valid special characters include \"_\", \"#\", and \"-\" only. **The password MUST be the same as the primary admin password.**

protection_mode

(required) The protection mode to set up between the primary and standby databases. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation. **IMPORTANT** - The only protection mode currently supported by the Database service is MAXIMUM_PERFORMANCE.

Allowed values are: 'MAXIMUM_AVAILABILITY', 'MAXIMUM_PERFORMANCE', 'MAXIMUM_PROTECTION'

transport_type

(required) The redo transport type to use for this Data Guard association. Valid values depend on the specified `protectionMode`: * MAXIMUM_AVAILABILITY - SYNC or FASTSYNC * MAXIMUM_PERFORMANCE - ASYNC * MAXIMUM_PROTECTION - SYNC For more information, see Redo Transport Services in the Oracle Data Guard documentation. **IMPORTANT** - The only transport type currently supported by the Database service is ASYNC.

Allowed values are: 'SYNC', 'ASYNC', 'FASTSYNC'

creation_type

(required) Specifies whether to create the peer database in an existing DB system or in a new DB system.

is_active_data_guard_enabled

(optional) True if active Data Guard is enabled.

peer_db_unique_name

(optional) Specifies the `DB_UNIQUE_NAME` of the peer database to be created.

peer_sid_prefix

(optional) Specifies a prefix for the `Oracle SID` of the database to be created.

DBMS_CLOUD_OCI_DATABASE_CREATE_DATA_GUARD_ASSOCIATION_TO_EXISTING_DB_SYSTEM_DETAILS_T Type

The configuration details for creating a Data Guard association for a bare metal or Exadata DB system database. For these types of DB system databases, the `creationType` should be `ExistingDbSystem`. A standby database will be created in the DB system you specify. To create a Data Guard association for a database in a virtual machine DB system, use the CREATE_DATA_GUARD_ASSOCIATION_WITH_NEW_DB_SYSTEM_DETAILS Function subtype instead.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_data_guard_association_to_existing_db_system_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_create_data_guard_association_details_t (
  peer_db_system_id varchar2(32767),
  peer_db_home_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_data_guard_association_to_existing_db_system_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_data_guard_association_to_existing_db_system_details_t (
    database_software_image_id varchar2,
    database_admin_password varchar2,
    protection_mode varchar2,
    transport_type varchar2,
    creation_type varchar2,
    is_active_data_guard_enabled number,
    peer_db_unique_name varchar2,
    peer_sid_prefix varchar2,
    peer_db_system_id varchar2,
    peer_db_home_id varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_create_data_guard_association_to_existing_db_system_details_t is a subtype of the dbms_cloud_oci_database_create_data_guard_association_details_t type.

Fields

Field Description

peer_db_system_id

(optional) The OCID of the DB system in which to create the standby database. You must supply this value if creationType is `ExistingDbSystem`.

peer_db_home_id

(optional) The OCID of the DB home in which to create the standby database. You must supply this value to create standby database with an existing DB home

DBMS_CLOUD_OCI_DATABASE_CREATE_DATA_GUARD_ASSOCIATION_TO_EXISTING_VM_CLUSTER_DETAILS_T Type

The configuration details for creating a Data Guard association for a ExaCC Vmcluster database. For these types of vm cluster databases, the `creationType` should be `ExistingVmCluster`. A standby database will be created in the VM cluster you specify.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_data_guard_association_to_existing_vm_cluster_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_create_data_guard_association_details_t (
  peer_vm_cluster_id varchar2(32767),
  peer_db_home_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_data_guard_association_to_existing_vm_cluster_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_data_guard_association_to_existing_vm_cluster_details_t (
    database_software_image_id varchar2,
    database_admin_password varchar2,
    protection_mode varchar2,
    transport_type varchar2,
    creation_type varchar2,
    is_active_data_guard_enabled number,
    peer_db_unique_name varchar2,
    peer_sid_prefix varchar2,
    peer_vm_cluster_id varchar2,
    peer_db_home_id varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_create_data_guard_association_to_existing_vm_cluster_details_t is a subtype of the dbms_cloud_oci_database_create_data_guard_association_details_t type.

Fields

Field Description

peer_vm_cluster_id

(optional) The OCID of the VM Cluster in which to create the standby database. You must supply this value if creationType is `ExistingVmCluster`.

peer_db_home_id

(optional) The OCID of the DB home in which to create the standby database. You must supply this value to create standby database with an existing DB home

DBMS_CLOUD_OCI_DATABASE_CREATE_DATA_GUARD_ASSOCIATION_WITH_NEW_DB_SYSTEM_DETAILS_T Type

The configuration details for creating a Data Guard association for a virtual machine DB system database. For this type of DB system database, the `creationType` should be `NewDbSystem`. A new DB system will be launched to create the standby database. To create a Data Guard association for a database in a bare metal or Exadata DB system, use the CREATE_DATA_GUARD_ASSOCIATION_TO_EXISTING_DB_SYSTEM_DETAILS Function subtype instead.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_data_guard_association_with_new_db_system_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_create_data_guard_association_details_t (
  display_name varchar2(32767),
  availability_domain varchar2(32767),
  shape varchar2(32767),
  cpu_core_count number,
  storage_volume_performance_mode varchar2(32767),
  node_count number,
  subnet_id varchar2(32767),
  nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  backup_network_nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  hostname varchar2(32767),
  time_zone varchar2(32767),
  fault_domains dbms_cloud_oci_database_varchar2_tbl,
  private_ip varchar2(32767),
  license_model varchar2(32767),
  db_system_freeform_tags json_element_t,
  db_system_defined_tags json_element_t,
  database_freeform_tags json_element_t,
  database_defined_tags json_element_t,
  data_collection_options dbms_cloud_oci_database_data_collection_options_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_data_guard_association_with_new_db_system_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_data_guard_association_with_new_db_system_details_t (
    database_software_image_id varchar2,
    database_admin_password varchar2,
    protection_mode varchar2,
    transport_type varchar2,
    creation_type varchar2,
    is_active_data_guard_enabled number,
    peer_db_unique_name varchar2,
    peer_sid_prefix varchar2,
    display_name varchar2,
    availability_domain varchar2,
    shape varchar2,
    cpu_core_count number,
    storage_volume_performance_mode varchar2,
    node_count number,
    subnet_id varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    backup_network_nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    hostname varchar2,
    time_zone varchar2,
    fault_domains dbms_cloud_oci_database_varchar2_tbl,
    private_ip varchar2,
    license_model varchar2,
    db_system_freeform_tags json_element_t,
    db_system_defined_tags json_element_t,
    database_freeform_tags json_element_t,
    database_defined_tags json_element_t,
    data_collection_options dbms_cloud_oci_database_data_collection_options_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_create_data_guard_association_with_new_db_system_details_t is a subtype of the dbms_cloud_oci_database_create_data_guard_association_details_t type.

Fields

Field Description

display_name

(optional) The user-friendly name of the DB system that will contain the the standby database. The display name does not have to be unique.

availability_domain

(optional) The name of the availability domain that the standby database DB system will be located in. For example- \"Uocm:PHX-AD-1\".

shape

(optional) The virtual machine DB system shape to launch for the standby database in the Data Guard association. The shape determines the number of CPU cores and the amount of memory available for the DB system. Only virtual machine shapes are valid options. If you do not supply this parameter, the default shape is the shape of the primary DB system. To get a list of all shapes, use the LIST_DB_SYSTEM_SHAPES Function operation.

cpu_core_count

(optional) The number of OCPU cores available for AMD-based virtual machine DB systems.

storage_volume_performance_mode

(optional) The block storage volume performance level. Valid values are `BALANCED` and `HIGH_PERFORMANCE`. See Block Volume Performance for more information.

Allowed values are: 'BALANCED', 'HIGH_PERFORMANCE'

node_count

(optional) The number of nodes to launch for the DB system of the standby in the Data Guard association. For a 2-node RAC virtual machine DB system, specify either 1 or 2. If you do not supply this parameter, the default is the node count of the primary DB system.

subnet_id

(optional) The OCID of the subnet the DB system is associated with. **Subnet Restrictions:** - For 1- and 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.16.16/28 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 backup subnet.

nsg_ids

(optional) 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.

backup_network_nsg_ids

(optional) A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

hostname

(optional) The hostname for the DB node.

time_zone

(optional) The time zone of the dataguard standby DB system. For details, see DB System Time Zones.

fault_domains

(optional) A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains. If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain. If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node. To get a list of Fault Domains, use the LIST_FAULT_DOMAINS Function operation in the Identity and Access Management Service API. Example: `FAULT-DOMAIN-1`

private_ip

(optional) The IPv4 address from the provided OCI subnet which needs to be assigned to the VNIC. If not provided, it will be auto-assigned with an available IPv4 address from the subnet.

license_model

(optional) The Oracle license model that applies to all the databases on the dataguard standby DB system. The default is LICENSE_INCLUDED.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

db_system_freeform_tags

(optional) 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\"}`

db_system_defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

database_freeform_tags

(optional) 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\"}`

database_defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

data_collection_options

(optional)

DBMS_CLOUD_OCI_DATABASE_CREATE_DATABASE_BASE_T Type

Details for creating a database. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_database_base_t FORCE AUTHID CURRENT_USER IS OBJECT (
  db_home_id varchar2(32767),
  db_version varchar2(32767),
  source varchar2(32767),
  kms_key_id varchar2(32767),
  kms_key_version_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_database_base_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_database_base_t (
    db_home_id varchar2,
    db_version varchar2,
    source varchar2,
    kms_key_id varchar2,
    kms_key_version_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

db_home_id

(required) The OCID of the Database Home.

db_version

(optional) A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

source

(required) The source of the database: Use `NONE` for creating a new database. Use `DB_BACKUP` for creating a new database by restoring from a backup. The default is `NONE`.

Allowed values are: 'NONE', 'DB_BACKUP'

kms_key_id

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

kms_key_version_id

(optional) 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.

DBMS_CLOUD_OCI_DATABASE_DB_BACKUP_CONFIG_T Type

Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_db_backup_config_t FORCE AUTHID CURRENT_USER IS OBJECT (
  auto_backup_enabled number,
  recovery_window_in_days number,
  auto_backup_window varchar2(32767),
  auto_full_backup_window varchar2(32767),
  auto_full_backup_day varchar2(32767),
  run_immediate_full_backup number,
  backup_destination_details dbms_cloud_oci_database_backup_destination_details_tbl,
  backup_deletion_policy varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_backup_config_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_backup_config_t (
    auto_backup_enabled number,
    recovery_window_in_days number,
    auto_backup_window varchar2,
    auto_full_backup_window varchar2,
    auto_full_backup_day varchar2,
    run_immediate_full_backup number,
    backup_destination_details dbms_cloud_oci_database_backup_destination_details_tbl,
    backup_deletion_policy varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

auto_backup_enabled

(optional) If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.

recovery_window_in_days

(optional) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.

auto_backup_window

(optional) Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO`

Allowed values are: 'SLOT_ONE', 'SLOT_TWO', 'SLOT_THREE', 'SLOT_FOUR', 'SLOT_FIVE', 'SLOT_SIX', 'SLOT_SEVEN', 'SLOT_EIGHT', 'SLOT_NINE', 'SLOT_TEN', 'SLOT_ELEVEN', 'SLOT_TWELVE'

auto_full_backup_window

(optional) Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO`

Allowed values are: 'SLOT_ONE', 'SLOT_TWO', 'SLOT_THREE', 'SLOT_FOUR', 'SLOT_FIVE', 'SLOT_SIX', 'SLOT_SEVEN', 'SLOT_EIGHT', 'SLOT_NINE', 'SLOT_TEN', 'SLOT_ELEVEN', 'SLOT_TWELVE'

auto_full_backup_day

(optional) Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.

Allowed values are: 'SUNDAY', 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY'

run_immediate_full_backup

(optional) If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

backup_destination_details

(optional) Backup destination details.

backup_deletion_policy

(optional) This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.

Allowed values are: 'DELETE_IMMEDIATELY', 'DELETE_AFTER_RETENTION_PERIOD'

DBMS_CLOUD_OCI_DATABASE_CREATE_DATABASE_DETAILS_T Type

Details for creating a database. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_database_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  db_name varchar2(32767),
  db_unique_name varchar2(32767),
  database_software_image_id varchar2(32767),
  pdb_name varchar2(32767),
  admin_password varchar2(32767),
  tde_wallet_password varchar2(32767),
  character_set varchar2(32767),
  ncharacter_set varchar2(32767),
  db_workload varchar2(32767),
  db_backup_config dbms_cloud_oci_database_db_backup_config_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  kms_key_id varchar2(32767),
  kms_key_version_id varchar2(32767),
  vault_id varchar2(32767),
  sid_prefix varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_database_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_database_details_t (
    db_name varchar2,
    db_unique_name varchar2,
    database_software_image_id varchar2,
    pdb_name varchar2,
    admin_password varchar2,
    tde_wallet_password varchar2,
    character_set varchar2,
    ncharacter_set varchar2,
    db_workload varchar2,
    db_backup_config dbms_cloud_oci_database_db_backup_config_t,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    kms_key_id varchar2,
    kms_key_version_id varchar2,
    vault_id varchar2,
    sid_prefix varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

db_name

(required) The database name. The name must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

db_unique_name

(optional) The `DB_UNIQUE_NAME` of the Oracle Database being backed up.

database_software_image_id

(optional) The database software image OCID

pdb_name

(optional) The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.

admin_password

(required) A strong password for SYS, SYSTEM, and PDB Admin. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, \\#, or -.

tde_wallet_password

(optional) The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, \\#, or -.

character_set

(optional) The character set for the database. The default is AL32UTF8. Allowed values are: AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS

ncharacter_set

(optional) The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

db_workload

(optional) **Deprecated.** The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored. The database workload type.

Allowed values are: 'OLTP', 'DSS'

db_backup_config

(optional)

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

kms_key_id

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

kms_key_version_id

(optional) 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.

vault_id

(optional) The OCID of the Oracle Cloud Infrastructure vault.

sid_prefix

(optional) Specifies a prefix for the `Oracle SID` of the database to be created.

DBMS_CLOUD_OCI_DATABASE_CREATE_DATABASE_FROM_ANOTHER_DATABASE_DETAILS_T Type

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_database_from_another_database_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  database_id varchar2(32767),
  backup_tde_password varchar2(32767),
  admin_password varchar2(32767),
  db_unique_name varchar2(32767),
  db_name varchar2(32767),
  time_stamp_for_point_in_time_recovery timestamp with time zone,
  pluggable_databases dbms_cloud_oci_database_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_database_from_another_database_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_database_from_another_database_details_t (
    database_id varchar2,
    backup_tde_password varchar2,
    admin_password varchar2,
    db_unique_name varchar2,
    db_name varchar2,
    time_stamp_for_point_in_time_recovery timestamp with time zone,
    pluggable_databases dbms_cloud_oci_database_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

database_id

(required) The database OCID.

backup_tde_password

(optional) The password to open the TDE wallet.

admin_password

(required) A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, \\#, or -.

db_unique_name

(optional) The `DB_UNIQUE_NAME` of the Oracle Database being backed up.

db_name

(optional) The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

time_stamp_for_point_in_time_recovery

(optional) The point in time of the original database from which the new database is created. If not specifed, the latest backup is used to create the database.

pluggable_databases

(optional) The list of pluggable databases that needs to be restored into new database.

DBMS_CLOUD_OCI_DATABASE_CREATE_DATABASE_FROM_BACKUP_DETAILS_T Type

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_database_from_backup_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  backup_id varchar2(32767),
  backup_tde_password varchar2(32767),
  admin_password varchar2(32767),
  db_unique_name varchar2(32767),
  db_name varchar2(32767),
  sid_prefix varchar2(32767),
  pluggable_databases dbms_cloud_oci_database_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_database_from_backup_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_database_from_backup_details_t (
    backup_id varchar2,
    backup_tde_password varchar2,
    admin_password varchar2,
    db_unique_name varchar2,
    db_name varchar2,
    sid_prefix varchar2,
    pluggable_databases dbms_cloud_oci_database_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

backup_id

(required) The backup OCID.

backup_tde_password

(optional) The password to open the TDE wallet.

admin_password

(required) A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, \\#, or -.

db_unique_name

(optional) The `DB_UNIQUE_NAME` of the Oracle Database being backed up.

db_name

(optional) The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

sid_prefix

(optional) Specifies a prefix for the `Oracle SID` of the database to be created.

pluggable_databases

(optional) The list of pluggable databases that needs to be restored into new database.

DBMS_CLOUD_OCI_DATABASE_CREATE_DATABASE_FROM_BACKUP_T Type

Details for creating a database by restoring from a database backup. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_database_from_backup_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_create_database_base_t (
  database dbms_cloud_oci_database_create_database_from_backup_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_database_from_backup_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_database_from_backup_t (
    db_home_id varchar2,
    db_version varchar2,
    source varchar2,
    kms_key_id varchar2,
    kms_key_version_id varchar2,
    database dbms_cloud_oci_database_create_database_from_backup_details_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_create_database_from_backup_t is a subtype of the dbms_cloud_oci_database_create_database_base_t type.

Fields

Field Description

database

(required)

DBMS_CLOUD_OCI_DATABASE_CREATE_DATABASE_FROM_DB_SYSTEM_DETAILS_T Type

Details for creating a database by restoring from a source database system. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_database_from_db_system_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  admin_password varchar2(32767),
  db_name varchar2(32767),
  db_domain varchar2(32767),
  db_unique_name varchar2(32767),
  db_backup_config dbms_cloud_oci_database_db_backup_config_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_database_from_db_system_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_database_from_db_system_details_t (
    admin_password varchar2,
    db_name varchar2,
    db_domain varchar2,
    db_unique_name varchar2,
    db_backup_config dbms_cloud_oci_database_db_backup_config_t,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

admin_password

(required) A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, \\#, or -.

db_name

(optional) The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

db_domain

(optional) The database domain. In a distributed database system, DB_DOMAIN specifies the logical location of the database within the network structure.

db_unique_name

(optional) The `DB_UNIQUE_NAME` of the Oracle Database.

db_backup_config

(optional)

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_CREATE_DATABASE_SOFTWARE_IMAGE_DETAILS_T Type

Parameters for creating a database software image in the specified compartment. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_database_software_image_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  database_version varchar2(32767),
  display_name varchar2(32767),
  image_shape_family varchar2(32767),
  image_type varchar2(32767),
  patch_set varchar2(32767),
  database_software_image_one_off_patches dbms_cloud_oci_database_varchar2_tbl,
  ls_inventory varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  source_db_home_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_database_software_image_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_database_software_image_details_t (
    compartment_id varchar2,
    database_version varchar2,
    display_name varchar2,
    image_shape_family varchar2,
    image_type varchar2,
    patch_set varchar2,
    database_software_image_one_off_patches dbms_cloud_oci_database_varchar2_tbl,
    ls_inventory varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    source_db_home_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment the database software image belongs in.

database_version

(optional) The database version with which the database software image is to be built.

display_name

(required) The user-friendly name for the database software image. The name does not have to be unique.

image_shape_family

(optional) To what shape the image is meant for.

Allowed values are: 'VM_BM_SHAPE', 'EXADATA_SHAPE', 'EXACC_SHAPE'

image_type

(optional) The type of software image. Can be grid or database.

Allowed values are: 'GRID_IMAGE', 'DATABASE_IMAGE'

patch_set

(optional) The PSU or PBP or Release Updates. To get a list of supported versions, use the LIST_DB_VERSIONS Function operation.

database_software_image_one_off_patches

(optional) List of one-off patches for Database Homes.

ls_inventory

(optional) The output from the OPatch lsInventory command, which is passed as a string.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

source_db_home_id

(optional) The OCID of the Database Home.

DBMS_CLOUD_OCI_DATABASE_CREATE_DB_HOME_BASE_T Type

Details for creating a Database Home. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_db_home_base_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  kms_key_id varchar2(32767),
  kms_key_version_id varchar2(32767),
  database_software_image_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  source varchar2(32767),
  is_desupported_version number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_db_home_base_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_db_home_base_t (
    display_name varchar2,
    kms_key_id varchar2,
    kms_key_version_id varchar2,
    database_software_image_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    source varchar2,
    is_desupported_version number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

display_name

(optional) The user-provided name of the Database Home.

kms_key_id

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

kms_key_version_id

(optional) 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.

database_software_image_id

(optional) The database software image OCID

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

source

(optional) The source of database: NONE for creating a new database. DB_BACKUP for creating a new database by restoring from a database backup.

Allowed values are: 'NONE', 'DB_BACKUP', 'DATABASE', 'VM_CLUSTER_BACKUP', 'VM_CLUSTER_NEW'

is_desupported_version

(optional) If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI.

DBMS_CLOUD_OCI_DATABASE_CREATE_DB_HOME_DETAILS_T Type

Details for creating a Database Home. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_db_home_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  db_version varchar2(32767),
  database_software_image_id varchar2(32767),
  database dbms_cloud_oci_database_create_database_details_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_db_home_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_db_home_details_t (
    display_name varchar2,
    db_version varchar2,
    database_software_image_id varchar2,
    database dbms_cloud_oci_database_create_database_details_t,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) The user-provided name of the Database Home.

db_version

(required) A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

database_software_image_id

(optional) The database software image OCID.

database

(required)

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_CREATE_DB_HOME_FROM_BACKUP_DETAILS_T Type

Details for creating a Database Home if you are creating a database by restoring from a database backup. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_db_home_from_backup_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  database_software_image_id varchar2(32767),
  database dbms_cloud_oci_database_create_database_from_backup_details_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_db_home_from_backup_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_db_home_from_backup_details_t (
    display_name varchar2,
    database_software_image_id varchar2,
    database dbms_cloud_oci_database_create_database_from_backup_details_t,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) The user-provided name of the Database Home.

database_software_image_id

(optional) The database software image OCID of the image to be used to restore a database.

database

(required)

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_CREATE_DB_HOME_FROM_DATABASE_DETAILS_T Type

Details for creating a Database Home if you are creating a database by restoring from a database backup. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_db_home_from_database_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  database dbms_cloud_oci_database_create_database_from_another_database_details_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_db_home_from_database_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_db_home_from_database_details_t (
    display_name varchar2,
    database dbms_cloud_oci_database_create_database_from_another_database_details_t,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) The user-provided name of the Database Home.

database

(required)

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_CREATE_DB_HOME_FROM_DB_SYSTEM_DETAILS_T Type

Details for creating a Database Home if you are cloning a database from a another database system. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_db_home_from_db_system_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  database dbms_cloud_oci_database_create_database_from_db_system_details_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_db_home_from_db_system_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_db_home_from_db_system_details_t (
    display_name varchar2,
    database dbms_cloud_oci_database_create_database_from_db_system_details_t,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) The user-provided name of the Database Home.

database

(required)

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_CREATE_DB_HOME_WITH_DB_SYSTEM_ID_DETAILS_T Type

Note that a valid `dbSystemId` value must be supplied for the `CreateDbHomeWithDbSystemId` API operation to successfully complete.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_db_home_with_db_system_id_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_create_db_home_base_t (
  db_system_id varchar2(32767),
  db_version varchar2(32767),
  database dbms_cloud_oci_database_create_database_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_db_home_with_db_system_id_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_db_home_with_db_system_id_details_t (
    display_name varchar2,
    kms_key_id varchar2,
    kms_key_version_id varchar2,
    database_software_image_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    source varchar2,
    is_desupported_version number,
    db_system_id varchar2,
    db_version varchar2,
    database dbms_cloud_oci_database_create_database_details_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_create_db_home_with_db_system_id_details_t is a subtype of the dbms_cloud_oci_database_create_db_home_base_t type.

Fields

Field Description

db_system_id

(required) The OCID of the DB system.

db_version

(optional) A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

database

(optional)

DBMS_CLOUD_OCI_DATABASE_CREATE_DB_HOME_WITH_DB_SYSTEM_ID_FROM_BACKUP_DETAILS_T Type

Note that a valid `dbSystemId` value must be supplied for the `CreateDbHomeWithDbSystemIdFromBackup` API operation to successfully complete.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_db_home_with_db_system_id_from_backup_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_create_db_home_base_t (
  db_system_id varchar2(32767),
  database dbms_cloud_oci_database_create_database_from_backup_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_db_home_with_db_system_id_from_backup_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_db_home_with_db_system_id_from_backup_details_t (
    display_name varchar2,
    kms_key_id varchar2,
    kms_key_version_id varchar2,
    database_software_image_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    source varchar2,
    is_desupported_version number,
    db_system_id varchar2,
    database dbms_cloud_oci_database_create_database_from_backup_details_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_create_db_home_with_db_system_id_from_backup_details_t is a subtype of the dbms_cloud_oci_database_create_db_home_base_t type.

Fields

Field Description

db_system_id

(required) The OCID of the DB system.

database

(required)

DBMS_CLOUD_OCI_DATABASE_CREATE_DB_HOME_WITH_DB_SYSTEM_ID_FROM_DATABASE_DETAILS_T Type

Note that a valid `dbSystemId` value must be supplied for the `CreateDbHomeWithDbSystemIdFromDatabase` API operation to successfully complete.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_db_home_with_db_system_id_from_database_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_create_db_home_base_t (
  db_system_id varchar2(32767),
  database dbms_cloud_oci_database_create_database_from_another_database_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_db_home_with_db_system_id_from_database_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_db_home_with_db_system_id_from_database_details_t (
    display_name varchar2,
    kms_key_id varchar2,
    kms_key_version_id varchar2,
    database_software_image_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    source varchar2,
    is_desupported_version number,
    db_system_id varchar2,
    database dbms_cloud_oci_database_create_database_from_another_database_details_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_create_db_home_with_db_system_id_from_database_details_t is a subtype of the dbms_cloud_oci_database_create_db_home_base_t type.

Fields

Field Description

db_system_id

(required) The OCID of the DB system.

database

(required)

DBMS_CLOUD_OCI_DATABASE_CREATE_DB_HOME_WITH_VM_CLUSTER_ID_DETAILS_T Type

Note that a valid `vmClusterId` value must be supplied for the `CreateDbHomeWithVmClusterId` API operation to successfully complete.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_db_home_with_vm_cluster_id_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_create_db_home_base_t (
  vm_cluster_id varchar2(32767),
  db_version varchar2(32767),
  database dbms_cloud_oci_database_create_database_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_db_home_with_vm_cluster_id_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_db_home_with_vm_cluster_id_details_t (
    display_name varchar2,
    kms_key_id varchar2,
    kms_key_version_id varchar2,
    database_software_image_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    source varchar2,
    is_desupported_version number,
    vm_cluster_id varchar2,
    db_version varchar2,
    database dbms_cloud_oci_database_create_database_details_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_create_db_home_with_vm_cluster_id_details_t is a subtype of the dbms_cloud_oci_database_create_db_home_base_t type.

Fields

Field Description

vm_cluster_id

(required) The OCID of the VM cluster.

db_version

(optional) A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

database

(optional)

DBMS_CLOUD_OCI_DATABASE_CREATE_DB_HOME_WITH_VM_CLUSTER_ID_FROM_BACKUP_DETAILS_T Type

Note that a valid `vmClusterId` value must be supplied for the `CreateDbHomeWithVmClusterIdFromBackup` API operation to successfully complete.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_db_home_with_vm_cluster_id_from_backup_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_create_db_home_base_t (
  vm_cluster_id varchar2(32767),
  database dbms_cloud_oci_database_create_database_from_backup_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_db_home_with_vm_cluster_id_from_backup_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_db_home_with_vm_cluster_id_from_backup_details_t (
    display_name varchar2,
    kms_key_id varchar2,
    kms_key_version_id varchar2,
    database_software_image_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    source varchar2,
    is_desupported_version number,
    vm_cluster_id varchar2,
    database dbms_cloud_oci_database_create_database_from_backup_details_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_create_db_home_with_vm_cluster_id_from_backup_details_t is a subtype of the dbms_cloud_oci_database_create_db_home_base_t type.

Fields

Field Description

vm_cluster_id

(required) The OCID of the VM cluster.

database

(required)

DBMS_CLOUD_OCI_DATABASE_EXADATA_INFRASTRUCTURE_CONTACT_T Type

Contact details for Exadata Infrastructure.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_exadata_infrastructure_contact_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  phone_number varchar2(32767),
  email varchar2(32767),
  is_primary number,
  is_contact_mos_validated number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_exadata_infrastructure_contact_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_exadata_infrastructure_contact_t (
    name varchar2,
    phone_number varchar2,
    email varchar2,
    is_primary number,
    is_contact_mos_validated number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) The name of the Exadata Infrastructure contact.

phone_number

(optional) The phone number for the Exadata Infrastructure contact.

email

(required) The email for the Exadata Infrastructure contact.

is_primary

(required) If `true`, this Exadata Infrastructure contact is a primary contact. If `false`, this Exadata Infrastructure is a secondary contact.

is_contact_mos_validated

(optional) If `true`, this Exadata Infrastructure contact is a valid My Oracle Support (MOS) contact. If `false`, this Exadata Infrastructure contact is not a valid MOS contact.

DBMS_CLOUD_OCI_DATABASE_NETWORK_BONDING_MODE_DETAILS_T Type

Details of bonding mode for Client and Backup and DR networks of an Exadata infrastructure.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_network_bonding_mode_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  client_network_bonding_mode varchar2(32767),
  backup_network_bonding_mode varchar2(32767),
  dr_network_bonding_mode varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_network_bonding_mode_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_network_bonding_mode_details_t (
    client_network_bonding_mode varchar2,
    backup_network_bonding_mode varchar2,
    dr_network_bonding_mode varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

client_network_bonding_mode

(optional) The network bonding mode for the Exadata infrastructure.

Allowed values are: 'ACTIVE_BACKUP', 'LACP'

backup_network_bonding_mode

(optional) The network bonding mode for the Exadata infrastructure.

Allowed values are: 'ACTIVE_BACKUP', 'LACP'

dr_network_bonding_mode

(optional) The network bonding mode for the Exadata infrastructure.

Allowed values are: 'ACTIVE_BACKUP', 'LACP'

DBMS_CLOUD_OCI_DATABASE_EXADATA_INFRASTRUCTURE_CONTACT_TBL Type

Nested table type of dbms_cloud_oci_database_exadata_infrastructure_contact_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_exadata_infrastructure_contact_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_exadata_infrastructure_contact_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_CREATE_EXADATA_INFRASTRUCTURE_DETAILS_T Type

Request to create Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only. See CREATE_CLOUD_EXADATA_INFRASTRUCTURE_DETAILS Function for information on creating a cloud Exadata infrastructure resource in an Exadata Cloud Service instance.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_exadata_infrastructure_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  shape varchar2(32767),
  time_zone varchar2(32767),
  cloud_control_plane_server1 varchar2(32767),
  cloud_control_plane_server2 varchar2(32767),
  netmask varchar2(32767),
  gateway varchar2(32767),
  admin_network_cidr varchar2(32767),
  infini_band_network_cidr varchar2(32767),
  corporate_proxy varchar2(32767),
  contacts dbms_cloud_oci_database_exadata_infrastructure_contact_tbl,
  maintenance_window dbms_cloud_oci_database_maintenance_window_t,
  storage_count number,
  compute_count number,
  is_multi_rack_deployment number,
  multi_rack_configuration_file clob,
  dns_server dbms_cloud_oci_database_varchar2_tbl,
  ntp_server dbms_cloud_oci_database_varchar2_tbl,
  is_cps_offline_report_enabled number,
  network_bonding_mode_details dbms_cloud_oci_database_network_bonding_mode_details_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_exadata_infrastructure_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_exadata_infrastructure_details_t (
    compartment_id varchar2,
    display_name varchar2,
    shape varchar2,
    time_zone varchar2,
    cloud_control_plane_server1 varchar2,
    cloud_control_plane_server2 varchar2,
    netmask varchar2,
    gateway varchar2,
    admin_network_cidr varchar2,
    infini_band_network_cidr varchar2,
    corporate_proxy varchar2,
    contacts dbms_cloud_oci_database_exadata_infrastructure_contact_tbl,
    maintenance_window dbms_cloud_oci_database_maintenance_window_t,
    storage_count number,
    compute_count number,
    is_multi_rack_deployment number,
    multi_rack_configuration_file clob,
    dns_server dbms_cloud_oci_database_varchar2_tbl,
    ntp_server dbms_cloud_oci_database_varchar2_tbl,
    is_cps_offline_report_enabled number,
    network_bonding_mode_details dbms_cloud_oci_database_network_bonding_mode_details_t,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment.

display_name

(required) The user-friendly name for the Exadata infrastructure. The name does not need to be unique.

shape

(required) The shape of the Exadata infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance.

time_zone

(required) The time zone of the Exadata infrastructure. For details, see Exadata Infrastructure Time Zones.

cloud_control_plane_server1

(required) The IP address for the first control plane server.

cloud_control_plane_server2

(required) The IP address for the second control plane server.

netmask

(required) The netmask for the control plane network.

gateway

(required) The gateway for the control plane network.

admin_network_cidr

(required) The CIDR block for the Exadata administration network.

infini_band_network_cidr

(required) The CIDR block for the Exadata InfiniBand interconnect.

corporate_proxy

(optional) The corporate network proxy for access to the control plane network. Oracle recommends using an HTTPS proxy when possible for enhanced security.

contacts

(optional) The list of contacts for the Exadata infrastructure.

maintenance_window

(optional)

storage_count

(optional) The number of storage servers for the Exadata infrastructure.

compute_count

(optional) The number of compute servers for the Exadata infrastructure.

is_multi_rack_deployment

(optional) Indicates if deployment is Multi-Rack or not.

multi_rack_configuration_file

(optional) The base64 encoded Multi-Rack configuration json file.

dns_server

(required) The list of DNS server IP addresses. Maximum of 3 allowed.

ntp_server

(required) The list of NTP server IP addresses. Maximum of 3 allowed.

is_cps_offline_report_enabled

(optional) Indicates whether cps offline diagnostic report is enabled for this Exadata infrastructure. This will allow a customer to quickly check status themselves and fix problems on their end, saving time and frustration for both Oracle and the customer when they find the CPS in a disconnected state.You can enable offline diagnostic report during Exadata infrastructure provisioning. You can also disable or enable it at any time using the UpdateExadatainfrastructure API.

network_bonding_mode_details

(optional)

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_CREATE_EXTERNAL_BACKUP_JOB_DETAILS_T Type

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_external_backup_job_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  availability_domain varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  db_version varchar2(32767),
  db_name varchar2(32767),
  db_unique_name varchar2(32767),
  pdb_name varchar2(32767),
  external_database_identifier number,
  character_set varchar2(32767),
  ncharacter_set varchar2(32767),
  database_mode varchar2(32767),
  database_edition varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_external_backup_job_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_external_backup_job_details_t (
    availability_domain varchar2,
    compartment_id varchar2,
    display_name varchar2,
    db_version varchar2,
    db_name varchar2,
    db_unique_name varchar2,
    pdb_name varchar2,
    external_database_identifier number,
    character_set varchar2,
    ncharacter_set varchar2,
    database_mode varchar2,
    database_edition varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

availability_domain

(required) The targeted availability domain for the backup.

compartment_id

(required) The OCID of the compartment where this backup should be created.

display_name

(required) A user-friendly name for the backup. This name does not have to be unique.

db_version

(required) A valid Oracle Database version.

db_name

(required) The name of the database from which the backup is being taken.

db_unique_name

(optional) The `DB_UNIQUE_NAME` of the Oracle Database being backed up.

pdb_name

(optional) The pluggable database name.

external_database_identifier

(required) The `DBID` of the Oracle Database being backed up.

character_set

(required) The character set for the database.

ncharacter_set

(required) The national character set for the database.

database_mode

(required) The mode (single instance or RAC) of the database being backed up.

Allowed values are: 'SI', 'RAC'

database_edition

(required) The Oracle Database edition to use for creating a database from this standalone backup. Note that 2-node RAC DB systems require Enterprise Edition - Extreme Performance.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION', 'ENTERPRISE_EDITION_HIGH_PERFORMANCE', 'ENTERPRISE_EDITION_EXTREME_PERFORMANCE'

DBMS_CLOUD_OCI_DATABASE_CREATE_EXTERNAL_CONTAINER_DATABASE_DETAILS_T Type

Details for creating an external container database resource.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_external_container_database_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_external_container_database_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_external_container_database_details_t (
    compartment_id varchar2,
    display_name varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment.

display_name

(required) The user-friendly name for the external database. The name does not have to be unique.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_CREATE_EXTERNAL_DATABASE_CONNECTOR_DETAILS_T Type

Details for creating an external database connector resource.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_external_database_connector_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  freeform_tags json_element_t,
  defined_tags json_element_t,
  display_name varchar2(32767),
  connector_type varchar2(32767),
  external_database_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_external_database_connector_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_external_database_connector_details_t (
    freeform_tags json_element_t,
    defined_tags json_element_t,
    display_name varchar2,
    connector_type varchar2,
    external_database_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

display_name

(required) The user-friendly name for the CREATE_EXTERNAL_DATABASE_CONNECTOR_DETAILS Function. The name does not have to be unique.

connector_type

(optional) The type of connector used by the external database resource.

Allowed values are: 'MACS'

external_database_id

(required) The OCID of the external database resource.

DBMS_CLOUD_OCI_DATABASE_CREATE_EXTERNAL_DATABASE_DETAILS_BASE_T Type

Details for creating an external database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_external_database_details_base_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_external_database_details_base_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_external_database_details_base_t (
    compartment_id varchar2,
    display_name varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment.

display_name

(required) The user-friendly name for the external database. The name does not have to be unique.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_DATABASE_CONNECTION_STRING_T Type

The Oracle Database connection string.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_database_connection_string_t FORCE AUTHID CURRENT_USER IS OBJECT (
  hostname varchar2(32767),
  port number,
  service varchar2(32767),
  protocol varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_connection_string_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_connection_string_t (
    hostname varchar2,
    port number,
    service varchar2,
    protocol varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

hostname

(required) The host name of the database.

port

(required) The port used to connect to the database.

service

(required) The name of the service alias used to connect to the database.

protocol

(required) The protocol used to connect to the database.

Allowed values are: 'TCP', 'TCPS'

DBMS_CLOUD_OCI_DATABASE_DATABASE_CONNECTION_CREDENTIALS_T Type

Credentials used to connect to the database. Currently only the `DETAILS` type is supported for creating MACS connector crendentials.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_database_connection_credentials_t FORCE AUTHID CURRENT_USER IS OBJECT (
  credential_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_connection_credentials_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_connection_credentials_t (
    credential_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

credential_type

(optional) The type of credential used to connect to the database.

Allowed values are: 'NAME_REFERENCE', 'DETAILS', 'SSL_DETAILS'

DBMS_CLOUD_OCI_DATABASE_CREATE_EXTERNAL_MACS_CONNECTOR_DETAILS_T Type

Details for creating a resource used to connect to an external Oracle Database using the Management Agent cloud service (MACS).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_external_macs_connector_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_create_external_database_connector_details_t (
  connection_string dbms_cloud_oci_database_database_connection_string_t,
  connection_credentials dbms_cloud_oci_database_database_connection_credentials_t,
  connector_agent_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_external_macs_connector_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_external_macs_connector_details_t (
    freeform_tags json_element_t,
    defined_tags json_element_t,
    display_name varchar2,
    connector_type varchar2,
    external_database_id varchar2,
    connection_string dbms_cloud_oci_database_database_connection_string_t,
    connection_credentials dbms_cloud_oci_database_database_connection_credentials_t,
    connector_agent_id varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_create_external_macs_connector_details_t is a subtype of the dbms_cloud_oci_database_create_external_database_connector_details_t type.

Fields

Field Description

connection_string

(required)

connection_credentials

(required)

connector_agent_id

(required) The ID of the agent used for the CREATE_EXTERNAL_DATABASE_CONNECTOR_DETAILS Function.

DBMS_CLOUD_OCI_DATABASE_CREATE_EXTERNAL_NON_CONTAINER_DATABASE_DETAILS_T Type

Details for creating an external non-container database resource.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_external_non_container_database_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_external_non_container_database_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_external_non_container_database_details_t (
    compartment_id varchar2,
    display_name varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment.

display_name

(required) The user-friendly name for the external database. The name does not have to be unique.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_CREATE_EXTERNAL_PLUGGABLE_DATABASE_DETAILS_T Type

Details for creating an external pluggable database resource.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_external_pluggable_database_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  source_id varchar2(32767),
  external_container_database_id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_external_pluggable_database_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_external_pluggable_database_details_t (
    source_id varchar2,
    external_container_database_id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

source_id

(optional) The OCID of the the non-container database that was converted to a pluggable database to create this resource.

external_container_database_id

(required) The OCID of the CREATE_EXTERNAL_CONTAINER_DATABASE_DETAILS Function that contains the specified CREATE_EXTERNAL_PLUGGABLE_DATABASE_DETAILS Function resource.

compartment_id

(required) The OCID of the compartment.

display_name

(required) The user-friendly name for the external database. The name does not have to be unique.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_KEY_STORE_TYPE_DETAILS_T Type

Key store type details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_key_store_type_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  l_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_key_store_type_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_key_store_type_details_t (
    l_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

l_type

(required) The type of key store.

Allowed values are: 'ORACLE_KEY_VAULT'

DBMS_CLOUD_OCI_DATABASE_CREATE_KEY_STORE_DETAILS_T Type

Details for the create key store operation.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_key_store_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  type_details dbms_cloud_oci_database_key_store_type_details_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_key_store_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_key_store_details_t (
    compartment_id varchar2,
    display_name varchar2,
    type_details dbms_cloud_oci_database_key_store_type_details_t,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment.

display_name

(required) The user-friendly name for the key store. The name does not need to be unique.

type_details

(required)

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_CREATE_MAINTENANCE_RUN_DETAILS_T Type

Details to schedule Maintenance Run with Latest Release Update along TimeZone File Update for the specified resource.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_maintenance_run_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  target_resource_id varchar2(32767),
  is_dst_file_update_enabled number,
  time_scheduled timestamp with time zone,
  patching_mode varchar2(32767),
  patch_type varchar2(32767),
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_maintenance_run_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_maintenance_run_details_t (
    target_resource_id varchar2,
    is_dst_file_update_enabled number,
    time_scheduled timestamp with time zone,
    patching_mode varchar2,
    patch_type varchar2,
    compartment_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

target_resource_id

(required) The ID of the target resource for which the maintenance run should be created.

is_dst_file_update_enabled

(optional) Indicates if an automatic DST Time Zone file update is enabled for the Autonomous Container Database. If enabled along with Release Update, patching will be done in a Non-Rolling manner.

time_scheduled

(required) The date and time that update should be scheduled.

patching_mode

(optional) Cloud Exadata infrastructure node patching method, either \"ROLLING\" or \"NONROLLING\". Default value is ROLLING. *IMPORTANT*: Non-rolling infrastructure patching involves system down time. See Oracle-Managed Infrastructure Maintenance Updates for more information.

Allowed values are: 'ROLLING', 'NONROLLING'

patch_type

(required) Patch type, either \"QUARTERLY\" or \"TIMEZONE\".

Allowed values are: 'QUARTERLY', 'TIMEZONE'

compartment_id

(optional) The OCID of the compartment containing the Maintenance Run.

DBMS_CLOUD_OCI_DATABASE_CREATE_NFS_BACKUP_DESTINATION_DETAILS_T Type

Used for creating NFS backup destinations.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_nfs_backup_destination_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_create_backup_destination_details_t (
  local_mount_point_path varchar2(32767),
  mount_type_details dbms_cloud_oci_database_mount_type_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_nfs_backup_destination_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_nfs_backup_destination_details_t (
    display_name varchar2,
    compartment_id varchar2,
    l_type varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    local_mount_point_path varchar2,
    mount_type_details dbms_cloud_oci_database_mount_type_details_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_create_nfs_backup_destination_details_t is a subtype of the dbms_cloud_oci_database_create_backup_destination_details_t type.

Fields

Field Description

local_mount_point_path

(optional) **Deprecated.** The local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes. This field is deprecated. Use the mountTypeDetails field instead to specify the mount type for NFS.

mount_type_details

(optional)

DBMS_CLOUD_OCI_DATABASE_CREATE_NEW_DATABASE_DETAILS_T Type

Details for creating a new database. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_new_database_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_create_database_base_t (
  database dbms_cloud_oci_database_create_database_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_new_database_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_new_database_details_t (
    db_home_id varchar2,
    db_version varchar2,
    source varchar2,
    kms_key_id varchar2,
    kms_key_version_id varchar2,
    database dbms_cloud_oci_database_create_database_details_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_create_new_database_details_t is a subtype of the dbms_cloud_oci_database_create_database_base_t type.

Fields

Field Description

database

(required)

DBMS_CLOUD_OCI_DATABASE_CREATE_ONEOFF_PATCH_DETAILS_T Type

Data to create the one-off patch for the specificed database version.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_oneoff_patch_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  db_version varchar2(32767),
  release_update varchar2(32767),
  one_off_patches dbms_cloud_oci_database_varchar2_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_oneoff_patch_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_oneoff_patch_details_t (
    compartment_id varchar2,
    display_name varchar2,
    db_version varchar2,
    release_update varchar2,
    one_off_patches dbms_cloud_oci_database_varchar2_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment.

display_name

(required) One-off patch name.

db_version

(required) A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

release_update

(required) The PSU or PBP or Release Updates. To get a list of supported versions, use the LIST_DB_VERSIONS Function operation.

one_off_patches

(optional) List of one-off patches for Database Homes.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_CREATE_PLUGGABLE_DATABASE_CREATION_TYPE_DETAILS_T Type

The Pluggable Database creation type. Use `LOCAL_CLONE_PDB` for creating a new PDB using Local Clone on Source Pluggable Database. This will Clone and starts a pluggable database (PDB) in the same database (CDB) as the source PDB. The source PDB must be in the `READ_WRITE` openMode to perform the clone operation. Use `REMOTE_CLONE_PDB` for creating a new PDB using Remote Clone on Source Pluggable Database. This will Clone a pluggable database (PDB) to a different database from the source PDB. The cloned PDB will be started upon completion of the clone operation. The source PDB must be in the `READ_WRITE` openMode when performing the clone. For Exadata Cloud@Customer instances, the source pluggable database (PDB) must be on the same Exadata Infrastructure as the target container database (CDB) to create a remote clone. Use `RELOCATE_PDB` for relocating the Pluggable Database from Source CDB and creating it in target CDB. This will relocate a pluggable database (PDB) to a different database from the source PDB. The source PDB must be in the `READ_WRITE` openMode when performing the relocate.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_pluggable_database_creation_type_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  creation_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_pluggable_database_creation_type_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_pluggable_database_creation_type_details_t (
    creation_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

creation_type

(required) The Pluggable Database creation type.

Allowed values are: 'LOCAL_CLONE_PDB', 'REMOTE_CLONE_PDB', 'RELOCATE_PDB'

DBMS_CLOUD_OCI_DATABASE_CREATE_PLUGGABLE_DATABASE_DETAILS_T Type

Parameters for creating a pluggable database in a specified container database (CDB). Additional option `pdbCreationTypeDetails` can be used for creating Pluggable Database using different operations, e.g. LocalClone, Remote Clone, Relocate. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_pluggable_database_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  pdb_name varchar2(32767),
  container_database_id varchar2(32767),
  pdb_admin_password varchar2(32767),
  tde_wallet_password varchar2(32767),
  should_pdb_admin_account_be_locked number,
  container_database_admin_password varchar2(32767),
  should_create_pdb_backup number,
  pdb_creation_type_details dbms_cloud_oci_database_create_pluggable_database_creation_type_details_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_pluggable_database_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_pluggable_database_details_t (
    pdb_name varchar2,
    container_database_id varchar2,
    pdb_admin_password varchar2,
    tde_wallet_password varchar2,
    should_pdb_admin_account_be_locked number,
    container_database_admin_password varchar2,
    should_create_pdb_backup number,
    pdb_creation_type_details dbms_cloud_oci_database_create_pluggable_database_creation_type_details_t,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

pdb_name

(required) The name for the pluggable database (PDB). The name is unique in the context of a DATABASE Type. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name.

container_database_id

(required) The OCID of the CDB

pdb_admin_password

(optional) A strong password for PDB Admin. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, \\#, or -.

tde_wallet_password

(optional) The existing TDE wallet password of the CDB.

should_pdb_admin_account_be_locked

(optional) The locked mode of the pluggable database admin account. If false, the user needs to provide the PDB Admin Password to connect to it. If true, the pluggable database will be locked and user cannot login to it.

container_database_admin_password

(optional) The DB system administrator password of the Container Database.

should_create_pdb_backup

(optional) Indicates whether to take Pluggable Database Backup after the operation.

pdb_creation_type_details

(optional)

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_CREATE_PLUGGABLE_DATABASE_FROM_LOCAL_CLONE_DETAILS_T Type

Specifies the creation type Local Clone.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_pluggable_database_from_local_clone_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_create_pluggable_database_creation_type_details_t (
  source_pluggable_database_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_pluggable_database_from_local_clone_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_pluggable_database_from_local_clone_details_t (
    creation_type varchar2,
    source_pluggable_database_id varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_create_pluggable_database_from_local_clone_details_t is a subtype of the dbms_cloud_oci_database_create_pluggable_database_creation_type_details_t type.

Fields

Field Description

source_pluggable_database_id

(required) The OCID of the Source Pluggable Database.

DBMS_CLOUD_OCI_DATABASE_CREATE_PLUGGABLE_DATABASE_FROM_RELOCATE_DETAILS_T Type

Specifies the creation type Relocate. Additional input 'dblinkUsername` and `dblinkUserPassword` can be provided for Relocate Operation. If not provided, Backend will create a temporary user to perform Relocate operation.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_pluggable_database_from_relocate_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_create_pluggable_database_creation_type_details_t (
  dblink_username varchar2(32767),
  dblink_user_password varchar2(32767),
  source_pluggable_database_id varchar2(32767),
  source_container_database_admin_password varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_pluggable_database_from_relocate_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_pluggable_database_from_relocate_details_t (
    creation_type varchar2,
    dblink_username varchar2,
    dblink_user_password varchar2,
    source_pluggable_database_id varchar2,
    source_container_database_admin_password varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_create_pluggable_database_from_relocate_details_t is a subtype of the dbms_cloud_oci_database_create_pluggable_database_creation_type_details_t type.

Fields

Field Description

dblink_username

(optional) The name of the DB link user.

dblink_user_password

(optional) The DB link user password.

source_pluggable_database_id

(required) The OCID of the Source Pluggable Database.

source_container_database_admin_password

(required) The DB system administrator password of the source Container Database.

DBMS_CLOUD_OCI_DATABASE_CREATE_PLUGGABLE_DATABASE_REFRESHABLE_CLONE_DETAILS_T Type

Parameters for creating Pluggable Database Refreshable Clone. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_pluggable_database_refreshable_clone_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  is_refreshable_clone number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_pluggable_database_refreshable_clone_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_pluggable_database_refreshable_clone_details_t (
    is_refreshable_clone number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

is_refreshable_clone

(optional) Indicates whether Pluggable Database is a refreshable clone.

DBMS_CLOUD_OCI_DATABASE_CREATE_PLUGGABLE_DATABASE_FROM_REMOTE_CLONE_DETAILS_T Type

Specifies the creation type Remote Clone. Additional input 'dblinkUsername` and `dblinkUserPassword` can be provided for RemoteClone/Create RefreshableClone Operation. If not provided, Backend will create a temporary user to perform RemoteClone operation. It is a required input parameter in case of creating Refreshable Clone PDB.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_pluggable_database_from_remote_clone_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_create_pluggable_database_creation_type_details_t (
  dblink_username varchar2(32767),
  dblink_user_password varchar2(32767),
  source_pluggable_database_id varchar2(32767),
  source_container_database_admin_password varchar2(32767),
  refreshable_clone_details dbms_cloud_oci_database_create_pluggable_database_refreshable_clone_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_pluggable_database_from_remote_clone_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_pluggable_database_from_remote_clone_details_t (
    creation_type varchar2,
    dblink_username varchar2,
    dblink_user_password varchar2,
    source_pluggable_database_id varchar2,
    source_container_database_admin_password varchar2,
    refreshable_clone_details dbms_cloud_oci_database_create_pluggable_database_refreshable_clone_details_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_create_pluggable_database_from_remote_clone_details_t is a subtype of the dbms_cloud_oci_database_create_pluggable_database_creation_type_details_t type.

Fields

Field Description

dblink_username

(optional) The name of the DB link user.

dblink_user_password

(optional) The DB link user password.

source_pluggable_database_id

(required) The OCID of the Source Pluggable Database.

source_container_database_admin_password

(required) The DB system administrator password of the source Container Database.

refreshable_clone_details

(optional)

DBMS_CLOUD_OCI_DATABASE_CREATE_RECOVERY_APPLIANCE_BACKUP_DESTINATION_DETAILS_T Type

Used for creating Recovery Appliance backup destinations.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_recovery_appliance_backup_destination_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_create_backup_destination_details_t (
  connection_string varchar2(32767),
  vpc_users dbms_cloud_oci_database_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_recovery_appliance_backup_destination_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_recovery_appliance_backup_destination_details_t (
    display_name varchar2,
    compartment_id varchar2,
    l_type varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    connection_string varchar2,
    vpc_users dbms_cloud_oci_database_varchar2_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_create_recovery_appliance_backup_destination_details_t is a subtype of the dbms_cloud_oci_database_create_backup_destination_details_t type.

Fields

Field Description

connection_string

(required) The connection string for connecting to the Recovery Appliance.

vpc_users

(required) The Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance.

DBMS_CLOUD_OCI_DATABASE_CREATE_REFRESHABLE_AUTONOMOUS_DATABASE_CLONE_DETAILS_T Type

Details to create an Oracle Autonomous Database refreshable clone.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_refreshable_autonomous_database_clone_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_create_autonomous_database_base_t (
  source_id varchar2(32767),
  refreshable_mode varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_refreshable_autonomous_database_clone_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_refreshable_autonomous_database_clone_details_t (
    compartment_id varchar2,
    character_set varchar2,
    ncharacter_set varchar2,
    db_name varchar2,
    cpu_core_count number,
    backup_retention_period_in_days number,
    compute_model varchar2,
    compute_count number,
    ocpu_count number,
    db_workload varchar2,
    data_storage_size_in_t_bs number,
    data_storage_size_in_g_bs number,
    is_free_tier number,
    kms_key_id varchar2,
    vault_id varchar2,
    admin_password varchar2,
    display_name varchar2,
    license_model varchar2,
    is_preview_version_with_service_terms_accepted number,
    is_auto_scaling_enabled number,
    is_dedicated number,
    autonomous_container_database_id varchar2,
    in_memory_percentage number,
    is_access_control_enabled number,
    whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
    are_primary_whitelisted_ips_used number,
    standby_whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
    is_data_guard_enabled number,
    is_local_data_guard_enabled number,
    subnet_id varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    private_endpoint_label varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    private_endpoint_ip varchar2,
    db_version varchar2,
    source varchar2,
    customer_contacts dbms_cloud_oci_database_customer_contact_tbl,
    is_mtls_connection_required number,
    resource_pool_leader_id varchar2,
    resource_pool_summary dbms_cloud_oci_database_resource_pool_summary_t,
    autonomous_maintenance_schedule_type varchar2,
    scheduled_operations dbms_cloud_oci_database_scheduled_operation_details_tbl,
    is_auto_scaling_for_storage_enabled number,
    max_cpu_core_count number,
    database_edition varchar2,
    db_tools_details dbms_cloud_oci_database_database_tool_tbl,
    secret_id varchar2,
    secret_version_number number,
    source_id varchar2,
    refreshable_mode varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_create_refreshable_autonomous_database_clone_details_t is a subtype of the dbms_cloud_oci_database_create_autonomous_database_base_t type.

Fields

Field Description

source_id

(required) The OCID of the source Autonomous Database that you will clone to create a new Autonomous Database.

refreshable_mode

(optional) The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous Database.

Allowed values are: 'AUTOMATIC', 'MANUAL'

DBMS_CLOUD_OCI_DATABASE_CREATE_VM_CLUSTER_DETAILS_T Type

Details for the create Exadata VM cluster operation. Applies to Exadata Cloud@Customer instances only. For details on the create cloud Exadata VM cluster operation used with Exadata Cloud Service instances, see CREATE_CLOUD_VM_CLUSTER_DETAILS Function

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_create_vm_cluster_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  exadata_infrastructure_id varchar2(32767),
  cpu_core_count number,
  ocpu_count number,
  memory_size_in_g_bs number,
  db_node_storage_size_in_g_bs number,
  data_storage_size_in_t_bs number,
  data_storage_size_in_g_bs number,
  ssh_public_keys dbms_cloud_oci_database_varchar2_tbl,
  vm_cluster_network_id varchar2(32767),
  license_model varchar2(32767),
  is_sparse_diskgroup_enabled number,
  is_local_backup_enabled number,
  time_zone varchar2(32767),
  gi_version varchar2(32767),
  db_servers dbms_cloud_oci_database_varchar2_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  data_collection_options dbms_cloud_oci_database_data_collection_options_t,
  system_version varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_vm_cluster_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_create_vm_cluster_details_t (
    compartment_id varchar2,
    display_name varchar2,
    exadata_infrastructure_id varchar2,
    cpu_core_count number,
    ocpu_count number,
    memory_size_in_g_bs number,
    db_node_storage_size_in_g_bs number,
    data_storage_size_in_t_bs number,
    data_storage_size_in_g_bs number,
    ssh_public_keys dbms_cloud_oci_database_varchar2_tbl,
    vm_cluster_network_id varchar2,
    license_model varchar2,
    is_sparse_diskgroup_enabled number,
    is_local_backup_enabled number,
    time_zone varchar2,
    gi_version varchar2,
    db_servers dbms_cloud_oci_database_varchar2_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    data_collection_options dbms_cloud_oci_database_data_collection_options_t,
    system_version varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment.

display_name

(required) The user-friendly name for the VM cluster. The name does not need to be unique.

exadata_infrastructure_id

(required) The OCID of the Exadata infrastructure.

cpu_core_count

(required) The number of CPU cores to enable for the VM cluster.

ocpu_count

(optional) The number of OCPU cores to enable for the VM cluster. Only one decimal place is allowed for the fractional part.

memory_size_in_g_bs

(optional) The memory to be allocated in GBs.

db_node_storage_size_in_g_bs

(optional) The local node storage to be allocated in GBs.

data_storage_size_in_t_bs

(optional) The data disk group size to be allocated in TBs.

data_storage_size_in_g_bs

(optional) The data disk group size to be allocated in GBs.

ssh_public_keys

(required) The public key portion of one or more key pairs used for SSH access to the VM cluster.

vm_cluster_network_id

(required) The OCID of the VM cluster network.

license_model

(optional) The Oracle license model that applies to the VM cluster. The default is BRING_YOUR_OWN_LICENSE.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

is_sparse_diskgroup_enabled

(optional) If true, the sparse disk group is configured for the VM cluster. If false, the sparse disk group is not created.

is_local_backup_enabled

(optional) If true, database backup on local Exadata storage is configured for the VM cluster. If false, database backup on local Exadata storage is not available in the VM cluster.

time_zone

(optional) The time zone to use for the VM cluster. For details, see DB System Time Zones.

gi_version

(required) The Oracle Grid Infrastructure software version for the VM cluster.

db_servers

(optional) The list of Db server.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

data_collection_options

(optional)

system_version

(optional) Operating system version of the image.

DBMS_CLOUD_OCI_DATABASE_DATA_GUARD_ASSOCIATION_T Type

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_data_guard_association_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  database_id varchar2(32767),
  role varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  peer_db_system_id varchar2(32767),
  peer_db_home_id varchar2(32767),
  peer_database_id varchar2(32767),
  peer_data_guard_association_id varchar2(32767),
  peer_role varchar2(32767),
  apply_lag varchar2(32767),
  apply_rate varchar2(32767),
  protection_mode varchar2(32767),
  transport_type varchar2(32767),
  time_created timestamp with time zone,
  is_active_data_guard_enabled number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_data_guard_association_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_data_guard_association_t (
    id varchar2,
    database_id varchar2,
    role varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    peer_db_system_id varchar2,
    peer_db_home_id varchar2,
    peer_database_id varchar2,
    peer_data_guard_association_id varchar2,
    peer_role varchar2,
    apply_lag varchar2,
    apply_rate varchar2,
    protection_mode varchar2,
    transport_type varchar2,
    time_created timestamp with time zone,
    is_active_data_guard_enabled number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Data Guard association.

database_id

(required) The OCID of the reporting database.

role

(required) The role of the reporting database in this Data Guard association.

Allowed values are: 'PRIMARY', 'STANDBY', 'DISABLED_STANDBY'

lifecycle_state

(required) The current state of the Data Guard association.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED', 'UPGRADING'

lifecycle_details

(optional) Additional information about the current lifecycleState, if available.

peer_db_system_id

(required) The OCID of the DB system containing the associated peer database.

peer_db_home_id

(optional) The OCID of the Database Home containing the associated peer database.

peer_database_id

(optional) The OCID of the associated peer database.

peer_data_guard_association_id

(optional) The OCID of the peer database's Data Guard association.

peer_role

(required) The role of the peer database in this Data Guard association.

Allowed values are: 'PRIMARY', 'STANDBY', 'DISABLED_STANDBY'

apply_lag

(optional) The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: `9 seconds`

apply_rate

(optional) The rate at which redo logs are synced between the associated databases. Example: `180 Mb per second`

protection_mode

(required) The protection mode of this Data Guard association. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

Allowed values are: 'MAXIMUM_AVAILABILITY', 'MAXIMUM_PERFORMANCE', 'MAXIMUM_PROTECTION'

transport_type

(optional) The redo transport type used by this Data Guard association. For more information, see Redo Transport Services in the Oracle Data Guard documentation.

Allowed values are: 'SYNC', 'ASYNC', 'FASTSYNC'

time_created

(optional) The date and time the Data Guard association was created.

is_active_data_guard_enabled

(optional) True if active Data Guard is enabled.

DBMS_CLOUD_OCI_DATABASE_DATA_GUARD_ASSOCIATION_SUMMARY_T Type

The properties that define a Data Guard association. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies. For information about endpoints and signing API requests, see About the API. For information about available SDKs and tools, see SDKS and Other Tools.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_data_guard_association_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  database_id varchar2(32767),
  role varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  peer_db_system_id varchar2(32767),
  peer_db_home_id varchar2(32767),
  peer_database_id varchar2(32767),
  peer_data_guard_association_id varchar2(32767),
  peer_role varchar2(32767),
  apply_lag varchar2(32767),
  apply_rate varchar2(32767),
  protection_mode varchar2(32767),
  transport_type varchar2(32767),
  time_created timestamp with time zone,
  is_active_data_guard_enabled number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_data_guard_association_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_data_guard_association_summary_t (
    id varchar2,
    database_id varchar2,
    role varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    peer_db_system_id varchar2,
    peer_db_home_id varchar2,
    peer_database_id varchar2,
    peer_data_guard_association_id varchar2,
    peer_role varchar2,
    apply_lag varchar2,
    apply_rate varchar2,
    protection_mode varchar2,
    transport_type varchar2,
    time_created timestamp with time zone,
    is_active_data_guard_enabled number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Data Guard association.

database_id

(required) The OCID of the reporting database.

role

(required) The role of the reporting database in this Data Guard association.

Allowed values are: 'PRIMARY', 'STANDBY', 'DISABLED_STANDBY'

lifecycle_state

(required) The current state of the Data Guard association.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED', 'UPGRADING'

lifecycle_details

(optional) Additional information about the current lifecycleState, if available.

peer_db_system_id

(required) The OCID of the DB system containing the associated peer database.

peer_db_home_id

(optional) The OCID of the Database Home containing the associated peer database.

peer_database_id

(optional) The OCID of the associated peer database.

peer_data_guard_association_id

(optional) The OCID of the peer database's Data Guard association.

peer_role

(required) The role of the peer database in this Data Guard association.

Allowed values are: 'PRIMARY', 'STANDBY', 'DISABLED_STANDBY'

apply_lag

(optional) The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: `9 seconds`

apply_rate

(optional) The rate at which redo logs are synced between the associated databases. Example: `180 Mb per second`

protection_mode

(required) The protection mode of this Data Guard association. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

Allowed values are: 'MAXIMUM_AVAILABILITY', 'MAXIMUM_PERFORMANCE', 'MAXIMUM_PROTECTION'

transport_type

(optional) The redo transport type used by this Data Guard association. For more information, see Redo Transport Services in the Oracle Data Guard documentation.

Allowed values are: 'SYNC', 'ASYNC', 'FASTSYNC'

time_created

(optional) The date and time the Data Guard association was created.

is_active_data_guard_enabled

(optional) True if active Data Guard is enabled.

DBMS_CLOUD_OCI_DATABASE_DATABASE_CONNECTION_STRINGS_T Type

Connection strings to connect to an Oracle Database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_database_connection_strings_t FORCE AUTHID CURRENT_USER IS OBJECT (
  cdb_default varchar2(32767),
  cdb_ip_default varchar2(32767),
  all_connection_strings json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_connection_strings_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_connection_strings_t (
    cdb_default varchar2,
    cdb_ip_default varchar2,
    all_connection_strings json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

cdb_default

(optional) Host name based CDB Connection String.

cdb_ip_default

(optional) IP based CDB Connection String.

all_connection_strings

(optional) All connection strings to use to connect to the Database.

DBMS_CLOUD_OCI_DATABASE_DATABASE_T Type

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_database_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  character_set varchar2(32767),
  ncharacter_set varchar2(32767),
  db_home_id varchar2(32767),
  db_system_id varchar2(32767),
  vm_cluster_id varchar2(32767),
  db_name varchar2(32767),
  pdb_name varchar2(32767),
  db_workload varchar2(32767),
  db_unique_name varchar2(32767),
  lifecycle_details varchar2(32767),
  lifecycle_state varchar2(32767),
  time_created timestamp with time zone,
  last_backup_timestamp timestamp with time zone,
  last_backup_duration_in_seconds number,
  last_failed_backup_timestamp timestamp with time zone,
  db_backup_config dbms_cloud_oci_database_db_backup_config_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  connection_strings dbms_cloud_oci_database_database_connection_strings_t,
  kms_key_id varchar2(32767),
  kms_key_version_id varchar2(32767),
  vault_id varchar2(32767),
  source_database_point_in_time_recovery_timestamp timestamp with time zone,
  database_software_image_id varchar2(32767),
  is_cdb number,
  database_management_config dbms_cloud_oci_database_cloud_database_management_config_t,
  sid_prefix varchar2(32767),
  key_store_id varchar2(32767),
  key_store_wallet_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_t (
    id varchar2,
    compartment_id varchar2,
    character_set varchar2,
    ncharacter_set varchar2,
    db_home_id varchar2,
    db_system_id varchar2,
    vm_cluster_id varchar2,
    db_name varchar2,
    pdb_name varchar2,
    db_workload varchar2,
    db_unique_name varchar2,
    lifecycle_details varchar2,
    lifecycle_state varchar2,
    time_created timestamp with time zone,
    last_backup_timestamp timestamp with time zone,
    last_backup_duration_in_seconds number,
    last_failed_backup_timestamp timestamp with time zone,
    db_backup_config dbms_cloud_oci_database_db_backup_config_t,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    connection_strings dbms_cloud_oci_database_database_connection_strings_t,
    kms_key_id varchar2,
    kms_key_version_id varchar2,
    vault_id varchar2,
    source_database_point_in_time_recovery_timestamp timestamp with time zone,
    database_software_image_id varchar2,
    is_cdb number,
    database_management_config dbms_cloud_oci_database_cloud_database_management_config_t,
    sid_prefix varchar2,
    key_store_id varchar2,
    key_store_wallet_name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the database.

compartment_id

(required) The OCID of the compartment.

character_set

(optional) The character set for the database.

ncharacter_set

(optional) The national character set for the database.

db_home_id

(optional) The OCID of the Database Home.

db_system_id

(optional) The OCID of the DB system.

vm_cluster_id

(optional) The OCID of the VM cluster.

db_name

(required) The database name.

pdb_name

(optional) The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.

db_workload

(optional) **Deprecated.** The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored. The database workload type.

db_unique_name

(required) A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.

lifecycle_details

(optional) Additional information about the current lifecycle state.

lifecycle_state

(required) The current state of the database.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'UPDATING', 'BACKUP_IN_PROGRESS', 'UPGRADING', 'CONVERTING', 'TERMINATING', 'TERMINATED', 'RESTORE_FAILED', 'FAILED'

time_created

(optional) The date and time the database was created.

last_backup_timestamp

(optional) The date and time when the latest database backup was created.

last_backup_duration_in_seconds

(optional) The duration when the latest database backup created.

last_failed_backup_timestamp

(optional) The date and time when the latest database backup failed.

db_backup_config

(optional)

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

connection_strings

(optional) The Connection strings used to connect to the Oracle Database.

kms_key_id

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

kms_key_version_id

(optional) 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.

vault_id

(optional) The OCID of the Oracle Cloud Infrastructure vault.

source_database_point_in_time_recovery_timestamp

(optional) Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339

database_software_image_id

(optional) The database software image OCID

is_cdb

(optional) True if the database is a container database.

database_management_config

(optional)

sid_prefix

(optional) Specifies a prefix for the `Oracle SID` of the database to be created.

key_store_id

(optional) The OCID of the key store.

key_store_wallet_name

(optional) The wallet name for Oracle Key Vault.

DBMS_CLOUD_OCI_DATABASE_DATABASE_CONNECTION_CREDENTAILS_BY_NAME_T Type

Existing named credential used to connect to the database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_database_connection_credentails_by_name_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_database_connection_credentials_t (
  l_credential_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_connection_credentails_by_name_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_connection_credentails_by_name_t (
    credential_type varchar2,
    l_credential_name varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_database_connection_credentails_by_name_t is a subtype of the dbms_cloud_oci_database_database_connection_credentials_t type.

Fields

Field Description

l_credential_name

(required) The name of the credential information that used to connect to the database. The name should be in \"x.y\" format, where the length of \"x\" has a maximum of 64 characters, and length of \"y\" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the \".\" character that separates the \"x\" and \"y\" portions of the name. *IMPORTANT* - The name must be unique within the OCI region the credential is being created in. If you specify a name that duplicates the name of another credential within the same OCI region, you may overwrite or corrupt the credential that is already using the name. For example: inventorydb.abc112233445566778899

DBMS_CLOUD_OCI_DATABASE_DATABASE_CONNECTION_CREDENTIALS_BY_DETAILS_T Type

User information to connect to the database. Required when performing the CREATE_EXTERNAL_DATABASE_CONNECTOR_DETAILS Function operation. *IMPORTANT*: Not supported for the UPDATE_EXTERNAL_DATABASE_CONNECTOR_DETAILS Function operation.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_database_connection_credentials_by_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_database_connection_credentials_t (
  l_credential_name varchar2(32767),
  username varchar2(32767),
  password varchar2(32767),
  role varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_connection_credentials_by_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_connection_credentials_by_details_t (
    credential_type varchar2,
    l_credential_name varchar2,
    username varchar2,
    password varchar2,
    role varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_database_connection_credentials_by_details_t is a subtype of the dbms_cloud_oci_database_database_connection_credentials_t type.

Fields

Field Description

l_credential_name

(optional) The name of the credential information that used to connect to the database. The name should be in \"x.y\" format, where the length of \"x\" has a maximum of 64 characters, and length of \"y\" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the \".\" character that separates the \"x\" and \"y\" portions of the name. *IMPORTANT* - The name must be unique within the OCI region the credential is being created in. If you specify a name that duplicates the name of another credential within the same OCI region, you may overwrite or corrupt the credential that is already using the name. For example: inventorydb.abc112233445566778899

username

(required) The username that will be used to connect to the database.

password

(required) The password that will be used to connect to the database.

role

(required) The role of the user that will be connecting to the database.

Allowed values are: 'SYSDBA', 'NORMAL'

DBMS_CLOUD_OCI_DATABASE_DATABASE_CREDENTIAL_DETAILS_T Type

Data for the credential used to connect to the database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_database_credential_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  user_name varchar2(32767),
  password_secret_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_credential_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_credential_details_t (
    user_name varchar2,
    password_secret_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

user_name

(required) The name of the Oracle Database user that will be used to connect to the database.

password_secret_id

(required) The OCID of the Oracle Cloud Infrastructure secret.

DBMS_CLOUD_OCI_DATABASE_DATABASE_MANAGEMENT_CONFIG_T Type

The configuration of the Database Management service.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_database_management_config_t FORCE AUTHID CURRENT_USER IS OBJECT (
  database_management_status varchar2(32767),
  database_management_connection_id varchar2(32767),
  license_model varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_management_config_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_management_config_t (
    database_management_status varchar2,
    database_management_connection_id varchar2,
    license_model varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

database_management_status

(required) The status of the Database Management service.

Allowed values are: 'ENABLING', 'ENABLED', 'DISABLING', 'NOT_ENABLED', 'FAILED_ENABLING', 'FAILED_DISABLING'

database_management_connection_id

(optional) The OCID of the CREATE_EXTERNAL_DATABASE_CONNECTOR_DETAILS Function.

license_model

(optional) The Oracle license model that applies to the external database.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

DBMS_CLOUD_OCI_DATABASE_DATABASE_SOFTWARE_IMAGE_T Type

Database software images are created by specifying a patch set, one-off patches and patches for the database home (listed by `ls inventory`).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_database_software_image_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  database_version varchar2(32767),
  display_name varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_created timestamp with time zone,
  image_type varchar2(32767),
  image_shape_family varchar2(32767),
  patch_set varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  database_software_image_included_patches dbms_cloud_oci_database_varchar2_tbl,
  included_patches_summary varchar2(32767),
  database_software_image_one_off_patches dbms_cloud_oci_database_varchar2_tbl,
  ls_inventory varchar2(32767),
  is_upgrade_supported number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_software_image_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_software_image_t (
    id varchar2,
    compartment_id varchar2,
    database_version varchar2,
    display_name varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_created timestamp with time zone,
    image_type varchar2,
    image_shape_family varchar2,
    patch_set varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    database_software_image_included_patches dbms_cloud_oci_database_varchar2_tbl,
    included_patches_summary varchar2,
    database_software_image_one_off_patches dbms_cloud_oci_database_varchar2_tbl,
    ls_inventory varchar2,
    is_upgrade_supported number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the database software image.

compartment_id

(required) The OCID of the compartment.

database_version

(required) The database version with which the database software image is to be built.

display_name

(required) The user-friendly name for the database software image. The name does not have to be unique.

lifecycle_state

(required) The current state of the database software image.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'DELETING', 'DELETED', 'FAILED', 'TERMINATING', 'TERMINATED', 'UPDATING'

lifecycle_details

(optional) Detailed message for the lifecycle state.

time_created

(required) The date and time the database software image was created.

image_type

(required) The type of software image. Can be grid or database.

Allowed values are: 'GRID_IMAGE', 'DATABASE_IMAGE'

image_shape_family

(required) To what shape the image is meant for.

Allowed values are: 'VM_BM_SHAPE', 'EXADATA_SHAPE', 'EXACC_SHAPE'

patch_set

(required) The PSU or PBP or Release Updates. To get a list of supported versions, use the LIST_DB_VERSIONS Function operation.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

database_software_image_included_patches

(optional) List of one-off patches for Database Homes.

included_patches_summary

(optional) The patches included in the image and the version of the image.

database_software_image_one_off_patches

(optional) List of one-off patches for Database Homes.

ls_inventory

(optional) The output from the OPatch lsInventory command, which is passed as a string.

is_upgrade_supported

(optional) True if this Database software image is supported for Upgrade.

DBMS_CLOUD_OCI_DATABASE_DATABASE_SOFTWARE_IMAGE_SUMMARY_T Type

The Database service supports the creation of database software images for use in creating and patching DB systems and databases. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies. For information about access control and compartments, see Overview of the Identity Service. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_database_software_image_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  database_version varchar2(32767),
  display_name varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_created timestamp with time zone,
  image_type varchar2(32767),
  image_shape_family varchar2(32767),
  patch_set varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  database_software_image_included_patches dbms_cloud_oci_database_varchar2_tbl,
  included_patches_summary varchar2(32767),
  database_software_image_one_off_patches dbms_cloud_oci_database_varchar2_tbl,
  ls_inventory varchar2(32767),
  is_upgrade_supported number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_software_image_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_software_image_summary_t (
    id varchar2,
    compartment_id varchar2,
    database_version varchar2,
    display_name varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_created timestamp with time zone,
    image_type varchar2,
    image_shape_family varchar2,
    patch_set varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    database_software_image_included_patches dbms_cloud_oci_database_varchar2_tbl,
    included_patches_summary varchar2,
    database_software_image_one_off_patches dbms_cloud_oci_database_varchar2_tbl,
    ls_inventory varchar2,
    is_upgrade_supported number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the database software image.

compartment_id

(required) The OCID of the compartment.

database_version

(required) The database version with which the database software image is to be built.

display_name

(required) The user-friendly name for the database software image. The name does not have to be unique.

lifecycle_state

(required) The current state of the database software image.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'DELETING', 'DELETED', 'FAILED', 'TERMINATING', 'TERMINATED', 'UPDATING'

lifecycle_details

(optional) Detailed message for the lifecycle state.

time_created

(required) The date and time the database software image was created.

image_type

(required) The type of software image. Can be grid or database.

Allowed values are: 'GRID_IMAGE', 'DATABASE_IMAGE'

image_shape_family

(required) To what shape the image is meant for.

Allowed values are: 'VM_BM_SHAPE', 'EXADATA_SHAPE', 'EXACC_SHAPE'

patch_set

(required) The PSU or PBP or Release Updates. To get a list of supported versions, use the LIST_DB_VERSIONS Function operation.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

database_software_image_included_patches

(optional) List of one-off patches for Database Homes.

included_patches_summary

(optional) The patches included in the image and the version of the image.

database_software_image_one_off_patches

(optional) List of one-off patches for Database Homes.

ls_inventory

(optional) The output from the OPatch lsInventory command, which is passed as a string.

is_upgrade_supported

(optional) True if this Database software image is supported for Upgrade.

DBMS_CLOUD_OCI_DATABASE_DATABASE_SSL_CONNECTION_CREDENTIALS_T Type

Ssl connection credential details used to connect to the database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_database_ssl_connection_credentials_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_database_connection_credentials_t (
  l_credential_name varchar2(32767),
  username varchar2(32767),
  password varchar2(32767),
  role varchar2(32767),
  ssl_secret_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_ssl_connection_credentials_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_ssl_connection_credentials_t (
    credential_type varchar2,
    l_credential_name varchar2,
    username varchar2,
    password varchar2,
    role varchar2,
    ssl_secret_id varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_database_ssl_connection_credentials_t is a subtype of the dbms_cloud_oci_database_database_connection_credentials_t type.

Fields

Field Description

l_credential_name

(optional) The name of the credential information that used to connect to the database. The name should be in \"x.y\" format, where the length of \"x\" has a maximum of 64 characters, and length of \"y\" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the \".\" character that separates the \"x\" and \"y\" portions of the name. *IMPORTANT* - The name must be unique within the OCI region the credential is being created in. If you specify a name that duplicates the name of another credential within the same OCI region, you may overwrite or corrupt the credential that is already using the name. For example: inventorydb.abc112233445566778899

username

(required) The username that will be used to connect to the database.

password

(required) The password that will be used to connect to the database.

role

(required) The role of the user that will be connecting to the database.

Allowed values are: 'SYSDBA', 'NORMAL'

ssl_secret_id

(required) The OCID of the Oracle Cloud Infrastructure secret.

DBMS_CLOUD_OCI_DATABASE_DATABASE_SUMMARY_T Type

An Oracle Database on a bare metal or virtual machine DB system. For more information, see Bare Metal and Virtual Machine DB Systems. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_database_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  character_set varchar2(32767),
  ncharacter_set varchar2(32767),
  db_home_id varchar2(32767),
  db_system_id varchar2(32767),
  vm_cluster_id varchar2(32767),
  db_name varchar2(32767),
  pdb_name varchar2(32767),
  db_workload varchar2(32767),
  db_unique_name varchar2(32767),
  lifecycle_details varchar2(32767),
  lifecycle_state varchar2(32767),
  time_created timestamp with time zone,
  last_backup_timestamp timestamp with time zone,
  last_backup_duration_in_seconds number,
  last_failed_backup_timestamp timestamp with time zone,
  db_backup_config dbms_cloud_oci_database_db_backup_config_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  connection_strings dbms_cloud_oci_database_database_connection_strings_t,
  kms_key_id varchar2(32767),
  kms_key_version_id varchar2(32767),
  vault_id varchar2(32767),
  source_database_point_in_time_recovery_timestamp timestamp with time zone,
  database_software_image_id varchar2(32767),
  is_cdb number,
  database_management_config dbms_cloud_oci_database_cloud_database_management_config_t,
  sid_prefix varchar2(32767),
  key_store_id varchar2(32767),
  key_store_wallet_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_summary_t (
    id varchar2,
    compartment_id varchar2,
    character_set varchar2,
    ncharacter_set varchar2,
    db_home_id varchar2,
    db_system_id varchar2,
    vm_cluster_id varchar2,
    db_name varchar2,
    pdb_name varchar2,
    db_workload varchar2,
    db_unique_name varchar2,
    lifecycle_details varchar2,
    lifecycle_state varchar2,
    time_created timestamp with time zone,
    last_backup_timestamp timestamp with time zone,
    last_backup_duration_in_seconds number,
    last_failed_backup_timestamp timestamp with time zone,
    db_backup_config dbms_cloud_oci_database_db_backup_config_t,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    connection_strings dbms_cloud_oci_database_database_connection_strings_t,
    kms_key_id varchar2,
    kms_key_version_id varchar2,
    vault_id varchar2,
    source_database_point_in_time_recovery_timestamp timestamp with time zone,
    database_software_image_id varchar2,
    is_cdb number,
    database_management_config dbms_cloud_oci_database_cloud_database_management_config_t,
    sid_prefix varchar2,
    key_store_id varchar2,
    key_store_wallet_name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the database.

compartment_id

(required) The OCID of the compartment.

character_set

(optional) The character set for the database.

ncharacter_set

(optional) The national character set for the database.

db_home_id

(optional) The OCID of the Database Home.

db_system_id

(optional) The OCID of the DB system.

vm_cluster_id

(optional) The OCID of the VM cluster.

db_name

(required) The database name.

pdb_name

(optional) The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.

db_workload

(optional) **Deprecated.** The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored. The database workload type.

db_unique_name

(required) A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.

lifecycle_details

(optional) Additional information about the current lifecycle state.

lifecycle_state

(required) The current state of the database.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'UPDATING', 'BACKUP_IN_PROGRESS', 'UPGRADING', 'CONVERTING', 'TERMINATING', 'TERMINATED', 'RESTORE_FAILED', 'FAILED'

time_created

(optional) The date and time the database was created.

last_backup_timestamp

(optional) The date and time when the latest database backup was created.

last_backup_duration_in_seconds

(optional) The duration when the latest database backup created.

last_failed_backup_timestamp

(optional) The date and time when the latest database backup failed.

db_backup_config

(optional)

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

connection_strings

(optional) The Connection strings used to connect to the Oracle Database.

kms_key_id

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

kms_key_version_id

(optional) 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.

vault_id

(optional) The OCID of the Oracle Cloud Infrastructure vault.

source_database_point_in_time_recovery_timestamp

(optional) Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339

database_software_image_id

(optional) The database software image OCID

is_cdb

(optional) True if the database is a container database.

database_management_config

(optional)

sid_prefix

(optional) Specifies a prefix for the `Oracle SID` of the database to be created.

key_store_id

(optional) The OCID of the key store.

key_store_wallet_name

(optional) The wallet name for Oracle Key Vault.

DBMS_CLOUD_OCI_DATABASE_DATABASE_UPGRADE_HISTORY_ENTRY_T Type

The Database service supports the upgrade history of databases. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies. For information about access control and compartments, see Overview of the Identity Service. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_database_upgrade_history_entry_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  action varchar2(32767),
  source varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  target_db_version varchar2(32767),
  target_database_software_image_id varchar2(32767),
  target_db_home_id varchar2(32767),
  source_db_home_id varchar2(32767),
  time_started timestamp with time zone,
  time_ended timestamp with time zone,
  options varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_upgrade_history_entry_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_upgrade_history_entry_t (
    id varchar2,
    action varchar2,
    source varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    target_db_version varchar2,
    target_database_software_image_id varchar2,
    target_db_home_id varchar2,
    source_db_home_id varchar2,
    time_started timestamp with time zone,
    time_ended timestamp with time zone,
    options varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the database upgrade history.

action

(required) The database upgrade action.

Allowed values are: 'PRECHECK', 'UPGRADE', 'ROLLBACK'

source

(optional) The source of the Oracle Database software to be used for the upgrade. - Use `DB_HOME` to specify an existing Database Home to upgrade the database. The database is moved to the target Database Home and makes use of the Oracle Database software version of the target Database Home. - Use `DB_VERSION` to specify a generally-available Oracle Database software version to upgrade the database. - Use `DB_SOFTWARE_IMAGE` to specify a database software image to upgrade the database.

Allowed values are: 'DB_HOME', 'DB_VERSION', 'DB_SOFTWARE_IMAGE'

lifecycle_state

(required) Status of database upgrade history SUCCEEDED|IN_PROGRESS|FAILED.

Allowed values are: 'SUCCEEDED', 'FAILED', 'IN_PROGRESS'

lifecycle_details

(optional) Additional information about the current lifecycle state.

target_db_version

(optional) A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

target_database_software_image_id

(optional) the database software image used for upgrading database.

target_db_home_id

(optional) The OCID of the Database Home.

source_db_home_id

(optional) The OCID of the Database Home.

time_started

(required) The date and time when the database upgrade started.

time_ended

(optional) The date and time when the database upgrade ended.

options

(optional) Additional upgrade options supported by DBUA(Database Upgrade Assistant). Example: \"-upgradeTimezone false -keepEvents\"

DBMS_CLOUD_OCI_DATABASE_DATABASE_UPGRADE_HISTORY_ENTRY_SUMMARY_T Type

The Database service supports the upgrade history of databases. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies. For information about access control and compartments, see Overview of the Identity Service. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_database_upgrade_history_entry_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  action varchar2(32767),
  source varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  target_db_version varchar2(32767),
  target_database_software_image_id varchar2(32767),
  target_db_home_id varchar2(32767),
  source_db_home_id varchar2(32767),
  time_started timestamp with time zone,
  time_ended timestamp with time zone,
  options varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_upgrade_history_entry_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_upgrade_history_entry_summary_t (
    id varchar2,
    action varchar2,
    source varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    target_db_version varchar2,
    target_database_software_image_id varchar2,
    target_db_home_id varchar2,
    source_db_home_id varchar2,
    time_started timestamp with time zone,
    time_ended timestamp with time zone,
    options varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the database upgrade history.

action

(required) The database upgrade action.

Allowed values are: 'PRECHECK', 'UPGRADE', 'ROLLBACK'

source

(optional) The source of the Oracle Database software to be used for the upgrade. - Use `DB_HOME` to specify an existing Database Home to upgrade the database. The database is moved to the target Database Home and makes use of the Oracle Database software version of the target Database Home. - Use `DB_VERSION` to specify a generally-available Oracle Database software version to upgrade the database. - Use `DB_SOFTWARE_IMAGE` to specify a database software image to upgrade the database.

Allowed values are: 'DB_HOME', 'DB_VERSION', 'DB_SOFTWARE_IMAGE'

lifecycle_state

(required) Status of database upgrade history SUCCEEDED|IN_PROGRESS|FAILED.

Allowed values are: 'SUCCEEDED', 'FAILED', 'IN_PROGRESS'

lifecycle_details

(optional) Additional information about the current lifecycle state.

target_db_version

(optional) A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

target_database_software_image_id

(optional) the database software image used for upgrading database.

target_db_home_id

(optional) The OCID of the Database Home.

source_db_home_id

(optional) The OCID of the Database Home.

time_started

(required) The date and time when the database upgrade started.

time_ended

(optional) The date and time when the database upgrade ended.

options

(optional) Additional upgrade options supported by DBUA(Database Upgrade Assistant). Example: \"-upgradeTimezone false -keepEvents\"

DBMS_CLOUD_OCI_DATABASE_DATABASE_UPGRADE_SOURCE_BASE_T Type

Details for the database upgrade source.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_database_upgrade_source_base_t FORCE AUTHID CURRENT_USER IS OBJECT (
  source varchar2(32767),
  options varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_upgrade_source_base_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_upgrade_source_base_t (
    source varchar2,
    options varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

source

(optional) The source of the Oracle Database software to be used for the upgrade. - Use `DB_HOME` to specify an existing Database Home to upgrade the database. The database is moved to the target Database Home and makes use of the Oracle Database software version of the target Database Home. - Use `DB_VERSION` to specify a generally-available Oracle Database software version to upgrade the database. - Use `DB_SOFTWARE_IMAGE` to specify a database software image to upgrade the database.

Allowed values are: 'DB_HOME', 'DB_VERSION', 'DB_SOFTWARE_IMAGE'

options

(optional) Additional upgrade options supported by DBUA(Database Upgrade Assistant). Example: \"-upgradeTimezone false -keepEvents\"

DBMS_CLOUD_OCI_DATABASE_DATABASE_UPGRADE_WITH_DATABASE_SOFTWARE_IMAGE_DETAILS_T Type

Details of the database software image to be used to upgrade a database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_database_upgrade_with_database_software_image_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_database_upgrade_source_base_t (
  database_software_image_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_upgrade_with_database_software_image_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_upgrade_with_database_software_image_details_t (
    source varchar2,
    options varchar2,
    database_software_image_id varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_database_upgrade_with_database_software_image_details_t is a subtype of the dbms_cloud_oci_database_database_upgrade_source_base_t type.

Fields

Field Description

database_software_image_id

(required) The database software image OCID of the image to be used to upgrade a database.

DBMS_CLOUD_OCI_DATABASE_DATABASE_UPGRADE_WITH_DB_HOME_DETAILS_T Type

Details of Database Home to be used to upgrade a database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_database_upgrade_with_db_home_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_database_upgrade_source_base_t (
  db_home_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_upgrade_with_db_home_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_upgrade_with_db_home_details_t (
    source varchar2,
    options varchar2,
    db_home_id varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_database_upgrade_with_db_home_details_t is a subtype of the dbms_cloud_oci_database_database_upgrade_source_base_t type.

Fields

Field Description

db_home_id

(required) The OCID of the Database Home.

DBMS_CLOUD_OCI_DATABASE_DATABASE_UPGRADE_WITH_DB_VERSION_DETAILS_T Type

Details of the Oracle Database software version number for upgrading a database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_database_upgrade_with_db_version_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_database_upgrade_source_base_t (
  db_version varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_upgrade_with_db_version_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_database_upgrade_with_db_version_details_t (
    source varchar2,
    options varchar2,
    db_version varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_database_upgrade_with_db_version_details_t is a subtype of the dbms_cloud_oci_database_database_upgrade_source_base_t type.

Fields

Field Description

db_version

(required) A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

DBMS_CLOUD_OCI_DATABASE_DB_HOME_T Type

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_db_home_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  last_patch_history_entry_id varchar2(32767),
  lifecycle_state varchar2(32767),
  db_system_id varchar2(32767),
  vm_cluster_id varchar2(32767),
  db_version varchar2(32767),
  db_home_location varchar2(32767),
  lifecycle_details varchar2(32767),
  time_created timestamp with time zone,
  kms_key_id varchar2(32767),
  one_off_patches dbms_cloud_oci_database_varchar2_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  database_software_image_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_home_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_home_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    last_patch_history_entry_id varchar2,
    lifecycle_state varchar2,
    db_system_id varchar2,
    vm_cluster_id varchar2,
    db_version varchar2,
    db_home_location varchar2,
    lifecycle_details varchar2,
    time_created timestamp with time zone,
    kms_key_id varchar2,
    one_off_patches dbms_cloud_oci_database_varchar2_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    database_software_image_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Database Home.

compartment_id

(required) The OCID of the compartment.

display_name

(required) The user-provided name for the Database Home. The name does not need to be unique.

last_patch_history_entry_id

(optional) The OCID of the last patch history. This value is updated as soon as a patch operation is started.

lifecycle_state

(required) The current state of the Database Home.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED'

db_system_id

(optional) The OCID of the DB system.

vm_cluster_id

(optional) The OCID of the VM cluster.

db_version

(required) The Oracle Database version.

db_home_location

(required) The location of the Oracle Database Home.

lifecycle_details

(optional) Additional information about the current lifecycle state.

time_created

(optional) The date and time the Database Home was created.

kms_key_id

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

one_off_patches

(optional) List of one-off patches for Database Homes.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

database_software_image_id

(optional) The database software image OCID

DBMS_CLOUD_OCI_DATABASE_DB_HOME_FROM_AGENT_RESOURCE_ID_T Type

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_db_home_from_agent_resource_id_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  last_patch_history_entry_id varchar2(32767),
  lifecycle_state varchar2(32767),
  db_system_id varchar2(32767),
  vm_cluster_id varchar2(32767),
  db_version varchar2(32767),
  db_home_location varchar2(32767),
  lifecycle_details varchar2(32767),
  time_created timestamp with time zone,
  kms_key_id varchar2(32767),
  one_off_patches dbms_cloud_oci_database_varchar2_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  database_software_image_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_home_from_agent_resource_id_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_home_from_agent_resource_id_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    last_patch_history_entry_id varchar2,
    lifecycle_state varchar2,
    db_system_id varchar2,
    vm_cluster_id varchar2,
    db_version varchar2,
    db_home_location varchar2,
    lifecycle_details varchar2,
    time_created timestamp with time zone,
    kms_key_id varchar2,
    one_off_patches dbms_cloud_oci_database_varchar2_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    database_software_image_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Database Home.

compartment_id

(required) The OCID of the compartment.

display_name

(required) The user-provided name for the Database Home. The name does not need to be unique.

last_patch_history_entry_id

(optional) The OCID of the last patch history. This value is updated as soon as a patch operation is started.

lifecycle_state

(required) The current state of the Database Home.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED'

db_system_id

(optional) The OCID of the DB system.

vm_cluster_id

(optional) The OCID of the VM cluster.

db_version

(required) The Oracle Database version.

db_home_location

(required) The location of the Oracle Database Home.

lifecycle_details

(optional) Additional information about the current lifecycle state.

time_created

(optional) The date and time the Database Home was created.

kms_key_id

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

one_off_patches

(optional) List of one-off patches for Database Homes.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

database_software_image_id

(optional) The database software image OCID

DBMS_CLOUD_OCI_DATABASE_DB_HOME_SUMMARY_T Type

A directory where Oracle Database software is installed. A bare metal or Exadata DB system can have multiple Database Homes and each Database Home can run a different supported version of Oracle Database. A virtual machine DB system can have only one Database Home. For more information, see Bare Metal and Virtual Machine DB Systems and Exadata DB Systems. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_db_home_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  last_patch_history_entry_id varchar2(32767),
  lifecycle_state varchar2(32767),
  db_system_id varchar2(32767),
  vm_cluster_id varchar2(32767),
  db_version varchar2(32767),
  db_home_location varchar2(32767),
  lifecycle_details varchar2(32767),
  time_created timestamp with time zone,
  kms_key_id varchar2(32767),
  one_off_patches dbms_cloud_oci_database_varchar2_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  database_software_image_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_home_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_home_summary_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    last_patch_history_entry_id varchar2,
    lifecycle_state varchar2,
    db_system_id varchar2,
    vm_cluster_id varchar2,
    db_version varchar2,
    db_home_location varchar2,
    lifecycle_details varchar2,
    time_created timestamp with time zone,
    kms_key_id varchar2,
    one_off_patches dbms_cloud_oci_database_varchar2_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    database_software_image_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Database Home.

compartment_id

(required) The OCID of the compartment.

display_name

(required) The user-provided name for the Database Home. The name does not need to be unique.

last_patch_history_entry_id

(optional) The OCID of the last patch history. This value is updated as soon as a patch operation is started.

lifecycle_state

(required) The current state of the Database Home.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED'

db_system_id

(optional) The OCID of the DB system.

vm_cluster_id

(optional) The OCID of the VM cluster.

db_version

(required) The Oracle Database version.

db_home_location

(required) The location of the Oracle Database Home.

lifecycle_details

(optional) Additional information about the current lifecycle state.

time_created

(optional) The date and time the Database Home was created.

kms_key_id

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

one_off_patches

(optional) List of one-off patches for Database Homes.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

database_software_image_id

(optional) The database software image OCID

DBMS_CLOUD_OCI_DATABASE_DB_NODE_T Type

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_db_node_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  db_system_id varchar2(32767),
  vnic_id varchar2(32767),
  backup_vnic_id varchar2(32767),
  host_ip_id varchar2(32767),
  backup_ip_id varchar2(32767),
  vnic2_id varchar2(32767),
  backup_vnic2_id varchar2(32767),
  lifecycle_state varchar2(32767),
  hostname varchar2(32767),
  fault_domain varchar2(32767),
  time_created timestamp with time zone,
  software_storage_size_in_gb number,
  maintenance_type varchar2(32767),
  time_maintenance_window_start timestamp with time zone,
  time_maintenance_window_end timestamp with time zone,
  additional_details varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  lifecycle_details varchar2(32767),
  cpu_core_count number,
  memory_size_in_g_bs number,
  db_node_storage_size_in_g_bs number,
  db_server_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_node_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_node_t (
    id varchar2,
    db_system_id varchar2,
    vnic_id varchar2,
    backup_vnic_id varchar2,
    host_ip_id varchar2,
    backup_ip_id varchar2,
    vnic2_id varchar2,
    backup_vnic2_id varchar2,
    lifecycle_state varchar2,
    hostname varchar2,
    fault_domain varchar2,
    time_created timestamp with time zone,
    software_storage_size_in_gb number,
    maintenance_type varchar2,
    time_maintenance_window_start timestamp with time zone,
    time_maintenance_window_end timestamp with time zone,
    additional_details varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    lifecycle_details varchar2,
    cpu_core_count number,
    memory_size_in_g_bs number,
    db_node_storage_size_in_g_bs number,
    db_server_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the database node.

db_system_id

(required) The OCID of the DB system.

vnic_id

(required) The OCID of the VNIC.

backup_vnic_id

(optional) The OCID of the backup VNIC.

host_ip_id

(optional) The OCID of the host IP address associated with the database node. Use this OCID with either the GET_PRIVATE_IP Function or the GET_PUBLIC_IP_BY_PRIVATE_IP_ID Function API to get the IP address needed to make a database connection. **Note:** Applies only to Exadata Cloud Service.

backup_ip_id

(optional) The OCID of the backup IP address associated with the database node. Use this OCID with either the GET_PRIVATE_IP Function or the GET_PUBLIC_IP_BY_PRIVATE_IP_ID Function API to get the IP address needed to make a database connection. **Note:** Applies only to Exadata Cloud Service.

vnic2_id

(optional) The OCID of the second VNIC. **Note:** Applies only to Exadata Cloud Service.

backup_vnic2_id

(optional) The OCID of the second backup VNIC. **Note:** Applies only to Exadata Cloud Service.

lifecycle_state

(required) The current state of the database node.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'UPDATING', 'STOPPING', 'STOPPED', 'STARTING', 'TERMINATING', 'TERMINATED', 'FAILED'

hostname

(optional) The host name for the database node.

fault_domain

(optional) The name of the Fault Domain the instance is contained in.

time_created

(required) The date and time that the database node was created.

software_storage_size_in_gb

(optional) The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems.

maintenance_type

(optional) The type of database node maintenance.

Allowed values are: 'VMDB_REBOOT_MIGRATION'

time_maintenance_window_start

(optional) Start date and time of maintenance window.

time_maintenance_window_end

(optional) End date and time of maintenance window.

additional_details

(optional) Additional information about the planned maintenance.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

lifecycle_details

(optional) Information about the current lifecycle state.

cpu_core_count

(optional) The number of CPU cores enabled on the Db node.

memory_size_in_g_bs

(optional) The allocated memory in GBs on the Db node.

db_node_storage_size_in_g_bs

(optional) The allocated local node storage in GBs on the Db node.

db_server_id

(optional) The OCID of the Exacc Db server associated with the database node.

DBMS_CLOUD_OCI_DATABASE_DB_NODE_SUMMARY_T Type

A server where Oracle Database software is running. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_db_node_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  db_system_id varchar2(32767),
  vnic_id varchar2(32767),
  backup_vnic_id varchar2(32767),
  host_ip_id varchar2(32767),
  backup_ip_id varchar2(32767),
  vnic2_id varchar2(32767),
  backup_vnic2_id varchar2(32767),
  lifecycle_state varchar2(32767),
  hostname varchar2(32767),
  fault_domain varchar2(32767),
  time_created timestamp with time zone,
  software_storage_size_in_gb number,
  maintenance_type varchar2(32767),
  time_maintenance_window_start timestamp with time zone,
  time_maintenance_window_end timestamp with time zone,
  additional_details varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  lifecycle_details varchar2(32767),
  cpu_core_count number,
  memory_size_in_g_bs number,
  db_node_storage_size_in_g_bs number,
  db_server_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_node_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_node_summary_t (
    id varchar2,
    db_system_id varchar2,
    vnic_id varchar2,
    backup_vnic_id varchar2,
    host_ip_id varchar2,
    backup_ip_id varchar2,
    vnic2_id varchar2,
    backup_vnic2_id varchar2,
    lifecycle_state varchar2,
    hostname varchar2,
    fault_domain varchar2,
    time_created timestamp with time zone,
    software_storage_size_in_gb number,
    maintenance_type varchar2,
    time_maintenance_window_start timestamp with time zone,
    time_maintenance_window_end timestamp with time zone,
    additional_details varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    lifecycle_details varchar2,
    cpu_core_count number,
    memory_size_in_g_bs number,
    db_node_storage_size_in_g_bs number,
    db_server_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the database node.

db_system_id

(required) The OCID of the DB system.

vnic_id

(required) The OCID of the VNIC.

backup_vnic_id

(optional) The OCID of the backup VNIC.

host_ip_id

(optional) The OCID of the host IP address associated with the database node. Use this OCID with either the GET_PRIVATE_IP Function or the GET_PUBLIC_IP_BY_PRIVATE_IP_ID Function API to get the IP address needed to make a database connection. **Note:** Applies only to Exadata Cloud Service.

backup_ip_id

(optional) The OCID of the backup IP address associated with the database node. Use this OCID with either the GET_PRIVATE_IP Function or the GET_PUBLIC_IP_BY_PRIVATE_IP_ID Function API to get the IP address needed to make a database connection. **Note:** Applies only to Exadata Cloud Service.

vnic2_id

(optional) The OCID of the second VNIC. **Note:** Applies only to Exadata Cloud Service.

backup_vnic2_id

(optional) The OCID of the second backup VNIC. **Note:** Applies only to Exadata Cloud Service.

lifecycle_state

(required) The current state of the database node.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'UPDATING', 'STOPPING', 'STOPPED', 'STARTING', 'TERMINATING', 'TERMINATED', 'FAILED'

hostname

(optional) The host name for the database node.

fault_domain

(optional) The name of the Fault Domain the instance is contained in.

time_created

(required) The date and time that the database node was created.

software_storage_size_in_gb

(optional) The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems.

maintenance_type

(optional) The type of database node maintenance.

Allowed values are: 'VMDB_REBOOT_MIGRATION'

time_maintenance_window_start

(optional) Start date and time of maintenance window.

time_maintenance_window_end

(optional) End date and time of maintenance window.

additional_details

(optional) Additional information about the planned maintenance.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

lifecycle_details

(optional) Information about the current lifecycle state.

cpu_core_count

(optional) The number of CPU cores enabled on the Db node.

memory_size_in_g_bs

(optional) The allocated memory in GBs on the Db node.

db_node_storage_size_in_g_bs

(optional) The allocated local node storage in GBs on the Db node.

db_server_id

(optional) The OCID of the Exacc Db server associated with the database node.

DBMS_CLOUD_OCI_DATABASE_DB_SERVER_PATCHING_DETAILS_T Type

The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_db_server_patching_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  estimated_patch_duration number,
  patching_status varchar2(32767),
  time_patching_started timestamp with time zone,
  time_patching_ended timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_server_patching_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_server_patching_details_t (
    estimated_patch_duration number,
    patching_status varchar2,
    time_patching_started timestamp with time zone,
    time_patching_ended timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

estimated_patch_duration

(optional) Estimated time, in minutes, to patch one database server.

patching_status

(optional) The status of the patching operation.

Allowed values are: 'SCHEDULED', 'MAINTENANCE_IN_PROGRESS', 'FAILED', 'COMPLETE'

time_patching_started

(optional) The time when the patching operation started.

time_patching_ended

(optional) The time when the patching operation ended.

DBMS_CLOUD_OCI_DATABASE_DB_SERVER_T Type

Details of the Exacc Db server resource. Applies to Exadata Cloud@Customer instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_db_server_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  exadata_infrastructure_id varchar2(32767),
  cpu_core_count number,
  memory_size_in_g_bs number,
  db_node_storage_size_in_g_bs number,
  vm_cluster_ids dbms_cloud_oci_database_varchar2_tbl,
  autonomous_vm_cluster_ids dbms_cloud_oci_database_varchar2_tbl,
  autonomous_virtual_machine_ids dbms_cloud_oci_database_varchar2_tbl,
  db_node_ids dbms_cloud_oci_database_varchar2_tbl,
  shape varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  max_cpu_count number,
  max_memory_in_g_bs number,
  max_db_node_storage_in_g_bs number,
  time_created timestamp with time zone,
  db_server_patching_details dbms_cloud_oci_database_db_server_patching_details_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_server_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_server_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    exadata_infrastructure_id varchar2,
    cpu_core_count number,
    memory_size_in_g_bs number,
    db_node_storage_size_in_g_bs number,
    vm_cluster_ids dbms_cloud_oci_database_varchar2_tbl,
    autonomous_vm_cluster_ids dbms_cloud_oci_database_varchar2_tbl,
    autonomous_virtual_machine_ids dbms_cloud_oci_database_varchar2_tbl,
    db_node_ids dbms_cloud_oci_database_varchar2_tbl,
    shape varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    max_cpu_count number,
    max_memory_in_g_bs number,
    max_db_node_storage_in_g_bs number,
    time_created timestamp with time zone,
    db_server_patching_details dbms_cloud_oci_database_db_server_patching_details_t,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) The OCID of the Exacc Db server.

display_name

(optional) The user-friendly name for the Db server. The name does not need to be unique.

compartment_id

(optional) The OCID of the compartment.

exadata_infrastructure_id

(optional) The OCID of the Exadata infrastructure.

cpu_core_count

(optional) The number of CPU cores enabled on the Db server.

memory_size_in_g_bs

(optional) The allocated memory in GBs on the Db server.

db_node_storage_size_in_g_bs

(optional) The allocated local node storage in GBs on the Db server.

vm_cluster_ids

(optional) The OCID of the VM Clusters associated with the Db server.

autonomous_vm_cluster_ids

(optional) The list of OCIDs of the Autonomous VM Clusters associated with the Db server.

autonomous_virtual_machine_ids

(optional) The list of OCIDs of the Autonomous Virtual Machines associated with the Db server.

db_node_ids

(optional) The OCID of the Db nodes associated with the Db server.

shape

(optional) The shape of the Db server. The shape determines the amount of CPU, storage, and memory resources available.

lifecycle_state

(optional) The current state of the Db server.

Allowed values are: 'CREATING', 'AVAILABLE', 'UNAVAILABLE', 'DELETING', 'DELETED', 'MAINTENANCE_IN_PROGRESS'

lifecycle_details

(optional) Additional information about the current lifecycle state.

max_cpu_count

(optional) The total number of CPU cores available.

max_memory_in_g_bs

(optional) The total memory available in GBs.

max_db_node_storage_in_g_bs

(optional) The total local node storage available in GBs.

time_created

(optional) The date and time that the Db Server was created.

db_server_patching_details

(optional)

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_DB_SERVER_HISTORY_SUMMARY_T Type

Details of a database server maintenance history.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_db_server_history_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  db_server_patching_details dbms_cloud_oci_database_db_server_patching_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_server_history_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_server_history_summary_t (
    id varchar2,
    display_name varchar2,
    db_server_patching_details dbms_cloud_oci_database_db_server_patching_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the database server.

display_name

(optional) The user-friendly name for the database server. The name does not need to be unique.

db_server_patching_details

(optional)

DBMS_CLOUD_OCI_DATABASE_DB_SERVER_SUMMARY_T Type

Details of the Exadata Cloud@Customer Db server.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_db_server_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  exadata_infrastructure_id varchar2(32767),
  cpu_core_count number,
  memory_size_in_g_bs number,
  db_node_storage_size_in_g_bs number,
  vm_cluster_ids dbms_cloud_oci_database_varchar2_tbl,
  autonomous_vm_cluster_ids dbms_cloud_oci_database_varchar2_tbl,
  autonomous_virtual_machine_ids dbms_cloud_oci_database_varchar2_tbl,
  db_node_ids dbms_cloud_oci_database_varchar2_tbl,
  shape varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  max_cpu_count number,
  max_memory_in_g_bs number,
  max_db_node_storage_in_g_bs number,
  time_created timestamp with time zone,
  db_server_patching_details dbms_cloud_oci_database_db_server_patching_details_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_server_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_server_summary_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    exadata_infrastructure_id varchar2,
    cpu_core_count number,
    memory_size_in_g_bs number,
    db_node_storage_size_in_g_bs number,
    vm_cluster_ids dbms_cloud_oci_database_varchar2_tbl,
    autonomous_vm_cluster_ids dbms_cloud_oci_database_varchar2_tbl,
    autonomous_virtual_machine_ids dbms_cloud_oci_database_varchar2_tbl,
    db_node_ids dbms_cloud_oci_database_varchar2_tbl,
    shape varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    max_cpu_count number,
    max_memory_in_g_bs number,
    max_db_node_storage_in_g_bs number,
    time_created timestamp with time zone,
    db_server_patching_details dbms_cloud_oci_database_db_server_patching_details_t,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) The OCID of the Exacc Db server.

display_name

(optional) The user-friendly name for the Db server. The name does not need to be unique.

compartment_id

(optional) The OCID of the compartment.

exadata_infrastructure_id

(optional) The OCID of the Exadata infrastructure.

cpu_core_count

(optional) The number of CPU cores enabled on the Db server.

memory_size_in_g_bs

(optional) The allocated memory in GBs on the Db server.

db_node_storage_size_in_g_bs

(optional) The allocated local node storage in GBs on the Db server.

vm_cluster_ids

(optional) The OCID of the VM Clusters associated with the Db server.

autonomous_vm_cluster_ids

(optional) The list of OCIDs of the Autonomous VM Clusters associated with the Db server.

autonomous_virtual_machine_ids

(optional) The list of OCIDs of the Autonomous Virtual Machines associated with the Db server.

db_node_ids

(optional) The OCID of the Db nodes associated with the Db server.

shape

(optional) The shape of the Db server. The shape determines the amount of CPU, storage, and memory resources available.

lifecycle_state

(optional) The current state of the Db server.

Allowed values are: 'CREATING', 'AVAILABLE', 'UNAVAILABLE', 'DELETING', 'DELETED', 'MAINTENANCE_IN_PROGRESS'

lifecycle_details

(optional) Additional information about the current lifecycle state.

max_cpu_count

(optional) The total number of CPU cores available.

max_memory_in_g_bs

(optional) The total memory available in GBs.

max_db_node_storage_in_g_bs

(optional) The total local node storage available in GBs.

time_created

(optional) The date and time that the Db Server was created.

db_server_patching_details

(optional)

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_DB_SYSTEM_OPTIONS_T Type

The DB system options.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_db_system_options_t FORCE AUTHID CURRENT_USER IS OBJECT (
  storage_management varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_system_options_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_system_options_t (
    storage_management varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

storage_management

(optional) The storage option used in DB system. ASM - Automatic storage management LVM - Logical Volume management

Allowed values are: 'ASM', 'LVM'

DBMS_CLOUD_OCI_DATABASE_DB_SYSTEM_T Type

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_db_system_t FORCE AUTHID CURRENT_USER IS OBJECT (
  iorm_config_cache dbms_cloud_oci_database_exadata_iorm_config_t,
  id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  availability_domain varchar2(32767),
  fault_domains dbms_cloud_oci_database_varchar2_tbl,
  subnet_id varchar2(32767),
  backup_subnet_id varchar2(32767),
  nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  backup_network_nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  memory_size_in_g_bs number,
  storage_volume_performance_mode varchar2(32767),
  shape varchar2(32767),
  db_system_options dbms_cloud_oci_database_db_system_options_t,
  ssh_public_keys dbms_cloud_oci_database_varchar2_tbl,
  time_zone varchar2(32767),
  hostname varchar2(32767),
  domain varchar2(32767),
  kms_key_id varchar2(32767),
  version varchar2(32767),
  os_version varchar2(32767),
  cpu_core_count number,
  cluster_name varchar2(32767),
  data_storage_percentage number,
  database_edition varchar2(32767),
  last_patch_history_entry_id varchar2(32767),
  listener_port number,
  lifecycle_state varchar2(32767),
  time_created timestamp with time zone,
  lifecycle_details varchar2(32767),
  disk_redundancy varchar2(32767),
  sparse_diskgroup number,
  scan_ip_ids dbms_cloud_oci_database_varchar2_tbl,
  vip_ids dbms_cloud_oci_database_varchar2_tbl,
  scan_dns_record_id varchar2(32767),
  scan_dns_name varchar2(32767),
  zone_id varchar2(32767),
  data_storage_size_in_g_bs number,
  reco_storage_size_in_gb number,
  node_count number,
  license_model varchar2(32767),
  maintenance_window dbms_cloud_oci_database_maintenance_window_t,
  last_maintenance_run_id varchar2(32767),
  next_maintenance_run_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  source_db_system_id varchar2(32767),
  point_in_time_data_disk_clone_timestamp timestamp with time zone,
  data_collection_options dbms_cloud_oci_database_data_collection_options_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_system_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_system_t (
    iorm_config_cache dbms_cloud_oci_database_exadata_iorm_config_t,
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    availability_domain varchar2,
    fault_domains dbms_cloud_oci_database_varchar2_tbl,
    subnet_id varchar2,
    backup_subnet_id varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    backup_network_nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    memory_size_in_g_bs number,
    storage_volume_performance_mode varchar2,
    shape varchar2,
    db_system_options dbms_cloud_oci_database_db_system_options_t,
    ssh_public_keys dbms_cloud_oci_database_varchar2_tbl,
    time_zone varchar2,
    hostname varchar2,
    domain varchar2,
    kms_key_id varchar2,
    version varchar2,
    os_version varchar2,
    cpu_core_count number,
    cluster_name varchar2,
    data_storage_percentage number,
    database_edition varchar2,
    last_patch_history_entry_id varchar2,
    listener_port number,
    lifecycle_state varchar2,
    time_created timestamp with time zone,
    lifecycle_details varchar2,
    disk_redundancy varchar2,
    sparse_diskgroup number,
    scan_ip_ids dbms_cloud_oci_database_varchar2_tbl,
    vip_ids dbms_cloud_oci_database_varchar2_tbl,
    scan_dns_record_id varchar2,
    scan_dns_name varchar2,
    zone_id varchar2,
    data_storage_size_in_g_bs number,
    reco_storage_size_in_gb number,
    node_count number,
    license_model varchar2,
    maintenance_window dbms_cloud_oci_database_maintenance_window_t,
    last_maintenance_run_id varchar2,
    next_maintenance_run_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    source_db_system_id varchar2,
    point_in_time_data_disk_clone_timestamp timestamp with time zone,
    data_collection_options dbms_cloud_oci_database_data_collection_options_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

iorm_config_cache

(optional)

id

(required) The OCID of the DB system.

compartment_id

(required) The OCID of the compartment.

display_name

(required) The user-friendly name for the DB system. The name does not have to be unique.

availability_domain

(required) The name of the availability domain that the DB system is located in.

fault_domains

(optional) List of the Fault Domains in which this DB system is provisioned.

subnet_id

(required) The OCID of the subnet the DB system is associated with. **Subnet Restrictions:** - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. - For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

backup_subnet_id

(optional) The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems. **Subnet Restriction:** See the subnet restrictions information for **subnetId**.

nsg_ids

(optional) 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.

backup_network_nsg_ids

(optional) A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

memory_size_in_g_bs

(optional) Memory allocated to the DB system, in gigabytes.

storage_volume_performance_mode

(optional) The block storage volume performance level. Valid values are `BALANCED` and `HIGH_PERFORMANCE`. See Block Volume Performance for more information.

Allowed values are: 'BALANCED', 'HIGH_PERFORMANCE'

shape

(required) The shape of the DB system. The shape determines resources to allocate to the DB system. - For virtual machine shapes, the number of CPU cores and memory - For bare metal and Exadata shapes, the number of CPU cores, storage, and memory

db_system_options

(optional)

ssh_public_keys

(required) The public key portion of one or more key pairs used for SSH access to the DB system.

time_zone

(optional) The time zone of the DB system. For details, see DB System Time Zones.

hostname

(required) The hostname for the DB system.

domain

(required) The domain name for the DB system.

kms_key_id

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

version

(optional) The Oracle Database version of the DB system.

os_version

(optional) The most recent OS Patch Version applied on the DB system.

cpu_core_count

(required) The number of CPU cores enabled on the DB system.

cluster_name

(optional) The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.

data_storage_percentage

(optional) The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems.

database_edition

(required) The Oracle Database edition that applies to all the databases on the DB system.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION', 'ENTERPRISE_EDITION_HIGH_PERFORMANCE', 'ENTERPRISE_EDITION_EXTREME_PERFORMANCE'

last_patch_history_entry_id

(optional) The OCID of the last patch history. This value is updated as soon as a patch operation starts.

listener_port

(optional) The port number configured for the listener on the DB system.

lifecycle_state

(required) The current state of the DB system.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED', 'MIGRATED', 'MAINTENANCE_IN_PROGRESS', 'NEEDS_ATTENTION', 'UPGRADING'

time_created

(optional) The date and time the DB system was created.

lifecycle_details

(optional) Additional information about the current lifecycle state.

disk_redundancy

(optional) The type of redundancy configured for the DB system. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.

Allowed values are: 'HIGH', 'NORMAL'

sparse_diskgroup

(optional) True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured.

scan_ip_ids

(optional) The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster. **Note:** For a single-node DB system, this list is empty.

vip_ids

(optional) The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty.

scan_dns_record_id

(optional) The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.

scan_dns_name

(optional) The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.

zone_id

(optional) The OCID of the zone the DB system is associated with.

data_storage_size_in_g_bs

(optional) The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems.

reco_storage_size_in_gb

(optional) The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.

node_count

(optional) The number of nodes in the DB system. For RAC DB systems, the value is greater than 1.

license_model

(optional) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

maintenance_window

(optional)

last_maintenance_run_id

(optional) The OCID of the last maintenance run.

next_maintenance_run_id

(optional) The OCID of the next maintenance run.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

source_db_system_id

(optional) The OCID of the DB system.

point_in_time_data_disk_clone_timestamp

(optional) The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.

data_collection_options

(optional)

DBMS_CLOUD_OCI_DATABASE_COMPUTE_PERFORMANCE_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_database_compute_performance_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_compute_performance_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_compute_performance_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_DB_SYSTEM_COMPUTE_PERFORMANCE_SUMMARY_T Type

Representation of disk performance detail parameters.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_db_system_compute_performance_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  shape varchar2(32767),
  compute_performance_list dbms_cloud_oci_database_compute_performance_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_system_compute_performance_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_system_compute_performance_summary_t (
    shape varchar2,
    compute_performance_list dbms_cloud_oci_database_compute_performance_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

shape

(required) The shape of the DB system.

compute_performance_list

(required) List of Compute performance details for the specified DB system shape.

DBMS_CLOUD_OCI_DATABASE_DB_SYSTEM_SHAPE_SUMMARY_T Type

The shape of the DB system. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_db_system_shape_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  shape_family varchar2(32767),
  shape_type varchar2(32767),
  shape varchar2(32767),
  available_core_count number,
  minimum_core_count number,
  core_count_increment number,
  min_storage_count number,
  max_storage_count number,
  available_data_storage_per_server_in_t_bs number,
  available_memory_per_node_in_g_bs number,
  available_db_node_per_node_in_g_bs number,
  min_core_count_per_node number,
  available_memory_in_g_bs number,
  min_memory_per_node_in_g_bs number,
  available_db_node_storage_in_g_bs number,
  min_db_node_storage_per_node_in_g_bs number,
  available_data_storage_in_t_bs number,
  min_data_storage_in_t_bs number,
  minimum_node_count number,
  maximum_node_count number,
  available_core_count_per_node number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_system_shape_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_system_shape_summary_t (
    name varchar2,
    shape_family varchar2,
    shape_type varchar2,
    shape varchar2,
    available_core_count number,
    minimum_core_count number,
    core_count_increment number,
    min_storage_count number,
    max_storage_count number,
    available_data_storage_per_server_in_t_bs number,
    available_memory_per_node_in_g_bs number,
    available_db_node_per_node_in_g_bs number,
    min_core_count_per_node number,
    available_memory_in_g_bs number,
    min_memory_per_node_in_g_bs number,
    available_db_node_storage_in_g_bs number,
    min_db_node_storage_per_node_in_g_bs number,
    available_data_storage_in_t_bs number,
    min_data_storage_in_t_bs number,
    minimum_node_count number,
    maximum_node_count number,
    available_core_count_per_node number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) The name of the shape used for the DB system.

shape_family

(optional) The family of the shape used for the DB system.

shape_type

(optional) The shape type for the virtual machine DB system. Shape type is determined by CPU hardware. Valid values are `AMD` , `INTEL`, `INTEL_FLEX_X9` or `AMPERE_FLEX_A1`.

Allowed values are: 'AMD', 'INTEL', 'INTEL_FLEX_X9', 'AMPERE_FLEX_A1'

shape

(optional) Deprecated. Use `name` instead of `shape`.

available_core_count

(required) The maximum number of CPU cores that can be enabled on the DB system for this shape.

minimum_core_count

(optional) The minimum number of CPU cores that can be enabled on the DB system for this shape.

core_count_increment

(optional) The discrete number by which the CPU core count for this shape can be increased or decreased.

min_storage_count

(optional) The minimum number of Exadata storage servers available for the Exadata infrastructure.

max_storage_count

(optional) The maximum number of Exadata storage servers available for the Exadata infrastructure.

available_data_storage_per_server_in_t_bs

(optional) The maximum data storage available per storage server for this shape. Only applicable to ExaCC Elastic shapes.

available_memory_per_node_in_g_bs

(optional) The maximum memory available per database node for this shape. Only applicable to ExaCC Elastic shapes.

available_db_node_per_node_in_g_bs

(optional) The maximum Db Node storage available per database node for this shape. Only applicable to ExaCC Elastic shapes.

min_core_count_per_node

(optional) The minimum number of CPU cores that can be enabled per node for this shape.

available_memory_in_g_bs

(optional) The maximum memory that can be enabled for this shape.

min_memory_per_node_in_g_bs

(optional) The minimum memory that need be allocated per node for this shape.

available_db_node_storage_in_g_bs

(optional) The maximum Db Node storage that can be enabled for this shape.

min_db_node_storage_per_node_in_g_bs

(optional) The minimum Db Node storage that need be allocated per node for this shape.

available_data_storage_in_t_bs

(optional) The maximum DATA storage that can be enabled for this shape.

min_data_storage_in_t_bs

(optional) The minimum data storage that need be allocated for this shape.

minimum_node_count

(optional) The minimum number of compute servers available for this shape.

maximum_node_count

(optional) The maximum number of compute servers available for this shape.

available_core_count_per_node

(optional) The maximum number of CPU cores per database node that can be enabled for this shape. Only applicable to the flex Exadata shape, ExaCC Elastic shapes and VM Flex shapes.

DBMS_CLOUD_OCI_DATABASE_DISK_PERFORMANCE_DETAILS_T Type

Representation of disk performance detail parameters.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_disk_performance_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  disk_iops number,
  disk_throughput_in_mbps number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_disk_performance_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_disk_performance_details_t (
    disk_iops number,
    disk_throughput_in_mbps number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

disk_iops

(required) Disk IOPS in thousands.

disk_throughput_in_mbps

(required) Disk Throughput in Mbps.

DBMS_CLOUD_OCI_DATABASE_STORAGE_PERFORMANCE_DETAILS_T Type

Representation of storage performance detail parameters.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_storage_performance_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  size_in_g_bs number,
  balanced_disk_performance dbms_cloud_oci_database_disk_performance_details_t,
  high_disk_performance dbms_cloud_oci_database_disk_performance_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_storage_performance_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_storage_performance_details_t (
    size_in_g_bs number,
    balanced_disk_performance dbms_cloud_oci_database_disk_performance_details_t,
    high_disk_performance dbms_cloud_oci_database_disk_performance_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

size_in_g_bs

(required) Size in GBs.

balanced_disk_performance

(required)

high_disk_performance

(required)

DBMS_CLOUD_OCI_DATABASE_STORAGE_PERFORMANCE_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_database_storage_performance_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_storage_performance_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_storage_performance_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_DB_SYSTEM_STORAGE_PERFORMANCE_SUMMARY_T Type

Representation of storage performance summary per shapeType .

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_db_system_storage_performance_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  shape_type varchar2(32767),
  data_storage_performance_list dbms_cloud_oci_database_storage_performance_details_tbl,
  reco_storage_performance_list dbms_cloud_oci_database_storage_performance_details_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_system_storage_performance_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_system_storage_performance_summary_t (
    shape_type varchar2,
    data_storage_performance_list dbms_cloud_oci_database_storage_performance_details_tbl,
    reco_storage_performance_list dbms_cloud_oci_database_storage_performance_details_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

shape_type

(required) ShapeType of the DbSystems INTEL , AMD, INTEL_FLEX_X9 or AMPERE_FLEX_A1

Allowed values are: 'AMD', 'INTEL', 'INTEL_FLEX_X9', 'AMPERE_FLEX_A1'

data_storage_performance_list

(required) List of storage performance for the DATA disks

reco_storage_performance_list

(required) List of storage performance for the RECO disks

DBMS_CLOUD_OCI_DATABASE_DB_SYSTEM_SUMMARY_T Type

The Database Service supports several types of DB systems, ranging in size, price, and performance. For details about each type of system, see Bare Metal and Virtual Machine DB Systems. **Note:** Deprecated for Exadata Cloud Service instances using the new resource model. To provision and manage new Exadata Cloud Service systems, use the CLOUD_EXADATA_INFRASTRUCTURE Type and CLOUD_VM_CLUSTER Type. See Exadata Cloud Service for more information on Exadata systems. For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See Switching an Exadata DB System to the New Resource Model and APIs for details on converting existing Exadata DB systems to the new resource model. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies. For information about access control and compartments, see Overview of the Identity Service. For information about availability domains, see Regions and Availability Domains. To get a list of availability domains, use the `ListAvailabilityDomains` operation in the Identity Service API. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_db_system_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  availability_domain varchar2(32767),
  fault_domains dbms_cloud_oci_database_varchar2_tbl,
  subnet_id varchar2(32767),
  backup_subnet_id varchar2(32767),
  nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  backup_network_nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  memory_size_in_g_bs number,
  storage_volume_performance_mode varchar2(32767),
  shape varchar2(32767),
  db_system_options dbms_cloud_oci_database_db_system_options_t,
  ssh_public_keys dbms_cloud_oci_database_varchar2_tbl,
  time_zone varchar2(32767),
  hostname varchar2(32767),
  domain varchar2(32767),
  kms_key_id varchar2(32767),
  version varchar2(32767),
  os_version varchar2(32767),
  cpu_core_count number,
  cluster_name varchar2(32767),
  data_storage_percentage number,
  database_edition varchar2(32767),
  last_patch_history_entry_id varchar2(32767),
  listener_port number,
  lifecycle_state varchar2(32767),
  time_created timestamp with time zone,
  lifecycle_details varchar2(32767),
  disk_redundancy varchar2(32767),
  sparse_diskgroup number,
  scan_ip_ids dbms_cloud_oci_database_varchar2_tbl,
  vip_ids dbms_cloud_oci_database_varchar2_tbl,
  scan_dns_record_id varchar2(32767),
  scan_dns_name varchar2(32767),
  zone_id varchar2(32767),
  data_storage_size_in_g_bs number,
  reco_storage_size_in_gb number,
  node_count number,
  license_model varchar2(32767),
  maintenance_window dbms_cloud_oci_database_maintenance_window_t,
  last_maintenance_run_id varchar2(32767),
  next_maintenance_run_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  source_db_system_id varchar2(32767),
  point_in_time_data_disk_clone_timestamp timestamp with time zone,
  data_collection_options dbms_cloud_oci_database_data_collection_options_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_system_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_system_summary_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    availability_domain varchar2,
    fault_domains dbms_cloud_oci_database_varchar2_tbl,
    subnet_id varchar2,
    backup_subnet_id varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    backup_network_nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    memory_size_in_g_bs number,
    storage_volume_performance_mode varchar2,
    shape varchar2,
    db_system_options dbms_cloud_oci_database_db_system_options_t,
    ssh_public_keys dbms_cloud_oci_database_varchar2_tbl,
    time_zone varchar2,
    hostname varchar2,
    domain varchar2,
    kms_key_id varchar2,
    version varchar2,
    os_version varchar2,
    cpu_core_count number,
    cluster_name varchar2,
    data_storage_percentage number,
    database_edition varchar2,
    last_patch_history_entry_id varchar2,
    listener_port number,
    lifecycle_state varchar2,
    time_created timestamp with time zone,
    lifecycle_details varchar2,
    disk_redundancy varchar2,
    sparse_diskgroup number,
    scan_ip_ids dbms_cloud_oci_database_varchar2_tbl,
    vip_ids dbms_cloud_oci_database_varchar2_tbl,
    scan_dns_record_id varchar2,
    scan_dns_name varchar2,
    zone_id varchar2,
    data_storage_size_in_g_bs number,
    reco_storage_size_in_gb number,
    node_count number,
    license_model varchar2,
    maintenance_window dbms_cloud_oci_database_maintenance_window_t,
    last_maintenance_run_id varchar2,
    next_maintenance_run_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    source_db_system_id varchar2,
    point_in_time_data_disk_clone_timestamp timestamp with time zone,
    data_collection_options dbms_cloud_oci_database_data_collection_options_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the DB system.

compartment_id

(required) The OCID of the compartment.

display_name

(required) The user-friendly name for the DB system. The name does not have to be unique.

availability_domain

(required) The name of the availability domain that the DB system is located in.

fault_domains

(optional) List of the Fault Domains in which this DB system is provisioned.

subnet_id

(required) The OCID of the subnet the DB system is associated with. **Subnet Restrictions:** - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. - For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

backup_subnet_id

(optional) The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems. **Subnet Restriction:** See the subnet restrictions information for **subnetId**.

nsg_ids

(optional) 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.

backup_network_nsg_ids

(optional) A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

memory_size_in_g_bs

(optional) Memory allocated to the DB system, in gigabytes.

storage_volume_performance_mode

(optional) The block storage volume performance level. Valid values are `BALANCED` and `HIGH_PERFORMANCE`. See Block Volume Performance for more information.

Allowed values are: 'BALANCED', 'HIGH_PERFORMANCE'

shape

(required) The shape of the DB system. The shape determines resources to allocate to the DB system. - For virtual machine shapes, the number of CPU cores and memory - For bare metal and Exadata shapes, the number of CPU cores, storage, and memory

db_system_options

(optional)

ssh_public_keys

(required) The public key portion of one or more key pairs used for SSH access to the DB system.

time_zone

(optional) The time zone of the DB system. For details, see DB System Time Zones.

hostname

(required) The hostname for the DB system.

domain

(required) The domain name for the DB system.

kms_key_id

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

version

(optional) The Oracle Database version of the DB system.

os_version

(optional) The most recent OS Patch Version applied on the DB system.

cpu_core_count

(required) The number of CPU cores enabled on the DB system.

cluster_name

(optional) The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.

data_storage_percentage

(optional) The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems.

database_edition

(required) The Oracle Database edition that applies to all the databases on the DB system.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION', 'ENTERPRISE_EDITION_HIGH_PERFORMANCE', 'ENTERPRISE_EDITION_EXTREME_PERFORMANCE'

last_patch_history_entry_id

(optional) The OCID of the last patch history. This value is updated as soon as a patch operation starts.

listener_port

(optional) The port number configured for the listener on the DB system.

lifecycle_state

(required) The current state of the DB system.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED', 'MIGRATED', 'MAINTENANCE_IN_PROGRESS', 'NEEDS_ATTENTION', 'UPGRADING'

time_created

(optional) The date and time the DB system was created.

lifecycle_details

(optional) Additional information about the current lifecycle state.

disk_redundancy

(optional) The type of redundancy configured for the DB system. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.

Allowed values are: 'HIGH', 'NORMAL'

sparse_diskgroup

(optional) True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured.

scan_ip_ids

(optional) The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster. **Note:** For a single-node DB system, this list is empty.

vip_ids

(optional) The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty.

scan_dns_record_id

(optional) The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.

scan_dns_name

(optional) The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.

zone_id

(optional) The OCID of the zone the DB system is associated with.

data_storage_size_in_g_bs

(optional) The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems.

reco_storage_size_in_gb

(optional) The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.

node_count

(optional) The number of nodes in the DB system. For RAC DB systems, the value is greater than 1.

license_model

(optional) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

maintenance_window

(optional)

last_maintenance_run_id

(optional) The OCID of the last maintenance run.

next_maintenance_run_id

(optional) The OCID of the next maintenance run.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

source_db_system_id

(optional) The OCID of the DB system.

point_in_time_data_disk_clone_timestamp

(optional) The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.

data_collection_options

(optional)

DBMS_CLOUD_OCI_DATABASE_DB_SYSTEM_UPGRADE_HISTORY_ENTRY_T Type

The record of an OS upgrade action on a DB system. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_db_system_upgrade_history_entry_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  action varchar2(32767),
  new_gi_version varchar2(32767),
  old_gi_version varchar2(32767),
  old_os_version varchar2(32767),
  new_os_version varchar2(32767),
  snapshot_retention_period_in_days number,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_started timestamp with time zone,
  time_ended timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_system_upgrade_history_entry_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_system_upgrade_history_entry_t (
    id varchar2,
    action varchar2,
    new_gi_version varchar2,
    old_gi_version varchar2,
    old_os_version varchar2,
    new_os_version varchar2,
    snapshot_retention_period_in_days number,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_started timestamp with time zone,
    time_ended timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the upgrade history entry.

action

(required) The operating system upgrade action.

Allowed values are: 'PRECHECK', 'ROLLBACK', 'UPDATE_SNAPSHOT_RETENTION_DAYS', 'UPGRADE'

new_gi_version

(optional) A valid Oracle Grid Infrastructure (GI) software version.

old_gi_version

(optional) A valid Oracle Grid Infrastructure (GI) software version.

old_os_version

(optional) A valid Oracle Software (OS) version eg. Oracle Linux Server release 8

new_os_version

(optional) A valid Oracle Software (OS) version eg. Oracle Linux Server release 8

snapshot_retention_period_in_days

(required) The retention period, in days, for the snapshot that allows you to perform a rollback of the upgrade operation. After this number of days passes, you cannot roll back the upgrade.

lifecycle_state

(required) The current state of the action.

Allowed values are: 'IN_PROGRESS', 'SUCCEEDED', 'FAILED', 'NEEDS_ATTENTION'

lifecycle_details

(optional) A descriptive text associated with the lifecycleState. Typically contains additional displayable text.

time_started

(required) The date and time when the upgrade action started.

time_ended

(optional) The date and time when the upgrade action completed

DBMS_CLOUD_OCI_DATABASE_DB_SYSTEM_UPGRADE_HISTORY_ENTRY_SUMMARY_T Type

The summary for the record of an OS upgrade action on a DB system.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_db_system_upgrade_history_entry_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  action varchar2(32767),
  new_gi_version varchar2(32767),
  old_gi_version varchar2(32767),
  old_os_version varchar2(32767),
  new_os_version varchar2(32767),
  snapshot_retention_period_in_days number,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_started timestamp with time zone,
  time_ended timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_system_upgrade_history_entry_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_system_upgrade_history_entry_summary_t (
    id varchar2,
    action varchar2,
    new_gi_version varchar2,
    old_gi_version varchar2,
    old_os_version varchar2,
    new_os_version varchar2,
    snapshot_retention_period_in_days number,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_started timestamp with time zone,
    time_ended timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the upgrade history entry.

action

(required) The operating system upgrade action.

Allowed values are: 'PRECHECK', 'ROLLBACK', 'UPDATE_SNAPSHOT_RETENTION_DAYS', 'UPGRADE'

new_gi_version

(optional) A valid Oracle Grid Infrastructure (GI) software version.

old_gi_version

(optional) A valid Oracle Grid Infrastructure (GI) software version.

old_os_version

(optional) A valid Oracle Software (OS) version eg. Oracle Linux Server release 8

new_os_version

(optional) A valid Oracle Software (OS) version eg. Oracle Linux Server release 8

snapshot_retention_period_in_days

(required) The retention period, in days, for the snapshot that allows you to perform a rollback of the upgrade operation. After this number of days passes, you cannot roll back the upgrade.

lifecycle_state

(required) The current state of the action.

Allowed values are: 'IN_PROGRESS', 'SUCCEEDED', 'FAILED', 'NEEDS_ATTENTION'

lifecycle_details

(optional) A descriptive text associated with the lifecycleState. Typically contains additional displayable text.

time_started

(required) The date and time when the upgrade action started.

time_ended

(optional) The date and time when the upgrade action completed

DBMS_CLOUD_OCI_DATABASE_DB_VERSION_SUMMARY_T Type

The Oracle Database software version. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_db_version_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  version varchar2(32767),
  is_latest_for_major_version number,
  supports_pdb number,
  is_preview_db_version number,
  is_upgrade_supported number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_version_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_version_summary_t (
    version varchar2,
    is_latest_for_major_version number,
    supports_pdb number,
    is_preview_db_version number,
    is_upgrade_supported number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

version

(required) A valid Oracle Database version.

is_latest_for_major_version

(optional) True if this version of the Oracle Database software is the latest version for a release.

supports_pdb

(optional) True if this version of the Oracle Database software supports pluggable databases.

is_preview_db_version

(optional) True if this version of the Oracle Database software is the preview version.

is_upgrade_supported

(optional) True if this version of the Oracle Database software is supported for Upgrade.

DBMS_CLOUD_OCI_DATABASE_DEREGISTER_AUTONOMOUS_DATABASE_DATA_SAFE_DETAILS_T Type

Details to deregister an Autonomous Database with Data Safe.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_deregister_autonomous_database_data_safe_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  pdb_admin_password varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_deregister_autonomous_database_data_safe_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_deregister_autonomous_database_data_safe_details_t (
    pdb_admin_password varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

pdb_admin_password

(required) 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.

DBMS_CLOUD_OCI_DATABASE_DOWNLOAD_ONEOFF_PATCH_T Type

Data to download one-off patch.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_download_oneoff_patch_t FORCE AUTHID CURRENT_USER IS OBJECT (
  access_uri varchar2(32767),
  time_created timestamp with time zone,
  time_expires timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_download_oneoff_patch_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_download_oneoff_patch_t (
    access_uri varchar2,
    time_created timestamp with time zone,
    time_expires timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

access_uri

(required) URI to download one-off patch.

time_created

(required) The date and time one-off patch URI was created.

time_expires

(required) The date and time until which the one-off patch URI will be available for download.

DBMS_CLOUD_OCI_DATABASE_DR_SCAN_DETAILS_T Type

The Single Client Access Name (SCAN) details for Disaster recovery network.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_dr_scan_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  hostname varchar2(32767),
  scan_listener_port_tcp number,
  ips dbms_cloud_oci_database_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_dr_scan_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_dr_scan_details_t (
    hostname varchar2,
    scan_listener_port_tcp number,
    ips dbms_cloud_oci_database_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

hostname

(required) The Disaster recovery SCAN hostname.

scan_listener_port_tcp

(required) The Disaster recovery SCAN TCPIP port. Default is 1521.

ips

(required) The list of Disaster recovery SCAN IP addresses. Three addresses should be provided.

DBMS_CLOUD_OCI_DATABASE_ENABLE_DATABASE_MANAGEMENT_DETAILS_T Type

Data to enable the Database Management service for the database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_enable_database_management_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  credential_details dbms_cloud_oci_database_database_credential_details_t,
  private_end_point_id varchar2(32767),
  management_type varchar2(32767),
  service_name varchar2(32767),
  protocol varchar2(32767),
  port number,
  ssl_secret_id varchar2(32767),
  role varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_enable_database_management_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_enable_database_management_details_t (
    credential_details dbms_cloud_oci_database_database_credential_details_t,
    private_end_point_id varchar2,
    management_type varchar2,
    service_name varchar2,
    protocol varchar2,
    port number,
    ssl_secret_id varchar2,
    role varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

credential_details

(required)

private_end_point_id

(required) The OCID of the private endpoint.

management_type

(optional) The Database Management type.

Allowed values are: 'BASIC', 'ADVANCED'

service_name

(required) The name of the Oracle Database service that will be used to connect to the database.

protocol

(optional) Protocol used by the database connection.

Allowed values are: 'TCP', 'TCPS'

port

(optional) The port used to connect to the database.

ssl_secret_id

(optional) The OCID of the Oracle Cloud Infrastructure secret.

role

(optional) The role of the user that will be connecting to the database.

Allowed values are: 'SYSDBA', 'NORMAL'

DBMS_CLOUD_OCI_DATABASE_ENABLE_EXTERNAL_CONTAINER_DATABASE_DATABASE_MANAGEMENT_DETAILS_T Type

Details to enable Database Management on an external container database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_enable_external_container_database_database_management_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  license_model varchar2(32767),
  external_database_connector_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_enable_external_container_database_database_management_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_enable_external_container_database_database_management_details_t (
    license_model varchar2,
    external_database_connector_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

license_model

(required) The Oracle license model that applies to the external database.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

external_database_connector_id

(required) The OCID of the CREATE_EXTERNAL_DATABASE_CONNECTOR_DETAILS Function.

DBMS_CLOUD_OCI_DATABASE_ENABLE_EXTERNAL_CONTAINER_DATABASE_STACK_MONITORING_DETAILS_T Type

Details to enable Stack Monitoring on the external container database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_enable_external_container_database_stack_monitoring_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  external_database_connector_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_enable_external_container_database_stack_monitoring_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_enable_external_container_database_stack_monitoring_details_t (
    external_database_connector_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

external_database_connector_id

(required) The OCID of the CREATE_EXTERNAL_DATABASE_CONNECTOR_DETAILS Function.

DBMS_CLOUD_OCI_DATABASE_ENABLE_EXTERNAL_DATABASE_MANAGEMENT_DETAILS_BASE_T Type

Details to enable Database Management on an external database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_enable_external_database_management_details_base_t FORCE AUTHID CURRENT_USER IS OBJECT (
  external_database_connector_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_enable_external_database_management_details_base_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_enable_external_database_management_details_base_t (
    external_database_connector_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

external_database_connector_id

(required) The OCID of the CREATE_EXTERNAL_DATABASE_CONNECTOR_DETAILS Function.

DBMS_CLOUD_OCI_DATABASE_ENABLE_EXTERNAL_DATABASE_OPERATIONS_INSIGHTS_DETAILS_BASE_T Type

Details to enable Operations Insights on the external database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_enable_external_database_operations_insights_details_base_t FORCE AUTHID CURRENT_USER IS OBJECT (
  external_database_connector_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_enable_external_database_operations_insights_details_base_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_enable_external_database_operations_insights_details_base_t (
    external_database_connector_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

external_database_connector_id

(required) The OCID of the CREATE_EXTERNAL_DATABASE_CONNECTOR_DETAILS Function.

DBMS_CLOUD_OCI_DATABASE_ENABLE_EXTERNAL_DATABASE_STACK_MONITORING_DETAILS_BASE_T Type

Details to enable Stack Monitoring on the external database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_enable_external_database_stack_monitoring_details_base_t FORCE AUTHID CURRENT_USER IS OBJECT (
  external_database_connector_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_enable_external_database_stack_monitoring_details_base_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_enable_external_database_stack_monitoring_details_base_t (
    external_database_connector_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

external_database_connector_id

(required) The OCID of the CREATE_EXTERNAL_DATABASE_CONNECTOR_DETAILS Function.

DBMS_CLOUD_OCI_DATABASE_ENABLE_EXTERNAL_NON_CONTAINER_DATABASE_DATABASE_MANAGEMENT_DETAILS_T Type

Details to enable Database Management on an external non-container database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_enable_external_non_container_database_database_management_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  license_model varchar2(32767),
  external_database_connector_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_enable_external_non_container_database_database_management_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_enable_external_non_container_database_database_management_details_t (
    license_model varchar2,
    external_database_connector_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

license_model

(required) The Oracle license model that applies to the external database.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

external_database_connector_id

(required) The OCID of the CREATE_EXTERNAL_DATABASE_CONNECTOR_DETAILS Function.

DBMS_CLOUD_OCI_DATABASE_ENABLE_EXTERNAL_NON_CONTAINER_DATABASE_OPERATIONS_INSIGHTS_DETAILS_T Type

Details to enable Operations Insights on the external non-container database

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_enable_external_non_container_database_operations_insights_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  external_database_connector_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_enable_external_non_container_database_operations_insights_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_enable_external_non_container_database_operations_insights_details_t (
    external_database_connector_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

external_database_connector_id

(required) The OCID of the CREATE_EXTERNAL_DATABASE_CONNECTOR_DETAILS Function.

DBMS_CLOUD_OCI_DATABASE_ENABLE_EXTERNAL_NON_CONTAINER_DATABASE_STACK_MONITORING_DETAILS_T Type

Details to enable Stack Monitoring on the external non-container database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_enable_external_non_container_database_stack_monitoring_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  external_database_connector_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_enable_external_non_container_database_stack_monitoring_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_enable_external_non_container_database_stack_monitoring_details_t (
    external_database_connector_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

external_database_connector_id

(required) The OCID of the CREATE_EXTERNAL_DATABASE_CONNECTOR_DETAILS Function.

DBMS_CLOUD_OCI_DATABASE_ENABLE_EXTERNAL_PLUGGABLE_DATABASE_DATABASE_MANAGEMENT_DETAILS_T Type

Details to enable Database Management on an external pluggable database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_enable_external_pluggable_database_database_management_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  external_database_connector_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_enable_external_pluggable_database_database_management_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_enable_external_pluggable_database_database_management_details_t (
    external_database_connector_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

external_database_connector_id

(required) The OCID of the CREATE_EXTERNAL_DATABASE_CONNECTOR_DETAILS Function.

DBMS_CLOUD_OCI_DATABASE_ENABLE_EXTERNAL_PLUGGABLE_DATABASE_OPERATIONS_INSIGHTS_DETAILS_T Type

Details to enable Operations Insights on the external pluggable database

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_enable_external_pluggable_database_operations_insights_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  external_database_connector_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_enable_external_pluggable_database_operations_insights_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_enable_external_pluggable_database_operations_insights_details_t (
    external_database_connector_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

external_database_connector_id

(required) The OCID of the CREATE_EXTERNAL_DATABASE_CONNECTOR_DETAILS Function.

DBMS_CLOUD_OCI_DATABASE_ENABLE_EXTERNAL_PLUGGABLE_DATABASE_STACK_MONITORING_DETAILS_T Type

Details to enable Stack Monitoring on the external pluggable database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_enable_external_pluggable_database_stack_monitoring_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  external_database_connector_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_enable_external_pluggable_database_stack_monitoring_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_enable_external_pluggable_database_stack_monitoring_details_t (
    external_database_connector_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

external_database_connector_id

(required) The OCID of the CREATE_EXTERNAL_DATABASE_CONNECTOR_DETAILS Function.

DBMS_CLOUD_OCI_DATABASE_ENABLE_PLUGGABLE_DATABASE_MANAGEMENT_DETAILS_T Type

Data to enable the Database Management service for the pluggable database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_enable_pluggable_database_management_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  credential_details dbms_cloud_oci_database_database_credential_details_t,
  private_end_point_id varchar2(32767),
  service_name varchar2(32767),
  protocol varchar2(32767),
  port number,
  ssl_secret_id varchar2(32767),
  role varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_enable_pluggable_database_management_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_enable_pluggable_database_management_details_t (
    credential_details dbms_cloud_oci_database_database_credential_details_t,
    private_end_point_id varchar2,
    service_name varchar2,
    protocol varchar2,
    port number,
    ssl_secret_id varchar2,
    role varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

credential_details

(required)

private_end_point_id

(required) The OCID of the private endpoint.

service_name

(required) The name of the Oracle Database service that will be used to connect to the database.

protocol

(optional) Protocol used by the database connection.

Allowed values are: 'TCP', 'TCPS'

port

(optional) The port used to connect to the pluggable database.

ssl_secret_id

(optional) The OCID of the Oracle Cloud Infrastructure secret.

role

(optional) The role of the user that will be connecting to the pluggable database.

Allowed values are: 'SYSDBA', 'NORMAL'

DBMS_CLOUD_OCI_DATABASE_ERROR_T Type

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_error_t (
    code varchar2,
    message varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A short error code that defines the error, meant for programmatic parsing. See API Errors.

message

(required) A human-readable error string.

DBMS_CLOUD_OCI_DATABASE_ESTIMATED_PATCHING_TIME_T Type

The estimated total time required in minutes for all patching operations (database server, storage server, and network switch patching).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_estimated_patching_time_t FORCE AUTHID CURRENT_USER IS OBJECT (
  total_estimated_patching_time number,
  estimated_db_server_patching_time number,
  estimated_storage_server_patching_time number,
  estimated_network_switches_patching_time number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_estimated_patching_time_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_estimated_patching_time_t (
    total_estimated_patching_time number,
    estimated_db_server_patching_time number,
    estimated_storage_server_patching_time number,
    estimated_network_switches_patching_time number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

total_estimated_patching_time

(optional) The estimated total time required in minutes for all patching operations.

estimated_db_server_patching_time

(optional) The estimated time required in minutes for database server patching.

estimated_storage_server_patching_time

(optional) The estimated time required in minutes for storage server patching.

estimated_network_switches_patching_time

(optional) The estimated time required in minutes for network switch patching.

DBMS_CLOUD_OCI_DATABASE_EXADATA_DB_SYSTEM_MIGRATION_SUMMARY_T Type

Information about the Exadata DB system migration. The migration is used to move the Exadata Cloud Service instance from the DB system resource model to the new cloud Exadata infrastructure resource model.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_exadata_db_system_migration_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  db_system_id varchar2(32767),
  cloud_vm_cluster_id varchar2(32767),
  cloud_exadata_infrastructure_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_exadata_db_system_migration_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_exadata_db_system_migration_summary_t (
    db_system_id varchar2,
    cloud_vm_cluster_id varchar2,
    cloud_exadata_infrastructure_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

db_system_id

(required) The OCID of the DB system.

cloud_vm_cluster_id

(required) The OCID of the cloud VM cluster.

cloud_exadata_infrastructure_id

(required) The OCID of the cloud Exadata infrastructure.

DBMS_CLOUD_OCI_DATABASE_EXADATA_DB_SYSTEM_MIGRATION_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_database_exadata_db_system_migration_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_exadata_db_system_migration_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_exadata_db_system_migration_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_EXADATA_DB_SYSTEM_MIGRATION_T Type

Information about the Exadata DB system migration. The migration is used to move the Exadata Cloud Service instance from the DB system resource model to the new cloud Exadata infrastructure resource model.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_exadata_db_system_migration_t FORCE AUTHID CURRENT_USER IS OBJECT (
  db_system_id varchar2(32767),
  cloud_vm_cluster_id varchar2(32767),
  cloud_exadata_infrastructure_id varchar2(32767),
  additional_migrations dbms_cloud_oci_database_exadata_db_system_migration_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_exadata_db_system_migration_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_exadata_db_system_migration_t (
    db_system_id varchar2,
    cloud_vm_cluster_id varchar2,
    cloud_exadata_infrastructure_id varchar2,
    additional_migrations dbms_cloud_oci_database_exadata_db_system_migration_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

db_system_id

(required) The OCID of the DB system.

cloud_vm_cluster_id

(required) The OCID of the cloud VM cluster.

cloud_exadata_infrastructure_id

(required) The OCID of the cloud Exadata infrastructure.

additional_migrations

(optional) The details of addtional resources related to the migration.

DBMS_CLOUD_OCI_DATABASE_EXADATA_INFRASTRUCTURE_T Type

ExadataInfrastructure

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_exadata_infrastructure_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  lifecycle_state varchar2(32767),
  display_name varchar2(32767),
  shape varchar2(32767),
  time_zone varchar2(32767),
  cpus_enabled number,
  max_cpu_count number,
  memory_size_in_g_bs number,
  max_memory_in_g_bs number,
  db_node_storage_size_in_g_bs number,
  max_db_node_storage_in_g_bs number,
  data_storage_size_in_t_bs number,
  max_data_storage_in_t_bs number,
  rack_serial_number varchar2(32767),
  storage_count number,
  additional_storage_count number,
  activated_storage_count number,
  compute_count number,
  is_multi_rack_deployment number,
  multi_rack_configuration_file clob,
  additional_compute_count number,
  additional_compute_system_model varchar2(32767),
  cloud_control_plane_server1 varchar2(32767),
  cloud_control_plane_server2 varchar2(32767),
  netmask varchar2(32767),
  gateway varchar2(32767),
  admin_network_cidr varchar2(32767),
  infini_band_network_cidr varchar2(32767),
  corporate_proxy varchar2(32767),
  dns_server dbms_cloud_oci_database_varchar2_tbl,
  ntp_server dbms_cloud_oci_database_varchar2_tbl,
  time_created timestamp with time zone,
  lifecycle_details varchar2(32767),
  csi_number varchar2(32767),
  contacts dbms_cloud_oci_database_exadata_infrastructure_contact_tbl,
  maintenance_slo_status varchar2(32767),
  maintenance_window dbms_cloud_oci_database_maintenance_window_t,
  storage_server_version varchar2(32767),
  db_server_version varchar2(32767),
  monthly_db_server_version varchar2(32767),
  last_maintenance_run_id varchar2(32767),
  next_maintenance_run_id varchar2(32767),
  is_cps_offline_report_enabled number,
  network_bonding_mode_details dbms_cloud_oci_database_network_bonding_mode_details_t,
  availability_domain varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_exadata_infrastructure_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_exadata_infrastructure_t (
    id varchar2,
    compartment_id varchar2,
    lifecycle_state varchar2,
    display_name varchar2,
    shape varchar2,
    time_zone varchar2,
    cpus_enabled number,
    max_cpu_count number,
    memory_size_in_g_bs number,
    max_memory_in_g_bs number,
    db_node_storage_size_in_g_bs number,
    max_db_node_storage_in_g_bs number,
    data_storage_size_in_t_bs number,
    max_data_storage_in_t_bs number,
    rack_serial_number varchar2,
    storage_count number,
    additional_storage_count number,
    activated_storage_count number,
    compute_count number,
    is_multi_rack_deployment number,
    multi_rack_configuration_file clob,
    additional_compute_count number,
    additional_compute_system_model varchar2,
    cloud_control_plane_server1 varchar2,
    cloud_control_plane_server2 varchar2,
    netmask varchar2,
    gateway varchar2,
    admin_network_cidr varchar2,
    infini_band_network_cidr varchar2,
    corporate_proxy varchar2,
    dns_server dbms_cloud_oci_database_varchar2_tbl,
    ntp_server dbms_cloud_oci_database_varchar2_tbl,
    time_created timestamp with time zone,
    lifecycle_details varchar2,
    csi_number varchar2,
    contacts dbms_cloud_oci_database_exadata_infrastructure_contact_tbl,
    maintenance_slo_status varchar2,
    maintenance_window dbms_cloud_oci_database_maintenance_window_t,
    storage_server_version varchar2,
    db_server_version varchar2,
    monthly_db_server_version varchar2,
    last_maintenance_run_id varchar2,
    next_maintenance_run_id varchar2,
    is_cps_offline_report_enabled number,
    network_bonding_mode_details dbms_cloud_oci_database_network_bonding_mode_details_t,
    availability_domain varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Exadata infrastructure.

compartment_id

(required) The OCID of the compartment.

lifecycle_state

(required) The current lifecycle state of the Exadata infrastructure.

Allowed values are: 'CREATING', 'REQUIRES_ACTIVATION', 'ACTIVATING', 'ACTIVE', 'ACTIVATION_FAILED', 'FAILED', 'UPDATING', 'DELETING', 'DELETED', 'DISCONNECTED', 'MAINTENANCE_IN_PROGRESS', 'WAITING_FOR_CONNECTIVITY'

display_name

(required) The user-friendly name for the Exadata Cloud@Customer infrastructure. The name does not need to be unique.

shape

(required) The shape of the Exadata infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance.

time_zone

(optional) The time zone of the Exadata infrastructure. For details, see Exadata Infrastructure Time Zones.

cpus_enabled

(optional) The number of enabled CPU cores.

max_cpu_count

(optional) The total number of CPU cores available.

memory_size_in_g_bs

(optional) The memory allocated in GBs.

max_memory_in_g_bs

(optional) The total memory available in GBs.

db_node_storage_size_in_g_bs

(optional) The local node storage allocated in GBs.

max_db_node_storage_in_g_bs

(optional) The total local node storage available in GBs.

data_storage_size_in_t_bs

(optional) Size, in terabytes, of the DATA disk group.

max_data_storage_in_t_bs

(optional) The total available DATA disk group size.

rack_serial_number

(optional) The serial number for the Exadata infrastructure.

storage_count

(optional) The number of Exadata storage servers for the Exadata infrastructure.

additional_storage_count

(optional) The requested number of additional storage servers for the Exadata infrastructure.

activated_storage_count

(optional) The requested number of additional storage servers activated for the Exadata infrastructure.

compute_count

(optional) The number of compute servers for the Exadata infrastructure.

is_multi_rack_deployment

(optional) Indicates if deployment is Multi-Rack or not.

multi_rack_configuration_file

(optional) The base64 encoded Multi-Rack configuration json file.

additional_compute_count

(optional) The requested number of additional compute servers for the Exadata infrastructure.

additional_compute_system_model

(optional) Oracle Exadata System Model specification. The system model determines the amount of compute or storage server resources available for use. For more information, please see System and Shape Configuration Options]

Allowed values are: 'X7', 'X8', 'X8M', 'X9M', 'X10M'

cloud_control_plane_server1

(optional) The IP address for the first control plane server.

cloud_control_plane_server2

(optional) The IP address for the second control plane server.

netmask

(optional) The netmask for the control plane network.

gateway

(optional) The gateway for the control plane network.

admin_network_cidr

(optional) The CIDR block for the Exadata administration network.

infini_band_network_cidr

(optional) The CIDR block for the Exadata InfiniBand interconnect.

corporate_proxy

(optional) The corporate network proxy for access to the control plane network.

dns_server

(optional) The list of DNS server IP addresses. Maximum of 3 allowed.

ntp_server

(optional) The list of NTP server IP addresses. Maximum of 3 allowed.

time_created

(optional) The date and time the Exadata infrastructure was created.

lifecycle_details

(optional) Additional information about the current lifecycle state.

csi_number

(optional) The CSI Number of the Exadata infrastructure.

contacts

(optional) The list of contacts for the Exadata infrastructure.

maintenance_slo_status

(optional) A field to capture ‘Maintenance SLO Status’ for the Exadata infrastructure with values ‘OK’, ‘DEGRADED’. Default is ‘OK’ when the infrastructure is provisioned.

Allowed values are: 'OK', 'DEGRADED'

maintenance_window

(optional)

storage_server_version

(optional) The software version of the storage servers (cells) in the Exadata infrastructure.

db_server_version

(optional) The software version of the database servers (dom0) in the Exadata infrastructure.

monthly_db_server_version

(optional) The monthly software version of the database servers (dom0) in the Exadata infrastructure.

last_maintenance_run_id

(optional) The OCID of the last maintenance run.

next_maintenance_run_id

(optional) The OCID of the next maintenance run.

is_cps_offline_report_enabled

(optional) Indicates whether cps offline diagnostic report is enabled for this Exadata infrastructure. This will allow a customer to quickly check status themselves and fix problems on their end, saving time and frustration for both Oracle and the customer when they find the CPS in a disconnected state.You can enable offline diagnostic report during Exadata infrastructure provisioning. You can also disable or enable it at any time using the UpdateExadatainfrastructure API.

network_bonding_mode_details

(optional)

availability_domain

(optional) The name of the availability domain that the Exadata infrastructure is located in.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_EXADATA_INFRASTRUCTURE_SUMMARY_T Type

Details of the Exadata Cloud@Customer infrastructure. Applies to Exadata Cloud@Customer instances only. See CLOUD_EXADATA_INFRASTRUCTURE_SUMMARY Function for details of the cloud Exadata infrastructure resource used by Exadata Cloud Service instances.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_exadata_infrastructure_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  lifecycle_state varchar2(32767),
  display_name varchar2(32767),
  shape varchar2(32767),
  time_zone varchar2(32767),
  cpus_enabled number,
  max_cpu_count number,
  memory_size_in_g_bs number,
  max_memory_in_g_bs number,
  db_node_storage_size_in_g_bs number,
  max_db_node_storage_in_g_bs number,
  data_storage_size_in_t_bs number,
  max_data_storage_in_t_bs number,
  rack_serial_number varchar2(32767),
  storage_count number,
  additional_storage_count number,
  activated_storage_count number,
  compute_count number,
  is_multi_rack_deployment number,
  multi_rack_configuration_file clob,
  additional_compute_count number,
  additional_compute_system_model varchar2(32767),
  cloud_control_plane_server1 varchar2(32767),
  cloud_control_plane_server2 varchar2(32767),
  netmask varchar2(32767),
  gateway varchar2(32767),
  admin_network_cidr varchar2(32767),
  infini_band_network_cidr varchar2(32767),
  corporate_proxy varchar2(32767),
  dns_server dbms_cloud_oci_database_varchar2_tbl,
  ntp_server dbms_cloud_oci_database_varchar2_tbl,
  time_created timestamp with time zone,
  lifecycle_details varchar2(32767),
  csi_number varchar2(32767),
  contacts dbms_cloud_oci_database_exadata_infrastructure_contact_tbl,
  maintenance_slo_status varchar2(32767),
  maintenance_window dbms_cloud_oci_database_maintenance_window_t,
  storage_server_version varchar2(32767),
  db_server_version varchar2(32767),
  monthly_db_server_version varchar2(32767),
  last_maintenance_run_id varchar2(32767),
  next_maintenance_run_id varchar2(32767),
  is_cps_offline_report_enabled number,
  network_bonding_mode_details dbms_cloud_oci_database_network_bonding_mode_details_t,
  availability_domain varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_exadata_infrastructure_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_exadata_infrastructure_summary_t (
    id varchar2,
    compartment_id varchar2,
    lifecycle_state varchar2,
    display_name varchar2,
    shape varchar2,
    time_zone varchar2,
    cpus_enabled number,
    max_cpu_count number,
    memory_size_in_g_bs number,
    max_memory_in_g_bs number,
    db_node_storage_size_in_g_bs number,
    max_db_node_storage_in_g_bs number,
    data_storage_size_in_t_bs number,
    max_data_storage_in_t_bs number,
    rack_serial_number varchar2,
    storage_count number,
    additional_storage_count number,
    activated_storage_count number,
    compute_count number,
    is_multi_rack_deployment number,
    multi_rack_configuration_file clob,
    additional_compute_count number,
    additional_compute_system_model varchar2,
    cloud_control_plane_server1 varchar2,
    cloud_control_plane_server2 varchar2,
    netmask varchar2,
    gateway varchar2,
    admin_network_cidr varchar2,
    infini_band_network_cidr varchar2,
    corporate_proxy varchar2,
    dns_server dbms_cloud_oci_database_varchar2_tbl,
    ntp_server dbms_cloud_oci_database_varchar2_tbl,
    time_created timestamp with time zone,
    lifecycle_details varchar2,
    csi_number varchar2,
    contacts dbms_cloud_oci_database_exadata_infrastructure_contact_tbl,
    maintenance_slo_status varchar2,
    maintenance_window dbms_cloud_oci_database_maintenance_window_t,
    storage_server_version varchar2,
    db_server_version varchar2,
    monthly_db_server_version varchar2,
    last_maintenance_run_id varchar2,
    next_maintenance_run_id varchar2,
    is_cps_offline_report_enabled number,
    network_bonding_mode_details dbms_cloud_oci_database_network_bonding_mode_details_t,
    availability_domain varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Exadata infrastructure.

compartment_id

(required) The OCID of the compartment.

lifecycle_state

(required) The current lifecycle state of the Exadata infrastructure.

Allowed values are: 'CREATING', 'REQUIRES_ACTIVATION', 'ACTIVATING', 'ACTIVE', 'ACTIVATION_FAILED', 'FAILED', 'UPDATING', 'DELETING', 'DELETED', 'DISCONNECTED', 'MAINTENANCE_IN_PROGRESS', 'WAITING_FOR_CONNECTIVITY'

display_name

(required) The user-friendly name for the Exadata Cloud@Customer infrastructure. The name does not need to be unique.

shape

(required) The shape of the Exadata infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance.

time_zone

(optional) The time zone of the Exadata infrastructure. For details, see Exadata Infrastructure Time Zones.

cpus_enabled

(optional) The number of enabled CPU cores.

max_cpu_count

(optional) The total number of CPU cores available.

memory_size_in_g_bs

(optional) The memory allocated in GBs.

max_memory_in_g_bs

(optional) The total memory available in GBs.

db_node_storage_size_in_g_bs

(optional) The local node storage allocated in GBs.

max_db_node_storage_in_g_bs

(optional) The total local node storage available in GBs.

data_storage_size_in_t_bs

(optional) Size, in terabytes, of the DATA disk group.

max_data_storage_in_t_bs

(optional) The total available DATA disk group size.

rack_serial_number

(optional) The serial number for the Exadata infrastructure.

storage_count

(optional) The number of Exadata storage servers for the Exadata infrastructure.

additional_storage_count

(optional) The requested number of additional storage servers for the Exadata infrastructure.

activated_storage_count

(optional) The requested number of additional storage servers activated for the Exadata infrastructure.

compute_count

(optional) The number of compute servers for the Exadata infrastructure.

is_multi_rack_deployment

(optional) Indicates if deployment is Multi-Rack or not.

multi_rack_configuration_file

(optional) The base64 encoded Multi-Rack configuration json file.

additional_compute_count

(optional) The requested number of additional compute servers for the Exadata infrastructure.

additional_compute_system_model

(optional) Oracle Exadata System Model specification. The system model determines the amount of compute or storage server resources available for use. For more information, please see System and Shape Configuration Options]

Allowed values are: 'X7', 'X8', 'X8M', 'X9M', 'X10M'

cloud_control_plane_server1

(optional) The IP address for the first control plane server.

cloud_control_plane_server2

(optional) The IP address for the second control plane server.

netmask

(optional) The netmask for the control plane network.

gateway

(optional) The gateway for the control plane network.

admin_network_cidr

(optional) The CIDR block for the Exadata administration network.

infini_band_network_cidr

(optional) The CIDR block for the Exadata InfiniBand interconnect.

corporate_proxy

(optional) The corporate network proxy for access to the control plane network.

dns_server

(optional) The list of DNS server IP addresses. Maximum of 3 allowed.

ntp_server

(optional) The list of NTP server IP addresses. Maximum of 3 allowed.

time_created

(optional) The date and time the Exadata infrastructure was created.

lifecycle_details

(optional) Additional information about the current lifecycle state.

csi_number

(optional) The CSI Number of the Exadata infrastructure.

contacts

(optional) The list of contacts for the Exadata infrastructure.

maintenance_slo_status

(optional) A field to capture ‘Maintenance SLO Status’ for the Exadata infrastructure with values ‘OK’, ‘DEGRADED’. Default is ‘OK’ when the infrastructure is provisioned.

Allowed values are: 'OK', 'DEGRADED'

maintenance_window

(optional)

storage_server_version

(optional) The software version of the storage servers (cells) in the Exadata infrastructure.

db_server_version

(optional) The software version of the database servers (dom0) in the Exadata infrastructure.

monthly_db_server_version

(optional) The monthly software version of the database servers (dom0) in the Exadata infrastructure.

last_maintenance_run_id

(optional) The OCID of the last maintenance run.

next_maintenance_run_id

(optional) The OCID of the next maintenance run.

is_cps_offline_report_enabled

(optional) Indicates whether cps offline diagnostic report is enabled for this Exadata infrastructure. This will allow a customer to quickly check status themselves and fix problems on their end, saving time and frustration for both Oracle and the customer when they find the CPS in a disconnected state.You can enable offline diagnostic report during Exadata infrastructure provisioning. You can also disable or enable it at any time using the UpdateExadatainfrastructure API.

network_bonding_mode_details

(optional)

availability_domain

(optional) The name of the availability domain that the Exadata infrastructure is located in.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_AUTONOMOUS_VM_CLUSTER_RESOURCE_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_database_autonomous_vm_cluster_resource_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_autonomous_vm_cluster_resource_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_autonomous_vm_cluster_resource_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_EXADATA_INFRASTRUCTURE_UN_ALLOCATED_RESOURCES_T Type

Un allocated resources details of the Exadata Cloud@Customer infrastructure. Applies to Exadata Cloud@Customer instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_exadata_infrastructure_un_allocated_resources_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  local_storage_in_gbs number,
  ocpus number,
  memory_in_g_bs number,
  exadata_storage_in_t_bs number,
  autonomous_vm_clusters dbms_cloud_oci_database_autonomous_vm_cluster_resource_details_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_exadata_infrastructure_un_allocated_resources_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_exadata_infrastructure_un_allocated_resources_t (
    id varchar2,
    display_name varchar2,
    local_storage_in_gbs number,
    ocpus number,
    memory_in_g_bs number,
    exadata_storage_in_t_bs number,
    autonomous_vm_clusters dbms_cloud_oci_database_autonomous_vm_cluster_resource_details_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Exadata infrastructure.

display_name

(required) The user-friendly name for the Exadata Cloud@Customer infrastructure. The name does not need to be unique.

local_storage_in_gbs

(optional) The minimum amount of un allocated storage that is available across all nodes in the infrastructure.

ocpus

(optional) The minimum amount of un allocated ocpus that is available across all nodes in the infrastructure.

memory_in_g_bs

(optional) The minimum amount of un allocated memory that is available across all nodes in the infrastructure.

exadata_storage_in_t_bs

(optional) Total unallocated exadata storage in the infrastructure in TBs.

autonomous_vm_clusters

(optional) The list of Autonomous VM Clusters on the Infra and their associated unallocated resources details

DBMS_CLOUD_OCI_DATABASE_DB_IORM_CONFIG_UPDATE_DETAIL_T Type

Details of the IORM configuration settings update request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_db_iorm_config_update_detail_t FORCE AUTHID CURRENT_USER IS OBJECT (
  db_name varchar2(32767),
  l_share number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_iorm_config_update_detail_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_db_iorm_config_update_detail_t (
    db_name varchar2,
    l_share number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

db_name

(optional) The database name. For the default `DbPlan`, the `dbName` is `default`.

l_share

(optional) The relative priority of this database.

DBMS_CLOUD_OCI_DATABASE_DB_IORM_CONFIG_UPDATE_DETAIL_TBL Type

Nested table type of dbms_cloud_oci_database_db_iorm_config_update_detail_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_db_iorm_config_update_detail_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_db_iorm_config_update_detail_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_EXADATA_IORM_CONFIG_UPDATE_DETAILS_T Type

IORM Setting details for this Exadata System to be updated

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_exadata_iorm_config_update_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  objective varchar2(32767),
  db_plans dbms_cloud_oci_database_db_iorm_config_update_detail_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_exadata_iorm_config_update_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_exadata_iorm_config_update_details_t (
    objective varchar2,
    db_plans dbms_cloud_oci_database_db_iorm_config_update_detail_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

objective

(optional) Value for the IORM objective Default is \"Auto\"

Allowed values are: 'LOW_LATENCY', 'HIGH_THROUGHPUT', 'BALANCED', 'AUTO', 'BASIC'

db_plans

(optional) Array of IORM Setting for all the database in this Exadata DB System

DBMS_CLOUD_OCI_DATABASE_EXTERNAL_BACKUP_JOB_T Type

Provides all the details that apply to an external backup job.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_external_backup_job_t FORCE AUTHID CURRENT_USER IS OBJECT (
  backup_id varchar2(32767),
  provisioning number,
  swift_path varchar2(32767),
  bucket_name varchar2(32767),
  tag varchar2(32767),
  user_name varchar2(32767),
  swift_password varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_external_backup_job_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_external_backup_job_t (
    backup_id varchar2,
    provisioning number,
    swift_path varchar2,
    bucket_name varchar2,
    tag varchar2,
    user_name varchar2,
    swift_password varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

backup_id

(required) The OCID of the associated backup resource.

provisioning

(required) An indicator for the provisioning state of the resource. If `TRUE`, the resource is still being provisioned.

swift_path

(required) The Swift path to use as a destination for the standalone backup.

bucket_name

(required) The name of the Swift compartment bucket where the backup should be stored.

tag

(required) The tag for RMAN to apply to the backup.

user_name

(required) The Swift user name to use for transferring the standalone backup to the designated Swift compartment bucket.

swift_password

(optional) The auth token to use for access to the Swift compartment bucket that will store the standalone backup. For information about auth tokens, see Working with Auth Tokens.

DBMS_CLOUD_OCI_DATABASE_STACK_MONITORING_CONFIG_T Type

The configuration of Stack Monitoring for the external database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_stack_monitoring_config_t FORCE AUTHID CURRENT_USER IS OBJECT (
  stack_monitoring_status varchar2(32767),
  stack_monitoring_connector_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_stack_monitoring_config_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_stack_monitoring_config_t (
    stack_monitoring_status varchar2,
    stack_monitoring_connector_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

stack_monitoring_status

(required) The status of Stack Monitoring.

Allowed values are: 'ENABLING', 'ENABLED', 'DISABLING', 'NOT_ENABLED', 'FAILED_ENABLING', 'FAILED_DISABLING'

stack_monitoring_connector_id

(optional) The OCID of the CREATE_EXTERNAL_DATABASE_CONNECTOR_DETAILS Function.

DBMS_CLOUD_OCI_DATABASE_EXTERNAL_CONTAINER_DATABASE_T Type

An Oracle Cloud Infrastructure resource that allows you to manage an external container database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_external_container_database_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  display_name varchar2(32767),
  id varchar2(32767),
  lifecycle_details varchar2(32767),
  lifecycle_state varchar2(32767),
  time_created timestamp with time zone,
  db_unique_name varchar2(32767),
  db_id varchar2(32767),
  database_version varchar2(32767),
  database_edition varchar2(32767),
  time_zone varchar2(32767),
  character_set varchar2(32767),
  ncharacter_set varchar2(32767),
  db_packs varchar2(32767),
  database_configuration varchar2(32767),
  database_management_config dbms_cloud_oci_database_database_management_config_t,
  stack_monitoring_config dbms_cloud_oci_database_stack_monitoring_config_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_external_container_database_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_external_container_database_t (
    compartment_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    display_name varchar2,
    id varchar2,
    lifecycle_details varchar2,
    lifecycle_state varchar2,
    time_created timestamp with time zone,
    db_unique_name varchar2,
    db_id varchar2,
    database_version varchar2,
    database_edition varchar2,
    time_zone varchar2,
    character_set varchar2,
    ncharacter_set varchar2,
    db_packs varchar2,
    database_configuration varchar2,
    database_management_config dbms_cloud_oci_database_database_management_config_t,
    stack_monitoring_config dbms_cloud_oci_database_stack_monitoring_config_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

display_name

(required) The user-friendly name for the external database. The name does not have to be unique.

id

(required) The OCID of the Oracle Cloud Infrastructure external database resource.

lifecycle_details

(optional) Additional information about the current lifecycle state.

lifecycle_state

(required) The current state of the Oracle Cloud Infrastructure external database resource.

Allowed values are: 'PROVISIONING', 'NOT_CONNECTED', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED'

time_created

(required) The date and time the database was created.

db_unique_name

(optional) The `DB_UNIQUE_NAME` of the external database.

db_id

(optional) The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud.

database_version

(optional) The Oracle Database version.

database_edition

(optional) The Oracle Database edition.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION', 'ENTERPRISE_EDITION_HIGH_PERFORMANCE', 'ENTERPRISE_EDITION_EXTREME_PERFORMANCE'

time_zone

(optional) The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered.

character_set

(optional) The character set of the external database.

ncharacter_set

(optional) The national character of the external database.

db_packs

(optional) The database packs licensed for the external Oracle Database.

database_configuration

(optional) The Oracle Database configuration

Allowed values are: 'RAC', 'SINGLE_INSTANCE'

database_management_config

(optional)

stack_monitoring_config

(optional)

DBMS_CLOUD_OCI_DATABASE_EXTERNAL_CONTAINER_DATABASE_SUMMARY_T Type

An Oracle Cloud Infrastructure resource that allows you to manage an external Oracle container database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_external_container_database_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  display_name varchar2(32767),
  id varchar2(32767),
  lifecycle_details varchar2(32767),
  lifecycle_state varchar2(32767),
  time_created timestamp with time zone,
  db_unique_name varchar2(32767),
  db_id varchar2(32767),
  database_version varchar2(32767),
  database_edition varchar2(32767),
  time_zone varchar2(32767),
  character_set varchar2(32767),
  ncharacter_set varchar2(32767),
  db_packs varchar2(32767),
  database_configuration varchar2(32767),
  database_management_config dbms_cloud_oci_database_database_management_config_t,
  stack_monitoring_config dbms_cloud_oci_database_stack_monitoring_config_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_external_container_database_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_external_container_database_summary_t (
    compartment_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    display_name varchar2,
    id varchar2,
    lifecycle_details varchar2,
    lifecycle_state varchar2,
    time_created timestamp with time zone,
    db_unique_name varchar2,
    db_id varchar2,
    database_version varchar2,
    database_edition varchar2,
    time_zone varchar2,
    character_set varchar2,
    ncharacter_set varchar2,
    db_packs varchar2,
    database_configuration varchar2,
    database_management_config dbms_cloud_oci_database_database_management_config_t,
    stack_monitoring_config dbms_cloud_oci_database_stack_monitoring_config_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

display_name

(required) The user-friendly name for the external database. The name does not have to be unique.

id

(required) The OCID of the Oracle Cloud Infrastructure external database resource.

lifecycle_details

(optional) Additional information about the current lifecycle state.

lifecycle_state

(required) The current state of the Oracle Cloud Infrastructure external database resource.

Allowed values are: 'PROVISIONING', 'NOT_CONNECTED', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED'

time_created

(required) The date and time the database was created.

db_unique_name

(optional) The `DB_UNIQUE_NAME` of the external database.

db_id

(optional) The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud.

database_version

(optional) The Oracle Database version.

database_edition

(optional) The Oracle Database edition.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION', 'ENTERPRISE_EDITION_HIGH_PERFORMANCE', 'ENTERPRISE_EDITION_EXTREME_PERFORMANCE'

time_zone

(optional) The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered.

character_set

(optional) The character set of the external database.

ncharacter_set

(optional) The national character of the external database.

db_packs

(optional) The database packs licensed for the external Oracle Database.

database_configuration

(optional) The Oracle Database configuration

Allowed values are: 'RAC', 'SINGLE_INSTANCE'

database_management_config

(optional)

stack_monitoring_config

(optional)

DBMS_CLOUD_OCI_DATABASE_EXTERNAL_DATABASE_BASE_T Type

A resource that allows you to manage an Oracle Database located outside of Oracle Cloud using Oracle Cloud Infrastructure's Console and APIs.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_external_database_base_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  display_name varchar2(32767),
  id varchar2(32767),
  lifecycle_details varchar2(32767),
  lifecycle_state varchar2(32767),
  time_created timestamp with time zone,
  db_unique_name varchar2(32767),
  db_id varchar2(32767),
  database_version varchar2(32767),
  database_edition varchar2(32767),
  time_zone varchar2(32767),
  character_set varchar2(32767),
  ncharacter_set varchar2(32767),
  db_packs varchar2(32767),
  database_configuration varchar2(32767),
  database_management_config dbms_cloud_oci_database_database_management_config_t,
  stack_monitoring_config dbms_cloud_oci_database_stack_monitoring_config_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_external_database_base_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_external_database_base_t (
    compartment_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    display_name varchar2,
    id varchar2,
    lifecycle_details varchar2,
    lifecycle_state varchar2,
    time_created timestamp with time zone,
    db_unique_name varchar2,
    db_id varchar2,
    database_version varchar2,
    database_edition varchar2,
    time_zone varchar2,
    character_set varchar2,
    ncharacter_set varchar2,
    db_packs varchar2,
    database_configuration varchar2,
    database_management_config dbms_cloud_oci_database_database_management_config_t,
    stack_monitoring_config dbms_cloud_oci_database_stack_monitoring_config_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

display_name

(required) The user-friendly name for the external database. The name does not have to be unique.

id

(required) The OCID of the Oracle Cloud Infrastructure external database resource.

lifecycle_details

(optional) Additional information about the current lifecycle state.

lifecycle_state

(required) The current state of the Oracle Cloud Infrastructure external database resource.

Allowed values are: 'PROVISIONING', 'NOT_CONNECTED', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED'

time_created

(required) The date and time the database was created.

db_unique_name

(optional) The `DB_UNIQUE_NAME` of the external database.

db_id

(optional) The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud.

database_version

(optional) The Oracle Database version.

database_edition

(optional) The Oracle Database edition.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION', 'ENTERPRISE_EDITION_HIGH_PERFORMANCE', 'ENTERPRISE_EDITION_EXTREME_PERFORMANCE'

time_zone

(optional) The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered.

character_set

(optional) The character set of the external database.

ncharacter_set

(optional) The national character of the external database.

db_packs

(optional) The database packs licensed for the external Oracle Database.

database_configuration

(optional) The Oracle Database configuration

Allowed values are: 'RAC', 'SINGLE_INSTANCE'

database_management_config

(optional)

stack_monitoring_config

(optional)

DBMS_CLOUD_OCI_DATABASE_EXTERNAL_DATABASE_CONNECTOR_T Type

An Oracle Cloud Infrastructure resource used to connect to an external Oracle Database. This resource stores the database connection string, user credentials, and related details that allow you to manage your external database using the Oracle Cloud Infrastructure Console and API interfaces.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_external_database_connector_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  display_name varchar2(32767),
  id varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_created timestamp with time zone,
  connector_type varchar2(32767),
  external_database_id varchar2(32767),
  connection_status varchar2(32767),
  time_connection_status_last_updated timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_external_database_connector_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_external_database_connector_t (
    compartment_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    display_name varchar2,
    id varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_created timestamp with time zone,
    connector_type varchar2,
    external_database_id varchar2,
    connection_status varchar2,
    time_connection_status_last_updated timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

compartment_id

(required) The OCID of the compartment.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

display_name

(required) The user-friendly name for the CREATE_EXTERNAL_DATABASE_CONNECTOR_DETAILS Function. The name does not have to be unique.

id

(required) The OCID of the CREATE_EXTERNAL_DATABASE_CONNECTOR_DETAILS Function.

lifecycle_state

(required) The current lifecycle state of the external database connector resource.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED'

lifecycle_details

(optional) Additional information about the current lifecycle state.

time_created

(required) The date and time the external connector was created.

connector_type

(required) The type of connector used by the external database resource.

Allowed values are: 'MACS'

external_database_id

(required) The OCID of the external database resource.

connection_status

(required) The status of connectivity to the external database.

time_connection_status_last_updated

(required) The date and time the connectionStatus of this external connector was last updated.

DBMS_CLOUD_OCI_DATABASE_EXTERNAL_DATABASE_CONNECTOR_SUMMARY_T Type

An Oracle Cloud Infrastructure resource used to connect to an external Oracle Database. This resource stores the database connection string, user credentials, and related details that allow you to manage your external database using the Oracle Cloud Infrastructure Console and API interfaces.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_external_database_connector_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  display_name varchar2(32767),
  id varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_created timestamp with time zone,
  connector_type varchar2(32767),
  external_database_id varchar2(32767),
  connection_status varchar2(32767),
  time_connection_status_last_updated timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_external_database_connector_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_external_database_connector_summary_t (
    compartment_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    display_name varchar2,
    id varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_created timestamp with time zone,
    connector_type varchar2,
    external_database_id varchar2,
    connection_status varchar2,
    time_connection_status_last_updated timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

compartment_id

(required) The OCID of the compartment.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

display_name

(required) The user-friendly name for the CREATE_EXTERNAL_DATABASE_CONNECTOR_DETAILS Function. The name does not have to be unique.

id

(required) The OCID of the CREATE_EXTERNAL_DATABASE_CONNECTOR_DETAILS Function.

lifecycle_state

(required) The current lifecycle state of the external database connector resource.

lifecycle_details

(optional) Additional information about the current lifecycle state.

time_created

(required) The date and time the external connector was created.

connector_type

(required) The type of connector used by the external database resource.

Allowed values are: 'MACS'

external_database_id

(required) The OCID of the external database resource.

connection_status

(required) The status of connectivity to the external database.

time_connection_status_last_updated

(required) The date and time the `connectionStatus` of this external connector was last updated.

DBMS_CLOUD_OCI_DATABASE_EXTERNAL_MACS_CONNECTOR_T Type

An Oracle Cloud Infrastructure resource that uses the Management Agent cloud service (MACS) to connect to an external Oracle Database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_external_macs_connector_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_external_database_connector_t (
  connection_string dbms_cloud_oci_database_database_connection_string_t,
  connection_credentials dbms_cloud_oci_database_database_connection_credentials_t,
  connector_agent_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_external_macs_connector_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_external_macs_connector_t (
    compartment_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    display_name varchar2,
    id varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_created timestamp with time zone,
    connector_type varchar2,
    external_database_id varchar2,
    connection_status varchar2,
    time_connection_status_last_updated timestamp with time zone,
    connection_string dbms_cloud_oci_database_database_connection_string_t,
    connection_credentials dbms_cloud_oci_database_database_connection_credentials_t,
    connector_agent_id varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_external_macs_connector_t is a subtype of the dbms_cloud_oci_database_external_database_connector_t type.

Fields

Field Description

connection_string

(required)

connection_credentials

(required)

connector_agent_id

(required) The ID of the agent used for the CREATE_EXTERNAL_DATABASE_CONNECTOR_DETAILS Function.

DBMS_CLOUD_OCI_DATABASE_EXTERNAL_MACS_CONNECTOR_SUMMARY_T Type

An Oracle Cloud Infrastructure resource that uses the Management Agent cloud service (MACS) to connect to an external Oracle Database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_external_macs_connector_summary_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_external_database_connector_summary_t (
  connection_string dbms_cloud_oci_database_database_connection_string_t,
  connection_credentials dbms_cloud_oci_database_database_connection_credentials_t,
  connector_agent_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_external_macs_connector_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_external_macs_connector_summary_t (
    compartment_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    display_name varchar2,
    id varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_created timestamp with time zone,
    connector_type varchar2,
    external_database_id varchar2,
    connection_status varchar2,
    time_connection_status_last_updated timestamp with time zone,
    connection_string dbms_cloud_oci_database_database_connection_string_t,
    connection_credentials dbms_cloud_oci_database_database_connection_credentials_t,
    connector_agent_id varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_external_macs_connector_summary_t is a subtype of the dbms_cloud_oci_database_external_database_connector_summary_t type.

Fields

Field Description

connection_string

(required)

connection_credentials

(required)

connector_agent_id

(required) The ID of the agent used for the CREATE_EXTERNAL_DATABASE_CONNECTOR_DETAILS Function.

DBMS_CLOUD_OCI_DATABASE_OPERATIONS_INSIGHTS_CONFIG_T Type

The configuration of Operations Insights for the external database

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_operations_insights_config_t FORCE AUTHID CURRENT_USER IS OBJECT (
  operations_insights_status varchar2(32767),
  operations_insights_connector_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_operations_insights_config_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_operations_insights_config_t (
    operations_insights_status varchar2,
    operations_insights_connector_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

operations_insights_status

(required) The status of Operations Insights

Allowed values are: 'ENABLING', 'ENABLED', 'DISABLING', 'NOT_ENABLED', 'FAILED_ENABLING', 'FAILED_DISABLING'

operations_insights_connector_id

(optional) The OCID of the CREATE_EXTERNAL_DATABASE_CONNECTOR_DETAILS Function.

DBMS_CLOUD_OCI_DATABASE_EXTERNAL_NON_CONTAINER_DATABASE_T Type

an external Oracle non-container database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_external_non_container_database_t FORCE AUTHID CURRENT_USER IS OBJECT (
  operations_insights_config dbms_cloud_oci_database_operations_insights_config_t,
  compartment_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  display_name varchar2(32767),
  id varchar2(32767),
  lifecycle_details varchar2(32767),
  lifecycle_state varchar2(32767),
  time_created timestamp with time zone,
  db_unique_name varchar2(32767),
  db_id varchar2(32767),
  database_version varchar2(32767),
  database_edition varchar2(32767),
  time_zone varchar2(32767),
  character_set varchar2(32767),
  ncharacter_set varchar2(32767),
  db_packs varchar2(32767),
  database_configuration varchar2(32767),
  database_management_config dbms_cloud_oci_database_database_management_config_t,
  stack_monitoring_config dbms_cloud_oci_database_stack_monitoring_config_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_external_non_container_database_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_external_non_container_database_t (
    operations_insights_config dbms_cloud_oci_database_operations_insights_config_t,
    compartment_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    display_name varchar2,
    id varchar2,
    lifecycle_details varchar2,
    lifecycle_state varchar2,
    time_created timestamp with time zone,
    db_unique_name varchar2,
    db_id varchar2,
    database_version varchar2,
    database_edition varchar2,
    time_zone varchar2,
    character_set varchar2,
    ncharacter_set varchar2,
    db_packs varchar2,
    database_configuration varchar2,
    database_management_config dbms_cloud_oci_database_database_management_config_t,
    stack_monitoring_config dbms_cloud_oci_database_stack_monitoring_config_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

operations_insights_config

(optional)

compartment_id

(required) The OCID of the compartment.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

display_name

(required) The user-friendly name for the external database. The name does not have to be unique.

id

(required) The OCID of the Oracle Cloud Infrastructure external database resource.

lifecycle_details

(optional) Additional information about the current lifecycle state.

lifecycle_state

(required) The current state of the Oracle Cloud Infrastructure external database resource.

Allowed values are: 'PROVISIONING', 'NOT_CONNECTED', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED'

time_created

(required) The date and time the database was created.

db_unique_name

(optional) The `DB_UNIQUE_NAME` of the external database.

db_id

(optional) The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud.

database_version

(optional) The Oracle Database version.

database_edition

(optional) The Oracle Database edition.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION', 'ENTERPRISE_EDITION_HIGH_PERFORMANCE', 'ENTERPRISE_EDITION_EXTREME_PERFORMANCE'

time_zone

(optional) The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered.

character_set

(optional) The character set of the external database.

ncharacter_set

(optional) The national character of the external database.

db_packs

(optional) The database packs licensed for the external Oracle Database.

database_configuration

(optional) The Oracle Database configuration

Allowed values are: 'RAC', 'SINGLE_INSTANCE'

database_management_config

(optional)

stack_monitoring_config

(optional)

DBMS_CLOUD_OCI_DATABASE_EXTERNAL_NON_CONTAINER_DATABASE_SUMMARY_T Type

An Oracle Cloud Infrastructure external non-container database resource. This resource is used to manage a non-container database located outside of Oracle Cloud.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_external_non_container_database_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  operations_insights_config dbms_cloud_oci_database_operations_insights_config_t,
  compartment_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  display_name varchar2(32767),
  id varchar2(32767),
  lifecycle_details varchar2(32767),
  lifecycle_state varchar2(32767),
  time_created timestamp with time zone,
  db_unique_name varchar2(32767),
  db_id varchar2(32767),
  database_version varchar2(32767),
  database_edition varchar2(32767),
  time_zone varchar2(32767),
  character_set varchar2(32767),
  ncharacter_set varchar2(32767),
  db_packs varchar2(32767),
  database_configuration varchar2(32767),
  database_management_config dbms_cloud_oci_database_database_management_config_t,
  stack_monitoring_config dbms_cloud_oci_database_stack_monitoring_config_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_external_non_container_database_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_external_non_container_database_summary_t (
    operations_insights_config dbms_cloud_oci_database_operations_insights_config_t,
    compartment_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    display_name varchar2,
    id varchar2,
    lifecycle_details varchar2,
    lifecycle_state varchar2,
    time_created timestamp with time zone,
    db_unique_name varchar2,
    db_id varchar2,
    database_version varchar2,
    database_edition varchar2,
    time_zone varchar2,
    character_set varchar2,
    ncharacter_set varchar2,
    db_packs varchar2,
    database_configuration varchar2,
    database_management_config dbms_cloud_oci_database_database_management_config_t,
    stack_monitoring_config dbms_cloud_oci_database_stack_monitoring_config_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

operations_insights_config

(optional)

compartment_id

(required) The OCID of the compartment.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

display_name

(required) The user-friendly name for the external database. The name does not have to be unique.

id

(required) The OCID of the Oracle Cloud Infrastructure external database resource.

lifecycle_details

(optional) Additional information about the current lifecycle state.

lifecycle_state

(required) The current state of the Oracle Cloud Infrastructure external database resource.

Allowed values are: 'PROVISIONING', 'NOT_CONNECTED', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED'

time_created

(required) The date and time the database was created.

db_unique_name

(optional) The `DB_UNIQUE_NAME` of the external database.

db_id

(optional) The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud.

database_version

(optional) The Oracle Database version.

database_edition

(optional) The Oracle Database edition.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION', 'ENTERPRISE_EDITION_HIGH_PERFORMANCE', 'ENTERPRISE_EDITION_EXTREME_PERFORMANCE'

time_zone

(optional) The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered.

character_set

(optional) The character set of the external database.

ncharacter_set

(optional) The national character of the external database.

db_packs

(optional) The database packs licensed for the external Oracle Database.

database_configuration

(optional) The Oracle Database configuration

Allowed values are: 'RAC', 'SINGLE_INSTANCE'

database_management_config

(optional)

stack_monitoring_config

(optional)

DBMS_CLOUD_OCI_DATABASE_EXTERNAL_PLUGGABLE_DATABASE_T Type

an external Oracle pluggable database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_external_pluggable_database_t FORCE AUTHID CURRENT_USER IS OBJECT (
  source_id varchar2(32767),
  external_container_database_id varchar2(32767),
  operations_insights_config dbms_cloud_oci_database_operations_insights_config_t,
  compartment_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  display_name varchar2(32767),
  id varchar2(32767),
  lifecycle_details varchar2(32767),
  lifecycle_state varchar2(32767),
  time_created timestamp with time zone,
  db_unique_name varchar2(32767),
  db_id varchar2(32767),
  database_version varchar2(32767),
  database_edition varchar2(32767),
  time_zone varchar2(32767),
  character_set varchar2(32767),
  ncharacter_set varchar2(32767),
  db_packs varchar2(32767),
  database_configuration varchar2(32767),
  database_management_config dbms_cloud_oci_database_database_management_config_t,
  stack_monitoring_config dbms_cloud_oci_database_stack_monitoring_config_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_external_pluggable_database_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_external_pluggable_database_t (
    source_id varchar2,
    external_container_database_id varchar2,
    operations_insights_config dbms_cloud_oci_database_operations_insights_config_t,
    compartment_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    display_name varchar2,
    id varchar2,
    lifecycle_details varchar2,
    lifecycle_state varchar2,
    time_created timestamp with time zone,
    db_unique_name varchar2,
    db_id varchar2,
    database_version varchar2,
    database_edition varchar2,
    time_zone varchar2,
    character_set varchar2,
    ncharacter_set varchar2,
    db_packs varchar2,
    database_configuration varchar2,
    database_management_config dbms_cloud_oci_database_database_management_config_t,
    stack_monitoring_config dbms_cloud_oci_database_stack_monitoring_config_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

source_id

(optional) The OCID of the the non-container database that was converted to a pluggable database to create this resource.

external_container_database_id

(required) The OCID of the CREATE_EXTERNAL_CONTAINER_DATABASE_DETAILS Function that contains the specified CREATE_EXTERNAL_PLUGGABLE_DATABASE_DETAILS Function resource.

operations_insights_config

(optional)

compartment_id

(required) The OCID of the compartment.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

display_name

(required) The user-friendly name for the external database. The name does not have to be unique.

id

(required) The OCID of the Oracle Cloud Infrastructure external database resource.

lifecycle_details

(optional) Additional information about the current lifecycle state.

lifecycle_state

(required) The current state of the Oracle Cloud Infrastructure external database resource.

Allowed values are: 'PROVISIONING', 'NOT_CONNECTED', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED'

time_created

(required) The date and time the database was created.

db_unique_name

(optional) The `DB_UNIQUE_NAME` of the external database.

db_id

(optional) The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud.

database_version

(optional) The Oracle Database version.

database_edition

(optional) The Oracle Database edition.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION', 'ENTERPRISE_EDITION_HIGH_PERFORMANCE', 'ENTERPRISE_EDITION_EXTREME_PERFORMANCE'

time_zone

(optional) The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered.

character_set

(optional) The character set of the external database.

ncharacter_set

(optional) The national character of the external database.

db_packs

(optional) The database packs licensed for the external Oracle Database.

database_configuration

(optional) The Oracle Database configuration

Allowed values are: 'RAC', 'SINGLE_INSTANCE'

database_management_config

(optional)

stack_monitoring_config

(optional)

DBMS_CLOUD_OCI_DATABASE_EXTERNAL_PLUGGABLE_DATABASE_SUMMARY_T Type

An Oracle Cloud Infrastructure resource that allows you to manage an external pluggable database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_external_pluggable_database_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  source_id varchar2(32767),
  external_container_database_id varchar2(32767),
  operations_insights_config dbms_cloud_oci_database_operations_insights_config_t,
  compartment_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  display_name varchar2(32767),
  id varchar2(32767),
  lifecycle_details varchar2(32767),
  lifecycle_state varchar2(32767),
  time_created timestamp with time zone,
  db_unique_name varchar2(32767),
  db_id varchar2(32767),
  database_version varchar2(32767),
  database_edition varchar2(32767),
  time_zone varchar2(32767),
  character_set varchar2(32767),
  ncharacter_set varchar2(32767),
  db_packs varchar2(32767),
  database_configuration varchar2(32767),
  database_management_config dbms_cloud_oci_database_database_management_config_t,
  stack_monitoring_config dbms_cloud_oci_database_stack_monitoring_config_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_external_pluggable_database_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_external_pluggable_database_summary_t (
    source_id varchar2,
    external_container_database_id varchar2,
    operations_insights_config dbms_cloud_oci_database_operations_insights_config_t,
    compartment_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    display_name varchar2,
    id varchar2,
    lifecycle_details varchar2,
    lifecycle_state varchar2,
    time_created timestamp with time zone,
    db_unique_name varchar2,
    db_id varchar2,
    database_version varchar2,
    database_edition varchar2,
    time_zone varchar2,
    character_set varchar2,
    ncharacter_set varchar2,
    db_packs varchar2,
    database_configuration varchar2,
    database_management_config dbms_cloud_oci_database_database_management_config_t,
    stack_monitoring_config dbms_cloud_oci_database_stack_monitoring_config_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

source_id

(optional) The OCID of the the non-container database that was converted to a pluggable database to create this resource.

external_container_database_id

(required) The OCID of the CREATE_EXTERNAL_CONTAINER_DATABASE_DETAILS Function that contains the specified CREATE_EXTERNAL_PLUGGABLE_DATABASE_DETAILS Function resource.

operations_insights_config

(optional)

compartment_id

(required) The OCID of the compartment.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

display_name

(required) The user-friendly name for the external database. The name does not have to be unique.

id

(required) The OCID of the Oracle Cloud Infrastructure external database resource.

lifecycle_details

(optional) Additional information about the current lifecycle state.

lifecycle_state

(required) The current state of the Oracle Cloud Infrastructure external database resource.

Allowed values are: 'PROVISIONING', 'NOT_CONNECTED', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED'

time_created

(required) The date and time the database was created.

db_unique_name

(optional) The `DB_UNIQUE_NAME` of the external database.

db_id

(optional) The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud.

database_version

(optional) The Oracle Database version.

database_edition

(optional) The Oracle Database edition.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION', 'ENTERPRISE_EDITION_HIGH_PERFORMANCE', 'ENTERPRISE_EDITION_EXTREME_PERFORMANCE'

time_zone

(optional) The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered.

character_set

(optional) The character set of the external database.

ncharacter_set

(optional) The national character of the external database.

db_packs

(optional) The database packs licensed for the external Oracle Database.

database_configuration

(optional) The Oracle Database configuration

Allowed values are: 'RAC', 'SINGLE_INSTANCE'

database_management_config

(optional)

stack_monitoring_config

(optional)

DBMS_CLOUD_OCI_DATABASE_FAILOVER_DATA_GUARD_ASSOCIATION_DETAILS_T Type

The Data Guard association failover parameters.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_failover_data_guard_association_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  database_admin_password varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_failover_data_guard_association_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_failover_data_guard_association_details_t (
    database_admin_password varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

database_admin_password

(required) The DB system administrator password.

DBMS_CLOUD_OCI_DATABASE_FLEX_COMPONENT_SUMMARY_T Type

The Flex Components for a DB system. The Flex Component determines resources to allocate to the DB system - CPU cores, memory and storage for Flex shapes. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_flex_component_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  minimum_core_count number,
  available_core_count number,
  available_db_storage_in_g_bs number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_flex_component_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_flex_component_summary_t (
    name varchar2,
    minimum_core_count number,
    available_core_count number,
    available_db_storage_in_g_bs number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) The name of the Flex Component used for the DB system.

minimum_core_count

(optional) The minimum number of CPU cores that can be enabled on the DB Server for this Flex Component.

available_core_count

(optional) The maximum number of CPU cores that can ben enabled on the DB Server for this Flex Component.

available_db_storage_in_g_bs

(optional) The maximum storage that can be enabled on the Storage Server for this Flex Component.

DBMS_CLOUD_OCI_DATABASE_FLEX_COMPONENT_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_database_flex_component_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_flex_component_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_flex_component_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_FLEX_COMPONENT_COLLECTION_T Type

Results of a FlexComponent lists. Contains FlexComponentSummary items.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_flex_component_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_database_flex_component_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_flex_component_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_flex_component_collection_t (
    items dbms_cloud_oci_database_flex_component_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required)

DBMS_CLOUD_OCI_DATABASE_GENERATE_AUTONOMOUS_DATABASE_WALLET_DETAILS_T Type

Details to create and download an Oracle Autonomous Database wallet.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_generate_autonomous_database_wallet_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  generate_type varchar2(32767),
  password varchar2(32767),
  is_regional number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_generate_autonomous_database_wallet_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_generate_autonomous_database_wallet_details_t (
    generate_type varchar2,
    password varchar2,
    is_regional number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

generate_type

(optional) 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.

Allowed values are: 'ALL', 'SINGLE'

password

(required) 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.

is_regional

(optional) True when requesting regional connection strings in PDB connect info, applicable to cross-region DG only.

DBMS_CLOUD_OCI_DATABASE_INFO_FOR_NETWORK_GEN_DETAILS_T Type

Parameters for generation of the client or backup network in a VM cluster network in an Exadata Cloud@Customer system.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_info_for_network_gen_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  network_type varchar2(32767),
  vlan_id varchar2(32767),
  cidr varchar2(32767),
  gateway varchar2(32767),
  netmask varchar2(32767),
  domain varchar2(32767),
  prefix varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_info_for_network_gen_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_info_for_network_gen_details_t (
    network_type varchar2,
    vlan_id varchar2,
    cidr varchar2,
    gateway varchar2,
    netmask varchar2,
    domain varchar2,
    prefix varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

network_type

(required) The network type.

Allowed values are: 'CLIENT', 'BACKUP', 'DISASTER_RECOVERY'

vlan_id

(required) The network VLAN ID.

cidr

(required) The cidr for the network.

gateway

(required) The network gateway.

netmask

(required) The network netmask.

domain

(required) The network domain name.

prefix

(required) The network domain name.

DBMS_CLOUD_OCI_DATABASE_INFO_FOR_NETWORK_GEN_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_database_info_for_network_gen_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_info_for_network_gen_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_info_for_network_gen_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_GENERATE_RECOMMENDED_NETWORK_DETAILS_T Type

Generates a recommended VM cluster network configuration for an Exadata Cloud@Customer system. Applies to Exadata Cloud@Customer instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_generate_recommended_network_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  db_servers dbms_cloud_oci_database_varchar2_tbl,
  scan_listener_port_tcp number,
  scan_listener_port_tcp_ssl number,
  dr_scan_listener_port_tcp number,
  networks dbms_cloud_oci_database_info_for_network_gen_details_tbl,
  dns dbms_cloud_oci_database_varchar2_tbl,
  ntp dbms_cloud_oci_database_varchar2_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_generate_recommended_network_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_generate_recommended_network_details_t (
    compartment_id varchar2,
    display_name varchar2,
    db_servers dbms_cloud_oci_database_varchar2_tbl,
    scan_listener_port_tcp number,
    scan_listener_port_tcp_ssl number,
    dr_scan_listener_port_tcp number,
    networks dbms_cloud_oci_database_info_for_network_gen_details_tbl,
    dns dbms_cloud_oci_database_varchar2_tbl,
    ntp dbms_cloud_oci_database_varchar2_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment.

display_name

(required) The user-friendly name for the VM cluster network. The name does not need to be unique.

db_servers

(optional) The list of Db server Ids to configure network.

scan_listener_port_tcp

(optional) The SCAN TCPIP port. Default is 1521.

scan_listener_port_tcp_ssl

(optional) The SCAN TCPIP SSL port. Default is 2484.

dr_scan_listener_port_tcp

(optional) The DR SCAN TCPIP port. Default is 1521.

networks

(required) List of parameters for generation of the client and backup networks.

dns

(optional) The list of DNS server IP addresses. Maximum of 3 allowed.

ntp

(optional) The list of NTP server IP addresses. Maximum of 3 allowed.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_GI_VERSION_SUMMARY_T Type

The Oracle Grid Infrastructure (GI) version. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_gi_version_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  version varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_gi_version_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_gi_version_summary_t (
    version varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

version

(required) A valid Oracle Grid Infrastructure (GI) software version.

DBMS_CLOUD_OCI_DATABASE_INFRASTRUCTURE_TARGET_VERSION_T Type

Infrastructure target version details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_infrastructure_target_version_t FORCE AUTHID CURRENT_USER IS OBJECT (
  target_db_version_history_entry dbms_cloud_oci_database_varchar2_tbl,
  target_storage_version_history_entry dbms_cloud_oci_database_varchar2_tbl,
  target_resource_type varchar2(32767),
  target_resource_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_infrastructure_target_version_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_infrastructure_target_version_t (
    target_db_version_history_entry dbms_cloud_oci_database_varchar2_tbl,
    target_storage_version_history_entry dbms_cloud_oci_database_varchar2_tbl,
    target_resource_type varchar2,
    target_resource_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

target_db_version_history_entry

(required) The history entry of the target system software version for the database server patching operation.

target_storage_version_history_entry

(required) The history entry of the target storage cell system software version for the storage cell patching operation.

target_resource_type

(optional) The resource type of the target Exadata infrastructure resource that will receive the system software update.

Allowed values are: 'EXADATA_DB_SYSTEM', 'CLOUD_EXADATA_INFRASTRUCTURE', 'EXACC_INFRASTRUCTURE'

target_resource_id

(optional) The OCID of the target Exadata Infrastructure resource that will receive the maintenance update.

DBMS_CLOUD_OCI_DATABASE_INFRASTRUCTURE_TARGET_VERSION_SUMMARY_T Type

The target Exadata Infrastructure system software version for an infrastructure resource. Applies to Exadata Cloud@Customer and Exadata Cloud instances only. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_infrastructure_target_version_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  target_db_version_history_entry dbms_cloud_oci_database_varchar2_tbl,
  target_storage_version_history_entry dbms_cloud_oci_database_varchar2_tbl,
  target_resource_type varchar2(32767),
  target_resource_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_infrastructure_target_version_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_infrastructure_target_version_summary_t (
    target_db_version_history_entry dbms_cloud_oci_database_varchar2_tbl,
    target_storage_version_history_entry dbms_cloud_oci_database_varchar2_tbl,
    target_resource_type varchar2,
    target_resource_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

target_db_version_history_entry

(required) The history entry of the target system software version for the database server patching operation.

target_storage_version_history_entry

(required) The history entry of the target storage cell system software version for the storage cell patching operation.

target_resource_type

(optional) The resource type of the target Exadata infrastructure resource that will receive the system software update.

Allowed values are: 'EXADATA_DB_SYSTEM', 'CLOUD_EXADATA_INFRASTRUCTURE', 'EXACC_INFRASTRUCTURE'

target_resource_id

(optional) The OCID of the target Exadata Infrastructure resource that will receive the maintenance update.

DBMS_CLOUD_OCI_DATABASE_KEY_STORE_ASSOCIATED_DATABASE_DETAILS_T Type

The databases associated with a key store

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_key_store_associated_database_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  db_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_key_store_associated_database_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_key_store_associated_database_details_t (
    id varchar2,
    db_name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) The database OCID.

db_name

(optional) The name of the database that is associated with the key store.

DBMS_CLOUD_OCI_DATABASE_KEY_STORE_ASSOCIATED_DATABASE_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_database_key_store_associated_database_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_key_store_associated_database_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_key_store_associated_database_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_KEY_STORE_T Type

A key store to connect to an on-premise encryption key appliance like Oracle Key Vault.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_key_store_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  time_created timestamp with time zone,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  type_details dbms_cloud_oci_database_key_store_type_details_t,
  associated_databases dbms_cloud_oci_database_key_store_associated_database_details_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_key_store_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_key_store_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    time_created timestamp with time zone,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    type_details dbms_cloud_oci_database_key_store_type_details_t,
    associated_databases dbms_cloud_oci_database_key_store_associated_database_details_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the key store.

compartment_id

(required) The OCID of the compartment.

display_name

(required) The user-friendly name for the key store. The name does not need to be unique.

time_created

(optional) The date and time that the key store was created.

lifecycle_state

(required) The current state of the key store.

Allowed values are: 'ACTIVE', 'DELETED'

lifecycle_details

(optional) Additional information about the current lifecycle state.

type_details

(required)

associated_databases

(optional) List of databases associated with the key store.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_KEY_STORE_SUMMARY_T Type

Details of the Key Store.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_key_store_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  time_created timestamp with time zone,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  type_details dbms_cloud_oci_database_key_store_type_details_t,
  associated_databases dbms_cloud_oci_database_key_store_associated_database_details_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_key_store_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_key_store_summary_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    time_created timestamp with time zone,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    type_details dbms_cloud_oci_database_key_store_type_details_t,
    associated_databases dbms_cloud_oci_database_key_store_associated_database_details_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the key store.

compartment_id

(required) The OCID of the compartment.

display_name

(required) The user-friendly name for the key store. The name does not need to be unique.

time_created

(optional) The date and time that the key store was created.

lifecycle_state

(required) The current state of the key store.

Allowed values are: 'ACTIVE', 'DELETED'

lifecycle_details

(optional) Additional information about the current lifecycle state.

type_details

(required)

associated_databases

(optional) List of databases associated with the key store.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_KEY_STORE_TYPE_FROM_ORACLE_KEY_VAULT_DETAILS_T Type

Details for Oracle Key Vault

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_key_store_type_from_oracle_key_vault_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_key_store_type_details_t (
  connection_ips dbms_cloud_oci_database_varchar2_tbl,
  admin_username varchar2(32767),
  vault_id varchar2(32767),
  secret_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_key_store_type_from_oracle_key_vault_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_key_store_type_from_oracle_key_vault_details_t (
    l_type varchar2,
    connection_ips dbms_cloud_oci_database_varchar2_tbl,
    admin_username varchar2,
    vault_id varchar2,
    secret_id varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_key_store_type_from_oracle_key_vault_details_t is a subtype of the dbms_cloud_oci_database_key_store_type_details_t type.

Fields

Field Description

connection_ips

(required) The list of Oracle Key Vault connection IP addresses.

admin_username

(required) The administrator username to connect to Oracle Key Vault

vault_id

(required) The OCID of the Oracle Cloud Infrastructure vault.

secret_id

(required) The OCID of the Oracle Cloud Infrastructure secret.

DBMS_CLOUD_OCI_DATABASE_LAUNCH_AUTONOMOUS_EXADATA_INFRASTRUCTURE_DETAILS_T Type

Describes the input parameters to launch a new Autonomous Exadata Infrastructure.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_launch_autonomous_exadata_infrastructure_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  availability_domain varchar2(32767),
  subnet_id varchar2(32767),
  nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  shape varchar2(32767),
  domain varchar2(32767),
  license_model varchar2(32767),
  maintenance_window_details dbms_cloud_oci_database_maintenance_window_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_launch_autonomous_exadata_infrastructure_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_launch_autonomous_exadata_infrastructure_details_t (
    compartment_id varchar2,
    display_name varchar2,
    availability_domain varchar2,
    subnet_id varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    shape varchar2,
    domain varchar2,
    license_model varchar2,
    maintenance_window_details dbms_cloud_oci_database_maintenance_window_t,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment the Autonomous Exadata Infrastructure belongs in.

display_name

(optional) The user-friendly name for the Autonomous Exadata Infrastructure. It does not have to be unique.

availability_domain

(required) The availability domain where the Autonomous Exadata Infrastructure is located.

subnet_id

(required) The OCID of the subnet the Autonomous Exadata Infrastructure is associated with. **Subnet Restrictions:** - For Autonomous Exadata Infrastructures, do not use a subnet that overlaps with 192.168.128.0/20 These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

nsg_ids

(optional) 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.

shape

(required) The shape of the Autonomous Exadata Infrastructure. The shape determines resources allocated to the Autonomous Exadata Infrastructure (CPU cores, memory and storage). To get a list of shapes, use the ListDbSystemShapes operation.

domain

(optional) A domain name used for the Autonomous Exadata Infrastructure. If the Oracle-provided Internet and VCN Resolver is enabled for the specified subnet, the domain name for the subnet is used (don't provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted.

license_model

(optional) The Oracle license model that applies to all the databases in the Autonomous Exadata Infrastructure. The default is BRING_YOUR_OWN_LICENSE.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

maintenance_window_details

(optional)

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_LAUNCH_DB_SYSTEM_BASE_T Type

Parameters for provisioning a bare metal, virtual machine, or Exadata DB system. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_launch_db_system_base_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  fault_domains dbms_cloud_oci_database_varchar2_tbl,
  display_name varchar2(32767),
  availability_domain varchar2(32767),
  subnet_id varchar2(32767),
  backup_subnet_id varchar2(32767),
  nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  backup_network_nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  shape varchar2(32767),
  time_zone varchar2(32767),
  db_system_options dbms_cloud_oci_database_db_system_options_t,
  storage_volume_performance_mode varchar2(32767),
  sparse_diskgroup number,
  ssh_public_keys dbms_cloud_oci_database_varchar2_tbl,
  hostname varchar2(32767),
  domain varchar2(32767),
  cpu_core_count number,
  cluster_name varchar2(32767),
  data_storage_percentage number,
  initial_data_storage_size_in_gb number,
  kms_key_id varchar2(32767),
  kms_key_version_id varchar2(32767),
  node_count number,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  source varchar2(32767),
  private_ip varchar2(32767),
  data_collection_options dbms_cloud_oci_database_data_collection_options_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_launch_db_system_base_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_launch_db_system_base_t (
    compartment_id varchar2,
    fault_domains dbms_cloud_oci_database_varchar2_tbl,
    display_name varchar2,
    availability_domain varchar2,
    subnet_id varchar2,
    backup_subnet_id varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    backup_network_nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    shape varchar2,
    time_zone varchar2,
    db_system_options dbms_cloud_oci_database_db_system_options_t,
    storage_volume_performance_mode varchar2,
    sparse_diskgroup number,
    ssh_public_keys dbms_cloud_oci_database_varchar2_tbl,
    hostname varchar2,
    domain varchar2,
    cpu_core_count number,
    cluster_name varchar2,
    data_storage_percentage number,
    initial_data_storage_size_in_gb number,
    kms_key_id varchar2,
    kms_key_version_id varchar2,
    node_count number,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    source varchar2,
    private_ip varchar2,
    data_collection_options dbms_cloud_oci_database_data_collection_options_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

compartment_id

(required) The OCID of the compartment the DB system belongs in.

fault_domains

(optional) A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains. If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain. If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node. To get a list of Fault Domains, use the LIST_FAULT_DOMAINS Function operation in the Identity and Access Management Service API. Example: `FAULT-DOMAIN-1`

display_name

(optional) The user-friendly name for the DB system. The name does not have to be unique.

availability_domain

(required) The availability domain where the DB system is located.

subnet_id

(required) The OCID of the subnet the DB system is associated with. **Subnet Restrictions:** - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. - For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.

backup_subnet_id

(optional) The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems. **Subnet Restrictions:** See the subnet restrictions information for **subnetId**.

nsg_ids

(optional) 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.

backup_network_nsg_ids

(optional) A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

shape

(required) The shape of the DB system. The shape determines resources allocated to the DB system. - For virtual machine shapes, the number of CPU cores and memory - For bare metal and Exadata shapes, the number of CPU cores, memory, and storage To get a list of shapes, use the LIST_DB_SYSTEM_SHAPES Function operation.

time_zone

(optional) The time zone to use for the DB system. For details, see DB System Time Zones.

db_system_options

(optional)

storage_volume_performance_mode

(optional) The block storage volume performance level. Valid values are `BALANCED` and `HIGH_PERFORMANCE`. See Block Volume Performance for more information.

Allowed values are: 'BALANCED', 'HIGH_PERFORMANCE'

sparse_diskgroup

(optional) If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured.

ssh_public_keys

(required) The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.

hostname

(required) The hostname for the DB system. The hostname must begin with an alphabetic character, and can contain alphanumeric characters and hyphens (-). The maximum length of the hostname is 16 characters for bare metal and virtual machine DB systems, and 12 characters for Exadata DB systems. The maximum length of the combined hostname and domain is 63 characters. **Note:** The hostname must be unique within the subnet. If it is not unique, the DB system will fail to provision.

domain

(optional) A domain name used for the DB system. If the Oracle-provided Internet and VCN Resolver is enabled for the specified subnet, the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted.

cpu_core_count

(required) The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape: - BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36. - BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52. - Exadata.Base.48 - Specify a multiple of 2, from 0 to 48. - Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84. - Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168. - Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336. - Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92. - Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184. - Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368. - VM.Standard.E4.Flex - Specify any thing from 1 to 64. This parameter is not used for INTEL virtual machine DB systems because virtual machine DB systems have a set number of cores for each shape. For information about the number of cores for a virtual machine DB system shape, see Virtual Machine DB Systems

cluster_name

(optional) The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.

data_storage_percentage

(optional) The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Specify 80 or 40. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems.

initial_data_storage_size_in_gb

(optional) Size (in GB) of the initial data volume that will be created and attached to a virtual machine DB system. You can scale up storage after provisioning, as needed. Note that the total storage size attached will be more than the amount you specify to allow for REDO/RECO space and software volume.

kms_key_id

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

kms_key_version_id

(optional) 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.

node_count

(optional) The number of nodes to launch for a 2-node RAC virtual machine DB system. Specify either 1 or 2.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

source

(optional) The source of the database: Use `NONE` for creating a new database. Use `DB_BACKUP` for creating a new database by restoring from a backup. Use `DATABASE` for creating a new database from an existing database, including archive redo log data. The default is `NONE`.

Allowed values are: 'NONE', 'DB_BACKUP', 'DATABASE', 'DB_SYSTEM'

private_ip

(optional) A private IP address of your choice. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet.

data_collection_options

(optional)

DBMS_CLOUD_OCI_DATABASE_LAUNCH_DB_SYSTEM_DETAILS_T Type

Used for creating a new DB system. Does not use backups or an existing database for the creation of the initial database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_launch_db_system_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_launch_db_system_base_t (
  db_home dbms_cloud_oci_database_create_db_home_details_t,
  database_edition varchar2(32767),
  disk_redundancy varchar2(32767),
  license_model varchar2(32767),
  maintenance_window_details dbms_cloud_oci_database_maintenance_window_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_launch_db_system_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_launch_db_system_details_t (
    compartment_id varchar2,
    fault_domains dbms_cloud_oci_database_varchar2_tbl,
    display_name varchar2,
    availability_domain varchar2,
    subnet_id varchar2,
    backup_subnet_id varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    backup_network_nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    shape varchar2,
    time_zone varchar2,
    db_system_options dbms_cloud_oci_database_db_system_options_t,
    storage_volume_performance_mode varchar2,
    sparse_diskgroup number,
    ssh_public_keys dbms_cloud_oci_database_varchar2_tbl,
    hostname varchar2,
    domain varchar2,
    cpu_core_count number,
    cluster_name varchar2,
    data_storage_percentage number,
    initial_data_storage_size_in_gb number,
    kms_key_id varchar2,
    kms_key_version_id varchar2,
    node_count number,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    source varchar2,
    private_ip varchar2,
    data_collection_options dbms_cloud_oci_database_data_collection_options_t,
    db_home dbms_cloud_oci_database_create_db_home_details_t,
    database_edition varchar2,
    disk_redundancy varchar2,
    license_model varchar2,
    maintenance_window_details dbms_cloud_oci_database_maintenance_window_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_launch_db_system_details_t is a subtype of the dbms_cloud_oci_database_launch_db_system_base_t type.

Fields

Field Description

db_home

(required)

database_edition

(required) The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION', 'ENTERPRISE_EDITION_HIGH_PERFORMANCE', 'ENTERPRISE_EDITION_EXTREME_PERFORMANCE'

disk_redundancy

(optional) The type of redundancy configured for the DB system. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems.

Allowed values are: 'HIGH', 'NORMAL'

license_model

(optional) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

maintenance_window_details

(optional)

DBMS_CLOUD_OCI_DATABASE_LAUNCH_DB_SYSTEM_FROM_BACKUP_DETAILS_T Type

Used for creating a new DB system from a database backup.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_launch_db_system_from_backup_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_launch_db_system_base_t (
  db_home dbms_cloud_oci_database_create_db_home_from_backup_details_t,
  database_edition varchar2(32767),
  disk_redundancy varchar2(32767),
  license_model varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_launch_db_system_from_backup_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_launch_db_system_from_backup_details_t (
    compartment_id varchar2,
    fault_domains dbms_cloud_oci_database_varchar2_tbl,
    display_name varchar2,
    availability_domain varchar2,
    subnet_id varchar2,
    backup_subnet_id varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    backup_network_nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    shape varchar2,
    time_zone varchar2,
    db_system_options dbms_cloud_oci_database_db_system_options_t,
    storage_volume_performance_mode varchar2,
    sparse_diskgroup number,
    ssh_public_keys dbms_cloud_oci_database_varchar2_tbl,
    hostname varchar2,
    domain varchar2,
    cpu_core_count number,
    cluster_name varchar2,
    data_storage_percentage number,
    initial_data_storage_size_in_gb number,
    kms_key_id varchar2,
    kms_key_version_id varchar2,
    node_count number,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    source varchar2,
    private_ip varchar2,
    data_collection_options dbms_cloud_oci_database_data_collection_options_t,
    db_home dbms_cloud_oci_database_create_db_home_from_backup_details_t,
    database_edition varchar2,
    disk_redundancy varchar2,
    license_model varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_launch_db_system_from_backup_details_t is a subtype of the dbms_cloud_oci_database_launch_db_system_base_t type.

Fields

Field Description

db_home

(required)

database_edition

(required) The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION', 'ENTERPRISE_EDITION_HIGH_PERFORMANCE', 'ENTERPRISE_EDITION_EXTREME_PERFORMANCE'

disk_redundancy

(optional) The type of redundancy configured for the DB system. NORMAL 2-way redundancy, recommended for test and development systems. HIGH is 3-way redundancy, recommended for production systems.

Allowed values are: 'HIGH', 'NORMAL'

license_model

(optional) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

DBMS_CLOUD_OCI_DATABASE_LAUNCH_DB_SYSTEM_FROM_DATABASE_DETAILS_T Type

Used for creating a new DB system from a database, including archived redo log data.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_launch_db_system_from_database_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_launch_db_system_base_t (
  db_home dbms_cloud_oci_database_create_db_home_from_database_details_t,
  database_edition varchar2(32767),
  disk_redundancy varchar2(32767),
  license_model varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_launch_db_system_from_database_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_launch_db_system_from_database_details_t (
    compartment_id varchar2,
    fault_domains dbms_cloud_oci_database_varchar2_tbl,
    display_name varchar2,
    availability_domain varchar2,
    subnet_id varchar2,
    backup_subnet_id varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    backup_network_nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    shape varchar2,
    time_zone varchar2,
    db_system_options dbms_cloud_oci_database_db_system_options_t,
    storage_volume_performance_mode varchar2,
    sparse_diskgroup number,
    ssh_public_keys dbms_cloud_oci_database_varchar2_tbl,
    hostname varchar2,
    domain varchar2,
    cpu_core_count number,
    cluster_name varchar2,
    data_storage_percentage number,
    initial_data_storage_size_in_gb number,
    kms_key_id varchar2,
    kms_key_version_id varchar2,
    node_count number,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    source varchar2,
    private_ip varchar2,
    data_collection_options dbms_cloud_oci_database_data_collection_options_t,
    db_home dbms_cloud_oci_database_create_db_home_from_database_details_t,
    database_edition varchar2,
    disk_redundancy varchar2,
    license_model varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_launch_db_system_from_database_details_t is a subtype of the dbms_cloud_oci_database_launch_db_system_base_t type.

Fields

Field Description

db_home

(required)

database_edition

(required) The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.

Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION', 'ENTERPRISE_EDITION_HIGH_PERFORMANCE', 'ENTERPRISE_EDITION_EXTREME_PERFORMANCE'

disk_redundancy

(optional) The type of redundancy configured for the DB system. NORMAL 2-way redundancy, recommended for test and development systems. HIGH is 3-way redundancy, recommended for production systems.

Allowed values are: 'HIGH', 'NORMAL'

license_model

(optional) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

DBMS_CLOUD_OCI_DATABASE_LAUNCH_DB_SYSTEM_FROM_DB_SYSTEM_DETAILS_T Type

Used for creating a new database system by cloning an existing DB system.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_launch_db_system_from_db_system_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_launch_db_system_base_t (
  source_db_system_id varchar2(32767),
  db_home dbms_cloud_oci_database_create_db_home_from_db_system_details_t,
  license_model varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_launch_db_system_from_db_system_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_launch_db_system_from_db_system_details_t (
    compartment_id varchar2,
    fault_domains dbms_cloud_oci_database_varchar2_tbl,
    display_name varchar2,
    availability_domain varchar2,
    subnet_id varchar2,
    backup_subnet_id varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    backup_network_nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    shape varchar2,
    time_zone varchar2,
    db_system_options dbms_cloud_oci_database_db_system_options_t,
    storage_volume_performance_mode varchar2,
    sparse_diskgroup number,
    ssh_public_keys dbms_cloud_oci_database_varchar2_tbl,
    hostname varchar2,
    domain varchar2,
    cpu_core_count number,
    cluster_name varchar2,
    data_storage_percentage number,
    initial_data_storage_size_in_gb number,
    kms_key_id varchar2,
    kms_key_version_id varchar2,
    node_count number,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    source varchar2,
    private_ip varchar2,
    data_collection_options dbms_cloud_oci_database_data_collection_options_t,
    source_db_system_id varchar2,
    db_home dbms_cloud_oci_database_create_db_home_from_db_system_details_t,
    license_model varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_launch_db_system_from_db_system_details_t is a subtype of the dbms_cloud_oci_database_launch_db_system_base_t type.

Fields

Field Description

source_db_system_id

(required) The OCID of the DB system.

db_home

(required)

license_model

(optional) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

DBMS_CLOUD_OCI_DATABASE_LOCAL_CLONE_PLUGGABLE_DATABASE_DETAILS_T Type

**Deprecated.** Use CREATE_PLUGGABLE_DATABASE_DETAILS Function for Pluggable Database LocalClone Operation. Parameters for cloning a pluggable database (PDB) within the same database (CDB). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_local_clone_pluggable_database_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  cloned_pdb_name varchar2(32767),
  pdb_admin_password varchar2(32767),
  target_tde_wallet_password varchar2(32767),
  should_pdb_admin_account_be_locked number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_local_clone_pluggable_database_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_local_clone_pluggable_database_details_t (
    cloned_pdb_name varchar2,
    pdb_admin_password varchar2,
    target_tde_wallet_password varchar2,
    should_pdb_admin_account_be_locked number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

cloned_pdb_name

(required) The name for the pluggable database (PDB). The name is unique in the context of a DATABASE Type. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name.

pdb_admin_password

(optional) A strong password for PDB Admin of the newly cloned PDB. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, \\#, or -.

target_tde_wallet_password

(optional) The existing TDE wallet password of the target CDB.

should_pdb_admin_account_be_locked

(optional) The locked mode of the pluggable database admin account. If false, the user needs to provide the PDB Admin Password to connect to it. If true, the pluggable database will be locked and user cannot login to it.

DBMS_CLOUD_OCI_DATABASE_MAINTENANCE_RUN_T Type

Details of a maintenance run.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_maintenance_run_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  description varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_scheduled timestamp with time zone,
  time_started timestamp with time zone,
  time_ended timestamp with time zone,
  target_resource_type varchar2(32767),
  target_resource_id varchar2(32767),
  maintenance_type varchar2(32767),
  patch_id varchar2(32767),
  maintenance_subtype varchar2(32767),
  is_dst_file_update_enabled number,
  peer_maintenance_run_id varchar2(32767),
  patching_mode varchar2(32767),
  patch_failure_count number,
  target_db_server_version varchar2(32767),
  target_storage_server_version varchar2(32767),
  is_custom_action_timeout_enabled number,
  custom_action_timeout_in_mins number,
  current_custom_action_timeout_in_mins number,
  patching_status varchar2(32767),
  patching_start_time timestamp with time zone,
  patching_end_time timestamp with time zone,
  estimated_patching_time dbms_cloud_oci_database_estimated_patching_time_t,
  current_patching_component varchar2(32767),
  estimated_component_patching_start_time timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_maintenance_run_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_maintenance_run_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    description varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_scheduled timestamp with time zone,
    time_started timestamp with time zone,
    time_ended timestamp with time zone,
    target_resource_type varchar2,
    target_resource_id varchar2,
    maintenance_type varchar2,
    patch_id varchar2,
    maintenance_subtype varchar2,
    is_dst_file_update_enabled number,
    peer_maintenance_run_id varchar2,
    patching_mode varchar2,
    patch_failure_count number,
    target_db_server_version varchar2,
    target_storage_server_version varchar2,
    is_custom_action_timeout_enabled number,
    custom_action_timeout_in_mins number,
    current_custom_action_timeout_in_mins number,
    patching_status varchar2,
    patching_start_time timestamp with time zone,
    patching_end_time timestamp with time zone,
    estimated_patching_time dbms_cloud_oci_database_estimated_patching_time_t,
    current_patching_component varchar2,
    estimated_component_patching_start_time timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the maintenance run.

compartment_id

(required) The OCID of the compartment.

display_name

(required) The user-friendly name for the maintenance run.

description

(optional) Description of the maintenance run.

lifecycle_state

(required) The current state of the maintenance run. For Autonomous Database Serverless instances, valid states are IN_PROGRESS, SUCCEEDED, and FAILED.

Allowed values are: 'SCHEDULED', 'IN_PROGRESS', 'SUCCEEDED', 'SKIPPED', 'FAILED', 'UPDATING', 'DELETING', 'DELETED', 'CANCELED'

lifecycle_details

(optional) Additional information about the current lifecycle state.

time_scheduled

(required) The date and time the maintenance run is scheduled to occur.

time_started

(optional) The date and time the maintenance run starts.

time_ended

(optional) The date and time the maintenance run was completed.

target_resource_type

(optional) The type of the target resource on which the maintenance run occurs.

Allowed values are: 'AUTONOMOUS_EXADATA_INFRASTRUCTURE', 'AUTONOMOUS_CONTAINER_DATABASE', 'EXADATA_DB_SYSTEM', 'CLOUD_EXADATA_INFRASTRUCTURE', 'EXACC_INFRASTRUCTURE', 'AUTONOMOUS_VM_CLUSTER', 'AUTONOMOUS_DATABASE', 'CLOUD_AUTONOMOUS_VM_CLUSTER'

target_resource_id

(optional) The ID of the target resource on which the maintenance run occurs.

maintenance_type

(optional) Maintenance type.

Allowed values are: 'PLANNED', 'UNPLANNED'

patch_id

(optional) The unique identifier of the patch. The identifier string includes the patch type, the Oracle Database version, and the patch creation date (using the format YYMMDD). For example, the identifier `ru_patch_19.9.0.0_201030` is used for an RU patch for Oracle Database 19.9.0.0 that was released October 30, 2020.

maintenance_subtype

(optional) Maintenance sub-type.

Allowed values are: 'QUARTERLY', 'HARDWARE', 'CRITICAL', 'INFRASTRUCTURE', 'DATABASE', 'ONEOFF', 'SECURITY_MONTHLY', 'TIMEZONE'

is_dst_file_update_enabled

(optional) Indicates if an automatic DST Time Zone file update is enabled for the Autonomous Container Database. If enabled along with Release Update, patching will be done in a Non-Rolling manner.

peer_maintenance_run_id

(optional) The OCID of the maintenance run for the Autonomous Data Guard association's peer container database.

patching_mode

(optional) Cloud Exadata infrastructure node patching method, either \"ROLLING\" or \"NONROLLING\". Default value is ROLLING. *IMPORTANT*: Non-rolling infrastructure patching involves system down time. See Oracle-Managed Infrastructure Maintenance Updates for more information.

Allowed values are: 'ROLLING', 'NONROLLING'

patch_failure_count

(optional) Contain the patch failure count.

target_db_server_version

(optional) The target software version for the database server patching operation.

target_storage_server_version

(optional) The target Cell version that is to be patched to.

is_custom_action_timeout_enabled

(optional) If true, enables the configuration of a custom action timeout (waiting period) between database servers patching operations.

custom_action_timeout_in_mins

(optional) Determines the amount of time the system will wait before the start of each database server patching operation. Specify a number of minutes, from 15 to 120.

current_custom_action_timeout_in_mins

(optional) Extend current custom action timeout between the current database servers during waiting state, from 0 (zero) to 30 minutes.

patching_status

(optional) The status of the patching operation.

Allowed values are: 'PATCHING', 'WAITING', 'SCHEDULED'

patching_start_time

(optional) The time when the patching operation started.

patching_end_time

(optional) The time when the patching operation ended.

estimated_patching_time

(optional)

current_patching_component

(optional) The name of the current infrastruture component that is getting patched.

estimated_component_patching_start_time

(optional) The estimated start time of the next infrastruture component patching operation.

DBMS_CLOUD_OCI_DATABASE_MAINTENANCE_RUN_SUMMARY_T Type

Details of a maintenance run.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_maintenance_run_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  description varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_scheduled timestamp with time zone,
  time_started timestamp with time zone,
  time_ended timestamp with time zone,
  target_resource_type varchar2(32767),
  target_resource_id varchar2(32767),
  maintenance_type varchar2(32767),
  patch_id varchar2(32767),
  maintenance_subtype varchar2(32767),
  is_dst_file_update_enabled number,
  peer_maintenance_run_id varchar2(32767),
  patching_mode varchar2(32767),
  patch_failure_count number,
  target_db_server_version varchar2(32767),
  target_storage_server_version varchar2(32767),
  is_custom_action_timeout_enabled number,
  custom_action_timeout_in_mins number,
  current_custom_action_timeout_in_mins number,
  patching_status varchar2(32767),
  patching_start_time timestamp with time zone,
  patching_end_time timestamp with time zone,
  estimated_patching_time dbms_cloud_oci_database_estimated_patching_time_t,
  current_patching_component varchar2(32767),
  estimated_component_patching_start_time timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_maintenance_run_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_maintenance_run_summary_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    description varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_scheduled timestamp with time zone,
    time_started timestamp with time zone,
    time_ended timestamp with time zone,
    target_resource_type varchar2,
    target_resource_id varchar2,
    maintenance_type varchar2,
    patch_id varchar2,
    maintenance_subtype varchar2,
    is_dst_file_update_enabled number,
    peer_maintenance_run_id varchar2,
    patching_mode varchar2,
    patch_failure_count number,
    target_db_server_version varchar2,
    target_storage_server_version varchar2,
    is_custom_action_timeout_enabled number,
    custom_action_timeout_in_mins number,
    current_custom_action_timeout_in_mins number,
    patching_status varchar2,
    patching_start_time timestamp with time zone,
    patching_end_time timestamp with time zone,
    estimated_patching_time dbms_cloud_oci_database_estimated_patching_time_t,
    current_patching_component varchar2,
    estimated_component_patching_start_time timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the maintenance run.

compartment_id

(required) The OCID of the compartment.

display_name

(required) The user-friendly name for the maintenance run.

description

(optional) Description of the maintenance run.

lifecycle_state

(required) The current state of the maintenance run. For Autonomous Database Serverless instances, valid states are IN_PROGRESS, SUCCEEDED, and FAILED.

Allowed values are: 'SCHEDULED', 'IN_PROGRESS', 'SUCCEEDED', 'SKIPPED', 'FAILED', 'UPDATING', 'DELETING', 'DELETED', 'CANCELED'

lifecycle_details

(optional) Additional information about the current lifecycle state.

time_scheduled

(required) The date and time the maintenance run is scheduled to occur.

time_started

(optional) The date and time the maintenance run starts.

time_ended

(optional) The date and time the maintenance run was completed.

target_resource_type

(optional) The type of the target resource on which the maintenance run occurs.

Allowed values are: 'AUTONOMOUS_EXADATA_INFRASTRUCTURE', 'AUTONOMOUS_CONTAINER_DATABASE', 'EXADATA_DB_SYSTEM', 'CLOUD_EXADATA_INFRASTRUCTURE', 'EXACC_INFRASTRUCTURE', 'AUTONOMOUS_VM_CLUSTER', 'AUTONOMOUS_DATABASE', 'CLOUD_AUTONOMOUS_VM_CLUSTER'

target_resource_id

(optional) The ID of the target resource on which the maintenance run occurs.

maintenance_type

(optional) Maintenance type.

Allowed values are: 'PLANNED', 'UNPLANNED'

patch_id

(optional) The unique identifier of the patch. The identifier string includes the patch type, the Oracle Database version, and the patch creation date (using the format YYMMDD). For example, the identifier `ru_patch_19.9.0.0_201030` is used for an RU patch for Oracle Database 19.9.0.0 that was released October 30, 2020.

maintenance_subtype

(optional) Maintenance sub-type.

Allowed values are: 'QUARTERLY', 'HARDWARE', 'CRITICAL', 'INFRASTRUCTURE', 'DATABASE', 'ONEOFF', 'SECURITY_MONTHLY', 'TIMEZONE'

is_dst_file_update_enabled

(optional) Indicates if an automatic DST Time Zone file update is enabled for the Autonomous Container Database. If enabled along with Release Update, patching will be done in a Non-Rolling manner.

peer_maintenance_run_id

(optional) The OCID of the maintenance run for the Autonomous Data Guard association's peer container database.

patching_mode

(optional) Cloud Exadata infrastructure node patching method, either \"ROLLING\" or \"NONROLLING\". Default value is ROLLING. *IMPORTANT*: Non-rolling infrastructure patching involves system down time. See Oracle-Managed Infrastructure Maintenance Updates for more information.

Allowed values are: 'ROLLING', 'NONROLLING'

patch_failure_count

(optional) Contain the patch failure count.

target_db_server_version

(optional) The target software version for the database server patching operation.

target_storage_server_version

(optional) The target Cell version that is to be patched to.

is_custom_action_timeout_enabled

(optional) If true, enables the configuration of a custom action timeout (waiting period) between database servers patching operations.

custom_action_timeout_in_mins

(optional) Determines the amount of time the system will wait before the start of each database server patching operation. Specify a number of minutes, from 15 to 120.

current_custom_action_timeout_in_mins

(optional) Extend current custom action timeout between the current database servers during waiting state, from 0 (zero) to 30 minutes.

patching_status

(optional) The status of the patching operation.

Allowed values are: 'PATCHING', 'WAITING', 'SCHEDULED'

patching_start_time

(optional) The time when the patching operation started.

patching_end_time

(optional) The time when the patching operation ended.

estimated_patching_time

(optional)

current_patching_component

(optional) The name of the current infrastruture component that is getting patched.

estimated_component_patching_start_time

(optional) The estimated start time of the next infrastruture component patching operation.

DBMS_CLOUD_OCI_DATABASE_DB_SERVER_HISTORY_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_database_db_server_history_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_db_server_history_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_db_server_history_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_MAINTENANCE_RUN_HISTORY_T Type

Details of a maintenance run history.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_maintenance_run_history_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  maintenance_run_details dbms_cloud_oci_database_maintenance_run_summary_t,
  db_servers_history_details dbms_cloud_oci_database_db_server_history_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_maintenance_run_history_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_maintenance_run_history_t (
    id varchar2,
    maintenance_run_details dbms_cloud_oci_database_maintenance_run_summary_t,
    db_servers_history_details dbms_cloud_oci_database_db_server_history_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the maintenance run history.

maintenance_run_details

(optional)

db_servers_history_details

(optional) List of database server history details.

DBMS_CLOUD_OCI_DATABASE_MAINTENANCE_RUN_HISTORY_SUMMARY_T Type

Details of a maintenance run history.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_maintenance_run_history_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  maintenance_run_details dbms_cloud_oci_database_maintenance_run_summary_t,
  db_servers_history_details dbms_cloud_oci_database_db_server_history_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_maintenance_run_history_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_maintenance_run_history_summary_t (
    id varchar2,
    maintenance_run_details dbms_cloud_oci_database_maintenance_run_summary_t,
    db_servers_history_details dbms_cloud_oci_database_db_server_history_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the maintenance run history.

maintenance_run_details

(optional)

db_servers_history_details

(optional) List of database server history details.

DBMS_CLOUD_OCI_DATABASE_MIGRATE_VAULT_KEY_DETAILS_T Type

Details for replacing existing Oracle-managed keys with customer-managed Vault service keys and vice-versa is not supported.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_migrate_vault_key_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  kms_key_id varchar2(32767),
  kms_key_version_id varchar2(32767),
  vault_id varchar2(32767),
  tde_wallet_password varchar2(32767),
  admin_password varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_migrate_vault_key_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_migrate_vault_key_details_t (
    kms_key_id varchar2,
    kms_key_version_id varchar2,
    vault_id varchar2,
    tde_wallet_password varchar2,
    admin_password varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

kms_key_id

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

kms_key_version_id

(optional) 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.

vault_id

(optional) The OCID of the Oracle Cloud Infrastructure vault.

tde_wallet_password

(optional) The existing TDE wallet password of the database.

admin_password

(optional) The existing admin password of the database.

DBMS_CLOUD_OCI_DATABASE_MODIFY_DATABASE_MANAGEMENT_DETAILS_T Type

Data to update one or more attributes of the Database Management configuration for the database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_modify_database_management_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  credential_details dbms_cloud_oci_database_database_credential_details_t,
  private_end_point_id varchar2(32767),
  management_type varchar2(32767),
  service_name varchar2(32767),
  protocol varchar2(32767),
  port number,
  ssl_secret_id varchar2(32767),
  role varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_modify_database_management_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_modify_database_management_details_t (
    credential_details dbms_cloud_oci_database_database_credential_details_t,
    private_end_point_id varchar2,
    management_type varchar2,
    service_name varchar2,
    protocol varchar2,
    port number,
    ssl_secret_id varchar2,
    role varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

credential_details

(optional)

private_end_point_id

(optional) The OCID of the private endpoint.

management_type

(optional) The Database Management type.

Allowed values are: 'BASIC', 'ADVANCED'

service_name

(optional) The name of the Oracle Database service that will be used to connect to the database.

protocol

(optional) Protocol used by the database connection.

Allowed values are: 'TCP', 'TCPS'

port

(optional) The port used to connect to the database.

ssl_secret_id

(optional) The OCID of the Oracle Cloud Infrastructure secret.

role

(optional) The role of the user that will be connecting to the database.

Allowed values are: 'SYSDBA', 'NORMAL'

DBMS_CLOUD_OCI_DATABASE_MODIFY_PLUGGABLE_DATABASE_MANAGEMENT_DETAILS_T Type

Data to update one or more attributes of the Database Management configuration for the pluggable database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_modify_pluggable_database_management_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  credential_details dbms_cloud_oci_database_database_credential_details_t,
  private_end_point_id varchar2(32767),
  service_name varchar2(32767),
  protocol varchar2(32767),
  port number,
  ssl_secret_id varchar2(32767),
  role varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_modify_pluggable_database_management_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_modify_pluggable_database_management_details_t (
    credential_details dbms_cloud_oci_database_database_credential_details_t,
    private_end_point_id varchar2,
    service_name varchar2,
    protocol varchar2,
    port number,
    ssl_secret_id varchar2,
    role varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

credential_details

(optional)

private_end_point_id

(optional) The OCID of the private endpoint.

service_name

(optional) The name of the Oracle Database service that will be used to connect to the database.

protocol

(optional) Protocol used by the database connection.

Allowed values are: 'TCP', 'TCPS'

port

(optional) The port used to connect to the database.

ssl_secret_id

(optional) The OCID of the Oracle Cloud Infrastructure secret.

role

(optional) The role of the user that will be connecting to the database.

Allowed values are: 'SYSDBA', 'NORMAL'

DBMS_CLOUD_OCI_DATABASE_NODE_DETAILS_T Type

Node details associated with a network.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_node_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  hostname varchar2(32767),
  ip varchar2(32767),
  vip_hostname varchar2(32767),
  vip varchar2(32767),
  lifecycle_state varchar2(32767),
  db_server_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_node_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_node_details_t (
    hostname varchar2,
    ip varchar2,
    vip_hostname varchar2,
    vip varchar2,
    lifecycle_state varchar2,
    db_server_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

hostname

(required) The node host name.

ip

(required) The node IP address.

vip_hostname

(optional) The node virtual IP (VIP) host name.

vip

(optional) The node virtual IP (VIP) address.

lifecycle_state

(optional) The current state of the VM cluster network nodes. CREATING - The resource is being created REQUIRES_VALIDATION - The resource is created and may not be usable until it is validated. VALIDATING - The resource is being validated and not available to use. VALIDATED - The resource is validated and is available for consumption by VM cluster. VALIDATION_FAILED - The resource validation has failed and might require user input to be corrected. UPDATING - The resource is being updated and not available to use. ALLOCATED - The resource is currently being used by VM cluster. TERMINATING - The resource is being deleted and not available to use. TERMINATED - The resource is deleted and unavailable. FAILED - The resource is in a failed state due to validation or other errors.

Allowed values are: 'CREATING', 'REQUIRES_VALIDATION', 'VALIDATING', 'VALIDATED', 'VALIDATION_FAILED', 'UPDATING', 'ALLOCATED', 'TERMINATING', 'TERMINATED', 'FAILED'

db_server_id

(optional) The Db server associated with the node.

DBMS_CLOUD_OCI_DATABASE_WORKLOAD_TYPE_T Type

The number of consumed OCPUs, by database workload type.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_workload_type_t FORCE AUTHID CURRENT_USER IS OBJECT (
  atp number,
  adw number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_workload_type_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_workload_type_t (
    atp number,
    adw number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

atp

(optional) The total number of OCPU cores in use for Autonomous Transaction Processing databases in the infrastructure instance.

adw

(optional) The total number of OCPU cores in use for Autonomous Data Warehouse databases in the infrastructure instance.

DBMS_CLOUD_OCI_DATABASE_OCP_US_T Type

The details of the available and consumed CPU cores of the Autonomous Exadata Infrastructure instance, including consumption by database workload type.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_ocp_us_t FORCE AUTHID CURRENT_USER IS OBJECT (
  total_cpu number,
  consumed_cpu number,
  by_workload_type dbms_cloud_oci_database_workload_type_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_ocp_us_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_ocp_us_t (
    total_cpu number,
    consumed_cpu number,
    by_workload_type dbms_cloud_oci_database_workload_type_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

total_cpu

(optional) The total number of OCPUs in the Autonomous Exadata Infrastructure instance.

consumed_cpu

(optional) The total number of consumed OCPUs in the Autonomous Exadata Infrastructure instance.

by_workload_type

(optional)

DBMS_CLOUD_OCI_DATABASE_ONEOFF_PATCH_T Type

One-off patches are created by specifying a database version, releaseUpdate and one-off patch number.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_oneoff_patch_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  db_version varchar2(32767),
  release_update varchar2(32767),
  one_off_patches dbms_cloud_oci_database_varchar2_tbl,
  size_in_k_bs number,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  sha256_sum varchar2(32767),
  time_updated timestamp with time zone,
  time_created timestamp with time zone,
  time_of_expiration timestamp with time zone,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_oneoff_patch_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_oneoff_patch_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    db_version varchar2,
    release_update varchar2,
    one_off_patches dbms_cloud_oci_database_varchar2_tbl,
    size_in_k_bs number,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    sha256_sum varchar2,
    time_updated timestamp with time zone,
    time_created timestamp with time zone,
    time_of_expiration timestamp with time zone,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the one-off patch.

compartment_id

(required) The OCID of the compartment.

display_name

(required) One-off patch name.

db_version

(required) A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

release_update

(required) The PSU or PBP or Release Updates. To get a list of supported versions, use the LIST_DB_VERSIONS Function operation.

one_off_patches

(optional) List of one-off patches for Database Homes.

size_in_k_bs

(optional) The size of one-off patch in kilobytes.

lifecycle_state

(required) The current state of the one-off patch.

Allowed values are: 'CREATING', 'AVAILABLE', 'UPDATING', 'INACTIVE', 'FAILED', 'EXPIRED', 'DELETING', 'DELETED', 'TERMINATING', 'TERMINATED'

lifecycle_details

(optional) Detailed message for the lifecycle state.

sha256_sum

(optional) SHA-256 checksum of the one-off patch.

time_updated

(optional) The date and time one-off patch was updated.

time_created

(required) The date and time one-off patch was created.

time_of_expiration

(optional) The date and time until which the one-off patch will be available for download.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_ONEOFF_PATCH_SUMMARY_T Type

An Oracle one-off patch for a specified database version. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_oneoff_patch_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  db_version varchar2(32767),
  release_update varchar2(32767),
  one_off_patches dbms_cloud_oci_database_varchar2_tbl,
  size_in_k_bs number,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  sha256_sum varchar2(32767),
  time_updated timestamp with time zone,
  time_created timestamp with time zone,
  time_of_expiration timestamp with time zone,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_oneoff_patch_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_oneoff_patch_summary_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    db_version varchar2,
    release_update varchar2,
    one_off_patches dbms_cloud_oci_database_varchar2_tbl,
    size_in_k_bs number,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    sha256_sum varchar2,
    time_updated timestamp with time zone,
    time_created timestamp with time zone,
    time_of_expiration timestamp with time zone,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the one-off patch.

compartment_id

(required) The OCID of the compartment.

display_name

(required) One-off patch name.

db_version

(required) A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

release_update

(required) The PSU or PBP or Release Updates. To get a list of supported versions, use the LIST_DB_VERSIONS Function operation.

one_off_patches

(optional) List of one-off patches for Database Homes.

size_in_k_bs

(optional) The size of one-off patch in kilobytes.

lifecycle_state

(required) The current state of the one-off patch.

Allowed values are: 'CREATING', 'AVAILABLE', 'UPDATING', 'INACTIVE', 'FAILED', 'EXPIRED', 'DELETING', 'DELETED', 'TERMINATING', 'TERMINATED'

lifecycle_details

(optional) Detailed message for the lifecycle state.

sha256_sum

(optional) SHA-256 checksum of the one-off patch.

time_updated

(optional) The date and time one-off patch was updated.

time_created

(required) The date and time one-off patch was created.

time_of_expiration

(optional) The date and time until which the one-off patch will be available for download.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_PATCH_T Type

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_patch_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  description varchar2(32767),
  last_action varchar2(32767),
  available_actions dbms_cloud_oci_database_varchar2_tbl,
  lifecycle_details varchar2(32767),
  lifecycle_state varchar2(32767),
  time_released timestamp with time zone,
  version varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_patch_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_patch_t (
    id varchar2,
    description varchar2,
    last_action varchar2,
    available_actions dbms_cloud_oci_database_varchar2_tbl,
    lifecycle_details varchar2,
    lifecycle_state varchar2,
    time_released timestamp with time zone,
    version varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the patch.

description

(required) The text describing this patch package.

last_action

(optional) Action that is currently being performed or was completed last.

Allowed values are: 'APPLY', 'PRECHECK'

available_actions

(optional) Actions that can possibly be performed using this patch.

Allowed values are: 'APPLY', 'PRECHECK'

lifecycle_details

(optional) A descriptive text associated with the lifecycleState. Typically can contain additional displayable text.

lifecycle_state

(optional) The current state of the patch as a result of lastAction.

Allowed values are: 'AVAILABLE', 'SUCCESS', 'IN_PROGRESS', 'FAILED'

time_released

(required) The date and time that the patch was released.

version

(required) The version of this patch package.

DBMS_CLOUD_OCI_DATABASE_PATCH_DETAILS_T Type

The details about what actions to perform and using what patch to the specified target. This is part of an update request that is applied to a version field on the target such as DB system, Database Home, etc.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_patch_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  patch_id varchar2(32767),
  database_software_image_id varchar2(32767),
  action varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_patch_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_patch_details_t (
    patch_id varchar2,
    database_software_image_id varchar2,
    action varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

patch_id

(optional) The OCID of the patch.

database_software_image_id

(optional) The OCID of the database software image.

action

(optional) The action to perform on the patch.

Allowed values are: 'APPLY', 'PRECHECK'

DBMS_CLOUD_OCI_DATABASE_PATCH_HISTORY_ENTRY_T Type

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_patch_history_entry_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  patch_id varchar2(32767),
  action varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_started timestamp with time zone,
  time_ended timestamp with time zone,
  patch_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_patch_history_entry_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_patch_history_entry_t (
    id varchar2,
    patch_id varchar2,
    action varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_started timestamp with time zone,
    time_ended timestamp with time zone,
    patch_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the patch history entry.

patch_id

(required) The OCID of the patch.

action

(optional) The action being performed or was completed.

Allowed values are: 'APPLY', 'PRECHECK'

lifecycle_state

(required) The current state of the action.

Allowed values are: 'IN_PROGRESS', 'SUCCEEDED', 'FAILED'

lifecycle_details

(optional) A descriptive text associated with the lifecycleState. Typically contains additional displayable text.

time_started

(required) The date and time when the patch action started.

time_ended

(optional) The date and time when the patch action completed

patch_type

(optional) The type of Patch operation.

Allowed values are: 'OS', 'DB', 'GI'

DBMS_CLOUD_OCI_DATABASE_PATCH_HISTORY_ENTRY_SUMMARY_T Type

The record of a patch action on a specified target.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_patch_history_entry_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  patch_id varchar2(32767),
  action varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_started timestamp with time zone,
  time_ended timestamp with time zone,
  patch_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_patch_history_entry_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_patch_history_entry_summary_t (
    id varchar2,
    patch_id varchar2,
    action varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_started timestamp with time zone,
    time_ended timestamp with time zone,
    patch_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the patch history entry.

patch_id

(required) The OCID of the patch.

action

(optional) The action being performed or was completed.

Allowed values are: 'APPLY', 'PRECHECK'

lifecycle_state

(required) The current state of the action.

Allowed values are: 'IN_PROGRESS', 'SUCCEEDED', 'FAILED'

lifecycle_details

(optional) A descriptive text associated with the lifecycleState. Typically contains additional displayable text.

time_started

(required) The date and time when the patch action started.

time_ended

(optional) The date and time when the patch action completed

patch_type

(optional) The type of Patch operation.

Allowed values are: 'OS', 'DB', 'GI'

DBMS_CLOUD_OCI_DATABASE_PATCH_SUMMARY_T Type

A Patch for a DB system or DB Home. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_patch_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  description varchar2(32767),
  last_action varchar2(32767),
  available_actions dbms_cloud_oci_database_varchar2_tbl,
  lifecycle_details varchar2(32767),
  lifecycle_state varchar2(32767),
  time_released timestamp with time zone,
  version varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_patch_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_patch_summary_t (
    id varchar2,
    description varchar2,
    last_action varchar2,
    available_actions dbms_cloud_oci_database_varchar2_tbl,
    lifecycle_details varchar2,
    lifecycle_state varchar2,
    time_released timestamp with time zone,
    version varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the patch.

description

(required) The text describing this patch package.

last_action

(optional) Action that is currently being performed or was completed last.

Allowed values are: 'APPLY', 'PRECHECK'

available_actions

(optional) Actions that can possibly be performed using this patch.

Allowed values are: 'APPLY', 'PRECHECK'

lifecycle_details

(optional) A descriptive text associated with the lifecycleState. Typically can contain additional displayable text.

lifecycle_state

(optional) The current state of the patch as a result of lastAction.

Allowed values are: 'AVAILABLE', 'SUCCESS', 'IN_PROGRESS', 'FAILED'

time_released

(required) The date and time that the patch was released.

version

(required) The version of this patch package.

DBMS_CLOUD_OCI_DATABASE_PDB_CONVERSION_HISTORY_ENTRY_T Type

Details of operations performed to convert a non-container database to pluggable database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_pdb_conversion_history_entry_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  action varchar2(32767),
  target varchar2(32767),
  source_database_id varchar2(32767),
  target_database_id varchar2(32767),
  cdb_name varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_started timestamp with time zone,
  time_ended timestamp with time zone,
  additional_cdb_params varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_pdb_conversion_history_entry_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_pdb_conversion_history_entry_t (
    id varchar2,
    action varchar2,
    target varchar2,
    source_database_id varchar2,
    target_database_id varchar2,
    cdb_name varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_started timestamp with time zone,
    time_ended timestamp with time zone,
    additional_cdb_params varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the database conversion history.

action

(required) The operations used to convert a non-container database to a pluggable database. - Use `PRECHECK` to run a pre-check operation on non-container database prior to converting it into a pluggable database. - Use `CONVERT` to convert a non-container database into a pluggable database. - Use `SYNC` if the non-container database was manually converted into a pluggable database using the dbcli command-line utility. Databases may need to be converted manually if the CONVERT action fails when converting a non-container database using the API. - Use `SYNC_ROLLBACK` if the conversion of a non-container database into a pluggable database was manually rolled back using the dbcli command line utility. Conversions may need to be manually rolled back if the CONVERT action fails when converting a non-container database using the API.

Allowed values are: 'PRECHECK', 'CONVERT', 'SYNC', 'SYNC_ROLLBACK'

target

(optional) The target container database of the pluggable database created by the database conversion operation. Currently, the database conversion operation only supports creating the pluggable database in a new container database. - Use `NEW_DATABASE` to specify that the pluggable database be created within a new container database in the same database home.

Allowed values are: 'NEW_DATABASE'

source_database_id

(required) The OCID of the database.

target_database_id

(optional) The OCID of the database.

cdb_name

(required) The database name. The name must begin with an alphabetic character and can contain a maximum of 8 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy.

lifecycle_state

(required) Status of an operation performed during the conversion of a non-container database to a pluggable database.

Allowed values are: 'SUCCEEDED', 'FAILED', 'IN_PROGRESS'

lifecycle_details

(optional) Additional information about the current lifecycle state for the conversion operation.

time_started

(required) The date and time when the database conversion operation started.

time_ended

(optional) The date and time when the database conversion operation ended.

additional_cdb_params

(optional) Additional container database parameter.

DBMS_CLOUD_OCI_DATABASE_PDB_CONVERSION_HISTORY_ENTRY_SUMMARY_T Type

Details of operations performed to convert a non-container database to pluggable database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_pdb_conversion_history_entry_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  action varchar2(32767),
  target varchar2(32767),
  source_database_id varchar2(32767),
  target_database_id varchar2(32767),
  cdb_name varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_started timestamp with time zone,
  time_ended timestamp with time zone,
  additional_cdb_params varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_pdb_conversion_history_entry_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_pdb_conversion_history_entry_summary_t (
    id varchar2,
    action varchar2,
    target varchar2,
    source_database_id varchar2,
    target_database_id varchar2,
    cdb_name varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_started timestamp with time zone,
    time_ended timestamp with time zone,
    additional_cdb_params varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the database conversion history.

action

(required) The operations used to convert a non-container database to a pluggable database. - Use `PRECHECK` to run a pre-check operation on non-container database prior to converting it into a pluggable database. - Use `CONVERT` to convert a non-container database into a pluggable database. - Use `SYNC` if the non-container database was manually converted into a pluggable database using the dbcli command-line utility. Databases may need to be converted manually if the CONVERT action fails when converting a non-container database using the API. - Use `SYNC_ROLLBACK` if the conversion of a non-container database into a pluggable database was manually rolled back using the dbcli command line utility. Conversions may need to be manually rolled back if the CONVERT action fails when converting a non-container database using the API.

Allowed values are: 'PRECHECK', 'CONVERT', 'SYNC', 'SYNC_ROLLBACK'

target

(optional) The target container database of the pluggable database created by the database conversion operation. Currently, the database conversion operation only supports creating the pluggable database in a new container database. - Use `NEW_DATABASE` to specify that the pluggable database be created within a new container database in the same database home.

Allowed values are: 'NEW_DATABASE'

source_database_id

(required) The OCID of the database.

target_database_id

(optional) The OCID of the database.

cdb_name

(required) The database name. The name must begin with an alphabetic character and can contain a maximum of 8 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy.

lifecycle_state

(required) Status of an operation performed during the conversion of a non-container database to a pluggable database.

Allowed values are: 'SUCCEEDED', 'FAILED', 'IN_PROGRESS'

lifecycle_details

(optional) Additional information about the current lifecycle state for the conversion operation.

time_started

(required) The date and time when the database conversion operation started.

time_ended

(optional) The date and time when the database conversion operation ended.

additional_cdb_params

(optional) Additional container database parameter.

DBMS_CLOUD_OCI_DATABASE_PDB_CONVERSION_TO_NEW_DATABASE_DETAILS_T Type

Details of the new container database in which the converted pluggable database will be located.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_pdb_conversion_to_new_database_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_convert_to_pdb_target_base_t (
  cdb_name varchar2(32767),
  cdb_admin_password varchar2(32767),
  pdb_admin_password varchar2(32767),
  cdb_tde_wallet_password varchar2(32767),
  non_cdb_tde_wallet_password varchar2(32767),
  additional_cdb_params varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_pdb_conversion_to_new_database_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_pdb_conversion_to_new_database_details_t (
    target varchar2,
    cdb_name varchar2,
    cdb_admin_password varchar2,
    pdb_admin_password varchar2,
    cdb_tde_wallet_password varchar2,
    non_cdb_tde_wallet_password varchar2,
    additional_cdb_params varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_pdb_conversion_to_new_database_details_t is a subtype of the dbms_cloud_oci_database_convert_to_pdb_target_base_t type.

Fields

Field Description

cdb_name

(required) The database name. The name must begin with an alphabetic character and can contain a maximum of 8 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy.

cdb_admin_password

(required) A strong password for SYS, SYSTEM, and the plugbable database ADMIN user of the container database after conversion. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, \\#, or -.

pdb_admin_password

(optional) A strong password for plugbable database ADMIN user of the container database after conversion. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, \\#, or -.

cdb_tde_wallet_password

(optional) The password to open the TDE wallet of the container database after conversion. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, \\#, or -.

non_cdb_tde_wallet_password

(required) The existing TDE wallet password of the non-container database.

additional_cdb_params

(optional) Additional container database parameters. Example: \"_pdb_name_case_sensitive=true\"

DBMS_CLOUD_OCI_DATABASE_PLUGGABLE_DATABASE_CONNECTION_STRINGS_T Type

Connection strings to connect to an Oracle Pluggable Database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_pluggable_database_connection_strings_t FORCE AUTHID CURRENT_USER IS OBJECT (
  pdb_default varchar2(32767),
  pdb_ip_default varchar2(32767),
  all_connection_strings json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_pluggable_database_connection_strings_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_pluggable_database_connection_strings_t (
    pdb_default varchar2,
    pdb_ip_default varchar2,
    all_connection_strings json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

pdb_default

(optional) A host name-based PDB connection string.

pdb_ip_default

(optional) An IP-based PDB connection string.

all_connection_strings

(optional) All connection strings to use to connect to the pluggable database.

DBMS_CLOUD_OCI_DATABASE_PLUGGABLE_DATABASE_MANAGEMENT_CONFIG_T Type

The configuration of the Pluggable Database Management service.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_pluggable_database_management_config_t FORCE AUTHID CURRENT_USER IS OBJECT (
  management_status varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_pluggable_database_management_config_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_pluggable_database_management_config_t (
    management_status varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

management_status

(required) The status of the Pluggable Database Management service.

Allowed values are: 'ENABLING', 'ENABLED', 'DISABLING', 'DISABLED', 'UPDATING', 'FAILED_ENABLING', 'FAILED_DISABLING', 'FAILED_UPDATING'

DBMS_CLOUD_OCI_DATABASE_PLUGGABLE_DATABASE_REFRESHABLE_CLONE_CONFIG_T Type

Pluggable Database Refreshable Clone Configuration.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_pluggable_database_refreshable_clone_config_t FORCE AUTHID CURRENT_USER IS OBJECT (
  is_refreshable_clone number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_pluggable_database_refreshable_clone_config_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_pluggable_database_refreshable_clone_config_t (
    is_refreshable_clone number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

is_refreshable_clone

(optional) Indicates whether the Pluggable Database is a refreshable clone.

DBMS_CLOUD_OCI_DATABASE_PLUGGABLE_DATABASE_NODE_LEVEL_DETAILS_T Type

Pluggable Database Node Level Details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_pluggable_database_node_level_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  node_name varchar2(32767),
  open_mode varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_pluggable_database_node_level_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_pluggable_database_node_level_details_t (
    node_name varchar2,
    open_mode varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

node_name

(required) The Node name of the Database Instance.

open_mode

(required) The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).

Allowed values are: 'READ_ONLY', 'READ_WRITE', 'MOUNTED', 'MIGRATE'

DBMS_CLOUD_OCI_DATABASE_PLUGGABLE_DATABASE_NODE_LEVEL_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_database_pluggable_database_node_level_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_pluggable_database_node_level_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_pluggable_database_node_level_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_PLUGGABLE_DATABASE_T Type

A pluggable database (PDB) is portable collection of schemas, schema objects, and non-schema objects that appears to an Oracle client as a non-container database. To use a PDB, it needs to be plugged into a CDB. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to a tenancy administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_pluggable_database_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  container_database_id varchar2(32767),
  pdb_name varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_created timestamp with time zone,
  connection_strings dbms_cloud_oci_database_pluggable_database_connection_strings_t,
  open_mode varchar2(32767),
  is_restricted number,
  compartment_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  pluggable_database_management_config dbms_cloud_oci_database_pluggable_database_management_config_t,
  refreshable_clone_config dbms_cloud_oci_database_pluggable_database_refreshable_clone_config_t,
  pdb_node_level_details dbms_cloud_oci_database_pluggable_database_node_level_details_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_pluggable_database_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_pluggable_database_t (
    id varchar2,
    container_database_id varchar2,
    pdb_name varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_created timestamp with time zone,
    connection_strings dbms_cloud_oci_database_pluggable_database_connection_strings_t,
    open_mode varchar2,
    is_restricted number,
    compartment_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    pluggable_database_management_config dbms_cloud_oci_database_pluggable_database_management_config_t,
    refreshable_clone_config dbms_cloud_oci_database_pluggable_database_refreshable_clone_config_t,
    pdb_node_level_details dbms_cloud_oci_database_pluggable_database_node_level_details_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the pluggable database.

container_database_id

(required) The OCID of the CDB.

pdb_name

(required) The name for the pluggable database (PDB). The name is unique in the context of a DATABASE Type. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name.

lifecycle_state

(required) The current state of the pluggable database.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'TERMINATING', 'TERMINATED', 'UPDATING', 'FAILED', 'RELOCATING', 'RELOCATED', 'REFRESHING', 'RESTORE_IN_PROGRESS', 'RESTORE_FAILED', 'BACKUP_IN_PROGRESS', 'DISABLED'

lifecycle_details

(optional) Detailed message for the lifecycle state.

time_created

(required) The date and time the pluggable database was created.

connection_strings

(optional)

open_mode

(required) **Deprecated.** Use PLUGGABLE_DATABASE_NODE_LEVEL_DETAILS Function for OpenMode details. The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).

Allowed values are: 'READ_ONLY', 'READ_WRITE', 'MOUNTED', 'MIGRATE'

is_restricted

(optional) The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.

compartment_id

(required) The OCID of the compartment.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

pluggable_database_management_config

(optional)

refreshable_clone_config

(optional)

pdb_node_level_details

(optional) Pluggable Database Node Level Details. Example: [{\"nodeName\" : \"node1\", \"openMode\" : \"READ_WRITE\"}, {\"nodeName\" : \"node2\", \"openMode\" : \"READ_ONLY\"}]

DBMS_CLOUD_OCI_DATABASE_PLUGGABLE_DATABASE_SUMMARY_T Type

A pluggable database (PDB) is portable collection of schemas, schema objects, and non-schema objects that appears to an Oracle client as a non-container database. To use a PDB, it needs to be plugged into a CDB. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to a tenancy administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_pluggable_database_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  container_database_id varchar2(32767),
  pdb_name varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_created timestamp with time zone,
  connection_strings dbms_cloud_oci_database_pluggable_database_connection_strings_t,
  open_mode varchar2(32767),
  is_restricted number,
  compartment_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  pluggable_database_management_config dbms_cloud_oci_database_pluggable_database_management_config_t,
  refreshable_clone_config dbms_cloud_oci_database_pluggable_database_refreshable_clone_config_t,
  pdb_node_level_details dbms_cloud_oci_database_pluggable_database_node_level_details_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_pluggable_database_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_pluggable_database_summary_t (
    id varchar2,
    container_database_id varchar2,
    pdb_name varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_created timestamp with time zone,
    connection_strings dbms_cloud_oci_database_pluggable_database_connection_strings_t,
    open_mode varchar2,
    is_restricted number,
    compartment_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    pluggable_database_management_config dbms_cloud_oci_database_pluggable_database_management_config_t,
    refreshable_clone_config dbms_cloud_oci_database_pluggable_database_refreshable_clone_config_t,
    pdb_node_level_details dbms_cloud_oci_database_pluggable_database_node_level_details_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the pluggable database.

container_database_id

(required) The OCID of the CDB.

pdb_name

(required) The name for the pluggable database (PDB). The name is unique in the context of a DATABASE Type. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name.

lifecycle_state

(required) The current state of the pluggable database.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'TERMINATING', 'TERMINATED', 'UPDATING', 'FAILED', 'RELOCATING', 'RELOCATED', 'REFRESHING', 'RESTORE_IN_PROGRESS', 'RESTORE_FAILED', 'BACKUP_IN_PROGRESS', 'DISABLED'

lifecycle_details

(optional) Detailed message for the lifecycle state.

time_created

(required) The date and time the pluggable database was created.

connection_strings

(optional)

open_mode

(required) **Deprecated.** Use PLUGGABLE_DATABASE_NODE_LEVEL_DETAILS Function for OpenMode details. The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).

Allowed values are: 'READ_ONLY', 'READ_WRITE', 'MOUNTED', 'MIGRATE'

is_restricted

(optional) The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.

compartment_id

(required) The OCID of the compartment.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

pluggable_database_management_config

(optional)

refreshable_clone_config

(optional)

pdb_node_level_details

(optional) Pluggable Database Node Level Details. Example: [{\"nodeName\" : \"node1\", \"openMode\" : \"READ_WRITE\"}, {\"nodeName\" : \"node2\", \"openMode\" : \"READ_ONLY\"}]

DBMS_CLOUD_OCI_DATABASE_REFRESHABLE_CLONE_SUMMARY_T Type

An Autonomous Database refreshable clone

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_refreshable_clone_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  l_region varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_refreshable_clone_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_refreshable_clone_summary_t (
    id varchar2,
    l_region varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the Autonomous Database.

l_region

(required) The name of the region where the refreshable clone exists.

DBMS_CLOUD_OCI_DATABASE_REFRESHABLE_CLONE_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_database_refreshable_clone_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_refreshable_clone_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_refreshable_clone_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_REFRESHABLE_CLONE_COLLECTION_T Type

A list of Autonomous Database RefreshableClone containing RefreshableCloneSummary items.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_refreshable_clone_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_database_refreshable_clone_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_refreshable_clone_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_refreshable_clone_collection_t (
    items dbms_cloud_oci_database_refreshable_clone_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required)

DBMS_CLOUD_OCI_DATABASE_REGISTER_AUTONOMOUS_DATABASE_DATA_SAFE_DETAILS_T Type

Details for registering an Autonomous Database with Data Safe.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_register_autonomous_database_data_safe_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  pdb_admin_password varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_register_autonomous_database_data_safe_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_register_autonomous_database_data_safe_details_t (
    pdb_admin_password varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

pdb_admin_password

(required) 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.

DBMS_CLOUD_OCI_DATABASE_REINSTATE_DATA_GUARD_ASSOCIATION_DETAILS_T Type

The Data Guard association reinstate parameters.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_reinstate_data_guard_association_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  database_admin_password varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_reinstate_data_guard_association_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_reinstate_data_guard_association_details_t (
    database_admin_password varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

database_admin_password

(required) The DB system administrator password.

DBMS_CLOUD_OCI_DATABASE_REMOTE_CLONE_PLUGGABLE_DATABASE_DETAILS_T Type

**Deprecated.** Use CREATE_PLUGGABLE_DATABASE_DETAILS Function for Pluggable Database RemoteClone Operation. Parameters for cloning a pluggable database (PDB) in a remote database (CDB). A remote CDB is one that does not contain the source PDB. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_remote_clone_pluggable_database_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  target_container_database_id varchar2(32767),
  source_container_db_admin_password varchar2(32767),
  cloned_pdb_name varchar2(32767),
  pdb_admin_password varchar2(32767),
  target_tde_wallet_password varchar2(32767),
  should_pdb_admin_account_be_locked number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_remote_clone_pluggable_database_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_remote_clone_pluggable_database_details_t (
    target_container_database_id varchar2,
    source_container_db_admin_password varchar2,
    cloned_pdb_name varchar2,
    pdb_admin_password varchar2,
    target_tde_wallet_password varchar2,
    should_pdb_admin_account_be_locked number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

target_container_database_id

(required) The OCID of the target CDB

source_container_db_admin_password

(required) The DB system administrator password of the source CDB.

cloned_pdb_name

(required) The name for the pluggable database (PDB). The name is unique in the context of a DATABASE Type. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name.

pdb_admin_password

(optional) A strong password for PDB Admin of the newly cloned PDB. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, \\#, or -.

target_tde_wallet_password

(optional) The existing TDE wallet password of the target CDB.

should_pdb_admin_account_be_locked

(optional) The locked mode of the pluggable database admin account. If false, the user needs to provide the PDB Admin Password to connect to it. If true, the pluggable database will be locked and user cannot login to it.

DBMS_CLOUD_OCI_DATABASE_REMOVE_VIRTUAL_MACHINE_FROM_CLOUD_VM_CLUSTER_DETAILS_T Type

Details of removing Virtual Machines from the Cloud VM Cluster. Applies to Exadata Cloud instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_remove_virtual_machine_from_cloud_vm_cluster_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  db_servers dbms_cloud_oci_database_cloud_db_server_details_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_remove_virtual_machine_from_cloud_vm_cluster_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_remove_virtual_machine_from_cloud_vm_cluster_details_t (
    db_servers dbms_cloud_oci_database_cloud_db_server_details_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

db_servers

(required) The list of ExaDB-D DB server for the cluster to be removed.

DBMS_CLOUD_OCI_DATABASE_REMOVE_VIRTUAL_MACHINE_FROM_VM_CLUSTER_DETAILS_T Type

Details of removing Virtual Machines from the VM Cluster. Applies to Exadata Cloud@Customer instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_remove_virtual_machine_from_vm_cluster_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  db_servers dbms_cloud_oci_database_db_server_details_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_remove_virtual_machine_from_vm_cluster_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_remove_virtual_machine_from_vm_cluster_details_t (
    db_servers dbms_cloud_oci_database_db_server_details_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

db_servers

(required) The list of Exacc DB servers for the cluster to be removed.

DBMS_CLOUD_OCI_DATABASE_NODE_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_database_node_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_node_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_node_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_VM_NETWORK_DETAILS_T Type

Details of the client or backup networks in an Exadata VM cluster network. Applies to Exadata Cloud@Customer instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_vm_network_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  vlan_id varchar2(32767),
  network_type varchar2(32767),
  netmask varchar2(32767),
  gateway varchar2(32767),
  domain_name varchar2(32767),
  nodes dbms_cloud_oci_database_node_details_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_vm_network_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_vm_network_details_t (
    vlan_id varchar2,
    network_type varchar2,
    netmask varchar2,
    gateway varchar2,
    domain_name varchar2,
    nodes dbms_cloud_oci_database_node_details_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

vlan_id

(optional) The network VLAN ID.

network_type

(required) The network type.

Allowed values are: 'CLIENT', 'BACKUP', 'DISASTER_RECOVERY'

netmask

(optional) The network netmask.

gateway

(optional) The network gateway.

domain_name

(optional) The network domain name.

nodes

(required) The list of node details.

DBMS_CLOUD_OCI_DATABASE_VM_NETWORK_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_database_vm_network_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_vm_network_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_vm_network_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_RESIZE_VM_CLUSTER_NETWORK_DETAILS_T Type

Details of Db server network nodes to extend or shrink the VM cluster network. Applies to Exadata Cloud@Customer instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_resize_vm_cluster_network_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  action varchar2(32767),
  vm_networks dbms_cloud_oci_database_vm_network_details_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_resize_vm_cluster_network_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_resize_vm_cluster_network_details_t (
    action varchar2,
    vm_networks dbms_cloud_oci_database_vm_network_details_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

action

(required) Actions that can be performed on the VM cluster network. ADD_DBSERVER_NETWORK - Provide Db server network details of network nodes to be added to the VM cluster network. REMOVE_DBSERVER_NETWORK - Provide Db server network details of network nodes to be removed from the VM cluster network.

Allowed values are: 'ADD_DBSERVER_NETWORK', 'REMOVE_DBSERVER_NETWORK'

vm_networks

(required) Details of the client and backup networks.

DBMS_CLOUD_OCI_DATABASE_RESOURCE_POOL_SHAPE_SUMMARY_T Type

An Autonomous Database Resource Pool. This object provides all the information related to the resource pool.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_resource_pool_shape_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  shape number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_resource_pool_shape_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_resource_pool_shape_summary_t (
    shape number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

shape

(required) Predefined shape of the resource pool.

DBMS_CLOUD_OCI_DATABASE_RESOURCE_POOL_SHAPE_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_database_resource_pool_shape_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_resource_pool_shape_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_resource_pool_shape_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_RESOURCE_POOL_SHAPE_COLLECTION_T Type

Results of an Autonomous Database resouce pool shape collection that contains ResourcePoolShapeSummary items.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_resource_pool_shape_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_database_resource_pool_shape_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_resource_pool_shape_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_resource_pool_shape_collection_t (
    items dbms_cloud_oci_database_resource_pool_shape_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(optional) List of Autonomous Database resource pools Shapes.

DBMS_CLOUD_OCI_DATABASE_RESTORE_AUTONOMOUS_DATABASE_DETAILS_T Type

Details to restore an Oracle Autonomous Database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_restore_autonomous_database_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  l_timestamp timestamp with time zone,
  database_scn varchar2(32767),
  latest number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_restore_autonomous_database_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_restore_autonomous_database_details_t (
    l_timestamp timestamp with time zone,
    database_scn varchar2,
    latest number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

l_timestamp

(required) The time to restore the database to.

database_scn

(optional) Restores using the backup with the System Change Number (SCN) specified.

latest

(optional) Restores to the last known good state with the least possible data loss.

DBMS_CLOUD_OCI_DATABASE_RESTORE_DATABASE_DETAILS_T Type

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_restore_database_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  database_scn varchar2(32767),
  l_timestamp timestamp with time zone,
  latest number,
  pluggable_database_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_restore_database_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_restore_database_details_t (
    database_scn varchar2,
    l_timestamp timestamp with time zone,
    latest number,
    pluggable_database_name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

database_scn

(optional) Restores using the backup with the System Change Number (SCN) specified. This field is applicable for both use cases - Restoring Container Database or Restoring specific Pluggable Database.

l_timestamp

(optional) Restores to the timestamp specified.

latest

(optional) Restores to the last known good state with the least possible data loss.

pluggable_database_name

(optional) Restores only the Pluggable Database (if specified) using the inputs provided in request.

DBMS_CLOUD_OCI_DATABASE_ROTATE_AUTONOMOUS_VM_CLUSTER_ORDS_CERTS_DETAILS_T Type

The details for configuring the SSL certificates on Autonomous VM Cluster

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_rotate_autonomous_vm_cluster_ords_certs_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  certificate_generation_type varchar2(32767),
  certificate_id varchar2(32767),
  certificate_authority_id varchar2(32767),
  ca_bundle_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_rotate_autonomous_vm_cluster_ords_certs_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_rotate_autonomous_vm_cluster_ords_certs_details_t (
    certificate_generation_type varchar2,
    certificate_id varchar2,
    certificate_authority_id varchar2,
    ca_bundle_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

certificate_generation_type

(required) Specify SYSTEM to use Oracle-managed certificates. Specify BYOC when you want to bring your own certificate.

Allowed values are: 'SYSTEM', 'BYOC'

certificate_id

(optional) The OCID of the certificate to use.

certificate_authority_id

(optional) The OCID of the certificate authority.

ca_bundle_id

(optional) The OCID of the certificate bundle.

DBMS_CLOUD_OCI_DATABASE_ROTATE_AUTONOMOUS_VM_CLUSTER_SSL_CERTS_DETAILS_T Type

Details for configuring the ORDS certificates on Autonomous Exadata VM Cluster

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_rotate_autonomous_vm_cluster_ssl_certs_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  certificate_generation_type varchar2(32767),
  certificate_id varchar2(32767),
  certificate_authority_id varchar2(32767),
  ca_bundle_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_rotate_autonomous_vm_cluster_ssl_certs_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_rotate_autonomous_vm_cluster_ssl_certs_details_t (
    certificate_generation_type varchar2,
    certificate_id varchar2,
    certificate_authority_id varchar2,
    ca_bundle_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

certificate_generation_type

(required) Specify SYSTEM to use Oracle-managed certificates. Specify BYOC when you want to bring your own certificate.

Allowed values are: 'SYSTEM', 'BYOC'

certificate_id

(optional) The OCID of the certificate to use.

certificate_authority_id

(optional) The OCID of the certificate authority.

ca_bundle_id

(optional) The OCID of the certificate bundle.

DBMS_CLOUD_OCI_DATABASE_ROTATE_CLOUD_AUTONOMOUS_VM_CLUSTER_ORDS_CERTS_DETAILS_T Type

The details for configuring the ORDS certificates on Cloud Autonomous VM Cluster

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_rotate_cloud_autonomous_vm_cluster_ords_certs_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  certificate_generation_type varchar2(32767),
  certificate_id varchar2(32767),
  certificate_authority_id varchar2(32767),
  ca_bundle_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_rotate_cloud_autonomous_vm_cluster_ords_certs_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_rotate_cloud_autonomous_vm_cluster_ords_certs_details_t (
    certificate_generation_type varchar2,
    certificate_id varchar2,
    certificate_authority_id varchar2,
    ca_bundle_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

certificate_generation_type

(required) Specify SYSTEM to use Oracle-managed certificates. Specify BYOC when you want to bring your own certificate.

Allowed values are: 'SYSTEM', 'BYOC'

certificate_id

(optional) The OCID of the certificate to use.

certificate_authority_id

(optional) The OCID of the certificate authority.

ca_bundle_id

(optional) The OCID of the certificate bundle.

DBMS_CLOUD_OCI_DATABASE_ROTATE_CLOUD_AUTONOMOUS_VM_CLUSTER_SSL_CERTS_DETAILS_T Type

The details for configuring the SSL certificates on Cloud Autonomous VM Cluster

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_rotate_cloud_autonomous_vm_cluster_ssl_certs_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  certificate_generation_type varchar2(32767),
  certificate_id varchar2(32767),
  certificate_authority_id varchar2(32767),
  ca_bundle_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_rotate_cloud_autonomous_vm_cluster_ssl_certs_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_rotate_cloud_autonomous_vm_cluster_ssl_certs_details_t (
    certificate_generation_type varchar2,
    certificate_id varchar2,
    certificate_authority_id varchar2,
    ca_bundle_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

certificate_generation_type

(required) Specify SYSTEM to use Oracle-managed certificates. Specify BYOC when you want to bring your own certificate.

Allowed values are: 'SYSTEM', 'BYOC'

certificate_id

(optional) The OCID of the certificate to use.

certificate_authority_id

(optional) The OCID of the certificate authority.

ca_bundle_id

(optional) The OCID of the certificate bundle.

DBMS_CLOUD_OCI_DATABASE_SAAS_ADMIN_USER_CONFIGURATION_T Type

SaaS administrative user configuration.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_saas_admin_user_configuration_t FORCE AUTHID CURRENT_USER IS OBJECT (
  password varchar2(32767),
  secret_id varchar2(32767),
  secret_version_number number,
  duration number,
  is_enabled number,
  access_type varchar2(32767),
  time_saas_admin_user_enabled timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_saas_admin_user_configuration_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_saas_admin_user_configuration_t (
    password varchar2,
    secret_id varchar2,
    secret_version_number number,
    duration number,
    is_enabled number,
    access_type varchar2,
    time_saas_admin_user_enabled timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

password

(optional) A strong password for SaaS administrative user. The password must be a minimum of nine (9) characters and contain a minimum of two (2) uppercase, two (2) lowercase, two (2) numbers, and two (2) special characters from _ (underscore), \\# (hashtag), or - (dash).

secret_id

(optional) The OCID of the Oracle Cloud Infrastructure secret.

secret_version_number

(optional) The version of the vault secret. If no version is specified, the latest version will be used.

duration

(optional) How long, in hours, the SaaS administrative user will stay enabled. If no duration is specified, the default value 1 will be used.

is_enabled

(optional) Indicates if the SaaS administrative user is enabled for the Autonomous Database.

access_type

(optional) The access type for the SaaS administrative user. If no access type is specified, the READ_ONLY access type is used.

Allowed values are: 'READ_ONLY', 'READ_WRITE', 'ADMIN'

time_saas_admin_user_enabled

(optional) The date and time the SaaS administrative user was enabled at, for the Autonomous Database.

DBMS_CLOUD_OCI_DATABASE_SAAS_ADMIN_USER_STATUS_T Type

SaaS administrative user status.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_saas_admin_user_status_t FORCE AUTHID CURRENT_USER IS OBJECT (
  is_enabled number,
  access_type varchar2(32767),
  time_saas_admin_user_enabled timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_saas_admin_user_status_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_saas_admin_user_status_t (
    is_enabled number,
    access_type varchar2,
    time_saas_admin_user_enabled timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

is_enabled

(optional) Indicates if the SaaS administrative user is enabled for the Autonomous Database.

access_type

(optional) The access type for the SaaS administrative user. If no access type is specified, the READ_ONLY access type is used.

Allowed values are: 'READ_ONLY', 'READ_WRITE', 'ADMIN'

time_saas_admin_user_enabled

(optional) The date and time the SaaS administrative user was enabled at, for the Autonomous Database.

DBMS_CLOUD_OCI_DATABASE_SCAN_DETAILS_T Type

The Single Client Access Name (SCAN) details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_scan_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  hostname varchar2(32767),
  port number,
  scan_listener_port_tcp number,
  scan_listener_port_tcp_ssl number,
  ips dbms_cloud_oci_database_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_scan_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_scan_details_t (
    hostname varchar2,
    port number,
    scan_listener_port_tcp number,
    scan_listener_port_tcp_ssl number,
    ips dbms_cloud_oci_database_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

hostname

(required) The SCAN hostname.

port

(optional) **Deprecated.** This field is deprecated. You may use 'scanListenerPortTcp' to specify the port. The SCAN TCPIP port. Default is 1521.

scan_listener_port_tcp

(optional) The SCAN TCPIP port. Default is 1521.

scan_listener_port_tcp_ssl

(optional) The SCAN TCPIP SSL port. Default is 2484.

ips

(required) The list of SCAN IP addresses. Three addresses should be provided.

DBMS_CLOUD_OCI_DATABASE_SELF_MOUNT_DETAILS_T Type

Used for creating NFS Self mount backup destinations for non-autonomous ExaCC.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_self_mount_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_mount_type_details_t (
  local_mount_point_path varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_self_mount_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_self_mount_details_t (
    mount_type varchar2,
    local_mount_point_path varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_self_mount_details_t is a subtype of the dbms_cloud_oci_database_mount_type_details_t type.

Fields

Field Description

local_mount_point_path

(required) The local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes.

DBMS_CLOUD_OCI_DATABASE_SWITCHOVER_DATA_GUARD_ASSOCIATION_DETAILS_T Type

The Data Guard association switchover parameters.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_switchover_data_guard_association_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  database_admin_password varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_switchover_data_guard_association_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_switchover_data_guard_association_details_t (
    database_admin_password varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

database_admin_password

(required) The DB system administrator password.

DBMS_CLOUD_OCI_DATABASE_SYSTEM_VERSION_SUMMARY_T Type

List of compatible Exadata system versions for a given shape and GI version.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_system_version_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  shape varchar2(32767),
  gi_version varchar2(32767),
  system_versions dbms_cloud_oci_database_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_system_version_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_system_version_summary_t (
    shape varchar2,
    gi_version varchar2,
    system_versions dbms_cloud_oci_database_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

shape

(required) Exadata shape.

gi_version

(required) Grid Infrastructure version.

system_versions

(optional) Compatible Exadata system versions for a given shape and GI version.

DBMS_CLOUD_OCI_DATABASE_SYSTEM_VERSION_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_database_system_version_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_system_version_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_system_version_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_SYSTEM_VERSION_COLLECTION_T Type

Results of the System version lists. Contains SystemVersionSummary items.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_system_version_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_database_system_version_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_system_version_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_system_version_collection_t (
    items dbms_cloud_oci_database_system_version_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of System versions.

DBMS_CLOUD_OCI_DATABASE_UPDATE_T Type

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  description varchar2(32767),
  last_action varchar2(32767),
  available_actions dbms_cloud_oci_database_varchar2_tbl,
  update_type varchar2(32767),
  lifecycle_details varchar2(32767),
  lifecycle_state varchar2(32767),
  time_released timestamp with time zone,
  version varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_t (
    id varchar2,
    description varchar2,
    last_action varchar2,
    available_actions dbms_cloud_oci_database_varchar2_tbl,
    update_type varchar2,
    lifecycle_details varchar2,
    lifecycle_state varchar2,
    time_released timestamp with time zone,
    version varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the maintenance update.

description

(required) Details of the maintenance update package.

last_action

(optional) The previous update action performed.

Allowed values are: 'ROLLING_APPLY', 'NON_ROLLING_APPLY', 'PRECHECK', 'ROLLBACK'

available_actions

(optional) The possible actions performed by the update operation on the infrastructure components.

Allowed values are: 'ROLLING_APPLY', 'NON_ROLLING_APPLY', 'PRECHECK', 'ROLLBACK'

update_type

(required) The type of cloud VM cluster maintenance update.

Allowed values are: 'GI_UPGRADE', 'GI_PATCH', 'OS_UPDATE'

lifecycle_details

(optional) Descriptive text providing additional details about the lifecycle state.

lifecycle_state

(optional) The current state of the maintenance update. Dependent on value of `lastAction`.

Allowed values are: 'AVAILABLE', 'SUCCESS', 'IN_PROGRESS', 'FAILED'

time_released

(required) The date and time the maintenance update was released.

version

(required) The version of the maintenance update package.

DBMS_CLOUD_OCI_DATABASE_UPDATE_AUTONOMOUS_CONTAINER_DATABASE_DATA_GUARD_ASSOCIATION_DETAILS_T Type

The configuration details for updating a Autonomous Container DatabaseData Guard association for a Autonomous Container Database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_autonomous_container_database_data_guard_association_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  is_automatic_failover_enabled number,
  protection_mode varchar2(32767),
  fast_start_fail_over_lag_limit_in_seconds number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_autonomous_container_database_data_guard_association_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_autonomous_container_database_data_guard_association_details_t (
    is_automatic_failover_enabled number,
    protection_mode varchar2,
    fast_start_fail_over_lag_limit_in_seconds number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

is_automatic_failover_enabled

(optional) Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association

protection_mode

(optional) The protection mode of this Autonomous Data Guard association. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

Allowed values are: 'MAXIMUM_AVAILABILITY', 'MAXIMUM_PERFORMANCE'

fast_start_fail_over_lag_limit_in_seconds

(optional) The lag time for my preference based on data loss tolerance in seconds.

DBMS_CLOUD_OCI_DATABASE_UPDATE_AUTONOMOUS_CONTAINER_DATABASE_DETAILS_T Type

Describes the modification parameters for the Autonomous Container Database.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_autonomous_container_database_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  patch_model varchar2(32767),
  maintenance_window_details dbms_cloud_oci_database_maintenance_window_t,
  standby_maintenance_buffer_in_days number,
  version_preference varchar2(32767),
  is_dst_file_update_enabled number,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  backup_config dbms_cloud_oci_database_autonomous_container_database_backup_config_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_autonomous_container_database_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_autonomous_container_database_details_t (
    display_name varchar2,
    patch_model varchar2,
    maintenance_window_details dbms_cloud_oci_database_maintenance_window_t,
    standby_maintenance_buffer_in_days number,
    version_preference varchar2,
    is_dst_file_update_enabled number,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    backup_config dbms_cloud_oci_database_autonomous_container_database_backup_config_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) The display name for the Autonomous Container Database.

patch_model

(optional) Database Patch model preference.

Allowed values are: 'RELEASE_UPDATES', 'RELEASE_UPDATE_REVISIONS'

maintenance_window_details

(optional)

standby_maintenance_buffer_in_days

(optional) The scheduling detail for the quarterly maintenance window of the standby Autonomous Container Database. This value represents the number of days before schedlued maintenance of the primary database.

version_preference

(optional) The next maintenance version preference.

Allowed values are: 'NEXT_RELEASE_UPDATE', 'LATEST_RELEASE_UPDATE'

is_dst_file_update_enabled

(optional) Indicates if an automatic DST Time Zone file update is enabled for the Autonomous Container Database. If enabled along with Release Update, patching will be done in a Non-Rolling manner.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

backup_config

(optional)

DBMS_CLOUD_OCI_DATABASE_UPDATE_AUTONOMOUS_DATABASE_BACKUP_DETAILS_T Type

Details for updating the Autonomous Database backup. **Warning:** Oracle recommends avoiding using confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_autonomous_database_backup_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  retention_period_in_days number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_autonomous_database_backup_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_autonomous_database_backup_details_t (
    retention_period_in_days number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

retention_period_in_days

(optional) Retention period, in days, for long-term backups

DBMS_CLOUD_OCI_DATABASE_UPDATE_AUTONOMOUS_DATABASE_DETAILS_T Type

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

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_autonomous_database_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  backup_retention_period_in_days number,
  compute_model varchar2(32767),
  in_memory_percentage number,
  local_adg_auto_failover_max_data_loss_limit number,
  cpu_core_count number,
  long_term_backup_schedule dbms_cloud_oci_database_long_term_back_up_schedule_details_t,
  compute_count number,
  ocpu_count number,
  data_storage_size_in_t_bs number,
  data_storage_size_in_g_bs number,
  display_name varchar2(32767),
  is_free_tier number,
  admin_password varchar2(32767),
  db_name varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  db_workload varchar2(32767),
  license_model varchar2(32767),
  is_access_control_enabled number,
  whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
  are_primary_whitelisted_ips_used number,
  standby_whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
  is_auto_scaling_enabled number,
  is_refreshable_clone number,
  refreshable_mode varchar2(32767),
  is_local_data_guard_enabled number,
  is_data_guard_enabled number,
  peer_db_id varchar2(32767),
  db_version varchar2(32767),
  open_mode varchar2(32767),
  permission_level varchar2(32767),
  subnet_id varchar2(32767),
  private_endpoint_label varchar2(32767),
  private_endpoint_ip varchar2(32767),
  nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  customer_contacts dbms_cloud_oci_database_customer_contact_tbl,
  is_mtls_connection_required number,
  resource_pool_leader_id varchar2(32767),
  resource_pool_summary dbms_cloud_oci_database_resource_pool_summary_t,
  scheduled_operations dbms_cloud_oci_database_scheduled_operation_details_tbl,
  is_auto_scaling_for_storage_enabled number,
  max_cpu_core_count number,
  database_edition varchar2(32767),
  db_tools_details dbms_cloud_oci_database_database_tool_tbl,
  secret_id varchar2(32767),
  secret_version_number number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_autonomous_database_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_autonomous_database_details_t (
    backup_retention_period_in_days number,
    compute_model varchar2,
    in_memory_percentage number,
    local_adg_auto_failover_max_data_loss_limit number,
    cpu_core_count number,
    long_term_backup_schedule dbms_cloud_oci_database_long_term_back_up_schedule_details_t,
    compute_count number,
    ocpu_count number,
    data_storage_size_in_t_bs number,
    data_storage_size_in_g_bs number,
    display_name varchar2,
    is_free_tier number,
    admin_password varchar2,
    db_name varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    db_workload varchar2,
    license_model varchar2,
    is_access_control_enabled number,
    whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
    are_primary_whitelisted_ips_used number,
    standby_whitelisted_ips dbms_cloud_oci_database_varchar2_tbl,
    is_auto_scaling_enabled number,
    is_refreshable_clone number,
    refreshable_mode varchar2,
    is_local_data_guard_enabled number,
    is_data_guard_enabled number,
    peer_db_id varchar2,
    db_version varchar2,
    open_mode varchar2,
    permission_level varchar2,
    subnet_id varchar2,
    private_endpoint_label varchar2,
    private_endpoint_ip varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    customer_contacts dbms_cloud_oci_database_customer_contact_tbl,
    is_mtls_connection_required number,
    resource_pool_leader_id varchar2,
    resource_pool_summary dbms_cloud_oci_database_resource_pool_summary_t,
    scheduled_operations dbms_cloud_oci_database_scheduled_operation_details_tbl,
    is_auto_scaling_for_storage_enabled number,
    max_cpu_core_count number,
    database_edition varchar2,
    db_tools_details dbms_cloud_oci_database_database_tool_tbl,
    secret_id varchar2,
    secret_version_number number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

backup_retention_period_in_days

(optional) Retention period, in days, for long-term backups

compute_model

(optional) 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.

Allowed values are: 'ECPU', 'OCPU'

in_memory_percentage

(optional) The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous Database.

local_adg_auto_failover_max_data_loss_limit

(optional) 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

cpu_core_count

(optional) The number of CPUs to be made available to the Autonomous Database.<br> For Autonomous Databases on Dedicated Exadata Infrastructure: - The CPU type (OCPUs or ECPUs) is determined by the parent Autonomous Exadata VM Cluster's compute model. - It is suggested to use 'computeCount' parameter if you want to use fractional value to provision less than 1 core. **Note:** This parameter cannot be used with the `ocpuCount` or `computeCount` parameter. This cannot be updated in parallel with any of the following: licenseModel, databaseEdition, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

long_term_backup_schedule

(optional)

compute_count

(optional) The compute amount 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 values in multiples of two. Required when using the computeModel parameter. When using the cpuCoreCount parameter, computeCount must be null. This cannot be updated in parallel with any of the following: licenseModel, databaseEdition, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

ocpu_count

(optional) The number of OCPU cores to be made available to the Autonomous Database. For Autonomous Databases on Dedicated Exadata Infrastructure, you can specify a fractional value for this parameter. Fractional values are not supported for Autonomous Database Serverless instances. To provision less than 1 core, enter a fractional value in an increment of 0.1. To provision 1 or more cores, you must enter an integer between 1 and the maximum number of cores available to the infrastructure shape. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. Likewise, you can provision 2 cores or 3 cores, but not 2.5 cores. The maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details. **Note:** This parameter cannot be used with the `cpuCoreCount` parameter.

data_storage_size_in_t_bs

(optional) The size, in terabytes, of the data volume that will be created and attached to the database. For Autonomous Databases on dedicated Exadata infrastructure, the maximum storage value is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details. A full Exadata service is allocated when the Autonomous Database size is set to the upper limit (384 TB). **Note:** This parameter cannot be used with the `dataStorageSizeInGBs` parameter. This cannot be updated in parallel with any of the following: licenseModel, databaseEdition, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

data_storage_size_in_g_bs

(optional) Applies to dedicated Exadata infrastructure only. The size, in gigabytes, of the data volume that will be created and attached to the database. The maximum storage value depends on the system shape. See Characteristics of Infrastructure Shapes for shape details. **Note:** This parameter cannot be used with the `dataStorageSizeInTBs` parameter.

display_name

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

is_free_tier

(optional) 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

admin_password

(optional) The password must be between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (\") or the username \"admin\", regardless of casing. It must be different from the last four passwords and it must not be a password used within the last 24 hours. This cannot be used in conjunction with with OCI vault secrets (secretId). This cannot be updated in parallel with any of the following: licenseModel, dbEdition, whitelistedIps, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, or isFreeTier.

db_name

(optional) New name for this Autonomous Database. For Autonomous Databases on Dedicated Exadata Infrastructure, the name must begin with an alphabetic character, and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. For Autonomous Database Serverless instances, the name must begin with an alphabetic character, and can contain a maximum of 14 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

db_workload

(optional) The Autonomous Database workload type. The following values are valid: - OLTP - indicates an Autonomous Transaction Processing database - DW - indicates an Autonomous Data Warehouse database - AJD - indicates an Autonomous JSON Database - APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

Allowed values are: 'OLTP', 'DW', 'AJD', 'APEX'

license_model

(optional) 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`. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, maxCpuCoreCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

is_access_control_enabled

(optional) 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.

whitelisted_ips

(optional) 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. 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). Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. 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.

are_primary_whitelisted_ips_used

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

standby_whitelisted_ips

(optional) 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. 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). Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. 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.

is_auto_scaling_enabled

(optional) Indicates whether auto scaling is enabled for the Autonomous Database OCPU core count. Setting to `TRUE` enables auto scaling. Setting to `FALSE` disables auto scaling. The default value is true. Auto scaling is only available for Autonomous Database Serverless instances.

is_refreshable_clone

(optional) 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.

refreshable_mode

(optional) The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous Database.

Allowed values are: 'AUTOMATIC', 'MANUAL'

is_local_data_guard_enabled

(optional) Indicates whether the Autonomous Database has a local (in-region) standby database. Not applicable when creating a cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. To create a local standby, set to `TRUE`. To delete a local standby, set to `FALSE`. For more information on using Autonomous Data Guard on an Autonomous Database Serverless instance (local and cross-region) , see About Standby Databases . This cannot be updated in parallel with any of the following: isMTLSRequired, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

is_data_guard_enabled

(optional) ** Deprecated. ** Indicates whether the Autonomous Database has a local (in-region) standby database. Not applicable when creating a cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. To create a local standby, set to `TRUE`. To delete a local standby, set to `FALSE`. For more information on using Autonomous Data Guard on an Autonomous Database Serverless instance (local and cross-region) , see About Standby Databases . To delete a cross-region standby database, provide the `peerDbId` for the standby database in a remote region, and set `isDataGuardEnabled` to `FALSE`.

peer_db_id

(optional) The OCID of the Autonomous Data Guard standby database located in a different (remote) region from the source primary Autonomous Database. To create or delete a local (in-region) standby, see the `isDataGuardEnabled` parameter.

db_version

(optional) A valid Oracle Database version for Autonomous Database.

open_mode

(optional) Indicates the Autonomous Database mode. The database can be opened in `READ_ONLY` or `READ_WRITE` mode. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

Allowed values are: 'READ_ONLY', 'READ_WRITE'

permission_level

(optional) The Autonomous Database permission level. Restricted mode allows access only by admin users. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

Allowed values are: 'RESTRICTED', 'UNRESTRICTED'

subnet_id

(optional) The OCID of the subnet the resource is associated with. **Subnet Restrictions:** - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. - For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20. - For Autonomous Database, setting this will disable public secure access to the database. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.

private_endpoint_label

(optional) The resource's private endpoint label. Setting this to an empty string, after the creation of the private endpoint database, changes the private endpoint database to a public endpoint database. 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.

private_endpoint_ip

(optional) The private endpoint Ip address for the resource.

nsg_ids

(optional) 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.

customer_contacts

(optional) Customer Contacts. Setting this to an empty list removes all customer contacts of an Oracle This cannot be updated in parallel with any of the following: isMTLSConnectionRequired, scheduledOperations, or dbToolsDetails.

is_mtls_connection_required

(optional) Specifies if the Autonomous Database requires mTLS connections. This may not be updated in parallel with any of the following: licenseModel, databaseEdition, cpuCoreCount, computeCount, maxCpuCoreCount, 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.

resource_pool_leader_id

(optional) The unique identifier for leader autonomous database OCID OCID.

resource_pool_summary

(optional)

scheduled_operations

(optional) The list of scheduled operations. 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.

is_auto_scaling_for_storage_enabled

(optional) Indicates if auto scaling is enabled for the Autonomous Database storage. The default value is `FALSE`.

max_cpu_core_count

(optional) The number of Max OCPU cores to be made available to the autonomous database with auto scaling of cpu enabled.

database_edition

(optional) The Oracle Database Edition that applies to the Autonomous databases. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

db_tools_details

(optional) 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.

secret_id

(optional) The OCI vault secret [/Content/General/Concepts/identifiers.htm]OCID. This cannot be used in conjunction with adminPassword.

secret_version_number

(optional) The version of the vault secret. If no version is specified, the latest version will be used.

DBMS_CLOUD_OCI_DATABASE_UPDATE_AUTONOMOUS_DATABASE_WALLET_DETAILS_T Type

Details to update an Autonomous Database wallet.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_autonomous_database_wallet_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  should_rotate number,
  grace_period number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_autonomous_database_wallet_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_autonomous_database_wallet_details_t (
    should_rotate number,
    grace_period number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

should_rotate

(optional) Indicates whether to rotate the wallet or not. If `false`, the wallet will not be rotated. The default is `false`.

grace_period

(optional) The number of hours that the old wallet can be used after it has been rotated. The old wallet will no longer be valid after the number of hours in the wallet rotation grace period has passed. During the grace period, both the old wallet and the current wallet can be used.

DBMS_CLOUD_OCI_DATABASE_UPDATE_AUTONOMOUS_EXADATA_INFRASTRUCTURE_DETAILS_T Type

Describes the modification parameters for the Autonomous Exadata Infrastructure.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_autonomous_exadata_infrastructure_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  maintenance_window_details dbms_cloud_oci_database_maintenance_window_t,
  nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_autonomous_exadata_infrastructure_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_autonomous_exadata_infrastructure_details_t (
    display_name varchar2,
    maintenance_window_details dbms_cloud_oci_database_maintenance_window_t,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) The display name is a user-friendly name for the Autonomous Exadata Infrastructure. The display name does not have to be unique.

maintenance_window_details

(optional)

nsg_ids

(optional) 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.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_UPDATE_AUTONOMOUS_VM_CLUSTER_DETAILS_T Type

Details for updating the Autonomous VM cluster.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_autonomous_vm_cluster_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  maintenance_window_details dbms_cloud_oci_database_maintenance_window_t,
  license_model varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  autonomous_data_storage_size_in_t_bs number,
  cpu_core_count_per_node number,
  total_container_databases number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_autonomous_vm_cluster_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_autonomous_vm_cluster_details_t (
    maintenance_window_details dbms_cloud_oci_database_maintenance_window_t,
    license_model varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    autonomous_data_storage_size_in_t_bs number,
    cpu_core_count_per_node number,
    total_container_databases number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

maintenance_window_details

(optional)

license_model

(optional) The Oracle license model that applies to the Autonomous VM cluster. The default is BRING_YOUR_OWN_LICENSE.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

autonomous_data_storage_size_in_t_bs

(optional) The new scaled up/down value for autonomous data storage in TBs for Autonomous VM cluster.

cpu_core_count_per_node

(optional) The new scaled up/down value for cpus per Autonomous VM cluster per node.

total_container_databases

(optional) The new scaled up/down value for maxACD count for Autonomous VM cluster.

DBMS_CLOUD_OCI_DATABASE_UPDATE_BACKUP_DESTINATION_DETAILS_T Type

For a RECOVERY_APPLIANCE backup destination, used to update the connection string and/or the list of VPC users. For an NFS backup destination, there are 2 mount types - Self mount used for non-autonomous ExaCC and automated mount used for autonomous on ExaCC.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_backup_destination_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  vpc_users dbms_cloud_oci_database_varchar2_tbl,
  connection_string varchar2(32767),
  local_mount_point_path varchar2(32767),
  nfs_mount_type varchar2(32767),
  nfs_server dbms_cloud_oci_database_varchar2_tbl,
  nfs_server_export varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_backup_destination_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_backup_destination_details_t (
    vpc_users dbms_cloud_oci_database_varchar2_tbl,
    connection_string varchar2,
    local_mount_point_path varchar2,
    nfs_mount_type varchar2,
    nfs_server dbms_cloud_oci_database_varchar2_tbl,
    nfs_server_export varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

vpc_users

(optional) For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance.

connection_string

(optional) For a RECOVERY_APPLIANCE backup destination, the connection string for connecting to the Recovery Appliance.

local_mount_point_path

(optional) The local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes.

nfs_mount_type

(optional) NFS Mount type for backup destination.

Allowed values are: 'SELF_MOUNT', 'AUTOMATED_MOUNT'

nfs_server

(optional) IP addresses for NFS Auto mount.

nfs_server_export

(optional) Specifies the directory on which to mount the file system

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_UPDATE_CLOUD_AUTONOMOUS_VM_CLUSTER_DETAILS_T Type

Details for updating the cloud Autonomous VM cluster.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_cloud_autonomous_vm_cluster_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  description varchar2(32767),
  display_name varchar2(32767),
  maintenance_window_details dbms_cloud_oci_database_maintenance_window_t,
  autonomous_data_storage_size_in_t_bs number,
  cpu_core_count_per_node number,
  total_container_databases number,
  license_model varchar2(32767),
  nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_cloud_autonomous_vm_cluster_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_cloud_autonomous_vm_cluster_details_t (
    description varchar2,
    display_name varchar2,
    maintenance_window_details dbms_cloud_oci_database_maintenance_window_t,
    autonomous_data_storage_size_in_t_bs number,
    cpu_core_count_per_node number,
    total_container_databases number,
    license_model varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

description

(optional) User defined description of the cloud Autonomous VM cluster.

display_name

(optional) The user-friendly name for the cloud Autonomous VM cluster. The name does not need to be unique.

maintenance_window_details

(optional)

autonomous_data_storage_size_in_t_bs

(optional) The new scaled up/down value for exadata storage in TBs for cloud autonomous VM cluster.

cpu_core_count_per_node

(optional) The new scaled up/down value for ocpus for cloud autonomous VM cluster per node.

total_container_databases

(optional) The new scaled up/down value for maxACD count for cloud autonomous VM cluster.

license_model

(optional) 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`. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, maxCpuCoreCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

nsg_ids

(optional) 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.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_UPDATE_CLOUD_EXADATA_INFRASTRUCTURE_DETAILS_T Type

Updates the cloud Exadata infrastructure. Applies to Exadata Cloud Service instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_cloud_exadata_infrastructure_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  maintenance_window dbms_cloud_oci_database_maintenance_window_t,
  compute_count number,
  storage_count number,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  customer_contacts dbms_cloud_oci_database_customer_contact_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_cloud_exadata_infrastructure_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_cloud_exadata_infrastructure_details_t (
    display_name varchar2,
    maintenance_window dbms_cloud_oci_database_maintenance_window_t,
    compute_count number,
    storage_count number,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    customer_contacts dbms_cloud_oci_database_customer_contact_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) The user-friendly name for the cloud Exadata infrastructure. The name does not need to be unique.

maintenance_window

(optional)

compute_count

(optional) The number of compute servers for the cloud Exadata infrastructure.

storage_count

(optional) The number of storage servers for the cloud Exadata infrastructure.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

customer_contacts

(optional) Customer contacts. Setting this to an empty list removes all customer contact information (email addresses) for the specified OCI Database service resource.

DBMS_CLOUD_OCI_DATABASE_UPDATE_DETAILS_T Type

Details specifying which maintenance update to apply to the cloud VM cluster and which actions are to be performed by the maintenance update. Applies to Exadata Cloud Service instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  update_id varchar2(32767),
  update_action varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_details_t (
    update_id varchar2,
    update_action varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

update_id

(optional) The OCID of the maintenance update.

update_action

(optional) The update action.

Allowed values are: 'ROLLING_APPLY', 'NON_ROLLING_APPLY', 'PRECHECK', 'ROLLBACK'

DBMS_CLOUD_OCI_DATABASE_UPDATE_CLOUD_VM_CLUSTER_DETAILS_T Type

Details for updating the cloud VM cluster. Applies to Exadata Cloud Service instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_cloud_vm_cluster_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  cpu_core_count number,
  ocpu_count number,
  memory_size_in_g_bs number,
  db_node_storage_size_in_g_bs number,
  data_storage_size_in_t_bs number,
  license_model varchar2(32767),
  ssh_public_keys dbms_cloud_oci_database_varchar2_tbl,
  update_details dbms_cloud_oci_database_update_details_t,
  nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  backup_network_nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  compute_nodes dbms_cloud_oci_database_varchar2_tbl,
  storage_size_in_g_bs number,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  data_collection_options dbms_cloud_oci_database_data_collection_options_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_cloud_vm_cluster_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_cloud_vm_cluster_details_t (
    display_name varchar2,
    cpu_core_count number,
    ocpu_count number,
    memory_size_in_g_bs number,
    db_node_storage_size_in_g_bs number,
    data_storage_size_in_t_bs number,
    license_model varchar2,
    ssh_public_keys dbms_cloud_oci_database_varchar2_tbl,
    update_details dbms_cloud_oci_database_update_details_t,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    backup_network_nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    compute_nodes dbms_cloud_oci_database_varchar2_tbl,
    storage_size_in_g_bs number,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    data_collection_options dbms_cloud_oci_database_data_collection_options_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) The user-friendly name for the cloud VM cluster. The name does not need to be unique.

cpu_core_count

(optional) The number of CPU cores to enable for the cloud VM cluster.

ocpu_count

(optional) The number of OCPU cores to enable for a cloud VM cluster. Only 1 decimal place is allowed for the fractional part.

memory_size_in_g_bs

(optional) The memory to be allocated in GBs.

db_node_storage_size_in_g_bs

(optional) The local node storage to be allocated in GBs.

data_storage_size_in_t_bs

(optional) The data disk group size to be allocated in TBs.

license_model

(optional) The Oracle license model that applies to the cloud VM cluster. The default is BRING_YOUR_OWN_LICENSE. Applies to Exadata Cloud Service instances only.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

ssh_public_keys

(optional) The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.

update_details

(optional)

nsg_ids

(optional) 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.

backup_network_nsg_ids

(optional) A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

compute_nodes

(optional) The list of compute servers to be added to the cloud VM cluster.

storage_size_in_g_bs

(optional) The disk group size to be allocated in GBs.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

data_collection_options

(optional)

DBMS_CLOUD_OCI_DATABASE_UPDATE_CONSOLE_CONNECTION_DETAILS_T Type

The details for updating a Db node console connection.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_console_connection_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_console_connection_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_console_connection_details_t (
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_UPDATE_CONSOLE_HISTORY_DETAILS_T Type

The details for updating a Db node console history.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_console_history_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  freeform_tags json_element_t,
  defined_tags json_element_t,
  display_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_console_history_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_console_history_details_t (
    freeform_tags json_element_t,
    defined_tags json_element_t,
    display_name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

display_name

(optional) The user-friendly name for the console history. The name does not need to be unique.

DBMS_CLOUD_OCI_DATABASE_UPDATE_DATA_GUARD_ASSOCIATION_DETAILS_T Type

The configuration details for updating a Data Guard association for a database. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_data_guard_association_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  database_admin_password varchar2(32767),
  protection_mode varchar2(32767),
  transport_type varchar2(32767),
  is_active_data_guard_enabled number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_data_guard_association_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_data_guard_association_details_t (
    database_admin_password varchar2,
    protection_mode varchar2,
    transport_type varchar2,
    is_active_data_guard_enabled number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

database_admin_password

(optional) A strong password for the 'SYS', 'SYSTEM', and 'PDB Admin' users to apply during standby creation. The password must contain no fewer than nine characters and include: * At least two uppercase characters. * At least two lowercase characters. * At least two numeric characters. * At least two special characters. Valid special characters include \"_\", \"#\", and \"-\" only. **The password MUST be the same as the primary admin password.**

protection_mode

(optional) The protection mode for the Data Guard association's primary and standby database. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

Allowed values are: 'MAXIMUM_AVAILABILITY', 'MAXIMUM_PERFORMANCE', 'MAXIMUM_PROTECTION'

transport_type

(optional) The redo transport type to use for this Data Guard association. Valid values depend on the specified 'protectionMode': * MAXIMUM_AVAILABILITY - Use SYNC or FASTSYNC * MAXIMUM_PERFORMANCE - Use ASYNC * MAXIMUM_PROTECTION - Use SYNC For more information, see Redo Transport Services in the Oracle Data Guard documentation.

Allowed values are: 'SYNC', 'ASYNC', 'FASTSYNC'

is_active_data_guard_enabled

(optional) True if active Data Guard is enabled. Update this parameter to change the Data Guard setting.

DBMS_CLOUD_OCI_DATABASE_UPDATE_DATABASE_DETAILS_T Type

Details to update a database. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_database_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  db_backup_config dbms_cloud_oci_database_db_backup_config_t,
  db_home_id varchar2(32767),
  new_admin_password varchar2(32767),
  old_tde_wallet_password varchar2(32767),
  new_tde_wallet_password varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_database_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_database_details_t (
    db_backup_config dbms_cloud_oci_database_db_backup_config_t,
    db_home_id varchar2,
    new_admin_password varchar2,
    old_tde_wallet_password varchar2,
    new_tde_wallet_password varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

db_backup_config

(optional)

db_home_id

(optional) The OCID of the Database Home.

new_admin_password

(optional) A new strong password for SYS, SYSTEM, and the plugbable database ADMIN user. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, \\#, or -.

old_tde_wallet_password

(optional) The existing TDE wallet password. You must provide the existing password in order to set a new TDE wallet password.

new_tde_wallet_password

(optional) The new password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, \\#, or -.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_UPDATE_DATABASE_SOFTWARE_IMAGE_DETAILS_T Type

Describes the parameters for updating the Database Software Image

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_database_software_image_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_database_software_image_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_database_software_image_details_t (
    display_name varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) The user-friendly name for the database software image. The name does not have to be unique.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_UPDATE_DB_HOME_DETAILS_T Type

Describes the modification parameters for the Database Home.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_db_home_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  db_version dbms_cloud_oci_database_patch_details_t,
  one_off_patches dbms_cloud_oci_database_varchar2_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_db_home_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_db_home_details_t (
    db_version dbms_cloud_oci_database_patch_details_t,
    one_off_patches dbms_cloud_oci_database_varchar2_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

db_version

(optional)

one_off_patches

(optional) List of one-off patches for Database Homes.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_UPDATE_DB_NODE_DETAILS_T Type

The details for updating a Db node.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_db_node_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_db_node_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_db_node_details_t (
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_UPDATE_DB_SYSTEM_DETAILS_T Type

Describes the parameters for updating the DB system. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_db_system_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  cpu_core_count number,
  version dbms_cloud_oci_database_patch_details_t,
  ssh_public_keys dbms_cloud_oci_database_varchar2_tbl,
  data_storage_size_in_g_bs number,
  reco_storage_size_in_g_bs number,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  shape varchar2(32767),
  nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  backup_network_nsg_ids dbms_cloud_oci_database_varchar2_tbl,
  license_model varchar2(32767),
  maintenance_window_details dbms_cloud_oci_database_maintenance_window_t,
  data_collection_options dbms_cloud_oci_database_data_collection_options_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_db_system_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_db_system_details_t (
    cpu_core_count number,
    version dbms_cloud_oci_database_patch_details_t,
    ssh_public_keys dbms_cloud_oci_database_varchar2_tbl,
    data_storage_size_in_g_bs number,
    reco_storage_size_in_g_bs number,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    shape varchar2,
    nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    backup_network_nsg_ids dbms_cloud_oci_database_varchar2_tbl,
    license_model varchar2,
    maintenance_window_details dbms_cloud_oci_database_maintenance_window_t,
    data_collection_options dbms_cloud_oci_database_data_collection_options_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

cpu_core_count

(optional) The new number of CPU cores to set for the DB system. Not applicable for INTEL based virtual machine DB systems.

version

(optional)

ssh_public_keys

(optional) The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.

data_storage_size_in_g_bs

(optional) The size, in gigabytes, to scale the attached storage up to for this virtual machine DB system. This value must be greater than current storage size. Note that the resulting total storage size attached will be greater than the amount requested to allow for REDO/RECO space and software volume. Applies only to virtual machine DB systems.

reco_storage_size_in_g_bs

(optional) The size, in gigabytes, to scale the attached RECO storage up to for this virtual machine DB system. This value must be greater than current storage size. Note that the resulting total storage size attached will be greater than the amount requested to allow for the software volume. Applies only to virtual machine DB systems.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

shape

(optional) The shape of the DB system. The shape determines resources allocated to the DB system. - For virtual machine shapes, the number of CPU cores and memory To get a list of shapes, use the LIST_DB_SYSTEM_SHAPES Function operation.

nsg_ids

(optional) 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.

backup_network_nsg_ids

(optional) A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

license_model

(optional) The Oracle Database license model that applies to all databases on the DB system. The default is LICENSE_INCLUDED.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

maintenance_window_details

(optional)

data_collection_options

(optional)

DBMS_CLOUD_OCI_DATABASE_UPDATE_EXADATA_INFRASTRUCTURE_DETAILS_T Type

Updates the Exadata infrastructure. Applies to Exadata Cloud@Customer instances only. See UPDATE_CLOUD_EXADATA_INFRASTRUCTURE_DETAILS Function for information on updating Exadata Cloud Service cloud Exadata infrastructure resources.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_exadata_infrastructure_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  cloud_control_plane_server1 varchar2(32767),
  cloud_control_plane_server2 varchar2(32767),
  netmask varchar2(32767),
  gateway varchar2(32767),
  admin_network_cidr varchar2(32767),
  infini_band_network_cidr varchar2(32767),
  corporate_proxy varchar2(32767),
  contacts dbms_cloud_oci_database_exadata_infrastructure_contact_tbl,
  maintenance_window dbms_cloud_oci_database_maintenance_window_t,
  additional_storage_count number,
  is_multi_rack_deployment number,
  multi_rack_configuration_file clob,
  additional_compute_count number,
  additional_compute_system_model varchar2(32767),
  dns_server dbms_cloud_oci_database_varchar2_tbl,
  ntp_server dbms_cloud_oci_database_varchar2_tbl,
  time_zone varchar2(32767),
  is_cps_offline_report_enabled number,
  network_bonding_mode_details dbms_cloud_oci_database_network_bonding_mode_details_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_exadata_infrastructure_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_exadata_infrastructure_details_t (
    cloud_control_plane_server1 varchar2,
    cloud_control_plane_server2 varchar2,
    netmask varchar2,
    gateway varchar2,
    admin_network_cidr varchar2,
    infini_band_network_cidr varchar2,
    corporate_proxy varchar2,
    contacts dbms_cloud_oci_database_exadata_infrastructure_contact_tbl,
    maintenance_window dbms_cloud_oci_database_maintenance_window_t,
    additional_storage_count number,
    is_multi_rack_deployment number,
    multi_rack_configuration_file clob,
    additional_compute_count number,
    additional_compute_system_model varchar2,
    dns_server dbms_cloud_oci_database_varchar2_tbl,
    ntp_server dbms_cloud_oci_database_varchar2_tbl,
    time_zone varchar2,
    is_cps_offline_report_enabled number,
    network_bonding_mode_details dbms_cloud_oci_database_network_bonding_mode_details_t,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

cloud_control_plane_server1

(optional) The IP address for the first control plane server.

cloud_control_plane_server2

(optional) The IP address for the second control plane server.

netmask

(optional) The netmask for the control plane network.

gateway

(optional) The gateway for the control plane network.

admin_network_cidr

(optional) The CIDR block for the Exadata administration network.

infini_band_network_cidr

(optional) The CIDR block for the Exadata InfiniBand interconnect.

corporate_proxy

(optional) The corporate network proxy for access to the control plane network.

contacts

(optional) The list of contacts for the Exadata infrastructure.

maintenance_window

(optional)

additional_storage_count

(optional) The requested number of additional storage servers for the Exadata infrastructure.

is_multi_rack_deployment

(optional) Indicates if deployment is Multi-Rack or not.

multi_rack_configuration_file

(optional) The base64 encoded Multi-Rack configuration json file.

additional_compute_count

(optional) The requested number of additional compute servers for the Exadata infrastructure.

additional_compute_system_model

(optional) Oracle Exadata System Model specification. The system model determines the amount of compute or storage server resources available for use. For more information, please see System and Shape Configuration Options]

Allowed values are: 'X7', 'X8', 'X8M', 'X9M', 'X10M'

dns_server

(optional) The list of DNS server IP addresses. Maximum of 3 allowed.

ntp_server

(optional) The list of NTP server IP addresses. Maximum of 3 allowed.

time_zone

(optional) The time zone of the Exadata infrastructure. For details, see Exadata Infrastructure Time Zones.

is_cps_offline_report_enabled

(optional) Indicates whether cps offline diagnostic report is enabled for this Exadata infrastructure. This will allow a customer to quickly check status themselves and fix problems on their end, saving time and frustration for both Oracle and the customer when they find the CPS in a disconnected state.You can enable offline diagnostic report during Exadata infrastructure provisioning. You can also disable or enable it at any time using the UpdateExadatainfrastructure API.

network_bonding_mode_details

(optional)

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_UPDATE_EXTERNAL_CONTAINER_DATABASE_DETAILS_T Type

Details for updating an external container database. This API is not currently supported.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_external_container_database_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_external_container_database_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_external_container_database_details_t (
    display_name varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(required) The user-friendly name for the external database. The name does not have to be unique.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_UPDATE_EXTERNAL_DATABASE_CONNECTOR_DETAILS_T Type

Details for updating an external database connector.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_external_database_connector_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  freeform_tags json_element_t,
  defined_tags json_element_t,
  display_name varchar2(32767),
  connector_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_external_database_connector_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_external_database_connector_details_t (
    freeform_tags json_element_t,
    defined_tags json_element_t,
    display_name varchar2,
    connector_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

display_name

(optional) The user-friendly name for the CREATE_EXTERNAL_DATABASE_CONNECTOR_DETAILS Function. The name does not have to be unique.

connector_type

(optional) The type of connector used by the external database resource.

Allowed values are: 'MACS'

DBMS_CLOUD_OCI_DATABASE_UPDATE_EXTERNAL_DATABASE_DETAILS_BASE_T Type

Details for updating an external database. This API is not currently supported.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_external_database_details_base_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_external_database_details_base_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_external_database_details_base_t (
    display_name varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(required) The user-friendly name for the external database. The name does not have to be unique.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_UPDATE_EXTERNAL_MACS_CONNECTOR_DETAILS_T Type

Details for updating an external Management Agent cloud service (MACS) database connection.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_external_macs_connector_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_database_update_external_database_connector_details_t (
  connection_string dbms_cloud_oci_database_database_connection_string_t,
  connection_credentials dbms_cloud_oci_database_database_connection_credentials_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_external_macs_connector_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_external_macs_connector_details_t (
    freeform_tags json_element_t,
    defined_tags json_element_t,
    display_name varchar2,
    connector_type varchar2,
    connection_string dbms_cloud_oci_database_database_connection_string_t,
    connection_credentials dbms_cloud_oci_database_database_connection_credentials_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_database_update_external_macs_connector_details_t is a subtype of the dbms_cloud_oci_database_update_external_database_connector_details_t type.

Fields

Field Description

connection_string

(optional)

connection_credentials

(optional)

DBMS_CLOUD_OCI_DATABASE_UPDATE_EXTERNAL_NON_CONTAINER_DATABASE_DETAILS_T Type

Details for updating an external non-container database. This API is not currently supported.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_external_non_container_database_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_external_non_container_database_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_external_non_container_database_details_t (
    display_name varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(required) The user-friendly name for the external database. The name does not have to be unique.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_UPDATE_EXTERNAL_PLUGGABLE_DATABASE_DETAILS_T Type

Details for updating an external pluggable database. This API is not currently supported.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_external_pluggable_database_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_external_pluggable_database_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_external_pluggable_database_details_t (
    display_name varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(required) The user-friendly name for the external database. The name does not have to be unique.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_UPDATE_HISTORY_ENTRY_T Type

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_history_entry_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  update_id varchar2(32767),
  update_action varchar2(32767),
  update_type varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_started timestamp with time zone,
  time_completed timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_history_entry_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_history_entry_t (
    id varchar2,
    update_id varchar2,
    update_action varchar2,
    update_type varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_started timestamp with time zone,
    time_completed timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the maintenance update history entry.

update_id

(required) The OCID of the maintenance update.

update_action

(optional) The update action.

Allowed values are: 'ROLLING_APPLY', 'NON_ROLLING_APPLY', 'PRECHECK', 'ROLLBACK'

update_type

(required) The type of cloud VM cluster maintenance update.

Allowed values are: 'GI_UPGRADE', 'GI_PATCH', 'OS_UPDATE'

lifecycle_state

(required) The current lifecycle state of the maintenance update operation.

Allowed values are: 'IN_PROGRESS', 'SUCCEEDED', 'FAILED'

lifecycle_details

(optional) Descriptive text providing additional details about the lifecycle state.

time_started

(required) The date and time when the maintenance update action started.

time_completed

(optional) The date and time when the maintenance update action completed.

DBMS_CLOUD_OCI_DATABASE_UPDATE_HISTORY_ENTRY_SUMMARY_T Type

The record of an maintenance update action on a specified cloud VM cluster. Applies to Exadata Cloud Service instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_history_entry_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  update_id varchar2(32767),
  update_action varchar2(32767),
  update_type varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_started timestamp with time zone,
  time_completed timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_history_entry_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_history_entry_summary_t (
    id varchar2,
    update_id varchar2,
    update_action varchar2,
    update_type varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_started timestamp with time zone,
    time_completed timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the maintenance update history entry.

update_id

(required) The OCID of the maintenance update.

update_action

(optional) The update action.

Allowed values are: 'ROLLING_APPLY', 'NON_ROLLING_APPLY', 'PRECHECK', 'ROLLBACK'

update_type

(required) The type of cloud VM cluster maintenance update.

Allowed values are: 'GI_UPGRADE', 'GI_PATCH', 'OS_UPDATE'

lifecycle_state

(required) The current lifecycle state of the maintenance update operation.

Allowed values are: 'IN_PROGRESS', 'SUCCEEDED', 'FAILED'

lifecycle_details

(optional) Descriptive text providing additional details about the lifecycle state.

time_started

(required) The date and time when the maintenance update action started.

time_completed

(optional) The date and time when the maintenance update action completed.

DBMS_CLOUD_OCI_DATABASE_UPDATE_KEY_STORE_DETAILS_T Type

Details for updating the key store.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_key_store_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  type_details dbms_cloud_oci_database_key_store_type_details_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_key_store_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_key_store_details_t (
    type_details dbms_cloud_oci_database_key_store_type_details_t,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

type_details

(optional)

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_UPDATE_MAINTENANCE_RUN_DETAILS_T Type

Describes the modification parameters for the maintenance run.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_maintenance_run_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  is_enabled number,
  time_scheduled timestamp with time zone,
  is_patch_now_enabled number,
  patch_id varchar2(32767),
  patching_mode varchar2(32767),
  is_custom_action_timeout_enabled number,
  custom_action_timeout_in_mins number,
  current_custom_action_timeout_in_mins number,
  is_resume_patching number,
  target_db_server_version varchar2(32767),
  target_storage_server_version varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_maintenance_run_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_maintenance_run_details_t (
    is_enabled number,
    time_scheduled timestamp with time zone,
    is_patch_now_enabled number,
    patch_id varchar2,
    patching_mode varchar2,
    is_custom_action_timeout_enabled number,
    custom_action_timeout_in_mins number,
    current_custom_action_timeout_in_mins number,
    is_resume_patching number,
    target_db_server_version varchar2,
    target_storage_server_version varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

is_enabled

(optional) If `FALSE`, skips the maintenance run.

time_scheduled

(optional) The scheduled date and time of the maintenance run to update.

is_patch_now_enabled

(optional) If set to `TRUE`, starts patching immediately.

patch_id

(optional) The OCID of the patch to be applied in the maintenance run.

patching_mode

(optional) Cloud Exadata infrastructure node patching method, either \"ROLLING\" or \"NONROLLING\". Default value is ROLLING. *IMPORTANT*: Non-rolling infrastructure patching involves system down time. See Oracle-Managed Infrastructure Maintenance Updates for more information.

Allowed values are: 'ROLLING', 'NONROLLING'

is_custom_action_timeout_enabled

(optional) If true, enables the configuration of a custom action timeout (waiting period) between database servers patching operations.

custom_action_timeout_in_mins

(optional) Determines the amount of time the system will wait before the start of each database server patching operation. Specify a number of minutes from 15 to 120.

current_custom_action_timeout_in_mins

(optional) The current custom action timeout between the current database servers during waiting state in addition to custom action timeout, from 0 (zero) to 30 minutes.

is_resume_patching

(optional) If true, then the patching is resumed and the next component will be patched immediately.

target_db_server_version

(optional) The target database server system software version for the patching operation.

target_storage_server_version

(optional) The target storage cell system software version for the patching operation.

DBMS_CLOUD_OCI_DATABASE_UPDATE_ONEOFF_PATCH_DETAILS_T Type

Data to update the one-off patch.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_oneoff_patch_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_oneoff_patch_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_oneoff_patch_details_t (
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_UPDATE_PLUGGABLE_DATABASE_DETAILS_T Type

Details for updating a pluggable database (PDB). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_pluggable_database_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_pluggable_database_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_pluggable_database_details_t (
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_UPDATE_SUMMARY_T Type

A maintenance update for a cloud VM cluster. Applies to Exadata Cloud Service instances only. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  description varchar2(32767),
  last_action varchar2(32767),
  available_actions dbms_cloud_oci_database_varchar2_tbl,
  update_type varchar2(32767),
  lifecycle_details varchar2(32767),
  lifecycle_state varchar2(32767),
  time_released timestamp with time zone,
  version varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_summary_t (
    id varchar2,
    description varchar2,
    last_action varchar2,
    available_actions dbms_cloud_oci_database_varchar2_tbl,
    update_type varchar2,
    lifecycle_details varchar2,
    lifecycle_state varchar2,
    time_released timestamp with time zone,
    version varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the maintenance update.

description

(required) Details of the maintenance update package.

last_action

(optional) The previous update action performed.

Allowed values are: 'ROLLING_APPLY', 'NON_ROLLING_APPLY', 'PRECHECK', 'ROLLBACK'

available_actions

(optional) The possible actions performed by the update operation on the infrastructure components.

Allowed values are: 'ROLLING_APPLY', 'NON_ROLLING_APPLY', 'PRECHECK', 'ROLLBACK'

update_type

(required) The type of cloud VM cluster maintenance update.

Allowed values are: 'GI_UPGRADE', 'GI_PATCH', 'OS_UPDATE'

lifecycle_details

(optional) Descriptive text providing additional details about the lifecycle state.

lifecycle_state

(optional) The current state of the maintenance update. Dependent on value of `lastAction`.

Allowed values are: 'AVAILABLE', 'SUCCESS', 'IN_PROGRESS', 'FAILED'

time_released

(required) The date and time the maintenance update was released.

version

(required) The version of the maintenance update package.

DBMS_CLOUD_OCI_DATABASE_VM_CLUSTER_UPDATE_DETAILS_T Type

Details specifying which maintenance update to apply to the VM Cluster and which action is to be performed by the maintenance update. Applies to Exadata Cloud@Customer instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_vm_cluster_update_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  update_id varchar2(32767),
  update_action varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_vm_cluster_update_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_vm_cluster_update_details_t (
    update_id varchar2,
    update_action varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

update_id

(optional) The OCID of the maintenance update.

update_action

(optional) The update action to perform.

Allowed values are: 'ROLLING_APPLY', 'PRECHECK', 'ROLLBACK'

DBMS_CLOUD_OCI_DATABASE_UPDATE_VM_CLUSTER_DETAILS_T Type

Details for updating the VM cluster. Applies to Exadata Cloud@Customer instances only. For details on updating a cloud VM cluster in an Exadata Cloud Service instance, see UPDATE_CLOUD_VM_CLUSTER_DETAILS Function

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_vm_cluster_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  cpu_core_count number,
  ocpu_count number,
  memory_size_in_g_bs number,
  db_node_storage_size_in_g_bs number,
  data_storage_size_in_t_bs number,
  data_storage_size_in_g_bs number,
  license_model varchar2(32767),
  ssh_public_keys dbms_cloud_oci_database_varchar2_tbl,
  version dbms_cloud_oci_database_patch_details_t,
  update_details dbms_cloud_oci_database_vm_cluster_update_details_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  data_collection_options dbms_cloud_oci_database_data_collection_options_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_vm_cluster_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_vm_cluster_details_t (
    cpu_core_count number,
    ocpu_count number,
    memory_size_in_g_bs number,
    db_node_storage_size_in_g_bs number,
    data_storage_size_in_t_bs number,
    data_storage_size_in_g_bs number,
    license_model varchar2,
    ssh_public_keys dbms_cloud_oci_database_varchar2_tbl,
    version dbms_cloud_oci_database_patch_details_t,
    update_details dbms_cloud_oci_database_vm_cluster_update_details_t,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    data_collection_options dbms_cloud_oci_database_data_collection_options_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

cpu_core_count

(optional) The number of CPU cores to enable for the VM cluster.

ocpu_count

(optional) The number of OCPU cores to enable for the VM cluster. Only 1 decimal place is allowed for the fractional part.

memory_size_in_g_bs

(optional) The memory to be allocated in GBs.

db_node_storage_size_in_g_bs

(optional) The local node storage to be allocated in GBs.

data_storage_size_in_t_bs

(optional) The data disk group size to be allocated in TBs.

data_storage_size_in_g_bs

(optional) The data disk group size to be allocated in GBs.

license_model

(optional) The Oracle license model that applies to the VM cluster. The default is BRING_YOUR_OWN_LICENSE.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

ssh_public_keys

(optional) The public key portion of one or more key pairs used for SSH access to the VM cluster.

version

(optional)

update_details

(optional)

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

data_collection_options

(optional)

DBMS_CLOUD_OCI_DATABASE_SCAN_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_database_scan_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_scan_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_scan_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_DR_SCAN_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_database_dr_scan_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_dr_scan_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_database_dr_scan_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_DATABASE_UPDATE_VM_CLUSTER_NETWORK_DETAILS_T Type

Details for an Exadata VM cluster network. Applies to Exadata Cloud@Customer instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_update_vm_cluster_network_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  scans dbms_cloud_oci_database_scan_details_tbl,
  dns dbms_cloud_oci_database_varchar2_tbl,
  ntp dbms_cloud_oci_database_varchar2_tbl,
  vm_networks dbms_cloud_oci_database_vm_network_details_tbl,
  dr_scans dbms_cloud_oci_database_dr_scan_details_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_vm_cluster_network_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_update_vm_cluster_network_details_t (
    scans dbms_cloud_oci_database_scan_details_tbl,
    dns dbms_cloud_oci_database_varchar2_tbl,
    ntp dbms_cloud_oci_database_varchar2_tbl,
    vm_networks dbms_cloud_oci_database_vm_network_details_tbl,
    dr_scans dbms_cloud_oci_database_dr_scan_details_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

scans

(optional) The SCAN details.

dns

(optional) The list of DNS server IP addresses. Maximum of 3 allowed.

ntp

(optional) The list of NTP server IP addresses. Maximum of 3 allowed.

vm_networks

(optional) Details of the client and backup networks.

dr_scans

(optional) The SCAN details for DR network

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_UPGRADE_DATABASE_DETAILS_T Type

Details for upgrading a database to a specific Oracle Database version.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_upgrade_database_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  action varchar2(32767),
  database_upgrade_source_details dbms_cloud_oci_database_database_upgrade_source_base_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_upgrade_database_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_upgrade_database_details_t (
    action varchar2,
    database_upgrade_source_details dbms_cloud_oci_database_database_upgrade_source_base_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

action

(required) The database upgrade action.

Allowed values are: 'PRECHECK', 'UPGRADE', 'ROLLBACK'

database_upgrade_source_details

(optional)

DBMS_CLOUD_OCI_DATABASE_UPGRADE_DB_SYSTEM_DETAILS_T Type

Details for upgrading the operating system and Oracle Grid Infrastructure (GI) of a DB system.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_upgrade_db_system_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  action varchar2(32767),
  snapshot_retention_period_in_days number,
  new_gi_version varchar2(32767),
  new_os_version varchar2(32767),
  is_snapshot_retention_days_force_updated number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_upgrade_db_system_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_upgrade_db_system_details_t (
    action varchar2,
    snapshot_retention_period_in_days number,
    new_gi_version varchar2,
    new_os_version varchar2,
    is_snapshot_retention_days_force_updated number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

action

(required) The operating system upgrade action.

Allowed values are: 'PRECHECK', 'ROLLBACK', 'UPDATE_SNAPSHOT_RETENTION_DAYS', 'UPGRADE'

snapshot_retention_period_in_days

(optional) The retention period, in days, for the snapshot that allows you to perform a rollback of the upgrade operation. After this number of days passes, you cannot roll back the upgrade.

new_gi_version

(optional) A valid Oracle Grid Infrastructure (GI) software version.

new_os_version

(optional) A valid Oracle Software (OS) version eg. Oracle Linux Server release 8

is_snapshot_retention_days_force_updated

(optional) If true, rollback time is updated even if operating system upgrade history contains errors.

DBMS_CLOUD_OCI_DATABASE_VM_CLUSTER_T Type

Details of the VM cluster resource. Applies to Exadata Cloud@Customer instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_vm_cluster_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  last_patch_history_entry_id varchar2(32767),
  lifecycle_state varchar2(32767),
  display_name varchar2(32767),
  time_created timestamp with time zone,
  lifecycle_details varchar2(32767),
  time_zone varchar2(32767),
  is_local_backup_enabled number,
  exadata_infrastructure_id varchar2(32767),
  is_sparse_diskgroup_enabled number,
  vm_cluster_network_id varchar2(32767),
  cpus_enabled number,
  ocpus_enabled number,
  memory_size_in_g_bs number,
  db_node_storage_size_in_g_bs number,
  data_storage_size_in_t_bs number,
  data_storage_size_in_g_bs number,
  shape varchar2(32767),
  gi_version varchar2(32767),
  system_version varchar2(32767),
  ssh_public_keys dbms_cloud_oci_database_varchar2_tbl,
  license_model varchar2(32767),
  db_servers dbms_cloud_oci_database_varchar2_tbl,
  availability_domain varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  data_collection_options dbms_cloud_oci_database_data_collection_options_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_vm_cluster_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_vm_cluster_t (
    id varchar2,
    compartment_id varchar2,
    last_patch_history_entry_id varchar2,
    lifecycle_state varchar2,
    display_name varchar2,
    time_created timestamp with time zone,
    lifecycle_details varchar2,
    time_zone varchar2,
    is_local_backup_enabled number,
    exadata_infrastructure_id varchar2,
    is_sparse_diskgroup_enabled number,
    vm_cluster_network_id varchar2,
    cpus_enabled number,
    ocpus_enabled number,
    memory_size_in_g_bs number,
    db_node_storage_size_in_g_bs number,
    data_storage_size_in_t_bs number,
    data_storage_size_in_g_bs number,
    shape varchar2,
    gi_version varchar2,
    system_version varchar2,
    ssh_public_keys dbms_cloud_oci_database_varchar2_tbl,
    license_model varchar2,
    db_servers dbms_cloud_oci_database_varchar2_tbl,
    availability_domain varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    data_collection_options dbms_cloud_oci_database_data_collection_options_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) The OCID of the VM cluster.

compartment_id

(optional) The OCID of the compartment.

last_patch_history_entry_id

(optional) The OCID of the last patch history. This value is updated as soon as a patch operation starts.

lifecycle_state

(optional) The current state of the VM cluster.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED', 'MAINTENANCE_IN_PROGRESS'

display_name

(optional) The user-friendly name for the Exadata Cloud@Customer VM cluster. The name does not need to be unique.

time_created

(optional) The date and time that the VM cluster was created.

lifecycle_details

(optional) Additional information about the current lifecycle state.

time_zone

(optional) The time zone of the Exadata infrastructure. For details, see Exadata Infrastructure Time Zones.

is_local_backup_enabled

(optional) If true, database backup on local Exadata storage is configured for the VM cluster. If false, database backup on local Exadata storage is not available in the VM cluster.

exadata_infrastructure_id

(optional) The OCID of the Exadata infrastructure.

is_sparse_diskgroup_enabled

(optional) If true, sparse disk group is configured for the VM cluster. If false, sparse disk group is not created.

vm_cluster_network_id

(optional) The OCID of the VM cluster network.

cpus_enabled

(optional) The number of enabled CPU cores.

ocpus_enabled

(optional) The number of enabled OCPU cores.

memory_size_in_g_bs

(optional) The memory allocated in GBs.

db_node_storage_size_in_g_bs

(optional) The local node storage allocated in GBs.

data_storage_size_in_t_bs

(optional) Size, in terabytes, of the DATA disk group.

data_storage_size_in_g_bs

(optional) Size of the DATA disk group in GBs.

shape

(optional) The shape of the Exadata infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance.

gi_version

(optional) The Oracle Grid Infrastructure software version for the VM cluster.

system_version

(optional) Operating system version of the image.

ssh_public_keys

(optional) The public key portion of one or more key pairs used for SSH access to the VM cluster.

license_model

(optional) The Oracle license model that applies to the VM cluster. The default is LICENSE_INCLUDED.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

db_servers

(optional) The list of Db server.

availability_domain

(optional) The name of the availability domain that the VM cluster is located in.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

data_collection_options

(optional)

DBMS_CLOUD_OCI_DATABASE_VM_CLUSTER_NETWORK_T Type

The VM cluster network.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_vm_cluster_network_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  exadata_infrastructure_id varchar2(32767),
  compartment_id varchar2(32767),
  vm_cluster_id varchar2(32767),
  display_name varchar2(32767),
  scans dbms_cloud_oci_database_scan_details_tbl,
  dns dbms_cloud_oci_database_varchar2_tbl,
  ntp dbms_cloud_oci_database_varchar2_tbl,
  vm_networks dbms_cloud_oci_database_vm_network_details_tbl,
  dr_scans dbms_cloud_oci_database_dr_scan_details_tbl,
  lifecycle_state varchar2(32767),
  time_created timestamp with time zone,
  lifecycle_details varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_vm_cluster_network_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_vm_cluster_network_t (
    id varchar2,
    exadata_infrastructure_id varchar2,
    compartment_id varchar2,
    vm_cluster_id varchar2,
    display_name varchar2,
    scans dbms_cloud_oci_database_scan_details_tbl,
    dns dbms_cloud_oci_database_varchar2_tbl,
    ntp dbms_cloud_oci_database_varchar2_tbl,
    vm_networks dbms_cloud_oci_database_vm_network_details_tbl,
    dr_scans dbms_cloud_oci_database_dr_scan_details_tbl,
    lifecycle_state varchar2,
    time_created timestamp with time zone,
    lifecycle_details varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) The OCID of the VM cluster network.

exadata_infrastructure_id

(optional) The OCID of the Exadata infrastructure.

compartment_id

(optional) The OCID of the compartment.

vm_cluster_id

(optional) The OCID of the associated VM Cluster.

display_name

(optional) The user-friendly name for the VM cluster network. The name does not need to be unique.

scans

(optional) The SCAN details.

dns

(optional) The list of DNS server IP addresses. Maximum of 3 allowed.

ntp

(optional) The list of NTP server IP addresses. Maximum of 3 allowed.

vm_networks

(optional) Details of the client and backup networks.

dr_scans

(optional) The SCAN details for DR network

lifecycle_state

(optional) The current state of the VM cluster network. CREATING - The resource is being created REQUIRES_VALIDATION - The resource is created and may not be usable until it is validated. VALIDATING - The resource is being validated and not available to use. VALIDATED - The resource is validated and is available for consumption by VM cluster. VALIDATION_FAILED - The resource validation has failed and might require user input to be corrected. UPDATING - The resource is being updated and not available to use. ALLOCATED - The resource is is currently being used by VM cluster. TERMINATING - The resource is being deleted and not available to use. TERMINATED - The resource is deleted and unavailable. FAILED - The resource is in a failed state due to validation or other errors. NEEDS_ATTENTION - The resource is in needs attention state as some of it's child nodes are not validated and unusable by VM cluster.

Allowed values are: 'CREATING', 'REQUIRES_VALIDATION', 'VALIDATING', 'VALIDATED', 'VALIDATION_FAILED', 'UPDATING', 'ALLOCATED', 'TERMINATING', 'TERMINATED', 'FAILED', 'NEEDS_ATTENTION'

time_created

(optional) The date and time when the VM cluster network was created.

lifecycle_details

(optional) Additional information about the current lifecycle state.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_VM_CLUSTER_NETWORK_DETAILS_T Type

Details for an Exadata VM cluster network. Applies to Exadata Cloud@Customer instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_vm_cluster_network_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  scans dbms_cloud_oci_database_scan_details_tbl,
  dns dbms_cloud_oci_database_varchar2_tbl,
  ntp dbms_cloud_oci_database_varchar2_tbl,
  vm_networks dbms_cloud_oci_database_vm_network_details_tbl,
  dr_scans dbms_cloud_oci_database_dr_scan_details_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_vm_cluster_network_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_vm_cluster_network_details_t (
    compartment_id varchar2,
    display_name varchar2,
    scans dbms_cloud_oci_database_scan_details_tbl,
    dns dbms_cloud_oci_database_varchar2_tbl,
    ntp dbms_cloud_oci_database_varchar2_tbl,
    vm_networks dbms_cloud_oci_database_vm_network_details_tbl,
    dr_scans dbms_cloud_oci_database_dr_scan_details_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment.

display_name

(required) The user-friendly name for the Exadata Cloud@Customer VM cluster network. The name does not need to be unique.

scans

(required) The SCAN details.

dns

(optional) The list of DNS server IP addresses. Maximum of 3 allowed.

ntp

(optional) The list of NTP server IP addresses. Maximum of 3 allowed.

vm_networks

(required) Details of the client and backup networks.

dr_scans

(optional) The SCAN details for DR network

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_VM_CLUSTER_NETWORK_SUMMARY_T Type

Details of the VM cluster network. Applies to Exadata Cloud@Customer instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_vm_cluster_network_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  exadata_infrastructure_id varchar2(32767),
  compartment_id varchar2(32767),
  vm_cluster_id varchar2(32767),
  display_name varchar2(32767),
  scans dbms_cloud_oci_database_scan_details_tbl,
  dns dbms_cloud_oci_database_varchar2_tbl,
  ntp dbms_cloud_oci_database_varchar2_tbl,
  vm_networks dbms_cloud_oci_database_vm_network_details_tbl,
  dr_scans dbms_cloud_oci_database_dr_scan_details_tbl,
  lifecycle_state varchar2(32767),
  time_created timestamp with time zone,
  lifecycle_details varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_vm_cluster_network_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_vm_cluster_network_summary_t (
    id varchar2,
    exadata_infrastructure_id varchar2,
    compartment_id varchar2,
    vm_cluster_id varchar2,
    display_name varchar2,
    scans dbms_cloud_oci_database_scan_details_tbl,
    dns dbms_cloud_oci_database_varchar2_tbl,
    ntp dbms_cloud_oci_database_varchar2_tbl,
    vm_networks dbms_cloud_oci_database_vm_network_details_tbl,
    dr_scans dbms_cloud_oci_database_dr_scan_details_tbl,
    lifecycle_state varchar2,
    time_created timestamp with time zone,
    lifecycle_details varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) The OCID of the VM cluster network.

exadata_infrastructure_id

(optional) The OCID of the Exadata infrastructure.

compartment_id

(optional) The OCID of the compartment.

vm_cluster_id

(optional) The OCID of the associated VM Cluster.

display_name

(optional) The user-friendly name for the VM cluster network. The name does not need to be unique.

scans

(optional) The SCAN details.

dns

(optional) The list of DNS server IP addresses. Maximum of 3 allowed.

ntp

(optional) The list of NTP server IP addresses. Maximum of 3 allowed.

vm_networks

(optional) Details of the client and backup networks.

dr_scans

(optional) The SCAN details for DR network

lifecycle_state

(optional) The current state of the VM cluster network. CREATING - The resource is being created REQUIRES_VALIDATION - The resource is created and may not be usable until it is validated. VALIDATING - The resource is being validated and not available to use. VALIDATED - The resource is validated and is available for consumption by VM cluster. VALIDATION_FAILED - The resource validation has failed and might require user input to be corrected. UPDATING - The resource is being updated and not available to use. ALLOCATED - The resource is is currently being used by VM cluster. TERMINATING - The resource is being deleted and not available to use. TERMINATED - The resource is deleted and unavailable. FAILED - The resource is in a failed state due to validation or other errors. NEEDS_ATTENTION - The resource is in needs attention state as some of it's child nodes are not validated and unusable by VM cluster.

Allowed values are: 'CREATING', 'REQUIRES_VALIDATION', 'VALIDATING', 'VALIDATED', 'VALIDATION_FAILED', 'UPDATING', 'ALLOCATED', 'TERMINATING', 'TERMINATED', 'FAILED', 'NEEDS_ATTENTION'

time_created

(optional) The date and time when the VM cluster network was created.

lifecycle_details

(optional) Additional information about the current lifecycle state.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DBMS_CLOUD_OCI_DATABASE_VM_CLUSTER_SUMMARY_T Type

Details of the Exadata Cloud@Customer VM cluster.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_vm_cluster_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  last_patch_history_entry_id varchar2(32767),
  lifecycle_state varchar2(32767),
  display_name varchar2(32767),
  time_created timestamp with time zone,
  lifecycle_details varchar2(32767),
  time_zone varchar2(32767),
  is_local_backup_enabled number,
  exadata_infrastructure_id varchar2(32767),
  is_sparse_diskgroup_enabled number,
  vm_cluster_network_id varchar2(32767),
  cpus_enabled number,
  ocpus_enabled number,
  memory_size_in_g_bs number,
  db_node_storage_size_in_g_bs number,
  data_storage_size_in_t_bs number,
  data_storage_size_in_g_bs number,
  shape varchar2(32767),
  gi_version varchar2(32767),
  system_version varchar2(32767),
  ssh_public_keys dbms_cloud_oci_database_varchar2_tbl,
  license_model varchar2(32767),
  db_servers dbms_cloud_oci_database_varchar2_tbl,
  availability_domain varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  data_collection_options dbms_cloud_oci_database_data_collection_options_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_vm_cluster_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_vm_cluster_summary_t (
    id varchar2,
    compartment_id varchar2,
    last_patch_history_entry_id varchar2,
    lifecycle_state varchar2,
    display_name varchar2,
    time_created timestamp with time zone,
    lifecycle_details varchar2,
    time_zone varchar2,
    is_local_backup_enabled number,
    exadata_infrastructure_id varchar2,
    is_sparse_diskgroup_enabled number,
    vm_cluster_network_id varchar2,
    cpus_enabled number,
    ocpus_enabled number,
    memory_size_in_g_bs number,
    db_node_storage_size_in_g_bs number,
    data_storage_size_in_t_bs number,
    data_storage_size_in_g_bs number,
    shape varchar2,
    gi_version varchar2,
    system_version varchar2,
    ssh_public_keys dbms_cloud_oci_database_varchar2_tbl,
    license_model varchar2,
    db_servers dbms_cloud_oci_database_varchar2_tbl,
    availability_domain varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    data_collection_options dbms_cloud_oci_database_data_collection_options_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) The OCID of the VM cluster.

compartment_id

(optional) The OCID of the compartment.

last_patch_history_entry_id

(optional) The OCID of the last patch history. This value is updated as soon as a patch operation starts.

lifecycle_state

(optional) The current state of the VM cluster.

Allowed values are: 'PROVISIONING', 'AVAILABLE', 'UPDATING', 'TERMINATING', 'TERMINATED', 'FAILED', 'MAINTENANCE_IN_PROGRESS'

display_name

(optional) The user-friendly name for the Exadata Cloud@Customer VM cluster. The name does not need to be unique.

time_created

(optional) The date and time that the VM cluster was created.

lifecycle_details

(optional) Additional information about the current lifecycle state.

time_zone

(optional) The time zone of the Exadata infrastructure. For details, see Exadata Infrastructure Time Zones.

is_local_backup_enabled

(optional) If true, database backup on local Exadata storage is configured for the VM cluster. If false, database backup on local Exadata storage is not available in the VM cluster.

exadata_infrastructure_id

(optional) The OCID of the Exadata infrastructure.

is_sparse_diskgroup_enabled

(optional) If true, sparse disk group is configured for the VM cluster. If false, sparse disk group is not created.

vm_cluster_network_id

(optional) The OCID of the VM cluster network.

cpus_enabled

(optional) The number of enabled CPU cores.

ocpus_enabled

(optional) The number of enabled OCPU cores.

memory_size_in_g_bs

(optional) The memory allocated in GBs.

db_node_storage_size_in_g_bs

(optional) The local node storage allocated in GBs.

data_storage_size_in_t_bs

(optional) Size, in terabytes, of the DATA disk group.

data_storage_size_in_g_bs

(optional) Size of the DATA disk group in GBs.

shape

(optional) The shape of the Exadata infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance.

gi_version

(optional) The Oracle Grid Infrastructure software version for the VM cluster.

system_version

(optional) Operating system version of the image.

ssh_public_keys

(optional) The public key portion of one or more key pairs used for SSH access to the VM cluster.

license_model

(optional) The Oracle license model that applies to the VM cluster. The default is LICENSE_INCLUDED.

Allowed values are: 'LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE'

db_servers

(optional) The list of Db server.

availability_domain

(optional) The name of the availability domain that the VM cluster is located in.

freeform_tags

(optional) 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\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

data_collection_options

(optional)

DBMS_CLOUD_OCI_DATABASE_VM_CLUSTER_UPDATE_T Type

A maintenance update for a VM cluster. Applies to Exadata Cloud@Customer instances only. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_vm_cluster_update_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  description varchar2(32767),
  last_action varchar2(32767),
  available_actions dbms_cloud_oci_database_varchar2_tbl,
  update_type varchar2(32767),
  lifecycle_details varchar2(32767),
  lifecycle_state varchar2(32767),
  time_released timestamp with time zone,
  version varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_vm_cluster_update_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_vm_cluster_update_t (
    id varchar2,
    description varchar2,
    last_action varchar2,
    available_actions dbms_cloud_oci_database_varchar2_tbl,
    update_type varchar2,
    lifecycle_details varchar2,
    lifecycle_state varchar2,
    time_released timestamp with time zone,
    version varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the maintenance update.

description

(required) Details of the maintenance update package.

last_action

(optional) The update action performed most recently using this maintenance update.

Allowed values are: 'ROLLING_APPLY', 'PRECHECK', 'ROLLBACK'

available_actions

(optional) The possible actions that can be performed using this maintenance update.

Allowed values are: 'ROLLING_APPLY', 'PRECHECK', 'ROLLBACK'

update_type

(required) The type of VM cluster maintenance update.

Allowed values are: 'GI_UPGRADE', 'GI_PATCH', 'OS_UPDATE'

lifecycle_details

(optional) Descriptive text providing additional details about the lifecycle state.

lifecycle_state

(optional) The current state of the maintenance update. Dependent on value of `lastAction`.

Allowed values are: 'AVAILABLE', 'SUCCESS', 'IN_PROGRESS', 'FAILED'

time_released

(required) The date and time the maintenance update was released.

version

(required) The version of the maintenance update package.

DBMS_CLOUD_OCI_DATABASE_VM_CLUSTER_UPDATE_HISTORY_ENTRY_T Type

The record of a maintenance update action performed on a specified VM cluster. Applies to Exadata Cloud@Customer instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_vm_cluster_update_history_entry_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  update_id varchar2(32767),
  update_action varchar2(32767),
  update_type varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_started timestamp with time zone,
  time_completed timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_vm_cluster_update_history_entry_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_vm_cluster_update_history_entry_t (
    id varchar2,
    update_id varchar2,
    update_action varchar2,
    update_type varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_started timestamp with time zone,
    time_completed timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the maintenance update history entry.

update_id

(required) The OCID of the maintenance update.

update_action

(optional) The update action performed using this maintenance update.

Allowed values are: 'ROLLING_APPLY', 'PRECHECK', 'ROLLBACK'

update_type

(required) The type of VM cluster maintenance update.

Allowed values are: 'GI_UPGRADE', 'GI_PATCH', 'OS_UPDATE'

lifecycle_state

(required) The current lifecycle state of the maintenance update operation.

Allowed values are: 'IN_PROGRESS', 'SUCCEEDED', 'FAILED'

lifecycle_details

(optional) Descriptive text providing additional details about the lifecycle state.

time_started

(required) The date and time when the maintenance update action started.

time_completed

(optional) The date and time when the maintenance update action completed.

DBMS_CLOUD_OCI_DATABASE_VM_CLUSTER_UPDATE_HISTORY_ENTRY_SUMMARY_T Type

The record of a maintenance update action performed on a specified VM cluster. Applies to Exadata Cloud@Customer instances only.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_vm_cluster_update_history_entry_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  update_id varchar2(32767),
  update_action varchar2(32767),
  update_type varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_started timestamp with time zone,
  time_completed timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_vm_cluster_update_history_entry_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_vm_cluster_update_history_entry_summary_t (
    id varchar2,
    update_id varchar2,
    update_action varchar2,
    update_type varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_started timestamp with time zone,
    time_completed timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the maintenance update history entry.

update_id

(required) The OCID of the maintenance update.

update_action

(optional) The update action performed using this maintenance update.

Allowed values are: 'ROLLING_APPLY', 'PRECHECK', 'ROLLBACK'

update_type

(required) The type of VM cluster maintenance update.

Allowed values are: 'GI_UPGRADE', 'GI_PATCH', 'OS_UPDATE'

lifecycle_state

(required) The current lifecycle state of the maintenance update operation.

Allowed values are: 'IN_PROGRESS', 'SUCCEEDED', 'FAILED'

lifecycle_details

(optional) Descriptive text providing additional details about the lifecycle state.

time_started

(required) The date and time when the maintenance update action started.

time_completed

(optional) The date and time when the maintenance update action completed.

DBMS_CLOUD_OCI_DATABASE_VM_CLUSTER_UPDATE_SUMMARY_T Type

A maintenance update for a VM cluster. Applies to Exadata Cloud@Customer instances only. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_database_vm_cluster_update_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  description varchar2(32767),
  last_action varchar2(32767),
  available_actions dbms_cloud_oci_database_varchar2_tbl,
  update_type varchar2(32767),
  lifecycle_details varchar2(32767),
  lifecycle_state varchar2(32767),
  time_released timestamp with time zone,
  version varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_vm_cluster_update_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_database_vm_cluster_update_summary_t (
    id varchar2,
    description varchar2,
    last_action varchar2,
    available_actions dbms_cloud_oci_database_varchar2_tbl,
    update_type varchar2,
    lifecycle_details varchar2,
    lifecycle_state varchar2,
    time_released timestamp with time zone,
    version varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the maintenance update.

description

(required) Details of the maintenance update package.

last_action

(optional) The update action performed most recently using this maintenance update.

Allowed values are: 'ROLLING_APPLY', 'PRECHECK', 'ROLLBACK'

available_actions

(optional) The possible actions that can be performed using this maintenance update.

Allowed values are: 'ROLLING_APPLY', 'PRECHECK', 'ROLLBACK'

update_type

(required) The type of VM cluster maintenance update.

Allowed values are: 'GI_UPGRADE', 'GI_PATCH', 'OS_UPDATE'

lifecycle_details

(optional) Descriptive text providing additional details about the lifecycle state.

lifecycle_state

(optional) The current state of the maintenance update. Dependent on value of `lastAction`.

Allowed values are: 'AVAILABLE', 'SUCCESS', 'IN_PROGRESS', 'FAILED'

time_released

(required) The date and time the maintenance update was released.

version

(required) The version of the maintenance update package.