Class BackupPolicy

The Backup policy for the DB System.

Inheritance

object

BackupPolicy

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 BackupPolicy

Properties

CopyPolicies

Declaration

[JsonProperty(PropertyName = "copyPolicies")]
public List<CopyPolicy> CopyPolicies { get; set; }

Property Value

Type	Description
List<CopyPolicy>	List of policies of a DB system to schedule cross-region DB system backup copy. The policy includes the name of the destination region to which the DB system backup will be copied, and an optional parameter which specifies the retention period of the copied DB system backup in days. Note: Currently, only one policy can be specified in the list.

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. Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy. Example: {"foo-namespace": {"bar-key": "value"}}

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. Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy. Example: {"bar-key": "value"}

IsEnabled

Declaration

[Required(ErrorMessage = "IsEnabled is required.")]
[JsonProperty(PropertyName = "isEnabled")]
public bool? IsEnabled { get; set; }

Property Value

Type	Description
bool?	If automated backups are enabled or disabled.

Remarks

Required

PitrPolicy

Declaration

[JsonProperty(PropertyName = "pitrPolicy")]
public PitrPolicy PitrPolicy { get; set; }

Property Value

Type	Description
PitrPolicy

RetentionInDays

Declaration

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

Property Value

Type	Description
int?	The number of days automated backups are retained.

Remarks

Required

SoftDelete

Declaration

[JsonProperty(PropertyName = "softDelete")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SoftDelete? SoftDelete { get; set; }

Property Value

Type	Description
SoftDelete?	Retains the backup to be deleted due to the retention policy in DELETE SCHEDULED state for 7 days before permanently deleting it.

WindowStartTime

Declaration

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

Property Value

Type	Description
string	The start of a 30-minute window of time in which daily, automated backups occur. This should be in the format of the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero. At some point in the window, the system may incur a brief service disruption as the backup is performed. If not defined, a window is selected from the following Region-based time-spans: eu-frankfurt-1: 20:00 - 04:00 UTC us-ashburn-1: 03:00 - 11:00 UTC uk-london-1: 06:00 - 14:00 UTC ap-tokyo-1: 13:00 - 21:00 us-phoenix-1: 06:00 - 14:00

Type

Description

string

The start of a 30-minute window of time in which daily, automated backups occur.
This should be in the format of the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero.
At some point in the window, the system may incur a brief service disruption as the backup is performed.
If not defined, a window is selected from the following Region-based time-spans:

eu-frankfurt-1: 20:00 - 04:00 UTC
us-ashburn-1: 03:00 - 11:00 UTC
uk-london-1: 06:00 - 14:00 UTC
ap-tokyo-1: 13:00 - 21:00
us-phoenix-1: 06:00 - 14:00

Remarks

Required