Package software.amazon.awscdk.services.backup

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 Type	Method	Description
BackupPlan.Builder	backupPlanName(String backupPlanName)	The display name of the backup plan.
BackupPlan.Builder	backupPlanRules(List<? extends BackupPlanRule> backupPlanRules)	Rules for the backup plan.
BackupPlan.Builder	backupVault(IBackupVault backupVault)	The backup vault where backups are stored.
BackupPlan	build()
static BackupPlan.Builder	create(software.constructs.Construct scope, String id)
BackupPlan.Builder	windowsVss(Boolean windowsVss)	Enable Windows VSS backup.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

@Stability(Stable)
public BackupPlan.Builder backupPlanName(String 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

@Stability(Stable)
public BackupPlan.Builder backupVault(IBackupVault 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

@Stability(Stable)
public BackupPlan.Builder windowsVss(Boolean windowsVss)

Enable Windows VSS backup.

Default: false

Parameters:

windowsVss - Enable Windows VSS backup. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public BackupPlan build()

Specified by:

build in interface software.amazon.jsii.Builder<BackupPlan>

Returns:

a newly built instance of BackupPlan.