backup_vault_access_policies

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

Overview

Name	backup_vault_access_policies
Type	Resource
Id	aws.backup.backup_vault_access_policies

Fields

The following fields are returned by SELECT queries:

get_backup_vault_access_policy

Name	Datatype	Description
backup_vault_arn	string	An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
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. (pattern: <code>^[a-zA-Z0-9-_]{2,50}$</code>)
policy	string	The backup vault access policy document in JSON format.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_backup_vault_access_policy	select	backup_vault_name, region		Returns the access policy document that is associated with the named backup vault.
put_backup_vault_access_policy	replace	backup_vault_name, region		Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in JSON format.
delete_backup_vault_access_policy	delete	backup_vault_name, region		Deletes the policy document that manages permissions on a backup 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 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. They consist of lowercase letters, numbers, and hyphens.
region	string	AWS region (default: us-east-1)

SELECT examples

get_backup_vault_access_policy

Returns the access policy document that is associated with the named backup vault.

SELECT
backup_vault_arn,
backup_vault_name,
policy
FROM aws.backup.backup_vault_access_policies
WHERE backup_vault_name = '{{ backup_vault_name }}' -- required
AND region = '{{ region }}' -- required
;

REPLACE examples

put_backup_vault_access_policy

Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in JSON format.

REPLACE aws.backup.backup_vault_access_policies
SET 
Policy = '{{ Policy }}'
WHERE 
backup_vault_name = '{{ backup_vault_name }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_backup_vault_access_policy

Deletes the policy document that manages permissions on a backup vault.

DELETE FROM aws.backup.backup_vault_access_policies
WHERE backup_vault_name = '{{ backup_vault_name }}' --required
AND region = '{{ region }}' --required
;