AbstractAmazonElasticFileSystem (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.elasticfilesystem.AbstractAmazonElasticFileSystem

All Implemented Interfaces:

AmazonElasticFileSystem

Direct Known Subclasses:

AbstractAmazonElasticFileSystemAsync
```
public class AbstractAmazonElasticFileSystem
extends Object
implements AmazonElasticFileSystem
```
Abstract implementation of AmazonElasticFileSystem. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.elasticfilesystem.AmazonElasticFileSystem
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateFileSystemResult`	`createFileSystem(CreateFileSystemRequest request)` Creates a new, empty file system.
`CreateMountTargetResult`	`createMountTarget(CreateMountTargetRequest request)` Creates a mount target for a file system.
`CreateTagsResult`	`createTags(CreateTagsRequest request)` Creates or overwrites tags associated with a file system.
`DeleteFileSystemResult`	`deleteFileSystem(DeleteFileSystemRequest request)` Deletes a file system, permanently severing access to its contents.
`DeleteMountTargetResult`	`deleteMountTarget(DeleteMountTargetRequest request)` Deletes the specified mount target.
`DeleteTagsResult`	`deleteTags(DeleteTagsRequest request)` Deletes the specified tags from a file system.
`DescribeFileSystemsResult`	`describeFileSystems()` Simplified method form for invoking the DescribeFileSystems operation.
`DescribeFileSystemsResult`	`describeFileSystems(DescribeFileSystemsRequest request)` Returns the description of a specific Amazon EFS file system if either the file system `CreationToken` or the `FileSystemId` is provided.
`DescribeMountTargetsResult`	`describeMountTargets(DescribeMountTargetsRequest request)` Returns the descriptions of all the current mount targets, or a specific mount target, for a file system.
`DescribeMountTargetSecurityGroupsResult`	`describeMountTargetSecurityGroups(DescribeMountTargetSecurityGroupsRequest request)` Returns the security groups currently in effect for a mount target.
`DescribeTagsResult`	`describeTags(DescribeTagsRequest request)` Returns the tags associated with a file system.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`ModifyMountTargetSecurityGroupsResult`	`modifyMountTargetSecurityGroups(ModifyMountTargetSecurityGroupsRequest request)` Modifies the set of security groups in effect for a mount target.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("https://elasticfilesystem.us-east-1.amazonaws.com").
`void`	`setRegion(Region region)` An alternative to `AmazonElasticFileSystem.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AmazonElasticFileSystem
    
    Overrides the default endpoint for this client ("https://elasticfilesystem.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "elasticfilesystem.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://elasticfilesystem.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
    This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setEndpoint in interface AmazonElasticFileSystem
    
    Parameters:
    
    endpoint - The endpoint (ex: "elasticfilesystem.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://elasticfilesystem.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AmazonElasticFileSystem
    
    An alternative to AmazonElasticFileSystem.setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setRegion in interface AmazonElasticFileSystem
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - createFileSystem
```
public CreateFileSystemResult createFileSystem(CreateFileSystemRequest request)
```
    Description copied from interface: AmazonElasticFileSystem
    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:
    
    createFileSystem in interface AmazonElasticFileSystem
    
    Returns:
    
    Result of the CreateFileSystem operation returned by the service.
  - createMountTarget
```
public CreateMountTargetResult createMountTarget(CreateMountTargetRequest request)
```
    Description copied from interface: AmazonElasticFileSystem
    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:
    
    createMountTarget in interface AmazonElasticFileSystem
    
    Returns:
    
    Result of the CreateMountTarget operation returned by the service.
  - createTags
```
public CreateTagsResult createTags(CreateTagsRequest request)
```
    Description copied from interface: AmazonElasticFileSystem
    
    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:
    
    createTags in interface AmazonElasticFileSystem
    
    Returns:
    
    Result of the CreateTags operation returned by the service.
  - deleteFileSystem
```
public DeleteFileSystemResult deleteFileSystem(DeleteFileSystemRequest request)
```
    Description copied from interface: AmazonElasticFileSystem
    
    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:
    
    deleteFileSystem in interface AmazonElasticFileSystem
    
    Returns:
    
    Result of the DeleteFileSystem operation returned by the service.
  - deleteMountTarget
```
public DeleteMountTargetResult deleteMountTarget(DeleteMountTargetRequest request)
```
    Description copied from interface: AmazonElasticFileSystem
    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:
    
    deleteMountTarget in interface AmazonElasticFileSystem
    
    Returns:
    
    Result of the DeleteMountTarget operation returned by the service.
  - deleteTags
```
public DeleteTagsResult deleteTags(DeleteTagsRequest request)
```
    Description copied from interface: AmazonElasticFileSystem
    
    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:
    
    deleteTags in interface AmazonElasticFileSystem
    
    Returns:
    
    Result of the DeleteTags operation returned by the service.
  - describeFileSystems
```
public DescribeFileSystemsResult describeFileSystems(DescribeFileSystemsRequest request)
```
    Description copied from interface: AmazonElasticFileSystem
    
    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:
    
    describeFileSystems in interface AmazonElasticFileSystem
    
    Returns:
    
    Result of the DescribeFileSystems operation returned by the service.
  - describeFileSystems
```
public DescribeFileSystemsResult describeFileSystems()
```
    Description copied from interface: AmazonElasticFileSystem
    
    Simplified method form for invoking the DescribeFileSystems operation.
    
    Specified by:
    
    describeFileSystems in interface AmazonElasticFileSystem
    
    See Also:
    
    AmazonElasticFileSystem.describeFileSystems(DescribeFileSystemsRequest)
  - describeMountTargetSecurityGroups
```
public DescribeMountTargetSecurityGroupsResult describeMountTargetSecurityGroups(DescribeMountTargetSecurityGroupsRequest request)
```
    Description copied from interface: AmazonElasticFileSystem
    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:
    
    describeMountTargetSecurityGroups in interface AmazonElasticFileSystem
    
    Returns:
    
    Result of the DescribeMountTargetSecurityGroups operation returned by the service.
  - describeMountTargets
```
public DescribeMountTargetsResult describeMountTargets(DescribeMountTargetsRequest request)
```
    Description copied from interface: AmazonElasticFileSystem
    
    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:
    
    describeMountTargets in interface AmazonElasticFileSystem
    
    Returns:
    
    Result of the DescribeMountTargets operation returned by the service.
  - describeTags
```
public DescribeTagsResult describeTags(DescribeTagsRequest request)
```
    Description copied from interface: AmazonElasticFileSystem
    
    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:
    
    describeTags in interface AmazonElasticFileSystem
    
    Returns:
    
    Result of the DescribeTags operation returned by the service.
  - modifyMountTargetSecurityGroups
```
public ModifyMountTargetSecurityGroupsResult modifyMountTargetSecurityGroups(ModifyMountTargetSecurityGroupsRequest request)
```
    Description copied from interface: AmazonElasticFileSystem
    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:
    
    modifyMountTargetSecurityGroups in interface AmazonElasticFileSystem
    
    Returns:
    
    Result of the ModifyMountTargetSecurityGroups operation returned by the service.
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonElasticFileSystem
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonElasticFileSystem
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonElasticFileSystem
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonElasticFileSystem
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAmazonElasticFileSystem

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

createFileSystem

createMountTarget

createTags

deleteFileSystem

deleteMountTarget

deleteTags

describeFileSystems

describeFileSystems

describeMountTargetSecurityGroups

describeMountTargets

describeTags

modifyMountTargetSecurityGroups

shutdown

getCachedResponseMetadata