BackupPlanRule.Builder

java.lang.Object
- software.amazon.awscdk.services.backup.BackupPlanRule.Builder

Enclosing class:: BackupPlanRule

public static final class BackupPlanRule.Builder
extends java.lang.Object

A fluent builder for BackupPlanRule.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BackupPlanRule.Builder`	`backupVault(IBackupVault backupVault)` The backup vault where backups are.
`BackupPlanRule`	`build()`
`BackupPlanRule.Builder`	`completionWindow(Duration completionWindow)` 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)` Specifies the duration after creation that a recovery point is deleted.
`BackupPlanRule.Builder`	`enableContinuousBackup(java.lang.Boolean enableContinuousBackup)` Enables continuous backup and point-in-time restores (PITR).
`BackupPlanRule.Builder`	`moveToColdStorageAfter(Duration moveToColdStorageAfter)` Specifies the duration after creation that a recovery point is moved to cold storage.
`BackupPlanRule.Builder`	`ruleName(java.lang.String ruleName)` A display name for the backup rule.
`BackupPlanRule.Builder`	`scheduleExpression(Schedule scheduleExpression)` A CRON expression specifying when AWS Backup initiates a backup job.
`BackupPlanRule.Builder`	`startWindow(Duration startWindow)` 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
```
public static BackupPlanRule.Builder create()
```
    Returns:
    
    a new instance of BackupPlanRule.Builder.
  - backupVault
```
public BackupPlanRule.Builder backupVault(IBackupVault backupVault)
```
    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
```
public BackupPlanRule.Builder completionWindow(Duration completionWindow)
```
    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
```
public BackupPlanRule.Builder deleteAfter(Duration deleteAfter)
```
    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
  - enableContinuousBackup
```
public BackupPlanRule.Builder enableContinuousBackup(java.lang.Boolean 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.
    Default: false
    
    Parameters:
    
    enableContinuousBackup - Enables continuous backup and point-in-time restores (PITR). This parameter is required.
    
    Returns:
    
    this
  - moveToColdStorageAfter
```
public BackupPlanRule.Builder moveToColdStorageAfter(Duration moveToColdStorageAfter)
```
    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
```
public BackupPlanRule.Builder ruleName(java.lang.String ruleName)
```
    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
```
public BackupPlanRule.Builder scheduleExpression(Schedule scheduleExpression)
```
    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
```
public BackupPlanRule.Builder startWindow(Duration startWindow)
```
    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
```
public BackupPlanRule build()
```

Class BackupPlanRule.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

backupVault

completionWindow

deleteAfter

enableContinuousBackup

moveToColdStorageAfter

ruleName

scheduleExpression

startWindow

build