S3Files class
S3 Files makes S3 buckets accessible as high-performance file systems powered by EFS. This service enables file system interface access to S3 data with sub-millisecond latencies through mount targets, supporting AI/ML workloads, media processing, and hybrid storage workflows that require both file system and object storage access to the same data.
Constructors
- S3Files({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<CreateAccessPointResponse> - Creates an S3 File System Access Point for application-specific access with POSIX user identity and root directory enforcement. Access points provide a way to manage access to shared datasets in multi-tenant scenarios.
-
createFileSystem(
{required String bucket, required String roleArn, bool? acceptBucketWarning, String? clientToken, String? kmsKeyId, String? prefix, List< Tag> ? tags}) → Future<CreateFileSystemResponse> - Creates an S3 File System resource scoped to a bucket or prefix within a bucket, enabling file system access to S3 data. To create a file system, you need an S3 bucket and an IAM role that grants the service permission to access the bucket.
-
createMountTarget(
{required String fileSystemId, required String subnetId, IpAddressType? ipAddressType, String? ipv4Address, String? ipv6Address, List< String> ? securityGroups}) → Future<CreateMountTargetResponse> - Creates a mount target resource as an endpoint for mounting the S3 File System from compute resources in a specific Availability Zone and VPC. Mount targets provide network access to the file system.
-
deleteAccessPoint(
{required String accessPointId}) → Future< void> - Deletes an S3 File System Access Point. This operation is irreversible.
-
deleteFileSystem(
{required String fileSystemId, bool? forceDelete}) → Future< void> - Deletes an S3 File System. You can optionally force deletion of a file system that has pending export data.
-
deleteFileSystemPolicy(
{required String fileSystemId}) → Future< void> - Deletes the IAM resource policy of an S3 File System.
-
deleteMountTarget(
{required String mountTargetId}) → Future< void> - Deletes the specified mount target. This operation is irreversible.
-
getAccessPoint(
{required String accessPointId}) → Future< GetAccessPointResponse> - Returns resource information for an S3 File System Access Point.
-
getFileSystem(
{required String fileSystemId}) → Future< GetFileSystemResponse> - Returns resource information for the specified S3 File System including status, configuration, and metadata.
-
getFileSystemPolicy(
{required String fileSystemId}) → Future< GetFileSystemPolicyResponse> - Returns the IAM resource policy of an S3 File System.
-
getMountTarget(
{required String mountTargetId}) → Future< GetMountTargetResponse> - Returns detailed resource information for the specified mount target including network configuration.
-
getSynchronizationConfiguration(
{required String fileSystemId}) → Future< GetSynchronizationConfigurationResponse> - Returns the synchronization configuration for the specified S3 File System, including import data rules and expiration data rules.
-
listAccessPoints(
{required String fileSystemId, int? maxResults, String? nextToken}) → Future< ListAccessPointsResponse> - Returns resource information for all S3 File System Access Points associated with the specified S3 File System.
-
listFileSystems(
{String? bucket, int? maxResults, String? nextToken}) → Future< ListFileSystemsResponse> - Returns a list of all S3 File Systems owned by the account with optional filtering by bucket.
-
listMountTargets(
{String? accessPointId, String? fileSystemId, int? maxResults, String? nextToken}) → Future< ListMountTargetsResponse> - Returns resource information for all mount targets with optional filtering by file system, access point, and VPC.
-
listTagsForResource(
{required String resourceId, int? maxResults, String? nextToken}) → Future< ListTagsForResourceResponse> - Lists all tags for S3 Files resources.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
putFileSystemPolicy(
{required String fileSystemId, required String policy}) → Future< void> - Creates or replaces the IAM resource policy for an S3 File System to control access permissions.
-
putSynchronizationConfiguration(
{required List< ExpirationDataRule> expirationDataRules, required String fileSystemId, required List<ImportDataRule> importDataRules, int? latestVersionNumber}) → Future<void> - Creates or updates the synchronization configuration for the specified S3 File System, including import data rules and expiration data rules.
-
tagResource(
{required String resourceId, required List< Tag> tags}) → Future<void> - Creates tags for S3 Files resources using standard Amazon Web Services tagging APIs.
-
toString(
) → String -
A string representation of this object.
inherited
-
untagResource(
{required String resourceId, required List< String> tagKeys}) → Future<void> - Removes tags from S3 Files resources.
-
updateMountTarget(
{required String mountTargetId, required List< String> securityGroups}) → Future<UpdateMountTargetResponse> - Updates the mount target resource, specifically security group configurations.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited