logo
Expand description

Amazon Elastic File System

Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use with Amazon EC2 instances in the AWS Cloud. With Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you add and remove files, so your applications have the storage they need, when they need it. For more information, see the Amazon Elastic File System API Reference and the Amazon Elastic File System User Guide.

If you’re using the service, you’re probably looking for EfsClient and Efs.

Structs

Provides a description of an EFS file system access point.

The backup policy for the file system used to create automatic daily backups. If status has a value of ENABLED, the file system is being automatically backed up. For more information, see Automatic backups.

Required if the RootDirectory > Path specified does not exist. Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory > Path. If the access point root directory does not exist, EFS creates it with these settings when a client connects to the access point. When specifying CreationInfo, you must include values for all properties.

Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. If you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount using the access point will fail.

If you do not provide CreationInfo and the specified RootDirectory does not exist, attempts to mount the file system using the access point will fail.

A client for the EFS API.

A description of the file system.

The latest known metered size (in bytes) of data stored in the file system, in its Value field, and the time at which that size was determined in its Timestamp field. The value doesn't represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, the value represents the actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not necessarily the exact size the file system was at any instant in time.

Describes a policy used by EFS lifecycle management to transition files to the Infrequent Access (IA) storage class.

Provides a description of a mount target.

The full POSIX identity, including the user ID, group ID, and any secondary group IDs, on the access point that is used for all file system operations performed by NFS clients using the access point.

Specifies the directory on the Amazon EFS file system that the access point provides access to. The access point exposes the specified file system path as the root directory of your file system to applications using the access point. NFS clients using the access point can only access data in the access point's RootDirectory and it's subdirectories.

A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters: + - = . _ : /.

Enums

Errors returned by CreateAccessPoint

Errors returned by CreateFileSystem

Errors returned by CreateMountTarget

Errors returned by CreateTags

Errors returned by DeleteAccessPoint

Errors returned by DeleteFileSystem

Errors returned by DeleteFileSystemPolicy

Errors returned by DeleteMountTarget

Errors returned by DeleteTags

Errors returned by DescribeAccessPoints

Errors returned by DescribeAccountPreferences

Errors returned by DescribeBackupPolicy

Errors returned by DescribeFileSystemPolicy

Errors returned by DescribeFileSystems

Errors returned by DescribeLifecycleConfiguration

Errors returned by DescribeMountTargetSecurityGroups

Errors returned by DescribeMountTargets

Errors returned by DescribeTags

Errors returned by ListTagsForResource

Errors returned by ModifyMountTargetSecurityGroups

Errors returned by PutAccountPreferences

Errors returned by PutBackupPolicy

Errors returned by PutFileSystemPolicy

Errors returned by PutLifecycleConfiguration

Errors returned by TagResource

Errors returned by UntagResource

Errors returned by UpdateFileSystem

Traits

Trait representing the capabilities of the EFS API. EFS clients implement this trait.