CreateBackupPolicyDetails¶

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

Bases: object

Backup policy as optionally used for DB System Creation.

Attributes:

`SOFT_DELETE_DISABLED`	A constant which can be used with the soft_delete property of a CreateBackupPolicyDetails.
`SOFT_DELETE_ENABLED`	A constant which can be used with the soft_delete property of a CreateBackupPolicyDetails.
`copy_policies`	Gets the copy_policies of this CreateBackupPolicyDetails.
`defined_tags`	Gets the defined_tags of this CreateBackupPolicyDetails.
`freeform_tags`	Gets the freeform_tags of this CreateBackupPolicyDetails.
`is_enabled`	Gets the is_enabled of this CreateBackupPolicyDetails.
`pitr_policy`	Gets the pitr_policy of this CreateBackupPolicyDetails.
`retention_in_days`	Gets the retention_in_days of this CreateBackupPolicyDetails.
`soft_delete`	Gets the soft_delete of this CreateBackupPolicyDetails.
`window_start_time`	Gets the window_start_time of this CreateBackupPolicyDetails.

Methods:

__init__(**kwargs)

Initializes a new CreateBackupPolicyDetails object with values from keyword arguments.

SOFT_DELETE_DISABLED = 'DISABLED'¶: A constant which can be used with the soft_delete property of a CreateBackupPolicyDetails. This constant has a value of “DISABLED”

SOFT_DELETE_ENABLED = 'ENABLED'¶: A constant which can be used with the soft_delete property of a CreateBackupPolicyDetails. This constant has a value of “ENABLED”

__init__(**kwargs)¶

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

property copy_policies¶

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

property defined_tags¶

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

property freeform_tags¶

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

property is_enabled¶

Gets the is_enabled of this CreateBackupPolicyDetails. Specifies if automatic backups are enabled.

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

property pitr_policy¶

Gets the pitr_policy of this CreateBackupPolicyDetails.

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

property retention_in_days¶

Gets the retention_in_days of this CreateBackupPolicyDetails. Number of days to retain an automatic backup.

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

property soft_delete¶

Gets the soft_delete of this CreateBackupPolicyDetails. 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 CreateBackupPolicyDetails.
Return type: str

property window_start_time¶

Gets the window_start_time of this CreateBackupPolicyDetails. 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 CreateBackupPolicyDetails.
Return type: str