com.amazonaws.services.elasticfilesystem

Class AbstractAmazonElasticFileSystem

java.lang.Object

com.amazonaws.services.elasticfilesystem.AbstractAmazonElasticFileSystem

All Implemented Interfaces:

AmazonElasticFileSystem

Direct Known Subclasses:

AbstractAmazonElasticFileSystemAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
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

Modifier and Type	Method and Description
CreateAccessPointResult	createAccessPoint(CreateAccessPointRequest request) Creates an EFS access point.
CreateFileSystemResult	createFileSystem(CreateFileSystemRequest request) Creates a new, empty file system.
CreateMountTargetResult	createMountTarget(CreateMountTargetRequest request) Creates a mount target for a file system.
CreateReplicationConfigurationResult	createReplicationConfiguration(CreateReplicationConfigurationRequest request) Creates a replication configuration that replicates an existing EFS file system to a new, read-only file system.
CreateTagsResult	createTags(CreateTagsRequest request) Deprecated.
DeleteAccessPointResult	deleteAccessPoint(DeleteAccessPointRequest request) Deletes the specified access point.
DeleteFileSystemResult	deleteFileSystem(DeleteFileSystemRequest request) Deletes a file system, permanently severing access to its contents.
DeleteFileSystemPolicyResult	deleteFileSystemPolicy(DeleteFileSystemPolicyRequest request) Deletes the FileSystemPolicy for the specified file system.
DeleteMountTargetResult	deleteMountTarget(DeleteMountTargetRequest request) Deletes the specified mount target.
DeleteReplicationConfigurationResult	deleteReplicationConfiguration(DeleteReplicationConfigurationRequest request) Deletes an existing replication configuration.
DeleteTagsResult	deleteTags(DeleteTagsRequest request) Deprecated.
DescribeAccessPointsResult	describeAccessPoints(DescribeAccessPointsRequest request) Returns the description of a specific Amazon EFS access point if the AccessPointId is provided.
DescribeAccountPreferencesResult	describeAccountPreferences(DescribeAccountPreferencesRequest request) Returns the account preferences settings for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region.
DescribeBackupPolicyResult	describeBackupPolicy(DescribeBackupPolicyRequest request) Returns the backup policy for the specified EFS file system.
DescribeFileSystemPolicyResult	describeFileSystemPolicy(DescribeFileSystemPolicyRequest request) Returns the FileSystemPolicy for the specified EFS 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.
DescribeLifecycleConfigurationResult	describeLifecycleConfiguration(DescribeLifecycleConfigurationRequest request) Returns the current LifecycleConfiguration object for the specified Amazon EFS file system.
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.
DescribeReplicationConfigurationsResult	describeReplicationConfigurations(DescribeReplicationConfigurationsRequest request) Retrieves the replication configuration for a specific file system.
DescribeTagsResult	describeTags(DescribeTagsRequest request) Deprecated.
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.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists all tags for a top-level EFS resource.
ModifyMountTargetSecurityGroupsResult	modifyMountTargetSecurityGroups(ModifyMountTargetSecurityGroupsRequest request) Modifies the set of security groups in effect for a mount target.
PutAccountPreferencesResult	putAccountPreferences(PutAccountPreferencesRequest request) Use this operation to set the account preference in the current Amazon Web Services Region to use long 17 character (63 bit) or short 8 character (32 bit) resource IDs for new EFS file system and mount target resources.
PutBackupPolicyResult	putBackupPolicy(PutBackupPolicyRequest request) Updates the file system's backup policy.
PutFileSystemPolicyResult	putFileSystemPolicy(PutFileSystemPolicyRequest request) Applies an Amazon EFS FileSystemPolicy to an Amazon EFS file system.
PutLifecycleConfigurationResult	putLifecycleConfiguration(PutLifecycleConfigurationRequest request) Use this action to manage EFS lifecycle management and EFS Intelligent-Tiering.
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.
TagResourceResult	tagResource(TagResourceRequest request) Creates a tag for an EFS resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes tags from an EFS resource.
UpdateFileSystemResult	updateFileSystem(UpdateFileSystemRequest request) Updates the throughput mode or the amount of provisioned throughput of an existing file system.

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: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint

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)

createAccessPoint

public CreateAccessPointResult createAccessPoint(CreateAccessPointRequest request)

Description copied from interface: AmazonElasticFileSystem

Creates an EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group override any identity information provided by the NFS client. The file system path is exposed as the access point's root directory. Applications using the access point can only access data in the application's own directory and any subdirectories. To learn more, see Mounting a file system using EFS access points.

If multiple requests to create access points on the same file system are sent in quick succession, and the file system is near the limit of 1,000 access points, you may experience a throttling response for these requests. This is to ensure that the file system does not exceed the stated access point limit.

This operation requires permissions for the elasticfilesystem:CreateAccessPoint action.

Access points can be tagged on creation. If tags are specified in the creation action, IAM performs additional authorization on the elasticfilesystem:TagResource action to verify if users have permissions to create tags. Therefore, you must grant explicit permissions to use the elasticfilesystem:TagResource action. For more information, see Granting permissions to tag resources during creation.

Specified by:

createAccessPoint in interface AmazonElasticFileSystem

Returns:

Result of the CreateAccessPoint operation returned by the service.

See Also:

AWS API Documentation

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 Amazon Web Services 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.

For more information, see Creating a file system in the Amazon EFS User Guide.

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 accepts 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 and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. For more information, see Amazon EFS performance modes.

You can set the throughput mode for the file system using the ThroughputMode parameter.

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 by using the mount target. For more information, see Amazon EFS: How it Works.

This operation requires permissions for the elasticfilesystem:CreateFileSystem action.

File systems can be tagged on creation. If tags are specified in the creation action, IAM performs additional authorization on the elasticfilesystem:TagResource action to verify if users have permissions to create tags. Therefore, you must grant explicit permissions to use the elasticfilesystem:TagResource action. For more information, see Granting permissions to tag resources during creation.

Specified by:

createFileSystem in interface AmazonElasticFileSystem

Returns:

Result of the CreateFileSystem operation returned by the service.

See Also:

AWS API Documentation

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 by using 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.

You can create only one mount target for an EFS file system using One Zone storage classes. You must create that mount target in the same Availability Zone in which the file system is located. Use the AvailabilityZoneName and AvailabiltyZoneId properties in the DescribeFileSystems response object to get this information. Use the subnetId associated with the file system's Availability Zone when creating the mount target.

For more information, see Amazon EFS: How it Works.

To create a mount target for a file system, the file system's lifecycle state must be available. For more information, see DescribeFileSystems.

In the request, provide the following:

• The file system ID for which you are creating the mount target.

• A subnet ID, which determines the following:

  • The VPC in which Amazon EFS creates the mount target

  • The Availability Zone in which Amazon EFS creates the mount target

  • The 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 by using 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 requester-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 DescribeMountTargets operation, which among other things returns the mount target state.

We recommend that 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 can't 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.

See Also:

AWS API Documentation

createReplicationConfiguration

public CreateReplicationConfigurationResult createReplicationConfiguration(CreateReplicationConfigurationRequest request)

Description copied from interface: AmazonElasticFileSystem

Creates a replication configuration that replicates an existing EFS file system to a new, read-only file system. For more information, see Amazon EFS replication in the Amazon EFS User Guide. The replication configuration specifies the following:

• Source file system - An existing EFS file system that you want replicated. The source file system cannot be a destination file system in an existing replication configuration.

• Destination file system configuration - The configuration of the destination file system to which the source file system will be replicated. There can only be one destination file system in a replication configuration. The destination file system configuration consists of the following properties:

  • Amazon Web Services Region - The Amazon Web Services Region in which the destination file system is created. Amazon EFS replication is available in all Amazon Web Services Regions in which EFS is available. To use EFS replication in a Region that is disabled by default, you must first opt in to the Region. For more information, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference Reference Guide

  • Availability Zone - If you want the destination file system to use EFS One Zone availability and durability, you must specify the Availability Zone to create the file system in. For more information about EFS storage classes, see Amazon EFS storage classes in the Amazon EFS User Guide.

  • Encryption - All destination file systems are created with encryption at rest enabled. You can specify the Key Management Service (KMS) key that is used to encrypt the destination file system. If you don't specify a KMS key, your service-managed KMS key for Amazon EFS is used.

    After the file system is created, you cannot change the KMS key.

The following properties are set by default:

• Performance mode - The destination file system's performance mode matches that of the source file system, unless the destination file system uses EFS One Zone storage. In that case, the General Purpose performance mode is used. The performance mode cannot be changed.

• Throughput mode - The destination file system's throughput mode matches that of the source file system. After the file system is created, you can modify the throughput mode.

The following properties are turned off by default:

• Lifecycle management - EFS lifecycle management and EFS Intelligent-Tiering are not enabled on the destination file system. After the destination file system is created, you can enable EFS lifecycle management and EFS Intelligent-Tiering.

• Automatic backups - Automatic daily backups are enabled on the destination file system. After the file system is created, you can change this setting.

For more information, see Amazon EFS replication in the Amazon EFS User Guide.

Specified by:

createReplicationConfiguration in interface AmazonElasticFileSystem

Returns:

Result of the CreateReplicationConfiguration operation returned by the service.

See Also:

AWS API Documentation

createTags

@Deprecated
public CreateTagsResult createTags(CreateTagsRequest request)

Deprecated.

Description copied from interface: AmazonElasticFileSystem

DEPRECATED - CreateTags is deprecated and not maintained. To create tags for EFS resources, use the API action.

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.

See Also:

AWS API Documentation

deleteAccessPoint

public DeleteAccessPointResult deleteAccessPoint(DeleteAccessPointRequest request)

Description copied from interface: AmazonElasticFileSystem

Deletes the specified access point. After deletion is complete, new clients can no longer connect to the access points. Clients connected to the access point at the time of deletion will continue to function until they terminate their connection.

This operation requires permissions for the elasticfilesystem:DeleteAccessPoint action.

Specified by:

deleteAccessPoint in interface AmazonElasticFileSystem

Returns:

Result of the DeleteAccessPoint operation returned by the service.

See Also:

AWS API Documentation

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 need to manually delete mount targets attached to a file system before you can delete an EFS file system. This step is performed for you when you use the Amazon Web Services console to delete a file system.

You cannot delete a file system that is part of an EFS Replication configuration. You need to delete the replication configuration first.

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.

See Also:

AWS API Documentation

deleteFileSystemPolicy

public DeleteFileSystemPolicyResult deleteFileSystemPolicy(DeleteFileSystemPolicyRequest request)

Description copied from interface: AmazonElasticFileSystem

Deletes the FileSystemPolicy for the specified file system. The default FileSystemPolicy goes into effect once the existing policy is deleted. For more information about the default file system policy, see Using Resource-based Policies with EFS.

This operation requires permissions for the elasticfilesystem:DeleteFileSystemPolicy action.

Specified by:

deleteFileSystemPolicy in interface AmazonElasticFileSystem

Returns:

Result of the DeleteFileSystemPolicy operation returned by the service.

See Also:

AWS API Documentation

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 by using 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 might 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 by using 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.

See Also:

AWS API Documentation

deleteReplicationConfiguration

public DeleteReplicationConfigurationResult deleteReplicationConfiguration(DeleteReplicationConfigurationRequest request)

Description copied from interface: AmazonElasticFileSystem

Deletes an existing replication configuration. Deleting a replication configuration ends the replication process. After a replication configuration is deleted, the destination file system is no longer read-only. You can write to the destination file system after its status becomes Writeable.

Specified by:

deleteReplicationConfiguration in interface AmazonElasticFileSystem

Returns:

Result of the DeleteReplicationConfiguration operation returned by the service.

See Also:

AWS API Documentation

deleteTags

@Deprecated
public DeleteTagsResult deleteTags(DeleteTagsRequest request)

Deprecated.

Description copied from interface: AmazonElasticFileSystem

DEPRECATED - DeleteTags is deprecated and not maintained. To remove tags from EFS resources, use the API action.

Deletes the specified tags from a file system. If the DeleteTags request includes a tag key that doesn't exist, Amazon EFS ignores it and doesn't cause an error. For more information about tags and related restrictions, see Tag restrictions in the 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.

See Also:

AWS API Documentation

describeAccessPoints

public DescribeAccessPointsResult describeAccessPoints(DescribeAccessPointsRequest request)

Description copied from interface: AmazonElasticFileSystem

Returns the description of a specific Amazon EFS access point if the AccessPointId is provided. If you provide an EFS FileSystemId, it returns descriptions of all access points for that file system. You can provide either an AccessPointId or a FileSystemId in the request, but not both.

This operation requires permissions for the elasticfilesystem:DescribeAccessPoints action.

Specified by:

describeAccessPoints in interface AmazonElasticFileSystem

Returns:

Result of the DescribeAccessPoints operation returned by the service.

See Also:

AWS API Documentation

describeAccountPreferences

public DescribeAccountPreferencesResult describeAccountPreferences(DescribeAccountPreferencesRequest request)

Description copied from interface: AmazonElasticFileSystem

Returns the account preferences settings for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region.

Specified by:

describeAccountPreferences in interface AmazonElasticFileSystem

Returns:

Result of the DescribeAccountPreferences operation returned by the service.

See Also:

AWS API Documentation

describeBackupPolicy

public DescribeBackupPolicyResult describeBackupPolicy(DescribeBackupPolicyRequest request)

Description copied from interface: AmazonElasticFileSystem

Returns the backup policy for the specified EFS file system.

Specified by:

describeBackupPolicy in interface AmazonElasticFileSystem

Returns:

Result of the DescribeBackupPolicy operation returned by the service.

See Also:

AWS API Documentation

describeFileSystemPolicy

public DescribeFileSystemPolicyResult describeFileSystemPolicy(DescribeFileSystemPolicyRequest request)

Description copied from interface: AmazonElasticFileSystem

Returns the FileSystemPolicy for the specified EFS file system.

This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy action.

Specified by:

describeFileSystemPolicy in interface AmazonElasticFileSystem

Returns:

Result of the DescribeFileSystemPolicy operation returned by the service.

See Also:

AWS API Documentation

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 Amazon Web Services account in the Amazon Web Services 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. This number is automatically set to 100. 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 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.

See Also:

AWS API Documentation

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)

describeLifecycleConfiguration

public DescribeLifecycleConfigurationResult describeLifecycleConfiguration(DescribeLifecycleConfigurationRequest request)

Description copied from interface: AmazonElasticFileSystem

Returns the current LifecycleConfiguration object for the specified Amazon EFS file system. EFS lifecycle management uses the LifecycleConfiguration object to identify which files to move to the EFS Infrequent Access (IA) storage class. For a file system without a LifecycleConfiguration object, the call returns an empty array in the response.

When EFS Intelligent-Tiering is enabled, TransitionToPrimaryStorageClass has a value of AFTER_1_ACCESS.

This operation requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration operation.

Specified by:

describeLifecycleConfiguration in interface AmazonElasticFileSystem

Returns:

Result of the DescribeLifecycleConfiguration operation returned by the service.

See Also:

AWS API Documentation

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.

See Also:

AWS API Documentation

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.

See Also:

AWS API Documentation

describeReplicationConfigurations

public DescribeReplicationConfigurationsResult describeReplicationConfigurations(DescribeReplicationConfigurationsRequest request)

Description copied from interface: AmazonElasticFileSystem

Retrieves the replication configuration for a specific file system. If a file system is not specified, all of the replication configurations for the Amazon Web Services account in an Amazon Web Services Region are retrieved.

Specified by:

describeReplicationConfigurations in interface AmazonElasticFileSystem

Returns:

Result of the DescribeReplicationConfigurations operation returned by the service.

See Also:

AWS API Documentation

describeTags

@Deprecated
public DescribeTagsResult describeTags(DescribeTagsRequest request)

Deprecated.

Description copied from interface: AmazonElasticFileSystem

DEPRECATED - The DescribeTags action is deprecated and not maintained. To view tags associated with EFS resources, use the ListTagsForResource API action.

Returns the tags associated with a file system. The order of tags returned in the response of one DescribeTags call and the order of tags returned across the responses of a multiple-call iteration (when using pagination) is unspecified.

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.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Description copied from interface: AmazonElasticFileSystem

Lists all tags for a top-level EFS resource. You must provide the ID of the resource that you want to retrieve the tags for.

This operation requires permissions for the elasticfilesystem:DescribeAccessPoints action.

Specified by:

listTagsForResource in interface AmazonElasticFileSystem

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

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.

See Also:

AWS API Documentation

putAccountPreferences

public PutAccountPreferencesResult putAccountPreferences(PutAccountPreferencesRequest request)

Description copied from interface: AmazonElasticFileSystem

Use this operation to set the account preference in the current Amazon Web Services Region to use long 17 character (63 bit) or short 8 character (32 bit) resource IDs for new EFS file system and mount target resources. All existing resource IDs are not affected by any changes you make. You can set the ID preference during the opt-in period as EFS transitions to long resource IDs. For more information, see Managing Amazon EFS resource IDs.

Starting in October, 2021, you will receive an error if you try to set the account preference to use the short 8 character format resource ID. Contact Amazon Web Services support if you receive an error and must use short IDs for file system and mount target resources.

Specified by:

putAccountPreferences in interface AmazonElasticFileSystem

Returns:

Result of the PutAccountPreferences operation returned by the service.

See Also:

AWS API Documentation

putBackupPolicy

public PutBackupPolicyResult putBackupPolicy(PutBackupPolicyRequest request)

Description copied from interface: AmazonElasticFileSystem

Updates the file system's backup policy. Use this action to start or stop automatic backups of the file system.

Specified by:

putBackupPolicy in interface AmazonElasticFileSystem

Returns:

Result of the PutBackupPolicy operation returned by the service.

See Also:

AWS API Documentation

putFileSystemPolicy

public PutFileSystemPolicyResult putFileSystemPolicy(PutFileSystemPolicyRequest request)

Description copied from interface: AmazonElasticFileSystem

Applies an Amazon EFS FileSystemPolicy to an Amazon EFS file system. A file system policy is an IAM resource-based policy and can contain multiple policy statements. A file system always has exactly one file system policy, which can be the default policy or an explicit policy set or updated using this API operation. EFS file system policies have a 20,000 character limit. When an explicit policy is set, it overrides the default policy. For more information about the default file system policy, see Default EFS File System Policy.

EFS file system policies have a 20,000 character limit.

This operation requires permissions for the elasticfilesystem:PutFileSystemPolicy action.

Specified by:

putFileSystemPolicy in interface AmazonElasticFileSystem

Returns:

Result of the PutFileSystemPolicy operation returned by the service.

See Also:

AWS API Documentation

putLifecycleConfiguration

public PutLifecycleConfigurationResult putLifecycleConfiguration(PutLifecycleConfigurationRequest request)

Description copied from interface: AmazonElasticFileSystem

Use this action to manage EFS lifecycle management and EFS Intelligent-Tiering. A LifecycleConfiguration consists of one or more LifecyclePolicy objects that define the following:

• EFS Lifecycle management - When Amazon EFS automatically transitions files in a file system into the lower-cost EFS Infrequent Access (IA) storage class.

  To enable EFS Lifecycle management, set the value of TransitionToIA to one of the available options.

• EFS Intelligent-Tiering - When Amazon EFS automatically transitions files from IA back into the file system's primary storage class (EFS Standard or EFS One Zone Standard).

  To enable EFS Intelligent-Tiering, set the value of TransitionToPrimaryStorageClass to AFTER_1_ACCESS.

For more information, see EFS Lifecycle Management.

Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system. If a LifecycleConfiguration object already exists for the specified file system, a PutLifecycleConfiguration call modifies the existing configuration. A PutLifecycleConfiguration call with an empty LifecyclePolicies array in the request body deletes any existing LifecycleConfiguration and turns off lifecycle management and EFS Intelligent-Tiering for the file system.

In the request, specify the following:

• The ID for the file system for which you are enabling, disabling, or modifying lifecycle management and EFS Intelligent-Tiering.

• A LifecyclePolicies array of LifecyclePolicy objects that define when files are moved into IA storage, and when they are moved back to Standard storage.

  Amazon EFS requires that each LifecyclePolicy object have only have a single transition, so the LifecyclePolicies array needs to be structured with separate LifecyclePolicy objects. See the example requests in the following section for more information.

This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration operation.

To apply a LifecycleConfiguration object to an encrypted file system, you need the same Key Management Service permissions as when you created the encrypted file system.

Specified by:

putLifecycleConfiguration in interface AmazonElasticFileSystem

Returns:

Result of the PutLifecycleConfiguration operation returned by the service.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Description copied from interface: AmazonElasticFileSystem

Creates a tag for an EFS resource. You can create tags for EFS file systems and access points using this API operation.

This operation requires permissions for the elasticfilesystem:TagResource action.

Specified by:

tagResource in interface AmazonElasticFileSystem

Returns:

Result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Description copied from interface: AmazonElasticFileSystem

Removes tags from an EFS resource. You can remove tags from EFS file systems and access points using this API operation.

This operation requires permissions for the elasticfilesystem:UntagResource action.

Specified by:

untagResource in interface AmazonElasticFileSystem

Returns:

Result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateFileSystem

public UpdateFileSystemResult updateFileSystem(UpdateFileSystemRequest request)

Description copied from interface: AmazonElasticFileSystem

Updates the throughput mode or the amount of provisioned throughput of an existing file system.

Specified by:

updateFileSystem in interface AmazonElasticFileSystem

Returns:

Result of the UpdateFileSystem operation returned by the service.

See Also:

AWS API Documentation

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.