Skip to main content

recovery_points

Creates, updates, deletes, gets or lists a recovery_points resource.

Overview​

Namerecovery_points
TypeResource
Idaws.backup.recovery_points

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
backup_size_in_bytesinteger (int64)The size, in bytes, of a backup.
backup_vault_arnstringAn ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
backup_vault_namestringThe 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 Region where they are created. (pattern: <code>^[a-zA-Z0-9-_]{2,50}$</code>)
calculated_lifecycleobjectA CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.
completion_datestring (date-time)The date and time that a job to create 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.
composite_member_identifierstringThe 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.
created_byobjectContains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.
creation_datestring (date-time)The date and time that 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.
encryption_key_arnstringThe server-side encryption key used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
encryption_key_typestringThe type of encryption key used for the recovery point. Valid values are CUSTOMER_MANAGED_KMS_KEY for customer-managed keys or Amazon Web Services_OWNED_KMS_KEY for Amazon Web Services-owned keys. (AWS_OWNED_KMS_KEY, CUSTOMER_MANAGED_KMS_KEY)
iam_role_arnstringSpecifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
index_statusstringThis is the current status for the backup index associated with the specified recovery point. Statuses are: PENDING | ACTIVE | FAILED | DELETING A recovery point with an index that has the status of ACTIVE can be included in a search. (PENDING, ACTIVE, FAILED, DELETING)
index_status_messagestringA string in the form of a detailed message explaining the status of a backup index associated with the recovery point.
initiation_datestring (date-time)The date and time when the backup job that created this recovery point was initiated, in Unix format and Coordinated Universal Time (UTC).
is_encryptedbooleanA Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.
is_parentbooleanThis returns the boolean value that a recovery point is a parent (composite) job.
last_restore_timestring (date-time)The date and time that 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.
lifecycleobjectSpecifies 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.
parent_recovery_point_arnstringThis is an ARN that uniquely identifies a parent (composite) recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
recovery_point_arnstringAn ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
resource_arnstringAn ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
resource_namestringThe name of the resource that belongs to the specified backup.
resource_typestringThe type of Amazon Web Services resource to save as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. (pattern: <code>^[a-zA-Z0-9-_.]{1,50}$</code>)
scan_resultsarrayContains the latest scanning results against the recovery point and currently include MalwareScanner, ScanJobState, Findings, and LastScanTimestamp
source_backup_vault_arnstringAn Amazon Resource Name (ARN) that uniquely identifies the source vault where the resource was originally backed up in; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault. If the recovery is restored to the same Amazon Web Services account or Region, this value will be null.
statusstringA status code specifying the state of the recovery point. For more information, see Recovery point status in the Backup Developer Guide. CREATING status indicates that an Backup job has been initiated for a resource. The backup process has started and is actively processing a backup job for the associated recovery point. AVAILABLE status indicates that the backup was successfully created for the recovery point. The backup process has completed without any issues, and the recovery point is now ready for use. PARTIAL status indicates a composite recovery point has one or more nested recovery points that were not in the backup. EXPIRED status indicates that the recovery point has exceeded its retention period, but Backup lacks permission or is otherwise unable to delete it. To manually delete these recovery points, see Step 3: Delete the recovery points in the Clean up resources section of Getting started. STOPPED status occurs on a continuous backup where a user has taken some action that causes the continuous backup to be disabled. This can be caused by the removal of permissions, turning off versioning, turning off events being sent to EventBridge, or disabling the EventBridge rules that are put in place by Backup. For recovery points of Amazon S3, Amazon RDS, and Amazon Aurora resources, this status occurs when the retention period of a continuous backup rule is changed. To resolve STOPPED status, ensure that all requested permissions are in place and that versioning is enabled on the S3 bucket. Once these conditions are met, the next instance of a backup rule running will result in a new continuous recovery point being created. The recovery points with STOPPED status do not need to be deleted. For SAP HANA on Amazon EC2 STOPPED status occurs due to user action, application misconfiguration, or backup failure. To ensure that future continuous backups succeed, refer to the recovery point status and check SAP HANA for details. (COMPLETED, PARTIAL, DELETING, EXPIRED, AVAILABLE, STOPPED, CREATING)
status_messagestringA status message explaining the status of the recovery point.
storage_classstringSpecifies the storage class of the recovery point. Valid values are WARM or COLD. (WARM, COLD, DELETED)
vault_typestringThe type of vault in which the described recovery point is stored. (BACKUP_VAULT, LOGICALLY_AIR_GAPPED_BACKUP_VAULT, RESTORE_ACCESS_BACKUP_VAULT)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_recovery_pointselectbackup_vault_name, recovery_point_arn, regionbackupVaultAccountIdReturns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
disassociate_recovery_pointupdatebackup_vault_name, recovery_point_arn, regionDeletes the specified continuous backup recovery point from Backup and releases control of that continuous backup to the source service, such as Amazon RDS. The source service will continue to create and retain continuous backups using the lifecycle that you specified in your original backup plan. Does not support snapshot backup recovery points.
delete_recovery_pointdeletebackup_vault_name, recovery_point_arn, regionDeletes the recovery point specified by a recovery point ID. If the recovery point ID belongs to a continuous backup, calling this endpoint deletes the existing continuous backup and stops future continuous backup. When an IAM role's permissions are insufficient to call this API, the service sends back an HTTP 200 response with an empty HTTP body, but the recovery point is not deleted. Instead, it enters an EXPIRED state. EXPIRED recovery points can be deleted with this API once the IAM role has the iam:CreateServiceLinkedRole action. To learn more about adding this role, see Troubleshooting manual deletions. If the user or role is deleted or the permission within the role is removed, the deletion will not be successful and will enter an EXPIRED state.
update_recovery_point_lifecycleexecbackup_vault_name, recovery_point_arn, regionSets 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.
disassociate_recovery_point_from_parentexecbackup_vault_name, recovery_point_arn, regionThis action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point.
update_recovery_point_index_settingsexecbackup_vault_name, recovery_point_arn, regionThis operation updates the settings of a recovery point index. Required: BackupVaultName, RecoveryPointArn, and IAMRoleArn
start_copy_jobexecregion, RecoveryPointArn, SourceBackupVaultName, DestinationBackupVaultArn, IamRoleArnStarts 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.
start_restore_jobexecregion, RecoveryPointArn, MetadataRecovers the saved resource identified by an Amazon Resource Name (ARN).
start_scan_jobexecregion, BackupVaultName, IamRoleArn, MalwareScanner, RecoveryPointArn, ScanMode, ScannerRoleArnStarts scanning jobs for specific resources.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
backup_vault_namestringThe 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 Region where they are created. Accepted characters include lowercase letters, numbers, and hyphens.
recovery_point_arnstringAn ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
regionstringAWS region (default: us-east-1)
backupVaultAccountIdstringThe account ID of the specified backup vault.

SELECT examples​

Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.

SELECT
backup_size_in_bytes,
backup_vault_arn,
backup_vault_name,
calculated_lifecycle,
completion_date,
composite_member_identifier,
created_by,
creation_date,
encryption_key_arn,
encryption_key_type,
iam_role_arn,
index_status,
index_status_message,
initiation_date,
is_encrypted,
is_parent,
last_restore_time,
lifecycle,
parent_recovery_point_arn,
recovery_point_arn,
resource_arn,
resource_name,
resource_type,
scan_results,
source_backup_vault_arn,
status,
status_message,
storage_class,
vault_type
FROM aws.backup.recovery_points
WHERE backup_vault_name = '{{ backup_vault_name }}' -- required
AND recovery_point_arn = '{{ recovery_point_arn }}' -- required
AND region = '{{ region }}' -- required
AND backupVaultAccountId = '{{ backupVaultAccountId }}'
;

UPDATE examples​

Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup to the source service, such as Amazon RDS. The source service will continue to create and retain continuous backups using the lifecycle that you specified in your original backup plan. Does not support snapshot backup recovery points.

UPDATE aws.backup.recovery_points
SET 
-- No updatable properties
WHERE 
backup_vault_name = '{{ backup_vault_name }}' --required
AND recovery_point_arn = '{{ recovery_point_arn }}' --required
AND region = '{{ region }}' --required;

DELETE examples​

Deletes the recovery point specified by a recovery point ID. If the recovery point ID belongs to a continuous backup, calling this endpoint deletes the existing continuous backup and stops future continuous backup. When an IAM role's permissions are insufficient to call this API, the service sends back an HTTP 200 response with an empty HTTP body, but the recovery point is not deleted. Instead, it enters an EXPIRED state. EXPIRED recovery points can be deleted with this API once the IAM role has the iam:CreateServiceLinkedRole action. To learn more about adding this role, see Troubleshooting manual deletions. If the user or role is deleted or the permission within the role is removed, the deletion will not be successful and will enter an EXPIRED state.

DELETE FROM aws.backup.recovery_points
WHERE backup_vault_name = '{{ backup_vault_name }}' --required
AND recovery_point_arn = '{{ recovery_point_arn }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods​

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.

EXEC aws.backup.recovery_points.update_recovery_point_lifecycle 
@backup_vault_name='{{ backup_vault_name }}' --required, 
@recovery_point_arn='{{ recovery_point_arn }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"Lifecycle": "{{ Lifecycle }}"
}'
;
Last updated on