Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace DbSystem

A DB System is the core logical unit of MySQL Database Service.

Properties

Optional availabilityDomain

availabilityDomain: undefined | string

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.

Optional backupPolicy

backupPolicy: model.BackupPolicy

Optional channels

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

compartmentId

compartmentId: string

The OCID of the compartment the DB System belongs in.

Optional configurationId

configurationId: undefined | string

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

Optional crashRecovery

crashRecovery: model.CrashRecoveryStatus

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.

Optional currentPlacement

currentPlacement: model.DbSystemPlacement

dataStorageSizeInGBs

dataStorageSizeInGBs: number

Initial size of the data volume in GiBs that will be created and attached. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional databaseManagement

databaseManagement: model.DatabaseManagementStatus

Whether to enable monitoring via the Database Management service.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

deletionPolicy

deletionPolicy: DeletionPolicyDetails

Optional description

description: undefined | string

User-provided data about the DB System.

displayName

displayName: string

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

Optional endpoints

The network endpoints available for this DB System.

Optional faultDomain

faultDomain: undefined | string

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.

Optional freeformTags

freeformTags: undefined | object

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

Optional heatWaveCluster

heatWaveCluster: model.HeatWaveClusterSummary

Optional hostnameLabel

hostnameLabel: undefined | string

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.

id

id: string

The OCID of the DB System.

Optional ipAddress

ipAddress: undefined | string

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.

Optional isHeatWaveClusterAttached

isHeatWaveClusterAttached: undefined | false | true

If the DB System has a HeatWave Cluster attached.

Optional isHighlyAvailable

isHighlyAvailable: undefined | false | true

Specifies if the DB System is highly available.

Optional lifecycleDetails

lifecycleDetails: undefined | string

Additional information about the current lifecycleState.

lifecycleState

lifecycleState: LifecycleState

The current state of the DB System.

maintenance

maintenance: MaintenanceDetails

mysqlVersion

mysqlVersion: string

Name of the MySQL Version in use for the DB System.

Optional pointInTimeRecoveryDetails

pointInTimeRecoveryDetails: model.PointInTimeRecoveryDetails

Optional port

port: undefined | number

The port for primary endpoint of the DB System to listen on. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional portX

portX: undefined | number

The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional secureConnections

secureConnections: model.SecureConnectionDetails

Optional shapeName

shapeName: undefined | string

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 {@link #listShapes(ListShapesRequest) listShapes} operation.

Optional source

subnetId

subnetId: string

The OCID of the subnet the DB System is associated with.

timeCreated

timeCreated: Date

The date and time the DB System was created.

timeUpdated

timeUpdated: Date

The time the DB System was last updated.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: DbSystem): object

getJsonObj