DbBackupConfig¶
-
class
oci.database.models.DbBackupConfig(**kwargs)¶ Bases:
objectBackup 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_EIGHTA constant which can be used with the auto_backup_window property of a DbBackupConfig. AUTO_BACKUP_WINDOW_SLOT_ELEVENA constant which can be used with the auto_backup_window property of a DbBackupConfig. AUTO_BACKUP_WINDOW_SLOT_FIVEA constant which can be used with the auto_backup_window property of a DbBackupConfig. AUTO_BACKUP_WINDOW_SLOT_FOURA constant which can be used with the auto_backup_window property of a DbBackupConfig. AUTO_BACKUP_WINDOW_SLOT_NINEA constant which can be used with the auto_backup_window property of a DbBackupConfig. AUTO_BACKUP_WINDOW_SLOT_ONEA constant which can be used with the auto_backup_window property of a DbBackupConfig. AUTO_BACKUP_WINDOW_SLOT_SEVENA constant which can be used with the auto_backup_window property of a DbBackupConfig. AUTO_BACKUP_WINDOW_SLOT_SIXA constant which can be used with the auto_backup_window property of a DbBackupConfig. AUTO_BACKUP_WINDOW_SLOT_TENA constant which can be used with the auto_backup_window property of a DbBackupConfig. AUTO_BACKUP_WINDOW_SLOT_THREEA constant which can be used with the auto_backup_window property of a DbBackupConfig. AUTO_BACKUP_WINDOW_SLOT_TWELVEA constant which can be used with the auto_backup_window property of a DbBackupConfig. AUTO_BACKUP_WINDOW_SLOT_TWOA constant which can be used with the auto_backup_window property of a DbBackupConfig. AUTO_FULL_BACKUP_DAY_FRIDAYA constant which can be used with the auto_full_backup_day property of a DbBackupConfig. AUTO_FULL_BACKUP_DAY_MONDAYA constant which can be used with the auto_full_backup_day property of a DbBackupConfig. AUTO_FULL_BACKUP_DAY_SATURDAYA constant which can be used with the auto_full_backup_day property of a DbBackupConfig. AUTO_FULL_BACKUP_DAY_SUNDAYA constant which can be used with the auto_full_backup_day property of a DbBackupConfig. AUTO_FULL_BACKUP_DAY_THURSDAYA constant which can be used with the auto_full_backup_day property of a DbBackupConfig. AUTO_FULL_BACKUP_DAY_TUESDAYA constant which can be used with the auto_full_backup_day property of a DbBackupConfig. AUTO_FULL_BACKUP_DAY_WEDNESDAYA constant which can be used with the auto_full_backup_day property of a DbBackupConfig. AUTO_FULL_BACKUP_WINDOW_SLOT_EIGHTA constant which can be used with the auto_full_backup_window property of a DbBackupConfig. AUTO_FULL_BACKUP_WINDOW_SLOT_ELEVENA constant which can be used with the auto_full_backup_window property of a DbBackupConfig. AUTO_FULL_BACKUP_WINDOW_SLOT_FIVEA constant which can be used with the auto_full_backup_window property of a DbBackupConfig. AUTO_FULL_BACKUP_WINDOW_SLOT_FOURA constant which can be used with the auto_full_backup_window property of a DbBackupConfig. AUTO_FULL_BACKUP_WINDOW_SLOT_NINEA constant which can be used with the auto_full_backup_window property of a DbBackupConfig. AUTO_FULL_BACKUP_WINDOW_SLOT_ONEA constant which can be used with the auto_full_backup_window property of a DbBackupConfig. AUTO_FULL_BACKUP_WINDOW_SLOT_SEVENA constant which can be used with the auto_full_backup_window property of a DbBackupConfig. AUTO_FULL_BACKUP_WINDOW_SLOT_SIXA constant which can be used with the auto_full_backup_window property of a DbBackupConfig. AUTO_FULL_BACKUP_WINDOW_SLOT_TENA constant which can be used with the auto_full_backup_window property of a DbBackupConfig. AUTO_FULL_BACKUP_WINDOW_SLOT_THREEA constant which can be used with the auto_full_backup_window property of a DbBackupConfig. AUTO_FULL_BACKUP_WINDOW_SLOT_TWELVEA constant which can be used with the auto_full_backup_window property of a DbBackupConfig. AUTO_FULL_BACKUP_WINDOW_SLOT_TWOA constant which can be used with the auto_full_backup_window property of a DbBackupConfig. BACKUP_DELETION_POLICY_DELETE_AFTER_RETENTION_PERIODA constant which can be used with the backup_deletion_policy property of a DbBackupConfig. BACKUP_DELETION_POLICY_DELETE_IMMEDIATELYA constant which can be used with the backup_deletion_policy property of a DbBackupConfig. auto_backup_enabledGets the auto_backup_enabled of this DbBackupConfig. auto_backup_windowGets the auto_backup_window of this DbBackupConfig. auto_full_backup_dayGets the auto_full_backup_day of this DbBackupConfig. auto_full_backup_windowGets the auto_full_backup_window of this DbBackupConfig. backup_deletion_policyGets the backup_deletion_policy of this DbBackupConfig. backup_destination_detailsGets the backup_destination_details of this DbBackupConfig. recovery_window_in_daysGets the recovery_window_in_days of this DbBackupConfig. run_immediate_full_backupGets the run_immediate_full_backup of this DbBackupConfig. Methods
__init__(**kwargs)Initializes a new DbBackupConfig 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. This constant has a value of “DELETE_IMMEDIATELY”
-
__init__(**kwargs)¶ Initializes a new DbBackupConfig object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
Parameters: - auto_backup_enabled (bool) – The value to assign to the auto_backup_enabled property of this DbBackupConfig.
- recovery_window_in_days (int) – The value to assign to the recovery_window_in_days property of this DbBackupConfig.
- auto_backup_window (str) – The value to assign to the auto_backup_window property of this DbBackupConfig. 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 DbBackupConfig. 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 DbBackupConfig. 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’.
- run_immediate_full_backup (bool) – The value to assign to the run_immediate_full_backup property of this DbBackupConfig.
- backup_destination_details (list[oci.database.models.BackupDestinationDetails]) – The value to assign to the backup_destination_details property of this DbBackupConfig.
- backup_deletion_policy (str) – The value to assign to the backup_deletion_policy property of this DbBackupConfig. 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_enabled¶ Gets the auto_backup_enabled of this DbBackupConfig. 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 auto_backup_enabled of this DbBackupConfig. Return type: bool
-
auto_backup_window¶ Gets the auto_backup_window of this DbBackupConfig. 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 DbBackupConfig. Return type: str
-
auto_full_backup_day¶ Gets the auto_full_backup_day of this DbBackupConfig. 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 DbBackupConfig. Return type: str
-
auto_full_backup_window¶ Gets the auto_full_backup_window of this DbBackupConfig. 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 DbBackupConfig. Return type: str
-
backup_deletion_policy¶ Gets the backup_deletion_policy of this DbBackupConfig. 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 DbBackupConfig. Return type: str
-
backup_destination_details¶ Gets the backup_destination_details of this DbBackupConfig. Backup destination details.
Returns: The backup_destination_details of this DbBackupConfig. Return type: list[oci.database.models.BackupDestinationDetails]
-
recovery_window_in_days¶ Gets the recovery_window_in_days of this DbBackupConfig. 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 DbBackupConfig. Return type: int
-
run_immediate_full_backup¶ Gets the run_immediate_full_backup of this DbBackupConfig. 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 run_immediate_full_backup of this DbBackupConfig. Return type: bool
-