com.amazonaws.services.elasticfilesystem

Class AmazonElasticFileSystemAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.elasticfilesystem.AmazonElasticFileSystemClient

com.amazonaws.services.elasticfilesystem.AmazonElasticFileSystemAsyncClient

All Implemented Interfaces:

AmazonElasticFileSystem, AmazonElasticFileSystemAsync

@ThreadSafe
public class AmazonElasticFileSystemAsyncClient
extends AmazonElasticFileSystemClient
implements AmazonElasticFileSystemAsync

Interface for accessing EFS asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Amazon Elastic File System

Field Summary

Fields inherited from class com.amazonaws.services.elasticfilesystem.AmazonElasticFileSystemClient

configFactory

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.elasticfilesystem.AmazonElasticFileSystem

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AmazonElasticFileSystemAsyncClient() Constructs a new asynchronous client to invoke service methods on EFS.
AmazonElasticFileSystemAsyncClient(AWSCredentials awsCredentials) Constructs a new asynchronous client to invoke service methods on EFS using the specified AWS account credentials.
AmazonElasticFileSystemAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on EFS using the specified AWS account credentials, executor service, and client configuration options.
AmazonElasticFileSystemAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on EFS using the specified AWS account credentials and executor service.
AmazonElasticFileSystemAsyncClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new asynchronous client to invoke service methods on EFS using the specified AWS account credentials provider.
AmazonElasticFileSystemAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on EFS using the provided AWS account credentials provider and client configuration options.
AmazonElasticFileSystemAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on EFS using the specified AWS account credentials provider, executor service, and client configuration options.
AmazonElasticFileSystemAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on EFS using the specified AWS account credentials provider and executor service.
AmazonElasticFileSystemAsyncClient(ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on EFS.

Method Summary

Modifier and Type	Method and Description
Future<CreateFileSystemResult>	createFileSystemAsync(CreateFileSystemRequest request) Creates a new, empty file system.
Future<CreateFileSystemResult>	createFileSystemAsync(CreateFileSystemRequest request, AsyncHandler<CreateFileSystemRequest,CreateFileSystemResult> asyncHandler) Creates a new, empty file system.
Future<CreateMountTargetResult>	createMountTargetAsync(CreateMountTargetRequest request) Creates a mount target for a file system.
Future<CreateMountTargetResult>	createMountTargetAsync(CreateMountTargetRequest request, AsyncHandler<CreateMountTargetRequest,CreateMountTargetResult> asyncHandler) Creates a mount target for a file system.
Future<CreateTagsResult>	createTagsAsync(CreateTagsRequest request) Creates or overwrites tags associated with a file system.
Future<CreateTagsResult>	createTagsAsync(CreateTagsRequest request, AsyncHandler<CreateTagsRequest,CreateTagsResult> asyncHandler) Creates or overwrites tags associated with a file system.
Future<DeleteFileSystemResult>	deleteFileSystemAsync(DeleteFileSystemRequest request) Deletes a file system, permanently severing access to its contents.
Future<DeleteFileSystemResult>	deleteFileSystemAsync(DeleteFileSystemRequest request, AsyncHandler<DeleteFileSystemRequest,DeleteFileSystemResult> asyncHandler) Deletes a file system, permanently severing access to its contents.
Future<DeleteMountTargetResult>	deleteMountTargetAsync(DeleteMountTargetRequest request) Deletes the specified mount target.
Future<DeleteMountTargetResult>	deleteMountTargetAsync(DeleteMountTargetRequest request, AsyncHandler<DeleteMountTargetRequest,DeleteMountTargetResult> asyncHandler) Deletes the specified mount target.
Future<DeleteTagsResult>	deleteTagsAsync(DeleteTagsRequest request) Deletes the specified tags from a file system.
Future<DeleteTagsResult>	deleteTagsAsync(DeleteTagsRequest request, AsyncHandler<DeleteTagsRequest,DeleteTagsResult> asyncHandler) Deletes the specified tags from a file system.
Future<DescribeFileSystemsResult>	describeFileSystemsAsync() Simplified method form for invoking the DescribeFileSystems operation.
Future<DescribeFileSystemsResult>	describeFileSystemsAsync(AsyncHandler<DescribeFileSystemsRequest,DescribeFileSystemsResult> asyncHandler) Simplified method form for invoking the DescribeFileSystems operation with an AsyncHandler.
Future<DescribeFileSystemsResult>	describeFileSystemsAsync(DescribeFileSystemsRequest request) Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided.
Future<DescribeFileSystemsResult>	describeFileSystemsAsync(DescribeFileSystemsRequest request, AsyncHandler<DescribeFileSystemsRequest,DescribeFileSystemsResult> asyncHandler) Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided.
Future<DescribeMountTargetsResult>	describeMountTargetsAsync(DescribeMountTargetsRequest request) Returns the descriptions of all the current mount targets, or a specific mount target, for a file system.
Future<DescribeMountTargetsResult>	describeMountTargetsAsync(DescribeMountTargetsRequest request, AsyncHandler<DescribeMountTargetsRequest,DescribeMountTargetsResult> asyncHandler) Returns the descriptions of all the current mount targets, or a specific mount target, for a file system.
Future<DescribeMountTargetSecurityGroupsResult>	describeMountTargetSecurityGroupsAsync(DescribeMountTargetSecurityGroupsRequest request) Returns the security groups currently in effect for a mount target.
Future<DescribeMountTargetSecurityGroupsResult>	describeMountTargetSecurityGroupsAsync(DescribeMountTargetSecurityGroupsRequest request, AsyncHandler<DescribeMountTargetSecurityGroupsRequest,DescribeMountTargetSecurityGroupsResult> asyncHandler) Returns the security groups currently in effect for a mount target.
Future<DescribeTagsResult>	describeTagsAsync(DescribeTagsRequest request) Returns the tags associated with a file system.
Future<DescribeTagsResult>	describeTagsAsync(DescribeTagsRequest request, AsyncHandler<DescribeTagsRequest,DescribeTagsResult> asyncHandler) Returns the tags associated with a file system.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<ModifyMountTargetSecurityGroupsResult>	modifyMountTargetSecurityGroupsAsync(ModifyMountTargetSecurityGroupsRequest request) Modifies the set of security groups in effect for a mount target.
Future<ModifyMountTargetSecurityGroupsResult>	modifyMountTargetSecurityGroupsAsync(ModifyMountTargetSecurityGroupsRequest request, AsyncHandler<ModifyMountTargetSecurityGroupsRequest,ModifyMountTargetSecurityGroupsResult> asyncHandler) Modifies the set of security groups in effect for a mount target.
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazonaws.services.elasticfilesystem.AmazonElasticFileSystemClient

createFileSystem, createMountTarget, createTags, deleteFileSystem, deleteMountTarget, deleteTags, describeFileSystems, describeFileSystems, describeMountTargets, describeMountTargetSecurityGroups, describeTags, getCachedResponseMetadata, modifyMountTargetSecurityGroups

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.elasticfilesystem.AmazonElasticFileSystem

createFileSystem, createMountTarget, createTags, deleteFileSystem, deleteMountTarget, deleteTags, describeFileSystems, describeFileSystems, describeMountTargets, describeMountTargetSecurityGroups, describeTags, getCachedResponseMetadata, modifyMountTargetSecurityGroups, setEndpoint, setRegion

Constructor Detail

AmazonElasticFileSystemAsyncClient

public AmazonElasticFileSystemAsyncClient()

Constructs a new asynchronous client to invoke service methods on EFS. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
• Instance profile credentials delivered through the Amazon EC2 metadata service

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

See Also:

DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)

AmazonElasticFileSystemAsyncClient

public AmazonElasticFileSystemAsyncClient(ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on EFS. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
• Instance profile credentials delivered through the Amazon EC2 metadata service

Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to EFS (ex: proxy settings, retry counts, etc).

See Also:

DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)

AmazonElasticFileSystemAsyncClient

public AmazonElasticFileSystemAsyncClient(AWSCredentials awsCredentials)

Constructs a new asynchronous client to invoke service methods on EFS using the specified AWS account credentials.

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

See Also:

Executors.newFixedThreadPool(int)

AmazonElasticFileSystemAsyncClient

public AmazonElasticFileSystemAsyncClient(AWSCredentials awsCredentials,
                                          ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on EFS using the specified AWS account credentials and executor service. Default client settings will be used.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AmazonElasticFileSystemAsyncClient

public AmazonElasticFileSystemAsyncClient(AWSCredentials awsCredentials,
                                          ClientConfiguration clientConfiguration,
                                          ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on EFS using the specified AWS account credentials, executor service, and client configuration options.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

AmazonElasticFileSystemAsyncClient

public AmazonElasticFileSystemAsyncClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new asynchronous client to invoke service methods on EFS using the specified AWS account credentials provider. Default client settings will be used.

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

See Also:

Executors.newFixedThreadPool(int)

AmazonElasticFileSystemAsyncClient

public AmazonElasticFileSystemAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                          ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on EFS using the provided AWS account credentials provider and client configuration options.

Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

See Also:

DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)

AmazonElasticFileSystemAsyncClient

public AmazonElasticFileSystemAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                          ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on EFS using the specified AWS account credentials provider and executor service. Default client settings will be used.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AmazonElasticFileSystemAsyncClient

public AmazonElasticFileSystemAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                          ClientConfiguration clientConfiguration,
                                          ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on EFS using the specified AWS account credentials provider, executor service, and client configuration options.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

Method Detail

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

createFileSystemAsync

public Future<CreateFileSystemResult> createFileSystemAsync(CreateFileSystemRequest request)

Description copied from interface: AmazonElasticFileSystemAsync

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:

• Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state creating.

• Returns with the description of the created file system.

Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system.

For basic use cases, you can use a randomly generated UUID for the creation token.

The idempotent operation allows you to retry a CreateFileSystem call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists error.

The CreateFileSystem call returns while the file system's lifecycle state is still creating. You can check the file system creation status by calling the DescribeFileSystems operation, which among other things returns the file system state.

This operation also takes an optional PerformanceMode parameter that you choose for your file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput than general purpose mode file systems, with a tradeoff of slightly higher latencies for most file operations. For more information, see Amazon EFS: Performance Modes.

After the file system is fully created, Amazon EFS sets its lifecycle state to available, at which point you can create one or more mount targets for the file system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in your VPC via the mount target. For more information, see Amazon EFS: How it Works.

This operation requires permissions for the elasticfilesystem:CreateFileSystem action.

Specified by:

createFileSystemAsync in interface AmazonElasticFileSystemAsync

Returns:

A Java Future containing the result of the CreateFileSystem operation returned by the service.

createFileSystemAsync

public Future<CreateFileSystemResult> createFileSystemAsync(CreateFileSystemRequest request,
                                                            AsyncHandler<CreateFileSystemRequest,CreateFileSystemResult> asyncHandler)

Description copied from interface: AmazonElasticFileSystemAsync

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:

• Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state creating.

• Returns with the description of the created file system.

Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system.

For basic use cases, you can use a randomly generated UUID for the creation token.

The idempotent operation allows you to retry a CreateFileSystem call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists error.

The CreateFileSystem call returns while the file system's lifecycle state is still creating. You can check the file system creation status by calling the DescribeFileSystems operation, which among other things returns the file system state.

This operation also takes an optional PerformanceMode parameter that you choose for your file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput than general purpose mode file systems, with a tradeoff of slightly higher latencies for most file operations. For more information, see Amazon EFS: Performance Modes.

After the file system is fully created, Amazon EFS sets its lifecycle state to available, at which point you can create one or more mount targets for the file system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in your VPC via the mount target. For more information, see Amazon EFS: How it Works.

This operation requires permissions for the elasticfilesystem:CreateFileSystem action.

Specified by:

createFileSystemAsync in interface AmazonElasticFileSystemAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateFileSystem operation returned by the service.

createMountTargetAsync

public Future<CreateMountTargetResult> createMountTargetAsync(CreateMountTargetRequest request)

Description copied from interface: AmazonElasticFileSystemAsync

Creates a mount target for a file system. You can then mount the file system on EC2 instances via the mount target.

You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system. For more information, see Amazon EFS: How it Works.

In the request, you also specify a file system ID for which you are creating the mount target and the file system's lifecycle state must be available. For more information, see DescribeFileSystems.

In the request, you also provide a subnet ID, which determines the following:

• VPC in which Amazon EFS creates the mount target

• Availability Zone in which Amazon EFS creates the mount target

• IP address range from which Amazon EFS selects the IP address of the mount target (if you don't specify an IP address in the request)

After creating the mount target, Amazon EFS returns a response that includes, a MountTargetId and an IpAddress. You use this IP address when mounting the file system in an EC2 instance. You can also use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file system via the mount target can resolve the mount target's DNS name to its IP address. For more information, see How it Works: Implementation Overview.

Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the subnet specified in the request to add another mount target must meet the following requirements:

• Must belong to the same VPC as the subnets of the existing mount targets

• Must not be in the same Availability Zone as any of the subnets of the existing mount targets

If the request satisfies the requirements, Amazon EFS does the following:

• Creates a new mount target in the specified subnet.

• Also creates a new network interface in the subnet as follows:

  • If the request provides an IpAddress, Amazon EFS assigns that IP address to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet (in the same way that the Amazon EC2 CreateNetworkInterface call does when a request does not specify a primary private IP address).

  • If the request provides SecurityGroups, this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC.

  • Assigns the description Mount target fsmt-id for file system fs-id where fsmt-id is the mount target ID, and fs-id is the FileSystemId.

  • Sets the requesterManaged property of the network interface to true, and the requesterId value to EFS.

  Each Amazon EFS mount target has one corresponding requestor-managed EC2 network interface. After the network interface is created, Amazon EFS sets the NetworkInterfaceId field in the mount target's description to the network interface ID, and the IpAddress field to its address. If network interface creation fails, the entire CreateMountTarget operation fails.

The CreateMountTarget call returns only after creating the network interface, but while the mount target state is still creating. You can check the mount target creation status by calling the DescribeFileSystems operation, which among other things returns the mount target state.

We recommend you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, see Amazon EFS. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario. If the Availability Zone in which your mount target is created goes down, then you won't be able to access your file system through that mount target.

This operation requires permissions for the following action on the file system:

• elasticfilesystem:CreateMountTarget

This operation also requires permissions for the following Amazon EC2 actions:

• ec2:DescribeSubnets

• ec2:DescribeNetworkInterfaces

• ec2:CreateNetworkInterface

Specified by:

createMountTargetAsync in interface AmazonElasticFileSystemAsync

Returns:

A Java Future containing the result of the CreateMountTarget operation returned by the service.

createMountTargetAsync

public Future<CreateMountTargetResult> createMountTargetAsync(CreateMountTargetRequest request,
                                                              AsyncHandler<CreateMountTargetRequest,CreateMountTargetResult> asyncHandler)

Description copied from interface: AmazonElasticFileSystemAsync

Creates a mount target for a file system. You can then mount the file system on EC2 instances via the mount target.

You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system. For more information, see Amazon EFS: How it Works.

In the request, you also specify a file system ID for which you are creating the mount target and the file system's lifecycle state must be available. For more information, see DescribeFileSystems.

In the request, you also provide a subnet ID, which determines the following:

• VPC in which Amazon EFS creates the mount target

• Availability Zone in which Amazon EFS creates the mount target

• IP address range from which Amazon EFS selects the IP address of the mount target (if you don't specify an IP address in the request)

After creating the mount target, Amazon EFS returns a response that includes, a MountTargetId and an IpAddress. You use this IP address when mounting the file system in an EC2 instance. You can also use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file system via the mount target can resolve the mount target's DNS name to its IP address. For more information, see How it Works: Implementation Overview.

Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the subnet specified in the request to add another mount target must meet the following requirements:

• Must belong to the same VPC as the subnets of the existing mount targets

• Must not be in the same Availability Zone as any of the subnets of the existing mount targets

If the request satisfies the requirements, Amazon EFS does the following:

• Creates a new mount target in the specified subnet.

• Also creates a new network interface in the subnet as follows:

  • If the request provides an IpAddress, Amazon EFS assigns that IP address to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet (in the same way that the Amazon EC2 CreateNetworkInterface call does when a request does not specify a primary private IP address).

  • If the request provides SecurityGroups, this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC.

  • Assigns the description Mount target fsmt-id for file system fs-id where fsmt-id is the mount target ID, and fs-id is the FileSystemId.

  • Sets the requesterManaged property of the network interface to true, and the requesterId value to EFS.

  Each Amazon EFS mount target has one corresponding requestor-managed EC2 network interface. After the network interface is created, Amazon EFS sets the NetworkInterfaceId field in the mount target's description to the network interface ID, and the IpAddress field to its address. If network interface creation fails, the entire CreateMountTarget operation fails.

The CreateMountTarget call returns only after creating the network interface, but while the mount target state is still creating. You can check the mount target creation status by calling the DescribeFileSystems operation, which among other things returns the mount target state.

We recommend you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, see Amazon EFS. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario. If the Availability Zone in which your mount target is created goes down, then you won't be able to access your file system through that mount target.

This operation requires permissions for the following action on the file system:

• elasticfilesystem:CreateMountTarget

This operation also requires permissions for the following Amazon EC2 actions:

• ec2:DescribeSubnets

• ec2:DescribeNetworkInterfaces

• ec2:CreateNetworkInterface

Specified by:

createMountTargetAsync in interface AmazonElasticFileSystemAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateMountTarget operation returned by the service.

createTagsAsync

public Future<CreateTagsResult> createTagsAsync(CreateTagsRequest request)

Description copied from interface: AmazonElasticFileSystemAsync

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.

This operation requires permission for the elasticfilesystem:CreateTags action.

Specified by:

createTagsAsync in interface AmazonElasticFileSystemAsync

Returns:

A Java Future containing the result of the CreateTags operation returned by the service.

createTagsAsync

public Future<CreateTagsResult> createTagsAsync(CreateTagsRequest request,
                                                AsyncHandler<CreateTagsRequest,CreateTagsResult> asyncHandler)

Description copied from interface: AmazonElasticFileSystemAsync

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.

This operation requires permission for the elasticfilesystem:CreateTags action.

Specified by:

createTagsAsync in interface AmazonElasticFileSystemAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateTags operation returned by the service.

deleteFileSystemAsync

public Future<DeleteFileSystemResult> deleteFileSystemAsync(DeleteFileSystemRequest request)

Description copied from interface: AmazonElasticFileSystemAsync

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.

You can't delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see DescribeMountTargets and DeleteMountTarget.

The DeleteFileSystem call returns while the file system state is still deleting. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your account. If you pass file system ID or creation token for the deleted file system, the DescribeFileSystems returns a 404 FileSystemNotFound error.

This operation requires permissions for the elasticfilesystem:DeleteFileSystem action.

Specified by:

deleteFileSystemAsync in interface AmazonElasticFileSystemAsync

Returns:

A Java Future containing the result of the DeleteFileSystem operation returned by the service.

deleteFileSystemAsync

public Future<DeleteFileSystemResult> deleteFileSystemAsync(DeleteFileSystemRequest request,
                                                            AsyncHandler<DeleteFileSystemRequest,DeleteFileSystemResult> asyncHandler)

Description copied from interface: AmazonElasticFileSystemAsync

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.

You can't delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see DescribeMountTargets and DeleteMountTarget.

The DeleteFileSystem call returns while the file system state is still deleting. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your account. If you pass file system ID or creation token for the deleted file system, the DescribeFileSystems returns a 404 FileSystemNotFound error.

This operation requires permissions for the elasticfilesystem:DeleteFileSystem action.

Specified by:

deleteFileSystemAsync in interface AmazonElasticFileSystemAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteFileSystem operation returned by the service.

deleteMountTargetAsync

public Future<DeleteMountTargetResult> deleteMountTargetAsync(DeleteMountTargetRequest request)

Description copied from interface: AmazonElasticFileSystemAsync

Deletes the specified mount target.

This operation forcibly breaks any mounts of the file system via the mount target that is being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes may be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC via another mount target.

This operation requires permissions for the following action on the file system:

• elasticfilesystem:DeleteMountTarget

The DeleteMountTarget call returns while the mount target state is still deleting. You can check the mount target deletion by calling the DescribeMountTargets operation, which returns a list of mount target descriptions for the given file system.

The operation also requires permissions for the following Amazon EC2 action on the mount target's network interface:

• ec2:DeleteNetworkInterface

Specified by:

deleteMountTargetAsync in interface AmazonElasticFileSystemAsync

Returns:

A Java Future containing the result of the DeleteMountTarget operation returned by the service.

deleteMountTargetAsync

public Future<DeleteMountTargetResult> deleteMountTargetAsync(DeleteMountTargetRequest request,
                                                              AsyncHandler<DeleteMountTargetRequest,DeleteMountTargetResult> asyncHandler)

Description copied from interface: AmazonElasticFileSystemAsync

Deletes the specified mount target.

This operation forcibly breaks any mounts of the file system via the mount target that is being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes may be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC via another mount target.

This operation requires permissions for the following action on the file system:

• elasticfilesystem:DeleteMountTarget

The DeleteMountTarget call returns while the mount target state is still deleting. You can check the mount target deletion by calling the DescribeMountTargets operation, which returns a list of mount target descriptions for the given file system.

The operation also requires permissions for the following Amazon EC2 action on the mount target's network interface:

• ec2:DeleteNetworkInterface

Specified by:

deleteMountTargetAsync in interface AmazonElasticFileSystemAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteMountTarget operation returned by the service.

deleteTagsAsync

public Future<DeleteTagsResult> deleteTagsAsync(DeleteTagsRequest request)

Description copied from interface: AmazonElasticFileSystemAsync

Deletes the specified tags from a file system. If the DeleteTags request includes a tag key that does not 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.

This operation requires permissions for the elasticfilesystem:DeleteTags action.

Specified by:

deleteTagsAsync in interface AmazonElasticFileSystemAsync

Returns:

A Java Future containing the result of the DeleteTags operation returned by the service.

deleteTagsAsync

public Future<DeleteTagsResult> deleteTagsAsync(DeleteTagsRequest request,
                                                AsyncHandler<DeleteTagsRequest,DeleteTagsResult> asyncHandler)

Description copied from interface: AmazonElasticFileSystemAsync

Deletes the specified tags from a file system. If the DeleteTags request includes a tag key that does not 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.

This operation requires permissions for the elasticfilesystem:DeleteTags action.

Specified by:

deleteTagsAsync in interface AmazonElasticFileSystemAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteTags operation returned by the service.

describeFileSystemsAsync

public Future<DescribeFileSystemsResult> describeFileSystemsAsync(DescribeFileSystemsRequest request)

Description copied from interface: AmazonElasticFileSystemAsync

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.

When retrieving all file system descriptions, you can optionally specify the MaxItems parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon EFS returns a NextMarker, an opaque token, in the response. In this case, you should send a subsequent request with the Marker request parameter set to the value of NextMarker.

To retrieve a list of your file system descriptions, this operation is used in an iterative process, where DescribeFileSystems is called first without the Marker and then the operation continues to call it with the Marker parameter set to the value of the NextMarker from the previous response until the response has no NextMarker.

The implementation may return fewer than MaxItems file system descriptions while still including a NextMarker value.

The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multi-call iteration is unspecified.

This operation requires permissions for the elasticfilesystem:DescribeFileSystems action.

Specified by:

describeFileSystemsAsync in interface AmazonElasticFileSystemAsync

Returns:

A Java Future containing the result of the DescribeFileSystems operation returned by the service.

describeFileSystemsAsync

public Future<DescribeFileSystemsResult> describeFileSystemsAsync(DescribeFileSystemsRequest request,
                                                                  AsyncHandler<DescribeFileSystemsRequest,DescribeFileSystemsResult> asyncHandler)

Description copied from interface: AmazonElasticFileSystemAsync

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.

When retrieving all file system descriptions, you can optionally specify the MaxItems parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon EFS returns a NextMarker, an opaque token, in the response. In this case, you should send a subsequent request with the Marker request parameter set to the value of NextMarker.

To retrieve a list of your file system descriptions, this operation is used in an iterative process, where DescribeFileSystems is called first without the Marker and then the operation continues to call it with the Marker parameter set to the value of the NextMarker from the previous response until the response has no NextMarker.

The implementation may return fewer than MaxItems file system descriptions while still including a NextMarker value.

The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multi-call iteration is unspecified.

This operation requires permissions for the elasticfilesystem:DescribeFileSystems action.

Specified by:

describeFileSystemsAsync in interface AmazonElasticFileSystemAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeFileSystems operation returned by the service.

describeFileSystemsAsync

public Future<DescribeFileSystemsResult> describeFileSystemsAsync()

Simplified method form for invoking the DescribeFileSystems operation.

Specified by:

describeFileSystemsAsync in interface AmazonElasticFileSystemAsync

See Also:

describeFileSystemsAsync(DescribeFileSystemsRequest)

describeFileSystemsAsync

public Future<DescribeFileSystemsResult> describeFileSystemsAsync(AsyncHandler<DescribeFileSystemsRequest,DescribeFileSystemsResult> asyncHandler)

Simplified method form for invoking the DescribeFileSystems operation with an AsyncHandler.

Specified by:

describeFileSystemsAsync in interface AmazonElasticFileSystemAsync

See Also:

describeFileSystemsAsync(DescribeFileSystemsRequest, com.amazonaws.handlers.AsyncHandler)

describeMountTargetSecurityGroupsAsync

public Future<DescribeMountTargetSecurityGroupsResult> describeMountTargetSecurityGroupsAsync(DescribeMountTargetSecurityGroupsRequest request)

Description copied from interface: AmazonElasticFileSystemAsync

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.

This operation requires permissions for the following actions:

• elasticfilesystem:DescribeMountTargetSecurityGroups action on the mount target's file system.

• ec2:DescribeNetworkInterfaceAttribute action on the mount target's network interface.

Specified by:

describeMountTargetSecurityGroupsAsync in interface AmazonElasticFileSystemAsync

Returns:

A Java Future containing the result of the DescribeMountTargetSecurityGroups operation returned by the service.

describeMountTargetSecurityGroupsAsync

public Future<DescribeMountTargetSecurityGroupsResult> describeMountTargetSecurityGroupsAsync(DescribeMountTargetSecurityGroupsRequest request,
                                                                                              AsyncHandler<DescribeMountTargetSecurityGroupsRequest,DescribeMountTargetSecurityGroupsResult> asyncHandler)

Description copied from interface: AmazonElasticFileSystemAsync

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.

This operation requires permissions for the following actions:

• elasticfilesystem:DescribeMountTargetSecurityGroups action on the mount target's file system.

• ec2:DescribeNetworkInterfaceAttribute action on the mount target's network interface.

Specified by:

describeMountTargetSecurityGroupsAsync in interface AmazonElasticFileSystemAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeMountTargetSecurityGroups operation returned by the service.

describeMountTargetsAsync

public Future<DescribeMountTargetsResult> describeMountTargetsAsync(DescribeMountTargetsRequest request)

Description copied from interface: AmazonElasticFileSystemAsync

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.

This operation requires permissions for the elasticfilesystem:DescribeMountTargets action, on either the file system ID that you specify in FileSystemId, or on the file system of the mount target that you specify in MountTargetId.

Specified by:

describeMountTargetsAsync in interface AmazonElasticFileSystemAsync

Returns:

A Java Future containing the result of the DescribeMountTargets operation returned by the service.

describeMountTargetsAsync

public Future<DescribeMountTargetsResult> describeMountTargetsAsync(DescribeMountTargetsRequest request,
                                                                    AsyncHandler<DescribeMountTargetsRequest,DescribeMountTargetsResult> asyncHandler)

Description copied from interface: AmazonElasticFileSystemAsync

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.

This operation requires permissions for the elasticfilesystem:DescribeMountTargets action, on either the file system ID that you specify in FileSystemId, or on the file system of the mount target that you specify in MountTargetId.

Specified by:

describeMountTargetsAsync in interface AmazonElasticFileSystemAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeMountTargets operation returned by the service.

describeTagsAsync

public Future<DescribeTagsResult> describeTagsAsync(DescribeTagsRequest request)

Description copied from interface: AmazonElasticFileSystemAsync

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 multi-call iteration (when using pagination) is unspecified.

This operation requires permissions for the elasticfilesystem:DescribeTags action.

Specified by:

describeTagsAsync in interface AmazonElasticFileSystemAsync

Returns:

A Java Future containing the result of the DescribeTags operation returned by the service.

describeTagsAsync

public Future<DescribeTagsResult> describeTagsAsync(DescribeTagsRequest request,
                                                    AsyncHandler<DescribeTagsRequest,DescribeTagsResult> asyncHandler)

Description copied from interface: AmazonElasticFileSystemAsync

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 multi-call iteration (when using pagination) is unspecified.

This operation requires permissions for the elasticfilesystem:DescribeTags action.

Specified by:

describeTagsAsync in interface AmazonElasticFileSystemAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeTags operation returned by the service.

modifyMountTargetSecurityGroupsAsync

public Future<ModifyMountTargetSecurityGroupsResult> modifyMountTargetSecurityGroupsAsync(ModifyMountTargetSecurityGroupsRequest request)

Description copied from interface: AmazonElasticFileSystemAsync

Modifies the set of security groups in effect for a mount target.

When you create a mount target, Amazon EFS also creates a new network interface. For more information, see CreateMountTarget. This operation replaces the security groups in effect for the network interface associated with a mount target, with the SecurityGroups provided in the request. 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.

The operation requires permissions for the following actions:

• elasticfilesystem:ModifyMountTargetSecurityGroups action on the mount target's file system.

• ec2:ModifyNetworkInterfaceAttribute action on the mount target's network interface.

Specified by:

modifyMountTargetSecurityGroupsAsync in interface AmazonElasticFileSystemAsync

Returns:

A Java Future containing the result of the ModifyMountTargetSecurityGroups operation returned by the service.

modifyMountTargetSecurityGroupsAsync

public Future<ModifyMountTargetSecurityGroupsResult> modifyMountTargetSecurityGroupsAsync(ModifyMountTargetSecurityGroupsRequest request,
                                                                                          AsyncHandler<ModifyMountTargetSecurityGroupsRequest,ModifyMountTargetSecurityGroupsResult> asyncHandler)

Description copied from interface: AmazonElasticFileSystemAsync

Modifies the set of security groups in effect for a mount target.

When you create a mount target, Amazon EFS also creates a new network interface. For more information, see CreateMountTarget. This operation replaces the security groups in effect for the network interface associated with a mount target, with the SecurityGroups provided in the request. 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.

The operation requires permissions for the following actions:

• elasticfilesystem:ModifyMountTargetSecurityGroups action on the mount target's file system.

• ec2:ModifyNetworkInterfaceAttribute action on the mount target's network interface.

Specified by:

modifyMountTargetSecurityGroupsAsync in interface AmazonElasticFileSystemAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ModifyMountTargetSecurityGroups operation returned by the service.

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AmazonElasticFileSystem

Overrides:

shutdown in class AmazonWebServiceClient