Package software.amazon.awscdk.services.backup

Class BackupPlanRuleProps.Builder

java.lang.Object

software.amazon.awscdk.services.backup.BackupPlanRuleProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<BackupPlanRuleProps>

Enclosing interface:

BackupPlanRuleProps

@Stability(Stable)
public static final class BackupPlanRuleProps.Builder
extends Object
implements software.amazon.jsii.Builder<BackupPlanRuleProps>

A builder for BackupPlanRuleProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BackupPlanRuleProps.Builder	backupVault(IBackupVault backupVault)	Sets the value of BackupPlanRuleProps.getBackupVault()
BackupPlanRuleProps	build()	Builds the configured instance.
BackupPlanRuleProps.Builder	completionWindow(Duration completionWindow)	Sets the value of BackupPlanRuleProps.getCompletionWindow()
BackupPlanRuleProps.Builder	copyActions(List<? extends BackupPlanCopyActionProps> copyActions)	Sets the value of BackupPlanRuleProps.getCopyActions()
BackupPlanRuleProps.Builder	deleteAfter(Duration deleteAfter)	Sets the value of BackupPlanRuleProps.getDeleteAfter()
BackupPlanRuleProps.Builder	enableContinuousBackup(Boolean enableContinuousBackup)	Sets the value of BackupPlanRuleProps.getEnableContinuousBackup()
BackupPlanRuleProps.Builder	moveToColdStorageAfter(Duration moveToColdStorageAfter)	Sets the value of BackupPlanRuleProps.getMoveToColdStorageAfter()
BackupPlanRuleProps.Builder	recoveryPointTags(Map<String,String> recoveryPointTags)	Sets the value of BackupPlanRuleProps.getRecoveryPointTags()
BackupPlanRuleProps.Builder	ruleName(String ruleName)	Sets the value of BackupPlanRuleProps.getRuleName()
BackupPlanRuleProps.Builder	scheduleExpression(Schedule scheduleExpression)	Sets the value of BackupPlanRuleProps.getScheduleExpression()
BackupPlanRuleProps.Builder	startWindow(Duration startWindow)	Sets the value of BackupPlanRuleProps.getStartWindow()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

backupVault

@Stability(Stable)
public BackupPlanRuleProps.Builder backupVault(IBackupVault backupVault)

Sets the value of BackupPlanRuleProps.getBackupVault()

Parameters:

backupVault - The backup vault where backups are.

Returns:

this

completionWindow

@Stability(Stable)
public BackupPlanRuleProps.Builder completionWindow(Duration completionWindow)

Sets the value of BackupPlanRuleProps.getCompletionWindow()

Parameters:

completionWindow - The duration after a backup job is successfully started before it must be completed or it is canceled by AWS Backup.

Returns:

this

copyActions

@Stability(Stable)
public BackupPlanRuleProps.Builder copyActions(List<? extends BackupPlanCopyActionProps> copyActions)

Sets the value of BackupPlanRuleProps.getCopyActions()

Parameters:

copyActions - Copy operations to perform on recovery points created by this rule.

Returns:

this

deleteAfter

@Stability(Stable)
public BackupPlanRuleProps.Builder deleteAfter(Duration deleteAfter)

Sets the value of BackupPlanRuleProps.getDeleteAfter()

Parameters:

deleteAfter - Specifies the duration after creation that a recovery point is deleted. Must be greater than moveToColdStorageAfter.

Returns:

this

enableContinuousBackup

@Stability(Stable)
public BackupPlanRuleProps.Builder enableContinuousBackup(Boolean enableContinuousBackup)

Sets the value of BackupPlanRuleProps.getEnableContinuousBackup()

Parameters:

enableContinuousBackup - Enables continuous backup and point-in-time restores (PITR). Property deleteAfter defines the retention period for the backup. It is mandatory if PITR is enabled. If no value is specified, the retention period is set to 35 days which is the maximum retention period supported by PITR.

Property moveToColdStorageAfter must not be specified because PITR does not support this option.

Returns:

this

moveToColdStorageAfter

@Stability(Stable)
public BackupPlanRuleProps.Builder moveToColdStorageAfter(Duration moveToColdStorageAfter)

Sets the value of BackupPlanRuleProps.getMoveToColdStorageAfter()

Parameters:

moveToColdStorageAfter - Specifies the duration after creation that a recovery point is moved to cold storage.

Returns:

this

recoveryPointTags

@Stability(Stable)
public BackupPlanRuleProps.Builder recoveryPointTags(Map<String,String> recoveryPointTags)

Sets the value of BackupPlanRuleProps.getRecoveryPointTags()

Parameters:

recoveryPointTags - To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

Returns:

this

ruleName

@Stability(Stable)
public BackupPlanRuleProps.Builder ruleName(String ruleName)

Sets the value of BackupPlanRuleProps.getRuleName()

Parameters:

ruleName - A display name for the backup rule.

Returns:

this

scheduleExpression

@Stability(Stable)
public BackupPlanRuleProps.Builder scheduleExpression(Schedule scheduleExpression)

Sets the value of BackupPlanRuleProps.getScheduleExpression()

Parameters:

scheduleExpression - A CRON expression specifying when AWS Backup initiates a backup job.

Returns:

this

startWindow

@Stability(Stable)
public BackupPlanRuleProps.Builder startWindow(Duration startWindow)

Sets the value of BackupPlanRuleProps.getStartWindow()

Parameters:

startWindow - The duration after a backup is scheduled before a job is canceled if it doesn't start successfully.

Returns:

this

build

@Stability(Stable)
public BackupPlanRuleProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of BackupPlanRuleProps

Throws:

NullPointerException - if any required attribute was not provided