recovery_point_restore_metadatas

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

Overview

Name	recovery_point_restore_metadatas
Type	Resource
Id	aws.backup.recovery_point_restore_metadatas

Fields

The following fields are returned by SELECT queries:

get_recovery_point_restore_metadata

Name	Datatype	Description
backup_vault_arn	string	An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
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 recovery point. (pattern: <code>^[a-zA-Z0-9-_.]{1,50}$</code>)
restore_metadata	object	The set of metadata key-value pairs that describe the original configuration of the backed-up resource. These values vary depending on the service that is being restored.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_recovery_point_restore_metadata	select	backup_vault_name, recovery_point_arn, region	backupVaultAccountId	Returns a set of metadata key-value pairs that were used to create the 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
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.
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.
region	string	AWS region (default: us-east-1)
backupVaultAccountId	string	The account ID of the specified backup vault.

SELECT examples

get_recovery_point_restore_metadata

Returns a set of metadata key-value pairs that were used to create the backup.

SELECT
backup_vault_arn,
recovery_point_arn,
resource_type,
restore_metadata
FROM aws.backup.recovery_point_restore_metadatas
WHERE backup_vault_name = '{{ backup_vault_name }}' -- required
AND recovery_point_arn = '{{ recovery_point_arn }}' -- required
AND region = '{{ region }}' -- required
AND backupVaultAccountId = '{{ backupVaultAccountId }}'
;