RecoveryPointByBackupVault - Amazon Backup
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

RecoveryPointByBackupVault

Contains detailed information about the recovery points stored in a backup vault.

Contents

BackupSizeInBytes

The size, in bytes, of a backup.

Type: Long

Required: No

BackupVaultArn

An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

Type: String

Required: No

BackupVaultName

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 Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Type: String

Pattern: ^[a-zA-Z0-9\-\_]{2,50}$

Required: No

CalculatedLifecycle

A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

Type: CalculatedLifecycle object

Required: No

CompletionDate

The date and time a job to restore a recovery point 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.

Type: Timestamp

Required: No

CompositeMemberIdentifier

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.

Type: String

Required: No

CreatedBy

Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.

Type: RecoveryPointCreator object

Required: No

CreationDate

The date and time a recovery point 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.

Type: Timestamp

Required: No

EncryptionKeyArn

The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

Type: String

Required: No

IamRoleArn

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

Type: String

Required: No

IsEncrypted

A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.

Type: Boolean

Required: No

IsParent

This is a boolean value indicating this is a parent (composite) recovery point.

Type: Boolean

Required: No

LastRestoreTime

The date and time a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Type: Timestamp

Required: No

Lifecycle

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Amazon 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.

Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Amazon Backup ignores this expression for other resource types.

Type: Lifecycle object

Required: No

ParentRecoveryPointArn

This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.

Type: String

Required: No

RecoveryPointArn

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.

Type: String

Required: No

ResourceArn

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

Type: String

Required: No

ResourceName

This is the non-unique name of the resource that belongs to the specified backup.

Type: String

Required: No

ResourceType

The type of Amazon resource saved as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

Type: String

Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$

Required: No

SourceBackupVaultArn

The backup vault where the recovery point was originally copied from. If the recovery point is restored to the same account this value will be null.

Type: String

Required: No

Status

A status code specifying the state of the recovery point.

Type: String

Valid Values: COMPLETED | PARTIAL | DELETING | EXPIRED

Required: No

StatusMessage

A message explaining the reason of the recovery point deletion failure.

Type: String

Required: No

VaultType

This is the type of vault in which the described recovery point is stored.

Type: String

Valid Values: BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: