OkeClusterBackupConfig¶

class oci.disaster_recovery.models.OkeClusterBackupConfig(**kwargs)¶

Bases: object

The details of backup performed on OKE Cluster.

Attributes

`REPLICATE_IMAGES_DISABLE`	A constant which can be used with the replicate_images property of a OkeClusterBackupConfig.
`REPLICATE_IMAGES_ENABLE`	A constant which can be used with the replicate_images property of a OkeClusterBackupConfig.
`backup_schedule`	Gets the backup_schedule of this OkeClusterBackupConfig.
`image_replication_vault_secret_id`	Gets the image_replication_vault_secret_id of this OkeClusterBackupConfig.
`max_number_of_backups_retained`	Gets the max_number_of_backups_retained of this OkeClusterBackupConfig.
`namespaces`	Gets the namespaces of this OkeClusterBackupConfig.
`replicate_images`	Gets the replicate_images of this OkeClusterBackupConfig.

Methods

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

REPLICATE_IMAGES_DISABLE = 'DISABLE'¶: A constant which can be used with the replicate_images property of a OkeClusterBackupConfig. This constant has a value of “DISABLE”

REPLICATE_IMAGES_ENABLE = 'ENABLE'¶: A constant which can be used with the replicate_images property of a OkeClusterBackupConfig. This constant has a value of “ENABLE”

__init__(**kwargs)¶

Initializes a new OkeClusterBackupConfig 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 OkeClusterBackupConfig.
backup_schedule (str) – The value to assign to the backup_schedule property of this OkeClusterBackupConfig.
replicate_images (str) – The value to assign to the replicate_images property of this OkeClusterBackupConfig. Allowed values for this property are: “ENABLE”, “DISABLE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
max_number_of_backups_retained (int) – The value to assign to the max_number_of_backups_retained property of this OkeClusterBackupConfig.
image_replication_vault_secret_id (str) – The value to assign to the image_replication_vault_secret_id property of this OkeClusterBackupConfig.

backup_schedule¶

Gets the backup_schedule of this OkeClusterBackupConfig. The schedule for backing up namespaces to the destination region. If a backup schedule is not specified, only a single backup will be created. This format of the string specifying the backup schedule 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 OkeClusterBackupConfig.
Return type:	str

image_replication_vault_secret_id¶

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

max_number_of_backups_retained¶

Gets the max_number_of_backups_retained of this OkeClusterBackupConfig. 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 OkeClusterBackupConfig.
Return type:	int

namespaces¶

Gets the namespaces of this OkeClusterBackupConfig. A list of namespaces that need to be backed up. The default value is null. If a list of namespaces is not provided, all namespaces will be backed up. This property applies to the OKE cluster member in primary region.

Example: [“default”, “pv-nginx”]

Returns:	The namespaces of this OkeClusterBackupConfig.
Return type:	list[str]

replicate_images¶

Gets the replicate_images of this OkeClusterBackupConfig. Controls the behaviour of image replication across regions. This property applies to the OKE cluster member in primary region.

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

Returns:	The replicate_images of this OkeClusterBackupConfig.
Return type:	str