Start Copy Job

backup_start_copy_job

R Documentation

Starts a job to create a one-time copy of the specified resource¶

Description¶

Starts a job to create a one-time copy of the specified resource.

Does not support continuous backups.

Usage¶

backup_start_copy_job(RecoveryPointArn, SourceBackupVaultName,
  DestinationBackupVaultArn, IamRoleArn, IdempotencyToken, Lifecycle)

Arguments¶

RecoveryPointArn: [required] An ARN that uniquely identifies a recovery point to use for the copy job; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
SourceBackupVaultName: [required] The name of a logical source 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.
DestinationBackupVaultArn: [required] An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to copy to; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
IamRoleArn: [required] Specifies the IAM role ARN used to copy the target recovery point; for example, ⁠arn:aws:iam::123456789012:role/S3Access⁠.
IdempotencyToken: A customer-chosen string that you can use to distinguish between otherwise identical calls to start_copy_job. Retrying a successful request with the same idempotency token results in a success message with no action taken.
Lifecycle

Value¶

A list with the following syntax:

list(
  CopyJobId = "string",
  CreationDate = as.POSIXct(
    "2015-01-01"
  ),
  IsParent = TRUE|FALSE
)

Request syntax¶

svc$start_copy_job(
  RecoveryPointArn = "string",
  SourceBackupVaultName = "string",
  DestinationBackupVaultArn = "string",
  IamRoleArn = "string",
  IdempotencyToken = "string",
  Lifecycle = list(
    MoveToColdStorageAfterDays = 123,
    DeleteAfterDays = 123,
    OptInToArchiveForSupportedResources = TRUE|FALSE
  )
)