EFS class

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 User Guide.

Constructors

EFS({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createAccessPoint({required String fileSystemId, String? clientToken, PosixUser? posixUser, RootDirectory? rootDirectory, List<Tag>? tags}) → Future<AccessPointDescription>
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 its own directory and below. To learn more, see Mounting a File System Using EFS Access Points.
createFileSystem({String? creationToken, bool? encrypted, String? kmsKeyId, PerformanceMode? performanceMode, double? provisionedThroughputInMibps, List<Tag>? tags, ThroughputMode? throughputMode}) → Future<FileSystemDescription>
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 AWS account with the specified creation token, this operation does the following:
createMountTarget({required String fileSystemId, required String subnetId, String? ipAddress, List<String>? securityGroups}) → Future<MountTargetDescription>
Creates a mount target for a file system. You can then mount the file system on EC2 instances by using the mount target.
createTags({required String fileSystemId, required List<Tag> tags}) → Future<void>
Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If a tag key specified in the request already exists on the file system, this operation overwrites its value with the value provided in the request. If you add the Name tag to your file system, Amazon EFS returns it in the response to the DescribeFileSystems operation.
deleteAccessPoint({required String accessPointId}) → Future<void>
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.
deleteFileSystem({required String fileSystemId}) → Future<void>
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.
deleteFileSystemPolicy({required String fileSystemId}) → Future<void>
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.
deleteMountTarget({required String mountTargetId}) → Future<void>
Deletes the specified mount target.
deleteTags({required String fileSystemId, required List<String> tagKeys}) → Future<void>
Deletes the specified tags from a file system. If the DeleteTags request includes a tag key that doesn't exist, Amazon EFS ignores it and doesn't cause an error. For more information about tags and related restrictions, see Tag Restrictions in the AWS Billing and Cost Management User Guide.
describeAccessPoints({String? accessPointId, String? fileSystemId, int? maxResults, String? nextToken}) → Future<DescribeAccessPointsResponse>
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.
describeBackupPolicy({required String fileSystemId}) → Future<BackupPolicyDescription>
Returns the backup policy for the specified EFS file system.
describeFileSystemPolicy({required String fileSystemId}) → Future<FileSystemPolicyDescription>
Returns the FileSystemPolicy for the specified EFS file system.
describeFileSystems({String? creationToken, String? fileSystemId, String? marker, int? maxItems}) → Future<DescribeFileSystemsResponse>
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 AWS account in the AWS Region of the endpoint that you're calling.
describeLifecycleConfiguration({required String fileSystemId}) → Future<LifecycleConfigurationDescription>
Returns the current LifecycleConfiguration object for the specified Amazon EFS file system. EFS lifecycle management uses the LifecycleConfiguration object to identify which files to move to the EFS Infrequent Access (IA) storage class. For a file system without a LifecycleConfiguration object, the call returns an empty array in the response.
describeMountTargets({String? accessPointId, String? fileSystemId, String? marker, int? maxItems, String? mountTargetId}) → Future<DescribeMountTargetsResponse>
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.
describeMountTargetSecurityGroups({required String mountTargetId}) → Future<DescribeMountTargetSecurityGroupsResponse>
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.
describeTags({required String fileSystemId, String? marker, int? maxItems}) → Future<DescribeTagsResponse>
Returns the tags associated with a file system. The order of tags returned in the response of one DescribeTags call and the order of tags returned across the responses of a multiple-call iteration (when using pagination) is unspecified.
listTagsForResource({required String resourceId, int? maxResults, String? nextToken}) → Future<ListTagsForResourceResponse>
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.
modifyMountTargetSecurityGroups({required String mountTargetId, List<String>? securityGroups}) → Future<void>
Modifies the set of security groups in effect for a mount target.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
putBackupPolicy({required BackupPolicy backupPolicy, required String fileSystemId}) → Future<BackupPolicyDescription>
Updates the file system's backup policy. Use this action to start or stop automatic backups of the file system.
putFileSystemPolicy({required String fileSystemId, required String policy, bool? bypassPolicyLockoutSafetyCheck}) → Future<FileSystemPolicyDescription>
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. 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.
putLifecycleConfiguration({required String fileSystemId, required List<LifecyclePolicy> lifecyclePolicies}) → Future<LifecycleConfigurationDescription>
Enables lifecycle management by creating a new LifecycleConfiguration object. A LifecycleConfiguration object defines when files in an Amazon EFS file system are automatically transitioned to the lower-cost EFS Infrequent Access (IA) storage class. A LifecycleConfiguration applies to all files in a file system.
tagResource({required String resourceId, required List<Tag> tags}) → Future<void>
Creates a tag for an EFS resource. You can create tags for EFS file systems and access points using this API operation.
toString() → String
A string representation of this object.
inherited
untagResource({required String resourceId, required List<String> tagKeys}) → Future<void>
Removes tags from an EFS resource. You can remove tags from EFS file systems and access points using this API operation.
updateFileSystem({required String fileSystemId, double? provisionedThroughputInMibps, ThroughputMode? throughputMode}) → Future<FileSystemDescription>
Updates the throughput mode or the amount of provisioned throughput of an existing file system.

Operators

operator ==(Object other) → bool
The equality operator.
inherited