Class: Aws::Backup::Types::BackupJob

Inherits:

Struct

• Object
• Struct
• Aws::Backup::Types::BackupJob

Defined in:

gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb

Overview

Contains detailed information about a backup job.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #account_id ⇒ String

  The account ID that owns the backup job.

• #backup_job_id ⇒ String

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

• #backup_options ⇒ Hash<String,String>

  Specifies the backup option for a selected resource.

• #backup_size_in_bytes ⇒ Integer

  The size, in bytes, of a backup.

• #backup_type ⇒ String

  Represents the type of backup for a backup job.

• #backup_vault_arn ⇒ 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_name ⇒ String

  The name of a logical container where backups are stored.

• #bytes_transferred ⇒ Integer

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

• #completion_date ⇒ Time

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

• #created_by ⇒ Types::RecoveryPointCreator

  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.

• #creation_date ⇒ Time

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

• #expected_completion_date ⇒ Time

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

• #iam_role_arn ⇒ String

  Specifies the IAM role ARN used to create the target recovery point.

• #is_parent ⇒ Boolean

  This is a boolean value indicating this is a parent (composite) backup job.

• #parent_job_id ⇒ String

  This uniquely identifies a request to Backup to back up a resource.

• #percent_done ⇒ String

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

• #recovery_point_arn ⇒ 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_arn ⇒ String

  An ARN that uniquely identifies a resource.

• #resource_type ⇒ String

  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.

• #start_by ⇒ Time

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

• #state ⇒ String

  The current state of a resource recovery point.

• #status_message ⇒ String

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

Instance Attribute Details

#account_id ⇒ String

The account ID that owns the backup job.

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 233

class BackupJob < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :expected_completion_date,
  :start_by,
  :resource_type,
  :bytes_transferred,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent)
  SENSITIVE = []
  include Aws::Structure
end

#backup_job_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 233

class BackupJob < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :expected_completion_date,
  :start_by,
  :resource_type,
  :bytes_transferred,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent)
  SENSITIVE = []
  include Aws::Structure
end

#backup_options ⇒ Hash<String,String>

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.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 233

class BackupJob < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :expected_completion_date,
  :start_by,
  :resource_type,
  :bytes_transferred,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent)
  SENSITIVE = []
  include Aws::Structure
end

#backup_size_in_bytes ⇒ Integer

The size, in bytes, of a backup.

Returns:

• (Integer)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 233

class BackupJob < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :expected_completion_date,
  :start_by,
  :resource_type,
  :bytes_transferred,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent)
  SENSITIVE = []
  include Aws::Structure
end

#backup_type ⇒ String

Represents the type of backup for a backup job.

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 233

class BackupJob < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :expected_completion_date,
  :start_by,
  :resource_type,
  :bytes_transferred,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent)
  SENSITIVE = []
  include Aws::Structure
end

#backup_vault_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 233

class BackupJob < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :expected_completion_date,
  :start_by,
  :resource_type,
  :bytes_transferred,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent)
  SENSITIVE = []
  include Aws::Structure
end

#backup_vault_name ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 233

class BackupJob < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :expected_completion_date,
  :start_by,
  :resource_type,
  :bytes_transferred,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent)
  SENSITIVE = []
  include Aws::Structure
end

#bytes_transferred ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 233

class BackupJob < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :expected_completion_date,
  :start_by,
  :resource_type,
  :bytes_transferred,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent)
  SENSITIVE = []
  include Aws::Structure
end

#completion_date ⇒ Time

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.

Returns:

• (Time)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 233

class BackupJob < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :expected_completion_date,
  :start_by,
  :resource_type,
  :bytes_transferred,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent)
  SENSITIVE = []
  include Aws::Structure
end

#created_by ⇒ Types::RecoveryPointCreator

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.

Returns:

• (Types::RecoveryPointCreator)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 233

class BackupJob < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :expected_completion_date,
  :start_by,
  :resource_type,
  :bytes_transferred,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date ⇒ Time

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.

Returns:

• (Time)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 233

class BackupJob < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :expected_completion_date,
  :start_by,
  :resource_type,
  :bytes_transferred,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent)
  SENSITIVE = []
  include Aws::Structure
end

#expected_completion_date ⇒ Time

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.

Returns:

• (Time)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 233

class BackupJob < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :expected_completion_date,
  :start_by,
  :resource_type,
  :bytes_transferred,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent)
  SENSITIVE = []
  include Aws::Structure
end

#iam_role_arn ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 233

class BackupJob < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :expected_completion_date,
  :start_by,
  :resource_type,
  :bytes_transferred,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent)
  SENSITIVE = []
  include Aws::Structure
end

#is_parent ⇒ Boolean

This is a boolean value indicating this is a parent (composite) backup job.

Returns:

• (Boolean)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 233

class BackupJob < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :expected_completion_date,
  :start_by,
  :resource_type,
  :bytes_transferred,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent)
  SENSITIVE = []
  include Aws::Structure
end

#parent_job_id ⇒ String

This uniquely identifies a request to Backup to back up a resource. The return will be the parent (composite) job ID.

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 233

class BackupJob < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :expected_completion_date,
  :start_by,
  :resource_type,
  :bytes_transferred,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent)
  SENSITIVE = []
  include Aws::Structure
end

#percent_done ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 233

class BackupJob < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :expected_completion_date,
  :start_by,
  :resource_type,
  :bytes_transferred,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent)
  SENSITIVE = []
  include Aws::Structure
end

#recovery_point_arn ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 233

class BackupJob < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :expected_completion_date,
  :start_by,
  :resource_type,
  :bytes_transferred,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 233

class BackupJob < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :expected_completion_date,
  :start_by,
  :resource_type,
  :bytes_transferred,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 233

class BackupJob < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :expected_completion_date,
  :start_by,
  :resource_type,
  :bytes_transferred,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent)
  SENSITIVE = []
  include Aws::Structure
end

#start_by ⇒ Time

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)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 233

class BackupJob < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :expected_completion_date,
  :start_by,
  :resource_type,
  :bytes_transferred,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The current state of a resource recovery point.

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 233

class BackupJob < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :expected_completion_date,
  :start_by,
  :resource_type,
  :bytes_transferred,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent)
  SENSITIVE = []
  include Aws::Structure
end

#status_message ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 233

class BackupJob < Struct.new(
  :account_id,
  :backup_job_id,
  :backup_vault_name,
  :backup_vault_arn,
  :recovery_point_arn,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :percent_done,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :expected_completion_date,
  :start_by,
  :resource_type,
  :bytes_transferred,
  :backup_options,
  :backup_type,
  :parent_job_id,
  :is_parent)
  SENSITIVE = []
  include Aws::Structure
end