Documentation

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

See: newRecoveryPointByBackupVault smart constructor.

Create a value of RecoveryPointByBackupVault with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:backupSizeInBytes:RecoveryPointByBackupVault', recoveryPointByBackupVault_backupSizeInBytes - The size, in bytes, of a backup.

$sel:backupVaultArn:RecoveryPointByBackupVault', recoveryPointByBackupVault_backupVaultArn - An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

$sel:backupVaultName:RecoveryPointByBackupVault', recoveryPointByBackupVault_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 Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

$sel:calculatedLifecycle:RecoveryPointByBackupVault', recoveryPointByBackupVault_calculatedLifecycle - A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

$sel:completionDate:RecoveryPointByBackupVault', recoveryPointByBackupVault_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.

$sel:compositeMemberIdentifier:RecoveryPointByBackupVault', recoveryPointByBackupVault_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.

$sel:createdBy:RecoveryPointByBackupVault', recoveryPointByBackupVault_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.

$sel:creationDate:RecoveryPointByBackupVault', recoveryPointByBackupVault_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.

$sel:encryptionKeyArn:RecoveryPointByBackupVault', recoveryPointByBackupVault_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.

$sel:iamRoleArn:RecoveryPointByBackupVault', recoveryPointByBackupVault_iamRoleArn - Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

$sel:isEncrypted:RecoveryPointByBackupVault', recoveryPointByBackupVault_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.

$sel:isParent:RecoveryPointByBackupVault', recoveryPointByBackupVault_isParent - This is a boolean value indicating this is a parent (composite) recovery point.

$sel:lastRestoreTime:RecoveryPointByBackupVault', recoveryPointByBackupVault_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.

$sel:lifecycle:RecoveryPointByBackupVault', recoveryPointByBackupVault_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.

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. Backup ignores this expression for other resource types.

$sel:parentRecoveryPointArn:RecoveryPointByBackupVault', recoveryPointByBackupVault_parentRecoveryPointArn - This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.

$sel:recoveryPointArn:RecoveryPointByBackupVault', recoveryPointByBackupVault_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.

$sel:resourceArn:RecoveryPointByBackupVault', recoveryPointByBackupVault_resourceArn - An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

$sel:resourceType:RecoveryPointByBackupVault', recoveryPointByBackupVault_resourceType - The type of Amazon Web Services 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.

$sel:sourceBackupVaultArn:RecoveryPointByBackupVault', recoveryPointByBackupVault_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.

$sel:status:RecoveryPointByBackupVault', recoveryPointByBackupVault_status - A status code specifying the state of the recovery point.

$sel:statusMessage:RecoveryPointByBackupVault', recoveryPointByBackupVault_statusMessage - A message explaining the reason of the recovery point deletion failure.

The size, in bytes, of a backup.

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

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. They consist of lowercase letters, numbers, and hyphens.

A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

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.

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.

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.

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.

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.

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

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

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

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.

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.

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. Backup ignores this expression for other resource types.

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

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.

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

The type of Amazon Web Services 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.

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.

A status code specifying the state of the recovery point.

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