mysql.oracle.com/v1beta1
Back to API Reference
APIVersion: mysql.oracle.com/v1beta1
This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.
Packages
| Package |
Support |
Latest release |
Resources |
| MySQL |
preview |
v2.0.0-alpha |
DbSystem |
Resources
| Kind |
Scope |
Sample |
Packages |
| DbSystem |
Namespaced |
Sample |
MySQL (v2.0.0-alpha) |
DbSystem
Manage OCI MySQL DB Systems.
Plural: dbsystemsScope: NamespacedAPIVersion: mysql.oracle.com/v1beta1Sample: Sample (config/samples/mysql_v1beta1_dbsystem.yaml)Packages: MySQL (v2.0.0-alpha)
Spec
DbSystemSpec defines the desired state of DbSystem.
| Field |
Description |
Type |
Required |
Default |
Enum |
accessMode |
The access mode indicating if the database access will be restricted only to administrators or not: - UNRESTRICTED (default): the access to the database is not restricted; - RESTRICTED: the access will be allowed only to users with specific privileges; RESTRICTED will correspond to setting the MySQL system variable offline_mode (https://dev.mysql.com/doc/en/server-system-variables.html#sysvar_offline_mode) to ON. |
string |
No |
- |
- |
adminPassword |
The password for the administrative user sourced from a Kubernetes Secret in the same namespace. The referenced Secret must contain a password key. |
object |
No |
- |
- |
adminUsername |
The username for the administrative user sourced from a Kubernetes Secret in the same namespace. The referenced Secret must contain a username key. |
object |
No |
- |
- |
availabilityDomain |
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. |
string |
No |
- |
- |
backupPolicy |
DbSystemBackupPolicy defines nested fields for DbSystem.BackupPolicy. |
object |
No |
- |
- |
compartmentId |
The OCID of the compartment. |
string |
Yes |
- |
- |
configurationId |
The OCID of the Configuration to be used for this DB System. |
string |
No |
- |
- |
crashRecovery |
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. |
string |
No |
- |
- |
customerContacts |
The list of customer email addresses that receive information from Oracle about the specified OCI DB System 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 DB System. |
list[object] |
No |
- |
- |
dataStorage |
DbSystemDataStorage defines nested fields for DbSystem.DataStorage. |
object |
No |
- |
- |
dataStorageSizeInGBs |
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. |
integer |
No |
- |
- |
databaseConsole |
DbSystemDatabaseConsole defines nested fields for DbSystem.DatabaseConsole. |
object |
No |
- |
- |
databaseManagement |
Whether to enable monitoring via the Database Management service. |
string |
No |
- |
- |
databaseMode |
The database mode indicating the types of statements that will be allowed to run in the DB system. This mode will apply only to statements run by user connections. Replicated write statements will continue to be allowed regardless of the DatabaseMode. - READ_WRITE (default): allow running read and write statements on the DB system; - READ_ONLY: only allow running read statements on the DB system. |
string |
No |
- |
- |
definedTags |
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No |
- |
- |
deletionPolicy |
DbSystemDeletionPolicy defines nested fields for DbSystem.DeletionPolicy. |
object |
No |
- |
- |
description |
User-provided data about the DB System. |
string |
No |
- |
- |
displayName |
The user-friendly name for the DB System. It does not have to be unique. |
string |
No |
- |
- |
encryptData |
DbSystemEncryptData defines nested fields for DbSystem.EncryptData. |
object |
No |
- |
- |
faultDomain |
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. |
string |
No |
- |
- |
freeformTags |
Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} |
map[string, string] |
No |
- |
- |
hostnameLabel |
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. |
string |
No |
- |
- |
ipAddress |
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. |
string |
No |
- |
- |
isHighlyAvailable |
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. |
boolean |
No |
- |
- |
maintenance |
DbSystemMaintenance defines nested fields for DbSystem.Maintenance. |
object |
No |
- |
- |
mysqlVersion |
The specific MySQL version identifier. |
string |
No |
- |
- |
nsgIds |
Network Security Group OCIDs used for the VNIC attachment. |
list[string] |
No |
- |
- |
port |
The port for primary endpoint of the DB System to listen on. |
integer |
No |
- |
- |
portX |
The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port. |
integer |
No |
- |
- |
readEndpoint |
DbSystemReadEndpoint defines nested fields for DbSystem.ReadEndpoint. |
object |
No |
- |
- |
rest |
DbSystemRest defines nested fields for DbSystem.Rest. |
object |
No |
- |
- |
secureConnections |
DbSystemSecureConnections defines nested fields for DbSystem.SecureConnections. |
object |
No |
- |
- |
securityAttributes |
Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see ZPR Artifacts (https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm). Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}} |
map[string, map[string, string]] |
No |
- |
- |
shapeName |
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 ListShapes operation. |
string |
Yes |
- |
- |
source |
DbSystemSource defines nested fields for DbSystem.Source. |
object |
No |
- |
- |
subnetId |
The OCID of the subnet the DB System is associated with. |
string |
Yes |
- |
- |
telemetryConfiguration |
DbSystemTelemetryConfiguration defines nested fields for DbSystem.TelemetryConfiguration. |
object |
No |
- |
- |
Spec.adminPassword
Back to DbSystem spec
The password for the administrative user sourced from a Kubernetes Secret in the same namespace. The referenced Secret must contain a password key.
| Field |
Description |
Type |
Required |
Default |
Enum |
secret |
- |
object |
No |
- |
- |
Spec.adminPassword.secret
Back to DbSystem spec
| Field |
Description |
Type |
Required |
Default |
Enum |
secretName |
- |
string |
No |
- |
- |
Spec.adminUsername
Back to DbSystem spec
The username for the administrative user sourced from a Kubernetes Secret in the same namespace. The referenced Secret must contain a username key.
| Field |
Description |
Type |
Required |
Default |
Enum |
secret |
- |
object |
No |
- |
- |
Spec.adminUsername.secret
Back to DbSystem spec
| Field |
Description |
Type |
Required |
Default |
Enum |
secretName |
- |
string |
No |
- |
- |
Spec.backupPolicy
Back to DbSystem spec
DbSystemBackupPolicy defines nested fields for DbSystem.BackupPolicy.
| Field |
Description |
Type |
Required |
Default |
Enum |
copyPolicies |
List of policies of a DB system to schedule cross-region DB system backup copy. The policy includes the name of the destination region to which the DB system backup will be copied, and an optional parameter which specifies the retention period of the copied DB system backup in days. Note: Currently, only one policy can be specified in the list. |
list[object] |
No |
- |
- |
definedTags |
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"}} |
map[string, map[string, string]] |
No |
- |
- |
freeformTags |
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"} |
map[string, string] |
No |
- |
- |
isEnabled |
Specifies if automatic backups are enabled. |
boolean |
No |
- |
- |
pitrPolicy |
DbSystemBackupPolicyPitrPolicy defines nested fields for DbSystem.BackupPolicy.PitrPolicy. |
object |
No |
- |
- |
retentionInDays |
Number of days to retain an automatic backup. |
integer |
No |
- |
- |
softDelete |
Retains the backup to be deleted due to the retention policy in DELETE SCHEDULED state for 7 days before permanently deleting it. |
string |
No |
- |
- |
windowStartTime |
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. |
string |
No |
- |
- |
Spec.backupPolicy.copyPolicies[]
Back to DbSystem spec
DbSystemBackupPolicyCopyPolicy defines nested fields for DbSystem.BackupPolicy.CopyPolicy.
| Field |
Description |
Type |
Required |
Default |
Enum |
backupCopyRetentionInDays |
Number of days to retain the copied DB system backup. |
integer |
No |
- |
- |
copyToRegion |
The destination region name to which the DB system backup will be copied. |
string |
Yes |
- |
- |
Spec.backupPolicy.pitrPolicy
Back to DbSystem spec
DbSystemBackupPolicyPitrPolicy defines nested fields for DbSystem.BackupPolicy.PitrPolicy.
| Field |
Description |
Type |
Required |
Default |
Enum |
isEnabled |
Specifies if PITR is enabled or disabled. |
boolean |
Yes |
- |
- |
Back to DbSystem spec
DbSystemCustomerContact defines nested fields for DbSystem.CustomerContact.
| Field |
Description |
Type |
Required |
Default |
Enum |
email |
The email address used by Oracle to send notifications regarding the DB System. |
string |
Yes |
- |
- |
Spec.dataStorage
Back to DbSystem spec
DbSystemDataStorage defines nested fields for DbSystem.DataStorage.
| Field |
Description |
Type |
Required |
Default |
Enum |
isAutoExpandStorageEnabled |
Enable/disable automatic storage expansion. When set to true, the DB System will automatically add storage incrementally up to the value specified in maxStorageSizeInGBs. |
boolean |
No |
- |
- |
maxStorageSizeInGBs |
Maximum storage size this DB System can expand to. When isAutoExpandStorageEnabled is set to true, the DB System will add storage incrementally up to this value. 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. You cannot set the maximum data storage size to less than either current DB System dataStorageSizeInGBs or allocatedStorageSizeInGBs. |
integer |
No |
- |
- |
Spec.databaseConsole
Back to DbSystem spec
DbSystemDatabaseConsole defines nested fields for DbSystem.DatabaseConsole.
| Field |
Description |
Type |
Required |
Default |
Enum |
port |
The port on which the database console can be accessed. Supported port numbers are 443 and from 1024 to 65535. |
integer |
No |
- |
- |
status |
Enable/disable the database console on the DB System. |
string |
Yes |
- |
- |
Spec.deletionPolicy
Back to DbSystem spec
DbSystemDeletionPolicy defines nested fields for DbSystem.DeletionPolicy.
| Field |
Description |
Type |
Required |
Default |
Enum |
automaticBackupRetention |
Specifies if any automatic backups created for a DB System should be retained or deleted when the DB System is deleted. |
string |
No |
- |
- |
finalBackup |
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. |
string |
No |
- |
- |
isDeleteProtected |
Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow. |
boolean |
No |
- |
- |
Spec.encryptData
Back to DbSystem spec
DbSystemEncryptData defines nested fields for DbSystem.EncryptData.
| Field |
Description |
Type |
Required |
Default |
Enum |
keyGenerationType |
Select whether to use Oracle-managed key (SYSTEM) or your own key (BYOK). |
string |
Yes |
- |
- |
keyId |
The OCID of the key to use. |
string |
No |
- |
- |
Spec.maintenance
Back to DbSystem spec
DbSystemMaintenance defines nested fields for DbSystem.Maintenance.
| Field |
Description |
Type |
Required |
Default |
Enum |
maintenanceDisabledWindows |
Time window during which downtime-inducing maintenance shall not be performed. Downtime-free maintenance may be performed to apply required security patches. At most one configured window is supported. |
list[object] |
No |
- |
- |
maintenanceScheduleType |
The maintenance schedule type of the DB system. Defaults to REGULAR. EARLY: Maintenance schedule follows a cycle where upgrades are performed when versions become deprecated. REGULAR: Maintenance schedule follows the normal cycle where upgrades are performed when versions become unavailable. |
string |
No |
- |
- |
versionPreference |
The preferred version to target when performing an automatic MySQL upgrade. Defaults to OLDEST. OLDEST: Choose the oldest available MySQL version based on the current version of the DB System. SECOND_NEWEST: Choose the MySQL version before the newest for auto-upgrade. NEWEST: Choose the latest and greatest MySQL version available for auto-upgrade. |
string |
No |
- |
- |
versionTrackPreference |
The preferred version track to target when performing an automatic MySQL upgrade. Defaults to FOLLOW. LONG_TERM_SUPPORT: No MySQL database behavior changes. INNOVATION: Provides access to the latest features and all bug fixes. FOLLOW: Follows the track of the current MySQL version. |
string |
No |
- |
- |
windowStartTime |
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. |
string |
Yes |
- |
- |
Spec.maintenance.maintenanceDisabledWindows[]
Back to DbSystem spec
DbSystemMaintenanceMaintenanceDisabledWindow defines nested fields for DbSystem.Maintenance.MaintenanceDisabledWindow.
| Field |
Description |
Type |
Required |
Default |
Enum |
timeEnd |
The time until when maintenance is disabled. Must be set together with timeStart and must be after timeStart. as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339). |
string |
Yes |
- |
- |
timeStart |
The time from when maintenance is disabled. Must be set together with timeEnd and must be before timeEnd. as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339). |
string |
Yes |
- |
- |
Spec.readEndpoint
Back to DbSystem spec
DbSystemReadEndpoint defines nested fields for DbSystem.ReadEndpoint.
| Field |
Description |
Type |
Required |
Default |
Enum |
excludeIps |
A list of IP addresses of read replicas that are excluded from serving read requests. |
list[string] |
No |
- |
- |
isEnabled |
Specifies if the DB System read endpoint is enabled or not. |
boolean |
No |
- |
- |
readEndpointHostnameLabel |
The hostname for the read 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. |
string |
No |
- |
- |
readEndpointIpAddress |
The IP address the DB System read endpoint is configured to listen on. A private IP address of your choice to assign to the read 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. |
string |
No |
- |
- |
Spec.rest
Back to DbSystem spec
DbSystemRest defines nested fields for DbSystem.Rest.
| Field |
Description |
Type |
Required |
Default |
Enum |
configuration |
Select how REST is configured across the DB System instances. |
string |
Yes |
- |
- |
port |
The port for REST to listen on. Supported port numbers are 443 and from 1024 to 65535. |
integer |
No |
- |
- |
Spec.secureConnections
Back to DbSystem spec
DbSystemSecureConnections defines nested fields for DbSystem.SecureConnections.
| Field |
Description |
Type |
Required |
Default |
Enum |
certificateGenerationType |
Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC). |
string |
Yes |
- |
- |
certificateId |
The OCID of the certificate to use. |
string |
No |
- |
- |
Spec.source
Back to DbSystem spec
DbSystemSource defines nested fields for DbSystem.Source.
| Field |
Description |
Type |
Required |
Default |
Enum |
backupId |
The OCID of the backup to be used as the source for the new DB System. |
string |
No |
- |
- |
dbSystemId |
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. |
string |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
recoveryPoint |
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. |
string |
No |
- |
- |
sourceType |
- |
string |
No |
- |
- |
sourceUrl |
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 (https://docs.oracle.com/en-us/iaas/Content/Object/Tasks/usingpreauthenticatedrequests.htm) 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. |
string |
No |
- |
- |
Spec.telemetryConfiguration
Back to DbSystem spec
DbSystemTelemetryConfiguration defines nested fields for DbSystem.TelemetryConfiguration.
| Field |
Description |
Type |
Required |
Default |
Enum |
logs |
Telemetry configuration details for logging. |
list[object] |
No |
- |
- |
Spec.telemetryConfiguration.logs[]
Back to DbSystem spec
DbSystemTelemetryConfigurationLog defines nested fields for DbSystem.TelemetryConfiguration.Log.
| Field |
Description |
Type |
Required |
Default |
Enum |
destination |
Type of destination where MySQL telemetry is exposed to. |
string |
Yes |
- |
- |
destinationConfigurations |
List of configuration variables for a given destination type. |
list[object] |
Yes |
- |
- |
logTypes |
List of MySQL telemetry types that can be exposed on a telemetry destination |
list[string] |
Yes |
- |
- |
Spec.telemetryConfiguration.logs[].destinationConfigurations[]
Back to DbSystem spec
DbSystemTelemetryConfigurationLogDestinationConfiguration defines nested fields for DbSystem.TelemetryConfiguration.Log.DestinationConfiguration.
| Field |
Description |
Type |
Required |
Default |
Enum |
key |
Name of the destination configuration variable. |
string |
Yes |
- |
- |
value |
Value of the destination configuration variable. |
string |
Yes |
- |
- |
Status
DbSystemStatus defines the observed state of DbSystem.
| Field |
Description |
Type |
Required |
Default |
Enum |
accessMode |
The access mode indicating if the database access is unrestricted (to all MySQL user accounts), or restricted (to only certain users with specific privileges): - UNRESTRICTED: the access to the database is not restricted; - RESTRICTED: access allowed only to users with specific privileges; RESTRICTED will correspond to setting the MySQL system variable offline_mode (https://dev.mysql.com/doc/en/server-system-variables.html#sysvar_offline_mode) to ON. |
string |
No |
- |
- |
adminPassword |
The last applied secret reference for the administrative password. |
object |
No |
- |
- |
adminUsername |
The last applied secret reference for the administrative username. |
object |
No |
- |
- |
availabilityDomain |
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. |
string |
No |
- |
- |
backupPolicy |
DbSystemBackupPolicyObservedState defines nested fields for DbSystem.BackupPolicy. |
object |
No |
- |
- |
channels |
A list with a summary of all the Channels attached to the DB System. |
list[object] |
No |
- |
- |
compartmentId |
The OCID of the compartment the DB System belongs in. |
string |
No |
- |
- |
configurationId |
The OCID of the Configuration to be used for Instances in this DB System. |
string |
No |
- |
- |
controlledUpdate |
DbSystemControlledUpdate defines nested fields for DbSystem.ControlledUpdate. |
object |
No |
- |
- |
crashRecovery |
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. |
string |
No |
- |
- |
currentPlacement |
DbSystemCurrentPlacement defines nested fields for DbSystem.CurrentPlacement. |
object |
No |
- |
- |
customerContacts |
The list of customer email addresses that receive information from Oracle about the specified OCI DB System 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 DB System. |
list[object] |
No |
- |
- |
dataStorage |
DbSystemDataStorageObservedState defines nested fields for DbSystem.DataStorage. |
object |
No |
- |
- |
dataStorageSizeInGBs |
DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs. |
integer |
No |
- |
- |
databaseConsole |
DbSystemDatabaseConsole defines nested fields for DbSystem.DatabaseConsole. |
object |
No |
- |
- |
databaseManagement |
Whether to enable monitoring via the Database Management service. |
string |
No |
- |
- |
databaseMode |
The database mode indicating the types of statements that are allowed to run in the the DB system. This mode applies only to statements run by user connections. Replicated write statements continue to be allowed regardless of the DatabaseMode. - READ_WRITE: allow running read and write statements on the DB system; - READ_ONLY: only allow running read statements on the DB system. |
string |
No |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No |
- |
- |
deletionPolicy |
DbSystemDeletionPolicy defines nested fields for DbSystem.DeletionPolicy. |
object |
No |
- |
- |
description |
User-provided data about the DB System. |
string |
No |
- |
- |
displayName |
The user-friendly name for the DB System. It does not have to be unique. |
string |
No |
- |
- |
encryptData |
DbSystemEncryptData defines nested fields for DbSystem.EncryptData. |
object |
No |
- |
- |
endpoints |
The network endpoints available for this DB System. |
list[object] |
No |
- |
- |
faultDomain |
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. |
string |
No |
- |
- |
freeformTags |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} |
map[string, string] |
No |
- |
- |
heatWaveCluster |
DbSystemHeatWaveCluster defines nested fields for DbSystem.HeatWaveCluster. |
object |
No |
- |
- |
hostnameLabel |
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. |
string |
No |
- |
- |
id |
The OCID of the DB System. |
string |
No |
- |
- |
ipAddress |
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. |
string |
No |
- |
- |
isHeatWaveClusterAttached |
If the DB System has a HeatWave Cluster attached. |
boolean |
No |
- |
- |
isHighlyAvailable |
Specifies if the DB System is highly available. |
boolean |
No |
- |
- |
lifecycleDetails |
Additional information about the current lifecycleState. |
string |
No |
- |
- |
lifecycleState |
The current state of the DB System. |
string |
No |
- |
- |
maintenance |
DbSystemMaintenanceObservedState defines nested fields for DbSystem.Maintenance. |
object |
No |
- |
- |
mysqlVersion |
Name of the MySQL Version in use for the DB System. |
string |
No |
- |
- |
nsgIds |
Network Security Group OCIDs used for the VNIC attachment. |
list[string] |
No |
- |
- |
pointInTimeRecoveryDetails |
DbSystemPointInTimeRecoveryDetails defines nested fields for DbSystem.PointInTimeRecoveryDetails. |
object |
No |
- |
- |
port |
The port for primary endpoint of the DB System to listen on. |
integer |
No |
- |
- |
portX |
The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port. |
integer |
No |
- |
- |
readEndpoint |
DbSystemReadEndpoint defines nested fields for DbSystem.ReadEndpoint. |
object |
No |
- |
- |
rest |
DbSystemRest defines nested fields for DbSystem.Rest. |
object |
No |
- |
- |
secureConnections |
DbSystemSecureConnections defines nested fields for DbSystem.SecureConnections. |
object |
No |
- |
- |
securityAttributes |
Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see ZPR Artifacts (https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm). Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}} |
map[string, map[string, string]] |
No |
- |
- |
shapeName |
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 ListShapes operation. |
string |
No |
- |
- |
source |
DbSystemSourceObservedState defines nested fields for DbSystem.Source. |
object |
No |
- |
- |
status |
- |
object |
Yes |
- |
- |
subnetId |
The OCID of the subnet the DB System is associated with. |
string |
No |
- |
- |
systemTags |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No |
- |
- |
telemetryConfiguration |
DbSystemTelemetryConfiguration defines nested fields for DbSystem.TelemetryConfiguration. |
object |
No |
- |
- |
timeCreated |
The date and time the DB System was created. |
string |
No |
- |
- |
timeUpdated |
The time the DB System was last updated. |
string |
No |
- |
- |
Status.adminPassword
Back to DbSystem status
The last applied secret reference for the administrative password.
| Field |
Description |
Type |
Required |
Default |
Enum |
secret |
- |
object |
No |
- |
- |
Status.adminPassword.secret
Back to DbSystem status
| Field |
Description |
Type |
Required |
Default |
Enum |
secretName |
- |
string |
No |
- |
- |
Status.adminUsername
Back to DbSystem status
The last applied secret reference for the administrative username.
| Field |
Description |
Type |
Required |
Default |
Enum |
secret |
- |
object |
No |
- |
- |
Status.adminUsername.secret
Back to DbSystem status
| Field |
Description |
Type |
Required |
Default |
Enum |
secretName |
- |
string |
No |
- |
- |
Status.backupPolicy
Back to DbSystem status
DbSystemBackupPolicyObservedState defines nested fields for DbSystem.BackupPolicy.
| Field |
Description |
Type |
Required |
Default |
Enum |
copyPolicies |
List of policies of a DB system to schedule cross-region DB system backup copy. The policy includes the name of the destination region to which the DB system backup will be copied, and an optional parameter which specifies the retention period of the copied DB system backup in days. Note: Currently, only one policy can be specified in the list. |
list[object] |
No |
- |
- |
definedTags |
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"}} |
map[string, map[string, string]] |
No |
- |
- |
freeformTags |
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"} |
map[string, string] |
No |
- |
- |
isEnabled |
If automated backups are enabled or disabled. |
boolean |
No |
- |
- |
pitrPolicy |
DbSystemBackupPolicyPitrPolicy defines nested fields for DbSystem.BackupPolicy.PitrPolicy. |
object |
No |
- |
- |
retentionInDays |
The number of days automated backups are retained. |
integer |
No |
- |
- |
softDelete |
Retains the backup to be deleted due to the retention policy in DELETE SCHEDULED state for 7 days before permanently deleting it. |
string |
No |
- |
- |
windowStartTime |
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 |
string |
No |
- |
- |
Status.backupPolicy.copyPolicies[]
Back to DbSystem status
DbSystemBackupPolicyCopyPolicy defines nested fields for DbSystem.BackupPolicy.CopyPolicy.
| Field |
Description |
Type |
Required |
Default |
Enum |
backupCopyRetentionInDays |
Number of days to retain the copied DB system backup. |
integer |
No |
- |
- |
copyToRegion |
The destination region name to which the DB system backup will be copied. |
string |
Yes |
- |
- |
Status.backupPolicy.pitrPolicy
Back to DbSystem status
DbSystemBackupPolicyPitrPolicy defines nested fields for DbSystem.BackupPolicy.PitrPolicy.
| Field |
Description |
Type |
Required |
Default |
Enum |
isEnabled |
Specifies if PITR is enabled or disabled. |
boolean |
Yes |
- |
- |
Status.channels[]
Back to DbSystem status
DbSystemChannel defines nested fields for DbSystem.Channel.
| Field |
Description |
Type |
Required |
Default |
Enum |
compartmentId |
The OCID of the compartment. |
string |
No |
- |
- |
definedTags |
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No |
- |
- |
displayName |
The user-friendly name for the Channel. It does not have to be unique. |
string |
No |
- |
- |
freeformTags |
Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} |
map[string, string] |
No |
- |
- |
id |
The OCID of the Channel. |
string |
No |
- |
- |
isEnabled |
Whether the Channel has been enabled by the user. |
boolean |
No |
- |
- |
lifecycleDetails |
A message describing the state of the Channel. |
string |
No |
- |
- |
lifecycleState |
The state of the Channel. |
string |
No |
- |
- |
source |
DbSystemChannelSource defines nested fields for DbSystem.Channel.Source. |
object |
No |
- |
- |
systemTags |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No |
- |
- |
target |
DbSystemChannelTarget defines nested fields for DbSystem.Channel.Target. |
object |
No |
- |
- |
timeCreated |
The date and time the Channel was created, as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339). |
string |
No |
- |
- |
timeUpdated |
The time the Channel was last updated, as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339). |
string |
No |
- |
- |
Status.channels[].source
Back to DbSystem status
DbSystemChannelSource defines nested fields for DbSystem.Channel.Source.
| Field |
Description |
Type |
Required |
Default |
Enum |
anonymousTransactionsHandling |
DbSystemChannelSourceAnonymousTransactionsHandling defines nested fields for DbSystem.Channel.Source.AnonymousTransactionsHandling. |
object |
No |
- |
- |
hostname |
The network address of the MySQL instance. |
string |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
port |
The port the source MySQL instance listens on. |
integer |
No |
- |
- |
sourceType |
- |
string |
No |
- |
- |
sslCaCertificate |
DbSystemChannelSourceSslCaCertificate defines nested fields for DbSystem.Channel.Source.SslCaCertificate. |
object |
No |
- |
- |
sslMode |
The SSL mode of the Channel. |
string |
No |
- |
- |
username |
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 (https://dev.mysql.com/doc/refman/8.0/en/change-master-to.html) |
string |
No |
- |
- |
Status.channels[].source.anonymousTransactionsHandling
Back to DbSystem status
DbSystemChannelSourceAnonymousTransactionsHandling defines nested fields for DbSystem.Channel.Source.AnonymousTransactionsHandling.
| Field |
Description |
Type |
Required |
Default |
Enum |
jsonData |
- |
string |
No |
- |
- |
lastConfiguredLogFilename |
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. |
string |
No |
- |
- |
lastConfiguredLogOffset |
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. |
integer (int64) |
No |
- |
- |
policy |
- |
string |
No |
- |
- |
uuid |
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. |
string |
No |
- |
- |
Status.channels[].source.sslCaCertificate
Back to DbSystem status
DbSystemChannelSourceSslCaCertificate defines nested fields for DbSystem.Channel.Source.SslCaCertificate.
| Field |
Description |
Type |
Required |
Default |
Enum |
certificateType |
- |
string |
No |
- |
- |
contents |
The string containing the CA certificate in PEM format. |
string |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
Status.channels[].target
Back to DbSystem status
DbSystemChannelTarget defines nested fields for DbSystem.Channel.Target.
| Field |
Description |
Type |
Required |
Default |
Enum |
applierUsername |
The username for the replication applier of the target MySQL DB System. |
string |
No |
- |
- |
channelName |
The case-insensitive name that identifies the replication channel. Channel names must follow the rules defined for MySQL identifiers (https://dev.mysql.com/doc/refman/8.0/en/identifiers.html). The names of non-Deleted Channels must be unique for each DB System. |
string |
No |
- |
- |
dbSystemId |
The OCID of the source DB System. |
string |
No |
- |
- |
delayInSeconds |
Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source. |
integer |
No |
- |
- |
filters |
Replication filter rules to be applied at the DB System Channel target. |
list[object] |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
tablesWithoutPrimaryKeyHandling |
Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key. |
string |
No |
- |
- |
targetType |
- |
string |
No |
- |
- |
Status.channels[].target.filters[]
Back to DbSystem status
DbSystemChannelTargetFilter defines nested fields for DbSystem.Channel.Target.Filter.
| Field |
Description |
Type |
Required |
Default |
Enum |
type |
The type of the filter rule. For details on each type, see Replication Filtering Rules (https://dev.mysql.com/doc/refman/8.0/en/replication-rules.html) |
string |
No |
- |
- |
value |
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 (https://dev.mysql.com/doc/refman/8.0/en/replication-rules.html). |
string |
No |
- |
- |
Status.controlledUpdate
Back to DbSystem status
DbSystemControlledUpdate defines nested fields for DbSystem.ControlledUpdate.
| Field |
Description |
Type |
Required |
Default |
Enum |
targetDbInstances |
Defines the MySQL instances to be operated during a controlled update. - ALL_BUT_PRIMARY: Update all MySQL instances in a highly available DB System except the primary group member, without triggering a controlled failover. - PRIMARY_ONLY: Update the primary group member in a highly available DB System after a controlled failover (downtime is expected). This operation requires that the other MySQL instances have been previously updated using the ALL_BUT_PRIMARY option. |
string |
No |
- |
- |
targetMysqlVersion |
The MySQL version to be applied to the selected instances. |
string |
No |
- |
- |
Status.currentPlacement
Back to DbSystem status
DbSystemCurrentPlacement defines nested fields for DbSystem.CurrentPlacement.
| Field |
Description |
Type |
Required |
Default |
Enum |
availabilityDomain |
The availability domain in which the DB System is placed. |
string |
No |
- |
- |
faultDomain |
The fault domain in which the DB System is placed. |
string |
No |
- |
- |
Back to DbSystem status
DbSystemCustomerContact defines nested fields for DbSystem.CustomerContact.
| Field |
Description |
Type |
Required |
Default |
Enum |
email |
The email address used by Oracle to send notifications regarding the DB System. |
string |
Yes |
- |
- |
Status.dataStorage
Back to DbSystem status
DbSystemDataStorageObservedState defines nested fields for DbSystem.DataStorage.
| Field |
Description |
Type |
Required |
Default |
Enum |
allocatedStorageSizeInGBs |
The actual allocated storage size for the DB System. This may be higher than dataStorageSizeInGBs if an automatic storage expansion has occurred. |
integer |
No |
- |
- |
dataStorageSizeInGBs |
User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. |
integer |
No |
- |
- |
dataStorageSizeLimitInGBs |
The absolute limit the DB System's storage size may ever expand to, either manually or automatically. This limit is based based on the initial dataStorageSizeInGBs when the DB System was first created. Both dataStorageSizeInGBs and maxDataStorageSizeInGBs can not exceed this value. 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. |
integer |
No |
- |
- |
isAutoExpandStorageEnabled |
Enable/disable automatic storage expansion. When set to true, the DB System will automatically add storage incrementally up to the value specified in maxStorageSizeInGBs. |
boolean |
No |
- |
- |
maxStorageSizeInGBs |
Maximum storage size this DB System can expand to. When isAutoExpandStorageEnabled is set to true, the DB System will add storage incrementally up to this value. 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. You cannot set the maximum data storage size to less than either current DB System dataStorageSizeInGBs or allocatedStorageSizeInGBs. |
integer |
No |
- |
- |
Status.databaseConsole
Back to DbSystem status
DbSystemDatabaseConsole defines nested fields for DbSystem.DatabaseConsole.
| Field |
Description |
Type |
Required |
Default |
Enum |
port |
The port on which the database console can be accessed. Supported port numbers are 443 and from 1024 to 65535. |
integer |
No |
- |
- |
status |
Enable/disable the database console on the DB System. |
string |
Yes |
- |
- |
Status.deletionPolicy
Back to DbSystem status
DbSystemDeletionPolicy defines nested fields for DbSystem.DeletionPolicy.
| Field |
Description |
Type |
Required |
Default |
Enum |
automaticBackupRetention |
Specifies if any automatic backups created for a DB System should be retained or deleted when the DB System is deleted. |
string |
No |
- |
- |
finalBackup |
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. |
string |
No |
- |
- |
isDeleteProtected |
Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow. |
boolean |
No |
- |
- |
Status.encryptData
Back to DbSystem status
DbSystemEncryptData defines nested fields for DbSystem.EncryptData.
| Field |
Description |
Type |
Required |
Default |
Enum |
keyGenerationType |
Select whether to use Oracle-managed key (SYSTEM) or your own key (BYOK). |
string |
Yes |
- |
- |
keyId |
The OCID of the key to use. |
string |
No |
- |
- |
Status.endpoints[]
Back to DbSystem status
DbSystemEndpoint defines nested fields for DbSystem.Endpoint.
| Field |
Description |
Type |
Required |
Default |
Enum |
hostname |
The network address of the DB System. |
string |
No |
- |
- |
ipAddress |
The IP address the DB System is configured to listen on. |
string |
No |
- |
- |
modes |
The access modes from the client that this endpoint supports. |
list[string] |
No |
- |
- |
port |
The port the MySQL instance listens on. |
integer |
No |
- |
- |
portX |
The network port where to connect to use this endpoint using the X protocol. |
integer |
No |
- |
- |
resourceId |
The OCID of the resource that this endpoint is attached to. |
string |
No |
- |
- |
resourceType |
The type of endpoint that clients and connectors can connect to. |
string |
No |
- |
- |
status |
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. |
string |
No |
- |
- |
statusDetails |
Additional information about the current endpoint status. |
string |
No |
- |
- |
Status.heatWaveCluster
Back to DbSystem status
DbSystemHeatWaveCluster defines nested fields for DbSystem.HeatWaveCluster.
| Field |
Description |
Type |
Required |
Default |
Enum |
clusterSize |
The number of analytics-processing compute instances, of the specified shape, in the HeatWave cluster. |
integer |
No |
- |
- |
isLakehouseEnabled |
Lakehouse enabled status for the HeatWave cluster. |
boolean |
No |
- |
- |
lifecycleState |
The current state of the MySQL HeatWave cluster. |
string |
No |
- |
- |
shapeName |
The shape determines resources to allocate to the HeatWave nodes - CPU cores, memory. |
string |
No |
- |
- |
timeCreated |
The date and time the HeatWave cluster was created, as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339). |
string |
No |
- |
- |
timeUpdated |
The time the HeatWave cluster was last updated, as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339). |
string |
No |
- |
- |
Status.maintenance
Back to DbSystem status
DbSystemMaintenanceObservedState defines nested fields for DbSystem.Maintenance.
| Field |
Description |
Type |
Required |
Default |
Enum |
maintenanceDisabledWindows |
Time window during which downtime-inducing maintenance shall not be performed. Downtime-free maintenance may be performed to apply required security patches. At most one configured window is supported. |
list[object] |
No |
- |
- |
maintenanceScheduleType |
The maintenance schedule type of the DB system. EARLY: Maintenance schedule follows a cycle where upgrades are performed when versions become deprecated. REGULAR: Maintenance schedule follows the normal cycle where upgrades are performed when versions become unavailable. |
string |
No |
- |
- |
targetVersion |
The version that is expected to be targeted during the next scheduled maintenance run. |
string |
No |
- |
- |
timeScheduled |
The time the scheduled maintenance is expected to start, as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339). |
string |
No |
- |
- |
versionPreference |
The preferred version to target when performing an automatic MySQL upgrade. OLDEST: Choose the oldest available MySQL version based on the current version of the DB System. SECOND_NEWEST: Choose the MySQL version before the newest for auto-upgrade. NEWEST: Choose the latest and greatest MySQL version available for auto-upgrade. |
string |
No |
- |
- |
versionTrackPreference |
The preferred version track to target when performing an automatic MySQL upgrade. LONG_TERM_SUPPORT: No MySQL database behavior changes. INNOVATION: Provides access to the latest features and all bug fixes. FOLLOW: Follows the track of the current MySQL version. |
string |
No |
- |
- |
windowStartTime |
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. |
string |
No |
- |
- |
Status.maintenance.maintenanceDisabledWindows[]
Back to DbSystem status
DbSystemMaintenanceMaintenanceDisabledWindow defines nested fields for DbSystem.Maintenance.MaintenanceDisabledWindow.
| Field |
Description |
Type |
Required |
Default |
Enum |
timeEnd |
The time until when maintenance is disabled. Must be set together with timeStart and must be after timeStart. as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339). |
string |
Yes |
- |
- |
timeStart |
The time from when maintenance is disabled. Must be set together with timeEnd and must be before timeEnd. as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339). |
string |
Yes |
- |
- |
Status.pointInTimeRecoveryDetails
Back to DbSystem status
DbSystemPointInTimeRecoveryDetails defines nested fields for DbSystem.PointInTimeRecoveryDetails.
| Field |
Description |
Type |
Required |
Default |
Enum |
timeEarliestRecoveryPoint |
Earliest recovery time point for the DB System, as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339). |
string |
No |
- |
- |
timeLatestRecoveryPoint |
Latest recovery time point for the DB System, as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339). |
string |
No |
- |
- |
Status.readEndpoint
Back to DbSystem status
DbSystemReadEndpoint defines nested fields for DbSystem.ReadEndpoint.
| Field |
Description |
Type |
Required |
Default |
Enum |
excludeIps |
A list of IP addresses of read replicas that are excluded from serving read requests. |
list[string] |
No |
- |
- |
isEnabled |
Specifies if the DB System read endpoint is enabled or not. |
boolean |
No |
- |
- |
readEndpointHostnameLabel |
The hostname for the read 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. |
string |
No |
- |
- |
readEndpointIpAddress |
The IP address the DB System read endpoint is configured to listen on. A private IP address of your choice to assign to the read 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. |
string |
No |
- |
- |
Status.rest
Back to DbSystem status
DbSystemRest defines nested fields for DbSystem.Rest.
| Field |
Description |
Type |
Required |
Default |
Enum |
configuration |
Select how REST is configured across the DB System instances. |
string |
Yes |
- |
- |
port |
The port for REST to listen on. Supported port numbers are 443 and from 1024 to 65535. |
integer |
No |
- |
- |
Status.secureConnections
Back to DbSystem status
DbSystemSecureConnections defines nested fields for DbSystem.SecureConnections.
| Field |
Description |
Type |
Required |
Default |
Enum |
certificateGenerationType |
Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC). |
string |
Yes |
- |
- |
certificateId |
The OCID of the certificate to use. |
string |
No |
- |
- |
Status.source
Back to DbSystem status
DbSystemSourceObservedState defines nested fields for DbSystem.Source.
| Field |
Description |
Type |
Required |
Default |
Enum |
backupId |
The OCID of the backup to be used as the source for the new DB System. |
string |
No |
- |
- |
dbSystemId |
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. |
string |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
recoveryPoint |
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. |
string |
No |
- |
- |
sourceType |
- |
string |
No |
- |
- |
Status.status
Back to DbSystem status
| Field |
Description |
Type |
Required |
Default |
Enum |
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. |
object |
No |
- |
- |
conditions |
- |
list[object] |
No |
- |
- |
createdAt |
- |
string (date-time) |
No |
- |
- |
deletedAt |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
ocid |
- |
string |
No |
- |
- |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
requestedAt |
- |
string (date-time) |
No |
- |
- |
updatedAt |
- |
string (date-time) |
No |
- |
- |
Status.status.async
Back to DbSystem status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field |
Description |
Type |
Required |
Default |
Enum |
current |
- |
object |
No |
- |
- |
Status.status.async.current
Back to DbSystem status
| Field |
Description |
Type |
Required |
Default |
Enum |
message |
- |
string |
No |
- |
- |
normalizedClass |
- |
string |
Yes |
- |
attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- |
number |
No |
- |
- |
phase |
- |
string |
Yes |
- |
create, delete, update |
rawOperationType |
- |
string |
No |
- |
- |
rawStatus |
- |
string |
No |
- |
- |
source |
- |
string |
Yes |
- |
lifecycle, none, workrequest |
updatedAt |
- |
string (date-time) |
Yes |
- |
- |
workRequestId |
- |
string |
No |
- |
- |
Status.status.conditions[]
Back to DbSystem status
| Field |
Description |
Type |
Required |
Default |
Enum |
lastTransitionTime |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
status |
- |
string |
Yes |
- |
- |
type |
- |
string |
Yes |
- |
- |
Status.telemetryConfiguration
Back to DbSystem status
DbSystemTelemetryConfiguration defines nested fields for DbSystem.TelemetryConfiguration.
| Field |
Description |
Type |
Required |
Default |
Enum |
logs |
Telemetry configuration details for logging. |
list[object] |
No |
- |
- |
Status.telemetryConfiguration.logs[]
Back to DbSystem status
DbSystemTelemetryConfigurationLog defines nested fields for DbSystem.TelemetryConfiguration.Log.
| Field |
Description |
Type |
Required |
Default |
Enum |
destination |
Type of destination where MySQL telemetry is exposed to. |
string |
Yes |
- |
- |
destinationConfigurations |
List of configuration variables for a given destination type. |
list[object] |
Yes |
- |
- |
logTypes |
List of MySQL telemetry types that can be exposed on a telemetry destination |
list[string] |
Yes |
- |
- |
Status.telemetryConfiguration.logs[].destinationConfigurations[]
Back to DbSystem status
DbSystemTelemetryConfigurationLogDestinationConfiguration defines nested fields for DbSystem.TelemetryConfiguration.Log.DestinationConfiguration.
| Field |
Description |
Type |
Required |
Default |
Enum |
key |
Name of the destination configuration variable. |
string |
Yes |
- |
- |
value |
Value of the destination configuration variable. |
string |
Yes |
- |
- |