Class BackupPlan.Builder
java.lang.Object
software.amazon.awscdk.services.backup.BackupPlan.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<BackupPlan>
- Enclosing class:
- BackupPlan
@Stability(Stable)
public static final class BackupPlan.Builder
extends Object
implements software.amazon.jsii.Builder<BackupPlan>
A fluent builder for
BackupPlan
.-
Method Summary
Modifier and TypeMethodDescriptionbackupPlanName
(String backupPlanName) The display name of the backup plan.backupPlanRules
(List<? extends BackupPlanRule> backupPlanRules) Rules for the backup plan.backupVault
(IBackupVault backupVault) The backup vault where backups are stored.build()
static BackupPlan.Builder
windowsVss
(Boolean windowsVss) Enable Windows VSS backup.
-
Method Details
-
create
@Stability(Stable) public static BackupPlan.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- This parameter is required.id
- This parameter is required.- Returns:
- a new instance of
BackupPlan.Builder
.
-
backupPlanName
The display name of the backup plan.Default: - A CDK generated name
- Parameters:
backupPlanName
- The display name of the backup plan. This parameter is required.- Returns:
this
-
backupPlanRules
@Stability(Stable) public BackupPlan.Builder backupPlanRules(List<? extends BackupPlanRule> backupPlanRules) Rules for the backup plan.Use
addRule()
to add rules after instantiation.Default: - use `addRule()` to add rules
- Parameters:
backupPlanRules
- Rules for the backup plan. This parameter is required.- Returns:
this
-
backupVault
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
- Parameters:
backupVault
- The backup vault where backups are stored. This parameter is required.- Returns:
this
-
windowsVss
Enable Windows VSS backup.Default: false
- Parameters:
windowsVss
- Enable Windows VSS backup. This parameter is required.- Returns:
this
- See Also:
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<BackupPlan>
- Returns:
- a newly built instance of
BackupPlan
.
-