Interface IBackupPlanRuleProps
Properties for a BackupPlanRule.
Namespace: Amazon.CDK.AWS.Backup
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IBackupPlanRulePropsSyntax (vb)
Public Interface IBackupPlanRulePropsRemarks
ExampleMetadata: infused
Examples
BackupPlan plan;
BackupVault secondaryVault;
plan.AddRule(new BackupPlanRule(new BackupPlanRuleProps {
CopyActions = new [] { new BackupPlanCopyActionProps {
DestinationBackupVault = secondaryVault,
MoveToColdStorageAfter = Duration.Days(30),
DeleteAfter = Duration.Days(120)
} }
}));Synopsis
Properties
| BackupVault | The backup vault where backups are. |
| CompletionWindow | The duration after a backup job is successfully started before it must be completed or it is canceled by AWS Backup. |
| CopyActions | Copy operations to perform on recovery points created by this rule. |
| DeleteAfter | Specifies the duration after creation that a recovery point is deleted. |
| EnableContinuousBackup | Enables continuous backup and point-in-time restores (PITR). |
| MoveToColdStorageAfter | Specifies the duration after creation that a recovery point is moved to cold storage. |
| RecoveryPointTags | To help organize your resources, you can assign your own metadata to the resources that you create. |
| RuleName | A display name for the backup rule. |
| ScheduleExpression | A CRON expression specifying when AWS Backup initiates a backup job. |
| ScheduleExpressionTimezone | The timezone in which the schedule expression is set. |
| StartWindow | The duration after a backup is scheduled before a job is canceled if it doesn't start successfully. |
Properties
BackupVault
The backup vault where backups are.
IBackupVaultRef? BackupVault { get; }Property Value
Remarks
Default: - use the vault defined at the plan level. If not defined a new common vault for the plan will be created
CompletionWindow
The duration after a backup job is successfully started before it must be completed or it is canceled by AWS Backup.
Duration? CompletionWindow { get; }Property Value
Remarks
Default: - 7 days
CopyActions
Copy operations to perform on recovery points created by this rule.
IBackupPlanCopyActionProps[]? CopyActions { get; }Property Value
Remarks
Default: - no copy actions
DeleteAfter
Specifies the duration after creation that a recovery point is deleted.
Duration? DeleteAfter { get; }Property Value
Remarks
Must be greater than moveToColdStorageAfter.
Default: - recovery point is never deleted
EnableContinuousBackup
Enables continuous backup and point-in-time restores (PITR).
bool? EnableContinuousBackup { get; }Property Value
bool?
Remarks
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
MoveToColdStorageAfter
Specifies the duration after creation that a recovery point is moved to cold storage.
Duration? MoveToColdStorageAfter { get; }Property Value
Remarks
Default: - recovery point is never moved to cold storage
RecoveryPointTags
To help organize your resources, you can assign your own metadata to the resources that you create.
IDictionary<string, string>? RecoveryPointTags { get; }Property Value
Remarks
Each tag is a key-value pair.
Default: - no recovery point tags.
RuleName
A display name for the backup rule.
string? RuleName { get; }Property Value
Remarks
Default: - a CDK generated name
ScheduleExpression
A CRON expression specifying when AWS Backup initiates a backup job.
Schedule? ScheduleExpression { get; }Property Value
Remarks
Default: - no schedule
ScheduleExpressionTimezone
The timezone in which the schedule expression is set.
TimeZone? ScheduleExpressionTimezone { get; }Property Value
Remarks
Default: - UTC
StartWindow
The duration after a backup is scheduled before a job is canceled if it doesn't start successfully.
Duration? StartWindow { get; }Property Value
Remarks
Default: - 8 hours