Class: Aws::Backup::Types::CopyJob
- Inherits:
-
Struct
- Object
- Struct
- Aws::Backup::Types::CopyJob
- Defined in:
- gems/aws-sdk-backup/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
This is 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.
-
#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:vault:aBackupVault
. -
#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
. -
#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
This is 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
This is 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: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.
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1423 class CopyJob < Struct.new( :account_id, :copy_job_id, :source_backup_vault_arn, :source_recovery_point_arn, :destination_backup_vault_arn, :destination_recovery_point_arn, :resource_arn, :creation_date, :completion_date, :state, :status_message, :backup_size_in_bytes, :iam_role_arn, :created_by, :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.
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1423 class CopyJob < Struct.new( :account_id, :copy_job_id, :source_backup_vault_arn, :source_recovery_point_arn, :destination_backup_vault_arn, :destination_recovery_point_arn, :resource_arn, :creation_date, :completion_date, :state, :status_message, :backup_size_in_bytes, :iam_role_arn, :created_by, :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.
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1423 class CopyJob < Struct.new( :account_id, :copy_job_id, :source_backup_vault_arn, :source_recovery_point_arn, :destination_backup_vault_arn, :destination_recovery_point_arn, :resource_arn, :creation_date, :completion_date, :state, :status_message, :backup_size_in_bytes, :iam_role_arn, :created_by, :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.
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1423 class CopyJob < Struct.new( :account_id, :copy_job_id, :source_backup_vault_arn, :source_recovery_point_arn, :destination_backup_vault_arn, :destination_recovery_point_arn, :resource_arn, :creation_date, :completion_date, :state, :status_message, :backup_size_in_bytes, :iam_role_arn, :created_by, :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
This is 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.
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1423 class CopyJob < Struct.new( :account_id, :copy_job_id, :source_backup_vault_arn, :source_recovery_point_arn, :destination_backup_vault_arn, :destination_recovery_point_arn, :resource_arn, :creation_date, :completion_date, :state, :status_message, :backup_size_in_bytes, :iam_role_arn, :created_by, :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.
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1423 class CopyJob < Struct.new( :account_id, :copy_job_id, :source_backup_vault_arn, :source_recovery_point_arn, :destination_backup_vault_arn, :destination_recovery_point_arn, :resource_arn, :creation_date, :completion_date, :state, :status_message, :backup_size_in_bytes, :iam_role_arn, :created_by, :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.
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1423 class CopyJob < Struct.new( :account_id, :copy_job_id, :source_backup_vault_arn, :source_recovery_point_arn, :destination_backup_vault_arn, :destination_recovery_point_arn, :resource_arn, :creation_date, :completion_date, :state, :status_message, :backup_size_in_bytes, :iam_role_arn, :created_by, :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.
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1423 class CopyJob < Struct.new( :account_id, :copy_job_id, :source_backup_vault_arn, :source_recovery_point_arn, :destination_backup_vault_arn, :destination_recovery_point_arn, :resource_arn, :creation_date, :completion_date, :state, :status_message, :backup_size_in_bytes, :iam_role_arn, :created_by, :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:vault:aBackupVault
.
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1423 class CopyJob < Struct.new( :account_id, :copy_job_id, :source_backup_vault_arn, :source_recovery_point_arn, :destination_backup_vault_arn, :destination_recovery_point_arn, :resource_arn, :creation_date, :completion_date, :state, :status_message, :backup_size_in_bytes, :iam_role_arn, :created_by, :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
.
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1423 class CopyJob < Struct.new( :account_id, :copy_job_id, :source_backup_vault_arn, :source_recovery_point_arn, :destination_backup_vault_arn, :destination_recovery_point_arn, :resource_arn, :creation_date, :completion_date, :state, :status_message, :backup_size_in_bytes, :iam_role_arn, :created_by, :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
.
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1423 class CopyJob < Struct.new( :account_id, :copy_job_id, :source_backup_vault_arn, :source_recovery_point_arn, :destination_backup_vault_arn, :destination_recovery_point_arn, :resource_arn, :creation_date, :completion_date, :state, :status_message, :backup_size_in_bytes, :iam_role_arn, :created_by, :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.
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1423 class CopyJob < Struct.new( :account_id, :copy_job_id, :source_backup_vault_arn, :source_recovery_point_arn, :destination_backup_vault_arn, :destination_recovery_point_arn, :resource_arn, :creation_date, :completion_date, :state, :status_message, :backup_size_in_bytes, :iam_role_arn, :created_by, :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
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1423 class CopyJob < Struct.new( :account_id, :copy_job_id, :source_backup_vault_arn, :source_recovery_point_arn, :destination_backup_vault_arn, :destination_recovery_point_arn, :resource_arn, :creation_date, :completion_date, :state, :status_message, :backup_size_in_bytes, :iam_role_arn, :created_by, :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
This is the number of child (nested) copy jobs.
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1423 class CopyJob < Struct.new( :account_id, :copy_job_id, :source_backup_vault_arn, :source_recovery_point_arn, :destination_backup_vault_arn, :destination_recovery_point_arn, :resource_arn, :creation_date, :completion_date, :state, :status_message, :backup_size_in_bytes, :iam_role_arn, :created_by, :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.
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1423 class CopyJob < Struct.new( :account_id, :copy_job_id, :source_backup_vault_arn, :source_recovery_point_arn, :destination_backup_vault_arn, :destination_recovery_point_arn, :resource_arn, :creation_date, :completion_date, :state, :status_message, :backup_size_in_bytes, :iam_role_arn, :created_by, :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.
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1423 class CopyJob < Struct.new( :account_id, :copy_job_id, :source_backup_vault_arn, :source_recovery_point_arn, :destination_backup_vault_arn, :destination_recovery_point_arn, :resource_arn, :creation_date, :completion_date, :state, :status_message, :backup_size_in_bytes, :iam_role_arn, :created_by, :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
This is the non-unique name of the resource that belongs to the specified backup.
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1423 class CopyJob < Struct.new( :account_id, :copy_job_id, :source_backup_vault_arn, :source_recovery_point_arn, :destination_backup_vault_arn, :destination_recovery_point_arn, :resource_arn, :creation_date, :completion_date, :state, :status_message, :backup_size_in_bytes, :iam_role_arn, :created_by, :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.
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1423 class CopyJob < Struct.new( :account_id, :copy_job_id, :source_backup_vault_arn, :source_recovery_point_arn, :destination_backup_vault_arn, :destination_recovery_point_arn, :resource_arn, :creation_date, :completion_date, :state, :status_message, :backup_size_in_bytes, :iam_role_arn, :created_by, :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:vault:aBackupVault
.
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1423 class CopyJob < Struct.new( :account_id, :copy_job_id, :source_backup_vault_arn, :source_recovery_point_arn, :destination_backup_vault_arn, :destination_recovery_point_arn, :resource_arn, :creation_date, :completion_date, :state, :status_message, :backup_size_in_bytes, :iam_role_arn, :created_by, :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
.
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1423 class CopyJob < Struct.new( :account_id, :copy_job_id, :source_backup_vault_arn, :source_recovery_point_arn, :destination_backup_vault_arn, :destination_recovery_point_arn, :resource_arn, :creation_date, :completion_date, :state, :status_message, :backup_size_in_bytes, :iam_role_arn, :created_by, :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.
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1423 class CopyJob < Struct.new( :account_id, :copy_job_id, :source_backup_vault_arn, :source_recovery_point_arn, :destination_backup_vault_arn, :destination_recovery_point_arn, :resource_arn, :creation_date, :completion_date, :state, :status_message, :backup_size_in_bytes, :iam_role_arn, :created_by, :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.
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1423 class CopyJob < Struct.new( :account_id, :copy_job_id, :source_backup_vault_arn, :source_recovery_point_arn, :destination_backup_vault_arn, :destination_recovery_point_arn, :resource_arn, :creation_date, :completion_date, :state, :status_message, :backup_size_in_bytes, :iam_role_arn, :created_by, :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 |