Class DbSystem

[Required(ErrorMessage = "AccessMode is required.")]
[JsonProperty(PropertyName = "accessMode")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DbSystem.AccessModeEnum? AccessMode { get; set; }

Property Value

Type	Description
DbSystem.AccessModeEnum?	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 to ON.

Type

Description

DbSystem.AccessModeEnum?

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

Remarks

Required

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.

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 BackupPolicy BackupPolicy { get; set; }

Property Value

Type	Description
BackupPolicy

Channels

Declaration

[JsonProperty(PropertyName = "channels")]
public List<ChannelSummary> Channels { get; set; }

Property Value

Type	Description
List<ChannelSummary>	A list with a summary of all the Channels attached to the DB System.

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment the DB System belongs in.

Remarks

Required

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.

ControlledUpdate

Declaration

[JsonProperty(PropertyName = "controlledUpdate")]
public ControlledUpdate ControlledUpdate { get; set; }

Property Value

Type	Description
ControlledUpdate

CrashRecovery

Declaration

[JsonProperty(PropertyName = "crashRecovery")]
[JsonConverter(typeof(ResponseEnumConverter))]
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.

CurrentPlacement

Declaration

[JsonProperty(PropertyName = "currentPlacement")]
public DbSystemPlacement CurrentPlacement { get; set; }

Property Value

Type	Description
DbSystemPlacement

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

[Required(ErrorMessage = "DataStorage is required.")]
[JsonProperty(PropertyName = "dataStorage")]
public DataStorage DataStorage { get; set; }

Property Value

Type	Description
DataStorage

Remarks

Required

DataStorageSizeInGBs

Declaration

[Required(ErrorMessage = "DataStorageSizeInGBs is required.")]
[JsonProperty(PropertyName = "dataStorageSizeInGBs")]
public int? DataStorageSizeInGBs { get; set; }

Property Value

Type	Description
int?	DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.

Remarks

Required

DatabaseConsole

Declaration

[JsonProperty(PropertyName = "databaseConsole")]
public DatabaseConsoleDetails DatabaseConsole { get; set; }

Property Value

Type	Description
DatabaseConsoleDetails

DatabaseManagement

Declaration

[JsonProperty(PropertyName = "databaseManagement")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DatabaseManagementStatus? DatabaseManagement { get; set; }

Property Value

Type	Description
DatabaseManagementStatus?	Whether to enable monitoring via the Database Management service.

DatabaseMode

Declaration

[Required(ErrorMessage = "DatabaseMode is required.")]
[JsonProperty(PropertyName = "databaseMode")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DbSystem.DatabaseModeEnum? DatabaseMode { get; set; }

Property Value

Type	Description
DbSystem.DatabaseModeEnum?	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.

Type

Description

DbSystem.DatabaseModeEnum?

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.

Remarks

Required

DefinedTags

Declaration

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

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

DeletionPolicy

Declaration

[Required(ErrorMessage = "DeletionPolicy is required.")]
[JsonProperty(PropertyName = "deletionPolicy")]
public DeletionPolicyDetails DeletionPolicy { get; set; }

Property Value

Type	Description
DeletionPolicyDetails

Remarks

Required

Description

Declaration

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

Property Value

Type	Description
string	User-provided data about the DB System.

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[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.

Remarks

Required

EncryptData

Declaration

[JsonProperty(PropertyName = "encryptData")]
public EncryptDataDetails EncryptData { get; set; }

Property Value

Type	Description
EncryptDataDetails

Endpoints

Declaration

[JsonProperty(PropertyName = "endpoints")]
public List<DbSystemEndpoint> Endpoints { get; set; }

Property Value

Type	Description
List<DbSystemEndpoint>	The network endpoints available for this DB System.

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.

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

HeatWaveCluster

Declaration

[JsonProperty(PropertyName = "heatWaveCluster")]
public HeatWaveClusterSummary HeatWaveCluster { get; set; }

Property Value

Type	Description
HeatWaveClusterSummary

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.

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the DB System.

Remarks

Required

IpAddress

Declaration

[JsonProperty(PropertyName = "ipAddress")]
public string IpAddress { get; set; }

Property Value

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

Ipv6AddressIpv6SubnetCidrPairDetails

Declaration

[JsonProperty(PropertyName = "ipv6AddressIpv6SubnetCidrPairDetails")]
public Ipv6AddressIpv6SubnetCidrPairDetails Ipv6AddressIpv6SubnetCidrPairDetails { get; set; }

Property Value

Type	Description
Ipv6AddressIpv6SubnetCidrPairDetails

IsHeatWaveClusterAttached

Declaration

[JsonProperty(PropertyName = "isHeatWaveClusterAttached")]
public bool? IsHeatWaveClusterAttached { get; set; }

Property Value

Type	Description
bool?	If the DB System has a HeatWave Cluster attached.

IsHighlyAvailable

Declaration

[JsonProperty(PropertyName = "isHighlyAvailable")]
public bool? IsHighlyAvailable { get; set; }

Property Value

Type	Description
bool?	Specifies if the DB System is highly available.

IsIpv6Enabled

Declaration

[JsonProperty(PropertyName = "isIpv6Enabled")]
public bool? IsIpv6Enabled { get; set; }

Property Value

Type	Description
bool?	Whether an IPv6 address has been allocated for the DB system when attached to an IPv6 enabled subnet. Default: False.

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
string	Additional information about the current lifecycleState.

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DbSystem.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
DbSystem.LifecycleStateEnum?	The current state of the DB System.

Remarks

Required

Maintenance

Declaration

[Required(ErrorMessage = "Maintenance is required.")]
[JsonProperty(PropertyName = "maintenance")]
public MaintenanceDetails Maintenance { get; set; }

Property Value

Type	Description
MaintenanceDetails

Remarks

Required

MysqlVersion

Declaration

[Required(ErrorMessage = "MysqlVersion is required.")]
[JsonProperty(PropertyName = "mysqlVersion")]
public string MysqlVersion { get; set; }

Property Value

Type	Description
string	Name of the MySQL Version in use for the DB System.

Remarks

Required

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.

PointInTimeRecoveryDetails

Declaration

[JsonProperty(PropertyName = "pointInTimeRecoveryDetails")]
public PointInTimeRecoveryDetails PointInTimeRecoveryDetails { get; set; }

Property Value

Type	Description
PointInTimeRecoveryDetails

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 network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port.

ReadEndpoint

Declaration

[JsonProperty(PropertyName = "readEndpoint")]
public ReadEndpointDetails ReadEndpoint { get; set; }

Property Value

Type	Description
ReadEndpointDetails

Rest

Declaration

[JsonProperty(PropertyName = "rest")]
public RestDetails Rest { get; set; }

Property Value

Type	Description
RestDetails

SecureConnections

Declaration

[JsonProperty(PropertyName = "secureConnections")]
public SecureConnectionDetails SecureConnections { get; set; }

Property Value

Type	Description
SecureConnectionDetails

SecurityAttributes

Declaration

[JsonProperty(PropertyName = "securityAttributes")]
public Dictionary<string, Dictionary<string, object>> SecurityAttributes { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see ZPR Artifacts. Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}

ShapeName

Declaration

[JsonProperty(PropertyName = "shapeName")]
public string ShapeName { get; set; }

Property Value

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

Source

Declaration

[JsonProperty(PropertyName = "source")]
public DbSystemSource Source { get; set; }

Property Value

Type	Description
DbSystemSource

SubnetId

Declaration

[Required(ErrorMessage = "SubnetId is required.")]
[JsonProperty(PropertyName = "subnetId")]
public string SubnetId { get; set; }

Property Value

Type	Description
string	The OCID of the subnet the DB System is associated with.

Remarks

Required

SystemTags

Declaration

[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TelemetryConfiguration

Declaration

[JsonProperty(PropertyName = "telemetryConfiguration")]
public TelemetryConfigurationDetails TelemetryConfiguration { get; set; }

Property Value

Type	Description
TelemetryConfigurationDetails

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the DB System was created.

Remarks

Required

TimeUpdated

Declaration

[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The time the DB System was last updated.

Remarks

Required