Skip to content

BackupPlan

Source code in docs_src/capo_backup/types/backup_plan.py
class BackupPlan(TypedDict, closed=True):
    backup_plan_name: "capo_backup.types.backup_plan_name.BackupPlanName"
    """<p>The display name of a backup plan. Must contain only alphanumeric or '-_.' special characters.</p> <p>If this is set in the console, it can contain 1 to 50 characters; if this is set through CLI or API, it can contain 1 to 200 characters.</p>"""
    rules: "capo_backup.types.backup_rules.BackupRules"
    """<p>An array of <code>BackupRule</code> objects, each of which specifies a scheduled task that is used to back up a selection of resources. </p>"""
    advanced_backup_settings: NotRequired[
        "capo_backup.types.advanced_backup_settings.AdvancedBackupSettings"
    ]
    """<p>Contains a list of <code>BackupOptions</code> for each resource type.</p>"""
    scan_settings: NotRequired["capo_backup.types.scan_settings.ScanSettings"]
    """<p>Contains your scanning configuration for the backup plan and includes the Malware scanner, your selected resources, and scanner role.</p>"""

advanced_backup_settings instance-attribute

advanced_backup_settings: NotRequired[AdvancedBackupSettings]

Contains a list of BackupOptions for each resource type.

backup_plan_name instance-attribute

backup_plan_name: BackupPlanName

The display name of a backup plan. Must contain only alphanumeric or '-_.' special characters.

If this is set in the console, it can contain 1 to 50 characters; if this is set through CLI or API, it can contain 1 to 200 characters.

rules instance-attribute

rules: BackupRules

An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.

scan_settings instance-attribute

scan_settings: NotRequired[ScanSettings]

Contains your scanning configuration for the backup plan and includes the Malware scanner, your selected resources, and scanner role.