Package software.amazon.awssdk.services.efs

Interface EfsClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface EfsClient
extends AwsClient

Service client for accessing EFS. This can be created using the static builder() method. Amazon Elastic File System

Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use with Amazon EC2 Linux and Mac instances in the Amazon Web Services Cloud. With Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you add and remove files, so that your applications have the storage they need, when they need it. For more information, see the Amazon Elastic File System API Reference and the Amazon Elastic File System User Guide.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static EfsClientBuilder	builder()	Create a builder that can be used to configure and create a EfsClient.
static EfsClient	create()	Create a EfsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateAccessPointResponse	createAccessPoint(Consumer<CreateAccessPointRequest.Builder> createAccessPointRequest)	Creates an EFS access point.
default CreateAccessPointResponse	createAccessPoint(CreateAccessPointRequest createAccessPointRequest)	Creates an EFS access point.
default CreateFileSystemResponse	createFileSystem(Consumer<CreateFileSystemRequest.Builder> createFileSystemRequest)	Creates a new, empty file system.
default CreateFileSystemResponse	createFileSystem(CreateFileSystemRequest createFileSystemRequest)	Creates a new, empty file system.
default CreateMountTargetResponse	createMountTarget(Consumer<CreateMountTargetRequest.Builder> createMountTargetRequest)	Creates a mount target for a file system.
default CreateMountTargetResponse	createMountTarget(CreateMountTargetRequest createMountTargetRequest)	Creates a mount target for a file system.
default CreateReplicationConfigurationResponse	createReplicationConfiguration(Consumer<CreateReplicationConfigurationRequest.Builder> createReplicationConfigurationRequest)	Creates a replication configuration that replicates an existing EFS file system to a new, read-only file system.
default CreateReplicationConfigurationResponse	createReplicationConfiguration(CreateReplicationConfigurationRequest createReplicationConfigurationRequest)	Creates a replication configuration that replicates an existing EFS file system to a new, read-only file system.
default CreateTagsResponse	createTags(Consumer<CreateTagsRequest.Builder> createTagsRequest)	Deprecated. Use TagResource.
default CreateTagsResponse	createTags(CreateTagsRequest createTagsRequest)	Deprecated. Use TagResource.
default DeleteAccessPointResponse	deleteAccessPoint(Consumer<DeleteAccessPointRequest.Builder> deleteAccessPointRequest)	Deletes the specified access point.
default DeleteAccessPointResponse	deleteAccessPoint(DeleteAccessPointRequest deleteAccessPointRequest)	Deletes the specified access point.
default DeleteFileSystemResponse	deleteFileSystem(Consumer<DeleteFileSystemRequest.Builder> deleteFileSystemRequest)	Deletes a file system, permanently severing access to its contents.
default DeleteFileSystemResponse	deleteFileSystem(DeleteFileSystemRequest deleteFileSystemRequest)	Deletes a file system, permanently severing access to its contents.
default DeleteFileSystemPolicyResponse	deleteFileSystemPolicy(Consumer<DeleteFileSystemPolicyRequest.Builder> deleteFileSystemPolicyRequest)	Deletes the FileSystemPolicy for the specified file system.
default DeleteFileSystemPolicyResponse	deleteFileSystemPolicy(DeleteFileSystemPolicyRequest deleteFileSystemPolicyRequest)	Deletes the FileSystemPolicy for the specified file system.
default DeleteMountTargetResponse	deleteMountTarget(Consumer<DeleteMountTargetRequest.Builder> deleteMountTargetRequest)	Deletes the specified mount target.
default DeleteMountTargetResponse	deleteMountTarget(DeleteMountTargetRequest deleteMountTargetRequest)	Deletes the specified mount target.
default DeleteReplicationConfigurationResponse	deleteReplicationConfiguration(Consumer<DeleteReplicationConfigurationRequest.Builder> deleteReplicationConfigurationRequest)	Deletes a replication configuration.
default DeleteReplicationConfigurationResponse	deleteReplicationConfiguration(DeleteReplicationConfigurationRequest deleteReplicationConfigurationRequest)	Deletes a replication configuration.
default DeleteTagsResponse	deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest)	Deprecated. Use UntagResource.
default DeleteTagsResponse	deleteTags(DeleteTagsRequest deleteTagsRequest)	Deprecated. Use UntagResource.
default DescribeAccessPointsResponse	describeAccessPoints(Consumer<DescribeAccessPointsRequest.Builder> describeAccessPointsRequest)	Returns the description of a specific Amazon EFS access point if the AccessPointId is provided.
default DescribeAccessPointsResponse	describeAccessPoints(DescribeAccessPointsRequest describeAccessPointsRequest)	Returns the description of a specific Amazon EFS access point if the AccessPointId is provided.
default DescribeAccessPointsIterable	describeAccessPointsPaginator(Consumer<DescribeAccessPointsRequest.Builder> describeAccessPointsRequest)	This is a variant of describeAccessPoints(software.amazon.awssdk.services.efs.model.DescribeAccessPointsRequest) operation.
default DescribeAccessPointsIterable	describeAccessPointsPaginator(DescribeAccessPointsRequest describeAccessPointsRequest)	This is a variant of describeAccessPoints(software.amazon.awssdk.services.efs.model.DescribeAccessPointsRequest) operation.
default DescribeAccountPreferencesResponse	describeAccountPreferences(Consumer<DescribeAccountPreferencesRequest.Builder> describeAccountPreferencesRequest)	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.
default DescribeAccountPreferencesResponse	describeAccountPreferences(DescribeAccountPreferencesRequest describeAccountPreferencesRequest)	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.
default DescribeBackupPolicyResponse	describeBackupPolicy(Consumer<DescribeBackupPolicyRequest.Builder> describeBackupPolicyRequest)	Returns the backup policy for the specified EFS file system.
default DescribeBackupPolicyResponse	describeBackupPolicy(DescribeBackupPolicyRequest describeBackupPolicyRequest)	Returns the backup policy for the specified EFS file system.
default DescribeFileSystemPolicyResponse	describeFileSystemPolicy(Consumer<DescribeFileSystemPolicyRequest.Builder> describeFileSystemPolicyRequest)	Returns the FileSystemPolicy for the specified EFS file system.
default DescribeFileSystemPolicyResponse	describeFileSystemPolicy(DescribeFileSystemPolicyRequest describeFileSystemPolicyRequest)	Returns the FileSystemPolicy for the specified EFS file system.
default DescribeFileSystemsResponse	describeFileSystems()	Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided.
default DescribeFileSystemsResponse	describeFileSystems(Consumer<DescribeFileSystemsRequest.Builder> describeFileSystemsRequest)	Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided.
default DescribeFileSystemsResponse	describeFileSystems(DescribeFileSystemsRequest describeFileSystemsRequest)	Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided.
default DescribeFileSystemsIterable	describeFileSystemsPaginator()	This is a variant of describeFileSystems(software.amazon.awssdk.services.efs.model.DescribeFileSystemsRequest) operation.
default DescribeFileSystemsIterable	describeFileSystemsPaginator(Consumer<DescribeFileSystemsRequest.Builder> describeFileSystemsRequest)	This is a variant of describeFileSystems(software.amazon.awssdk.services.efs.model.DescribeFileSystemsRequest) operation.
default DescribeFileSystemsIterable	describeFileSystemsPaginator(DescribeFileSystemsRequest describeFileSystemsRequest)	This is a variant of describeFileSystems(software.amazon.awssdk.services.efs.model.DescribeFileSystemsRequest) operation.
default DescribeLifecycleConfigurationResponse	describeLifecycleConfiguration(Consumer<DescribeLifecycleConfigurationRequest.Builder> describeLifecycleConfigurationRequest)	Returns the current LifecycleConfiguration object for the specified Amazon EFS file system.
default DescribeLifecycleConfigurationResponse	describeLifecycleConfiguration(DescribeLifecycleConfigurationRequest describeLifecycleConfigurationRequest)	Returns the current LifecycleConfiguration object for the specified Amazon EFS file system.
default DescribeMountTargetsResponse	describeMountTargets(Consumer<DescribeMountTargetsRequest.Builder> describeMountTargetsRequest)	Returns the descriptions of all the current mount targets, or a specific mount target, for a file system.
default DescribeMountTargetsResponse	describeMountTargets(DescribeMountTargetsRequest describeMountTargetsRequest)	Returns the descriptions of all the current mount targets, or a specific mount target, for a file system.
default DescribeMountTargetSecurityGroupsResponse	describeMountTargetSecurityGroups(Consumer<DescribeMountTargetSecurityGroupsRequest.Builder> describeMountTargetSecurityGroupsRequest)	Returns the security groups currently in effect for a mount target.
default DescribeMountTargetSecurityGroupsResponse	describeMountTargetSecurityGroups(DescribeMountTargetSecurityGroupsRequest describeMountTargetSecurityGroupsRequest)	Returns the security groups currently in effect for a mount target.
default DescribeMountTargetsIterable	describeMountTargetsPaginator(Consumer<DescribeMountTargetsRequest.Builder> describeMountTargetsRequest)	This is a variant of describeMountTargets(software.amazon.awssdk.services.efs.model.DescribeMountTargetsRequest) operation.
default DescribeMountTargetsIterable	describeMountTargetsPaginator(DescribeMountTargetsRequest describeMountTargetsRequest)	This is a variant of describeMountTargets(software.amazon.awssdk.services.efs.model.DescribeMountTargetsRequest) operation.
default DescribeReplicationConfigurationsResponse	describeReplicationConfigurations(Consumer<DescribeReplicationConfigurationsRequest.Builder> describeReplicationConfigurationsRequest)	Retrieves the replication configuration for a specific file system.
default DescribeReplicationConfigurationsResponse	describeReplicationConfigurations(DescribeReplicationConfigurationsRequest describeReplicationConfigurationsRequest)	Retrieves the replication configuration for a specific file system.
default DescribeReplicationConfigurationsIterable	describeReplicationConfigurationsPaginator(Consumer<DescribeReplicationConfigurationsRequest.Builder> describeReplicationConfigurationsRequest)	This is a variant of describeReplicationConfigurations(software.amazon.awssdk.services.efs.model.DescribeReplicationConfigurationsRequest) operation.
default DescribeReplicationConfigurationsIterable	describeReplicationConfigurationsPaginator(DescribeReplicationConfigurationsRequest describeReplicationConfigurationsRequest)	This is a variant of describeReplicationConfigurations(software.amazon.awssdk.services.efs.model.DescribeReplicationConfigurationsRequest) operation.
default DescribeTagsResponse	describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)	Deprecated. Use ListTagsForResource.
default DescribeTagsResponse	describeTags(DescribeTagsRequest describeTagsRequest)	Deprecated. Use ListTagsForResource.
default DescribeTagsIterable	describeTagsPaginator(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)	Deprecated. Use ListTagsForResource.
default DescribeTagsIterable	describeTagsPaginator(DescribeTagsRequest describeTagsRequest)	Deprecated. Use ListTagsForResource.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists all tags for a top-level EFS resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists all tags for a top-level EFS resource.
default ListTagsForResourceIterable	listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	This is a variant of listTagsForResource(software.amazon.awssdk.services.efs.model.ListTagsForResourceRequest) operation.
default ListTagsForResourceIterable	listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)	This is a variant of listTagsForResource(software.amazon.awssdk.services.efs.model.ListTagsForResourceRequest) operation.
default ModifyMountTargetSecurityGroupsResponse	modifyMountTargetSecurityGroups(Consumer<ModifyMountTargetSecurityGroupsRequest.Builder> modifyMountTargetSecurityGroupsRequest)	Modifies the set of security groups in effect for a mount target.
default ModifyMountTargetSecurityGroupsResponse	modifyMountTargetSecurityGroups(ModifyMountTargetSecurityGroupsRequest modifyMountTargetSecurityGroupsRequest)	Modifies the set of security groups in effect for a mount target.
default PutAccountPreferencesResponse	putAccountPreferences(Consumer<PutAccountPreferencesRequest.Builder> putAccountPreferencesRequest)	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.
default PutAccountPreferencesResponse	putAccountPreferences(PutAccountPreferencesRequest putAccountPreferencesRequest)	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.
default PutBackupPolicyResponse	putBackupPolicy(Consumer<PutBackupPolicyRequest.Builder> putBackupPolicyRequest)	Updates the file system's backup policy.
default PutBackupPolicyResponse	putBackupPolicy(PutBackupPolicyRequest putBackupPolicyRequest)	Updates the file system's backup policy.
default PutFileSystemPolicyResponse	putFileSystemPolicy(Consumer<PutFileSystemPolicyRequest.Builder> putFileSystemPolicyRequest)	Applies an Amazon EFS FileSystemPolicy to an Amazon EFS file system.
default PutFileSystemPolicyResponse	putFileSystemPolicy(PutFileSystemPolicyRequest putFileSystemPolicyRequest)	Applies an Amazon EFS FileSystemPolicy to an Amazon EFS file system.
default PutLifecycleConfigurationResponse	putLifecycleConfiguration(Consumer<PutLifecycleConfigurationRequest.Builder> putLifecycleConfigurationRequest)	Use this action to manage storage for your file system.
default PutLifecycleConfigurationResponse	putLifecycleConfiguration(PutLifecycleConfigurationRequest putLifecycleConfigurationRequest)	Use this action to manage storage for your file system.
default EfsServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Creates a tag for an EFS resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Creates a tag for an EFS resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes tags from an EFS resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes tags from an EFS resource.
default UpdateFileSystemResponse	updateFileSystem(Consumer<UpdateFileSystemRequest.Builder> updateFileSystemRequest)	Updates the throughput mode or the amount of provisioned throughput of an existing file system.
default UpdateFileSystemResponse	updateFileSystem(UpdateFileSystemRequest updateFileSystemRequest)	Updates the throughput mode or the amount of provisioned throughput of an existing file system.
default UpdateFileSystemProtectionResponse	updateFileSystemProtection(Consumer<UpdateFileSystemProtectionRequest.Builder> updateFileSystemProtectionRequest)	Updates protection on the file system.
default UpdateFileSystemProtectionResponse	updateFileSystemProtection(UpdateFileSystemProtectionRequest updateFileSystemProtectionRequest)	Updates protection on the file system.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createAccessPoint

default CreateAccessPointResponse createAccessPoint(CreateAccessPointRequest createAccessPointRequest)
                                             throws BadRequestException,
AccessPointAlreadyExistsException,
IncorrectFileSystemLifeCycleStateException,
InternalServerErrorException,
FileSystemNotFoundException,
AccessPointLimitExceededException,
ThrottlingException,
AwsServiceException,
SdkClientException,
EfsException

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.

Parameters:

createAccessPointRequest -

Returns:

Result of the CreateAccessPoint operation returned by the service.

See Also:

• AWS API Documentation

createAccessPoint

default CreateAccessPointResponse createAccessPoint(Consumer<CreateAccessPointRequest.Builder> createAccessPointRequest)
                                             throws BadRequestException,
AccessPointAlreadyExistsException,
IncorrectFileSystemLifeCycleStateException,
InternalServerErrorException,
FileSystemNotFoundException,
AccessPointLimitExceededException,
ThrottlingException,
AwsServiceException,
SdkClientException,
EfsException

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.

This is a convenience which creates an instance of the CreateAccessPointRequest.Builder avoiding the need to create one manually via CreateAccessPointRequest.builder()

Parameters:

createAccessPointRequest - A Consumer that will call methods on CreateAccessPointRequest.Builder to create a request.

Returns:

Result of the CreateAccessPoint operation returned by the service.

See Also:

• AWS API Documentation

createFileSystem

default CreateFileSystemResponse createFileSystem(CreateFileSystemRequest createFileSystemRequest)
                                           throws BadRequestException,
InternalServerErrorException,
FileSystemAlreadyExistsException,
FileSystemLimitExceededException,
InsufficientThroughputCapacityException,
ThroughputLimitExceededException,
UnsupportedAvailabilityZoneException,
AwsServiceException,
SdkClientException,
EfsException

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 all file systems. File systems using the maxIO mode is a previous generation performance type that is designed for highly parallelized workloads that can tolerate higher latencies than the General Purpose mode. Max I/O mode is not supported for One Zone file systems or file systems that use Elastic throughput.

Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.

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.

Parameters:

createFileSystemRequest -

Returns:

Result of the CreateFileSystem operation returned by the service.

See Also:

• AWS API Documentation

createFileSystem

default CreateFileSystemResponse createFileSystem(Consumer<CreateFileSystemRequest.Builder> createFileSystemRequest)
                                           throws BadRequestException,
InternalServerErrorException,
FileSystemAlreadyExistsException,
FileSystemLimitExceededException,
InsufficientThroughputCapacityException,
ThroughputLimitExceededException,
UnsupportedAvailabilityZoneException,
AwsServiceException,
SdkClientException,
EfsException

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 all file systems. File systems using the maxIO mode is a previous generation performance type that is designed for highly parallelized workloads that can tolerate higher latencies than the General Purpose mode. Max I/O mode is not supported for One Zone file systems or file systems that use Elastic throughput.

Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.

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.

This is a convenience which creates an instance of the CreateFileSystemRequest.Builder avoiding the need to create one manually via CreateFileSystemRequest.builder()

Parameters:

createFileSystemRequest - A Consumer that will call methods on CreateFileSystemRequest.Builder to create a request.

Returns:

Result of the CreateFileSystem operation returned by the service.

See Also:

• AWS API Documentation

createMountTarget

default CreateMountTargetResponse createMountTarget(CreateMountTargetRequest createMountTargetRequest)
                                             throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
IncorrectFileSystemLifeCycleStateException,
MountTargetConflictException,
SubnetNotFoundException,
NoFreeAddressesInSubnetException,
IpAddressInUseException,
NetworkInterfaceLimitExceededException,
SecurityGroupLimitExceededException,
SecurityGroupNotFoundException,
UnsupportedAvailabilityZoneException,
AvailabilityZonesMismatchException,
AwsServiceException,
SdkClientException,
EfsException

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 a One Zone file system. 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

Parameters:

createMountTargetRequest -

Returns:

Result of the CreateMountTarget operation returned by the service.

See Also:

• AWS API Documentation

createMountTarget

default CreateMountTargetResponse createMountTarget(Consumer<CreateMountTargetRequest.Builder> createMountTargetRequest)
                                             throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
IncorrectFileSystemLifeCycleStateException,
MountTargetConflictException,
SubnetNotFoundException,
NoFreeAddressesInSubnetException,
IpAddressInUseException,
NetworkInterfaceLimitExceededException,
SecurityGroupLimitExceededException,
SecurityGroupNotFoundException,
UnsupportedAvailabilityZoneException,
AvailabilityZonesMismatchException,
AwsServiceException,
SdkClientException,
EfsException

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 a One Zone file system. 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

This is a convenience which creates an instance of the CreateMountTargetRequest.Builder avoiding the need to create one manually via CreateMountTargetRequest.builder()

Parameters:

createMountTargetRequest - A Consumer that will call methods on CreateMountTargetRequest.Builder to create a request.

Returns:

Result of the CreateMountTarget operation returned by the service.

See Also:

• AWS API Documentation

createReplicationConfiguration

default CreateReplicationConfigurationResponse createReplicationConfiguration(CreateReplicationConfigurationRequest createReplicationConfigurationRequest)
                                                                       throws BadRequestException,
IncorrectFileSystemLifeCycleStateException,
ValidationException,
ReplicationNotFoundException,
FileSystemNotFoundException,
UnsupportedAvailabilityZoneException,
FileSystemLimitExceededException,
InsufficientThroughputCapacityException,
ThroughputLimitExceededException,
ConflictException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
EfsException

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 – The EFS file system that you want replicated. The source file system cannot be a destination file system in an existing replication configuration.

• 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. The Region must be enabled. For more information, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference Reference Guide.

• 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.

  Parameters for the replication configuration include:

  • File system ID – The ID of the destination file system for the replication. If no ID is provided, then EFS creates a new file system with the default settings. For existing file systems, the file system's replication overwrite protection must be disabled. For more information, see Replicating to an existing file system.

  • Availability Zone – If you want the destination file system to use One Zone storage, you must specify the Availability Zone to create the file system in. For more information, see EFS file system types 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.

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

For new destination file systems, 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.

• Lifecycle management – Lifecycle management is not enabled on the destination file system. After the destination file system is created, you can enable lifecycle management.

• 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.

Parameters:

createReplicationConfigurationRequest -

Returns:

Result of the CreateReplicationConfiguration operation returned by the service.

See Also:

• AWS API Documentation

createReplicationConfiguration

default CreateReplicationConfigurationResponse createReplicationConfiguration(Consumer<CreateReplicationConfigurationRequest.Builder> createReplicationConfigurationRequest)
                                                                       throws BadRequestException,
IncorrectFileSystemLifeCycleStateException,
ValidationException,
ReplicationNotFoundException,
FileSystemNotFoundException,
UnsupportedAvailabilityZoneException,
FileSystemLimitExceededException,
InsufficientThroughputCapacityException,
ThroughputLimitExceededException,
ConflictException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
EfsException

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 – The EFS file system that you want replicated. The source file system cannot be a destination file system in an existing replication configuration.

• 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. The Region must be enabled. For more information, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference Reference Guide.

• 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.

  Parameters for the replication configuration include:

  • File system ID – The ID of the destination file system for the replication. If no ID is provided, then EFS creates a new file system with the default settings. For existing file systems, the file system's replication overwrite protection must be disabled. For more information, see Replicating to an existing file system.

  • Availability Zone – If you want the destination file system to use One Zone storage, you must specify the Availability Zone to create the file system in. For more information, see EFS file system types 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.

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

For new destination file systems, 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.

• Lifecycle management – Lifecycle management is not enabled on the destination file system. After the destination file system is created, you can enable lifecycle management.

• 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.

This is a convenience which creates an instance of the CreateReplicationConfigurationRequest.Builder avoiding the need to create one manually via CreateReplicationConfigurationRequest.builder()

Parameters:

createReplicationConfigurationRequest - A Consumer that will call methods on CreateReplicationConfigurationRequest.Builder to create a request.

Returns:

Result of the CreateReplicationConfiguration operation returned by the service.

See Also:

• AWS API Documentation

createTags

@Deprecated
default CreateTagsResponse createTags(CreateTagsRequest createTagsRequest)
                               throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

Deprecated.

Use TagResource.

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.

Parameters:

createTagsRequest -

Returns:

Result of the CreateTags operation returned by the service.

See Also:

• AWS API Documentation

createTags

@Deprecated
default CreateTagsResponse createTags(Consumer<CreateTagsRequest.Builder> createTagsRequest)
                               throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

Deprecated.

Use TagResource.

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.

This is a convenience which creates an instance of the CreateTagsRequest.Builder avoiding the need to create one manually via CreateTagsRequest.builder()

Parameters:

createTagsRequest - A Consumer that will call methods on CreateTagsRequest.Builder to create a request.

Returns:

Result of the CreateTags operation returned by the service.

See Also:

• AWS API Documentation

deleteAccessPoint

default DeleteAccessPointResponse deleteAccessPoint(DeleteAccessPointRequest deleteAccessPointRequest)
                                             throws BadRequestException,
InternalServerErrorException,
AccessPointNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

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.

Parameters:

deleteAccessPointRequest -

Returns:

Result of the DeleteAccessPoint operation returned by the service.

See Also:

• AWS API Documentation

deleteAccessPoint

default DeleteAccessPointResponse deleteAccessPoint(Consumer<DeleteAccessPointRequest.Builder> deleteAccessPointRequest)
                                             throws BadRequestException,
InternalServerErrorException,
AccessPointNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

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.

This is a convenience which creates an instance of the DeleteAccessPointRequest.Builder avoiding the need to create one manually via DeleteAccessPointRequest.builder()

Parameters:

deleteAccessPointRequest - A Consumer that will call methods on DeleteAccessPointRequest.Builder to create a request.

Returns:

Result of the DeleteAccessPoint operation returned by the service.

See Also:

• AWS API Documentation

deleteFileSystem

default DeleteFileSystemResponse deleteFileSystem(DeleteFileSystemRequest deleteFileSystemRequest)
                                           throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
FileSystemInUseException,
AwsServiceException,
SdkClientException,
EfsException

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.

Parameters:

deleteFileSystemRequest -

Returns:

Result of the DeleteFileSystem operation returned by the service.

See Also:

• AWS API Documentation

deleteFileSystem

default DeleteFileSystemResponse deleteFileSystem(Consumer<DeleteFileSystemRequest.Builder> deleteFileSystemRequest)
                                           throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
FileSystemInUseException,
AwsServiceException,
SdkClientException,
EfsException

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.

This is a convenience which creates an instance of the DeleteFileSystemRequest.Builder avoiding the need to create one manually via DeleteFileSystemRequest.builder()

Parameters:

deleteFileSystemRequest - A Consumer that will call methods on DeleteFileSystemRequest.Builder to create a request.

Returns:

Result of the DeleteFileSystem operation returned by the service.

See Also:

• AWS API Documentation

deleteFileSystemPolicy

default DeleteFileSystemPolicyResponse deleteFileSystemPolicy(DeleteFileSystemPolicyRequest deleteFileSystemPolicyRequest)
                                                       throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
IncorrectFileSystemLifeCycleStateException,
AwsServiceException,
SdkClientException,
EfsException

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.

Parameters:

deleteFileSystemPolicyRequest -

Returns:

Result of the DeleteFileSystemPolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteFileSystemPolicy

default DeleteFileSystemPolicyResponse deleteFileSystemPolicy(Consumer<DeleteFileSystemPolicyRequest.Builder> deleteFileSystemPolicyRequest)
                                                       throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
IncorrectFileSystemLifeCycleStateException,
AwsServiceException,
SdkClientException,
EfsException

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.

This is a convenience which creates an instance of the DeleteFileSystemPolicyRequest.Builder avoiding the need to create one manually via DeleteFileSystemPolicyRequest.builder()

Parameters:

deleteFileSystemPolicyRequest - A Consumer that will call methods on DeleteFileSystemPolicyRequest.Builder to create a request.

Returns:

Result of the DeleteFileSystemPolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteMountTarget

default DeleteMountTargetResponse deleteMountTarget(DeleteMountTargetRequest deleteMountTargetRequest)
                                             throws BadRequestException,
InternalServerErrorException,
DependencyTimeoutException,
MountTargetNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

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

Parameters:

deleteMountTargetRequest -

Returns:

Result of the DeleteMountTarget operation returned by the service.

See Also:

• AWS API Documentation

deleteMountTarget

default DeleteMountTargetResponse deleteMountTarget(Consumer<DeleteMountTargetRequest.Builder> deleteMountTargetRequest)
                                             throws BadRequestException,
InternalServerErrorException,
DependencyTimeoutException,
MountTargetNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

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

This is a convenience which creates an instance of the DeleteMountTargetRequest.Builder avoiding the need to create one manually via DeleteMountTargetRequest.builder()

Parameters:

deleteMountTargetRequest - A Consumer that will call methods on DeleteMountTargetRequest.Builder to create a request.

Returns:

Result of the DeleteMountTarget operation returned by the service.

See Also:

• AWS API Documentation

deleteReplicationConfiguration

default DeleteReplicationConfigurationResponse deleteReplicationConfiguration(DeleteReplicationConfigurationRequest deleteReplicationConfigurationRequest)
                                                                       throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
ReplicationNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

Deletes a replication configuration. Deleting a replication configuration ends the replication process. After a replication configuration is deleted, the destination file system becomes Writeable and its replication overwrite protection is re-enabled. For more information, see Delete a replication configuration.

This operation requires permissions for the elasticfilesystem:DeleteReplicationConfiguration action.

Parameters:

deleteReplicationConfigurationRequest -

Returns:

Result of the DeleteReplicationConfiguration operation returned by the service.

See Also:

• AWS API Documentation

deleteReplicationConfiguration

default DeleteReplicationConfigurationResponse deleteReplicationConfiguration(Consumer<DeleteReplicationConfigurationRequest.Builder> deleteReplicationConfigurationRequest)
                                                                       throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
ReplicationNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

Deletes a replication configuration. Deleting a replication configuration ends the replication process. After a replication configuration is deleted, the destination file system becomes Writeable and its replication overwrite protection is re-enabled. For more information, see Delete a replication configuration.

This operation requires permissions for the elasticfilesystem:DeleteReplicationConfiguration action.

This is a convenience which creates an instance of the DeleteReplicationConfigurationRequest.Builder avoiding the need to create one manually via DeleteReplicationConfigurationRequest.builder()

Parameters:

deleteReplicationConfigurationRequest - A Consumer that will call methods on DeleteReplicationConfigurationRequest.Builder to create a request.

Returns:

Result of the DeleteReplicationConfiguration operation returned by the service.

See Also:

• AWS API Documentation

deleteTags

@Deprecated
default DeleteTagsResponse deleteTags(DeleteTagsRequest deleteTagsRequest)
                               throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

Deprecated.

Use UntagResource.

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.

Parameters:

deleteTagsRequest -

Returns:

Result of the DeleteTags operation returned by the service.

See Also:

• AWS API Documentation

deleteTags

@Deprecated
default DeleteTagsResponse deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest)
                               throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

Deprecated.

Use UntagResource.

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.

This is a convenience which creates an instance of the DeleteTagsRequest.Builder avoiding the need to create one manually via DeleteTagsRequest.builder()

Parameters:

deleteTagsRequest - A Consumer that will call methods on DeleteTagsRequest.Builder to create a request.

Returns:

Result of the DeleteTags operation returned by the service.

See Also:

• AWS API Documentation

describeAccessPoints

default DescribeAccessPointsResponse describeAccessPoints(DescribeAccessPointsRequest describeAccessPointsRequest)
                                                   throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
AccessPointNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

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.

Parameters:

describeAccessPointsRequest -

Returns:

Result of the DescribeAccessPoints operation returned by the service.

See Also:

• AWS API Documentation

describeAccessPoints

default DescribeAccessPointsResponse describeAccessPoints(Consumer<DescribeAccessPointsRequest.Builder> describeAccessPointsRequest)
                                                   throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
AccessPointNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

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.

This is a convenience which creates an instance of the DescribeAccessPointsRequest.Builder avoiding the need to create one manually via DescribeAccessPointsRequest.builder()

Parameters:

describeAccessPointsRequest - A Consumer that will call methods on DescribeAccessPointsRequest.Builder to create a request.

Returns:

Result of the DescribeAccessPoints operation returned by the service.

See Also:

• AWS API Documentation

describeAccessPointsPaginator

default DescribeAccessPointsIterable describeAccessPointsPaginator(DescribeAccessPointsRequest describeAccessPointsRequest)
                                                            throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
AccessPointNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

This is a variant of describeAccessPoints(software.amazon.awssdk.services.efs.model.DescribeAccessPointsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.efs.paginators.DescribeAccessPointsIterable responses = client.describeAccessPointsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.efs.paginators.DescribeAccessPointsIterable responses = client
             .describeAccessPointsPaginator(request);
     for (software.amazon.awssdk.services.efs.model.DescribeAccessPointsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.efs.paginators.DescribeAccessPointsIterable responses = client.describeAccessPointsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeAccessPoints(software.amazon.awssdk.services.efs.model.DescribeAccessPointsRequest) operation.

Parameters:

describeAccessPointsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeAccessPointsPaginator

default DescribeAccessPointsIterable describeAccessPointsPaginator(Consumer<DescribeAccessPointsRequest.Builder> describeAccessPointsRequest)
                                                            throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
AccessPointNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

This is a variant of describeAccessPoints(software.amazon.awssdk.services.efs.model.DescribeAccessPointsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.efs.paginators.DescribeAccessPointsIterable responses = client.describeAccessPointsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.efs.paginators.DescribeAccessPointsIterable responses = client
             .describeAccessPointsPaginator(request);
     for (software.amazon.awssdk.services.efs.model.DescribeAccessPointsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.efs.paginators.DescribeAccessPointsIterable responses = client.describeAccessPointsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeAccessPoints(software.amazon.awssdk.services.efs.model.DescribeAccessPointsRequest) operation.

This is a convenience which creates an instance of the DescribeAccessPointsRequest.Builder avoiding the need to create one manually via DescribeAccessPointsRequest.builder()

Parameters:

describeAccessPointsRequest - A Consumer that will call methods on DescribeAccessPointsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeAccountPreferences

default DescribeAccountPreferencesResponse describeAccountPreferences(DescribeAccountPreferencesRequest describeAccountPreferencesRequest)
                                                               throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
EfsException

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.

Parameters:

describeAccountPreferencesRequest -

Returns:

Result of the DescribeAccountPreferences operation returned by the service.

See Also:

• AWS API Documentation

describeAccountPreferences

default DescribeAccountPreferencesResponse describeAccountPreferences(Consumer<DescribeAccountPreferencesRequest.Builder> describeAccountPreferencesRequest)
                                                               throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
EfsException

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.

This is a convenience which creates an instance of the DescribeAccountPreferencesRequest.Builder avoiding the need to create one manually via DescribeAccountPreferencesRequest.builder()

Parameters:

describeAccountPreferencesRequest - A Consumer that will call methods on DescribeAccountPreferencesRequest.Builder to create a request.

Returns:

Result of the DescribeAccountPreferences operation returned by the service.

See Also:

• AWS API Documentation

describeBackupPolicy

default DescribeBackupPolicyResponse describeBackupPolicy(DescribeBackupPolicyRequest describeBackupPolicyRequest)
                                                   throws BadRequestException,
FileSystemNotFoundException,
InternalServerErrorException,
PolicyNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
EfsException

Returns the backup policy for the specified EFS file system.

Parameters:

describeBackupPolicyRequest -

Returns:

Result of the DescribeBackupPolicy operation returned by the service.

See Also:

• AWS API Documentation

describeBackupPolicy

default DescribeBackupPolicyResponse describeBackupPolicy(Consumer<DescribeBackupPolicyRequest.Builder> describeBackupPolicyRequest)
                                                   throws BadRequestException,
FileSystemNotFoundException,
InternalServerErrorException,
PolicyNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
EfsException

Returns the backup policy for the specified EFS file system.

This is a convenience which creates an instance of the DescribeBackupPolicyRequest.Builder avoiding the need to create one manually via DescribeBackupPolicyRequest.builder()

Parameters:

describeBackupPolicyRequest - A Consumer that will call methods on DescribeBackupPolicyRequest.Builder to create a request.

Returns:

Result of the DescribeBackupPolicy operation returned by the service.

See Also:

• AWS API Documentation

describeFileSystemPolicy

default DescribeFileSystemPolicyResponse describeFileSystemPolicy(DescribeFileSystemPolicyRequest describeFileSystemPolicyRequest)
                                                           throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
PolicyNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

Returns the FileSystemPolicy for the specified EFS file system.

This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy action.

Parameters:

describeFileSystemPolicyRequest -

Returns:

Result of the DescribeFileSystemPolicy operation returned by the service.

See Also:

• AWS API Documentation

describeFileSystemPolicy

default DescribeFileSystemPolicyResponse describeFileSystemPolicy(Consumer<DescribeFileSystemPolicyRequest.Builder> describeFileSystemPolicyRequest)
                                                           throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
PolicyNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

Returns the FileSystemPolicy for the specified EFS file system.

This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy action.

This is a convenience which creates an instance of the DescribeFileSystemPolicyRequest.Builder avoiding the need to create one manually via DescribeFileSystemPolicyRequest.builder()

Parameters:

describeFileSystemPolicyRequest - A Consumer that will call methods on DescribeFileSystemPolicyRequest.Builder to create a request.

Returns:

Result of the DescribeFileSystemPolicy operation returned by the service.

See Also:

• AWS API Documentation

describeFileSystems

default DescribeFileSystemsResponse describeFileSystems(DescribeFileSystemsRequest describeFileSystemsRequest)
                                                 throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

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.

Parameters:

describeFileSystemsRequest -

Returns:

Result of the DescribeFileSystems operation returned by the service.

See Also:

• AWS API Documentation

describeFileSystems

default DescribeFileSystemsResponse describeFileSystems(Consumer<DescribeFileSystemsRequest.Builder> describeFileSystemsRequest)
                                                 throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

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.

This is a convenience which creates an instance of the DescribeFileSystemsRequest.Builder avoiding the need to create one manually via DescribeFileSystemsRequest.builder()

Parameters:

describeFileSystemsRequest - A Consumer that will call methods on DescribeFileSystemsRequest.Builder to create a request.

Returns:

Result of the DescribeFileSystems operation returned by the service.

See Also:

• AWS API Documentation

describeFileSystems

default DescribeFileSystemsResponse describeFileSystems()
                                                 throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

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.

Returns:

Result of the DescribeFileSystems operation returned by the service.

See Also:

• describeFileSystems(DescribeFileSystemsRequest)
• AWS API Documentation

describeFileSystemsPaginator

default DescribeFileSystemsIterable describeFileSystemsPaginator()
                                                          throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

This is a variant of describeFileSystems(software.amazon.awssdk.services.efs.model.DescribeFileSystemsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.efs.paginators.DescribeFileSystemsIterable responses = client.describeFileSystemsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.efs.paginators.DescribeFileSystemsIterable responses = client
             .describeFileSystemsPaginator(request);
     for (software.amazon.awssdk.services.efs.model.DescribeFileSystemsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.efs.paginators.DescribeFileSystemsIterable responses = client.describeFileSystemsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeFileSystems(software.amazon.awssdk.services.efs.model.DescribeFileSystemsRequest) operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• describeFileSystemsPaginator(DescribeFileSystemsRequest)
• AWS API Documentation

describeFileSystemsPaginator

default DescribeFileSystemsIterable describeFileSystemsPaginator(DescribeFileSystemsRequest describeFileSystemsRequest)
                                                          throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

This is a variant of describeFileSystems(software.amazon.awssdk.services.efs.model.DescribeFileSystemsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.efs.paginators.DescribeFileSystemsIterable responses = client.describeFileSystemsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.efs.paginators.DescribeFileSystemsIterable responses = client
             .describeFileSystemsPaginator(request);
     for (software.amazon.awssdk.services.efs.model.DescribeFileSystemsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.efs.paginators.DescribeFileSystemsIterable responses = client.describeFileSystemsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeFileSystems(software.amazon.awssdk.services.efs.model.DescribeFileSystemsRequest) operation.

Parameters:

describeFileSystemsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeFileSystemsPaginator

default DescribeFileSystemsIterable describeFileSystemsPaginator(Consumer<DescribeFileSystemsRequest.Builder> describeFileSystemsRequest)
                                                          throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

This is a variant of describeFileSystems(software.amazon.awssdk.services.efs.model.DescribeFileSystemsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.efs.paginators.DescribeFileSystemsIterable responses = client.describeFileSystemsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.efs.paginators.DescribeFileSystemsIterable responses = client
             .describeFileSystemsPaginator(request);
     for (software.amazon.awssdk.services.efs.model.DescribeFileSystemsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.efs.paginators.DescribeFileSystemsIterable responses = client.describeFileSystemsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeFileSystems(software.amazon.awssdk.services.efs.model.DescribeFileSystemsRequest) operation.

This is a convenience which creates an instance of the DescribeFileSystemsRequest.Builder avoiding the need to create one manually via DescribeFileSystemsRequest.builder()

Parameters:

describeFileSystemsRequest - A Consumer that will call methods on DescribeFileSystemsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeLifecycleConfiguration

default DescribeLifecycleConfigurationResponse describeLifecycleConfiguration(DescribeLifecycleConfigurationRequest describeLifecycleConfigurationRequest)
                                                                       throws InternalServerErrorException,
BadRequestException,
FileSystemNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

Returns the current LifecycleConfiguration object for the specified Amazon EFS file system. Lifecycle management uses the LifecycleConfiguration object to identify when to move files between storage classes. For a file system without a LifecycleConfiguration object, the call returns an empty array in the response.

This operation requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration operation.

Parameters:

describeLifecycleConfigurationRequest -

Returns:

Result of the DescribeLifecycleConfiguration operation returned by the service.

See Also:

• AWS API Documentation

describeLifecycleConfiguration

default DescribeLifecycleConfigurationResponse describeLifecycleConfiguration(Consumer<DescribeLifecycleConfigurationRequest.Builder> describeLifecycleConfigurationRequest)
                                                                       throws InternalServerErrorException,
BadRequestException,
FileSystemNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

Returns the current LifecycleConfiguration object for the specified Amazon EFS file system. Lifecycle management uses the LifecycleConfiguration object to identify when to move files between storage classes. For a file system without a LifecycleConfiguration object, the call returns an empty array in the response.

This operation requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration operation.

This is a convenience which creates an instance of the DescribeLifecycleConfigurationRequest.Builder avoiding the need to create one manually via DescribeLifecycleConfigurationRequest.builder()

Parameters:

describeLifecycleConfigurationRequest - A Consumer that will call methods on DescribeLifecycleConfigurationRequest.Builder to create a request.

Returns:

Result of the DescribeLifecycleConfiguration operation returned by the service.

See Also:

• AWS API Documentation

describeMountTargetSecurityGroups

default DescribeMountTargetSecurityGroupsResponse describeMountTargetSecurityGroups(DescribeMountTargetSecurityGroupsRequest describeMountTargetSecurityGroupsRequest)
                                                                             throws BadRequestException,
InternalServerErrorException,
MountTargetNotFoundException,
IncorrectMountTargetStateException,
AwsServiceException,
SdkClientException,
EfsException

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.

Parameters:

describeMountTargetSecurityGroupsRequest -

Returns:

Result of the DescribeMountTargetSecurityGroups operation returned by the service.

See Also:

• AWS API Documentation

describeMountTargetSecurityGroups

default DescribeMountTargetSecurityGroupsResponse describeMountTargetSecurityGroups(Consumer<DescribeMountTargetSecurityGroupsRequest.Builder> describeMountTargetSecurityGroupsRequest)
                                                                             throws BadRequestException,
InternalServerErrorException,
MountTargetNotFoundException,
IncorrectMountTargetStateException,
AwsServiceException,
SdkClientException,
EfsException

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.

This is a convenience which creates an instance of the DescribeMountTargetSecurityGroupsRequest.Builder avoiding the need to create one manually via DescribeMountTargetSecurityGroupsRequest.builder()

Parameters:

describeMountTargetSecurityGroupsRequest - A Consumer that will call methods on DescribeMountTargetSecurityGroupsRequest.Builder to create a request.

Returns:

Result of the DescribeMountTargetSecurityGroups operation returned by the service.

See Also:

• AWS API Documentation

describeMountTargets

default DescribeMountTargetsResponse describeMountTargets(DescribeMountTargetsRequest describeMountTargetsRequest)
                                                   throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
MountTargetNotFoundException,
AccessPointNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

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.

Parameters:

describeMountTargetsRequest -

Returns:

Result of the DescribeMountTargets operation returned by the service.

See Also:

• AWS API Documentation

describeMountTargets

default DescribeMountTargetsResponse describeMountTargets(Consumer<DescribeMountTargetsRequest.Builder> describeMountTargetsRequest)
                                                   throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
MountTargetNotFoundException,
AccessPointNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

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.

This is a convenience which creates an instance of the DescribeMountTargetsRequest.Builder avoiding the need to create one manually via DescribeMountTargetsRequest.builder()

Parameters:

describeMountTargetsRequest - A Consumer that will call methods on DescribeMountTargetsRequest.Builder to create a request.

Returns:

Result of the DescribeMountTargets operation returned by the service.

See Also:

• AWS API Documentation

describeMountTargetsPaginator

default DescribeMountTargetsIterable describeMountTargetsPaginator(DescribeMountTargetsRequest describeMountTargetsRequest)
                                                            throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
MountTargetNotFoundException,
AccessPointNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

This is a variant of describeMountTargets(software.amazon.awssdk.services.efs.model.DescribeMountTargetsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.efs.paginators.DescribeMountTargetsIterable responses = client.describeMountTargetsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.efs.paginators.DescribeMountTargetsIterable responses = client
             .describeMountTargetsPaginator(request);
     for (software.amazon.awssdk.services.efs.model.DescribeMountTargetsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.efs.paginators.DescribeMountTargetsIterable responses = client.describeMountTargetsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeMountTargets(software.amazon.awssdk.services.efs.model.DescribeMountTargetsRequest) operation.

Parameters:

describeMountTargetsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeMountTargetsPaginator

default DescribeMountTargetsIterable describeMountTargetsPaginator(Consumer<DescribeMountTargetsRequest.Builder> describeMountTargetsRequest)
                                                            throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
MountTargetNotFoundException,
AccessPointNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

This is a variant of describeMountTargets(software.amazon.awssdk.services.efs.model.DescribeMountTargetsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.efs.paginators.DescribeMountTargetsIterable responses = client.describeMountTargetsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.efs.paginators.DescribeMountTargetsIterable responses = client
             .describeMountTargetsPaginator(request);
     for (software.amazon.awssdk.services.efs.model.DescribeMountTargetsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.efs.paginators.DescribeMountTargetsIterable responses = client.describeMountTargetsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeMountTargets(software.amazon.awssdk.services.efs.model.DescribeMountTargetsRequest) operation.

This is a convenience which creates an instance of the DescribeMountTargetsRequest.Builder avoiding the need to create one manually via DescribeMountTargetsRequest.builder()

Parameters:

describeMountTargetsRequest - A Consumer that will call methods on DescribeMountTargetsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeReplicationConfigurations

default DescribeReplicationConfigurationsResponse describeReplicationConfigurations(DescribeReplicationConfigurationsRequest describeReplicationConfigurationsRequest)
                                                                             throws BadRequestException,
FileSystemNotFoundException,
InternalServerErrorException,
ReplicationNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
EfsException

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.

Parameters:

describeReplicationConfigurationsRequest -

Returns:

Result of the DescribeReplicationConfigurations operation returned by the service.

See Also:

• AWS API Documentation

describeReplicationConfigurations

default DescribeReplicationConfigurationsResponse describeReplicationConfigurations(Consumer<DescribeReplicationConfigurationsRequest.Builder> describeReplicationConfigurationsRequest)
                                                                             throws BadRequestException,
FileSystemNotFoundException,
InternalServerErrorException,
ReplicationNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
EfsException

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.

This is a convenience which creates an instance of the DescribeReplicationConfigurationsRequest.Builder avoiding the need to create one manually via DescribeReplicationConfigurationsRequest.builder()

Parameters:

describeReplicationConfigurationsRequest - A Consumer that will call methods on DescribeReplicationConfigurationsRequest.Builder to create a request.

Returns:

Result of the DescribeReplicationConfigurations operation returned by the service.

See Also:

• AWS API Documentation

describeReplicationConfigurationsPaginator

default DescribeReplicationConfigurationsIterable describeReplicationConfigurationsPaginator(DescribeReplicationConfigurationsRequest describeReplicationConfigurationsRequest)
                                                                                      throws BadRequestException,
FileSystemNotFoundException,
InternalServerErrorException,
ReplicationNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
EfsException

This is a variant of describeReplicationConfigurations(software.amazon.awssdk.services.efs.model.DescribeReplicationConfigurationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.efs.paginators.DescribeReplicationConfigurationsIterable responses = client.describeReplicationConfigurationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.efs.paginators.DescribeReplicationConfigurationsIterable responses = client
             .describeReplicationConfigurationsPaginator(request);
     for (software.amazon.awssdk.services.efs.model.DescribeReplicationConfigurationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.efs.paginators.DescribeReplicationConfigurationsIterable responses = client.describeReplicationConfigurationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeReplicationConfigurations(software.amazon.awssdk.services.efs.model.DescribeReplicationConfigurationsRequest) operation.

Parameters:

describeReplicationConfigurationsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeReplicationConfigurationsPaginator

default DescribeReplicationConfigurationsIterable describeReplicationConfigurationsPaginator(Consumer<DescribeReplicationConfigurationsRequest.Builder> describeReplicationConfigurationsRequest)
                                                                                      throws BadRequestException,
FileSystemNotFoundException,
InternalServerErrorException,
ReplicationNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
EfsException

This is a variant of describeReplicationConfigurations(software.amazon.awssdk.services.efs.model.DescribeReplicationConfigurationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.efs.paginators.DescribeReplicationConfigurationsIterable responses = client.describeReplicationConfigurationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.efs.paginators.DescribeReplicationConfigurationsIterable responses = client
             .describeReplicationConfigurationsPaginator(request);
     for (software.amazon.awssdk.services.efs.model.DescribeReplicationConfigurationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.efs.paginators.DescribeReplicationConfigurationsIterable responses = client.describeReplicationConfigurationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeReplicationConfigurations(software.amazon.awssdk.services.efs.model.DescribeReplicationConfigurationsRequest) operation.

This is a convenience which creates an instance of the DescribeReplicationConfigurationsRequest.Builder avoiding the need to create one manually via DescribeReplicationConfigurationsRequest.builder()

Parameters:

describeReplicationConfigurationsRequest - A Consumer that will call methods on DescribeReplicationConfigurationsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeTags

@Deprecated
default DescribeTagsResponse describeTags(DescribeTagsRequest describeTagsRequest)
                                   throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

Deprecated.

Use ListTagsForResource.

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.

Parameters:

describeTagsRequest -

Returns:

Result of the DescribeTags operation returned by the service.

See Also:

• AWS API Documentation

describeTags

@Deprecated
default DescribeTagsResponse describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)
                                   throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

Deprecated.

Use ListTagsForResource.

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.

This is a convenience which creates an instance of the DescribeTagsRequest.Builder avoiding the need to create one manually via DescribeTagsRequest.builder()

Parameters:

describeTagsRequest - A Consumer that will call methods on DescribeTagsRequest.Builder to create a request.

Returns:

Result of the DescribeTags operation returned by the service.

See Also:

• AWS API Documentation

describeTagsPaginator

@Deprecated
default DescribeTagsIterable describeTagsPaginator(DescribeTagsRequest describeTagsRequest)
                                            throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

Deprecated.

Use ListTagsForResource.

This is a variant of describeTags(software.amazon.awssdk.services.efs.model.DescribeTagsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.efs.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.efs.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request);
     for (software.amazon.awssdk.services.efs.model.DescribeTagsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.efs.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeTags(software.amazon.awssdk.services.efs.model.DescribeTagsRequest) operation.

Parameters:

describeTagsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeTagsPaginator

@Deprecated
default DescribeTagsIterable describeTagsPaginator(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)
                                            throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

Deprecated.

Use ListTagsForResource.

This is a variant of describeTags(software.amazon.awssdk.services.efs.model.DescribeTagsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.efs.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.efs.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request);
     for (software.amazon.awssdk.services.efs.model.DescribeTagsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.efs.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeTags(software.amazon.awssdk.services.efs.model.DescribeTagsRequest) operation.

This is a convenience which creates an instance of the DescribeTagsRequest.Builder avoiding the need to create one manually via DescribeTagsRequest.builder()

Parameters:

describeTagsRequest - A Consumer that will call methods on DescribeTagsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
AccessPointNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

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.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
AccessPointNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

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.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResourcePaginator

default ListTagsForResourceIterable listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
                                                          throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
AccessPointNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

This is a variant of listTagsForResource(software.amazon.awssdk.services.efs.model.ListTagsForResourceRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.efs.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.efs.paginators.ListTagsForResourceIterable responses = client
             .listTagsForResourcePaginator(request);
     for (software.amazon.awssdk.services.efs.model.ListTagsForResourceResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.efs.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listTagsForResource(software.amazon.awssdk.services.efs.model.ListTagsForResourceRequest) operation.

Parameters:

listTagsForResourceRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResourcePaginator

default ListTagsForResourceIterable listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                          throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
AccessPointNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

This is a variant of listTagsForResource(software.amazon.awssdk.services.efs.model.ListTagsForResourceRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.efs.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.efs.paginators.ListTagsForResourceIterable responses = client
             .listTagsForResourcePaginator(request);
     for (software.amazon.awssdk.services.efs.model.ListTagsForResourceResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.efs.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listTagsForResource(software.amazon.awssdk.services.efs.model.ListTagsForResourceRequest) operation.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

modifyMountTargetSecurityGroups

default ModifyMountTargetSecurityGroupsResponse modifyMountTargetSecurityGroups(ModifyMountTargetSecurityGroupsRequest modifyMountTargetSecurityGroupsRequest)
                                                                         throws BadRequestException,
InternalServerErrorException,
MountTargetNotFoundException,
IncorrectMountTargetStateException,
SecurityGroupLimitExceededException,
SecurityGroupNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

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.

Parameters:

modifyMountTargetSecurityGroupsRequest -

Returns:

Result of the ModifyMountTargetSecurityGroups operation returned by the service.

See Also:

• AWS API Documentation

modifyMountTargetSecurityGroups

default ModifyMountTargetSecurityGroupsResponse modifyMountTargetSecurityGroups(Consumer<ModifyMountTargetSecurityGroupsRequest.Builder> modifyMountTargetSecurityGroupsRequest)
                                                                         throws BadRequestException,
InternalServerErrorException,
MountTargetNotFoundException,
IncorrectMountTargetStateException,
SecurityGroupLimitExceededException,
SecurityGroupNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

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.

This is a convenience which creates an instance of the ModifyMountTargetSecurityGroupsRequest.Builder avoiding the need to create one manually via ModifyMountTargetSecurityGroupsRequest.builder()

Parameters:

modifyMountTargetSecurityGroupsRequest - A Consumer that will call methods on ModifyMountTargetSecurityGroupsRequest.Builder to create a request.

Returns:

Result of the ModifyMountTargetSecurityGroups operation returned by the service.

See Also:

• AWS API Documentation

putAccountPreferences

default PutAccountPreferencesResponse putAccountPreferences(PutAccountPreferencesRequest putAccountPreferencesRequest)
                                                     throws BadRequestException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
EfsException

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.

Parameters:

putAccountPreferencesRequest -

Returns:

Result of the PutAccountPreferences operation returned by the service.

See Also:

• AWS API Documentation

putAccountPreferences

default PutAccountPreferencesResponse putAccountPreferences(Consumer<PutAccountPreferencesRequest.Builder> putAccountPreferencesRequest)
                                                     throws BadRequestException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
EfsException

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.

This is a convenience which creates an instance of the PutAccountPreferencesRequest.Builder avoiding the need to create one manually via PutAccountPreferencesRequest.builder()

Parameters:

putAccountPreferencesRequest - A Consumer that will call methods on PutAccountPreferencesRequest.Builder to create a request.

Returns:

Result of the PutAccountPreferences operation returned by the service.

See Also:

• AWS API Documentation

putBackupPolicy

default PutBackupPolicyResponse putBackupPolicy(PutBackupPolicyRequest putBackupPolicyRequest)
                                         throws BadRequestException,
FileSystemNotFoundException,
IncorrectFileSystemLifeCycleStateException,
InternalServerErrorException,
ValidationException,
AwsServiceException,
SdkClientException,
EfsException

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

Parameters:

putBackupPolicyRequest -

Returns:

Result of the PutBackupPolicy operation returned by the service.

See Also:

• AWS API Documentation

putBackupPolicy

default PutBackupPolicyResponse putBackupPolicy(Consumer<PutBackupPolicyRequest.Builder> putBackupPolicyRequest)
                                         throws BadRequestException,
FileSystemNotFoundException,
IncorrectFileSystemLifeCycleStateException,
InternalServerErrorException,
ValidationException,
AwsServiceException,
SdkClientException,
EfsException

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

This is a convenience which creates an instance of the PutBackupPolicyRequest.Builder avoiding the need to create one manually via PutBackupPolicyRequest.builder()

Parameters:

putBackupPolicyRequest - A Consumer that will call methods on PutBackupPolicyRequest.Builder to create a request.

Returns:

Result of the PutBackupPolicy operation returned by the service.

See Also:

• AWS API Documentation

putFileSystemPolicy

default PutFileSystemPolicyResponse putFileSystemPolicy(PutFileSystemPolicyRequest putFileSystemPolicyRequest)
                                                 throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
InvalidPolicyException,
IncorrectFileSystemLifeCycleStateException,
AwsServiceException,
SdkClientException,
EfsException

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.

Parameters:

putFileSystemPolicyRequest -

Returns:

Result of the PutFileSystemPolicy operation returned by the service.

See Also:

• AWS API Documentation

putFileSystemPolicy

default PutFileSystemPolicyResponse putFileSystemPolicy(Consumer<PutFileSystemPolicyRequest.Builder> putFileSystemPolicyRequest)
                                                 throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
InvalidPolicyException,
IncorrectFileSystemLifeCycleStateException,
AwsServiceException,
SdkClientException,
EfsException

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.

This is a convenience which creates an instance of the PutFileSystemPolicyRequest.Builder avoiding the need to create one manually via PutFileSystemPolicyRequest.builder()

Parameters:

putFileSystemPolicyRequest - A Consumer that will call methods on PutFileSystemPolicyRequest.Builder to create a request.

Returns:

Result of the PutFileSystemPolicy operation returned by the service.

See Also:

• AWS API Documentation

putLifecycleConfiguration

default PutLifecycleConfigurationResponse putLifecycleConfiguration(PutLifecycleConfigurationRequest putLifecycleConfigurationRequest)
                                                             throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
IncorrectFileSystemLifeCycleStateException,
AwsServiceException,
SdkClientException,
EfsException

Use this action to manage storage for your file system. A LifecycleConfiguration consists of one or more LifecyclePolicy objects that define the following:

• TransitionToIA – When to move files in the file system from primary storage (Standard storage class) into the Infrequent Access (IA) storage.

• TransitionToArchive – When to move files in the file system from their current storage class (either IA or Standard storage) into the Archive storage.

  File systems cannot transition into Archive storage before transitioning into IA storage. Therefore, TransitionToArchive must either not be set or must be later than TransitionToIA.

  The Archive storage class is available only for file systems that use the Elastic Throughput mode and the General Purpose Performance mode.

• TransitionToPrimaryStorageClass – Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA or Archive storage.

For more information, see Managing file system storage.

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. In the request, specify the following:

• The ID for the file system for which you are enabling, disabling, or modifying Lifecycle management.

• A LifecyclePolicies array of LifecyclePolicy objects that define when to move files to IA storage, to Archive storage, and back to primary 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.

Parameters:

putLifecycleConfigurationRequest -

Returns:

Result of the PutLifecycleConfiguration operation returned by the service.

See Also:

• AWS API Documentation

putLifecycleConfiguration

default PutLifecycleConfigurationResponse putLifecycleConfiguration(Consumer<PutLifecycleConfigurationRequest.Builder> putLifecycleConfigurationRequest)
                                                             throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
IncorrectFileSystemLifeCycleStateException,
AwsServiceException,
SdkClientException,
EfsException

Use this action to manage storage for your file system. A LifecycleConfiguration consists of one or more LifecyclePolicy objects that define the following:

• TransitionToIA – When to move files in the file system from primary storage (Standard storage class) into the Infrequent Access (IA) storage.

• TransitionToArchive – When to move files in the file system from their current storage class (either IA or Standard storage) into the Archive storage.

  File systems cannot transition into Archive storage before transitioning into IA storage. Therefore, TransitionToArchive must either not be set or must be later than TransitionToIA.

  The Archive storage class is available only for file systems that use the Elastic Throughput mode and the General Purpose Performance mode.

• TransitionToPrimaryStorageClass – Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA or Archive storage.

For more information, see Managing file system storage.

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. In the request, specify the following:

• The ID for the file system for which you are enabling, disabling, or modifying Lifecycle management.

• A LifecyclePolicies array of LifecyclePolicy objects that define when to move files to IA storage, to Archive storage, and back to primary 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.

This is a convenience which creates an instance of the PutLifecycleConfigurationRequest.Builder avoiding the need to create one manually via PutLifecycleConfigurationRequest.builder()

Parameters:

putLifecycleConfigurationRequest - A Consumer that will call methods on PutLifecycleConfigurationRequest.Builder to create a request.

Returns:

Result of the PutLifecycleConfiguration operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
AccessPointNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

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.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
AccessPointNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

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.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
AccessPointNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

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.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws BadRequestException,
InternalServerErrorException,
FileSystemNotFoundException,
AccessPointNotFoundException,
AwsServiceException,
SdkClientException,
EfsException

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.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateFileSystem

default UpdateFileSystemResponse updateFileSystem(UpdateFileSystemRequest updateFileSystemRequest)
                                           throws BadRequestException,
FileSystemNotFoundException,
IncorrectFileSystemLifeCycleStateException,
InsufficientThroughputCapacityException,
InternalServerErrorException,
ThroughputLimitExceededException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
EfsException

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

Parameters:

updateFileSystemRequest -

Returns:

Result of the UpdateFileSystem operation returned by the service.

See Also:

• AWS API Documentation

updateFileSystem

default UpdateFileSystemResponse updateFileSystem(Consumer<UpdateFileSystemRequest.Builder> updateFileSystemRequest)
                                           throws BadRequestException,
FileSystemNotFoundException,
IncorrectFileSystemLifeCycleStateException,
InsufficientThroughputCapacityException,
InternalServerErrorException,
ThroughputLimitExceededException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
EfsException

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

This is a convenience which creates an instance of the UpdateFileSystemRequest.Builder avoiding the need to create one manually via UpdateFileSystemRequest.builder()

Parameters:

updateFileSystemRequest - A Consumer that will call methods on UpdateFileSystemRequest.Builder to create a request.

Returns:

Result of the UpdateFileSystem operation returned by the service.

See Also:

• AWS API Documentation

updateFileSystemProtection

default UpdateFileSystemProtectionResponse updateFileSystemProtection(UpdateFileSystemProtectionRequest updateFileSystemProtectionRequest)
                                                               throws BadRequestException,
FileSystemNotFoundException,
IncorrectFileSystemLifeCycleStateException,
InsufficientThroughputCapacityException,
InternalServerErrorException,
ThroughputLimitExceededException,
ReplicationAlreadyExistsException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
EfsException

Updates protection on the file system.

This operation requires permissions for the elasticfilesystem:UpdateFileSystemProtection action.

Parameters:

updateFileSystemProtectionRequest -

Returns:

Result of the UpdateFileSystemProtection operation returned by the service.

See Also:

• AWS API Documentation

updateFileSystemProtection

default UpdateFileSystemProtectionResponse updateFileSystemProtection(Consumer<UpdateFileSystemProtectionRequest.Builder> updateFileSystemProtectionRequest)
                                                               throws BadRequestException,
FileSystemNotFoundException,
IncorrectFileSystemLifeCycleStateException,
InsufficientThroughputCapacityException,
InternalServerErrorException,
ThroughputLimitExceededException,
ReplicationAlreadyExistsException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
EfsException

Updates protection on the file system.

This operation requires permissions for the elasticfilesystem:UpdateFileSystemProtection action.

This is a convenience which creates an instance of the UpdateFileSystemProtectionRequest.Builder avoiding the need to create one manually via UpdateFileSystemProtectionRequest.builder()

Parameters:

updateFileSystemProtectionRequest - A Consumer that will call methods on UpdateFileSystemProtectionRequest.Builder to create a request.

Returns:

Result of the UpdateFileSystemProtection operation returned by the service.

See Also:

• AWS API Documentation

create

static EfsClient create()

Create a EfsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static EfsClientBuilder builder()

Create a builder that can be used to configure and create a EfsClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default EfsServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration