DistributedDbBackupConfig¶

class oci.distributed_database.models.DistributedDbBackupConfig(**kwargs)¶

Bases: object

Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

Attributes

`AUTO_BACKUP_WINDOW_SLOT_EIGHT`	A constant which can be used with the auto_backup_window property of a DistributedDbBackupConfig.
`AUTO_BACKUP_WINDOW_SLOT_ELEVEN`	A constant which can be used with the auto_backup_window property of a DistributedDbBackupConfig.
`AUTO_BACKUP_WINDOW_SLOT_FIVE`	A constant which can be used with the auto_backup_window property of a DistributedDbBackupConfig.
`AUTO_BACKUP_WINDOW_SLOT_FOUR`	A constant which can be used with the auto_backup_window property of a DistributedDbBackupConfig.
`AUTO_BACKUP_WINDOW_SLOT_NINE`	A constant which can be used with the auto_backup_window property of a DistributedDbBackupConfig.
`AUTO_BACKUP_WINDOW_SLOT_ONE`	A constant which can be used with the auto_backup_window property of a DistributedDbBackupConfig.
`AUTO_BACKUP_WINDOW_SLOT_SEVEN`	A constant which can be used with the auto_backup_window property of a DistributedDbBackupConfig.
`AUTO_BACKUP_WINDOW_SLOT_SIX`	A constant which can be used with the auto_backup_window property of a DistributedDbBackupConfig.
`AUTO_BACKUP_WINDOW_SLOT_TEN`	A constant which can be used with the auto_backup_window property of a DistributedDbBackupConfig.
`AUTO_BACKUP_WINDOW_SLOT_THREE`	A constant which can be used with the auto_backup_window property of a DistributedDbBackupConfig.
`AUTO_BACKUP_WINDOW_SLOT_TWELVE`	A constant which can be used with the auto_backup_window property of a DistributedDbBackupConfig.
`AUTO_BACKUP_WINDOW_SLOT_TWO`	A constant which can be used with the auto_backup_window property of a DistributedDbBackupConfig.
`AUTO_FULL_BACKUP_DAY_FRIDAY`	A constant which can be used with the auto_full_backup_day property of a DistributedDbBackupConfig.
`AUTO_FULL_BACKUP_DAY_MONDAY`	A constant which can be used with the auto_full_backup_day property of a DistributedDbBackupConfig.
`AUTO_FULL_BACKUP_DAY_SATURDAY`	A constant which can be used with the auto_full_backup_day property of a DistributedDbBackupConfig.
`AUTO_FULL_BACKUP_DAY_SUNDAY`	A constant which can be used with the auto_full_backup_day property of a DistributedDbBackupConfig.
`AUTO_FULL_BACKUP_DAY_THURSDAY`	A constant which can be used with the auto_full_backup_day property of a DistributedDbBackupConfig.
`AUTO_FULL_BACKUP_DAY_TUESDAY`	A constant which can be used with the auto_full_backup_day property of a DistributedDbBackupConfig.
`AUTO_FULL_BACKUP_DAY_WEDNESDAY`	A constant which can be used with the auto_full_backup_day property of a DistributedDbBackupConfig.
`AUTO_FULL_BACKUP_WINDOW_SLOT_EIGHT`	A constant which can be used with the auto_full_backup_window property of a DistributedDbBackupConfig.
`AUTO_FULL_BACKUP_WINDOW_SLOT_ELEVEN`	A constant which can be used with the auto_full_backup_window property of a DistributedDbBackupConfig.
`AUTO_FULL_BACKUP_WINDOW_SLOT_FIVE`	A constant which can be used with the auto_full_backup_window property of a DistributedDbBackupConfig.
`AUTO_FULL_BACKUP_WINDOW_SLOT_FOUR`	A constant which can be used with the auto_full_backup_window property of a DistributedDbBackupConfig.
`AUTO_FULL_BACKUP_WINDOW_SLOT_NINE`	A constant which can be used with the auto_full_backup_window property of a DistributedDbBackupConfig.
`AUTO_FULL_BACKUP_WINDOW_SLOT_ONE`	A constant which can be used with the auto_full_backup_window property of a DistributedDbBackupConfig.
`AUTO_FULL_BACKUP_WINDOW_SLOT_SEVEN`	A constant which can be used with the auto_full_backup_window property of a DistributedDbBackupConfig.
`AUTO_FULL_BACKUP_WINDOW_SLOT_SIX`	A constant which can be used with the auto_full_backup_window property of a DistributedDbBackupConfig.
`AUTO_FULL_BACKUP_WINDOW_SLOT_TEN`	A constant which can be used with the auto_full_backup_window property of a DistributedDbBackupConfig.
`AUTO_FULL_BACKUP_WINDOW_SLOT_THREE`	A constant which can be used with the auto_full_backup_window property of a DistributedDbBackupConfig.
`AUTO_FULL_BACKUP_WINDOW_SLOT_TWELVE`	A constant which can be used with the auto_full_backup_window property of a DistributedDbBackupConfig.
`AUTO_FULL_BACKUP_WINDOW_SLOT_TWO`	A constant which can be used with the auto_full_backup_window property of a DistributedDbBackupConfig.
`BACKUP_DELETION_POLICY_DELETE_AFTER_RETENTION_PERIOD`	A constant which can be used with the backup_deletion_policy property of a DistributedDbBackupConfig.
`BACKUP_DELETION_POLICY_DELETE_IMMEDIATELY`	A constant which can be used with the backup_deletion_policy property of a DistributedDbBackupConfig.
`auto_backup_window`	Gets the auto_backup_window of this DistributedDbBackupConfig.
`auto_full_backup_day`	Gets the auto_full_backup_day of this DistributedDbBackupConfig.
`auto_full_backup_window`	Gets the auto_full_backup_window of this DistributedDbBackupConfig.
`backup_deletion_policy`	Gets the backup_deletion_policy of this DistributedDbBackupConfig.
`backup_destination_details`	Gets the backup_destination_details of this DistributedDbBackupConfig.
`can_run_immediate_full_backup`	Gets the can_run_immediate_full_backup of this DistributedDbBackupConfig.
`is_auto_backup_enabled`	Gets the is_auto_backup_enabled of this DistributedDbBackupConfig.
`is_remote_backup_enabled`	Gets the is_remote_backup_enabled of this DistributedDbBackupConfig.
`recovery_window_in_days`	Gets the recovery_window_in_days of this DistributedDbBackupConfig.
`remote_region`	Gets the remote_region of this DistributedDbBackupConfig.

Methods

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

AUTO_BACKUP_WINDOW_SLOT_EIGHT = 'SLOT_EIGHT'¶: A constant which can be used with the auto_backup_window property of a DistributedDbBackupConfig. This constant has a value of “SLOT_EIGHT”

AUTO_BACKUP_WINDOW_SLOT_ELEVEN = 'SLOT_ELEVEN'¶: A constant which can be used with the auto_backup_window property of a DistributedDbBackupConfig. This constant has a value of “SLOT_ELEVEN”

AUTO_BACKUP_WINDOW_SLOT_FIVE = 'SLOT_FIVE'¶: A constant which can be used with the auto_backup_window property of a DistributedDbBackupConfig. This constant has a value of “SLOT_FIVE”

AUTO_BACKUP_WINDOW_SLOT_FOUR = 'SLOT_FOUR'¶: A constant which can be used with the auto_backup_window property of a DistributedDbBackupConfig. This constant has a value of “SLOT_FOUR”

AUTO_BACKUP_WINDOW_SLOT_NINE = 'SLOT_NINE'¶: A constant which can be used with the auto_backup_window property of a DistributedDbBackupConfig. This constant has a value of “SLOT_NINE”

AUTO_BACKUP_WINDOW_SLOT_ONE = 'SLOT_ONE'¶: A constant which can be used with the auto_backup_window property of a DistributedDbBackupConfig. This constant has a value of “SLOT_ONE”

AUTO_BACKUP_WINDOW_SLOT_SEVEN = 'SLOT_SEVEN'¶: A constant which can be used with the auto_backup_window property of a DistributedDbBackupConfig. This constant has a value of “SLOT_SEVEN”

AUTO_BACKUP_WINDOW_SLOT_SIX = 'SLOT_SIX'¶: A constant which can be used with the auto_backup_window property of a DistributedDbBackupConfig. This constant has a value of “SLOT_SIX”

AUTO_BACKUP_WINDOW_SLOT_TEN = 'SLOT_TEN'¶: A constant which can be used with the auto_backup_window property of a DistributedDbBackupConfig. This constant has a value of “SLOT_TEN”

AUTO_BACKUP_WINDOW_SLOT_THREE = 'SLOT_THREE'¶: A constant which can be used with the auto_backup_window property of a DistributedDbBackupConfig. This constant has a value of “SLOT_THREE”

AUTO_BACKUP_WINDOW_SLOT_TWELVE = 'SLOT_TWELVE'¶: A constant which can be used with the auto_backup_window property of a DistributedDbBackupConfig. This constant has a value of “SLOT_TWELVE”

AUTO_BACKUP_WINDOW_SLOT_TWO = 'SLOT_TWO'¶: A constant which can be used with the auto_backup_window property of a DistributedDbBackupConfig. This constant has a value of “SLOT_TWO”

AUTO_FULL_BACKUP_DAY_FRIDAY = 'FRIDAY'¶: A constant which can be used with the auto_full_backup_day property of a DistributedDbBackupConfig. This constant has a value of “FRIDAY”

AUTO_FULL_BACKUP_DAY_MONDAY = 'MONDAY'¶: A constant which can be used with the auto_full_backup_day property of a DistributedDbBackupConfig. This constant has a value of “MONDAY”

AUTO_FULL_BACKUP_DAY_SATURDAY = 'SATURDAY'¶: A constant which can be used with the auto_full_backup_day property of a DistributedDbBackupConfig. This constant has a value of “SATURDAY”

AUTO_FULL_BACKUP_DAY_SUNDAY = 'SUNDAY'¶: A constant which can be used with the auto_full_backup_day property of a DistributedDbBackupConfig. This constant has a value of “SUNDAY”

AUTO_FULL_BACKUP_DAY_THURSDAY = 'THURSDAY'¶: A constant which can be used with the auto_full_backup_day property of a DistributedDbBackupConfig. This constant has a value of “THURSDAY”

AUTO_FULL_BACKUP_DAY_TUESDAY = 'TUESDAY'¶: A constant which can be used with the auto_full_backup_day property of a DistributedDbBackupConfig. This constant has a value of “TUESDAY”

AUTO_FULL_BACKUP_DAY_WEDNESDAY = 'WEDNESDAY'¶: A constant which can be used with the auto_full_backup_day property of a DistributedDbBackupConfig. This constant has a value of “WEDNESDAY”

AUTO_FULL_BACKUP_WINDOW_SLOT_EIGHT = 'SLOT_EIGHT'¶: A constant which can be used with the auto_full_backup_window property of a DistributedDbBackupConfig. This constant has a value of “SLOT_EIGHT”

AUTO_FULL_BACKUP_WINDOW_SLOT_ELEVEN = 'SLOT_ELEVEN'¶: A constant which can be used with the auto_full_backup_window property of a DistributedDbBackupConfig. This constant has a value of “SLOT_ELEVEN”

AUTO_FULL_BACKUP_WINDOW_SLOT_FIVE = 'SLOT_FIVE'¶: A constant which can be used with the auto_full_backup_window property of a DistributedDbBackupConfig. This constant has a value of “SLOT_FIVE”

AUTO_FULL_BACKUP_WINDOW_SLOT_FOUR = 'SLOT_FOUR'¶: A constant which can be used with the auto_full_backup_window property of a DistributedDbBackupConfig. This constant has a value of “SLOT_FOUR”

AUTO_FULL_BACKUP_WINDOW_SLOT_NINE = 'SLOT_NINE'¶: A constant which can be used with the auto_full_backup_window property of a DistributedDbBackupConfig. This constant has a value of “SLOT_NINE”

AUTO_FULL_BACKUP_WINDOW_SLOT_ONE = 'SLOT_ONE'¶: A constant which can be used with the auto_full_backup_window property of a DistributedDbBackupConfig. This constant has a value of “SLOT_ONE”

AUTO_FULL_BACKUP_WINDOW_SLOT_SEVEN = 'SLOT_SEVEN'¶: A constant which can be used with the auto_full_backup_window property of a DistributedDbBackupConfig. This constant has a value of “SLOT_SEVEN”

AUTO_FULL_BACKUP_WINDOW_SLOT_SIX = 'SLOT_SIX'¶: A constant which can be used with the auto_full_backup_window property of a DistributedDbBackupConfig. This constant has a value of “SLOT_SIX”

AUTO_FULL_BACKUP_WINDOW_SLOT_TEN = 'SLOT_TEN'¶: A constant which can be used with the auto_full_backup_window property of a DistributedDbBackupConfig. This constant has a value of “SLOT_TEN”

AUTO_FULL_BACKUP_WINDOW_SLOT_THREE = 'SLOT_THREE'¶: A constant which can be used with the auto_full_backup_window property of a DistributedDbBackupConfig. This constant has a value of “SLOT_THREE”

AUTO_FULL_BACKUP_WINDOW_SLOT_TWELVE = 'SLOT_TWELVE'¶: A constant which can be used with the auto_full_backup_window property of a DistributedDbBackupConfig. This constant has a value of “SLOT_TWELVE”

AUTO_FULL_BACKUP_WINDOW_SLOT_TWO = 'SLOT_TWO'¶: A constant which can be used with the auto_full_backup_window property of a DistributedDbBackupConfig. This constant has a value of “SLOT_TWO”

BACKUP_DELETION_POLICY_DELETE_AFTER_RETENTION_PERIOD = 'DELETE_AFTER_RETENTION_PERIOD'¶: A constant which can be used with the backup_deletion_policy property of a DistributedDbBackupConfig. This constant has a value of “DELETE_AFTER_RETENTION_PERIOD”

BACKUP_DELETION_POLICY_DELETE_IMMEDIATELY = 'DELETE_IMMEDIATELY'¶: A constant which can be used with the backup_deletion_policy property of a DistributedDbBackupConfig. This constant has a value of “DELETE_IMMEDIATELY”

__init__(**kwargs)¶

Initializes a new DistributedDbBackupConfig object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

is_auto_backup_enabled (bool) – The value to assign to the is_auto_backup_enabled property of this DistributedDbBackupConfig.
recovery_window_in_days (int) – The value to assign to the recovery_window_in_days property of this DistributedDbBackupConfig.
auto_backup_window (str) – The value to assign to the auto_backup_window property of this DistributedDbBackupConfig. Allowed values for this property are: “SLOT_ONE”, “SLOT_TWO”, “SLOT_THREE”, “SLOT_FOUR”, “SLOT_FIVE”, “SLOT_SIX”, “SLOT_SEVEN”, “SLOT_EIGHT”, “SLOT_NINE”, “SLOT_TEN”, “SLOT_ELEVEN”, “SLOT_TWELVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
auto_full_backup_window (str) – The value to assign to the auto_full_backup_window property of this DistributedDbBackupConfig. Allowed values for this property are: “SLOT_ONE”, “SLOT_TWO”, “SLOT_THREE”, “SLOT_FOUR”, “SLOT_FIVE”, “SLOT_SIX”, “SLOT_SEVEN”, “SLOT_EIGHT”, “SLOT_NINE”, “SLOT_TEN”, “SLOT_ELEVEN”, “SLOT_TWELVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
auto_full_backup_day (str) – The value to assign to the auto_full_backup_day property of this DistributedDbBackupConfig. Allowed values for this property are: “SUNDAY”, “MONDAY”, “TUESDAY”, “WEDNESDAY”, “THURSDAY”, “FRIDAY”, “SATURDAY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
can_run_immediate_full_backup (bool) – The value to assign to the can_run_immediate_full_backup property of this DistributedDbBackupConfig.
is_remote_backup_enabled (bool) – The value to assign to the is_remote_backup_enabled property of this DistributedDbBackupConfig.
remote_region (str) – The value to assign to the remote_region property of this DistributedDbBackupConfig.
backup_destination_details (list[oci.distributed_database.models.DistributedDbBackupDestination]) – The value to assign to the backup_destination_details property of this DistributedDbBackupConfig.
backup_deletion_policy (str) – The value to assign to the backup_deletion_policy property of this DistributedDbBackupConfig. Allowed values for this property are: “DELETE_IMMEDIATELY”, “DELETE_AFTER_RETENTION_PERIOD”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

auto_backup_window¶

Gets the auto_backup_window of this DistributedDbBackupConfig. Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO

Allowed values for this property are: “SLOT_ONE”, “SLOT_TWO”, “SLOT_THREE”, “SLOT_FOUR”, “SLOT_FIVE”, “SLOT_SIX”, “SLOT_SEVEN”, “SLOT_EIGHT”, “SLOT_NINE”, “SLOT_TEN”, “SLOT_ELEVEN”, “SLOT_TWELVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The auto_backup_window of this DistributedDbBackupConfig.
Return type:	str

auto_full_backup_day¶

Gets the auto_full_backup_day of this DistributedDbBackupConfig. Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.

Allowed values for this property are: “SUNDAY”, “MONDAY”, “TUESDAY”, “WEDNESDAY”, “THURSDAY”, “FRIDAY”, “SATURDAY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The auto_full_backup_day of this DistributedDbBackupConfig.
Return type:	str

auto_full_backup_window¶

Gets the auto_full_backup_window of this DistributedDbBackupConfig. Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO

Allowed values for this property are: “SLOT_ONE”, “SLOT_TWO”, “SLOT_THREE”, “SLOT_FOUR”, “SLOT_FIVE”, “SLOT_SIX”, “SLOT_SEVEN”, “SLOT_EIGHT”, “SLOT_NINE”, “SLOT_TEN”, “SLOT_ELEVEN”, “SLOT_TWELVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The auto_full_backup_window of this DistributedDbBackupConfig.
Return type:	str

backup_deletion_policy¶

Gets the backup_deletion_policy of this DistributedDbBackupConfig. This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently… - RETAIN will keep the backups as per the policy defined for database backups.

Allowed values for this property are: “DELETE_IMMEDIATELY”, “DELETE_AFTER_RETENTION_PERIOD”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The backup_deletion_policy of this DistributedDbBackupConfig.
Return type:	str

backup_destination_details¶

Gets the backup_destination_details of this DistributedDbBackupConfig. Backup destination details.

Returns:	The backup_destination_details of this DistributedDbBackupConfig.
Return type:	list[oci.distributed_database.models.DistributedDbBackupDestination]

can_run_immediate_full_backup¶

Gets the can_run_immediate_full_backup of this DistributedDbBackupConfig. If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

Returns:	The can_run_immediate_full_backup of this DistributedDbBackupConfig.
Return type:	bool

is_auto_backup_enabled¶

Gets the is_auto_backup_enabled of this DistributedDbBackupConfig. If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.

Returns:	The is_auto_backup_enabled of this DistributedDbBackupConfig.
Return type:	bool

is_remote_backup_enabled¶

Gets the is_remote_backup_enabled of this DistributedDbBackupConfig. If set to true, configures automatic incremental backups in the local region (the region of the DB system) and the remote region with a default frequency of 1 hour. If you previously used RMAN or dbcli to configure backups, using the Console or the API for manged backups creates a new backup configuration for your database. The new configuration replaces the configuration created with RMAN or dbcli. This means that you can no longer rely on your previously configured unmanaged backups to work.

Returns:	The is_remote_backup_enabled of this DistributedDbBackupConfig.
Return type:	bool

recovery_window_in_days¶

Gets the recovery_window_in_days of this DistributedDbBackupConfig. Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.

Returns:	The recovery_window_in_days of this DistributedDbBackupConfig.
Return type:	int

remote_region¶

Gets the remote_region of this DistributedDbBackupConfig. The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see Regions and Availability Domains.

Returns:	The remote_region of this DistributedDbBackupConfig.
Return type:	str