Skip to main content

Aws/backup

@swamp/aws/backupv2026.11.08.2· AGPL-3.0-or-later· 12d agoBEHAVIORS
01README

AWS BACKUP infrastructure models

02Release Notes
  • Updated: backup_access_point, backup_plan, backup_selection, backup_vault, framework, legal_hold, logically_air_gapped_backup_vault, report_plan, restore_testing_plan, restore_testing_selection, tiering_configuration
03Behaviors11
@swamp/aws/backup/backup-access-pointv2026.11.08.2backup_access_point.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Name?stringThe name of the backup access point. This name is shared with the Amazon S3 access point namespace. It must be unique within your account and Region and cannot conflict with an existing Amazon S3 access point. If omitted, a name is generated.
RecoveryPointArn?stringThe Amazon Resource Name (ARN) of the recovery point for which to create the backup access point. The recovery point must be an Amazon S3 recovery point in the AVAILABLE, STOPPED, or COMPLETED state.
AccessPointPolicy?recordAn optional resource-based policy document, in JSON, to apply to the underlying Amazon S3 access point. The policy controls how backup data can be accessed through the access point. If you do not specify a policy, access is governed by the caller's IAM permissions. The serialized policy may not exceed 200000 characters. This value is not returned by the service and cannot be updated in place.
AccessPointInTime?stringFor continuous (point-in-time) recovery points, the timestamp in ISO 8601 format (for example 2021-11-27T03:30:27Z) that determines the point-in-time view of the backup data. The timestamp must be within the continuous backup's retention period at the time the access point is created. Do not specify this for snapshot recovery points. The service reports it back under AccessPointMetadata.
Tags?arrayThe tags to assign to the backup access point.
fn create()
Create a Backup BackupAccessPoint
fn get(identifier: string)
Get a Backup BackupAccessPoint
ArgumentTypeDescription
identifierstringThe primary identifier of the Backup BackupAccessPoint
fn update()
Update a Backup BackupAccessPoint
fn delete(identifier: string)
Delete a Backup BackupAccessPoint
ArgumentTypeDescription
identifierstringThe primary identifier of the Backup BackupAccessPoint
fn sync()
Sync Backup BackupAccessPoint state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Backup BackupAccessPoint resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— Backup BackupAccessPoint resource state
@swamp/aws/backup/backup-planv2026.11.08.2backup_plan.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
BackupPlan?object
BackupPlanTags?record
fn create()
Create a Backup BackupPlan
fn get(identifier: string)
Get a Backup BackupPlan
ArgumentTypeDescription
identifierstringThe primary identifier of the Backup BackupPlan
fn update()
Update a Backup BackupPlan
fn delete(identifier: string)
Delete a Backup BackupPlan
ArgumentTypeDescription
identifierstringThe primary identifier of the Backup BackupPlan
fn sync()
Sync Backup BackupPlan state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Backup BackupPlan resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— Backup BackupPlan resource state
@swamp/aws/backup/backup-selectionv2026.11.08.2backup_selection.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
BackupPlanId?string
BackupSelection?object
fn create()
Create a Backup BackupSelection
fn get(identifier: string)
Get a Backup BackupSelection
ArgumentTypeDescription
identifierstringThe primary identifier of the Backup BackupSelection
fn delete(identifier: string)
Delete a Backup BackupSelection
ArgumentTypeDescription
identifierstringThe primary identifier of the Backup BackupSelection
fn sync()
Sync Backup BackupSelection state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Backup BackupSelection resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— Backup BackupSelection resource state
@swamp/aws/backup/backup-vaultv2026.11.08.2backup_vault.ts

Global Arguments

ArgumentTypeDescription
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
AccessPolicy?record
BackupVaultNamestring
BackupVaultTags?record
EncryptionKeyArn?string
Notifications?object
LockConfiguration?object
fn create()
Create a Backup BackupVault
fn get(identifier: string)
Get a Backup BackupVault
ArgumentTypeDescription
identifierstringThe primary identifier of the Backup BackupVault
fn update()
Update a Backup BackupVault
fn delete(identifier: string)
Delete a Backup BackupVault
ArgumentTypeDescription
identifierstringThe primary identifier of the Backup BackupVault
fn sync()
Sync Backup BackupVault state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Backup BackupVault resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— Backup BackupVault resource state
@swamp/aws/backup/frameworkv2026.11.08.2framework.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
FrameworkName?stringThe unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
FrameworkDescription?stringAn optional description of the framework with a maximum 1,024 characters.
FrameworkControls?arrayContains detailed information about all of the controls of a framework. Each framework must contain at least one control.
FrameworkTags?arrayMetadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
fn create()
Create a Backup Framework
fn get(identifier: string)
Get a Backup Framework
ArgumentTypeDescription
identifierstringThe primary identifier of the Backup Framework
fn update()
Update a Backup Framework
fn delete(identifier: string)
Delete a Backup Framework
ArgumentTypeDescription
identifierstringThe primary identifier of the Backup Framework
fn sync()
Sync Backup Framework state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Backup Framework resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— Backup Framework resource state
@swamp/aws/backup/legal-holdv2026.11.08.2legal_hold.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Title?stringThe title of the legal hold.
Description?stringThe description of the legal hold.
RecoveryPointSelection?objectThe criteria to assign a set of resources, such as resource types or backup vaults.
Tags?arrayOptional tags to include.
fn create()
Create a Backup LegalHold
fn get(identifier: string)
Get a Backup LegalHold
ArgumentTypeDescription
identifierstringThe primary identifier of the Backup LegalHold
fn update()
Update a Backup LegalHold
fn delete(identifier: string)
Delete a Backup LegalHold
ArgumentTypeDescription
identifierstringThe primary identifier of the Backup LegalHold
fn sync()
Sync Backup LegalHold state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Backup LegalHold resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— Backup LegalHold resource state
@swamp/aws/backup/logically-air-gapped-backup-vaultv2026.11.08.2logically_air_gapped_backup_vault.ts

Global Arguments

ArgumentTypeDescription
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
AccessPolicy?record
BackupVaultNamestring
MinRetentionDays?number
MaxRetentionDays?number
BackupVaultTags?record
Notifications?object
EncryptionKeyArn?string
MpaApprovalTeamArn?string
fn create()
Create a Backup LogicallyAirGappedBackupVault
fn get(identifier: string)
Get a Backup LogicallyAirGappedBackupVault
ArgumentTypeDescription
identifierstringThe primary identifier of the Backup LogicallyAirGappedBackupVault
fn update()
Update a Backup LogicallyAirGappedBackupVault
fn delete(identifier: string)
Delete a Backup LogicallyAirGappedBackupVault
ArgumentTypeDescription
identifierstringThe primary identifier of the Backup LogicallyAirGappedBackupVault
fn sync()
Sync Backup LogicallyAirGappedBackupVault state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Backup LogicallyAirGappedBackupVault resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— Backup LogicallyAirGappedBackupVault resource state
@swamp/aws/backup/report-planv2026.11.08.2report_plan.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
ReportPlanName?stringThe unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
ReportPlanDescription?stringAn optional description of the report plan with a maximum of 1,024 characters.
ReportPlanTags?arrayMetadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
ReportDeliveryChannel?objectA structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
ReportSetting?objectIdentifies the report template for the report. Reports are built using a report template.
fn create()
Create a Backup ReportPlan
fn get(identifier: string)
Get a Backup ReportPlan
ArgumentTypeDescription
identifierstringThe primary identifier of the Backup ReportPlan
fn update()
Update a Backup ReportPlan
fn delete(identifier: string)
Delete a Backup ReportPlan
ArgumentTypeDescription
identifierstringThe primary identifier of the Backup ReportPlan
fn sync()
Sync Backup ReportPlan state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Backup ReportPlan resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— Backup ReportPlan resource state
@swamp/aws/backup/restore-testing-planv2026.11.08.2restore_testing_plan.ts

Global Arguments

ArgumentTypeDescription
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
RecoveryPointSelection?object
RestoreTestingPlanNamestring
ScheduleExpression?string
ScheduleExpressionTimezone?string
StartWindowHours?number
Tags?array
fn create()
Create a Backup RestoreTestingPlan
fn get(identifier: string)
Get a Backup RestoreTestingPlan
ArgumentTypeDescription
identifierstringThe primary identifier of the Backup RestoreTestingPlan
fn update()
Update a Backup RestoreTestingPlan
fn delete(identifier: string)
Delete a Backup RestoreTestingPlan
ArgumentTypeDescription
identifierstringThe primary identifier of the Backup RestoreTestingPlan
fn sync()
Sync Backup RestoreTestingPlan state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Backup RestoreTestingPlan resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— Backup RestoreTestingPlan resource state
@swamp/aws/backup/restore-testing-selectionv2026.11.08.2restore_testing_selection.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
IamRoleArn?string
ProtectedResourceArns?array
ProtectedResourceConditions?object
ProtectedResourceType?string
RestoreMetadataOverrides?record
RestoreTestingPlanName?string
RestoreTestingSelectionName?string
ValidationWindowHours?number
fn create()
Create a Backup RestoreTestingSelection
fn get(identifier: string)
Get a Backup RestoreTestingSelection
ArgumentTypeDescription
identifierstringThe primary identifier of the Backup RestoreTestingSelection
fn update()
Update a Backup RestoreTestingSelection
fn delete(identifier: string)
Delete a Backup RestoreTestingSelection
ArgumentTypeDescription
identifierstringThe primary identifier of the Backup RestoreTestingSelection
fn sync()
Sync Backup RestoreTestingSelection state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Backup RestoreTestingSelection resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— Backup RestoreTestingSelection resource state
@swamp/aws/backup/tiering-configurationv2026.11.08.2tiering_configuration.ts

Global Arguments

ArgumentTypeDescription
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
TieringConfigurationNamestring
BackupVaultName?string
ResourceSelection?array
TieringConfigurationTags?record
fn create()
Create a Backup TieringConfiguration
fn get(identifier: string)
Get a Backup TieringConfiguration
ArgumentTypeDescription
identifierstringThe primary identifier of the Backup TieringConfiguration
fn update()
Update a Backup TieringConfiguration
fn delete(identifier: string)
Delete a Backup TieringConfiguration
ArgumentTypeDescription
identifierstringThe primary identifier of the Backup TieringConfiguration
fn sync()
Sync Backup TieringConfiguration state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Backup TieringConfiguration resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— Backup TieringConfiguration resource state
04Previous Versions19
2026.11.08.1AGPL-3.0-or-later
  • Updated: backup_access_point, backup_plan, backup_selection, backup_vault, framework, legal_hold, logically_air_gapped_backup_vault, report_plan, restore_testing_plan, restore_testing_selection, tiering_configuration
2026.11.02.1AGPL-3.0-or-later
2026.10.31.1AGPL-3.0-or-later
  • Added: backup_access_point

Added 1 behaviors

2026.10.25.1AGPL-3.0-or-later
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later(was none)
  • Updated: backup_plan, backup_selection, backup_vault, framework, legal_hold, logically_air_gapped_backup_vault, report_plan, restore_testing_plan, restore_testing_selection, tiering_configuration
2026.10.13.1
  • Updated: backup_plan, backup_selection, backup_vault, framework, legal_hold, logically_air_gapped_backup_vault, report_plan, restore_testing_plan, restore_testing_selection, tiering_configuration
2026.10.08.1
2026.10.06.1
2026.10.04.1
2026.10.03.1
2026.10.02.1
2026.10.01.1
2026.09.30.1
2026.09.29.1
2026.09.28.1
2026.09.27.1
2026.09.26.1
2026.09.25.1
05Stats
A
100 / 100
Downloads
44
Archive size
2.2 MB
Verified by Swamp
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Docs keep secrets in a vault1/1earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License2/2earned
  • Verified public repository2/2earned
06Platforms
07Labels