backup_vault_notifications

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

Overview

Name	backup_vault_notifications
Type	Resource
Id	aws.backup.backup_vault_notifications

Fields

The following fields are returned by SELECT queries:

get_backup_vault_notifications

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_events	array	An array of events that indicate the status of jobs to back up resources to the backup vault.
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>)
sns_topic_arn	string	An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon SNS) topic; for example, arn:aws:sns:us-west-2:111122223333:MyTopic.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_backup_vault_notifications	select	backup_vault_name, region		Returns event notifications for the specified backup vault.
put_backup_vault_notifications	replace	backup_vault_name, region, SNSTopicArn, BackupVaultEvents		Turns on notifications on a backup vault for the specified topic and events.
delete_backup_vault_notifications	delete	backup_vault_name, region		Deletes event notifications for the specified 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 Region where they are created.
region	string	AWS region (default: us-east-1)

SELECT examples

get_backup_vault_notifications

Returns event notifications for the specified backup vault.

SELECT
backup_vault_arn,
backup_vault_events,
backup_vault_name,
sns_topic_arn
FROM aws.backup.backup_vault_notifications
WHERE backup_vault_name = '{{ backup_vault_name }}' -- required
AND region = '{{ region }}' -- required
;

REPLACE examples

put_backup_vault_notifications

Turns on notifications on a backup vault for the specified topic and events.

REPLACE aws.backup.backup_vault_notifications
SET 
SNSTopicArn = '{{ SNSTopicArn }}',
BackupVaultEvents = '{{ BackupVaultEvents }}'
WHERE 
backup_vault_name = '{{ backup_vault_name }}' --required
AND region = '{{ region }}' --required
AND SNSTopicArn = '{{ SNSTopicArn }}' --required
AND BackupVaultEvents = '{{ BackupVaultEvents }}' --required;

DELETE examples

delete_backup_vault_notifications

Deletes event notifications for the specified backup vault.

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