class Aws::Backup::Types::BackupJob

Contains detailed information about a backup job.

@!attribute [rw] account_id

The account ID that owns the backup job.
@return [String]

@!attribute [rw] backup_job_id

Uniquely identifies a request to Backup to back up a resource.
@return [String]

@!attribute [rw] backup_vault_name

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.
@return [String]

@!attribute [rw] backup_vault_arn

An Amazon Resource Name (ARN) that uniquely identifies a backup
vault; for example,
`arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
@return [String]

@!attribute [rw] recovery_point_arn

An ARN that uniquely identifies a recovery point; for example,
`arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
@return [String]

@!attribute [rw] resource_arn

An ARN that uniquely identifies a resource. The format of the ARN
depends on the resource type.
@return [String]

@!attribute [rw] creation_date

The date and time a backup job is created, in Unix format and
Coordinated Universal Time (UTC). The value of `CreationDate` is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
@return [Time]

@!attribute [rw] completion_date

The date and time a job to create a backup job is completed, in Unix
format and Coordinated Universal Time (UTC). The value of
`CompletionDate` is accurate to milliseconds. For example, the value
1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
@return [Time]

@!attribute [rw] state

The current state of a resource recovery point.
@return [String]

@!attribute [rw] status_message

A detailed message explaining the status of the job to back up a
resource.
@return [String]

@!attribute [rw] percent_done

Contains an estimated percentage complete of a job at the time the
job status was queried.
@return [String]

@!attribute [rw] backup_size_in_bytes

The size, in bytes, of a backup.
@return [Integer]

@!attribute [rw] iam_role_arn

Specifies the IAM role ARN used to create the target recovery point.
IAM roles other than the default role must include either
`AWSBackup` or `AwsBackup` in the role name. For example,
`arn:aws:iam::123456789012:role/AWSBackupRDSAccess`. Role names
without those strings lack permissions to perform backup jobs.
@return [String]

@!attribute [rw] created_by

Contains identifying information about the creation of a backup job,
including the `BackupPlanArn`, `BackupPlanId`, `BackupPlanVersion`,
and `BackupRuleId` of the backup plan used to create it.
@return [Types::RecoveryPointCreator]

@!attribute [rw] expected_completion_date

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 `ExpectedCompletionDate` is accurate to milliseconds. For
example, the value 1516925490.087 represents Friday, January 26,
2018 12:11:30.087 AM.
@return [Time]

@!attribute [rw] start_by

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 `StartBy` time would be 8:00 PM on the date specified.
The value of `StartBy` is accurate to milliseconds. For example, the
value 1516925490.087 represents Friday, January 26, 2018
12:11:30.087 AM.
@return [Time]

@!attribute [rw] resource_type

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.
@return [String]

@!attribute [rw] bytes_transferred

The size in bytes transferred to a backup vault at the time that the
job status was queried.
@return [Integer]

@!attribute [rw] backup_options

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 `"WindowsVSS":"enabled"` to enable the
`WindowsVSS` backup option and create a Windows VSS backup. Set to
`"WindowsVSS":"disabled"` to create a regular backup. If you specify
an invalid option, you get an `InvalidParameterValueException`
exception.
@return [Hash<String,String>]

@!attribute [rw] backup_type

Represents the type of backup for a backup job.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupJob AWS API Documentation

Constants

SENSITIVE