Aws/fsx
@swamp/aws/fsxv2026.10.25.1
01README
AWS FSX infrastructure models
02Release Notes
- Updated: file_cache, volume
03Behaviors
@swamp/aws/fsx/backupv2026.10.23.1backup.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. |
| FileSystemId | string | The ID of the file system to back up. |
| Tags? | array | The tags to apply to the backup at backup creation. |
fn create()
Create a FSx Backup
fn get(identifier: string)
Get a FSx Backup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the FSx Backup |
fn update()
Update a FSx Backup
fn delete(identifier: string)
Delete a FSx Backup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the FSx Backup |
fn sync()
Sync FSx Backup state from AWS
fn list(maxPages?: number, resourceModel?: string)
List FSx Backup 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)— FSx Backup resource state
@swamp/aws/fsx/data-repository-associationv2026.10.23.1data_repository_association.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. |
| FileSystemId | string | The globally unique ID of the file system, assigned by Amazon FSx. |
| FileSystemPath | string | This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory. |
| DataRepositoryPath | string | The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/. This path specifies where in the S3 data repository files will be imported from or exported to. |
| BatchImportMetaDataOnCreate? | boolean | A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created. The task runs if this flag is set to true. |
| ImportedFileChunkSize? | number | For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system. |
| S3? | object | The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository. |
| Tags? | array | A list of Tag values, with a maximum of 50 elements. |
fn create()
Create a FSx DataRepositoryAssociation
fn get(identifier: string)
Get a FSx DataRepositoryAssociation
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the FSx DataRepositoryAssociation |
fn update()
Update a FSx DataRepositoryAssociation
fn delete(identifier: string)
Delete a FSx DataRepositoryAssociation
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the FSx DataRepositoryAssociation |
fn sync()
Sync FSx DataRepositoryAssociation state from AWS
fn list(maxPages?: number, resourceModel?: string)
List FSx DataRepositoryAssociation 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)— FSx DataRepositoryAssociation resource state
@swamp/aws/fsx/file-cachev2026.10.25.1file_cache.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. |
| FileCacheType | enum | The type of cache, which must be LUSTRE |
| FileCacheTypeVersion | string | The Lustre version of the cache, which must be 2.12 |
| StorageCapacity | number | The storage capacity of the cache in gibibytes (GiB) |
| SubnetIds | array | A list of subnet IDs for the cache |
| SecurityGroupIds? | array | A list of security group IDs for the cache |
| Tags? | array | Tags to associate with the file cache |
| CopyTagsToDataRepositoryAssociations? | boolean | Whether tags should be copied to data repository associations |
| KmsKeyId? | string | The KMS key ID for encrypting data |
| LustreConfiguration? | object | The Lustre configuration for the file cache |
| DataRepositoryAssociations? | array | Data repository associations for the cache |
fn create()
Create a FSx FileCache
fn get(identifier: string)
Get a FSx FileCache
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the FSx FileCache |
fn update()
Update a FSx FileCache
fn delete(identifier: string)
Delete a FSx FileCache
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the FSx FileCache |
fn sync()
Sync FSx FileCache state from AWS
fn list(maxPages?: number, resourceModel?: string)
List FSx FileCache 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)— FSx FileCache resource state
@swamp/aws/fsx/s3access-point-attachmentv2026.10.23.1s3access_point_attachment.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. |
| Name | string | The name of the S3 access point attachment; also used for the name of the S3 access point. |
| Type | enum | The type of Amazon FSx volume that the S3 access point is attached to. |
| OntapConfiguration? | object | The OntapConfiguration of the S3 access point attachment. |
| OpenZFSConfiguration? | object | The OpenZFSConfiguration of the S3 access point attachment. |
| S3AccessPoint? | object | The S3 access point configuration of the S3 access point attachment. |
fn create()
Create a FSx S3AccessPointAttachment
fn get(identifier: string)
Get a FSx S3AccessPointAttachment
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the FSx S3AccessPointAttachment |
fn delete(identifier: string)
Delete a FSx S3AccessPointAttachment
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the FSx S3AccessPointAttachment |
fn sync()
Sync FSx S3AccessPointAttachment state from AWS
fn list(maxPages?: number, resourceModel?: string)
List FSx S3AccessPointAttachment 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)— FSx S3AccessPointAttachment resource state
@swamp/aws/fsx/snapshotv2026.10.23.1snapshot.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. |
| VolumeId | string | The ID of the volume that the snapshot is of. |
| Tags? | array | A list of Tag values, with a maximum of 50 elements. |
| Name | string | The name of the snapshot. |
fn create()
Create a FSx Snapshot
fn get(identifier: string)
Get a FSx Snapshot
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the FSx Snapshot |
fn update()
Update a FSx Snapshot
fn delete(identifier: string)
Delete a FSx Snapshot
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the FSx Snapshot |
fn sync()
Sync FSx Snapshot state from AWS
fn list(maxPages?: number, resourceModel?: string)
List FSx Snapshot 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)— FSx Snapshot resource state
@swamp/aws/fsx/storage-virtual-machinev2026.10.23.1storage_virtual_machine.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. |
| ActiveDirectoryConfiguration? | object | Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable. |
| FileSystemId | string | Specifies the FSx for ONTAP file system on which to create the SVM. |
| Name | string | The name of the SVM. Pattern: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,47}$` |
| RootVolumeSecurityStyle? | string | The security style of the root volume of the SVM. Allowed values: UNIX | NTFS | MIXED. |
| SvmAdminPassword? | string | Specifies the password to use when logging on to the SVM using a secure shell (SSH) connection to the SVM's management endpoint. |
| Tags? | array | A list of Tag values, with a maximum of 50 elements. |
fn create()
Create a FSx StorageVirtualMachine
fn get(identifier: string)
Get a FSx StorageVirtualMachine
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the FSx StorageVirtualMachine |
fn update()
Update a FSx StorageVirtualMachine
fn delete(identifier: string)
Delete a FSx StorageVirtualMachine
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the FSx StorageVirtualMachine |
fn sync()
Sync FSx StorageVirtualMachine state from AWS
fn list(maxPages?: number, resourceModel?: string)
List FSx StorageVirtualMachine 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)— FSx StorageVirtualMachine resource state
@swamp/aws/fsx/volumev2026.10.25.1volume.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. |
| BackupId? | string | Specifies the ID of the volume backup to use to create a new volume. |
| Name | string | The name of the volume. |
| OntapConfiguration? | object | The configuration of an Amazon FSx for NetApp ONTAP volume. |
| OpenZFSConfiguration? | object | The configuration of an Amazon FSx for OpenZFS volume. |
| Tags? | array | One or more tags. |
| VolumeType? | string | The type of the volume. |
fn create()
Create a FSx Volume
fn get(identifier: string)
Get a FSx Volume
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the FSx Volume |
fn update()
Update a FSx Volume
fn delete(identifier: string)
Delete a FSx Volume
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the FSx Volume |
fn sync()
Sync FSx Volume state from AWS
fn list(maxPages?: number, resourceModel?: string)
List FSx Volume 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)— FSx Volume resource state
04Previous Versions
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later
- Updated: backup, data_repository_association, file_cache, s3access_point_attachment, snapshot, storage_virtual_machine, volume
2026.10.14.1AGPL-3.0-or-later(was none)
- Added: snapshot, storage_virtual_machine, volume
Added 3 behaviors
2026.10.13.1
- Updated: backup, data_repository_association, file_cache, s3access_point_attachment
2026.10.08.2
2026.10.08.1
Removed 1 behaviors
2026.10.06.1
- Added: volume
Added 1 behaviors
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
2026.09.24.1
2026.09.23.1
05Stats
A
100 / 100
Downloads
25
Archive size
1.4 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