Skip to main content

@swamp/aws/s3files

v2026.04.23.3

AWS S3FILES infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Labels

awss3filescloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/aws/s3files

@swamp/aws/s3files/access-pointv2026.04.23.2access_point.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
ClientToken?string(optional) A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.
Tags?array
FileSystemIdstringThe ID of the S3 Files file system that the access point provides access to.
PosixUser?objectThe operating system user and group applied to all compute drive requests made using the access point.
RootDirectory?objectSpecifies 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
createCreate a S3Files AccessPoint
getGet a S3Files AccessPoint
ArgumentTypeDescription
identifierstringThe primary identifier of the S3Files AccessPoint
updateUpdate a S3Files AccessPoint
deleteDelete a S3Files AccessPoint
ArgumentTypeDescription
identifierstringThe primary identifier of the S3Files AccessPoint
syncSync S3Files AccessPoint state from AWS

Resources

state(infinite)— S3Files AccessPoint resource state
@swamp/aws/s3files/file-systemv2026.04.23.2file_system.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
Tags?array
KmsKeyId?string
Bucketstring
Prefix?string
ClientToken?string
RoleArnstring
SynchronizationConfiguration?object
AcceptBucketWarning?boolean
createCreate a S3Files FileSystem
getGet a S3Files FileSystem
ArgumentTypeDescription
identifierstringThe primary identifier of the S3Files FileSystem
updateUpdate a S3Files FileSystem
deleteDelete a S3Files FileSystem
ArgumentTypeDescription
identifierstringThe primary identifier of the S3Files FileSystem
syncSync S3Files FileSystem state from AWS

Resources

state(infinite)— S3Files FileSystem resource state
@swamp/aws/s3files/file-system-policyv2026.04.23.2file_system_policy.ts

Global Arguments

ArgumentTypeDescription
FileSystemIdstring
Policystring
createCreate a S3Files FileSystemPolicy
getGet a S3Files FileSystemPolicy
ArgumentTypeDescription
identifierstringThe primary identifier of the S3Files FileSystemPolicy
updateUpdate a S3Files FileSystemPolicy
deleteDelete a S3Files FileSystemPolicy
ArgumentTypeDescription
identifierstringThe primary identifier of the S3Files FileSystemPolicy
syncSync S3Files FileSystemPolicy state from AWS

Resources

state(infinite)— S3Files FileSystemPolicy resource state
@swamp/aws/s3files/mount-targetv2026.04.23.2mount_target.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
Ipv4Address?string
Ipv6Address?string
IpAddressType?enum
FileSystemIdstring
SecurityGroups?array
SubnetIdstring
createCreate a S3Files MountTarget
getGet a S3Files MountTarget
ArgumentTypeDescription
identifierstringThe primary identifier of the S3Files MountTarget
updateUpdate a S3Files MountTarget
deleteDelete a S3Files MountTarget
ArgumentTypeDescription
identifierstringThe primary identifier of the S3Files MountTarget
syncSync S3Files MountTarget state from AWS

Resources

state(infinite)— S3Files MountTarget resource state