Aws/s3files
@swamp/aws/s3filesv2026.10.25.1
01README
AWS S3FILES infrastructure models
02Release Notes
- Updated: access_point
03Behaviors
@swamp/aws/s3files/access-pointv2026.10.25.1access_point.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. |
| ClientToken? | string | (optional) A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation. |
| Tags? | array | |
| FileSystemId | string | The ID of the S3 Files file system that the access point provides access to. |
| PosixUser? | object | The operating system user and group applied to all compute drive requests made using the access point. |
| RootDirectory? | object | Specifies the directory on the Amazon EFS file system that the access point exposes as the root directory of your file system to NFS clients using the access point. The clients using the access point can only access the root directory and below. If the RootDirectory>Path specified does not exist, EFS creates it and applies the CreationPermissions settings when a client connects to an access point. When specifying a RootDirectory, you need to provide the Path, and the CreationPermissions is optio |
fn create()
Create a S3Files AccessPoint
fn get(identifier: string)
Get a S3Files AccessPoint
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3Files AccessPoint |
fn update()
Update a S3Files AccessPoint
fn delete(identifier: string)
Delete a S3Files AccessPoint
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3Files AccessPoint |
fn sync()
Sync S3Files AccessPoint state from AWS
fn list(maxPages?: number, resourceModel?: string)
List S3Files AccessPoint 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)— S3Files AccessPoint resource state
@swamp/aws/s3files/file-systemv2026.10.23.1file_system.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. |
| Tags? | array | |
| KmsKeyId? | string | |
| Bucket | string | |
| Prefix? | string | |
| ClientToken? | string | |
| RoleArn | string | |
| SynchronizationConfiguration? | object | |
| AcceptBucketWarning? | boolean |
fn create()
Create a S3Files FileSystem
fn get(identifier: string)
Get a S3Files FileSystem
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3Files FileSystem |
fn update()
Update a S3Files FileSystem
fn delete(identifier: string)
Delete a S3Files FileSystem
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3Files FileSystem |
fn sync()
Sync S3Files FileSystem state from AWS
fn list(maxPages?: number, resourceModel?: string)
List S3Files FileSystem 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)— S3Files FileSystem resource state
@swamp/aws/s3files/file-system-policyv2026.10.23.1file_system_policy.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. |
| FileSystemId | string | |
| Policy | record |
fn create()
Create a S3Files FileSystemPolicy
fn get(identifier: string)
Get a S3Files FileSystemPolicy
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3Files FileSystemPolicy |
fn update()
Update a S3Files FileSystemPolicy
fn delete(identifier: string)
Delete a S3Files FileSystemPolicy
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3Files FileSystemPolicy |
fn sync()
Sync S3Files FileSystemPolicy state from AWS
fn list(maxPages?: number, resourceModel?: string)
List S3Files FileSystemPolicy 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)— S3Files FileSystemPolicy resource state
@swamp/aws/s3files/mount-targetv2026.10.23.1mount_target.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. |
| Ipv4Address? | string | |
| Ipv6Address? | string | |
| IpAddressType? | enum | |
| FileSystemId | string | |
| SecurityGroups? | array | |
| SubnetId | string |
fn create()
Create a S3Files MountTarget
fn get(identifier: string)
Get a S3Files MountTarget
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3Files MountTarget |
fn update()
Update a S3Files MountTarget
fn delete(identifier: string)
Delete a S3Files MountTarget
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3Files MountTarget |
fn sync()
Sync S3Files MountTarget state from AWS
fn list(maxPages?: number, resourceModel?: string)
List S3Files MountTarget 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)— S3Files MountTarget resource state
04Previous Versions
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later(was none)
- Updated: access_point, file_system, file_system_policy, mount_target
2026.10.13.1
- Updated: access_point, file_system, file_system_policy, mount_target
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
2026.09.24.1
2026.09.23.1
2026.09.21.1
2026.09.20.1
05Stats
A
100 / 100
Downloads
115
Archive size
826.1 KB
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