shape_name

(required) The shape determines resources to allocate to the HeatWave nodes - CPU cores, memory.

cluster_size

(required) The number of analytics-processing nodes provisioned for the HeatWave cluster.

is_lakehouse_enabled

(optional) Enable/disable Lakehouse for the HeatWave cluster.

policy

(required) Specifies how the replication channel handles anonymous transactions.

Allowed values are: 'ERROR_ON_ANONYMOUS', 'ASSIGN_TARGET_UUID', 'ASSIGN_MANUAL_UUID'

last_configured_log_filename

(optional) Specifies one of the coordinates (file) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it.

last_configured_log_offset

(optional) Specifies one of the coordinates (offset) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it.

uuid

(optional) The UUID that is used as a prefix when generating transaction identifiers for anonymous transactions coming from the source. You can change the UUID later.

last_configured_log_filename

(optional) Specifies one of the coordinates (file) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it.

last_configured_log_offset

(optional) Specifies one of the coordinates (offset) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it.

is_enabled

(required) Specifies if PITR is enabled or disabled.

is_enabled

(required) If automated backups are enabled or disabled.

window_start_time

(required) The start of a 30-minute window of time in which daily, automated backups occur. This should be in the format of the \"Time\" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero. At some point in the window, the system may incur a brief service disruption as the backup is performed. If not defined, a window is selected from the following Region-based time-spans: - eu-frankfurt-1: 20:00 - 04:00 UTC - us-ashburn-1: 03:00 - 11:00 UTC - uk-london-1: 06:00 - 14:00 UTC - ap-tokyo-1: 13:00 - 21:00 - us-phoenix-1: 06:00 - 14:00

retention_in_days

(required) The number of days automated backups are retained.

freeform_tags

(optional) Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

pitr_policy

(optional)

hostname

(optional) The network address of the DB System.

ip_address

(required) The IP address the DB System is configured to listen on.

port

(required) The port the MySQL instance listens on.

port_x

(required) The network port where to connect to use this endpoint using the X protocol.

modes

(optional) The access modes from the client that this endpoint supports.

Allowed values are: 'READ', 'WRITE'

status

(optional) The state of the endpoints, as far as it can seen from the DB System. There may be some inconsistency with the actual state of the MySQL service.

Allowed values are: 'ACTIVE', 'INACTIVE', 'UPDATING'

status_details

(optional) Additional information about the current endpoint status.

resource_type

(optional) The type of endpoint that clients and connectors can connect to.

Allowed values are: 'DBSYSTEM', 'READ_REPLICA', 'LOAD_BALANCER'

resource_id

(optional) The OCID of the resource that this endpoint is attached to.

window_start_time

(optional) The start time of the maintenance window. This string is of the format: \"{day-of-week} {time-of-day}\". \"{day-of-week}\" is a case-insensitive string like \"mon\", \"tue\", &c. \"{time-of-day}\" is the \"Time\" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero. If you set the read replica maintenance window to \"\" or if not specified, the read replica is set same as the DB system maintenance window.

automatic_backup_retention

(required) Specifies if any automatic backups created for a DB System should be retained or deleted when the DB System is deleted.

Allowed values are: 'DELETE', 'RETAIN'

final_backup

(required) Specifies whether or not a backup is taken when the DB System is deleted. REQUIRE_FINAL_BACKUP: a backup is taken if the DB System is deleted. SKIP_FINAL_BACKUP: a backup is not taken if the DB System is deleted.

Allowed values are: 'SKIP_FINAL_BACKUP', 'REQUIRE_FINAL_BACKUP'

is_delete_protected

(required) Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow.

id

(required) The OCID of the DB System.

display_name

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

description

(optional) User-provided data about the DB System.

compartment_id

(required) The OCID of the compartment the DB System belongs in.

subnet_id

(required) The OCID of the subnet the DB System is associated with.

availability_domain

(optional) The Availability Domain where the primary DB System should be located.

fault_domain

(optional) The name of the Fault Domain the DB System is located in.

shape_name

(optional) The shape of the primary instances of the DB System. The shape determines resources allocated to a DB System - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. To get a list of shapes, use (the LIST_SHAPES Function operation.

mysql_version

(required) Name of the MySQL Version in use for the DB System.

admin_username

(optional) The username for the administrative user.

backup_policy

(optional)

configuration_id

(optional) The OCID of the Configuration to be used for Instances in this DB System.

data_storage_size_in_g_bs

(required) Initial size of the data volume in GiBs that will be created and attached.

hostname_label

(optional) The hostname for the primary endpoint of the DB System. Used for DNS. The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) (for example, \"dbsystem-1\" in FQDN \"dbsystem-1.subnet123.vcn1.oraclevcn.com\"). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.

ip_address

(optional) The IP address the DB System is configured to listen on. A private IP address of the primary endpoint of the DB System. Must be an available IP address within the subnet's CIDR. This will be a \"dotted-quad\" style IPv4 address.

port

(optional) The port for primary endpoint of the DB System to listen on.

port_x

(optional) The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port.

is_highly_available

(optional) Specifies if the DB System is highly available.

endpoints

(optional) The network endpoints available for this DB System.

maintenance

(required)

deletion_policy

(required)

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

crash_recovery

(optional) Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, and whether to enable or disable syncing of the Binary Logs.

Allowed values are: 'ENABLED', 'DISABLED'

database_management

(optional) Whether to enable monitoring via the Database Management service.

Allowed values are: 'ENABLED', 'DISABLED'

id

(required) OCID of the backup itself

display_name

(optional) A user-supplied display name for the backup.

description

(optional) A user-supplied description for the backup.

compartment_id

(required) The OCID of the compartment.

time_created

(required) The time the backup record was created.

time_updated

(required) The time at which the backup was updated.

lifecycle_state

(required) The state of the backup.

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

lifecycle_details

(required) Additional information about the current lifecycleState.

backup_type

(required) The type of backup.

Allowed values are: 'FULL', 'INCREMENTAL'

creation_type

(required) Indicates how the backup was created: manually, automatic, or by an Operator.

Allowed values are: 'MANUAL', 'AUTOMATIC', 'OPERATOR'

db_system_id

(required) The OCID of the DB System the backup is associated with.

db_system_snapshot

(optional)

backup_size_in_g_bs

(optional) The size of the backup in base-2 (IEC) gibibytes. (GiB).

retention_in_days

(optional) Number of days to retain this backup.

data_storage_size_in_g_bs

(optional) Initial size of the data volume in GiBs.

mysql_version

(optional) The MySQL server version of the DB System used for backup.

shape_name

(optional) The shape of the DB System used for backup.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

id

(required) OCID of the backup.

display_name

(optional) A user-supplied display name for the backup.

description

(optional) A user-supplied description of the backup.

time_created

(required) The time the backup was created.

lifecycle_state

(required) The state of the backup.

backup_type

(required) The type of backup.

creation_type

(required) If the backup was created automatically, or by a manual request.

db_system_id

(required) The OCID of the DB System the Backup is associated with.

compartment_id

(required) The OCID of the compartment the backup exists in.

data_storage_size_in_g_bs

(optional) Size of the data volume in GiBs.

backup_size_in_g_bs

(optional) The size of the backup in GiBs.

retention_in_days

(optional) Number of days to retain this backup.

mysql_version

(optional) The version of the DB System used for backup.

shape_name

(optional) The shape of the DB System instance used for backup.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

certificate_type

(required) The type of CA certificate.

Allowed values are: 'PEM'

compartment_id

(required) OCID of the target compartment.

source_type

(required) The specific source identifier.

Allowed values are: 'MYSQL'

target_type

(required) The specific target identifier.

Allowed values are: 'DBSYSTEM'

id

(required) The OCID of the Channel.

compartment_id

(required) The OCID of the compartment.

display_name

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

is_enabled

(required) Whether the Channel has been enabled by the user.

source

(required)

target

(required)

description

(optional) User provided description of the Channel.

lifecycle_state

(required) The state of the Channel.

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

lifecycle_details

(optional) A message describing the state of the Channel.

time_created

(required) The date and time the Channel was created, as described by RFC 3339.

time_updated

(required) The time the Channel was last updated, as described by RFC 3339.

freeform_tags

(optional) Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

l_type

(required) The type of the filter rule. For details on each type, see Replication Filtering Rules

Allowed values are: 'REPLICATE_DO_DB', 'REPLICATE_IGNORE_DB', 'REPLICATE_DO_TABLE', 'REPLICATE_IGNORE_TABLE', 'REPLICATE_WILD_DO_TABLE', 'REPLICATE_WILD_IGNORE_TABLE', 'REPLICATE_REWRITE_DB'

value

(required) The body of the filter rule. This can represent a database, a table, or a database pair (represented as \"db1->db2\"). For more information, see Replication Filtering Rules.

hostname

(required) The network address of the MySQL instance.

port

(required) The port the source MySQL instance listens on.

username

(required) The name of the replication user on the source MySQL instance. The username has a maximum length of 96 characters. For more information, please see the MySQL documentation

ssl_mode

(required) The SSL mode of the Channel.

Allowed values are: 'VERIFY_IDENTITY', 'VERIFY_CA', 'REQUIRED', 'DISABLED'

ssl_ca_certificate

(optional)

anonymous_transactions_handling

(optional)

id

(required) The OCID of the Channel.

compartment_id

(required) The OCID of the compartment.

is_enabled

(required) Whether the Channel has been enabled by the user.

source

(required)

target

(required)

lifecycle_state

(required) The state of the Channel.

lifecycle_details

(optional) A message describing the state of the Channel.

display_name

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

time_created

(required) The date and time the Channel was created, as described by RFC 3339.

time_updated

(required) The time the Channel was last updated, as described by RFC 3339.

freeform_tags

(optional) Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

db_system_id

(required) The OCID of the source DB System.

channel_name

(required) The case-insensitive name that identifies the replication channel. Channel names must follow the rules defined for MySQL identifiers. The names of non-Deleted Channels must be unique for each DB System.

applier_username

(required) The username for the replication applier of the target MySQL DB System.

filters

(optional) Replication filter rules to be applied at the DB System Channel target.

tables_without_primary_key_handling

(required) Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key.

Allowed values are: 'RAISE_ERROR', 'ALLOW', 'GENERATE_IMPLICIT_PRIMARY_KEY'

delay_in_seconds

(required) Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source.

lower_case_table_names

(optional) Represents the MySQL server system variable lower_case_table_names (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_lower_case_table_names). lowerCaseTableNames controls case-sensitivity of tables and schema names and how they are stored in the DB System. Valid values are: - CASE_SENSITIVE - (default) Table and schema name comparisons are case-sensitive and stored as specified. (lower_case_table_names=0) - CASE_INSENSITIVE_LOWERCASE - Table and schema name comparisons are not case-sensitive and stored in lowercase. (lower_case_table_names=1)

Allowed values are: 'CASE_SENSITIVE', 'CASE_INSENSITIVE_LOWERCASE'

completion_type

(optional) (\"completion_type\")

Allowed values are: 'NO_CHAIN', 'CHAIN', 'RELEASE'

big_tables

(optional) If enabled, the server stores all temporary tables on disk rather than in memory. bigTables corresponds to the MySQL server variable big_tables.

connection_memory_chunk_size

(optional) Set the chunking size for updates to the global memory usage counter Global_connection_memory. connectionMemoryChunkSize corresponds to the MySQL system variable connection_memory_chunk_size.

connection_memory_limit

(optional) Set the maximum amount of memory that can be used by a single user connection. connectionMemoryLimit corresponds to the MySQL system variable connection_memory_limit.

default_authentication_plugin

(optional) (\"default_authentication_plugin\")

Allowed values are: 'mysql_native_password', 'sha256_password', 'caching_sha2_password'

global_connection_memory_limit

(optional) Set the total amount of memory that can be used by all user connections. globalConnectionMemoryLimit corresponds to the MySQL system variable global_connection_memory_limit.

global_connection_memory_tracking

(optional) Determines whether the MySQL server calculates Global_connection_memory. globalConnectionMemoryTracking corresponds to the MySQL system variable global_connection_memory_tracking.

transaction_isolation

(optional) (\"transaction_isolation\")

Allowed values are: 'READ-UNCOMMITTED', 'READ-COMMITED', 'READ-COMMITTED', 'REPEATABLE-READ', 'SERIALIZABLE'

innodb_ft_server_stopword_table

(optional) (\"innodb_ft_server_stopword_table\")

mandatory_roles

(optional) (\"mandatory_roles\")

autocommit

(optional) (\"autocommit\")

foreign_key_checks

(optional) (\"foreign_key_checks\")

group_replication_consistency

(optional) - EVENTUAL: Both RO and RW transactions do not wait for preceding transactions to be applied before executing. A RW transaction does not wait for other members to apply a transaction. This means that a transaction could be externalized on one member before the others. This also means that in the event of a primary failover, the new primary can accept new RO and RW transactions before the previous primary transactions are all applied. RO transactions could result in outdated values, RW transactions could result in a rollback due to conflicts. - BEFORE_ON_PRIMARY_FAILOVER: New RO or RW transactions with a newly elected primary that is applying backlog from the old primary are held (not applied) until any backlog has been applied. This ensures that when a primary failover happens, intentionally or not, clients always see the latest value on the primary. This guarantees consistency, but means that clients must be able to handle the delay in the event that a backlog is being applied. Usually this delay should be minimal, but does depend on the size of the backlog. - BEFORE: A RW transaction waits for all preceding transactions to complete before being applied. A RO transaction waits for all preceding transactions to complete before being executed. This ensures that this transaction reads the latest value by only affecting the latency of the transaction. This reduces the overhead of synchronization on every RW transaction, by ensuring synchronization is used only on RO transactions. This consistency level also includes the consistency guarantees provided by BEFORE_ON_PRIMARY_FAILOVER. - AFTER: A RW transaction waits until its changes have been applied to all of the other members. This value has no effect on RO transactions. This mode ensures that when a transaction is committed on the local member, any subsequent transaction reads the written value or a more recent value on any group member. Use this mode with a group that is used for predominantly RO operations to ensure that applied RW transactions are applied everywhere once they commit. This could be used by your application to ensure that subsequent reads fetch the latest data which includes the latest writes. This reduces the overhead of synchronization on every RO transaction, by ensuring synchronization is used only on RW transactions. This consistency level also includes the consistency guarantees provided by BEFORE_ON_PRIMARY_FAILOVER. - BEFORE_AND_AFTER: A RW transaction waits for 1) all preceding transactions to complete before being applied and 2) until its changes have been applied on other members. A RO transaction waits for all preceding transactions to complete before execution takes place. This consistency level also includes the consistency guarantees provided by BEFORE_ON_PRIMARY_FAILOVER.

Allowed values are: 'EVENTUAL', 'BEFORE_ON_PRIMARY_FAILOVER', 'BEFORE', 'AFTER', 'BEFORE_AND_AFTER'

innodb_ft_enable_stopword

(optional) (\"innodb_ft_enable_stopword\")

innodb_log_writer_threads

(optional) Enables dedicated log writer threads for writing redo log records from the log buffer to the system buffers and flushing the system buffers to the redo log files. This is the MySQL variable \"innodb_log_writer_threads\". For more information, please see the MySQL documentation

local_infile

(optional) (\"local_infile\")

mysql_firewall_mode

(optional) (\"mysql_firewall_mode\")

mysqlx_enable_hello_notice

(optional) (\"mysqlx_enable_hello_notice\") DEPRECATED -- variable should not be settable and will be ignored

sql_require_primary_key

(optional) (\"sql_require_primary_key\")

sql_warnings

(optional) (\"sql_warnings\")

binlog_expire_logs_seconds

(optional) Sets the binary log expiration period in seconds. binlogExpireLogsSeconds corresponds to the MySQL binary logging system variable binlog_expire_logs_seconds.

binlog_row_metadata

(optional) Configures the amount of table metadata added to the binary log when using row-based logging. binlogRowMetadata corresponds to the MySQL binary logging system variable binlog_row_metadata.

Allowed values are: 'FULL', 'MINIMAL'

binlog_row_value_options

(optional) When set to PARTIAL_JSON, this enables use of a space-efficient binary log format for updates that modify only a small portion of a JSON document. binlogRowValueOptions corresponds to the MySQL binary logging system variable binlog_row_value_options.

binlog_transaction_compression

(optional) Enables compression for transactions that are written to binary log files on this server. binlogTransactionCompression corresponds to the MySQL binary logging system variable binlog_transaction_compression.

innodb_buffer_pool_size

(optional) The size (in bytes) of the buffer pool, that is, the memory area where InnoDB caches table and index data. innodbBufferPoolSize corresponds to the MySQL server system variable innodb_buffer_pool_size. The default and maximum values depend on the amount of RAM provisioned by the shape.

innodb_ft_result_cache_limit

(optional) (\"innodb_ft_result_cache_limit\")

max_binlog_cache_size

(optional) Sets the size of the transaction cache. maxBinlogCacheSize corresponds to the MySQL server system variable max_binlog_cache_size.

max_connect_errors

(optional) (\"max_connect_errors\")

max_heap_table_size

(optional) This variable sets the maximum size to which user-created MEMORY tables are permitted to grow. maxHeapTableSize corresponds to the MySQL system variable max_heap_table_size

max_connections

(optional) (\"max_connections\")

max_prepared_stmt_count

(optional) (\"max_prepared_stmt_count\")

connect_timeout

(optional) The number of seconds that the mysqld server waits for a connect packet before responding with Bad handshake. connectTimeout corresponds to the MySQL system variable connect_timeout Increasing the connect_timeout value might help if clients frequently encounter errors of the form \"Lost connection to MySQL server at 'XXX', system error: errno\".

cte_max_recursion_depth

(optional) (\"cte_max_recursion_depth\")

generated_random_password_length

(optional) (\"generated_random_password_length\") DEPRECATED -- variable should not be settable and will be ignored

information_schema_stats_expiry

(optional) (\"information_schema_stats_expiry\")

innodb_buffer_pool_dump_pct

(optional) Specifies the percentage of the most recently used pages for each buffer pool to read out and dump. innodbBufferPoolDumpPct corresponds to the MySQL InnoDB system variable innodb_buffer_pool_dump_pct. The range is 1 to 100. The default value is 25. For example, if there are 4 buffer pools with 100 pages each, and innodb_buffer_pool_dump_pct is set to 25, the 25 most recently used pages from each buffer pool are dumped.

innodb_buffer_pool_instances

(optional) (\"innodb_buffer_pool_instances\")

innodb_ddl_buffer_size

(optional) innodbDdlBufferSize corresponds to the MySQL system variable innodb_ddl_buffer_size]

innodb_ddl_threads

(optional) innodbDdlThreads corresponds to the MySQL system variable innodb_ddl_threads]

innodb_ft_max_token_size

(optional) (\"innodb_ft_max_token_size\")

innodb_ft_min_token_size

(optional) (\"innodb_ft_min_token_size\")

innodb_ft_num_word_optimize

(optional) (\"innodb_ft_num_word_optimize\")

innodb_lock_wait_timeout

(optional) (\"innodb_lock_wait_timeout\")

innodb_max_purge_lag

(optional) The desired maximum purge lag in terms of transactions. InnoDB maintains a list of transactions that have index records delete-marked by UPDATE or DELETE operations. The length of the list is the purge lag. If this value is exceeded, a delay is imposed on INSERT, UPDATE, and DELETE operations to allow time for purge to catch up. The default value is 0, which means there is no maximum purge lag and no delay. innodbMaxPurgeLag corresponds to the MySQL server system variable innodb_max_purge_lag.

innodb_max_purge_lag_delay

(optional) The maximum delay in microseconds for the delay imposed when the innodb_max_purge_lag threshold is exceeded. The specified innodb_max_purge_lag_delay value is an upper limit on the delay period. innodbMaxPurgeLagDelay corresponds to the MySQL server system variable innodb_max_purge_lag_delay.

interactive_timeout

(optional) The number of seconds the server waits for activity on an interactive connection before closing it. interactiveTimeout corresponds to the MySQL system variable. interactive_timeout

innodb_stats_persistent_sample_pages

(optional) The number of index pages to sample when estimating cardinality and other statistics for an indexed column, such as those calculated by ANALYZE TABLE. innodbStatsPersistentSamplePages corresponds to the MySQL InnoDB system variable innodb_stats_persistent_sample_pages innodb_stats_persistent_sample_pages only applies when innodb_stats_persistent is enabled for a table; when innodb_stats_persistent is disabled, innodb_stats_transient_sample_pages applies instead.

innodb_stats_transient_sample_pages

(optional) The number of index pages to sample when estimating cardinality and other statistics for an indexed column, such as those calculated by ANALYZE TABLE. innodbStatsTransientSamplePages corresponds to the MySQL InnoDB system variable innodb_stats_transient_sample_pages innodb_stats_transient_sample_pages only applies when innodb_stats_persistent is disabled for a table; when innodb_stats_persistent is enabled, innodb_stats_persistent_sample_pages applies instead. innodb_stats_persistent is ON by default and cannot be changed. It is possible to override it using the STATS_PERSISTENT clause of the CREATE TABLE and ALTER TABLE statements.

max_allowed_packet

(optional) The maximum size of one packet or any generated/intermediate string. This is the mysql variable \"max_allowed_packet\".

max_execution_time

(optional) (\"max_execution_time\")

mysqlx_connect_timeout

(optional) The number of seconds X Plugin waits for the first packet to be received from newly connected clients. mysqlxConnectTimeout corresponds to the MySQL X Plugin system variable mysqlx_connect_timeout

mysqlx_document_id_unique_prefix

(optional) (\"mysqlx_document_id_unique_prefix\") DEPRECATED -- variable should not be settable and will be ignored

mysqlx_idle_worker_thread_timeout

(optional) (\"mysqlx_idle_worker_thread_timeout\") DEPRECATED -- variable should not be settable and will be ignored

mysqlx_interactive_timeout

(optional) The number of seconds to wait for interactive clients to timeout. mysqlxInteractiveTimeout corresponds to the MySQL X Plugin system variable. mysqlx_interactive_timeout

mysqlx_max_allowed_packet

(optional) The maximum size of network packets that can be received by X Plugin. This is the mysql variable \"mysqlx_max_allowed_packet\".

mysqlx_min_worker_threads

(optional) (\"mysqlx_min_worker_threads\") DEPRECATED -- variable should not be settable and will be ignored

mysqlx_read_timeout

(optional) The number of seconds that X Plugin waits for blocking read operations to complete. After this time, if the read operation is not successful, X Plugin closes the connection and returns a warning notice with the error code ER_IO_READ_ERROR to the client application. mysqlxReadTimeout corresponds to the MySQL X Plugin system variable mysqlx_read_timeout

mysqlx_wait_timeout

(optional) The number of seconds that X Plugin waits for activity on a connection. mysqlxWaitTimeout corresponds to the MySQL X Plugin system variable. mysqlx_wait_timeout

mysqlx_write_timeout

(optional) The number of seconds that X Plugin waits for blocking write operations to complete. After this time, if the write operation is not successful, X Plugin closes the connection. mysqlxReadmysqlxWriteTimeoutTimeout corresponds to the MySQL X Plugin system variable mysqlx_write_timeout

net_read_timeout

(optional) The number of seconds to wait for more data from a connection before aborting the read. netReadTimeout corresponds to the MySQL system variable net_read_timeout

net_write_timeout

(optional) The number of seconds to wait for a block to be written to a connection before aborting the write. netWriteTimeout corresponds to the MySQL system variable net_write_timeout

parser_max_mem_size

(optional) (\"parser_max_mem_size\")

query_alloc_block_size

(optional) (\"query_alloc_block_size\") DEPRECATED -- variable should not be settable and will be ignored

query_prealloc_size

(optional) (\"query_prealloc_size\") DEPRECATED -- variable should not be settable and will be ignored

regexp_time_limit

(optional) regexpTimeLimit corresponds to the MySQL system variable regexp_time_limit]

sql_mode

(optional) (\"sql_mode\")

tmp_table_size

(optional) The maximum size of internal in-memory temporary tables. This variable does not apply to user-created MEMORY tables. tmp_table_size corresponds to the MySQL system variable tmp_table_size

mysqlx_deflate_default_compression_level

(optional) Set the default compression level for the deflate algorithm. (\"mysqlx_deflate_default_compression_level\")

mysqlx_deflate_max_client_compression_level

(optional) Limit the upper bound of accepted compression levels for the deflate algorithm. (\"mysqlx_deflate_max_client_compression_level\")

mysqlx_lz4_max_client_compression_level

(optional) Limit the upper bound of accepted compression levels for the lz4 algorithm. (\"mysqlx_lz4_max_client_compression_level\")

mysqlx_lz4_default_compression_level

(optional) Set the default compression level for the lz4 algorithm. (\"mysqlx_lz4_default_compression_level\")

mysqlx_zstd_max_client_compression_level

(optional) Limit the upper bound of accepted compression levels for the zstd algorithm. (\"mysqlx_zstd_max_client_compression_level\")

mysqlx_zstd_default_compression_level

(optional) Set the default compression level for the zstd algorithm. (\"mysqlx_zstd_default_compression_level\")

mysql_zstd_default_compression_level

(optional) DEPRECATED -- typo of mysqlx_zstd_default_compression_level. variable will be ignored.

sort_buffer_size

(optional) Each session that must perform a sort allocates a buffer of this size. sortBufferSize corresponds to the MySQL system variable sort_buffer_size

wait_timeout

(optional) The number of seconds the server waits for activity on a noninteractive connection before closing it. waitTimeout corresponds to the MySQL system variable. wait_timeout

thread_pool_dedicated_listeners

(optional) Controls whether the thread pool uses dedicated listener threads. If enabled, a listener thread in each thread group is dedicated to the task of listening for network events from clients, ensuring that the maximum number of query worker threads is no more than the value specified by threadPoolMaxTransactionsLimit. threadPoolDedicatedListeners corresponds to the MySQL Database Service-specific system variable thread_pool_dedicated_listeners.

thread_pool_max_transactions_limit

(optional) Limits the maximum number of open transactions to the defined value. The default value is 0, which enforces no limit. threadPoolMaxTransactionsLimit corresponds to the MySQL Database Service-specific system variable thread_pool_max_transactions_limit.

time_zone

(optional) Initializes the time zone for each client that connects. This corresponds to the MySQL System Variable \"time_zone\". The values can be given in one of the following formats, none of which are case-sensitive: - As a string indicating an offset from UTC of the form [H]H:MM, prefixed with a + or -, such as '+10:00', '-6:00', or '+05:30'. The permitted range is '-13:59' to '+14:00', inclusive. - As a named time zone, as defined by the \"IANA Time Zone database\", such as 'Europe/Helsinki', 'US/Eastern', 'MET', or 'UTC'.

id

(required) The OCID of the Configuration.

compartment_id

(required) OCID of the Compartment the Configuration exists in.

description

(optional) User-provided data about the Configuration.

display_name

(optional) The display name of the Configuration.

shape_name

(required) The name of the associated Shape.

l_type

(required) The Configuration type, DEFAULT or CUSTOM.

Allowed values are: 'DEFAULT', 'CUSTOM'

time_created

(required) The date and time the Configuration was created, as described by RFC 3339.

time_updated

(required) The date and time the Configuration was last updated, as described by RFC 3339.

lifecycle_state

(required) The current state of the Configuration.

Allowed values are: 'ACTIVE', 'DELETED'

init_variables

(optional)

variables

(required)

parent_configuration_id

(optional) The OCID of the Configuration from which this Configuration is \"derived\". This is entirely a metadata relationship. There is no relation between the values in this Configuration and its parent.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

id

(required) The OCID of the Configuration.

compartment_id

(required) OCID of the Compartment the Configuration exists in.

description

(optional) User-provided data about the Configuration.

display_name

(optional) The display name of the Configuration.

shape_name

(required) The name of the associated Shape.

l_type

(required) The Configuration type, DEFAULT or CUSTOM

lifecycle_state

(required) The current state of the Configuration.

time_created

(optional) The date and time the Configuration was created, as described by RFC 3339.

time_updated

(optional) The date and time the Configuration was last updated, as described by RFC 3339.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

display_name

(optional) A user-supplied display name for the backup.

description

(optional) A user-supplied description for the backup.

backup_type

(optional) The type of backup.

Allowed values are: 'FULL', 'INCREMENTAL'

db_system_id

(required) The OCID of the DB System the Backup is associated with.

retention_in_days

(optional) Number of days to retain this backup.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

is_enabled

(optional) Specifies if automatic backups are enabled.

window_start_time

(optional) The start of a 30-minute window of time in which daily, automated backups occur. This should be in the format of the \"Time\" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero. At some point in the window, the system may incur a brief service disruption as the backup is performed.

retention_in_days

(optional) Number of days to retain an automatic backup.

freeform_tags

(optional) Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

pitr_policy

(optional)

source_type

(required) The specific source identifier.

target_type

(required) The specific target identifier.

compartment_id

(optional) The OCID of the compartment.

display_name

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

is_enabled

(optional) Whether the Channel should be enabled upon creation. If set to true, the Channel will be asynchronously started as a result of the create Channel operation.

source

(required)

target

(required)

description

(optional) User provided information about the Channel.

freeform_tags

(optional) Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

hostname

(required) The network address of the MySQL instance.

port

(optional) The port the source MySQL instance listens on.

username

(required) The name of the replication user on the source MySQL instance. The username has a maximum length of 96 characters. For more information, please see the MySQL documentation

password

(required) The password for the replication user. The password must be between 8 and 32 characters long, and must contain at least 1 numeric character, 1 lowercase character, 1 uppercase character, and 1 special (nonalphanumeric) character.

ssl_mode

(required) The SSL mode of the Channel.

ssl_ca_certificate

(optional)

anonymous_transactions_handling

(optional)

db_system_id

(required) The OCID of the target DB System.

channel_name

(optional) The case-insensitive name that identifies the replication channel. Channel names must follow the rules defined for MySQL identifiers. The names of non-Deleted Channels must be unique for each DB System.

applier_username

(optional) The username for the replication applier of the target MySQL DB System.

filters

(optional) Replication filter rules to be applied at the DB System Channel target.

tables_without_primary_key_handling

(optional) Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key. The default value is set to ALLOW.

delay_in_seconds

(optional) Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source.

compartment_id

(required) The OCID of the compartment.

description

(optional) User-provided data about the Configuration.

display_name

(optional) The display name of the Configuration.

shape_name

(required) The name of the associated Shape.

init_variables

(optional)

variables

(optional)

parent_configuration_id

(optional) The OCID of the Configuration from which the new Configuration is derived. The values in CreateConfigurationDetails.variables supersede the variables of the parent Configuration.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

source_type

(required) The specific source identifier.

Allowed values are: 'NONE', 'BACKUP', 'PITR', 'IMPORTURL'

window_start_time

(required) The start of the 2 hour maintenance window. This string is of the format: \"{day-of-week} {time-of-day}\". \"{day-of-week}\" is a case-insensitive string like \"mon\", \"tue\", &c. \"{time-of-day}\" is the \"Time\" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero. If you set the read replica maintenance window to \"\" or if not specified, the read replica is set same as the DB system maintenance window.

automatic_backup_retention

(optional) Specifies if any automatic backups created for a DB System should be retained or deleted when the DB System is deleted.

Allowed values are: 'DELETE', 'RETAIN'

final_backup

(optional) Specifies whether or not a backup is taken when the DB System is deleted. REQUIRE_FINAL_BACKUP: a backup is taken if the DB System is deleted. SKIP_FINAL_BACKUP: a backup is not taken if the DB System is deleted.

Allowed values are: 'SKIP_FINAL_BACKUP', 'REQUIRE_FINAL_BACKUP'

is_delete_protected

(optional) Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow.

display_name

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

description

(optional) User-provided data about the DB System.

compartment_id

(required) The OCID of the compartment.

is_highly_available

(optional) Specifies if the DB System is highly available. When creating a DB System with High Availability, three instances are created and placed according to your region- and subnet-type. The secondaries are placed automatically in the other two availability or fault domains. You can choose the preferred location of your primary instance, only.

availability_domain

(optional) The availability domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance. In a failover scenario, the Read/Write endpoint is redirected to one of the other availability domains and the MySQL instance in that domain is promoted to the primary instance. This redirection does not affect the IP address of the DB System in any way. For a standalone DB System, this defines the availability domain in which the DB System is placed.

fault_domain

(optional) The fault domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance. In a failover scenario, the Read/Write endpoint is redirected to one of the other fault domains and the MySQL instance in that domain is promoted to the primary instance. This redirection does not affect the IP address of the DB System in any way. For a standalone DB System, this defines the fault domain in which the DB System is placed.

configuration_id

(optional) The OCID of the Configuration to be used for this DB System.

shape_name

(required) The name of the shape. The shape determines the resources allocated - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. To get a list of shapes, use the LIST_SHAPES Function operation.

mysql_version

(optional) The specific MySQL version identifier.

subnet_id

(required) The OCID of the subnet the DB System is associated with.

admin_username

(optional) The username for the administrative user.

admin_password

(optional) The password for the administrative user. The password must be between 8 and 32 characters long, and must contain at least 1 numeric character, 1 lowercase character, 1 uppercase character, and 1 special (nonalphanumeric) character.

data_storage_size_in_g_bs

(optional) Initial size of the data volume in GBs that will be created and attached. Keep in mind that this only specifies the size of the database data volume, the log volume for the database will be scaled appropriately with its shape.

hostname_label

(optional) The hostname for the primary endpoint of the DB System. Used for DNS. The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) (for example, \"dbsystem-1\" in FQDN \"dbsystem-1.subnet123.vcn1.oraclevcn.com\"). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.

ip_address

(optional) The IP address the DB System is configured to listen on. A private IP address of your choice to assign to the primary endpoint of the DB System. 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. This should be a \"dotted-quad\" style IPv4 address.

port

(optional) The port for primary endpoint of the DB System to listen on.

port_x

(optional) The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port.

backup_policy

(optional)

source

(optional)

maintenance

(optional)

freeform_tags

(optional) Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

deletion_policy

(optional)

crash_recovery

(optional) Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, and whether to enable or disable syncing of the Binary Logs.

Allowed values are: 'ENABLED', 'DISABLED'

database_management

(optional) Whether to enable monitoring via the Database Management service.

Allowed values are: 'ENABLED', 'DISABLED'

backup_id

(required) The OCID of the backup to be used as the source for the new DB System.

db_system_id

(required) The OCID of the DB System from which a backup shall be selected to be restored when creating the new DB System. Use this together with recovery point to perform a point in time recovery operation.

recovery_point

(optional) The date and time, as per RFC 3339, of the change up to which the new DB System shall be restored to, using a backup and logs from the original DB System. In case no point in time is specified, then this new DB System shall be restored up to the latest change recorded for the original DB System.

source_url

(required) The Pre-Authenticated Request (PAR) of a bucket/prefix or PAR of a @.manifest.json object from the Object Storage. Check Using Pre-Authenticated Requests for information related to PAR creation. Please create PAR with \"Permit object reads\" access type and \"Enable Object Listing\" permission when using a bucket/prefix PAR. Please create PAR with \"Permit object reads\" access type when using a @.manifest.json object PAR.

mysql_version

(optional) The MySQL version to be used by the read replica.

shape_name

(optional) The shape to be used by the read replica. The shape determines the resources allocated: CPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes. To get a list of shapes, use the LIST_SHAPES Function operation.

configuration_id

(optional) The OCID of the Configuration to be used by the read replica.

db_system_id

(required) The OCID of the DB System the read replica is associated with.

display_name

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

description

(optional) User provided description of the read replica.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

is_delete_protected

(optional) Specifies whether the read replica can be deleted. Set to true to prevent deletion, false (default) to allow. Note that if a read replica is delete protected it also prevents the entire DB System from being deleted. If the DB System is delete protected, read replicas can still be deleted individually if they are not delete protected themselves.

replica_overrides

(optional)

availability_domain

(optional) The availability domain in which the DB System is placed.

fault_domain

(optional) The fault domain in which the DB System is placed.

shape_name

(required) The shape determines resources to allocate to the HeatWave nodes - CPU cores, memory.

cluster_size

(required) The number of analytics-processing compute instances, of the specified shape, in the HeatWave cluster.

is_lakehouse_enabled

(optional) Lakehouse enabled status for the HeatWave cluster.

lifecycle_state

(required) The current state of the MySQL HeatWave cluster.

time_created

(required) The date and time the HeatWave cluster was created, as described by RFC 3339.

time_updated

(required) The time the HeatWave cluster was last updated, as described by RFC 3339.

source_type

(required) The specific source identifier.

Allowed values are: 'NONE', 'BACKUP', 'PITR', 'IMPORTURL'

time_earliest_recovery_point

(required) Earliest recovery time point for the DB System, as described by RFC 3339.

time_latest_recovery_point

(required) Latest recovery time point for the DB System, as described by RFC 3339.

id

(required) The OCID of the DB System.

display_name

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

description

(optional) User-provided data about the DB System.

compartment_id

(required) The OCID of the compartment the DB System belongs in.

subnet_id

(required) The OCID of the subnet the DB System is associated with.

is_highly_available

(optional) Specifies if the DB System is highly available.

current_placement

(optional)

is_heat_wave_cluster_attached

(optional) If the DB System has a HeatWave Cluster attached.

heat_wave_cluster

(optional)

availability_domain

(optional) The availability domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance. In a failover scenario, the Read/Write endpoint is redirected to one of the other availability domains and the MySQL instance in that domain is promoted to the primary instance. This redirection does not affect the IP address of the DB System in any way. For a standalone DB System, this defines the availability domain in which the DB System is placed.

fault_domain

(optional) The fault domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance. In a failover scenario, the Read/Write endpoint is redirected to one of the other fault domains and the MySQL instance in that domain is promoted to the primary instance. This redirection does not affect the IP address of the DB System in any way. For a standalone DB System, this defines the fault domain in which the DB System is placed.

shape_name

(optional) The shape of the primary instances of the DB System. The shape determines resources allocated to a DB System - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. To get a list of shapes, use (the LIST_SHAPES Function operation.

mysql_version

(required) Name of the MySQL Version in use for the DB System.

backup_policy

(optional)

source

(optional)

configuration_id

(optional) The OCID of the Configuration to be used for Instances in this DB System.

data_storage_size_in_g_bs

(required) Initial size of the data volume in GiBs that will be created and attached.

hostname_label

(optional) The hostname for the primary endpoint of the DB System. Used for DNS. The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) (for example, \"dbsystem-1\" in FQDN \"dbsystem-1.subnet123.vcn1.oraclevcn.com\"). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.

ip_address

(optional) The IP address the DB System is configured to listen on. A private IP address of the primary endpoint of the DB System. Must be an available IP address within the subnet's CIDR. This will be a \"dotted-quad\" style IPv4 address.

port

(optional) The port for primary endpoint of the DB System to listen on.

port_x

(optional) The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port.

endpoints

(optional) The network endpoints available for this DB System.

channels

(optional) A list with a summary of all the Channels attached to the DB System.

lifecycle_state

(required) The current state of the DB System.

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

lifecycle_details

(optional) Additional information about the current lifecycleState.

maintenance

(required)

deletion_policy

(required)

time_created

(required) The date and time the DB System was created.

time_updated

(required) The time the DB System was last updated.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

crash_recovery

(optional) Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, and whether to enable or disable syncing of the Binary Logs.

Allowed values are: 'ENABLED', 'DISABLED'

point_in_time_recovery_details

(optional)

database_management

(optional) Whether to enable monitoring via the Database Management service.

Allowed values are: 'ENABLED', 'DISABLED'

backup_id

(required) The OCID of the backup to be used as the source for the new DB System.

db_system_id

(required) The OCID of the DB System from which a backup shall be selected to be restored when creating the new DB System. Use this together with recovery point to perform a point in time recovery operation.

recovery_point

(optional) The date and time, as per RFC 3339, of the change up to which the new DB System shall be restored to, using a backup and logs from the original DB System. In case no point in time is specified, then this new DB System shall be restored up to the latest change recorded for the original DB System.

id

(required) The OCID of the DB System.

display_name

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

description

(optional) User-provided data about the DB System.

compartment_id

(optional) The OCID of the compartment the DB System belongs in.

is_highly_available

(optional) Specifies if the DB System is highly available.

current_placement

(optional)

is_heat_wave_cluster_attached

(optional) If the DB System has a HeatWave Cluster attached.

heat_wave_cluster

(optional)

availability_domain

(optional) The availability domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance. In a failover scenario, the Read/Write endpoint is redirected to one of the other availability domains and the MySQL instance in that domain is promoted to the primary instance. This redirection does not affect the IP address of the DB System in any way. For a standalone DB System, this defines the availability domain in which the DB System is placed.

fault_domain

(optional) The fault domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance. In a failover scenario, the Read/Write endpoint is redirected to one of the other fault domains and the MySQL instance in that domain is promoted to the primary instance. This redirection does not affect the IP address of the DB System in any way. For a standalone DB System, this defines the fault domain in which the DB System is placed.

endpoints

(optional) The network endpoints available for this DB System.

lifecycle_state

(required) The current state of the DB System.

mysql_version

(required) Name of the MySQL Version in use for the DB System.

time_created

(required) The date and time the DB System was created.

time_updated

(required) The time the DB System was last updated.

deletion_policy

(optional)

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

backup_policy

(optional)

shape_name

(optional) The shape of the primary instances of the DB System. The shape determines resources allocated to a DB System - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. To get a list of shapes, use (the LIST_SHAPES Function operation.

crash_recovery

(optional) Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, and whether to enable or disable syncing of the Binary Logs.

Allowed values are: 'ENABLED', 'DISABLED'

database_management

(optional) Whether to enable monitoring via the Database Management service.

Allowed values are: 'ENABLED', 'DISABLED'

code

(required) A short error code that defines the error, meant for programmatic parsing. See API Errors.

message

(required) A human-readable error string.

node_id

(required) The ID of the node within MySQL HeatWave cluster.

lifecycle_state

(required) The current state of the MySQL HeatWave node.

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

time_created

(optional) The date and time the MySQL HeatWave node was created, as described by RFC 3339.

time_updated

(optional) The date and time the MySQL HeatWave node was updated, as described by RFC 3339.

db_system_id

(required) The OCID of the parent DB System this HeatWave cluster is attached to.

shape_name

(required) The shape determines resources to allocate to the HeatWave nodes - CPU cores, memory.

cluster_size

(required) The number of analytics-processing compute instances, of the specified shape, in the HeatWave cluster.

is_lakehouse_enabled

(optional) Lakehouse enabled status for the HeatWave cluster.

cluster_nodes

(required) A HeatWave node is a compute host that is part of a HeatWave cluster.

lifecycle_state

(required) The current state of the HeatWave cluster.

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

lifecycle_details

(optional) Additional information about the current lifecycleState.

time_created

(required) The date and time the HeatWave cluster was created, as described by RFC 3339.

time_updated

(required) The time the HeatWave cluster was last updated, as described by RFC 3339.

table_name

(required) The table name.

to_load_column_count

(required) The number of columns to be loaded to HeatWave cluster memory. These columns contribute to the analytical memory footprint.

varlen_column_count

(required) The number of variable-length columns to be loaded to HeatWave cluster memory. These columns contribute to the analytical memory footprint.

estimated_row_count

(required) The estimated number of rows in the table. This number was used to derive the analytical memory footprint.

analytical_footprint_in_mbs

(required) The estimated memory footprint of the table in MBs when loaded to HeatWave cluster memory (null if the table cannot be loaded to the HeatWave cluster).

error_comment

(required) Error comment (empty string if no errors occured).

schema_name

(required) The name of the schema.

per_table_estimates

(required) Estimated memory footprints for MySQL user tables of the schema when loaded to HeatWave cluster memory.

db_system_id

(required) The OCID of the DB System the HeatWave cluster memory estimate is associated with.

status

(required) Current status of the Work Request generating the HeatWave cluster memory estimate.

Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED'

time_created

(required) The date and time that the Work Request to generate the HeatWave cluster memory estimate was issued, as described by RFC 3339.

time_updated

(required) The date and time that the HeatWave cluster memory estimate was generated, as described by RFC 3339.

table_schemas

(required) Collection of schemas with estimated memory footprints for MySQL user tables of each schema when loaded to HeatWave cluster memory.

contents

(required) The string containing the CA certificate in PEM format.

id

(required) The OCID of the read replica.

db_system_id

(required) The OCID of the DB System the read replica is associated with.

compartment_id

(required) The OCID of the compartment that contains the read replica.

display_name

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

description

(optional) User provided description of the read replica.

lifecycle_state

(required) The state of the read replica.

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

lifecycle_details

(optional) A message describing the state of the read replica.

time_created

(required) The date and time the read replica was created, as described by RFC 3339.

time_updated

(optional) The time the read replica was last updated, as described by RFC 3339.

mysql_version

(required) The MySQL version currently in use by the read replica.

availability_domain

(optional) The name of the Availability Domain the read replica is located in.

fault_domain

(optional) The name of the Fault Domain the read replica is located in.

ip_address

(required) The IP address the read replica is configured to listen on.

port

(required) The port the read replica is configured to listen on.

port_x

(required) The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

is_delete_protected

(optional) Specifies whether the read replica can be deleted. Set to true to prevent deletion, false (default) to allow. Note that if a read replica is delete protected it also prevents the entire DB System from being deleted. If the DB System is delete protected, read replicas can still be deleted individually if they are not delete protected themselves.

shape_name

(optional) The shape currently in use by the read replica. The shape determines the resources allocated: CPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes. To get a list of shapes, use the LIST_SHAPES Function operation.

configuration_id

(optional) The OCID of the Configuration currently in use by the read replica.

replica_overrides

(optional)

id

(required) The OCID of the read replica.

db_system_id

(required) The OCID of the DB System the read replica is associated with.

compartment_id

(required) The OCID of the compartment that contains the read replica.

display_name

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

description

(optional) User provided description of the read replica.

lifecycle_state

(required) The state of the read replica.

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

lifecycle_details

(optional) A message describing the state of the read replica.

time_created

(required) The date and time the read replica was created, as described by RFC 3339.

time_updated

(optional) The time the read replica was last updated, as described by RFC 3339.

mysql_version

(required) The MySQL version currently in use by the read replica.

availability_domain

(optional) The name of the Availability Domain the read replica is located in.

fault_domain

(optional) The name of the Fault Domain the read replica is located in.

ip_address

(required) The IP address the read replica is configured to listen on.

port

(required) The port the read replica is configured to listen on.

port_x

(required) The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

is_delete_protected

(optional) Specifies whether the read replica can be deleted. Set to true to prevent deletion, false (default) to allow. Note that if a read replica is delete protected it also prevents the entire DB System from being deleted. If the DB System is delete protected, read replicas can still be deleted individually if they are not delete protected themselves.

shape_name

(optional) The shape currently in use by the read replica. The shape determines the resources allocated: CPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes. To get a list of shapes, use the LIST_SHAPES Function operation.

configuration_id

(optional) The OCID of the Configuration currently in use by the read replica.

replica_overrides

(optional)

shutdown_type

(required) The InnoDB shutdown mode to use, following the option \"innodb_fast_shutdown\".

Allowed values are: 'IMMEDIATE', 'FAST', 'SLOW'

name

(required) The name of the shape used for the DB System.

cpu_core_count

(required) The number of CPU Cores the Instance provides. These are \"OCPU\"s.

memory_size_in_g_bs

(required) The amount of RAM the Instance provides. This is an IEC base-2 number.

is_supported_for

(optional) What service features the shape is supported for.

Allowed values are: 'DBSYSTEM', 'HEATWAVECLUSTER'

shutdown_type

(required) The InnoDB shutdown mode to use, following the option \"innodb_fast_shutdown\".

Allowed values are: 'IMMEDIATE', 'FAST', 'SLOW'

display_name

(optional) A user-supplied display name for the backup.

description

(optional) A user-supplied description for the backup.

retention_in_days

(optional) The number of days backups are retained.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

is_enabled

(optional) Specifies if automatic backups are enabled.

window_start_time

(optional) The start of a 30-minute window of time in which daily, automated backups occur. This should be in the format of the \"Time\" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero. At some point in the window, the system may incur a brief service disruption as the backup is performed.

retention_in_days

(optional) Number of days to retain an automatic backup.

freeform_tags

(optional) Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

pitr_policy

(optional)

source_type

(required) The specific source identifier.

target_type

(required) The specific targetType identifier.

source

(optional)

target

(optional)

display_name

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

is_enabled

(optional) Whether the Channel should be enabled or disabled. Enabling a previously disabled Channel will cause the Channel to be started. Conversely, disabling a previously enabled Channel will stop the Channel. Both operations are executed asynchronously.

description

(optional) User provided description of the Channel.

freeform_tags

(optional) Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

hostname

(optional) The network address of the MySQL instance.

port

(optional) The port the source MySQL instance listens on.

username

(optional) The name of the replication user on the source MySQL instance. The username has a maximum length of 96 characters. For more information, please see the MySQL documentation

password

(optional) The password for the replication user. The password must be between 8 and 32 characters long, and must contain at least 1 numeric character, 1 lowercase character, 1 uppercase character, and 1 special (nonalphanumeric) character.

ssl_mode

(optional) The SSL mode of the Channel.

ssl_ca_certificate

(optional)

anonymous_transactions_handling

(optional)

channel_name

(optional) The case-insensitive name that identifies the replication channel. Channel names must follow the rules defined for MySQL identifiers. The names of non-Deleted Channels must be unique for each DB System.

applier_username

(optional) The username for the replication applier of the target MySQL DB System.

filters

(optional) Replication filter rules to be applied at the DB System Channel target.

tables_without_primary_key_handling

(optional) Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key.

delay_in_seconds

(optional) Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source.

description

(optional) User-provided data about the Configuration.

display_name

(optional) A new display name for the Configuration.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

window_start_time

(optional) The start of the 2 hour maintenance window. This string is of the format: \"{day-of-week} {time-of-day}\". \"{day-of-week}\" is a case-insensitive string like \"mon\", \"tue\", &c. \"{time-of-day}\" is the \"Time\" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero. If you set the read replica maintenance window to \"\", the read replica is set same as the DB system maintenance window. If not specific by the user, there will be no changes to the maintenace window.

automatic_backup_retention

(optional) Specifies if any automatic backups created for a DB System should be retained or deleted when the DB System is deleted.

Allowed values are: 'DELETE', 'RETAIN'

final_backup

(optional) Specifies whether or not a backup is taken when the DB System is deleted. REQUIRE_FINAL_BACKUP: a backup is taken if the DB System is deleted. SKIP_FINAL_BACKUP: a backup is not taken if the DB System is deleted.

Allowed values are: 'SKIP_FINAL_BACKUP', 'REQUIRE_FINAL_BACKUP'

is_delete_protected

(optional) Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow.

display_name

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

description

(optional) User-provided data about the DB System.

subnet_id

(optional) The OCID of the subnet the DB System is associated with.

is_highly_available

(optional) Specifies if the DB System is highly available. Set to true to enable high availability. Two secondary MySQL instances are created and placed in the unused availability or fault domains, depending on your region and subnet type. Set to false to disable high availability. The secondary MySQL instances are removed and the MySQL instance in the preferred location is used.

availability_domain

(optional) The availability domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance. In a failover scenario, the Read/Write endpoint is redirected to one of the other availability domains and the MySQL instance in that domain is promoted to the primary instance. This redirection does not affect the IP address of the DB System in any way. For a standalone DB System, this defines the availability domain in which the DB System is placed.

fault_domain

(optional) The fault domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance. In a failover scenario, the Read/Write endpoint is redirected to one of the other fault domains and the MySQL instance in that domain is promoted to the primary instance. This redirection does not affect the IP address of the DB System in any way. For a standalone DB System, this defines the fault domain in which the DB System is placed.

shape_name

(optional) The shape of the DB System. The shape determines resources allocated to the DB System - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. To get a list of shapes, use the LIST_SHAPES Function operation. Changes in Shape will result in a downtime as the MySQL DB System is migrated to the new Compute instance.

mysql_version

(optional) The specific MySQL version identifier.

configuration_id

(optional) The OCID of the Configuration to be used for Instances in this DB System.

admin_username

(optional) The username for the administrative user for the MySQL Instance.

admin_password

(optional) The password for the administrative user. The password must be between 8 and 32 characters long, and must contain at least 1 numeric character, 1 lowercase character, 1 uppercase character, and 1 special (nonalphanumeric) character.

data_storage_size_in_g_bs

(optional) Expands the DB System's storage to the specified value. Only supports values larger than the current DB System's storage size. DB Systems with an initial storage size of 400 GB or less can be expanded up to 32 TB. DB Systems with an initial storage size between 401-800 GB can be expanded up to 64 TB. DB Systems with an initial storage size between 801-1200 GB can be expanded up to 96 TB. DB Systems with an initial storage size of 1201 GB or more can be expanded up to 128 TB. It is not possible to decrease data storage size.

hostname_label

(optional) The hostname for the primary endpoint of the DB System. Used for DNS. The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) (for example, \"dbsystem-1\" in FQDN \"dbsystem-1.subnet123.vcn1.oraclevcn.com\"). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.

ip_address

(optional) The IP address the DB System should be configured to listen on the provided subnet. It must be a free private IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This should be a \"dotted-quad\" style IPv4 address.

port

(optional) The port for primary endpoint of the DB System to listen on.

port_x

(optional) The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port.

backup_policy

(optional)

maintenance

(optional)

freeform_tags

(optional) Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

deletion_policy

(optional)

crash_recovery

(optional) Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, and whether to enable or disable syncing of the Binary Logs.

Allowed values are: 'ENABLED', 'DISABLED'

database_management

(optional) Whether to enable monitoring via the Database Management service.

Allowed values are: 'ENABLED', 'DISABLED'

shape_name

(optional) A change to the shape of the nodes in the HeatWave cluster will result in the entire cluster being torn down and re-created with Compute instances of the new Shape. This may result in significant downtime for the analytics capability while the HeatWave cluster is re-provisioned.

cluster_size

(optional) A change to the number of nodes in the HeatWave cluster will result in the entire cluster being torn down and re-created with the new cluster of nodes. This may result in a significant downtime for the analytics capability while the HeatWave cluster is re-provisioned.

is_lakehouse_enabled

(optional) Enable/disable Lakehouse for the HeatWave cluster.

display_name

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

description

(optional) User provided description of the read replica.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

is_delete_protected

(optional) Specifies whether the read replica can be deleted. Set to true to prevent deletion, false (default) to allow. Note that if a read replica is delete protected it also prevents the entire DB System from being deleted. If the DB System is delete protected, read replicas can still be deleted individually if they are not delete protected themselves.

replica_overrides

(optional)

version

(optional) The specific version identifier

description

(optional) A link to a page describing the version.

version_family

(optional) A descriptive summary of a group of versions.

versions

(required) The list of supported MySQL Versions.

entity_type

(required) The resource type the work request affects.

action_type

(required) The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively.

Allowed values are: 'CREATED', 'UPDATED', 'DELETED', 'IN_PROGRESS', 'RELATED'

identifier

(required) The identifier of the resource the work request affects.

entity_uri

(optional) The URI path the user can do a GET on to access the resource.

id

(required) The id of the work request.

operation_type

(required) the original operation ID requested

Allowed values are: 'CREATE_DBSYSTEM', 'UPDATE_DBSYSTEM', 'DELETE_DBSYSTEM', 'START_DBSYSTEM', 'STOP_DBSYSTEM', 'RESTART_DBSYSTEM', 'ADD_HEATWAVE_CLUSTER', 'UPDATE_HEATWAVE_CLUSTER', 'DELETE_HEATWAVE_CLUSTER', 'START_HEATWAVE_CLUSTER', 'STOP_HEATWAVE_CLUSTER', 'RESTART_HEATWAVE_CLUSTER', 'GENERATE_HEATWAVE_CLUSTER_MEMORY_ESTIMATE', 'CREATE_REPLICA', 'UPDATE_REPLICA', 'DELETE_REPLICA', 'CREATE_CHANNEL', 'UPDATE_CHANNEL', 'RESUME_CHANNEL', 'RESET_CHANNEL', 'DELETE_CHANNEL'

status

(required) Current status of the work request

Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED'

compartment_id

(required) The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used

resources

(required) The resources affected by this work request.

percent_complete

(required) Percentage of the request completed.

time_accepted

(required) The date and time the request was created, as described in RFC 3339, section 14.29.

time_started

(optional) The date and time the request was started, as described in RFC 3339, section 14.29.

time_finished

(optional) The date and time the object was finished, as described in RFC 3339.

code

(required) A machine-usable code for the error that occured. Error codes are listed on (https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)

message

(required) A human readable description of the issue encountered.

l_timestamp

(required) The time the error occured. An RFC3339 formatted datetime string.

message

(required) Human-readable log message.

l_timestamp

(required) The time the log message was written. An RFC3339 formatted datetime string

id

(required) The id of the work request.

operation_type

(required) the original operation ID requested

Allowed values are: 'CREATE_DBSYSTEM', 'UPDATE_DBSYSTEM', 'DELETE_DBSYSTEM', 'START_DBSYSTEM', 'STOP_DBSYSTEM', 'RESTART_DBSYSTEM', 'ADD_HEATWAVE_CLUSTER', 'UPDATE_HEATWAVE_CLUSTER', 'DELETE_HEATWAVE_CLUSTER', 'START_HEATWAVE_CLUSTER', 'STOP_HEATWAVE_CLUSTER', 'RESTART_HEATWAVE_CLUSTER', 'GENERATE_HEATWAVE_CLUSTER_MEMORY_ESTIMATE', 'CREATE_REPLICA', 'UPDATE_REPLICA', 'DELETE_REPLICA', 'CREATE_CHANNEL', 'UPDATE_CHANNEL', 'RESUME_CHANNEL', 'RESET_CHANNEL', 'DELETE_CHANNEL'

status

(required) Current status of the work request

Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED'

compartment_id

(required) The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used

percent_complete

(required) Percentage of the request completed.

time_accepted

(required) The date and time the request was created, as described in RFC 3339, section 14.29.

time_started

(optional) The date and time the request was started, as described in RFC 3339, section 14.29.

time_finished

(optional) The date and time the object was finished, as described in RFC 3339.