logically_air_gapped_backup_vaults

Creates, updates, deletes or gets a logically_air_gapped_backup_vault resource or lists logically_air_gapped_backup_vaults in a region

Overview

Name	logically_air_gapped_backup_vaults
Type	Resource
Description	Resource Type definition for AWS::Backup::LogicallyAirGappedBackupVault
Id	aws.backup.logically_air_gapped_backup_vaults

Fields

Name	Datatype	Description
access_policy	object
backup_vault_name	string
min_retention_days	integer
max_retention_days	integer
backup_vault_tags	object
notifications	object
encryption_key_arn	string
backup_vault_arn	string
vault_state	string
vault_type	string
region	string	AWS region.

For more information, see AWS::Backup::LogicallyAirGappedBackupVault.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	BackupVaultName, MinRetentionDays, MaxRetentionDays, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all logically_air_gapped_backup_vaults in a region.

SELECT
region,
access_policy,
backup_vault_name,
min_retention_days,
max_retention_days,
backup_vault_tags,
notifications,
encryption_key_arn,
backup_vault_arn,
vault_state,
vault_type
FROM aws.backup.logically_air_gapped_backup_vaults
WHERE region = 'us-east-1';

Gets all properties from an individual logically_air_gapped_backup_vault.

SELECT
region,
access_policy,
backup_vault_name,
min_retention_days,
max_retention_days,
backup_vault_tags,
notifications,
encryption_key_arn,
backup_vault_arn,
vault_state,
vault_type
FROM aws.backup.logically_air_gapped_backup_vaults
WHERE region = 'us-east-1' AND data__Identifier = '<BackupVaultName>';

INSERT example

Use the following StackQL query and manifest file to create a new logically_air_gapped_backup_vault resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.backup.logically_air_gapped_backup_vaults (
 BackupVaultName,
 MinRetentionDays,
 MaxRetentionDays,
 region
)
SELECT 
'{{ BackupVaultName }}',
 '{{ MinRetentionDays }}',
 '{{ MaxRetentionDays }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.backup.logically_air_gapped_backup_vaults (
 AccessPolicy,
 BackupVaultName,
 MinRetentionDays,
 MaxRetentionDays,
 BackupVaultTags,
 Notifications,
 region
)
SELECT 
 '{{ AccessPolicy }}',
 '{{ BackupVaultName }}',
 '{{ MinRetentionDays }}',
 '{{ MaxRetentionDays }}',
 '{{ BackupVaultTags }}',
 '{{ Notifications }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: logically_air_gapped_backup_vault
    props:
      - name: AccessPolicy
        value: {}
      - name: BackupVaultName
        value: '{{ BackupVaultName }}'
      - name: MinRetentionDays
        value: '{{ MinRetentionDays }}'
      - name: MaxRetentionDays
        value: '{{ MaxRetentionDays }}'
      - name: BackupVaultTags
        value: {}
      - name: Notifications
        value:
          BackupVaultEvents:
            - '{{ BackupVaultEvents[0] }}'
          SNSTopicArn: '{{ SNSTopicArn }}'

DELETE example

/*+ delete */
DELETE FROM aws.backup.logically_air_gapped_backup_vaults
WHERE data__Identifier = '<BackupVaultName>'
AND region = 'us-east-1';

Permissions

To operate on the logically_air_gapped_backup_vaults resource, the following permissions are required:

Create

backup:TagResource,
backup:CreateLogicallyAirGappedBackupVault,
backup:PutBackupVaultAccessPolicy,
backup:PutBackupVaultNotifications,
backup-storage:Mount,
backup-storage:MountCapsule,
backup:DescribeBackupVault

Read

backup:DescribeBackupVault,
backup:GetBackupVaultNotifications,
backup:GetBackupVaultAccessPolicy,
backup:ListTags

Update

backup:DescribeBackupVault,
backup:DeleteBackupVaultAccessPolicy,
backup:DeleteBackupVaultNotifications,
backup:DeleteBackupVaultLockConfiguration,
backup:GetBackupVaultAccessPolicy,
backup:ListTags,
backup:TagResource,
backup:UntagResource,
backup:PutBackupVaultAccessPolicy,
backup:PutBackupVaultNotifications,
backup:PutBackupVaultLockConfiguration

Delete

backup:DeleteBackupVault

List

backup:ListBackupVaults