Package-level declarations
Types
Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use with Amazon EC2 Linux and Mac instances in the Amazon Web Services Cloud. With Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you add and remove files, so that 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.
Inherited functions
Creates an EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group override any identity information provided by the NFS client. The file system path is exposed as the access point's root directory. Applications using the access point can only access data in the application's own directory and any subdirectories. A file system can have a maximum of 10,000 access points unless you request an increase. To learn more, see Mounting a file system using EFS access points.
Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's Amazon Web Services account with the specified creation token, this operation does the following:
Creates a mount target for a file system. You can then mount the file system on EC2 instances by using the mount target.
Creates a replication configuration to either a new or existing EFS file system. For more information, see Amazon EFS replication in the Amazon EFS User Guide. The replication configuration specifies the following:
DEPRECATED - CreateTags
is deprecated and not maintained. To create tags for EFS resources, use the API action.
Deletes the specified access point. After deletion is complete, new clients can no longer connect to the access points. Clients connected to the access point at the time of deletion will continue to function until they terminate their connection.
Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you can't access any contents of the deleted file system.
Deletes the FileSystemPolicy
for the specified file system. The default FileSystemPolicy
goes into effect once the existing policy is deleted. For more information about the default file system policy, see Using Resource-based Policies with EFS.
Deletes the specified mount target.
Deletes a replication configuration. Deleting a replication configuration ends the replication process. After a replication configuration is deleted, the destination file system becomes Writeable
and its replication overwrite protection is re-enabled. For more information, see Delete a replication configuration.
DEPRECATED - DeleteTags
is deprecated and not maintained. To remove tags from EFS resources, use the API action.
Returns the description of a specific Amazon EFS access point if the AccessPointId
is provided. If you provide an EFS FileSystemId
, it returns descriptions of all access points for that file system. You can provide either an AccessPointId
or a FileSystemId
in the request, but not both.
Returns the account preferences settings for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region.
Returns the backup policy for the specified EFS file system.
Returns the FileSystemPolicy
for the specified EFS file system.
Returns the description of a specific Amazon EFS file system if either the file system CreationToken
or the FileSystemId
is provided. Otherwise, it returns descriptions of all file systems owned by the caller's Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
Returns the current LifecycleConfiguration
object for the specified EFS file system. Lifecycle management uses the LifecycleConfiguration
object to identify when to move files between storage classes. For a file system without a LifecycleConfiguration
object, the call returns an empty array in the response.
Returns the descriptions of all the current mount targets, or a specific mount target, for a file system. When requesting all of the current mount targets, the order of mount targets returned in the response is unspecified.
Returns the security groups currently in effect for a mount target. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not deleted
.
Retrieves the replication configuration for a specific file system. If a file system is not specified, all of the replication configurations for the Amazon Web Services account in an Amazon Web Services Region are retrieved.
DEPRECATED - The DescribeTags
action is deprecated and not maintained. To view tags associated with EFS resources, use the ListTagsForResource
API action.
Lists all tags for a top-level EFS resource. You must provide the ID of the resource that you want to retrieve the tags for.
Modifies the set of security groups in effect for a mount target.
Use this operation to set the account preference in the current Amazon Web Services Region to use long 17 character (63 bit) or short 8 character (32 bit) resource IDs for new EFS file system and mount target resources. All existing resource IDs are not affected by any changes you make. You can set the ID preference during the opt-in period as EFS transitions to long resource IDs. For more information, see Managing Amazon EFS resource IDs.
Updates the file system's backup policy. Use this action to start or stop automatic backups of the file system.
Applies an Amazon EFS FileSystemPolicy
to an Amazon EFS file system. A file system policy is an IAM resource-based policy and can contain multiple policy statements. A file system always has exactly one file system policy, which can be the default policy or an explicit policy set or updated using this API operation. EFS file system policies have a 20,000 character limit. When an explicit policy is set, it overrides the default policy. For more information about the default file system policy, see Default EFS file system policy.
Use this action to manage storage for your file system. A LifecycleConfiguration
consists of one or more LifecyclePolicy
objects that define the following:
Creates a tag for an EFS resource. You can create tags for EFS file systems and access points using this API operation.
Removes tags from an EFS resource. You can remove tags from EFS file systems and access points using this API operation.
Updates the throughput mode or the amount of provisioned throughput of an existing file system.
Updates protection on the file system.
Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.