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.

See Copy job retry for information on how Backup retries copy job operations.

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

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 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.

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,
    DeleteAfterEvent = "DELETE_AFTER_COPY"
  )
)