EFS (Elastic File System)

Implementation details for API efs

Coverage Overview

Elastic File System (EFS) is supported by LocalStack only in the pro image.

AvailabilityTesting*
OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
CreateAccessPoint✔️pro✔️✔️✔️✔️Show Tests
CreateFileSystem✔️pro✔️✔️✔️✔️Show Tests
CreateMountTarget✔️pro✔️✔️✔️Show Tests
CreateReplicationConfiguration
CreateTags
DeleteAccessPoint✔️pro✔️✔️✔️Show Tests
DeleteFileSystem✔️pro✔️✔️✔️Show Tests
DeleteFileSystemPolicy
DeleteMountTarget✔️pro✔️✔️✔️Show Tests
DeleteReplicationConfiguration
DeleteTags
DescribeAccessPoints✔️pro✔️✔️✔️Show Tests
DescribeAccountPreferences
DescribeBackupPolicy✔️pro
DescribeFileSystemPolicy✔️pro✔️✔️✔️Show Tests
DescribeFileSystems✔️pro✔️✔️✔️Show Tests
DescribeLifecycleConfiguration✔️pro✔️✔️✔️Show Tests
DescribeMountTargetSecurityGroups✔️pro
DescribeMountTargets✔️pro✔️✔️✔️Show Tests
DescribeReplicationConfigurations
DescribeTags
ListTagsForResource✔️pro✔️✔️✔️Show Tests
ModifyMountTargetSecurityGroups✔️pro
PutAccountPreferences
PutBackupPolicy
PutFileSystemPolicy✔️pro✔️✔️✔️Show Tests
PutLifecycleConfiguration✔️pro✔️✔️✔️Show Tests
TagResource✔️pro
UntagResource✔️pro
UpdateFileSystem
UpdateFileSystemProtection

Terminology

  • Internal Test Suite: tested by LocalStack's internal integration test suite
  • External Test Suite: covered by an external integration test suite, that runs against LocalStack
  • Terraform Validated: operation tested with Terraform
  • AWS Validated: the integration test that includes this operation call was validated against AWS
  • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

Testing Details

This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

How to read the test details?

For each operation we put up a list of the related integration test cases.
Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

  • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
  • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
    • test name
    • status code returned (which is the expected one for the test case)
    • information about validation:
      • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
      • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


CreateAccessPoint

Parameters: ClientToken, FileSystemId, PosixUser, RootDirectory
  • LocalStack Pro
    • test_file_system_deployment LocalStack Pro: tests/aws/services/cloudformation/resources/test_efs.py::test_file_system_deployment HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: ClientToken, FileSystemId, PosixUser, RootDirectory, Tags
  • LocalStack Pro
    • test_access_point LocalStack Pro: tests/aws/services/efs/test_efs.py::TestEfsFileSystemCrud::test_access_point HTTP Status Code: 200 AWS validated Snapshot Tested

CreateFileSystem

Parameters: Backup, CreationToken, Encrypted, PerformanceMode
  • LocalStack Pro
    • test_listener LocalStack Pro: tests/aws/services/ecs/test_ecs_samples.py::TestDurableStorageSample::test_listener HTTP Status Code: 201 AWS validated Snapshot Tested
Parameters: Backup, CreationToken, Encrypted, PerformanceMode, ProvisionedThroughputInMibps, ThroughputMode
  • LocalStack Pro
    • test_file_system_deployment LocalStack Pro: tests/aws/services/cloudformation/resources/test_efs.py::test_file_system_deployment HTTP Status Code: 201 AWS validated Snapshot Tested
Parameters: CreationToken
  • LocalStack Pro
    • test_access_point LocalStack Pro: tests/aws/services/efs/test_efs.py::TestEfsFileSystemCrud::test_access_point HTTP Status Code: 201 AWS validated Snapshot Tested
    • test_lifecycle_configuration LocalStack Pro: tests/aws/services/efs/test_efs.py::TestEfsFileSystemCrud::test_lifecycle_configuration HTTP Status Code: 201 AWS validated Snapshot Tested
    • test_mount_target LocalStack Pro: tests/aws/services/efs/test_efs.py::TestEfsFileSystemCrud::test_mount_target HTTP Status Code: 201 AWS validated Snapshot Tested
    • test_efs_file_system_policy LocalStack Pro: tests/aws/services/iam/test_iam_enforcement.py::TestIAMEnforcementResourceBasedPolicies::test_efs_file_system_policy HTTP Status Code: 201 AWS validated Snapshot Tested
Parameters: CreationToken, PerformanceMode
  • LocalStack Pro
    • test_create_filesystem LocalStack Pro: tests/aws/services/efs/test_efs.py::TestEfsFileSystemCrud::test_create_filesystem HTTP Status Code: 201 AWS validated Snapshot Tested

CreateMountTarget

Parameters: FileSystemId, SecurityGroups, SubnetId
  • LocalStack Pro
    • test_file_system_deployment LocalStack Pro: tests/aws/services/cloudformation/resources/test_efs.py::test_file_system_deployment HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_listener LocalStack Pro: tests/aws/services/ecs/test_ecs_samples.py::TestDurableStorageSample::test_listener HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: FileSystemId, SubnetId
  • LocalStack Pro
    • test_mount_target LocalStack Pro: tests/aws/services/efs/test_efs.py::TestEfsFileSystemCrud::test_mount_target HTTP Status Code: 200 AWS validated Snapshot Tested

DeleteAccessPoint

Parameters: AccessPointId
  • LocalStack Pro
    • test_file_system_deployment LocalStack Pro: tests/aws/services/cloudformation/resources/test_efs.py::test_file_system_deployment HTTP Status Code: 204 AWS validated Snapshot Tested
    • test_access_point LocalStack Pro: tests/aws/services/efs/test_efs.py::TestEfsFileSystemCrud::test_access_point HTTP Status Code: 204 AWS validated Snapshot Tested

DeleteFileSystem

Parameters: FileSystemId
  • LocalStack Pro
    • test_file_system_deployment LocalStack Pro: tests/aws/services/cloudformation/resources/test_efs.py::test_file_system_deployment HTTP Status Code: 204 AWS validated Snapshot Tested
    • test_listener LocalStack Pro: tests/aws/services/ecs/test_ecs_samples.py::TestDurableStorageSample::test_listener HTTP Status Code: 204 AWS validated Snapshot Tested
    • test_access_point LocalStack Pro: tests/aws/services/efs/test_efs.py::TestEfsFileSystemCrud::test_access_point HTTP Status Code: 204 AWS validated Snapshot Tested
    • test_create_filesystem LocalStack Pro: tests/aws/services/efs/test_efs.py::TestEfsFileSystemCrud::test_create_filesystem HTTP Status Code: 204 AWS validated Snapshot Tested
    • test_lifecycle_configuration LocalStack Pro: tests/aws/services/efs/test_efs.py::TestEfsFileSystemCrud::test_lifecycle_configuration HTTP Status Code: 204 AWS validated Snapshot Tested
    • test_mount_target LocalStack Pro: tests/aws/services/efs/test_efs.py::TestEfsFileSystemCrud::test_mount_target HTTP Status Code: 204 AWS validated Snapshot Tested
    • test_efs_file_system_policy LocalStack Pro: tests/aws/services/iam/test_iam_enforcement.py::TestIAMEnforcementResourceBasedPolicies::test_efs_file_system_policy HTTP Status Code: 204 AWS validated Snapshot Tested
    • test_create_filesystem LocalStack Pro: tests/aws/services/efs/test_efs.py::TestEfsFileSystemCrud::test_create_filesystem HTTP Status Code: 404 (FileSystemNotFound) AWS validated Snapshot Tested
    • test_mount_target LocalStack Pro: tests/aws/services/efs/test_efs.py::TestEfsFileSystemCrud::test_mount_target HTTP Status Code: 409 (FileSystemInUse) AWS validated Snapshot Tested

DeleteMountTarget

Parameters: MountTargetId
  • LocalStack Pro
    • test_file_system_deployment LocalStack Pro: tests/aws/services/cloudformation/resources/test_efs.py::test_file_system_deployment HTTP Status Code: 204 AWS validated Snapshot Tested
    • test_listener LocalStack Pro: tests/aws/services/ecs/test_ecs_samples.py::TestDurableStorageSample::test_listener HTTP Status Code: 204 AWS validated Snapshot Tested
    • test_mount_target LocalStack Pro: tests/aws/services/efs/test_efs.py::TestEfsFileSystemCrud::test_mount_target HTTP Status Code: 204 AWS validated Snapshot Tested

DescribeAccessPoints

Parameters: AccessPointId
  • LocalStack Pro
    • test_file_system_deployment LocalStack Pro: tests/aws/services/cloudformation/resources/test_efs.py::test_file_system_deployment HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_file_system_deployment LocalStack Pro: tests/aws/services/cloudformation/resources/test_efs.py::test_file_system_deployment HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_file_system_deployment LocalStack Pro: tests/aws/services/cloudformation/resources/test_efs.py::test_file_system_deployment HTTP Status Code: 404 (AccessPointNotFound) AWS validated Snapshot Tested
    • test_access_point LocalStack Pro: tests/aws/services/efs/test_efs.py::TestEfsFileSystemCrud::test_access_point HTTP Status Code: 404 (AccessPointNotFound) AWS validated Snapshot Tested
Parameters: FileSystemId
  • LocalStack Pro
    • test_access_point LocalStack Pro: tests/aws/services/efs/test_efs.py::TestEfsFileSystemCrud::test_access_point HTTP Status Code: 200 AWS validated Snapshot Tested

DescribeFileSystemPolicy

Parameters: FileSystemId
  • LocalStack Pro
    • test_efs_file_system_policy LocalStack Pro: tests/aws/services/iam/test_iam_enforcement.py::TestIAMEnforcementResourceBasedPolicies::test_efs_file_system_policy HTTP Status Code: 200 AWS validated Snapshot Tested

DescribeFileSystems

Parameters: - (without any parameters)
  • LocalStack Pro
    • test_create_filesystem LocalStack Pro: tests/aws/services/efs/test_efs.py::TestEfsFileSystemCrud::test_create_filesystem HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: FileSystemId
  • LocalStack Pro
    • test_file_system_deployment LocalStack Pro: tests/aws/services/cloudformation/resources/test_efs.py::test_file_system_deployment HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_access_point LocalStack Pro: tests/aws/services/efs/test_efs.py::TestEfsFileSystemCrud::test_access_point HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_create_filesystem LocalStack Pro: tests/aws/services/efs/test_efs.py::TestEfsFileSystemCrud::test_create_filesystem HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_lifecycle_configuration LocalStack Pro: tests/aws/services/efs/test_efs.py::TestEfsFileSystemCrud::test_lifecycle_configuration HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_mount_target LocalStack Pro: tests/aws/services/efs/test_efs.py::TestEfsFileSystemCrud::test_mount_target HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_efs_file_system_policy LocalStack Pro: tests/aws/services/iam/test_iam_enforcement.py::TestIAMEnforcementResourceBasedPolicies::test_efs_file_system_policy HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_efs_file_system_policy LocalStack Pro: tests/aws/services/iam/test_iam_enforcement.py::TestIAMEnforcementResourceBasedPolicies::test_efs_file_system_policy HTTP Status Code: 403 (AccessDeniedException) AWS validated Snapshot Tested
    • test_create_filesystem LocalStack Pro: tests/aws/services/efs/test_efs.py::TestEfsFileSystemCrud::test_create_filesystem HTTP Status Code: 404 (FileSystemNotFound) AWS validated Snapshot Tested

DescribeLifecycleConfiguration

Parameters: FileSystemId
  • LocalStack Pro
    • test_lifecycle_configuration LocalStack Pro: tests/aws/services/efs/test_efs.py::TestEfsFileSystemCrud::test_lifecycle_configuration HTTP Status Code: 200 AWS validated Snapshot Tested

DescribeMountTargets

Parameters: FileSystemId
  • LocalStack Pro
    • test_access_point LocalStack Pro: tests/aws/services/efs/test_efs.py::TestEfsFileSystemCrud::test_access_point HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_lifecycle_configuration LocalStack Pro: tests/aws/services/efs/test_efs.py::TestEfsFileSystemCrud::test_lifecycle_configuration HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_mount_target LocalStack Pro: tests/aws/services/efs/test_efs.py::TestEfsFileSystemCrud::test_mount_target HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_create_filesystem LocalStack Pro: tests/aws/services/efs/test_efs.py::TestEfsFileSystemCrud::test_create_filesystem HTTP Status Code: 404 (FileSystemNotFound) AWS validated Snapshot Tested
Parameters: MountTargetId
  • LocalStack Pro
    • test_file_system_deployment LocalStack Pro: tests/aws/services/cloudformation/resources/test_efs.py::test_file_system_deployment HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_file_system_deployment LocalStack Pro: tests/aws/services/cloudformation/resources/test_efs.py::test_file_system_deployment HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_listener LocalStack Pro: tests/aws/services/ecs/test_ecs_samples.py::TestDurableStorageSample::test_listener HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_file_system_deployment LocalStack Pro: tests/aws/services/cloudformation/resources/test_efs.py::test_file_system_deployment HTTP Status Code: 404 (MountTargetNotFound) AWS validated Snapshot Tested
    • test_listener LocalStack Pro: tests/aws/services/ecs/test_ecs_samples.py::TestDurableStorageSample::test_listener HTTP Status Code: 404 (MountTargetNotFound) AWS validated Snapshot Tested

ListTagsForResource

Parameters: ResourceId
  • LocalStack Pro
    • test_efs_file_system_policy LocalStack Pro: tests/aws/services/iam/test_iam_enforcement.py::TestIAMEnforcementResourceBasedPolicies::test_efs_file_system_policy HTTP Status Code: 200 AWS validated Snapshot Tested

PutFileSystemPolicy

Parameters: BypassPolicyLockoutSafetyCheck, FileSystemId, Policy
  • LocalStack Pro
    • test_efs_file_system_policy LocalStack Pro: tests/aws/services/iam/test_iam_enforcement.py::TestIAMEnforcementResourceBasedPolicies::test_efs_file_system_policy HTTP Status Code: 200 AWS validated Snapshot Tested

PutLifecycleConfiguration

Parameters: FileSystemId, LifecyclePolicies
  • LocalStack Pro
    • test_lifecycle_configuration LocalStack Pro: tests/aws/services/efs/test_efs.py::TestEfsFileSystemCrud::test_lifecycle_configuration HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_lifecycle_configuration LocalStack Pro: tests/aws/services/efs/test_efs.py::TestEfsFileSystemCrud::test_lifecycle_configuration HTTP Status Code: 400 (BadRequest) AWS validated Snapshot Tested

Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)