aws-cdk.aws-efs

What it is and what it does

This package provides Python constructs for the AWS CDK v1 framework to declaratively define Amazon EFS file systems and related resources. It wraps EFS capabilities—file system creation, access points, lifecycle policies, performance modes, and security group management—into reusable CDK components that generate CloudFormation templates.

The module allows you to create POSIX-compliant, shared NFS storage accessible across EC2 instances and availability zones, configure encryption at rest, set lifecycle transitions to infrequent-access storage, import existing file systems, and manage access permissions via IAM roles. However, AWS CDK v1 reached end-of-support on 2023-06-01 and is no longer being updated; this package will not receive new features or maintenance.

Use it for:

• Define shared file storage for multi-instance EC2 workloads using infrastructure-as-code in AWS CDK v1 projects.
• Create EFS access points that enforce OS user/group identity and restrict client access to specific directory trees.
• Import and reference existing EFS file systems into a CDK stack to grant IAM roles file system permissions.
• Configure EFS lifecycle policies and performance modes at stack definition time rather than via the AWS console.
• Automatically mount EFS on EC2 instances during launch by combining file system constructs with user data scripts.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Provides CDK constructs to define Amazon EFS file systems, access points, and related networking within AWS infrastructure-as-code.

No. This package is end-of-support as of 2023-06-01 and is no longer being updated. AWS CDK v1 itself has reached end-of-support, and users should migrate to AWS CDK v2. Installing this package locks you into a deprecated framework version. If you are already on CDK v1, it may work, but new projects should use the v2 equivalent instead.

Install

aws-cdk-aws-efs on PyPI

pip install aws-cdk-aws-efs

uv add aws-cdk-aws-efs

poetry add aws-cdk-aws-efs

Installing aws-cdk.aws-efs

Before you install

Low friction installation. The package is marked inactive (Development Status :: 7 - Inactive) because AWS CDK v1 reached end-of-support on 2023-06-01; users should migrate to AWS CDK v2 instead. The repository remains active but this specific module is no longer being updated.

License in practice

Apache-2.0 permissive license allows commercial and private use with minimal restrictions, typical for AWS CDK libraries.

Quickstart

from aws_cdk import aws_efs as efs, aws_ec2 as ec2

file_system = efs.FileSystem(self, "MyEfsFileSystem",
    vpc=ec2.Vpc(self, "VPC"),
    lifecycle_policy=efs.LifecyclePolicy.AFTER_14_DAYS,
    performance_mode=efs.PerformanceMode.GENERAL_PURPOSE
)

Requires AWS CDK v1 environment and Python 3.7 or later. AWS CDK v1 is end-of-support as of 2023-06-01; new projects should use AWS CDK v2 instead.

Verify before relying

• Whether existing AWS CDK v1 projects can safely continue using this package despite end-of-support status.
• Migration path complexity and effort for moving from this v1 module to AWS CDK v2 equivalents.

Package facts

Evidence: aws_cdk.aws_efs-1.204.0-py3-none-any.whl

Tags

More Build Tools packages