You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Backup::Types::DescribeBackupJobOutput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#backup_job_idString

Uniquely identifies a request to AWS Backup to back up a resource.

Returns:

  • (String)

    Uniquely identifies a request to AWS Backup to back up a resource.

#backup_size_in_bytesInteger

The size, in bytes, of a backup.

Returns:

  • (Integer)

    The size, in bytes, of a backup.

#backup_vault_arnString

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

Returns:

  • (String)

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

#backup_vault_nameString

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.

Returns:

  • (String)

    The name of a logical container where backups are stored.

#bytes_transferredInteger

The size in bytes transferred to a backup vault at the time that the job status was queried.

Returns:

  • (Integer)

    The size in bytes transferred to a backup vault at the time that the job status was queried.

#completion_dateTime

The date and time that a job to create a backup job is completed, 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.

Returns:

  • (Time)

    The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC).

#created_byTypes::RecoveryPointCreator

Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.

Returns:

  • (Types::RecoveryPointCreator)

    Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.

#creation_dateTime

The date and time that 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.

Returns:

  • (Time)

    The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC).

#expected_completion_dateTime

The date and time that 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.

Returns:

  • (Time)

    The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC).

#iam_role_arnString

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

Returns:

  • (String)

    Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

#percent_doneString

Contains an estimated percentage that is complete of a job at the time the job status was queried.

Returns:

  • (String)

    Contains an estimated percentage that is complete of a job at the time the job status was queried.

#recovery_point_arnString

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

Returns:

  • (String)

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

#resource_arnString

An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.

Returns:

  • (String)

    An ARN that uniquely identifies a saved resource.

#resource_typeString

The type of AWS resource to be backed-up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

Returns:

  • (String)

    The type of AWS resource to be backed-up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

#start_byTime

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.

Returns:

  • (Time)

    Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled.

#stateString

The current state of a resource recovery point.

Possible values:

  • CREATED
  • PENDING
  • RUNNING
  • ABORTING
  • ABORTED
  • COMPLETED
  • FAILED
  • EXPIRED

Returns:

  • (String)

    The current state of a resource recovery point.

#status_messageString

A detailed message explaining the status of the job to back up a resource.

Returns:

  • (String)

    A detailed message explaining the status of the job to back up a resource.