recovery_points_by_resources

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

Overview

Name	recovery_points_by_resources
Type	Resource
Id	aws.backup.recovery_points_by_resources

Fields

The following fields are returned by SELECT queries:

list_recovery_points_by_resource

Name	Datatype	Description
aggregated_scan_result	object	Contains the latest scanning results against the recovery point and currently include FailedScan, Findings, LastComputed.
backup_size_bytes	integer (int64)	The size, in bytes, of a backup.
backup_vault_name	string	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. (pattern: <code>^[a-zA-Z0-9-_]{2,50}$</code>)
creation_date	string (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_arn	string	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.
encryption_key_type	string	The 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)
index_status	string	This 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_message	string	A string in the form of a detailed message explaining the status of a backup index associated with the recovery point.
is_parent	boolean	This is a boolean value indicating this is a parent (composite) recovery point.
parent_recovery_point_arn	string	The Amazon Resource Name (ARN) of the parent (composite) recovery point.
recovery_point_arn	string	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.
resource_name	string	The non-unique name of the resource that belongs to the specified backup.
status	string	A status code specifying the state of the recovery point. (COMPLETED, PARTIAL, DELETING, EXPIRED, AVAILABLE, STOPPED, CREATING)
status_message	string	A message explaining the current status of the recovery point.
vault_type	string	The 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:

Name	Accessible by	Required Params	Optional Params	Description
list_recovery_points_by_resource	select	resource_arn, region	nextToken, maxResults, managedByAWSBackupOnly	The information about the recovery points of the type specified by a resource Amazon Resource Name (ARN). For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup.

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.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
resource_arn	string	An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
managedByAWSBackupOnly	boolean	This attribute filters recovery points based on ownership. If this is set to TRUE, the response will contain recovery points associated with the selected resources that are managed by Backup. If this is set to FALSE, the response will contain all recovery points associated with the selected resource, except for EBS snapshots copied within the same Region and account. Type: Boolean
maxResults	integer	The maximum number of items to be returned. Amazon RDS requires a value of at least 20.
nextToken	string	The 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.

SELECT examples

list_recovery_points_by_resource

The information about the recovery points of the type specified by a resource Amazon Resource Name (ARN). For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup.

SELECT
aggregated_scan_result,
backup_size_bytes,
backup_vault_name,
creation_date,
encryption_key_arn,
encryption_key_type,
index_status,
index_status_message,
is_parent,
parent_recovery_point_arn,
recovery_point_arn,
resource_name,
status,
status_message,
vault_type
FROM aws.backup.recovery_points_by_resources
WHERE resource_arn = '{{ resource_arn }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND managedByAWSBackupOnly = '{{ managedByAWSBackupOnly }}'
;