Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace UpdateDbSystemDetails

Details required to update a DB System.

Properties

Optional adminPassword

adminPassword: undefined | string

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.

Optional adminUsername

adminUsername: undefined | string

The username for the administrative user for the MySQL Instance.

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.UpdateBackupPolicyDetails

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 dataStorageSizeInGBs

dataStorageSizeInGBs: undefined | number

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. 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

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

Optional deletionPolicy

deletionPolicy: model.UpdateDeletionPolicyDetails

Optional description

description: undefined | string

User-provided data about the DB System.

Optional displayName

displayName: undefined | string

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

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 applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

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.

Optional ipAddress

ipAddress: undefined | string

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.

Optional isHighlyAvailable

isHighlyAvailable: undefined | false | true

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.

Optional maintenance

maintenance: model.UpdateMaintenanceDetails

Optional mysqlVersion

mysqlVersion: undefined | string

The specific MySQL version identifier.

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 TCP network port on which X Plugin listens for 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 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 {@link #listShapes(ListShapesRequest) listShapes} operation.

Changes in Shape will result in a downtime as the MySQL DB System is migrated to the new Compute instance.

Optional subnetId

subnetId: undefined | string

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

Functions

getDeserializedJsonObj

getJsonObj