software.amazon.awscdk.services.backup

Class BackupPlanRule.Builder

java.lang.Object

software.amazon.awscdk.services.backup.BackupPlanRule.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<BackupPlanRule>

Enclosing class:

BackupPlanRule

@Stability(value=Experimental)
public static final class BackupPlanRule.Builder
extends Object
implements software.amazon.jsii.Builder<BackupPlanRule>

(experimental) A fluent builder for BackupPlanRule.

Method Summary

Modifier and Type	Method and Description
BackupPlanRule.Builder	backupVault(IBackupVault backupVault) (experimental) The backup vault where backups are.
BackupPlanRule	build()
BackupPlanRule.Builder	completionWindow(Duration completionWindow) (experimental) The duration after a backup job is successfully started before it must be completed or it is canceled by AWS Backup.
static BackupPlanRule.Builder	create()
BackupPlanRule.Builder	deleteAfter(Duration deleteAfter) (experimental) Specifies the duration after creation that a recovery point is deleted.
BackupPlanRule.Builder	moveToColdStorageAfter(Duration moveToColdStorageAfter) (experimental) Specifies the duration after creation that a recovery point is moved to cold storage.
BackupPlanRule.Builder	ruleName(String ruleName) (experimental) A display name for the backup rule.
BackupPlanRule.Builder	scheduleExpression(Schedule scheduleExpression) (experimental) A CRON expression specifying when AWS Backup initiates a backup job.
BackupPlanRule.Builder	startWindow(Duration startWindow) (experimental) The duration after a backup is scheduled before a job is canceled if it doesn't start successfully.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static BackupPlanRule.Builder create()

Returns:

a new instance of BackupPlanRule.Builder.

backupVault

@Stability(value=Experimental)
public BackupPlanRule.Builder backupVault(IBackupVault backupVault)

(experimental) The backup vault where backups are.

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

Parameters:

backupVault - The backup vault where backups are. This parameter is required.

Returns:

this

completionWindow

@Stability(value=Experimental)
public BackupPlanRule.Builder completionWindow(Duration completionWindow)

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

Default: - 8 hours

Parameters:

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

Returns:

this

deleteAfter

@Stability(value=Experimental)
public BackupPlanRule.Builder deleteAfter(Duration deleteAfter)

(experimental) Specifies the duration after creation that a recovery point is deleted.

Must be greater than moveToColdStorageAfter.

Default: - recovery point is never deleted

Parameters:

deleteAfter - Specifies the duration after creation that a recovery point is deleted. This parameter is required.

Returns:

this

moveToColdStorageAfter

@Stability(value=Experimental)
public BackupPlanRule.Builder moveToColdStorageAfter(Duration moveToColdStorageAfter)

(experimental) Specifies the duration after creation that a recovery point is moved to cold storage.

Default: - recovery point is never moved to cold storage

Parameters:

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

Returns:

this

ruleName

@Stability(value=Experimental)
public BackupPlanRule.Builder ruleName(String ruleName)

(experimental) A display name for the backup rule.

Default: - a CDK generated name

Parameters:

ruleName - A display name for the backup rule. This parameter is required.

Returns:

this

scheduleExpression

@Stability(value=Experimental)
public BackupPlanRule.Builder scheduleExpression(Schedule scheduleExpression)

(experimental) A CRON expression specifying when AWS Backup initiates a backup job.

Default: - no schedule

Parameters:

scheduleExpression - A CRON expression specifying when AWS Backup initiates a backup job. This parameter is required.

Returns:

this

startWindow

@Stability(value=Experimental)
public BackupPlanRule.Builder startWindow(Duration startWindow)

(experimental) The duration after a backup is scheduled before a job is canceled if it doesn't start successfully.

Default: - 8 hours

Parameters:

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

Returns:

this

build

@Stability(value=Experimental)
public BackupPlanRule build()

Specified by:

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