CreateOkeClusterBackupConfigDetails¶

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

Bases: object

Create backup configuration properties for an OKE member.

Attributes

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

Methods

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

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

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

__init__(**kwargs)¶

Initializes a new CreateOkeClusterBackupConfigDetails 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 CreateOkeClusterBackupConfigDetails.
backup_schedule (str) – The value to assign to the backup_schedule property of this CreateOkeClusterBackupConfigDetails.
replicate_images (str) – The value to assign to the replicate_images property of this CreateOkeClusterBackupConfigDetails. 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 CreateOkeClusterBackupConfigDetails.
image_replication_vault_secret_id (str) – The value to assign to the image_replication_vault_secret_id property of this CreateOkeClusterBackupConfigDetails.

backup_schedule¶

Gets the backup_schedule of this CreateOkeClusterBackupConfigDetails. 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 (see examples below). This schedule will use the UTC timezone. This property applies to the OKE cluster member in primary region.

The backup frequency can be HOURLY, DAILY, WEEKLY or MONTHLY, and the upper and lower interval bounds are as follows

HOURLY

Minimum = 1
Maximum = 24

DAILY

Minimum = 1
Maximum = 30

WEEKLY

Minimum = 1
Maximum = 1

MONTHLY

Minimum = 1
Maximum = 12

Examples:

FREQ=WEEKLY;BYDAY=MO,WE;BYHOUR=10;INTERVAL=1 -> Run a backup every week on monday and wednesday at 10:00 AM. FREQ=WEEKLY;BYDAY=MO,WE;BYHOUR=10;INTERVAL=2 -> Invalid configuration (can not specify interval of 2).

FREQ=HOURLY;INTERVAL=25 -> Invalid configuration (can not specify interval of 25). FREQ=HOURLY;INTERVAL=0 -> Invalid configuration (can not specify interval of 0). FREQ=HOURLY;INTERVAL=24 -> Run a backup every 24 hours. FREQ=HOURLY;INTERVAL=1 -> Run a backup every hour. FREQ=HOURLY;BYMINUTE=30;INTERVAL=15 -> Run a backup every 15 hours at the 30th minute.

FREQ=DAILY;INTERVAL=31 -> Invalid configuration (can not specify interval of 31). FREQ=DAILY;INTERVAL=0 -> Invalid configuration (can not specify interval of 0). FREQ=DAILY;INTERVAL=30 -> Run a backup every 30 days at 12:00 midnight. FREQ=DAILY;BYHOUR=17;BYMINUTE=10;INTERVAL=1 -> Run a backup every day at 05:10 PM.

Returns:	The backup_schedule of this CreateOkeClusterBackupConfigDetails.
Return type:	str

image_replication_vault_secret_id¶

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

max_number_of_backups_retained¶

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

namespaces¶

Gets the namespaces of this CreateOkeClusterBackupConfigDetails. 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 CreateOkeClusterBackupConfigDetails.
Return type:	list[str]

replicate_images¶

Gets the replicate_images of this CreateOkeClusterBackupConfigDetails. Controls the behaviour of image replication across regions. Image replication is enabled by default for DR Protection Groups with a primary role. This property applies to the OKE cluster member in primary region.

Allowed values for this property are: “ENABLE”, “DISABLE”

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