restore_access_backup_vaults

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

Overview

Name	restore_access_backup_vaults
Type	Resource
Id	aws.backup.restore_access_backup_vaults

Fields

The following fields are returned by SELECT queries:

list_restore_access_backup_vaults

Name	Datatype	Description
approval_date	string (date-time)	The date and time when the restore access backup vault was approved.
creation_date	string (date-time)	The date and time when the restore access backup vault was created.
latest_revoke_request	object	Information about the latest request to revoke access to this backup vault.
restore_access_backup_vault_arn	string	The ARN of the restore access backup vault.
vault_state	string	The current state of the restore access backup vault. (CREATING, AVAILABLE, FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_restore_access_backup_vaults	select	backup_vault_name, region	nextToken, maxResults	Returns a list of restore access backup vaults associated with a specified backup vault.
create_restore_access_backup_vault	insert	region, SourceBackupVaultArn		Creates a restore access backup vault that provides temporary access to recovery points in a logically air-gapped backup vault, subject to MPA approval.
revoke_restore_access_backup_vault	update	backup_vault_name, restore_access_backup_vault_arn, region	requesterComment	Revokes access to a restore access backup vault, removing the ability to restore from its recovery points and permanently deleting the 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.

Name	Datatype	Description
backup_vault_name	string	The name of the source backup vault associated with the restore access backup vault to be revoked.
region	string	AWS region (default: us-east-1)
restore_access_backup_vault_arn	string	The ARN of the restore access backup vault to revoke.
maxResults	integer	The maximum number of items to return in the response.
nextToken	string	The pagination token from a previous request to retrieve the next set of results.
requesterComment	string	A comment explaining the reason for revoking access to the restore access backup vault.

SELECT examples

list_restore_access_backup_vaults

Returns a list of restore access backup vaults associated with a specified backup vault.

SELECT
approval_date,
creation_date,
latest_revoke_request,
restore_access_backup_vault_arn,
vault_state
FROM aws.backup.restore_access_backup_vaults
WHERE backup_vault_name = '{{ backup_vault_name }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_restore_access_backup_vault

Creates a restore access backup vault that provides temporary access to recovery points in a logically air-gapped backup vault, subject to MPA approval.

INSERT INTO aws.backup.restore_access_backup_vaults (
SourceBackupVaultArn,
BackupVaultName,
BackupVaultTags,
CreatorRequestId,
RequesterComment,
region
)
SELECT 
'{{ SourceBackupVaultArn }}' /* required */,
'{{ BackupVaultName }}',
'{{ BackupVaultTags }}',
'{{ CreatorRequestId }}',
'{{ RequesterComment }}',
'{{ region }}'
RETURNING
creation_date,
restore_access_backup_vault_arn,
restore_access_backup_vault_name,
vault_state
;

Manifest

# Description fields are for documentation purposes
- name: restore_access_backup_vaults
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the restore_access_backup_vaults resource.
  - name: SourceBackupVaultArn
    value: "{{ SourceBackupVaultArn }}"
  - name: BackupVaultName
    value: "{{ BackupVaultName }}"
  - name: BackupVaultTags
    value: "{{ BackupVaultTags }}"
  - name: CreatorRequestId
    value: "{{ CreatorRequestId }}"
  - name: RequesterComment
    value: "{{ RequesterComment }}"

UPDATE examples

revoke_restore_access_backup_vault

Revokes access to a restore access backup vault, removing the ability to restore from its recovery points and permanently deleting the vault.

UPDATE aws.backup.restore_access_backup_vaults
SET 
-- No updatable properties
WHERE 
backup_vault_name = '{{ backup_vault_name }}' --required
AND restore_access_backup_vault_arn = '{{ restore_access_backup_vault_arn }}' --required
AND region = '{{ region }}' --required
AND requesterComment = '{{ requesterComment}}';