Aws/efs

@swamp/aws/efsv2026.09.11.1· 1d agoMODELS

01README

AWS EFS infrastructure models

02Models3

@swamp/aws/efs/access-pointv2026.08.17.2access_point.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	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	no	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	no	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	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
ClientToken?	string	no	The opaque string specified in the request to ensure idempotent creation.
AccessPointTags?	array	no	An array of key-value pairs to apply to this resource. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
FileSystemId	string	yes	The ID of the EFS file system that the access point applies to. Accepts only the ID format for input when specifying a file system, for example fs-0123456789abcedf2.
PosixUser?	object	no	The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.
RootDirectory?	object	no	The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.

fn create()

Create a EFS AccessPoint

fn get(identifier: string)

Get a EFS AccessPoint

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the EFS AccessPoint

fn update()

Update a EFS AccessPoint

fn delete(identifier: string)

Delete a EFS AccessPoint

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the EFS AccessPoint

fn sync()

Sync EFS AccessPoint state from AWS

fn list(maxPages?: number, resourceModel?: string)

List EFS AccessPoint resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— EFS AccessPoint resource state

@swamp/aws/efs/file-systemv2026.08.17.2file_system.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	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	no	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	no	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	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Encrypted?	boolean	no	A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing kms-key-long. If you don't specify a kms-key, then the default kms-key for EFS, /aws/elasticfilesystem, is used to protect the encrypted file system.
FileSystemTags?	array	no	Use to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a "Key":"Name","Value":"{value}" key-value pair. Each key must be unique. For more information, see [Tagging resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the General Reference Guide.
KmsKeyId?	string	no	The ID of the kms-key-long to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault kms-key. If this parameter is not specified, the default kms-key for EFS is used. This ID can be in one of the following formats: Key ID - A unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab. ARN - An Amazon Resource Name (ARN) for the key, for example arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. K
LifecyclePolicies?	array	no	An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object. A LifecycleConfiguration object informs Lifecycle management of the following: When to move files in the file system from primary storage to IA storage. When to move files in the file system from primary storage or IA storage to Archive storage. When to move files that are in IA or Archive storage to primary storage. EFS requires that each LifecyclePolicy object have only a single transition. This me
FileSystemProtection?	object	no	Describes the protection on the file system.
PerformanceMode?	string	no	The performance mode of the file system. We recommend generalPurpose performance mode for all file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. The maxIO mode is not supported on One Zone file systems. Due to the higher per-operation latencies with Max I/O, we rec
ProvisionedThroughputInMibps?	number	no	The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. Required if ThroughputMode is set to provisioned. Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact SUP. For more information, see [Amazon EFS quotas that you can increase](https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in the Amazon EFS User Guide.
ThroughputMode?	string	no	Specifies the throughput mode for the file system. The mode can be bursting, provisioned, or elastic. If you set ThroughputMode to provisioned, you must also set a value for ProvisionedThroughputInMibps. After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see [Specifying throughput with provisioned mode](https://docs.aws.amazon.com/efs/latest/ug/performance.html#
FileSystemPolicy?	record	no	The FileSystemPolicy for the EFS file system. A file system policy is an IAM resource policy used to control NFS access to an EFS file system. For more information, see [Using to control NFS access to Amazon EFS](https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html) in the Amazon EFS User Guide.
BypassPolicyLockoutSafetyCheck?	boolean	no	(Optional) A boolean that specifies whether or not to bypass the FileSystemPolicy lockout safety check. The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future PutFileSystemPolicy requests on this file system. Set BypassPolicyLockoutSafetyCheck to True only when you intend to prevent the IAM principal that is making the request from making subsequent PutFileSystemPolicy requests on this file
AvailabilityZoneName?	string	no	For One Zone file systems, specify the AWS Availability Zone in which to create the file system. Use the format us-east-1a to specify the Availability Zone. For more information about One Zone file systems, see [EFS file system types](https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html#file-system-type) in the Amazon EFS User Guide. One Zone file systems are not available in all Availability Zones in AWS-Regions where Amazon EFS is available.
ReplicationConfiguration?	object	no	Describes the replication configuration for a specific file system.

fn create()

Create a EFS FileSystem

fn get(identifier: string)

Get a EFS FileSystem

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the EFS FileSystem

fn update()

Update a EFS FileSystem

fn delete(identifier: string)

Delete a EFS FileSystem

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the EFS FileSystem

fn sync()

Sync EFS FileSystem state from AWS

fn list(maxPages?: number, resourceModel?: string)

List EFS FileSystem resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— EFS FileSystem resource state

@swamp/aws/efs/mount-targetv2026.08.17.2mount_target.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	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	no	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	no	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	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
IpAddress?	string	no	If the IpAddressType for the mount target is IPv4 ( IPV4_ONLY or DUAL_STACK), then specify the IPv4 address to use. If you do not specify an IpAddress, then Amazon EFS selects an unused IP address from the subnet specified for SubnetId.
Ipv6Address?	string	no	If the IPAddressType for the mount target is IPv6 ( IPV6_ONLY or DUAL_STACK), then specify the IPv6 address to use. If you do not specify an Ipv6Address, then Amazon EFS selects an unused IP address from the subnet specified for SubnetId.
IpAddressType?	enum	no	The IP address type for the mount target. The possible values are IPV4_ONLY (only IPv4 addresses), IPV6_ONLY (only IPv6 addresses), and DUAL_STACK (dual-stack, both IPv4 and IPv6 addresses). If you don’t specify an IpAddressType, then IPV4_ONLY is used. The IPAddressType must match the IP type of the subnet. Additionally, the IPAddressType parameter overrides the value set as the default IP address for the subnet in the VPC. For example, if the IPAddressType is IPV4_ONLY and AssignIpv6AddressOnC
FileSystemId	string	yes	The ID of the file system for which to create the mount target.
SecurityGroups	array	yes	VPC security group IDs, of the form sg-xxxxxxxx. These must be for the same VPC as the subnet specified. The maximum number of security groups depends on account quota. For more information, see [Amazon VPC Quotas](https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html) in the Amazon VPC User Guide (see the Security Groups table). If you don't specify a security group, then Amazon EFS uses the default security group for the subnet's VPC.
SubnetId	string	yes	The ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is associated with the file system's Availability Zone. The subnet type must be the same type as the IpAddressType.

fn create()

Create a EFS MountTarget

fn get(identifier: string)

Get a EFS MountTarget

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the EFS MountTarget

fn update()

Update a EFS MountTarget

fn delete(identifier: string)

Delete a EFS MountTarget

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the EFS MountTarget

fn sync()

Sync EFS MountTarget state from AWS

fn list(maxPages?: number, resourceModel?: string)

List EFS MountTarget resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— EFS MountTarget resource state

03Previous Versions19

2026.09.09.1Sep 9, 2026

2026.09.08.1Sep 8, 2026

2026.09.07.1Sep 7, 2026

2026.09.06.3Sep 7, 2026

2026.09.06.1Sep 6, 2026

2026.09.05.1Sep 5, 2026

2026.09.04.1Sep 4, 2026

2026.09.03.1Sep 3, 2026

2026.09.02.1Sep 2, 2026

2026.09.01.1Sep 1, 2026

2026.08.31.1Aug 31, 2026

2026.08.30.1Aug 31, 2026

2026.08.29.1Aug 29, 2026

2026.08.28.1Aug 28, 2026

2026.08.27.1Aug 27, 2026

2026.08.26.1Aug 26, 2026

2026.08.25.6Aug 25, 2026

2026.08.25.5Aug 25, 2026

2026.08.24.6Aug 25, 2026

04Stats

100 / 100

Downloads

Archive size

755.4 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
Has description1/1earned
Platform support declared (or universal)2/2earned
License declared1/1earned
Verified public repository2/2earned

Repository

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

05Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64

06Labels

#aws #efs #cloud #infrastructure