public interface AmazonElasticFileSystemAsync extends AmazonElasticFileSystem
| Modifier and Type | Method and Description |
|---|---|
Future<CreateFileSystemResult> |
createFileSystemAsync(CreateFileSystemRequest createFileSystemRequest)
Creates a new, empty file system.
|
Future<CreateFileSystemResult> |
createFileSystemAsync(CreateFileSystemRequest createFileSystemRequest,
AsyncHandler<CreateFileSystemRequest,CreateFileSystemResult> asyncHandler)
Creates a new, empty file system.
|
Future<CreateMountTargetResult> |
createMountTargetAsync(CreateMountTargetRequest createMountTargetRequest)
Creates a mount target for a file system.
|
Future<CreateMountTargetResult> |
createMountTargetAsync(CreateMountTargetRequest createMountTargetRequest,
AsyncHandler<CreateMountTargetRequest,CreateMountTargetResult> asyncHandler)
Creates a mount target for a file system.
|
Future<Void> |
createTagsAsync(CreateTagsRequest createTagsRequest)
Creates or overwrites tags associated with a file system.
|
Future<Void> |
createTagsAsync(CreateTagsRequest createTagsRequest,
AsyncHandler<CreateTagsRequest,Void> asyncHandler)
Creates or overwrites tags associated with a file system.
|
Future<Void> |
deleteFileSystemAsync(DeleteFileSystemRequest deleteFileSystemRequest)
Deletes a file system, permanently severing access to its contents.
|
Future<Void> |
deleteFileSystemAsync(DeleteFileSystemRequest deleteFileSystemRequest,
AsyncHandler<DeleteFileSystemRequest,Void> asyncHandler)
Deletes a file system, permanently severing access to its contents.
|
Future<Void> |
deleteMountTargetAsync(DeleteMountTargetRequest deleteMountTargetRequest)
Deletes the specified mount target.
|
Future<Void> |
deleteMountTargetAsync(DeleteMountTargetRequest deleteMountTargetRequest,
AsyncHandler<DeleteMountTargetRequest,Void> asyncHandler)
Deletes the specified mount target.
|
Future<Void> |
deleteTagsAsync(DeleteTagsRequest deleteTagsRequest)
Deletes the specified tags from a file system.
|
Future<Void> |
deleteTagsAsync(DeleteTagsRequest deleteTagsRequest,
AsyncHandler<DeleteTagsRequest,Void> asyncHandler)
Deletes the specified tags from a file system.
|
Future<DescribeFileSystemsResult> |
describeFileSystemsAsync(DescribeFileSystemsRequest describeFileSystemsRequest)
Returns the description of a specific Amazon EFS file system if
either the file system
CreationToken or the
FileSystemId is provided; otherwise, returns descriptions
of all file systems owned by the caller's AWS account in the AWS
region of the endpoint that you're calling. |
Future<DescribeFileSystemsResult> |
describeFileSystemsAsync(DescribeFileSystemsRequest describeFileSystemsRequest,
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; otherwise, returns descriptions
of all file systems owned by the caller's AWS account in the AWS
region of the endpoint that you're calling. |
Future<DescribeMountTargetsResult> |
describeMountTargetsAsync(DescribeMountTargetsRequest describeMountTargetsRequest)
Returns the descriptions of the current mount targets for a file
system.
|
Future<DescribeMountTargetsResult> |
describeMountTargetsAsync(DescribeMountTargetsRequest describeMountTargetsRequest,
AsyncHandler<DescribeMountTargetsRequest,DescribeMountTargetsResult> asyncHandler)
Returns the descriptions of the current mount targets for a file
system.
|
Future<DescribeMountTargetSecurityGroupsResult> |
describeMountTargetSecurityGroupsAsync(DescribeMountTargetSecurityGroupsRequest describeMountTargetSecurityGroupsRequest)
Returns the security groups currently in effect for a mount target.
|
Future<DescribeMountTargetSecurityGroupsResult> |
describeMountTargetSecurityGroupsAsync(DescribeMountTargetSecurityGroupsRequest describeMountTargetSecurityGroupsRequest,
AsyncHandler<DescribeMountTargetSecurityGroupsRequest,DescribeMountTargetSecurityGroupsResult> asyncHandler)
Returns the security groups currently in effect for a mount target.
|
Future<DescribeTagsResult> |
describeTagsAsync(DescribeTagsRequest describeTagsRequest)
Returns the tags associated with a file system.
|
Future<DescribeTagsResult> |
describeTagsAsync(DescribeTagsRequest describeTagsRequest,
AsyncHandler<DescribeTagsRequest,DescribeTagsResult> asyncHandler)
Returns the tags associated with a file system.
|
Future<Void> |
modifyMountTargetSecurityGroupsAsync(ModifyMountTargetSecurityGroupsRequest modifyMountTargetSecurityGroupsRequest)
Modifies the set of security groups in effect for a mount target.
|
Future<Void> |
modifyMountTargetSecurityGroupsAsync(ModifyMountTargetSecurityGroupsRequest modifyMountTargetSecurityGroupsRequest,
AsyncHandler<ModifyMountTargetSecurityGroupsRequest,Void> asyncHandler)
Modifies the set of security groups in effect for a mount target.
|
createFileSystem, createMountTarget, createTags, deleteFileSystem, deleteMountTarget, deleteTags, describeFileSystems, describeFileSystems, describeMountTargets, describeMountTargetSecurityGroups, describeTags, getCachedResponseMetadata, modifyMountTargetSecurityGroups, setEndpoint, setRegion, shutdownFuture<CreateFileSystemResult> createFileSystemAsync(CreateFileSystemRequest createFileSystemRequest) throws AmazonServiceException, AmazonClientException
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:
Otherwise, this operation returns a
FileSystemAlreadyExists error with the ID of the existing
file system.
NOTE: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.
NOTE: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 API, which among other things returns the file system state.
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 (CreateMountTarget) in your VPC. 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 permission for the
elasticfilesystem:CreateFileSystem action.
createFileSystemRequest - Container for the necessary parameters
to execute the CreateFileSystem operation on AmazonElasticFileSystem.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticFileSystem indicating
either a problem with the data in the request, or a server side issue.Future<CreateFileSystemResult> createFileSystemAsync(CreateFileSystemRequest createFileSystemRequest, AsyncHandler<CreateFileSystemRequest,CreateFileSystemResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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:
Otherwise, this operation returns a
FileSystemAlreadyExists error with the ID of the existing
file system.
NOTE: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.
NOTE: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 API, which among other things returns the file system state.
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 (CreateMountTarget) in your VPC. 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 permission for the
elasticfilesystem:CreateFileSystem action.
createFileSystemRequest - Container for the necessary parameters
to execute the CreateFileSystem operation on AmazonElasticFileSystem.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticFileSystem indicating
either a problem with the data in the request, or a server side issue.Future<Void> deleteMountTargetAsync(DeleteMountTargetRequest deleteMountTargetRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified mount target.
This operation forcibly breaks any mounts of the file system via the mount target 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 using another mount target.
This operation requires permission for the following action on the file system:
elasticfilesystem:DeleteMountTarget NOTE:The DeleteMountTarget call returns while the mount target state is still "deleting". You can check the mount target deletion by calling the DescribeMountTargets API, which returns a list of mount target descriptions for the given file system.
The operation also requires permission for the following Amazon EC2 action on the mount target's network interface:
ec2:DeleteNetworkInterface deleteMountTargetRequest - Container for the necessary parameters
to execute the DeleteMountTarget operation on AmazonElasticFileSystem.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticFileSystem indicating
either a problem with the data in the request, or a server side issue.Future<Void> deleteMountTargetAsync(DeleteMountTargetRequest deleteMountTargetRequest, AsyncHandler<DeleteMountTargetRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Deletes the specified mount target.
This operation forcibly breaks any mounts of the file system via the mount target 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 using another mount target.
This operation requires permission for the following action on the file system:
elasticfilesystem:DeleteMountTarget NOTE:The DeleteMountTarget call returns while the mount target state is still "deleting". You can check the mount target deletion by calling the DescribeMountTargets API, which returns a list of mount target descriptions for the given file system.
The operation also requires permission for the following Amazon EC2 action on the mount target's network interface:
ec2:DeleteNetworkInterface deleteMountTargetRequest - Container for the necessary parameters
to execute the DeleteMountTarget operation on AmazonElasticFileSystem.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticFileSystem indicating
either a problem with the data in the request, or a server side issue.Future<DescribeFileSystemsResult> describeFileSystemsAsync(DescribeFileSystemsRequest describeFileSystemsRequest) throws AmazonServiceException, AmazonClientException
Returns the description of a specific Amazon EFS file system if
either the file system CreationToken or the
FileSystemId is provided; otherwise, 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 .
So to retrieve a list of your file system descriptions, the expected
usage of this API is an iterative process of first calling
DescribeFileSystems without the Marker and
then continuing to call it with the Marker parameter set
to the value of the NextMarker from the previous response
until the response has no NextMarker .
Note that 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 permission for the
elasticfilesystem:DescribeFileSystems action.
describeFileSystemsRequest - Container for the necessary
parameters to execute the DescribeFileSystems operation on
AmazonElasticFileSystem.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticFileSystem indicating
either a problem with the data in the request, or a server side issue.Future<DescribeFileSystemsResult> describeFileSystemsAsync(DescribeFileSystemsRequest describeFileSystemsRequest, AsyncHandler<DescribeFileSystemsRequest,DescribeFileSystemsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns the description of a specific Amazon EFS file system if
either the file system CreationToken or the
FileSystemId is provided; otherwise, 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 .
So to retrieve a list of your file system descriptions, the expected
usage of this API is an iterative process of first calling
DescribeFileSystems without the Marker and
then continuing to call it with the Marker parameter set
to the value of the NextMarker from the previous response
until the response has no NextMarker .
Note that 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 permission for the
elasticfilesystem:DescribeFileSystems action.
describeFileSystemsRequest - Container for the necessary
parameters to execute the DescribeFileSystems operation on
AmazonElasticFileSystem.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticFileSystem indicating
either a problem with the data in the request, or a server side issue.Future<Void> createTagsAsync(CreateTagsRequest createTagsRequest) throws AmazonServiceException, AmazonClientException
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 API.
This operation requires permission for the
elasticfilesystem:CreateTags action.
createTagsRequest - Container for the necessary parameters to
execute the CreateTags operation on AmazonElasticFileSystem.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticFileSystem indicating
either a problem with the data in the request, or a server side issue.Future<Void> createTagsAsync(CreateTagsRequest createTagsRequest, AsyncHandler<CreateTagsRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
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 API.
This operation requires permission for the
elasticfilesystem:CreateTags action.
createTagsRequest - Container for the necessary parameters to
execute the CreateTags operation on AmazonElasticFileSystem.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticFileSystem indicating
either a problem with the data in the request, or a server side issue.Future<Void> deleteFileSystemAsync(DeleteFileSystemRequest deleteFileSystemRequest) throws AmazonServiceException, AmazonClientException
Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you will not be able to access any contents of the deleted file system.
You cannot 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.
NOTE:The DeleteFileSystem call returns while the file system state is still "deleting". You can check the file system deletion status by calling the DescribeFileSystems API, 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 will return a 404 "FileSystemNotFound" error.
This operation requires permission for the
elasticfilesystem:DeleteFileSystem action.
deleteFileSystemRequest - Container for the necessary parameters
to execute the DeleteFileSystem operation on AmazonElasticFileSystem.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticFileSystem indicating
either a problem with the data in the request, or a server side issue.Future<Void> deleteFileSystemAsync(DeleteFileSystemRequest deleteFileSystemRequest, AsyncHandler<DeleteFileSystemRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you will not be able to access any contents of the deleted file system.
You cannot 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.
NOTE:The DeleteFileSystem call returns while the file system state is still "deleting". You can check the file system deletion status by calling the DescribeFileSystems API, 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 will return a 404 "FileSystemNotFound" error.
This operation requires permission for the
elasticfilesystem:DeleteFileSystem action.
deleteFileSystemRequest - Container for the necessary parameters
to execute the DeleteFileSystem operation on AmazonElasticFileSystem.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticFileSystem indicating
either a problem with the data in the request, or a server side issue.Future<DescribeMountTargetsResult> describeMountTargetsAsync(DescribeMountTargetsRequest describeMountTargetsRequest) throws AmazonServiceException, AmazonClientException
Returns the descriptions of the current mount targets for a file system. The order of mount targets returned in the response is unspecified.
This operation requires permission for the
elasticfilesystem:DescribeMountTargets action on the file
system FileSystemId .
describeMountTargetsRequest - Container for the necessary
parameters to execute the DescribeMountTargets operation on
AmazonElasticFileSystem.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticFileSystem indicating
either a problem with the data in the request, or a server side issue.Future<DescribeMountTargetsResult> describeMountTargetsAsync(DescribeMountTargetsRequest describeMountTargetsRequest, AsyncHandler<DescribeMountTargetsRequest,DescribeMountTargetsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns the descriptions of the current mount targets for a file system. The order of mount targets returned in the response is unspecified.
This operation requires permission for the
elasticfilesystem:DescribeMountTargets action on the file
system FileSystemId .
describeMountTargetsRequest - Container for the necessary
parameters to execute the DescribeMountTargets operation on
AmazonElasticFileSystem.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticFileSystem indicating
either a problem with the data in the request, or a server side issue.Future<CreateMountTargetResult> createMountTargetAsync(CreateMountTargetRequest createMountTargetRequest) throws AmazonServiceException, AmazonClientException
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" (see DescribeFileSystems).
In the request, you also provide a subnet ID, which serves several purposes:
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 request to add another mount target must meet the following requirements:
The subnet specified in the request must belong to the same VPC as the subnets of the existing mount targets.
If the request satisfies the requirements, Amazon EFS does the following:
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).SecurityGroups , this
network interface is associated with those security groups. Otherwise,
it belongs to the default security group for the subnet's VPC."Mount target fsmt-id for file
system fs-id" where fsmt-id is the mount target
ID, and fs-id is the FileSystemId .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.
NOTE: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 API, 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, go to Amazon EFS product detail page. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario; if the Availablity 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 permission for the following action on the file system:
elasticfilesystem:CreateMountTarget This operation also requires permission for the following Amazon EC2 actions:
ec2:DescribeSubnets ec2:DescribeNetworkInterfaces ec2:CreateNetworkInterface createMountTargetRequest - Container for the necessary parameters
to execute the CreateMountTarget operation on AmazonElasticFileSystem.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticFileSystem indicating
either a problem with the data in the request, or a server side issue.Future<CreateMountTargetResult> createMountTargetAsync(CreateMountTargetRequest createMountTargetRequest, AsyncHandler<CreateMountTargetRequest,CreateMountTargetResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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" (see DescribeFileSystems).
In the request, you also provide a subnet ID, which serves several purposes:
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 request to add another mount target must meet the following requirements:
The subnet specified in the request must belong to the same VPC as the subnets of the existing mount targets.
If the request satisfies the requirements, Amazon EFS does the following:
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).SecurityGroups , this
network interface is associated with those security groups. Otherwise,
it belongs to the default security group for the subnet's VPC."Mount target fsmt-id for file
system fs-id" where fsmt-id is the mount target
ID, and fs-id is the FileSystemId .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.
NOTE: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 API, 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, go to Amazon EFS product detail page. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario; if the Availablity 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 permission for the following action on the file system:
elasticfilesystem:CreateMountTarget This operation also requires permission for the following Amazon EC2 actions:
ec2:DescribeSubnets ec2:DescribeNetworkInterfaces ec2:CreateNetworkInterface createMountTargetRequest - Container for the necessary parameters
to execute the CreateMountTarget operation on AmazonElasticFileSystem.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticFileSystem indicating
either a problem with the data in the request, or a server side issue.Future<DescribeMountTargetSecurityGroupsResult> describeMountTargetSecurityGroupsAsync(DescribeMountTargetSecurityGroupsRequest describeMountTargetSecurityGroupsRequest) throws AmazonServiceException, AmazonClientException
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 life cycle 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. describeMountTargetSecurityGroupsRequest - Container for the
necessary parameters to execute the DescribeMountTargetSecurityGroups
operation on AmazonElasticFileSystem.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticFileSystem indicating
either a problem with the data in the request, or a server side issue.Future<DescribeMountTargetSecurityGroupsResult> describeMountTargetSecurityGroupsAsync(DescribeMountTargetSecurityGroupsRequest describeMountTargetSecurityGroupsRequest, AsyncHandler<DescribeMountTargetSecurityGroupsRequest,DescribeMountTargetSecurityGroupsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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 life cycle 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. describeMountTargetSecurityGroupsRequest - Container for the
necessary parameters to execute the DescribeMountTargetSecurityGroups
operation on AmazonElasticFileSystem.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticFileSystem indicating
either a problem with the data in the request, or a server side issue.Future<Void> modifyMountTargetSecurityGroupsAsync(ModifyMountTargetSecurityGroupsRequest modifyMountTargetSecurityGroupsRequest) throws AmazonServiceException, AmazonClientException
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 (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 life cycle 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. modifyMountTargetSecurityGroupsRequest - Container for the
necessary parameters to execute the ModifyMountTargetSecurityGroups
operation on AmazonElasticFileSystem.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticFileSystem indicating
either a problem with the data in the request, or a server side issue.Future<Void> modifyMountTargetSecurityGroupsAsync(ModifyMountTargetSecurityGroupsRequest modifyMountTargetSecurityGroupsRequest, AsyncHandler<ModifyMountTargetSecurityGroupsRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
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 (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 life cycle 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. modifyMountTargetSecurityGroupsRequest - Container for the
necessary parameters to execute the ModifyMountTargetSecurityGroups
operation on AmazonElasticFileSystem.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticFileSystem indicating
either a problem with the data in the request, or a server side issue.Future<DescribeTagsResult> describeTagsAsync(DescribeTagsRequest describeTagsRequest) throws AmazonServiceException, AmazonClientException
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 permission for the
elasticfilesystem:DescribeTags action.
describeTagsRequest - Container for the necessary parameters to
execute the DescribeTags operation on AmazonElasticFileSystem.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticFileSystem indicating
either a problem with the data in the request, or a server side issue.Future<DescribeTagsResult> describeTagsAsync(DescribeTagsRequest describeTagsRequest, AsyncHandler<DescribeTagsRequest,DescribeTagsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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 permission for the
elasticfilesystem:DescribeTags action.
describeTagsRequest - Container for the necessary parameters to
execute the DescribeTags operation on AmazonElasticFileSystem.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticFileSystem indicating
either a problem with the data in the request, or a server side issue.Future<Void> deleteTagsAsync(DeleteTagsRequest deleteTagsRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified tags from a file system. If the
DeleteTags request includes a tag key that does not
exist, Amazon EFS ignores it; it is not an error. For more information
about tags and related restrictions, go to
Tag Restrictions
in the AWS Billing and Cost Management User Guide .
This operation requires permission for the
elasticfilesystem:DeleteTags action.
deleteTagsRequest - Container for the necessary parameters to
execute the DeleteTags operation on AmazonElasticFileSystem.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticFileSystem indicating
either a problem with the data in the request, or a server side issue.Future<Void> deleteTagsAsync(DeleteTagsRequest deleteTagsRequest, AsyncHandler<DeleteTagsRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Deletes the specified tags from a file system. If the
DeleteTags request includes a tag key that does not
exist, Amazon EFS ignores it; it is not an error. For more information
about tags and related restrictions, go to
Tag Restrictions
in the AWS Billing and Cost Management User Guide .
This operation requires permission for the
elasticfilesystem:DeleteTags action.
deleteTagsRequest - Container for the necessary parameters to
execute the DeleteTags operation on AmazonElasticFileSystem.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticFileSystem indicating
either a problem with the data in the request, or a server side issue.Copyright © 2015. All rights reserved.