Modify Backup Attributes

cloudhsmv2_modify_backup_attributes

R Documentation

Modifies attributes for CloudHSM backup

Description

Modifies attributes for CloudHSM backup.

Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.

Usage

cloudhsmv2_modify_backup_attributes(BackupId, NeverExpires)

Arguments

BackupId

[required] The identifier (ID) of the backup to modify. To find the ID of a backup, use the describe_backups operation.

NeverExpires

[required] Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.

Value

A list with the following syntax:

list(
  Backup = list(
    BackupId = "string",
    BackupArn = "string",
    BackupState = "CREATE_IN_PROGRESS"|"READY"|"DELETED"|"PENDING_DELETION",
    ClusterId = "string",
    CreateTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    CopyTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    NeverExpires = TRUE|FALSE,
    SourceRegion = "string",
    SourceBackup = "string",
    SourceCluster = "string",
    DeleteTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    TagList = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    HsmType = "string",
    Mode = "FIPS"|"NON_FIPS"
  )
)

Request syntax

svc$modify_backup_attributes(
  BackupId = "string",
  NeverExpires = TRUE|FALSE
)