indexed_recovery_points

Creates, updates, deletes, gets or lists an indexed_recovery_points resource.

Overview

Name	indexed_recovery_points
Type	Resource
Id	aws.backup.indexed_recovery_points

Fields

The following fields are returned by SELECT queries:

list_indexed_recovery_points

Name	Datatype	Description
backup_creation_date	string (date-time)	The date and time that a backup was 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.
backup_vault_arn	string	An ARN that uniquely identifies the backup vault where the recovery point index is stored. For example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
iam_role_arn	string	This specifies the IAM role ARN used for this operation. For example, arn:aws:iam::123456789012:role/S3Access
index_creation_date	string (date-time)	The date and time that a backup index was 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.
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.
recovery_point_arn	string	An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
resource_type	string	The resource type of the indexed recovery point. EBS for Amazon Elastic Block Store S3 for Amazon Simple Storage Service (Amazon S3) (pattern: <code>^[a-zA-Z0-9-_.]{1,50}$</code>)
source_resource_arn	string	A string of the Amazon Resource Name (ARN) that uniquely identifies the source resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_indexed_recovery_points	select	region	nextToken, maxResults, sourceResourceArn, createdBefore, createdAfter, resourceType, indexStatus	This operation returns a list of recovery points that have an associated index, belonging to the specified account. Optional parameters you can include are: MaxResults; NextToken; SourceResourceArns; CreatedBefore; CreatedAfter; and ResourceType.

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)
createdAfter	string (date-time)	Returns only indexed recovery points that were created after the specified date.
createdBefore	string (date-time)	Returns only indexed recovery points that were created before the specified date.
indexStatus	string	Include this parameter to filter the returned list by the indicated statuses. Accepted values: PENDING | ACTIVE | FAILED | DELETING A recovery point with an index that has the status of ACTIVE can be included in a search.
maxResults	integer	The maximum number of resource list items to be returned.
nextToken	string	The next item following a partial list of returned recovery points. For example, if a request is made to return MaxResults number of indexed recovery points, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
resourceType	string	Returns a list of indexed recovery points for the specified resource type(s). Accepted values include: EBS for Amazon Elastic Block Store S3 for Amazon Simple Storage Service (Amazon S3)
sourceResourceArn	string	A string of the Amazon Resource Name (ARN) that uniquely identifies the source resource.

SELECT examples

list_indexed_recovery_points

This operation returns a list of recovery points that have an associated index, belonging to the specified account. Optional parameters you can include are: MaxResults; NextToken; SourceResourceArns; CreatedBefore; CreatedAfter; and ResourceType.

SELECT
backup_creation_date,
backup_vault_arn,
iam_role_arn,
index_creation_date,
index_status,
index_status_message,
recovery_point_arn,
resource_type,
source_resource_arn
FROM aws.backup.indexed_recovery_points
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND sourceResourceArn = '{{ sourceResourceArn }}'
AND createdBefore = '{{ createdBefore }}'
AND createdAfter = '{{ createdAfter }}'
AND resourceType = '{{ resourceType }}'
AND indexStatus = '{{ indexStatus }}'
;