BackupPolicy¶

class oci.mysql.models.BackupPolicy(**kwargs)¶

Bases: object

The Backup policy for the DB System.

Methods

__init__(**kwargs) Initializes a new BackupPolicy object with values from keyword arguments.

Attributes

`copy_policies`	Gets the copy_policies of this BackupPolicy.
`defined_tags`	Gets the defined_tags of this BackupPolicy.
`freeform_tags`	Gets the freeform_tags of this BackupPolicy.
`is_enabled`	[Required] Gets the is_enabled of this BackupPolicy.
`pitr_policy`	Gets the pitr_policy of this BackupPolicy.
`retention_in_days`	[Required] Gets the retention_in_days of this BackupPolicy.
`window_start_time`	[Required] Gets the window_start_time of this BackupPolicy.

__init__(**kwargs)¶

Initializes a new BackupPolicy 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 BackupPolicy.
copy_policies (list[oci.mysql.models.CopyPolicy]) – The value to assign to the copy_policies property of this BackupPolicy.
window_start_time (str) – The value to assign to the window_start_time property of this BackupPolicy.
retention_in_days (int) – The value to assign to the retention_in_days property of this BackupPolicy.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this BackupPolicy.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this BackupPolicy.
pitr_policy (oci.mysql.models.PitrPolicy) – The value to assign to the pitr_policy property of this BackupPolicy.

copy_policies¶

Gets the copy_policies of this BackupPolicy. 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 BackupPolicy.
Return type:	list[oci.mysql.models.CopyPolicy]

defined_tags¶

Gets the defined_tags of this BackupPolicy. 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 BackupPolicy.
Return type:	dict(str, dict(str, object))

freeform_tags¶

Gets the freeform_tags of this BackupPolicy. 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 BackupPolicy.
Return type:	dict(str, str)

is_enabled¶

[Required] Gets the is_enabled of this BackupPolicy. If automated backups are enabled or disabled.

Returns:	The is_enabled of this BackupPolicy.
Return type:	bool

pitr_policy¶

Gets the pitr_policy of this BackupPolicy.

Returns:	The pitr_policy of this BackupPolicy.
Return type:	oci.mysql.models.PitrPolicy

retention_in_days¶

[Required] Gets the retention_in_days of this BackupPolicy. The number of days automated backups are retained.

Returns:	The retention_in_days of this BackupPolicy.
Return type:	int

window_start_time¶

[Required] Gets the window_start_time of this BackupPolicy. 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

Returns:	The window_start_time of this BackupPolicy.
Return type:	str