Class: Aws::Backup::Types::CopyJob

Inherits:

Struct

Object
Struct
Aws::Backup::Types::CopyJob

show all

Includes:: Structure

Defined in:: lib/aws-sdk-backup/types.rb

Overview

Contains detailed information about a copy job.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#account_id ⇒ String

The account ID that owns the copy job.
#backup_size_in_bytes ⇒ Integer

The size, in bytes, of a copy job.
#child_jobs_in_state ⇒ Hash<String,Integer>

This returns the statistics of the included child (nested) copy jobs.
#completion_date ⇒ Time

The date and time a copy job is completed, in Unix format and Coordinated Universal Time (UTC).
#composite_member_identifier ⇒ String

The identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack.
#copy_job_id ⇒ String

Uniquely identifies a copy job.
#created_by ⇒ Types::RecoveryPointCreator

Contains information about the backup plan and rule that Backup used to initiate the recovery point backup.
#created_by_backup_job_id ⇒ String

The backup job ID that initiated this copy job.
#creation_date ⇒ Time

The date and time a copy job is created, in Unix format and Coordinated Universal Time (UTC).
#destination_backup_vault_arn ⇒ String

An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, ‘arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
#destination_encryption_key_arn ⇒ String

The Amazon Resource Name (ARN) of the KMS key used to encrypt the copied backup in the destination vault.
#destination_recovery_point_arn ⇒ String

An ARN that uniquely identifies a destination recovery point; for example, ‘arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
#destination_recovery_point_lifecycle ⇒ Types::Lifecycle

Specifies the time period, in days, before a recovery point transitions to cold storage or is deleted.
#destination_vault_lock_state ⇒ String

The lock state of the destination backup vault.
#destination_vault_type ⇒ String

The type of destination backup vault where the copied recovery point is stored.
#iam_role_arn ⇒ String

Specifies the IAM role ARN used to copy the target recovery point; for example, ‘arn:aws:iam::123456789012:role/S3Access`.
#is_parent ⇒ Boolean

This is a boolean value indicating this is a parent (composite) copy job.
#message_category ⇒ String

This parameter is the job count for the specified message category.
#number_of_child_jobs ⇒ Integer

The number of child (nested) copy jobs.
#parent_job_id ⇒ String

This uniquely identifies a request to Backup to copy a resource.
#resource_arn ⇒ String

The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
#resource_name ⇒ String

The non-unique name of the resource that belongs to the specified backup.
#resource_type ⇒ String

The type of Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
#source_backup_vault_arn ⇒ String

An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, ‘arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
#source_recovery_point_arn ⇒ String

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

The current state of a copy job.
#status_message ⇒ String

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

Instance Attribute Details

#account_id ⇒ `String`

The account ID that owns the copy job.

Returns:

(String)

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

class CopyJob < Struct.new(
  :account_id,
  :copy_job_id,
  :source_backup_vault_arn,
  :source_recovery_point_arn,
  :destination_backup_vault_arn,
  :destination_vault_type,
  :destination_vault_lock_state,
  :destination_recovery_point_arn,
  :destination_encryption_key_arn,
  :destination_recovery_point_lifecycle,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :created_by_backup_job_id,
  :resource_type,
  :parent_job_id,
  :is_parent,
  :composite_member_identifier,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#backup_size_in_bytes ⇒ `Integer`

The size, in bytes, of a copy job.

Returns:

(Integer)

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

class CopyJob < Struct.new(
  :account_id,
  :copy_job_id,
  :source_backup_vault_arn,
  :source_recovery_point_arn,
  :destination_backup_vault_arn,
  :destination_vault_type,
  :destination_vault_lock_state,
  :destination_recovery_point_arn,
  :destination_encryption_key_arn,
  :destination_recovery_point_lifecycle,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :created_by_backup_job_id,
  :resource_type,
  :parent_job_id,
  :is_parent,
  :composite_member_identifier,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#child_jobs_in_state ⇒ `Hash<String,Integer>`

This returns the statistics of the included child (nested) copy jobs.

Returns:

(Hash<String,Integer>)

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

class CopyJob < Struct.new(
  :account_id,
  :copy_job_id,
  :source_backup_vault_arn,
  :source_recovery_point_arn,
  :destination_backup_vault_arn,
  :destination_vault_type,
  :destination_vault_lock_state,
  :destination_recovery_point_arn,
  :destination_encryption_key_arn,
  :destination_recovery_point_lifecycle,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :created_by_backup_job_id,
  :resource_type,
  :parent_job_id,
  :is_parent,
  :composite_member_identifier,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#completion_date ⇒ `Time`

The date and time a copy 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 'lib/aws-sdk-backup/types.rb', line 1716

class CopyJob < Struct.new(
  :account_id,
  :copy_job_id,
  :source_backup_vault_arn,
  :source_recovery_point_arn,
  :destination_backup_vault_arn,
  :destination_vault_type,
  :destination_vault_lock_state,
  :destination_recovery_point_arn,
  :destination_encryption_key_arn,
  :destination_recovery_point_lifecycle,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :created_by_backup_job_id,
  :resource_type,
  :parent_job_id,
  :is_parent,
  :composite_member_identifier,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#composite_member_identifier ⇒ `String`

The identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the [ logical ID] within a stack.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax

Returns:

(String)

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

class CopyJob < Struct.new(
  :account_id,
  :copy_job_id,
  :source_backup_vault_arn,
  :source_recovery_point_arn,
  :destination_backup_vault_arn,
  :destination_vault_type,
  :destination_vault_lock_state,
  :destination_recovery_point_arn,
  :destination_encryption_key_arn,
  :destination_recovery_point_lifecycle,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :created_by_backup_job_id,
  :resource_type,
  :parent_job_id,
  :is_parent,
  :composite_member_identifier,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#copy_job_id ⇒ `String`

Uniquely identifies a copy job.

Returns:

(String)

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

class CopyJob < Struct.new(
  :account_id,
  :copy_job_id,
  :source_backup_vault_arn,
  :source_recovery_point_arn,
  :destination_backup_vault_arn,
  :destination_vault_type,
  :destination_vault_lock_state,
  :destination_recovery_point_arn,
  :destination_encryption_key_arn,
  :destination_recovery_point_lifecycle,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :created_by_backup_job_id,
  :resource_type,
  :parent_job_id,
  :is_parent,
  :composite_member_identifier,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#created_by ⇒ `Types::RecoveryPointCreator`

Contains information about the backup plan and rule that Backup used to initiate the recovery point backup.

Returns:

(Types::RecoveryPointCreator)

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

class CopyJob < Struct.new(
  :account_id,
  :copy_job_id,
  :source_backup_vault_arn,
  :source_recovery_point_arn,
  :destination_backup_vault_arn,
  :destination_vault_type,
  :destination_vault_lock_state,
  :destination_recovery_point_arn,
  :destination_encryption_key_arn,
  :destination_recovery_point_lifecycle,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :created_by_backup_job_id,
  :resource_type,
  :parent_job_id,
  :is_parent,
  :composite_member_identifier,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#created_by_backup_job_id ⇒ `String`

The backup job ID that initiated this copy job. Only applicable to scheduled copy jobs and automatic copy jobs to logically air-gapped vault.

Returns:

(String)

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

class CopyJob < Struct.new(
  :account_id,
  :copy_job_id,
  :source_backup_vault_arn,
  :source_recovery_point_arn,
  :destination_backup_vault_arn,
  :destination_vault_type,
  :destination_vault_lock_state,
  :destination_recovery_point_arn,
  :destination_encryption_key_arn,
  :destination_recovery_point_lifecycle,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :created_by_backup_job_id,
  :resource_type,
  :parent_job_id,
  :is_parent,
  :composite_member_identifier,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date ⇒ `Time`

The date and time a copy 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 'lib/aws-sdk-backup/types.rb', line 1716

class CopyJob < Struct.new(
  :account_id,
  :copy_job_id,
  :source_backup_vault_arn,
  :source_recovery_point_arn,
  :destination_backup_vault_arn,
  :destination_vault_type,
  :destination_vault_lock_state,
  :destination_recovery_point_arn,
  :destination_encryption_key_arn,
  :destination_recovery_point_lifecycle,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :created_by_backup_job_id,
  :resource_type,
  :parent_job_id,
  :is_parent,
  :composite_member_identifier,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#destination_backup_vault_arn ⇒ `String`

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

Returns:

(String)

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

class CopyJob < Struct.new(
  :account_id,
  :copy_job_id,
  :source_backup_vault_arn,
  :source_recovery_point_arn,
  :destination_backup_vault_arn,
  :destination_vault_type,
  :destination_vault_lock_state,
  :destination_recovery_point_arn,
  :destination_encryption_key_arn,
  :destination_recovery_point_lifecycle,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :created_by_backup_job_id,
  :resource_type,
  :parent_job_id,
  :is_parent,
  :composite_member_identifier,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#destination_encryption_key_arn ⇒ `String`

The Amazon Resource Name (ARN) of the KMS key used to encrypt the copied backup in the destination vault. This can be a customer-managed key or an Amazon Web Services managed key.

Returns:

(String)

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

class CopyJob < Struct.new(
  :account_id,
  :copy_job_id,
  :source_backup_vault_arn,
  :source_recovery_point_arn,
  :destination_backup_vault_arn,
  :destination_vault_type,
  :destination_vault_lock_state,
  :destination_recovery_point_arn,
  :destination_encryption_key_arn,
  :destination_recovery_point_lifecycle,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :created_by_backup_job_id,
  :resource_type,
  :parent_job_id,
  :is_parent,
  :composite_member_identifier,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#destination_recovery_point_arn ⇒ `String`

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

Returns:

(String)

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

class CopyJob < Struct.new(
  :account_id,
  :copy_job_id,
  :source_backup_vault_arn,
  :source_recovery_point_arn,
  :destination_backup_vault_arn,
  :destination_vault_type,
  :destination_vault_lock_state,
  :destination_recovery_point_arn,
  :destination_encryption_key_arn,
  :destination_recovery_point_lifecycle,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :created_by_backup_job_id,
  :resource_type,
  :parent_job_id,
  :is_parent,
  :composite_member_identifier,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#destination_recovery_point_lifecycle ⇒ `Types::Lifecycle`

Specifies the time period, in days, before a recovery point transitions to cold storage or is deleted.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the retention setting must be 90 days greater than the transition to cold after days setting. The transition to cold after days setting can’t be changed after a backup has been transitioned to cold.

Resource types that can transition to cold storage are listed in the

Feature availability by resource][1: table. Backup ignores this

expression for other resource types.

To remove the existing lifecycle and retention periods and keep your recovery points indefinitely, specify -1 for ‘MoveToColdStorageAfterDays` and `DeleteAfterDays`.

[1]: docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource

Returns:

(Types::Lifecycle)

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

class CopyJob < Struct.new(
  :account_id,
  :copy_job_id,
  :source_backup_vault_arn,
  :source_recovery_point_arn,
  :destination_backup_vault_arn,
  :destination_vault_type,
  :destination_vault_lock_state,
  :destination_recovery_point_arn,
  :destination_encryption_key_arn,
  :destination_recovery_point_lifecycle,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :created_by_backup_job_id,
  :resource_type,
  :parent_job_id,
  :is_parent,
  :composite_member_identifier,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#destination_vault_lock_state ⇒ `String`

The lock state of the destination backup vault. For logically air-gapped vaults, this indicates whether the vault is locked in compliance mode. Valid values include ‘LOCKED` and `UNLOCKED`.

Returns:

(String)

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

class CopyJob < Struct.new(
  :account_id,
  :copy_job_id,
  :source_backup_vault_arn,
  :source_recovery_point_arn,
  :destination_backup_vault_arn,
  :destination_vault_type,
  :destination_vault_lock_state,
  :destination_recovery_point_arn,
  :destination_encryption_key_arn,
  :destination_recovery_point_lifecycle,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :created_by_backup_job_id,
  :resource_type,
  :parent_job_id,
  :is_parent,
  :composite_member_identifier,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#destination_vault_type ⇒ `String`

The type of destination backup vault where the copied recovery point is stored. Valid values are ‘BACKUP_VAULT` for standard backup vaults and `LOGICALLY_AIR_GAPPED_BACKUP_VAULT` for logically air-gapped vaults.

Returns:

(String)

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

class CopyJob < Struct.new(
  :account_id,
  :copy_job_id,
  :source_backup_vault_arn,
  :source_recovery_point_arn,
  :destination_backup_vault_arn,
  :destination_vault_type,
  :destination_vault_lock_state,
  :destination_recovery_point_arn,
  :destination_encryption_key_arn,
  :destination_recovery_point_lifecycle,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :created_by_backup_job_id,
  :resource_type,
  :parent_job_id,
  :is_parent,
  :composite_member_identifier,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#iam_role_arn ⇒ `String`

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

Returns:

(String)

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

class CopyJob < Struct.new(
  :account_id,
  :copy_job_id,
  :source_backup_vault_arn,
  :source_recovery_point_arn,
  :destination_backup_vault_arn,
  :destination_vault_type,
  :destination_vault_lock_state,
  :destination_recovery_point_arn,
  :destination_encryption_key_arn,
  :destination_recovery_point_lifecycle,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :created_by_backup_job_id,
  :resource_type,
  :parent_job_id,
  :is_parent,
  :composite_member_identifier,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#is_parent ⇒ `Boolean`

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

Returns:

(Boolean)

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

class CopyJob < Struct.new(
  :account_id,
  :copy_job_id,
  :source_backup_vault_arn,
  :source_recovery_point_arn,
  :destination_backup_vault_arn,
  :destination_vault_type,
  :destination_vault_lock_state,
  :destination_recovery_point_arn,
  :destination_encryption_key_arn,
  :destination_recovery_point_lifecycle,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :created_by_backup_job_id,
  :resource_type,
  :parent_job_id,
  :is_parent,
  :composite_member_identifier,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#message_category ⇒ `String`

This parameter is the job count for the specified message category.

Example strings may include ‘AccessDenied`, `SUCCESS`, `AGGREGATE_ALL`, and `InvalidParameters`. See [Monitoring] for a list of MessageCategory strings.

The the value ANY returns count of all message categories.

‘AGGREGATE_ALL` aggregates job counts for all message categories and returns the sum

[1]: docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html

Returns:

(String)

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

class CopyJob < Struct.new(
  :account_id,
  :copy_job_id,
  :source_backup_vault_arn,
  :source_recovery_point_arn,
  :destination_backup_vault_arn,
  :destination_vault_type,
  :destination_vault_lock_state,
  :destination_recovery_point_arn,
  :destination_encryption_key_arn,
  :destination_recovery_point_lifecycle,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :created_by_backup_job_id,
  :resource_type,
  :parent_job_id,
  :is_parent,
  :composite_member_identifier,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_child_jobs ⇒ `Integer`

The number of child (nested) copy jobs.

Returns:

(Integer)

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

class CopyJob < Struct.new(
  :account_id,
  :copy_job_id,
  :source_backup_vault_arn,
  :source_recovery_point_arn,
  :destination_backup_vault_arn,
  :destination_vault_type,
  :destination_vault_lock_state,
  :destination_recovery_point_arn,
  :destination_encryption_key_arn,
  :destination_recovery_point_lifecycle,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :created_by_backup_job_id,
  :resource_type,
  :parent_job_id,
  :is_parent,
  :composite_member_identifier,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#parent_job_id ⇒ `String`

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

Returns:

(String)

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

class CopyJob < Struct.new(
  :account_id,
  :copy_job_id,
  :source_backup_vault_arn,
  :source_recovery_point_arn,
  :destination_backup_vault_arn,
  :destination_vault_type,
  :destination_vault_lock_state,
  :destination_recovery_point_arn,
  :destination_encryption_key_arn,
  :destination_recovery_point_lifecycle,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :created_by_backup_job_id,
  :resource_type,
  :parent_job_id,
  :is_parent,
  :composite_member_identifier,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arn ⇒ `String`

The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

Returns:

(String)

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

class CopyJob < Struct.new(
  :account_id,
  :copy_job_id,
  :source_backup_vault_arn,
  :source_recovery_point_arn,
  :destination_backup_vault_arn,
  :destination_vault_type,
  :destination_vault_lock_state,
  :destination_recovery_point_arn,
  :destination_encryption_key_arn,
  :destination_recovery_point_lifecycle,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :created_by_backup_job_id,
  :resource_type,
  :parent_job_id,
  :is_parent,
  :composite_member_identifier,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#resource_name ⇒ `String`

The non-unique name of the resource that belongs to the specified backup.

Returns:

(String)

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

class CopyJob < Struct.new(
  :account_id,
  :copy_job_id,
  :source_backup_vault_arn,
  :source_recovery_point_arn,
  :destination_backup_vault_arn,
  :destination_vault_type,
  :destination_vault_lock_state,
  :destination_recovery_point_arn,
  :destination_encryption_key_arn,
  :destination_recovery_point_lifecycle,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :created_by_backup_job_id,
  :resource_type,
  :parent_job_id,
  :is_parent,
  :composite_member_identifier,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ `String`

The type of Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

Returns:

(String)

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

class CopyJob < Struct.new(
  :account_id,
  :copy_job_id,
  :source_backup_vault_arn,
  :source_recovery_point_arn,
  :destination_backup_vault_arn,
  :destination_vault_type,
  :destination_vault_lock_state,
  :destination_recovery_point_arn,
  :destination_encryption_key_arn,
  :destination_recovery_point_lifecycle,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :created_by_backup_job_id,
  :resource_type,
  :parent_job_id,
  :is_parent,
  :composite_member_identifier,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#source_backup_vault_arn ⇒ `String`

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

Returns:

(String)

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

class CopyJob < Struct.new(
  :account_id,
  :copy_job_id,
  :source_backup_vault_arn,
  :source_recovery_point_arn,
  :destination_backup_vault_arn,
  :destination_vault_type,
  :destination_vault_lock_state,
  :destination_recovery_point_arn,
  :destination_encryption_key_arn,
  :destination_recovery_point_lifecycle,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :created_by_backup_job_id,
  :resource_type,
  :parent_job_id,
  :is_parent,
  :composite_member_identifier,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#source_recovery_point_arn ⇒ `String`

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

Returns:

(String)

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

class CopyJob < Struct.new(
  :account_id,
  :copy_job_id,
  :source_backup_vault_arn,
  :source_recovery_point_arn,
  :destination_backup_vault_arn,
  :destination_vault_type,
  :destination_vault_lock_state,
  :destination_recovery_point_arn,
  :destination_encryption_key_arn,
  :destination_recovery_point_lifecycle,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :created_by_backup_job_id,
  :resource_type,
  :parent_job_id,
  :is_parent,
  :composite_member_identifier,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ `String`

The current state of a copy job.

Returns:

(String)

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

class CopyJob < Struct.new(
  :account_id,
  :copy_job_id,
  :source_backup_vault_arn,
  :source_recovery_point_arn,
  :destination_backup_vault_arn,
  :destination_vault_type,
  :destination_vault_lock_state,
  :destination_recovery_point_arn,
  :destination_encryption_key_arn,
  :destination_recovery_point_lifecycle,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :created_by_backup_job_id,
  :resource_type,
  :parent_job_id,
  :is_parent,
  :composite_member_identifier,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

#status_message ⇒ `String`

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

Returns:

(String)

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

class CopyJob < Struct.new(
  :account_id,
  :copy_job_id,
  :source_backup_vault_arn,
  :source_recovery_point_arn,
  :destination_backup_vault_arn,
  :destination_vault_type,
  :destination_vault_lock_state,
  :destination_recovery_point_arn,
  :destination_encryption_key_arn,
  :destination_recovery_point_lifecycle,
  :resource_arn,
  :creation_date,
  :completion_date,
  :state,
  :status_message,
  :backup_size_in_bytes,
  :iam_role_arn,
  :created_by,
  :created_by_backup_job_id,
  :resource_type,
  :parent_job_id,
  :is_parent,
  :composite_member_identifier,
  :number_of_child_jobs,
  :child_jobs_in_state,
  :resource_name,
  :message_category)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::Backup::Types::CopyJob

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#account_id ⇒ String

#backup_size_in_bytes ⇒ Integer

#child_jobs_in_state ⇒ Hash<String,Integer>

#completion_date ⇒ Time

#composite_member_identifier ⇒ String

#copy_job_id ⇒ String

#created_by ⇒ Types::RecoveryPointCreator

#created_by_backup_job_id ⇒ String

#creation_date ⇒ Time

#destination_backup_vault_arn ⇒ String

#destination_encryption_key_arn ⇒ String

#destination_recovery_point_arn ⇒ String

#destination_recovery_point_lifecycle ⇒ Types::Lifecycle

#destination_vault_lock_state ⇒ String

#destination_vault_type ⇒ String

#iam_role_arn ⇒ String

#is_parent ⇒ Boolean

#message_category ⇒ String

#number_of_child_jobs ⇒ Integer

#parent_job_id ⇒ String

#resource_arn ⇒ String

#resource_name ⇒ String

#resource_type ⇒ String

#source_backup_vault_arn ⇒ String

#source_recovery_point_arn ⇒ String

#state ⇒ String

#status_message ⇒ String

#account_id ⇒ `String`

#backup_size_in_bytes ⇒ `Integer`

#child_jobs_in_state ⇒ `Hash<String,Integer>`

#completion_date ⇒ `Time`

#composite_member_identifier ⇒ `String`

#copy_job_id ⇒ `String`

#created_by ⇒ `Types::RecoveryPointCreator`

#created_by_backup_job_id ⇒ `String`

#creation_date ⇒ `Time`

#destination_backup_vault_arn ⇒ `String`

#destination_encryption_key_arn ⇒ `String`

#destination_recovery_point_arn ⇒ `String`

#destination_recovery_point_lifecycle ⇒ `Types::Lifecycle`

#destination_vault_lock_state ⇒ `String`

#destination_vault_type ⇒ `String`

#iam_role_arn ⇒ `String`

#is_parent ⇒ `Boolean`

#message_category ⇒ `String`

#number_of_child_jobs ⇒ `Integer`

#parent_job_id ⇒ `String`

#resource_arn ⇒ `String`

#resource_name ⇒ `String`

#resource_type ⇒ `String`

#source_backup_vault_arn ⇒ `String`

#source_recovery_point_arn ⇒ `String`

#state ⇒ `String`

#status_message ⇒ `String`