UpdateOkeClusterBackupConfigDetails¶
- class oci.disaster_recovery.models.UpdateOkeClusterBackupConfigDetails(**kwargs)¶
Bases:
objectUpdate backup configuration properties for an OKE member.
Attributes:
A constant which can be used with the replicate_images property of a UpdateOkeClusterBackupConfigDetails.
A constant which can be used with the replicate_images property of a UpdateOkeClusterBackupConfigDetails.
Gets the backup_schedule of this UpdateOkeClusterBackupConfigDetails.
Gets the exclude_namespaces of this UpdateOkeClusterBackupConfigDetails.
Gets the image_replication_vault_secret_id of this UpdateOkeClusterBackupConfigDetails.
Gets the max_number_of_backups_retained of this UpdateOkeClusterBackupConfigDetails.
Gets the namespaces of this UpdateOkeClusterBackupConfigDetails.
Gets the replicate_images of this UpdateOkeClusterBackupConfigDetails.
Methods:
__init__(**kwargs)Initializes a new UpdateOkeClusterBackupConfigDetails object with values from keyword arguments.
- REPLICATE_IMAGES_DISABLE = 'DISABLE'¶
A constant which can be used with the replicate_images property of a UpdateOkeClusterBackupConfigDetails. This constant has a value of “DISABLE”
- REPLICATE_IMAGES_ENABLE = 'ENABLE'¶
A constant which can be used with the replicate_images property of a UpdateOkeClusterBackupConfigDetails. This constant has a value of “ENABLE”
- __init__(**kwargs)¶
Initializes a new UpdateOkeClusterBackupConfigDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
namespaces (list[str]) – The value to assign to the namespaces property of this UpdateOkeClusterBackupConfigDetails.
exclude_namespaces (list[str]) – The value to assign to the exclude_namespaces property of this UpdateOkeClusterBackupConfigDetails.
backup_schedule (str) – The value to assign to the backup_schedule property of this UpdateOkeClusterBackupConfigDetails.
replicate_images (str) – The value to assign to the replicate_images property of this UpdateOkeClusterBackupConfigDetails. Allowed values for this property are: “ENABLE”, “DISABLE”
max_number_of_backups_retained (int) – The value to assign to the max_number_of_backups_retained property of this UpdateOkeClusterBackupConfigDetails.
image_replication_vault_secret_id (str) – The value to assign to the image_replication_vault_secret_id property of this UpdateOkeClusterBackupConfigDetails.
- property backup_schedule¶
Gets the backup_schedule of this UpdateOkeClusterBackupConfigDetails. The schedule for backing up namespaces to the destination region. If a`backupSchedule` is not specified, only a single backup will be created. This format of the string specifying the backupSchedule must conform with RFC-5545. This schedule will use the UTC timezone. This property applies to the OKE cluster member in primary region.
Example: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH;BYHOUR=10;INTERVAL=1
- Returns
The backup_schedule of this UpdateOkeClusterBackupConfigDetails.
- Return type
str
- property exclude_namespaces¶
Gets the exclude_namespaces of this UpdateOkeClusterBackupConfigDetails. A list of namespaces to be excluded from the backup. The default value is null. If a list of namespaces to exclude is not provided, all namespaces will be backed up. Specify either the namespaces or the excludeNamespaces parameter, but not both. This property applies to OKE cluster members in the primary region.
Example: [“namespace_string_3”, “namespace_string_4”]
- Returns
The exclude_namespaces of this UpdateOkeClusterBackupConfigDetails.
- Return type
list[str]
- property image_replication_vault_secret_id¶
Gets the image_replication_vault_secret_id of this UpdateOkeClusterBackupConfigDetails. The OCID of the vault secret that stores the image credential. This property applies to the OKE cluster member in both the primary and standby region.
- Returns
The image_replication_vault_secret_id of this UpdateOkeClusterBackupConfigDetails.
- Return type
str
- property max_number_of_backups_retained¶
Gets the max_number_of_backups_retained of this UpdateOkeClusterBackupConfigDetails. The maximum number of backups that should be retained. This property applies to the OKE cluster member in primary region.
- Returns
The max_number_of_backups_retained of this UpdateOkeClusterBackupConfigDetails.
- Return type
int
- property namespaces¶
Gets the namespaces of this UpdateOkeClusterBackupConfigDetails. A list of namespaces to be included in the backup. The default value is null. If a list of namespaces to include is not provided, all namespaces will be backed up. Specify either the namespaces or the excludeNamespaces parameter, but not both. This property applies to the OKE cluster member in primary region.
Example: [“default”, “pv-nginx”]
- Returns
The namespaces of this UpdateOkeClusterBackupConfigDetails.
- Return type
list[str]
- property replicate_images¶
Gets the replicate_images of this UpdateOkeClusterBackupConfigDetails. Controls the behavior of image replication across regions. Image replication is enabled by default for DR Protection Groups. This setting applies to the OKE cluster member in the primary region, and to the standby region only if the image replication secret is stored in a vault instead of using the default secret.
Allowed values for this property are: “ENABLE”, “DISABLE”
- Returns
The replicate_images of this UpdateOkeClusterBackupConfigDetails.
- Return type
str