Update Recovery Point Lifecycle

backup_update_recovery_point_lifecycle

R Documentation

Sets the transition lifecycle of a recovery point

Description

Sets the transition lifecycle of a recovery point.

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.

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.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

If your lifecycle currently uses the parameters DeleteAfterDays and MoveToColdStorageAfterDays, include these parameters and their values when you call this operation. Not including them may result in your plan updating with null values.

This operation does not support continuous backups.

Usage

backup_update_recovery_point_lifecycle(BackupVaultName,
  RecoveryPointArn, Lifecycle)

Arguments

BackupVaultName

[required] 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.

RecoveryPointArn

[required] An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, ⁠arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45⁠.

Lifecycle

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

Value

A list with the following syntax:

list(
  BackupVaultArn = "string",
  RecoveryPointArn = "string",
  Lifecycle = list(
    MoveToColdStorageAfterDays = 123,
    DeleteAfterDays = 123,
    OptInToArchiveForSupportedResources = TRUE|FALSE
  ),
  CalculatedLifecycle = list(
    MoveToColdStorageAt = as.POSIXct(
      "2015-01-01"
    ),
    DeleteAt = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$update_recovery_point_lifecycle(
  BackupVaultName = "string",
  RecoveryPointArn = "string",
  Lifecycle = list(
    MoveToColdStorageAfterDays = 123,
    DeleteAfterDays = 123,
    OptInToArchiveForSupportedResources = TRUE|FALSE
  )
)