Show / Hide Table of Contents

Class UpdateDbSystemDetails

Details required to update a DB System.

Inheritance
object
UpdateDbSystemDetails
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.MysqlService.Models
Assembly: OCI.DotNetSDK.Mysql.dll
Syntax
public class UpdateDbSystemDetails

Properties

AccessMode

Declaration
[JsonProperty(PropertyName = "accessMode")]
[JsonConverter(typeof(StringEnumConverter))]
public DbSystem.AccessModeEnum? AccessMode { get; set; }
Property Value
Type Description
DbSystem.AccessModeEnum?

The access mode indicating if the database access will be restricted only to administrators or not:

  • UNRESTRICTED: 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 to ON.

AdminPassword

Declaration
[JsonProperty(PropertyName = "adminPassword")]
public string AdminPassword { get; set; }
Property Value
Type Description
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.

AdminUsername

Declaration
[JsonProperty(PropertyName = "adminUsername")]
public string AdminUsername { get; set; }
Property Value
Type Description
string

The username for the administrative user for the MySQL Instance.

AvailabilityDomain

Declaration
[JsonProperty(PropertyName = "availabilityDomain")]
public string AvailabilityDomain { get; set; }
Property Value
Type Description
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.

BackupPolicy

Declaration
[JsonProperty(PropertyName = "backupPolicy")]
public UpdateBackupPolicyDetails BackupPolicy { get; set; }
Property Value
Type Description
UpdateBackupPolicyDetails

ConfigurationId

Declaration
[JsonProperty(PropertyName = "configurationId")]
public string ConfigurationId { get; set; }
Property Value
Type Description
string

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

CrashRecovery

Declaration
[JsonProperty(PropertyName = "crashRecovery")]
[JsonConverter(typeof(StringEnumConverter))]
public CrashRecoveryStatus? CrashRecovery { get; set; }
Property Value
Type Description
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.

CustomerContacts

Declaration
[JsonProperty(PropertyName = "customerContacts")]
public List<CustomerContact> CustomerContacts { get; set; }
Property Value
Type Description
List<CustomerContact>

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.

DataStorage

Declaration
[JsonProperty(PropertyName = "dataStorage")]
public DataStorageDetails DataStorage { get; set; }
Property Value
Type Description
DataStorageDetails

DataStorageSizeInGBs

Declaration
[JsonProperty(PropertyName = "dataStorageSizeInGBs")]
public int? DataStorageSizeInGBs { get; set; }
Property Value
Type Description
int?

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.

DatabaseManagement

Declaration
[JsonProperty(PropertyName = "databaseManagement")]
[JsonConverter(typeof(StringEnumConverter))]
public DatabaseManagementStatus? DatabaseManagement { get; set; }
Property Value
Type Description
DatabaseManagementStatus?

Whether to enable monitoring via the Database Management service.

DatabaseMode

Declaration
[JsonProperty(PropertyName = "databaseMode")]
[JsonConverter(typeof(StringEnumConverter))]
public DbSystem.DatabaseModeEnum? DatabaseMode { get; set; }
Property Value
Type Description
DbSystem.DatabaseModeEnum?

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: allow running read and write statements on the DB system;
  • READ_ONLY: only allow running read statements on the DB system.

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

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

DeletionPolicy

Declaration
[JsonProperty(PropertyName = "deletionPolicy")]
public UpdateDeletionPolicyDetails DeletionPolicy { get; set; }
Property Value
Type Description
UpdateDeletionPolicyDetails

Description

Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

User-provided data about the DB System.

DisplayName

Declaration
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

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

EncryptData

Declaration
[JsonProperty(PropertyName = "encryptData")]
public EncryptDataDetails EncryptData { get; set; }
Property Value
Type Description
EncryptDataDetails

FaultDomain

Declaration
[JsonProperty(PropertyName = "faultDomain")]
public string FaultDomain { get; set; }
Property Value
Type Description
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.

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

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

HostnameLabel

Declaration
[JsonProperty(PropertyName = "hostnameLabel")]
public string HostnameLabel { get; set; }
Property Value
Type Description
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.

IpAddress

Declaration
[JsonProperty(PropertyName = "ipAddress")]
public string IpAddress { get; set; }
Property Value
Type Description
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.

IsHighlyAvailable

Declaration
[JsonProperty(PropertyName = "isHighlyAvailable")]
public bool? IsHighlyAvailable { get; set; }
Property Value
Type Description
bool?

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.

Maintenance

Declaration
[JsonProperty(PropertyName = "maintenance")]
public UpdateMaintenanceDetails Maintenance { get; set; }
Property Value
Type Description
UpdateMaintenanceDetails

MysqlVersion

Declaration
[JsonProperty(PropertyName = "mysqlVersion")]
public string MysqlVersion { get; set; }
Property Value
Type Description
string

The specific MySQL version identifier.

NsgIds

Declaration
[JsonProperty(PropertyName = "nsgIds")]
public List<string> NsgIds { get; set; }
Property Value
Type Description
List<string>

Network Security Group OCIDs used for the VNIC attachment.

Port

Declaration
[JsonProperty(PropertyName = "port")]
public int? Port { get; set; }
Property Value
Type Description
int?

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

PortX

Declaration
[JsonProperty(PropertyName = "portX")]
public int? PortX { get; set; }
Property Value
Type Description
int?

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

ReadEndpoint

Declaration
[JsonProperty(PropertyName = "readEndpoint")]
public UpdateReadEndpointDetails ReadEndpoint { get; set; }
Property Value
Type Description
UpdateReadEndpointDetails

Rest

Declaration
[JsonProperty(PropertyName = "rest")]
public UpdateRestDetails Rest { get; set; }
Property Value
Type Description
UpdateRestDetails

SecureConnections

Declaration
[JsonProperty(PropertyName = "secureConnections")]
public SecureConnectionDetails SecureConnections { get; set; }
Property Value
Type Description
SecureConnectionDetails

ShapeName

Declaration
[JsonProperty(PropertyName = "shapeName")]
public string ShapeName { get; set; }
Property Value
Type Description
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.

SubnetId

Declaration
[JsonProperty(PropertyName = "subnetId")]
public string SubnetId { get; set; }
Property Value
Type Description
string

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

In this article
Back to top