recovery_point_index_details
Creates, updates, deletes, gets or lists a recovery_point_index_details resource.
Overview
| Name | recovery_point_index_details |
| Type | Resource |
| Id | aws.backup.recovery_point_index_details |
Fields
The following fields are returned by SELECT queries:
- get_recovery_point_index_details
| Name | Datatype | Description |
|---|---|---|
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. |
index_completion_date | string (date-time) | The date and time that a backup index finished creation, 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_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_deletion_date | string (date-time) | The date and time that a backup index was deleted, 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 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. |
source_resource_arn | string | A string of the Amazon Resource Name (ARN) that uniquely identifies the source resource. |
total_items_indexed | integer (int64) | Count of items within the backup index associated with the recovery point. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_recovery_point_index_details | select | backup_vault_name, recovery_point_arn, region | This operation returns the metadata and details specific to the backup index associated with the specified recovery point. |
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 |
|---|---|---|
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 Region where they are created. Accepted characters include lowercase letters, numbers, and hyphens. |
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. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_recovery_point_index_details
This operation returns the metadata and details specific to the backup index associated with the specified recovery point.
SELECT
backup_vault_arn,
index_completion_date,
index_creation_date,
index_deletion_date,
index_status,
index_status_message,
recovery_point_arn,
source_resource_arn,
total_items_indexed
FROM aws.backup.recovery_point_index_details
WHERE backup_vault_name = '{{ backup_vault_name }}' -- required
AND recovery_point_arn = '{{ recovery_point_arn }}' -- required
AND region = '{{ region }}' -- required
;