@Generated(value="software.amazon.awssdk:codegen") public interface EfsAsyncClient extends SdkClient
builder()
method.
Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use with Amazon EC2 instances in the AWS Cloud. With Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you add and remove files, so your applications have the storage they need, when they need it. For more information, see the User Guide.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider . |
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static EfsAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
EfsAsyncClient . |
static EfsAsyncClient |
create()
Create a
EfsAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<CreateAccessPointResponse> |
createAccessPoint(Consumer<CreateAccessPointRequest.Builder> createAccessPointRequest)
Creates an EFS access point.
|
default CompletableFuture<CreateAccessPointResponse> |
createAccessPoint(CreateAccessPointRequest createAccessPointRequest)
Creates an EFS access point.
|
default CompletableFuture<CreateFileSystemResponse> |
createFileSystem(Consumer<CreateFileSystemRequest.Builder> createFileSystemRequest)
Creates a new, empty file system.
|
default CompletableFuture<CreateFileSystemResponse> |
createFileSystem(CreateFileSystemRequest createFileSystemRequest)
Creates a new, empty file system.
|
default CompletableFuture<CreateMountTargetResponse> |
createMountTarget(Consumer<CreateMountTargetRequest.Builder> createMountTargetRequest)
Creates a mount target for a file system.
|
default CompletableFuture<CreateMountTargetResponse> |
createMountTarget(CreateMountTargetRequest createMountTargetRequest)
Creates a mount target for a file system.
|
default CompletableFuture<CreateTagsResponse> |
createTags(Consumer<CreateTagsRequest.Builder> createTagsRequest)
Creates or overwrites tags associated with a file system.
|
default CompletableFuture<CreateTagsResponse> |
createTags(CreateTagsRequest createTagsRequest)
Creates or overwrites tags associated with a file system.
|
default CompletableFuture<DeleteAccessPointResponse> |
deleteAccessPoint(Consumer<DeleteAccessPointRequest.Builder> deleteAccessPointRequest)
Deletes the specified access point.
|
default CompletableFuture<DeleteAccessPointResponse> |
deleteAccessPoint(DeleteAccessPointRequest deleteAccessPointRequest)
Deletes the specified access point.
|
default CompletableFuture<DeleteFileSystemResponse> |
deleteFileSystem(Consumer<DeleteFileSystemRequest.Builder> deleteFileSystemRequest)
Deletes a file system, permanently severing access to its contents.
|
default CompletableFuture<DeleteFileSystemResponse> |
deleteFileSystem(DeleteFileSystemRequest deleteFileSystemRequest)
Deletes a file system, permanently severing access to its contents.
|
default CompletableFuture<DeleteFileSystemPolicyResponse> |
deleteFileSystemPolicy(Consumer<DeleteFileSystemPolicyRequest.Builder> deleteFileSystemPolicyRequest)
Deletes the
FileSystemPolicy for the specified file system. |
default CompletableFuture<DeleteFileSystemPolicyResponse> |
deleteFileSystemPolicy(DeleteFileSystemPolicyRequest deleteFileSystemPolicyRequest)
Deletes the
FileSystemPolicy for the specified file system. |
default CompletableFuture<DeleteMountTargetResponse> |
deleteMountTarget(Consumer<DeleteMountTargetRequest.Builder> deleteMountTargetRequest)
Deletes the specified mount target.
|
default CompletableFuture<DeleteMountTargetResponse> |
deleteMountTarget(DeleteMountTargetRequest deleteMountTargetRequest)
Deletes the specified mount target.
|
default CompletableFuture<DeleteTagsResponse> |
deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest)
Deletes the specified tags from a file system.
|
default CompletableFuture<DeleteTagsResponse> |
deleteTags(DeleteTagsRequest deleteTagsRequest)
Deletes the specified tags from a file system.
|
default CompletableFuture<DescribeAccessPointsResponse> |
describeAccessPoints(Consumer<DescribeAccessPointsRequest.Builder> describeAccessPointsRequest)
Returns the description of a specific Amazon EFS access point if the
AccessPointId is provided. |
default CompletableFuture<DescribeAccessPointsResponse> |
describeAccessPoints(DescribeAccessPointsRequest describeAccessPointsRequest)
Returns the description of a specific Amazon EFS access point if the
AccessPointId is provided. |
default DescribeAccessPointsPublisher |
describeAccessPointsPaginator(Consumer<DescribeAccessPointsRequest.Builder> describeAccessPointsRequest)
Returns the description of a specific Amazon EFS access point if the
AccessPointId is provided. |
default DescribeAccessPointsPublisher |
describeAccessPointsPaginator(DescribeAccessPointsRequest describeAccessPointsRequest)
Returns the description of a specific Amazon EFS access point if the
AccessPointId is provided. |
default CompletableFuture<DescribeBackupPolicyResponse> |
describeBackupPolicy(Consumer<DescribeBackupPolicyRequest.Builder> describeBackupPolicyRequest)
Returns the backup policy for the specified EFS file system.
|
default CompletableFuture<DescribeBackupPolicyResponse> |
describeBackupPolicy(DescribeBackupPolicyRequest describeBackupPolicyRequest)
Returns the backup policy for the specified EFS file system.
|
default CompletableFuture<DescribeFileSystemPolicyResponse> |
describeFileSystemPolicy(Consumer<DescribeFileSystemPolicyRequest.Builder> describeFileSystemPolicyRequest)
Returns the
FileSystemPolicy for the specified EFS file system. |
default CompletableFuture<DescribeFileSystemPolicyResponse> |
describeFileSystemPolicy(DescribeFileSystemPolicyRequest describeFileSystemPolicyRequest)
Returns the
FileSystemPolicy for the specified EFS file system. |
default CompletableFuture<DescribeFileSystemsResponse> |
describeFileSystems()
Returns the description of a specific Amazon EFS file system if either the file system
CreationToken
or the FileSystemId is provided. |
default CompletableFuture<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 CompletableFuture<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 DescribeFileSystemsPublisher |
describeFileSystemsPaginator()
Returns the description of a specific Amazon EFS file system if either the file system
CreationToken
or the FileSystemId is provided. |
default DescribeFileSystemsPublisher |
describeFileSystemsPaginator(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 DescribeFileSystemsPublisher |
describeFileSystemsPaginator(DescribeFileSystemsRequest describeFileSystemsRequest)
Returns the description of a specific Amazon EFS file system if either the file system
CreationToken
or the FileSystemId is provided. |
default CompletableFuture<DescribeLifecycleConfigurationResponse> |
describeLifecycleConfiguration(Consumer<DescribeLifecycleConfigurationRequest.Builder> describeLifecycleConfigurationRequest)
Returns the current
LifecycleConfiguration object for the specified Amazon EFS file system. |
default CompletableFuture<DescribeLifecycleConfigurationResponse> |
describeLifecycleConfiguration(DescribeLifecycleConfigurationRequest describeLifecycleConfigurationRequest)
Returns the current
LifecycleConfiguration object for the specified Amazon EFS file system. |
default CompletableFuture<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 CompletableFuture<DescribeMountTargetsResponse> |
describeMountTargets(DescribeMountTargetsRequest describeMountTargetsRequest)
Returns the descriptions of all the current mount targets, or a specific mount target, for a file system.
|
default CompletableFuture<DescribeMountTargetSecurityGroupsResponse> |
describeMountTargetSecurityGroups(Consumer<DescribeMountTargetSecurityGroupsRequest.Builder> describeMountTargetSecurityGroupsRequest)
Returns the security groups currently in effect for a mount target.
|
default CompletableFuture<DescribeMountTargetSecurityGroupsResponse> |
describeMountTargetSecurityGroups(DescribeMountTargetSecurityGroupsRequest describeMountTargetSecurityGroupsRequest)
Returns the security groups currently in effect for a mount target.
|
default CompletableFuture<DescribeTagsResponse> |
describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)
Returns the tags associated with a file system.
|
default CompletableFuture<DescribeTagsResponse> |
describeTags(DescribeTagsRequest describeTagsRequest)
Returns the tags associated with a file system.
|
default DescribeTagsPublisher |
describeTagsPaginator(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)
Returns the tags associated with a file system.
|
default DescribeTagsPublisher |
describeTagsPaginator(DescribeTagsRequest describeTagsRequest)
Returns the tags associated with a file system.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all tags for a top-level EFS resource.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags for a top-level EFS resource.
|
default ListTagsForResourcePublisher |
listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all tags for a top-level EFS resource.
|
default ListTagsForResourcePublisher |
listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags for a top-level EFS resource.
|
default CompletableFuture<ModifyMountTargetSecurityGroupsResponse> |
modifyMountTargetSecurityGroups(Consumer<ModifyMountTargetSecurityGroupsRequest.Builder> modifyMountTargetSecurityGroupsRequest)
Modifies the set of security groups in effect for a mount target.
|
default CompletableFuture<ModifyMountTargetSecurityGroupsResponse> |
modifyMountTargetSecurityGroups(ModifyMountTargetSecurityGroupsRequest modifyMountTargetSecurityGroupsRequest)
Modifies the set of security groups in effect for a mount target.
|
default CompletableFuture<PutBackupPolicyResponse> |
putBackupPolicy(Consumer<PutBackupPolicyRequest.Builder> putBackupPolicyRequest)
Updates the file system's backup policy.
|
default CompletableFuture<PutBackupPolicyResponse> |
putBackupPolicy(PutBackupPolicyRequest putBackupPolicyRequest)
Updates the file system's backup policy.
|
default CompletableFuture<PutFileSystemPolicyResponse> |
putFileSystemPolicy(Consumer<PutFileSystemPolicyRequest.Builder> putFileSystemPolicyRequest)
Applies an Amazon EFS
FileSystemPolicy to an Amazon EFS file system. |
default CompletableFuture<PutFileSystemPolicyResponse> |
putFileSystemPolicy(PutFileSystemPolicyRequest putFileSystemPolicyRequest)
Applies an Amazon EFS
FileSystemPolicy to an Amazon EFS file system. |
default CompletableFuture<PutLifecycleConfigurationResponse> |
putLifecycleConfiguration(Consumer<PutLifecycleConfigurationRequest.Builder> putLifecycleConfigurationRequest)
Enables lifecycle management by creating a new
LifecycleConfiguration object. |
default CompletableFuture<PutLifecycleConfigurationResponse> |
putLifecycleConfiguration(PutLifecycleConfigurationRequest putLifecycleConfigurationRequest)
Enables lifecycle management by creating a new
LifecycleConfiguration object. |
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Creates a tag for an EFS resource.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Creates a tag for an EFS resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from an EFS resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from an EFS resource.
|
default CompletableFuture<UpdateFileSystemResponse> |
updateFileSystem(Consumer<UpdateFileSystemRequest.Builder> updateFileSystemRequest)
Updates the throughput mode or the amount of provisioned throughput of an existing file system.
|
default CompletableFuture<UpdateFileSystemResponse> |
updateFileSystem(UpdateFileSystemRequest updateFileSystemRequest)
Updates the throughput mode or the amount of provisioned throughput of an existing file system.
|
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.static EfsAsyncClient create()
EfsAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static EfsAsyncClientBuilder builder()
EfsAsyncClient
.default CompletableFuture<CreateAccessPointResponse> createAccessPoint(CreateAccessPointRequest createAccessPointRequest)
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 its own directory and below. To learn more, see Mounting a file system using EFS access points.
This operation requires permissions for the elasticfilesystem:CreateAccessPoint
action.
createAccessPointRequest
- FileSystemId
value doesn't exist
in the requester's AWS account.default CompletableFuture<CreateAccessPointResponse> createAccessPoint(Consumer<CreateAccessPointRequest.Builder> createAccessPointRequest)
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 its own directory and below. To learn more, see Mounting a file system using EFS access points.
This operation requires permissions for the elasticfilesystem:CreateAccessPoint
action.
This is a convenience which creates an instance of the CreateAccessPointRequest.Builder
avoiding the need
to create one manually via CreateAccessPointRequest.builder()
createAccessPointRequest
- A Consumer
that will call methods on CreateAccessPointRequest.Builder
to create a request.FileSystemId
value doesn't exist
in the requester's AWS account.default CompletableFuture<CreateFileSystemResponse> createFileSystem(CreateFileSystemRequest createFileSystemRequest)
Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's AWS account with the specified creation token, this operation does the following:
Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle
state creating
.
Returns with the description of the created file system.
Otherwise, this operation returns a FileSystemAlreadyExists
error with the ID of the existing file
system.
For basic use cases, you can use a randomly generated UUID for the creation token.
The idempotent operation allows you to retry a CreateFileSystem
call without risk of creating an
extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a
file system was actually created. An example might be that a transport level timeout occurred or your connection
was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file
system, the client can learn of its existence from the FileSystemAlreadyExists
error.
For more information, see Creating a file system in the Amazon EFS User Guide.
The CreateFileSystem
call returns while the file system's lifecycle state is still
creating
. You can check the file system creation status by calling the DescribeFileSystems
operation, which among other things returns the file system state.
This operation accepts an optional PerformanceMode
parameter that you choose for your file system.
We recommend generalPurpose
performance mode for most file systems. File systems using the
maxIO
performance mode can scale to higher levels of aggregate throughput and operations per second
with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed
after the file system has been created. For more information, see Amazon EFS performance
modes.
You can set the throughput mode for the file system using the ThroughputMode
parameter.
After the file system is fully created, Amazon EFS sets its lifecycle state to available
, at which
point you can create one or more mount targets for the file system in your VPC. For more information, see
CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in your VPC by using the
mount target. For more information, see Amazon EFS: How it Works.
This operation requires permissions for the elasticfilesystem:CreateFileSystem
action.
createFileSystemRequest
- default CompletableFuture<CreateFileSystemResponse> createFileSystem(Consumer<CreateFileSystemRequest.Builder> createFileSystemRequest)
Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's AWS account with the specified creation token, this operation does the following:
Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle
state creating
.
Returns with the description of the created file system.
Otherwise, this operation returns a FileSystemAlreadyExists
error with the ID of the existing file
system.
For basic use cases, you can use a randomly generated UUID for the creation token.
The idempotent operation allows you to retry a CreateFileSystem
call without risk of creating an
extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a
file system was actually created. An example might be that a transport level timeout occurred or your connection
was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file
system, the client can learn of its existence from the FileSystemAlreadyExists
error.
For more information, see Creating a file system in the Amazon EFS User Guide.
The CreateFileSystem
call returns while the file system's lifecycle state is still
creating
. You can check the file system creation status by calling the DescribeFileSystems
operation, which among other things returns the file system state.
This operation accepts an optional PerformanceMode
parameter that you choose for your file system.
We recommend generalPurpose
performance mode for most file systems. File systems using the
maxIO
performance mode can scale to higher levels of aggregate throughput and operations per second
with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed
after the file system has been created. For more information, see Amazon EFS performance
modes.
You can set the throughput mode for the file system using the ThroughputMode
parameter.
After the file system is fully created, Amazon EFS sets its lifecycle state to available
, at which
point you can create one or more mount targets for the file system in your VPC. For more information, see
CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in your VPC by using the
mount target. For more information, see Amazon EFS: How it Works.
This operation requires permissions for the elasticfilesystem:CreateFileSystem
action.
This is a convenience which creates an instance of the CreateFileSystemRequest.Builder
avoiding the need
to create one manually via CreateFileSystemRequest.builder()
createFileSystemRequest
- A Consumer
that will call methods on CreateFileSystemRequest.Builder
to create a request.default CompletableFuture<CreateMountTargetResponse> createMountTarget(CreateMountTargetRequest createMountTargetRequest)
Creates a mount target for a file system. You can then mount the file system on EC2 instances by using the mount target.
You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system.
You can create only one mount target for an EFS file system using One Zone storage classes. You must create that
mount target in the same Availability Zone in which the file system is located. Use the
AvailabilityZoneName
and AvailabiltyZoneId
properties in the DescribeFileSystems
response object to get this information. Use the subnetId
associated with the file system's
Availability Zone when creating the mount target.
For more information, see Amazon EFS: How it Works.
To create a mount target for a file system, the file system's lifecycle state must be available
. For
more information, see DescribeFileSystems.
In the request, provide the following:
The file system ID for which you are creating the mount target.
A subnet ID, which determines the following:
The VPC in which Amazon EFS creates the mount target
The Availability Zone in which Amazon EFS creates the mount target
The IP address range from which Amazon EFS selects the IP address of the mount target (if you don't specify an IP address in the request)
After creating the mount target, Amazon EFS returns a response that includes, a MountTargetId
and an
IpAddress
. You use this IP address when mounting the file system in an EC2 instance. You can also
use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file
system by using the mount target can resolve the mount target's DNS name to its IP address. For more information,
see How it
Works: Implementation Overview.
Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the subnet specified in the request to add another mount target must meet the following requirements:
Must belong to the same VPC as the subnets of the existing mount targets
Must not be in the same Availability Zone as any of the subnets of the existing mount targets
If the request satisfies the requirements, Amazon EFS does the following:
Creates a new mount target in the specified subnet.
Also creates a new network interface in the subnet as follows:
If the request provides an IpAddress
, Amazon EFS assigns that IP address to the network interface.
Otherwise, Amazon EFS assigns a free address in the subnet (in the same way that the Amazon EC2
CreateNetworkInterface
call does when a request does not specify a primary private IP address).
If the request provides SecurityGroups
, this network interface is associated with those security
groups. Otherwise, it belongs to the default security group for the subnet's VPC.
Assigns the description Mount target fsmt-id for file system fs-id
where
fsmt-id
is the mount target ID, and fs-id
is the
FileSystemId
.
Sets the requesterManaged
property of the network interface to true
, and the
requesterId
value to EFS
.
Each Amazon EFS mount target has one corresponding requester-managed EC2 network interface. After the network
interface is created, Amazon EFS sets the NetworkInterfaceId
field in the mount target's description
to the network interface ID, and the IpAddress
field to its address. If network interface creation
fails, the entire CreateMountTarget
operation fails.
The CreateMountTarget
call returns only after creating the network interface, but while the mount
target state is still creating
, you can check the mount target creation status by calling the
DescribeMountTargets operation, which among other things returns the mount target state.
We recommend that you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, see Amazon EFS. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario. If the Availability Zone in which your mount target is created goes down, then you can't access your file system through that mount target.
This operation requires permissions for the following action on the file system:
elasticfilesystem:CreateMountTarget
This operation also requires permissions for the following Amazon EC2 actions:
ec2:DescribeSubnets
ec2:DescribeNetworkInterfaces
ec2:CreateNetworkInterface
createMountTargetRequest
- FileSystemId
value doesn't exist
in the requester's AWS account.SubnetId
provided in the
request.IpAddress
was not specified in the request
and there are no free IP addresses in the subnet.IpAddress
that is already
in use in the subnet.SecurityGroups
specified in
the request is greater than five.default CompletableFuture<CreateMountTargetResponse> createMountTarget(Consumer<CreateMountTargetRequest.Builder> createMountTargetRequest)
Creates a mount target for a file system. You can then mount the file system on EC2 instances by using the mount target.
You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system.
You can create only one mount target for an EFS file system using One Zone storage classes. You must create that
mount target in the same Availability Zone in which the file system is located. Use the
AvailabilityZoneName
and AvailabiltyZoneId
properties in the DescribeFileSystems
response object to get this information. Use the subnetId
associated with the file system's
Availability Zone when creating the mount target.
For more information, see Amazon EFS: How it Works.
To create a mount target for a file system, the file system's lifecycle state must be available
. For
more information, see DescribeFileSystems.
In the request, provide the following:
The file system ID for which you are creating the mount target.
A subnet ID, which determines the following:
The VPC in which Amazon EFS creates the mount target
The Availability Zone in which Amazon EFS creates the mount target
The IP address range from which Amazon EFS selects the IP address of the mount target (if you don't specify an IP address in the request)
After creating the mount target, Amazon EFS returns a response that includes, a MountTargetId
and an
IpAddress
. You use this IP address when mounting the file system in an EC2 instance. You can also
use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file
system by using the mount target can resolve the mount target's DNS name to its IP address. For more information,
see How it
Works: Implementation Overview.
Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the subnet specified in the request to add another mount target must meet the following requirements:
Must belong to the same VPC as the subnets of the existing mount targets
Must not be in the same Availability Zone as any of the subnets of the existing mount targets
If the request satisfies the requirements, Amazon EFS does the following:
Creates a new mount target in the specified subnet.
Also creates a new network interface in the subnet as follows:
If the request provides an IpAddress
, Amazon EFS assigns that IP address to the network interface.
Otherwise, Amazon EFS assigns a free address in the subnet (in the same way that the Amazon EC2
CreateNetworkInterface
call does when a request does not specify a primary private IP address).
If the request provides SecurityGroups
, this network interface is associated with those security
groups. Otherwise, it belongs to the default security group for the subnet's VPC.
Assigns the description Mount target fsmt-id for file system fs-id
where
fsmt-id
is the mount target ID, and fs-id
is the
FileSystemId
.
Sets the requesterManaged
property of the network interface to true
, and the
requesterId
value to EFS
.
Each Amazon EFS mount target has one corresponding requester-managed EC2 network interface. After the network
interface is created, Amazon EFS sets the NetworkInterfaceId
field in the mount target's description
to the network interface ID, and the IpAddress
field to its address. If network interface creation
fails, the entire CreateMountTarget
operation fails.
The CreateMountTarget
call returns only after creating the network interface, but while the mount
target state is still creating
, you can check the mount target creation status by calling the
DescribeMountTargets operation, which among other things returns the mount target state.
We recommend that you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, see Amazon EFS. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario. If the Availability Zone in which your mount target is created goes down, then you can't access your file system through that mount target.
This operation requires permissions for the following action on the file system:
elasticfilesystem:CreateMountTarget
This operation also requires permissions for the following Amazon EC2 actions:
ec2:DescribeSubnets
ec2:DescribeNetworkInterfaces
ec2:CreateNetworkInterface
This is a convenience which creates an instance of the CreateMountTargetRequest.Builder
avoiding the need
to create one manually via CreateMountTargetRequest.builder()
createMountTargetRequest
- A Consumer
that will call methods on CreateMountTargetRequest.Builder
to create a request.FileSystemId
value doesn't exist
in the requester's AWS account.SubnetId
provided in the
request.IpAddress
was not specified in the request
and there are no free IP addresses in the subnet.IpAddress
that is already
in use in the subnet.SecurityGroups
specified in
the request is greater than five.default CompletableFuture<CreateTagsResponse> createTags(CreateTagsRequest createTagsRequest)
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.
createTagsRequest
- FileSystemId
value doesn't exist
in the requester's AWS account.default CompletableFuture<CreateTagsResponse> createTags(Consumer<CreateTagsRequest.Builder> createTagsRequest)
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()
createTagsRequest
- A Consumer
that will call methods on CreateTagsRequest.Builder
to create a request.FileSystemId
value doesn't exist
in the requester's AWS account.default CompletableFuture<DeleteAccessPointResponse> deleteAccessPoint(DeleteAccessPointRequest deleteAccessPointRequest)
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.
deleteAccessPointRequest
- AccessPointId
value doesn't exist
in the requester's AWS account.default CompletableFuture<DeleteAccessPointResponse> deleteAccessPoint(Consumer<DeleteAccessPointRequest.Builder> deleteAccessPointRequest)
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()
deleteAccessPointRequest
- A Consumer
that will call methods on DeleteAccessPointRequest.Builder
to create a request.AccessPointId
value doesn't exist
in the requester's AWS account.default CompletableFuture<DeleteFileSystemResponse> deleteFileSystem(DeleteFileSystemRequest deleteFileSystemRequest)
Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you can't access any contents of the deleted file system.
You can't delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see DescribeMountTargets and DeleteMountTarget.
The DeleteFileSystem
call returns while the file system state is still deleting
. You
can check the file system deletion status by calling the DescribeFileSystems operation, which returns a
list of file systems in your account. If you pass file system ID or creation token for the deleted file system,
the DescribeFileSystems returns a 404 FileSystemNotFound
error.
This operation requires permissions for the elasticfilesystem:DeleteFileSystem
action.
deleteFileSystemRequest
- FileSystemId
value doesn't exist
in the requester's AWS account.default CompletableFuture<DeleteFileSystemResponse> deleteFileSystem(Consumer<DeleteFileSystemRequest.Builder> deleteFileSystemRequest)
Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you can't access any contents of the deleted file system.
You can't delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see DescribeMountTargets and DeleteMountTarget.
The DeleteFileSystem
call returns while the file system state is still deleting
. You
can check the file system deletion status by calling the DescribeFileSystems operation, which returns a
list of file systems in your account. If you pass file system ID or creation token for the deleted file system,
the DescribeFileSystems returns a 404 FileSystemNotFound
error.
This operation requires permissions for the elasticfilesystem:DeleteFileSystem
action.
This is a convenience which creates an instance of the DeleteFileSystemRequest.Builder
avoiding the need
to create one manually via DeleteFileSystemRequest.builder()
deleteFileSystemRequest
- A Consumer
that will call methods on DeleteFileSystemRequest.Builder
to create a request.FileSystemId
value doesn't exist
in the requester's AWS account.default CompletableFuture<DeleteFileSystemPolicyResponse> deleteFileSystemPolicy(DeleteFileSystemPolicyRequest deleteFileSystemPolicyRequest)
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.
deleteFileSystemPolicyRequest
- FileSystemId
value doesn't exist
in the requester's AWS account.default CompletableFuture<DeleteFileSystemPolicyResponse> deleteFileSystemPolicy(Consumer<DeleteFileSystemPolicyRequest.Builder> deleteFileSystemPolicyRequest)
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()
deleteFileSystemPolicyRequest
- A Consumer
that will call methods on DeleteFileSystemPolicyRequest.Builder
to create a
request.FileSystemId
value doesn't exist
in the requester's AWS account.default CompletableFuture<DeleteMountTargetResponse> deleteMountTarget(DeleteMountTargetRequest deleteMountTargetRequest)
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
deleteMountTargetRequest
- default CompletableFuture<DeleteMountTargetResponse> deleteMountTarget(Consumer<DeleteMountTargetRequest.Builder> deleteMountTargetRequest)
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()
deleteMountTargetRequest
- A Consumer
that will call methods on DeleteMountTargetRequest.Builder
to create a request.default CompletableFuture<DeleteTagsResponse> deleteTags(DeleteTagsRequest deleteTagsRequest)
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 AWS Billing and Cost Management User Guide.
This operation requires permissions for the elasticfilesystem:DeleteTags
action.
deleteTagsRequest
- FileSystemId
value doesn't exist
in the requester's AWS account.default CompletableFuture<DeleteTagsResponse> deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest)
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 AWS 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()
deleteTagsRequest
- A Consumer
that will call methods on DeleteTagsRequest.Builder
to create a request.FileSystemId
value doesn't exist
in the requester's AWS account.default CompletableFuture<DescribeAccessPointsResponse> describeAccessPoints(DescribeAccessPointsRequest describeAccessPointsRequest)
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.
describeAccessPointsRequest
- FileSystemId
value doesn't exist
in the requester's AWS account.AccessPointId
value doesn't exist
in the requester's AWS account.default CompletableFuture<DescribeAccessPointsResponse> describeAccessPoints(Consumer<DescribeAccessPointsRequest.Builder> describeAccessPointsRequest)
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()
describeAccessPointsRequest
- A Consumer
that will call methods on DescribeAccessPointsRequest.Builder
to create a
request.FileSystemId
value doesn't exist
in the requester's AWS account.AccessPointId
value doesn't exist
in the requester's AWS account.default DescribeAccessPointsPublisher describeAccessPointsPaginator(DescribeAccessPointsRequest describeAccessPointsRequest)
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 variant of
describeAccessPoints(software.amazon.awssdk.services.efs.model.DescribeAccessPointsRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.efs.paginators.DescribeAccessPointsPublisher publisher = client.describeAccessPointsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.efs.paginators.DescribeAccessPointsPublisher publisher = client.describeAccessPointsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.efs.model.DescribeAccessPointsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.efs.model.DescribeAccessPointsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
describeAccessPointsRequest
- FileSystemId
value doesn't exist
in the requester's AWS account.AccessPointId
value doesn't exist
in the requester's AWS account.default DescribeAccessPointsPublisher describeAccessPointsPaginator(Consumer<DescribeAccessPointsRequest.Builder> describeAccessPointsRequest)
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 variant of
describeAccessPoints(software.amazon.awssdk.services.efs.model.DescribeAccessPointsRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.efs.paginators.DescribeAccessPointsPublisher publisher = client.describeAccessPointsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.efs.paginators.DescribeAccessPointsPublisher publisher = client.describeAccessPointsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.efs.model.DescribeAccessPointsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.efs.model.DescribeAccessPointsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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()
describeAccessPointsRequest
- A Consumer
that will call methods on DescribeAccessPointsRequest.Builder
to create a
request.FileSystemId
value doesn't exist
in the requester's AWS account.AccessPointId
value doesn't exist
in the requester's AWS account.default CompletableFuture<DescribeBackupPolicyResponse> describeBackupPolicy(DescribeBackupPolicyRequest describeBackupPolicyRequest)
Returns the backup policy for the specified EFS file system.
describeBackupPolicyRequest
- FileSystemId
value doesn't exist
in the requester's AWS account.default CompletableFuture<DescribeBackupPolicyResponse> describeBackupPolicy(Consumer<DescribeBackupPolicyRequest.Builder> describeBackupPolicyRequest)
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()
describeBackupPolicyRequest
- A Consumer
that will call methods on DescribeBackupPolicyRequest.Builder
to create a
request.FileSystemId
value doesn't exist
in the requester's AWS account.default CompletableFuture<DescribeFileSystemPolicyResponse> describeFileSystemPolicy(DescribeFileSystemPolicyRequest describeFileSystemPolicyRequest)
Returns the FileSystemPolicy
for the specified EFS file system.
This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy
action.
describeFileSystemPolicyRequest
- FileSystemId
value doesn't exist
in the requester's AWS account.default CompletableFuture<DescribeFileSystemPolicyResponse> describeFileSystemPolicy(Consumer<DescribeFileSystemPolicyRequest.Builder> describeFileSystemPolicyRequest)
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()
describeFileSystemPolicyRequest
- A Consumer
that will call methods on DescribeFileSystemPolicyRequest.Builder
to create a
request.FileSystemId
value doesn't exist
in the requester's AWS account.default CompletableFuture<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. Otherwise, it returns descriptions of all file systems owned by the
caller's AWS account in the AWS Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the MaxItems
parameter to
limit the number of descriptions in a response. Currently, this number is automatically set to 10. 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.
describeFileSystemsRequest
- FileSystemId
value doesn't exist
in the requester's AWS account.default CompletableFuture<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. Otherwise, it returns descriptions of all file systems owned by the
caller's AWS account in the AWS Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the MaxItems
parameter to
limit the number of descriptions in a response. Currently, this number is automatically set to 10. 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()
describeFileSystemsRequest
- A Consumer
that will call methods on DescribeFileSystemsRequest.Builder
to create a
request.FileSystemId
value doesn't exist
in the requester's AWS account.default CompletableFuture<DescribeFileSystemsResponse> describeFileSystems()
Returns the description of a specific Amazon EFS file system if either the file system CreationToken
or the FileSystemId
is provided. Otherwise, it returns descriptions of all file systems owned by the
caller's AWS account in the AWS Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the MaxItems
parameter to
limit the number of descriptions in a response. Currently, this number is automatically set to 10. 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.
FileSystemId
value doesn't exist
in the requester's AWS account.default DescribeFileSystemsPublisher describeFileSystemsPaginator()
Returns the description of a specific Amazon EFS file system if either the file system CreationToken
or the FileSystemId
is provided. Otherwise, it returns descriptions of all file systems owned by the
caller's AWS account in the AWS Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the MaxItems
parameter to
limit the number of descriptions in a response. Currently, this number is automatically set to 10. 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 variant of
describeFileSystems(software.amazon.awssdk.services.efs.model.DescribeFileSystemsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.efs.paginators.DescribeFileSystemsPublisher publisher = client.describeFileSystemsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.efs.paginators.DescribeFileSystemsPublisher publisher = client.describeFileSystemsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.efs.model.DescribeFileSystemsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.efs.model.DescribeFileSystemsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
FileSystemId
value doesn't exist
in the requester's AWS account.default DescribeFileSystemsPublisher describeFileSystemsPaginator(DescribeFileSystemsRequest describeFileSystemsRequest)
Returns the description of a specific Amazon EFS file system if either the file system CreationToken
or the FileSystemId
is provided. Otherwise, it returns descriptions of all file systems owned by the
caller's AWS account in the AWS Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the MaxItems
parameter to
limit the number of descriptions in a response. Currently, this number is automatically set to 10. 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 variant of
describeFileSystems(software.amazon.awssdk.services.efs.model.DescribeFileSystemsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.efs.paginators.DescribeFileSystemsPublisher publisher = client.describeFileSystemsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.efs.paginators.DescribeFileSystemsPublisher publisher = client.describeFileSystemsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.efs.model.DescribeFileSystemsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.efs.model.DescribeFileSystemsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
describeFileSystemsRequest
- FileSystemId
value doesn't exist
in the requester's AWS account.default DescribeFileSystemsPublisher describeFileSystemsPaginator(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. Otherwise, it returns descriptions of all file systems owned by the
caller's AWS account in the AWS Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the MaxItems
parameter to
limit the number of descriptions in a response. Currently, this number is automatically set to 10. 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 variant of
describeFileSystems(software.amazon.awssdk.services.efs.model.DescribeFileSystemsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.efs.paginators.DescribeFileSystemsPublisher publisher = client.describeFileSystemsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.efs.paginators.DescribeFileSystemsPublisher publisher = client.describeFileSystemsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.efs.model.DescribeFileSystemsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.efs.model.DescribeFileSystemsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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()
describeFileSystemsRequest
- A Consumer
that will call methods on DescribeFileSystemsRequest.Builder
to create a
request.FileSystemId
value doesn't exist
in the requester's AWS account.default CompletableFuture<DescribeLifecycleConfigurationResponse> describeLifecycleConfiguration(DescribeLifecycleConfigurationRequest describeLifecycleConfigurationRequest)
Returns the current LifecycleConfiguration
object for the specified Amazon EFS file system. EFS
lifecycle management uses the LifecycleConfiguration
object to identify which files to move to the
EFS Infrequent Access (IA) storage class. For a file system without a LifecycleConfiguration
object,
the call returns an empty array in the response.
This operation requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration
operation.
describeLifecycleConfigurationRequest
- FileSystemId
value doesn't exist
in the requester's AWS account.default CompletableFuture<DescribeLifecycleConfigurationResponse> describeLifecycleConfiguration(Consumer<DescribeLifecycleConfigurationRequest.Builder> describeLifecycleConfigurationRequest)
Returns the current LifecycleConfiguration
object for the specified Amazon EFS file system. EFS
lifecycle management uses the LifecycleConfiguration
object to identify which files to move to the
EFS Infrequent Access (IA) storage class. For a file system without a LifecycleConfiguration
object,
the call returns an empty array in the response.
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()
describeLifecycleConfigurationRequest
- A Consumer
that will call methods on DescribeLifecycleConfigurationRequest.Builder
to
create a request.FileSystemId
value doesn't exist
in the requester's AWS account.default CompletableFuture<DescribeMountTargetSecurityGroupsResponse> describeMountTargetSecurityGroups(DescribeMountTargetSecurityGroupsRequest describeMountTargetSecurityGroupsRequest)
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.
describeMountTargetSecurityGroupsRequest
- default CompletableFuture<DescribeMountTargetSecurityGroupsResponse> describeMountTargetSecurityGroups(Consumer<DescribeMountTargetSecurityGroupsRequest.Builder> describeMountTargetSecurityGroupsRequest)
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()
describeMountTargetSecurityGroupsRequest
- A Consumer
that will call methods on DescribeMountTargetSecurityGroupsRequest.Builder
to
create a request.default CompletableFuture<DescribeMountTargetsResponse> describeMountTargets(DescribeMountTargetsRequest describeMountTargetsRequest)
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
.
describeMountTargetsRequest
- FileSystemId
value doesn't exist
in the requester's AWS account.AccessPointId
value doesn't exist
in the requester's AWS account.default CompletableFuture<DescribeMountTargetsResponse> describeMountTargets(Consumer<DescribeMountTargetsRequest.Builder> describeMountTargetsRequest)
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()
describeMountTargetsRequest
- A Consumer
that will call methods on DescribeMountTargetsRequest.Builder
to create a
request.FileSystemId
value doesn't exist
in the requester's AWS account.AccessPointId
value doesn't exist
in the requester's AWS account.default CompletableFuture<DescribeTagsResponse> describeTags(DescribeTagsRequest describeTagsRequest)
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.
describeTagsRequest
- FileSystemId
value doesn't exist
in the requester's AWS account.default CompletableFuture<DescribeTagsResponse> describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)
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()
describeTagsRequest
- A Consumer
that will call methods on DescribeTagsRequest.Builder
to create a request.FileSystemId
value doesn't exist
in the requester's AWS account.default DescribeTagsPublisher describeTagsPaginator(DescribeTagsRequest describeTagsRequest)
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 variant of describeTags(software.amazon.awssdk.services.efs.model.DescribeTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.efs.paginators.DescribeTagsPublisher publisher = client.describeTagsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.efs.paginators.DescribeTagsPublisher publisher = client.describeTagsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.efs.model.DescribeTagsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.efs.model.DescribeTagsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
describeTagsRequest
- FileSystemId
value doesn't exist
in the requester's AWS account.default DescribeTagsPublisher describeTagsPaginator(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)
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 variant of describeTags(software.amazon.awssdk.services.efs.model.DescribeTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.efs.paginators.DescribeTagsPublisher publisher = client.describeTagsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.efs.paginators.DescribeTagsPublisher publisher = client.describeTagsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.efs.model.DescribeTagsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.efs.model.DescribeTagsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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()
describeTagsRequest
- A Consumer
that will call methods on DescribeTagsRequest.Builder
to create a request.FileSystemId
value doesn't exist
in the requester's AWS account.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
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.
listTagsForResourceRequest
- FileSystemId
value doesn't exist
in the requester's AWS account.AccessPointId
value doesn't exist
in the requester's AWS account.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
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()
listTagsForResourceRequest
- A Consumer
that will call methods on ListTagsForResourceRequest.Builder
to create a
request.FileSystemId
value doesn't exist
in the requester's AWS account.AccessPointId
value doesn't exist
in the requester's AWS account.default ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
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 variant of
listTagsForResource(software.amazon.awssdk.services.efs.model.ListTagsForResourceRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.efs.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.efs.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.efs.model.ListTagsForResourceResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.efs.model.ListTagsForResourceResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listTagsForResourceRequest
- FileSystemId
value doesn't exist
in the requester's AWS account.AccessPointId
value doesn't exist
in the requester's AWS account.default ListTagsForResourcePublisher listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
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 variant of
listTagsForResource(software.amazon.awssdk.services.efs.model.ListTagsForResourceRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.efs.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.efs.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.efs.model.ListTagsForResourceResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.efs.model.ListTagsForResourceResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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()
listTagsForResourceRequest
- A Consumer
that will call methods on ListTagsForResourceRequest.Builder
to create a
request.FileSystemId
value doesn't exist
in the requester's AWS account.AccessPointId
value doesn't exist
in the requester's AWS account.default CompletableFuture<ModifyMountTargetSecurityGroupsResponse> modifyMountTargetSecurityGroups(ModifyMountTargetSecurityGroupsRequest modifyMountTargetSecurityGroupsRequest)
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.
modifyMountTargetSecurityGroupsRequest
- SecurityGroups
specified in
the request is greater than five.default CompletableFuture<ModifyMountTargetSecurityGroupsResponse> modifyMountTargetSecurityGroups(Consumer<ModifyMountTargetSecurityGroupsRequest.Builder> modifyMountTargetSecurityGroupsRequest)
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()
modifyMountTargetSecurityGroupsRequest
- A Consumer
that will call methods on ModifyMountTargetSecurityGroupsRequest.Builder
to
create a request.SecurityGroups
specified in
the request is greater than five.default CompletableFuture<PutBackupPolicyResponse> putBackupPolicy(PutBackupPolicyRequest putBackupPolicyRequest)
Updates the file system's backup policy. Use this action to start or stop automatic backups of the file system.
putBackupPolicyRequest
- FileSystemId
value doesn't exist
in the requester's AWS account.default CompletableFuture<PutBackupPolicyResponse> putBackupPolicy(Consumer<PutBackupPolicyRequest.Builder> putBackupPolicyRequest)
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()
putBackupPolicyRequest
- A Consumer
that will call methods on PutBackupPolicyRequest.Builder
to create a request.FileSystemId
value doesn't exist
in the requester's AWS account.default CompletableFuture<PutFileSystemPolicyResponse> putFileSystemPolicy(PutFileSystemPolicyRequest putFileSystemPolicyRequest)
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.
putFileSystemPolicyRequest
- FileSystemId
value doesn't exist
in the requester's AWS account.FileSystemPolicy
is is malformed or contains an
error such as an invalid parameter value or a missing required parameter. Returned in the case of a
policy lockout safety check error.default CompletableFuture<PutFileSystemPolicyResponse> putFileSystemPolicy(Consumer<PutFileSystemPolicyRequest.Builder> putFileSystemPolicyRequest)
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()
putFileSystemPolicyRequest
- A Consumer
that will call methods on PutFileSystemPolicyRequest.Builder
to create a
request.FileSystemId
value doesn't exist
in the requester's AWS account.FileSystemPolicy
is is malformed or contains an
error such as an invalid parameter value or a missing required parameter. Returned in the case of a
policy lockout safety check error.default CompletableFuture<PutLifecycleConfigurationResponse> putLifecycleConfiguration(PutLifecycleConfigurationRequest putLifecycleConfigurationRequest)
Enables lifecycle management by creating a new LifecycleConfiguration
object. A
LifecycleConfiguration
object defines when files in an Amazon EFS file system are automatically
transitioned to the lower-cost EFS Infrequent Access (IA) storage class. A LifecycleConfiguration
applies to all files in a file system.
Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system.
If a LifecycleConfiguration
object already exists for the specified file system, a
PutLifecycleConfiguration
call modifies the existing configuration. A
PutLifecycleConfiguration
call with an empty LifecyclePolicies
array in the request
body deletes any existing LifecycleConfiguration
and disables lifecycle management.
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 files are moved
to the IA storage class. The array can contain only one LifecyclePolicy
item.
This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration
operation.
To apply a LifecycleConfiguration
object to an encrypted file system, you need the same AWS Key
Management Service (AWS KMS) permissions as when you created the encrypted file system.
putLifecycleConfigurationRequest
- FileSystemId
value doesn't exist
in the requester's AWS account.default CompletableFuture<PutLifecycleConfigurationResponse> putLifecycleConfiguration(Consumer<PutLifecycleConfigurationRequest.Builder> putLifecycleConfigurationRequest)
Enables lifecycle management by creating a new LifecycleConfiguration
object. A
LifecycleConfiguration
object defines when files in an Amazon EFS file system are automatically
transitioned to the lower-cost EFS Infrequent Access (IA) storage class. A LifecycleConfiguration
applies to all files in a file system.
Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system.
If a LifecycleConfiguration
object already exists for the specified file system, a
PutLifecycleConfiguration
call modifies the existing configuration. A
PutLifecycleConfiguration
call with an empty LifecyclePolicies
array in the request
body deletes any existing LifecycleConfiguration
and disables lifecycle management.
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 files are moved
to the IA storage class. The array can contain only one LifecyclePolicy
item.
This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration
operation.
To apply a LifecycleConfiguration
object to an encrypted file system, you need the same AWS Key
Management Service (AWS KMS) 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()
putLifecycleConfigurationRequest
- A Consumer
that will call methods on PutLifecycleConfigurationRequest.Builder
to create a
request.FileSystemId
value doesn't exist
in the requester's AWS account.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
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.
tagResourceRequest
- FileSystemId
value doesn't exist
in the requester's AWS account.AccessPointId
value doesn't exist
in the requester's AWS account.default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
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()
tagResourceRequest
- A Consumer
that will call methods on TagResourceRequest.Builder
to create a request.FileSystemId
value doesn't exist
in the requester's AWS account.AccessPointId
value doesn't exist
in the requester's AWS account.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
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.
untagResourceRequest
- FileSystemId
value doesn't exist
in the requester's AWS account.AccessPointId
value doesn't exist
in the requester's AWS account.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
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()
untagResourceRequest
- A Consumer
that will call methods on UntagResourceRequest.Builder
to create a request.FileSystemId
value doesn't exist
in the requester's AWS account.AccessPointId
value doesn't exist
in the requester's AWS account.default CompletableFuture<UpdateFileSystemResponse> updateFileSystem(UpdateFileSystemRequest updateFileSystemRequest)
Updates the throughput mode or the amount of provisioned throughput of an existing file system.
updateFileSystemRequest
- FileSystemId
value doesn't exist
in the requester's AWS account.default CompletableFuture<UpdateFileSystemResponse> updateFileSystem(Consumer<UpdateFileSystemRequest.Builder> updateFileSystemRequest)
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()
updateFileSystemRequest
- A Consumer
that will call methods on UpdateFileSystemRequest.Builder
to create a request.FileSystemId
value doesn't exist
in the requester's AWS account.