Skip to content

BackupPlanInput

Source code in docs_src/capo_backup/types/backup_plan_input.py
class BackupPlanInput(TypedDict, closed=True):
    backup_plan_name: "capo_backup.types.backup_plan_name.BackupPlanName"
    """<p>The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.</p>"""
    rules: "capo_backup.types.backup_rules_input.BackupRulesInput"
    """<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>Specifies a list of <code>BackupOptions</code> for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.</p>"""
    scan_settings: NotRequired["capo_backup.types.scan_settings.ScanSettings"]
    """<p>Contains your scanning configuration for the backup rule and includes the malware scanner, and scan mode of either full or incremental.</p>"""

advanced_backup_settings instance-attribute

advanced_backup_settings: NotRequired[AdvancedBackupSettings]

Specifies a list of BackupOptions for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

backup_plan_name instance-attribute

backup_plan_name: BackupPlanName

The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.

rules instance-attribute

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 rule and includes the malware scanner, and scan mode of either full or incremental.