Skip to main content
← back to extensions

@swamp/aws/efs

v2026.04.23.3

AWS EFS infrastructure models

Repository

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

Platforms

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

Labels

awsefscloudinfrastructure

Contents

models

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/efs

@swamp/aws/efs/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?stringThe opaque string specified in the request to ensure idempotent creation.
AccessPointTags?arrayAn 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).
FileSystemIdstringThe 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?objectThe 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?objectThe directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.
createCreate a EFS AccessPoint
getGet a EFS AccessPoint
ArgumentTypeDescription
identifierstringThe primary identifier of the EFS AccessPoint
updateUpdate a EFS AccessPoint
deleteDelete a EFS AccessPoint
ArgumentTypeDescription
identifierstringThe primary identifier of the EFS AccessPoint
syncSync EFS AccessPoint state from AWS

Resources

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

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
Encrypted?booleanA 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?arrayUse 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?stringThe 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?arrayAn 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?objectDescribes the protection on the file system.
PerformanceMode?stringThe 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?numberThe 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?stringSpecifies 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?stringThe 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(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?stringFor 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?objectDescribes the replication configuration for a specific file system.
createCreate a EFS FileSystem
getGet a EFS FileSystem
ArgumentTypeDescription
identifierstringThe primary identifier of the EFS FileSystem
updateUpdate a EFS FileSystem
deleteDelete a EFS FileSystem
ArgumentTypeDescription
identifierstringThe primary identifier of the EFS FileSystem
syncSync EFS FileSystem state from AWS

Resources

state(infinite)— EFS FileSystem resource state
@swamp/aws/efs/mount-targetv2026.04.23.2mount_target.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
IpAddress?stringIf 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?stringIf 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?enumThe 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
FileSystemIdstringThe ID of the file system for which to create the mount target.
SecurityGroupsarrayVPC 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.
SubnetIdstringThe 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.
createCreate a EFS MountTarget
getGet a EFS MountTarget
ArgumentTypeDescription
identifierstringThe primary identifier of the EFS MountTarget
updateUpdate a EFS MountTarget
deleteDelete a EFS MountTarget
ArgumentTypeDescription
identifierstringThe primary identifier of the EFS MountTarget
syncSync EFS MountTarget state from AWS

Resources

state(infinite)— EFS MountTarget resource state