software.amazon.awscdk.services.backup

Interface BackupPlanProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

BackupPlanProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.848Z")
 @Stability(value=Stable)
public interface BackupPlanProps
extends software.amazon.jsii.JsiiSerializable

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 String	getBackupPlanName() The display name of the backup plan.
default List<BackupPlanRule>	getBackupPlanRules() Rules for the backup plan.
default IBackupVault	getBackupVault() The backup vault where backups are stored.
default Boolean	getWindowsVss() Enable Windows VSS backup.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBackupPlanName

@Stability(value=Stable)
 @Nullable
default String getBackupPlanName()

The display name of the backup plan.

Default: - A CDK generated name

getBackupPlanRules

@Stability(value=Stable)
 @Nullable
default List<BackupPlanRule> getBackupPlanRules()

Rules for the backup plan.

Use addRule() to add rules after instantiation.

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

getBackupVault

@Stability(value=Stable)
 @Nullable
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

@Stability(value=Stable)
 @Nullable
default Boolean getWindowsVss()

Enable Windows VSS backup.

Default: false

See Also:

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

builder

@Stability(value=Stable)
static BackupPlanProps.Builder builder()

Returns:

a BackupPlanProps.Builder of BackupPlanProps