UpdateBackupPolicyDetails¶
- class oci.mysql.models.UpdateBackupPolicyDetails(**kwargs)¶
Bases:
objectBackup Policy as optionally used for DB System update.
Attributes:
A constant which can be used with the soft_delete property of a UpdateBackupPolicyDetails.
A constant which can be used with the soft_delete property of a UpdateBackupPolicyDetails.
Gets the copy_policies of this UpdateBackupPolicyDetails.
Gets the defined_tags of this UpdateBackupPolicyDetails.
Gets the freeform_tags of this UpdateBackupPolicyDetails.
Gets the is_enabled of this UpdateBackupPolicyDetails.
Gets the pitr_policy of this UpdateBackupPolicyDetails.
Gets the retention_in_days of this UpdateBackupPolicyDetails.
Gets the soft_delete of this UpdateBackupPolicyDetails.
Gets the window_start_time of this UpdateBackupPolicyDetails.
Methods:
__init__(**kwargs)Initializes a new UpdateBackupPolicyDetails object with values from keyword arguments.
- SOFT_DELETE_DISABLED = 'DISABLED'¶
A constant which can be used with the soft_delete property of a UpdateBackupPolicyDetails. This constant has a value of “DISABLED”
- SOFT_DELETE_ENABLED = 'ENABLED'¶
A constant which can be used with the soft_delete property of a UpdateBackupPolicyDetails. This constant has a value of “ENABLED”
- __init__(**kwargs)¶
Initializes a new UpdateBackupPolicyDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
is_enabled (bool) – The value to assign to the is_enabled property of this UpdateBackupPolicyDetails.
soft_delete (str) – The value to assign to the soft_delete property of this UpdateBackupPolicyDetails. Allowed values for this property are: “ENABLED”, “DISABLED”
copy_policies (list[oci.mysql.models.CopyPolicy]) – The value to assign to the copy_policies property of this UpdateBackupPolicyDetails.
window_start_time (str) – The value to assign to the window_start_time property of this UpdateBackupPolicyDetails.
retention_in_days (int) – The value to assign to the retention_in_days property of this UpdateBackupPolicyDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateBackupPolicyDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateBackupPolicyDetails.
pitr_policy (oci.mysql.models.PitrPolicy) – The value to assign to the pitr_policy property of this UpdateBackupPolicyDetails.
- property copy_policies¶
Gets the copy_policies of this UpdateBackupPolicyDetails. 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.
- Returns
The copy_policies of this UpdateBackupPolicyDetails.
- Return type
- property defined_tags¶
Gets the defined_tags of this UpdateBackupPolicyDetails. 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”}}
- Returns
The defined_tags of this UpdateBackupPolicyDetails.
- Return type
dict(str, dict(str, object))
- property freeform_tags¶
Gets the freeform_tags of this UpdateBackupPolicyDetails. 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”}
- Returns
The freeform_tags of this UpdateBackupPolicyDetails.
- Return type
dict(str, str)
- property is_enabled¶
Gets the is_enabled of this UpdateBackupPolicyDetails. Specifies if automatic backups are enabled.
- Returns
The is_enabled of this UpdateBackupPolicyDetails.
- Return type
bool
- property pitr_policy¶
Gets the pitr_policy of this UpdateBackupPolicyDetails.
- Returns
The pitr_policy of this UpdateBackupPolicyDetails.
- Return type
- property retention_in_days¶
Gets the retention_in_days of this UpdateBackupPolicyDetails. Number of days to retain an automatic backup.
- Returns
The retention_in_days of this UpdateBackupPolicyDetails.
- Return type
int
- property soft_delete¶
Gets the soft_delete of this UpdateBackupPolicyDetails. Retains the backup to be deleted due to the retention policy in DELETE SCHEDULED state for 7 days before permanently deleting it.
Allowed values for this property are: “ENABLED”, “DISABLED”
- Returns
The soft_delete of this UpdateBackupPolicyDetails.
- Return type
str
- property window_start_time¶
Gets the window_start_time of this UpdateBackupPolicyDetails. 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.
- Returns
The window_start_time of this UpdateBackupPolicyDetails.
- Return type
str