Skip to main content

recovery_points_by_backup_vaults

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

Overview​

Namerecovery_points_by_backup_vaults
TypeResource
Idaws.backup.recovery_points_by_backup_vaults

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
aggregated_scan_resultobjectContains the latest scanning results against the recovery point and currently include FailedScan, Findings, LastComputed.
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 Amazon Web Services 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 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.
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 information about the backup plan and rule that Backup used to initiate the recovery point backup.
creation_datestring (date-time)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.
encryption_key_arnstringThe 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.
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 is a boolean value indicating this is a parent (composite) recovery point.
last_restore_timestring (date-time)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.
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_arnstringThe Amazon Resource Name (ARN) of the parent (composite) recovery point.
recovery_point_arnstringAn 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.
resource_arnstringAn ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
resource_namestringThe non-unique name of the resource that belongs to the specified backup.
resource_typestringThe 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. (pattern: <code>^[a-zA-Z0-9-_.]{1,50}$</code>)
source_backup_vault_arnstringThe 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.
statusstringA status code specifying the state of the recovery point. (COMPLETED, PARTIAL, DELETING, EXPIRED, AVAILABLE, STOPPED, CREATING)
status_messagestringA message explaining the current status of the recovery point.
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
list_recovery_points_by_backup_vaultselectbackup_vault_name, regionbackupVaultAccountId, nextToken, maxResults, resourceArn, resourceType, backupPlanId, createdBefore, createdAfter, parentRecoveryPointArnReturns detailed information about the recovery points stored in a backup vault.

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 Amazon Web Services Region where they are created. Backup vault name might not be available when a supported service creates the backup.
regionstringAWS region (default: us-east-1)
backupPlanIdstringReturns only recovery points that match the specified backup plan ID.
backupVaultAccountIdstringThis parameter will sort the list of recovery points by account ID.
createdAfterstring (date-time)Returns only recovery points that were created after the specified timestamp.
createdBeforestring (date-time)Returns only recovery points that were created before the specified timestamp.
maxResultsintegerThe maximum number of items to be returned.
nextTokenstringThe next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
parentRecoveryPointArnstringThis returns only recovery points that match the specified parent (composite) recovery point Amazon Resource Name (ARN).
resourceArnstringReturns only recovery points that match the specified resource Amazon Resource Name (ARN).
resourceTypestringReturns only recovery points that match the specified resource type(s): Aurora for Amazon Aurora CloudFormation for CloudFormation DocumentDB for Amazon DocumentDB (with MongoDB compatibility) DynamoDB for Amazon DynamoDB EBS for Amazon Elastic Block Store EC2 for Amazon Elastic Compute Cloud EFS for Amazon Elastic File System EKS for Amazon Elastic Kubernetes Service FSx for Amazon FSx Neptune for Amazon Neptune RDS for Amazon Relational Database Service Redshift for Amazon Redshift S3 for Amazon Simple Storage Service (Amazon S3) SAP HANA on Amazon EC2 for SAP HANA databases on Amazon Elastic Compute Cloud instances Storage Gateway for Storage Gateway Timestream for Amazon Timestream VirtualMachine for VMware virtual machines

SELECT examples​

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

SELECT
aggregated_scan_result,
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,
source_backup_vault_arn,
status,
status_message,
vault_type
FROM aws.backup.recovery_points_by_backup_vaults
WHERE backup_vault_name = '{{ backup_vault_name }}' -- required
AND region = '{{ region }}' -- required
AND backupVaultAccountId = '{{ backupVaultAccountId }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND resourceArn = '{{ resourceArn }}'
AND resourceType = '{{ resourceType }}'
AND backupPlanId = '{{ backupPlanId }}'
AND createdBefore = '{{ createdBefore }}'
AND createdAfter = '{{ createdAfter }}'
AND parentRecoveryPointArn = '{{ parentRecoveryPointArn }}'
;
Last updated on