Aws/backup
@swamp/aws/backupv2026.08.22.1
01README
AWS BACKUP infrastructure models
02Models
@swamp/aws/backup/backup-planv2026.08.17.2backup_plan.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS 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
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Backup BackupPlan |
fn update()
Update a Backup BackupPlan
fn delete(identifier: string)
Delete a Backup BackupPlan
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Backup BackupPlan |
fn sync()
Sync Backup BackupPlan state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Backup BackupPlan resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Backup BackupPlan resource state
@swamp/aws/backup/backup-selectionv2026.08.17.2backup_selection.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS 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
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Backup BackupSelection |
fn delete(identifier: string)
Delete a Backup BackupSelection
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Backup BackupSelection |
fn sync()
Sync Backup BackupSelection state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Backup BackupSelection resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Backup BackupSelection resource state
@swamp/aws/backup/backup-vaultv2026.08.17.2backup_vault.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| AccessPolicy? | record | |
| BackupVaultName | string | |
| BackupVaultTags? | record | |
| EncryptionKeyArn? | string | |
| Notifications? | object | |
| LockConfiguration? | object |
fn create()
Create a Backup BackupVault
fn get(identifier: string)
Get a Backup BackupVault
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Backup BackupVault |
fn update()
Update a Backup BackupVault
fn delete(identifier: string)
Delete a Backup BackupVault
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Backup BackupVault |
fn sync()
Sync Backup BackupVault state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Backup BackupVault resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Backup BackupVault resource state
@swamp/aws/backup/frameworkv2026.08.17.2framework.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| FrameworkName? | string | The 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? | string | An optional description of the framework with a maximum 1,024 characters. |
| FrameworkControls | array | Contains detailed information about all of the controls of a framework. Each framework must contain at least one control. |
| FrameworkTags? | array | Metadata 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
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Backup Framework |
fn update()
Update a Backup Framework
fn delete(identifier: string)
Delete a Backup Framework
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Backup Framework |
fn sync()
Sync Backup Framework state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Backup Framework resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Backup Framework resource state
@swamp/aws/backup/legal-holdv2026.08.17.2legal_hold.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Title | string | The title of the legal hold. |
| Description | string | The description of the legal hold. |
| RecoveryPointSelection | object | The criteria to assign a set of resources, such as resource types or backup vaults. |
| Tags? | array | Optional tags to include. |
fn create()
Create a Backup LegalHold
fn get(identifier: string)
Get a Backup LegalHold
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Backup LegalHold |
fn update()
Update a Backup LegalHold
fn delete(identifier: string)
Delete a Backup LegalHold
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Backup LegalHold |
fn sync()
Sync Backup LegalHold state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Backup LegalHold resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON 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.08.17.2logically_air_gapped_backup_vault.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| AccessPolicy? | record | |
| BackupVaultName | string | |
| 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
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Backup LogicallyAirGappedBackupVault |
fn update()
Update a Backup LogicallyAirGappedBackupVault
fn delete(identifier: string)
Delete a Backup LogicallyAirGappedBackupVault
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Backup LogicallyAirGappedBackupVault |
fn sync()
Sync Backup LogicallyAirGappedBackupVault state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Backup LogicallyAirGappedBackupVault resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Backup LogicallyAirGappedBackupVault resource state
@swamp/aws/backup/report-planv2026.08.17.2report_plan.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ReportPlanName? | string | The 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? | string | An optional description of the report plan with a maximum of 1,024 characters. |
| ReportPlanTags? | array | Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair. |
| ReportDeliveryChannel | object | A 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 | object | Identifies 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
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Backup ReportPlan |
fn update()
Update a Backup ReportPlan
fn delete(identifier: string)
Delete a Backup ReportPlan
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Backup ReportPlan |
fn sync()
Sync Backup ReportPlan state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Backup ReportPlan resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Backup ReportPlan resource state
@swamp/aws/backup/restore-testing-planv2026.08.17.2restore_testing_plan.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| RecoveryPointSelection | object | |
| RestoreTestingPlanName | string | |
| ScheduleExpression | string | |
| ScheduleExpressionTimezone? | string | |
| StartWindowHours? | number | |
| Tags? | array |
fn create()
Create a Backup RestoreTestingPlan
fn get(identifier: string)
Get a Backup RestoreTestingPlan
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Backup RestoreTestingPlan |
fn update()
Update a Backup RestoreTestingPlan
fn delete(identifier: string)
Delete a Backup RestoreTestingPlan
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Backup RestoreTestingPlan |
fn sync()
Sync Backup RestoreTestingPlan state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Backup RestoreTestingPlan resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Backup RestoreTestingPlan resource state
@swamp/aws/backup/restore-testing-selectionv2026.08.17.2restore_testing_selection.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS 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
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Backup RestoreTestingSelection |
fn update()
Update a Backup RestoreTestingSelection
fn delete(identifier: string)
Delete a Backup RestoreTestingSelection
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Backup RestoreTestingSelection |
fn sync()
Sync Backup RestoreTestingSelection state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Backup RestoreTestingSelection resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Backup RestoreTestingSelection resource state
@swamp/aws/backup/tiering-configurationv2026.08.17.2tiering_configuration.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| TieringConfigurationName | string | |
| BackupVaultName | string | |
| ResourceSelection | array | |
| TieringConfigurationTags? | record |
fn create()
Create a Backup TieringConfiguration
fn get(identifier: string)
Get a Backup TieringConfiguration
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Backup TieringConfiguration |
fn update()
Update a Backup TieringConfiguration
fn delete(identifier: string)
Delete a Backup TieringConfiguration
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Backup TieringConfiguration |
fn sync()
Sync Backup TieringConfiguration state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Backup TieringConfiguration resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Backup TieringConfiguration resource state
03Previous Versions
2026.08.21.1
2026.08.20.1
2026.08.19.1
2026.08.18.1
2026.08.17.5
2026.08.17.4
Modified 10 models
2026.08.16.1
2026.08.15.1
2026.08.14.1
2026.08.11.1
2026.08.07.1
2026.08.06.1
2026.08.05.1
2026.08.04.1
2026.08.03.1
2026.08.02.1
2026.08.01.1
2026.07.31.1
2026.07.30.1
04Stats
A
100 / 100
Downloads
0
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
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
05Platforms
06Labels