Interface CfnBackupPlan.IBackupRuleResourceTypeProperty
Specifies an object containing properties used to schedule a task to back up a selection of resources.
Namespace: Amazon.CDK.AWS.Backup
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IBackupRuleResourceTypeProperty
Syntax (vb)
Public Interface IBackupRuleResourceTypeProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Backup;
var backupRuleResourceTypeProperty = new BackupRuleResourceTypeProperty {
RuleName = "ruleName",
TargetBackupVault = "targetBackupVault",
// the properties below are optional
CompletionWindowMinutes = 123,
CopyActions = new [] { new CopyActionResourceTypeProperty {
DestinationBackupVaultArn = "destinationBackupVaultArn",
// the properties below are optional
Lifecycle = new LifecycleResourceTypeProperty {
DeleteAfterDays = 123,
MoveToColdStorageAfterDays = 123,
OptInToArchiveForSupportedResources = false
}
} },
EnableContinuousBackup = false,
Lifecycle = new LifecycleResourceTypeProperty {
DeleteAfterDays = 123,
MoveToColdStorageAfterDays = 123,
OptInToArchiveForSupportedResources = false
},
RecoveryPointTags = new Dictionary<string, string> {
{ "recoveryPointTagsKey", "recoveryPointTags" }
},
ScheduleExpression = "scheduleExpression",
ScheduleExpressionTimezone = "scheduleExpressionTimezone",
StartWindowMinutes = 123
};
Synopsis
Properties
CompletionWindowMinutes | A value in minutes after a backup job is successfully started before it must be completed or it is canceled by AWS Backup . |
CopyActions | An array of CopyAction objects, which contains the details of the copy operation. |
EnableContinuousBackup | Enables continuous backup and point-in-time restores (PITR). |
Lifecycle | The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. |
RecoveryPointTags | To help organize your resources, you can assign your own metadata to the resources that you create. |
RuleName | A display name for a backup rule. |
ScheduleExpression | A CRON expression specifying when AWS Backup initiates a backup job. |
ScheduleExpressionTimezone | This is the timezone in which the schedule expression is set. |
StartWindowMinutes | An optional value that specifies a period of time in minutes after a backup is scheduled before a job is canceled if it doesn't start successfully. |
TargetBackupVault | The name of a logical container where backups are stored. |
Properties
CompletionWindowMinutes
A value in minutes after a backup job is successfully started before it must be completed or it is canceled by AWS Backup .
virtual Nullable<double> CompletionWindowMinutes { get; }
Property Value
System.Nullable<System.Double>
Remarks
CopyActions
An array of CopyAction objects, which contains the details of the copy operation.
virtual object CopyActions { get; }
Property Value
System.Object
Remarks
EnableContinuousBackup
Enables continuous backup and point-in-time restores (PITR).
virtual object EnableContinuousBackup { get; }
Property Value
System.Object
Remarks
Lifecycle
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.
virtual object Lifecycle { get; }
Property Value
System.Object
Remarks
AWS Backup transitions and expires backups automatically according to the lifecycle that you define.
RecoveryPointTags
To help organize your resources, you can assign your own metadata to the resources that you create.
virtual object RecoveryPointTags { get; }
Property Value
System.Object
Remarks
RuleName
A display name for a backup rule.
string RuleName { get; }
Property Value
System.String
Remarks
ScheduleExpression
A CRON expression specifying when AWS Backup initiates a backup job.
virtual string ScheduleExpression { get; }
Property Value
System.String
Remarks
ScheduleExpressionTimezone
This is the timezone in which the schedule expression is set.
virtual string ScheduleExpressionTimezone { get; }
Property Value
System.String
Remarks
By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
StartWindowMinutes
An optional value that specifies a period of time in minutes after a backup is scheduled before a job is canceled if it doesn't start successfully.
virtual Nullable<double> StartWindowMinutes { get; }
Property Value
System.Nullable<System.Double>
Remarks
If this value is included, it must be at least 60 minutes to avoid errors.
TargetBackupVault
The name of a logical container where backups are stored.
string TargetBackupVault { get; }
Property Value
System.String
Remarks
Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of letters, numbers, and hyphens.