Class DbSystem
A DB System is the core logical unit of MySQL Database Service.
Inherited Members
Namespace: Oci.MysqlService.Models
Assembly: OCI.DotNetSDK.Mysql.dll
Syntax
public class DbSystem
Properties
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.
|
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. |
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
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. |
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
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.
|
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. |
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. |
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
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. |
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 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
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