AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Specifies a scheduled task used to back up a selection of resources.

Inheritance Hierarchy

System.Object
  Amazon.Backup.Model.BackupRule

Namespace: Amazon.Backup.Model
Assembly: AWSSDK.Backup.dll
Version: 3.x.y.z

Syntax

C#
public class BackupRule

The BackupRule type exposes the following members

Constructors

NameDescription
Public Method BackupRule()

Properties

NameTypeDescription
Public Property CompletionWindowMinutes System.Int64

Gets and sets the property CompletionWindowMinutes.

A value in minutes after a backup job is successfully started before it must be completed or it is canceled by AWS Backup. This value is optional.

Public Property CopyActions System.Collections.Generic.List<Amazon.Backup.Model.CopyAction>

Gets and sets the property CopyActions.

An array of CopyAction objects, which contains the details of the copy operation.

Public Property Lifecycle Amazon.Backup.Model.Lifecycle

Gets and sets the property Lifecycle.

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

Public Property RecoveryPointTags System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property RecoveryPointTags.

An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.

Public Property RuleId System.String

Gets and sets the property RuleId.

Uniquely identifies a rule that is used to schedule the backup of a selection of resources.

Public Property RuleName System.String

Gets and sets the property RuleName.

An optional display name for a backup rule.

Public Property ScheduleExpression System.String

Gets and sets the property ScheduleExpression.

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

Public Property StartWindowMinutes System.Int64

Gets and sets the property 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.

Public Property TargetBackupVaultName System.String

Gets and sets the property TargetBackupVaultName.

The name of a logical container where backups are stored. 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 lowercase letters, numbers, and hyphens.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms