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.
Contains detailed information about a backup job.
Namespace: Amazon.Backup.Model
Assembly: AWSSDK.Backup.dll
Version: 3.x.y.z
public class BackupJob
The BackupJob type exposes the following members
Name | Description | |
---|---|---|
BackupJob() |
Name | Type | Description | |
---|---|---|---|
AccountId | System.String |
Gets and sets the property AccountId. The account ID that owns the backup job. |
|
BackupJobId | System.String |
Gets and sets the property BackupJobId. Uniquely identifies a request to Backup to back up a resource. |
|
BackupOptions | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property BackupOptions. Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
Valid values: Set to |
|
BackupSizeInBytes | System.Int64 |
Gets and sets the property BackupSizeInBytes. The size, in bytes, of a backup. |
|
BackupType | System.String |
Gets and sets the property BackupType. Represents the type of backup for a backup job. |
|
BackupVaultArn | System.String |
Gets and sets the property BackupVaultArn.
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
|
|
BackupVaultName | System.String |
Gets and sets the property BackupVaultName. 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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens. |
|
BytesTransferred | System.Int64 |
Gets and sets the property BytesTransferred. The size in bytes transferred to a backup vault at the time that the job status was queried. |
|
CompletionDate | System.DateTime |
Gets and sets the property CompletionDate.
The date and time a job to create a backup job is completed, in Unix format and Coordinated
Universal Time (UTC). The value of |
|
CreatedBy | Amazon.Backup.Model.RecoveryPointCreator |
Gets and sets the property CreatedBy.
Contains identifying information about the creation of a backup job, including the
|
|
CreationDate | System.DateTime |
Gets and sets the property CreationDate.
The date and time a backup job is created, in Unix format and Coordinated Universal
Time (UTC). The value of |
|
ExpectedCompletionDate | System.DateTime |
Gets and sets the property ExpectedCompletionDate.
The date and time a job to back up resources is expected to be completed, in Unix
format and Coordinated Universal Time (UTC). The value of |
|
IamRoleArn | System.String |
Gets and sets the property IamRoleArn.
Specifies the IAM role ARN used to create the target recovery point. IAM roles other
than the default role must include either |
|
InitiationDate | System.DateTime |
Gets and sets the property InitiationDate. This is the date on which the backup job was initiated. |
|
IsParent | System.Boolean |
Gets and sets the property IsParent. This is a boolean value indicating this is a parent (composite) backup job. |
|
MessageCategory | System.String |
Gets and sets the property MessageCategory. This parameter is the job count for the specified message category.
Example strings may include The the value ANY returns count of all message categories.
|
|
ParentJobId | System.String |
Gets and sets the property ParentJobId. This uniquely identifies a request to Backup to back up a resource. The return will be the parent (composite) job ID. |
|
PercentDone | System.String |
Gets and sets the property PercentDone. Contains an estimated percentage complete of a job at the time the job status was queried. |
|
RecoveryPointArn | System.String |
Gets and sets the property RecoveryPointArn.
An ARN that uniquely identifies a recovery point; for example, |
|
ResourceArn | System.String |
Gets and sets the property ResourceArn. An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type. |
|
ResourceName | System.String |
Gets and sets the property ResourceName. This is the non-unique name of the resource that belongs to the specified backup. |
|
ResourceType | System.String |
Gets and sets the property ResourceType. The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2. |
|
StartBy | System.DateTime |
Gets and sets the property StartBy.
Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup
job must be started before it is canceled. The value is calculated by adding the start
window to the scheduled time. So if the scheduled time were 6:00 PM and the start
window is 2 hours, the |
|
State | Amazon.Backup.BackupJobState |
Gets and sets the property State. The current state of a backup job. |
|
StatusMessage | System.String |
Gets and sets the property StatusMessage. A detailed message explaining the status of the job to back up a resource. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5