software.amazon.awscdk.services.backup

Interface BackupPlanProps

All Known Implementing Classes:

BackupPlanProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:37:02.394Z")
public interface BackupPlanProps

Properties for a BackupPlan.

Example:

 BackupPlan plan = BackupPlan.Builder.create(this, "Plan")
         .windowsVss(true)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BackupPlanProps.Builder A builder for BackupPlanProps
static class	BackupPlanProps.Jsii$Proxy An implementation for BackupPlanProps

Method Summary

Modifier and Type	Method and Description
static BackupPlanProps.Builder	builder()
default java.lang.String	getBackupPlanName() The display name of the backup plan.
default java.util.List<BackupPlanRule>	getBackupPlanRules() Rules for the backup plan.
default IBackupVault	getBackupVault() The backup vault where backups are stored.
default java.lang.Boolean	getWindowsVss() Enable Windows VSS backup.

Method Detail

getBackupPlanName

default java.lang.String getBackupPlanName()

The display name of the backup plan.

Default: - A CDK generated name

getBackupPlanRules

default java.util.List<BackupPlanRule> getBackupPlanRules()

Rules for the backup plan.

Use addRule() to add rules after instantiation.

Default: - use `addRule()` to add rules

getBackupVault

default IBackupVault getBackupVault()

The backup vault where backups are stored.

Default: - use the vault defined at the rule level. If not defined a new common vault for the plan will be created

getWindowsVss

default java.lang.Boolean getWindowsVss()

Enable Windows VSS backup.

Default: false

See Also:

https://docs.aws.amazon.com/aws-backup/latest/devguide/windows-backups.html

builder

static BackupPlanProps.Builder builder()

Returns:

a BackupPlanProps.Builder of BackupPlanProps