C# Class Amazon.ElasticFileSystem.AmazonElasticFileSystemClient

Implementation for accessing ElasticFileSystem Amazon Elastic File System

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.

Inheritance: AmazonServiceClient, IAmazonElasticFileSystem
Mostra file Open project: aws/aws-sdk-net

Public Methods

Method Description
AmazonElasticFileSystemClient ( ) : System

Constructs AmazonElasticFileSystemClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

AmazonElasticFileSystemClient ( AWSCredentials credentials ) : System

Constructs AmazonElasticFileSystemClient with AWS Credentials

AmazonElasticFileSystemClient ( AWSCredentials credentials, AmazonElasticFileSystemConfig clientConfig ) : System

Constructs AmazonElasticFileSystemClient with AWS Credentials and an AmazonElasticFileSystemClient Configuration object.

AmazonElasticFileSystemClient ( AWSCredentials credentials, RegionEndpoint region ) : System

Constructs AmazonElasticFileSystemClient with AWS Credentials

AmazonElasticFileSystemClient ( AmazonElasticFileSystemConfig config ) : System

Constructs AmazonElasticFileSystemClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

AmazonElasticFileSystemClient ( RegionEndpoint region ) : System

Constructs AmazonElasticFileSystemClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

AmazonElasticFileSystemClient ( string awsAccessKeyId, string awsSecretAccessKey ) : System

Constructs AmazonElasticFileSystemClient with AWS Access Key ID and AWS Secret Key

AmazonElasticFileSystemClient ( string awsAccessKeyId, string awsSecretAccessKey, AmazonElasticFileSystemConfig clientConfig ) : System

Constructs AmazonElasticFileSystemClient with AWS Access Key ID, AWS Secret Key and an AmazonElasticFileSystemClient Configuration object.

AmazonElasticFileSystemClient ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System

Constructs AmazonElasticFileSystemClient with AWS Access Key ID and AWS Secret Key

AmazonElasticFileSystemClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken ) : System

Constructs AmazonElasticFileSystemClient with AWS Access Key ID and AWS Secret Key

AmazonElasticFileSystemClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonElasticFileSystemConfig clientConfig ) : System

Constructs AmazonElasticFileSystemClient with AWS Access Key ID, AWS Secret Key and an AmazonElasticFileSystemClient Configuration object.

AmazonElasticFileSystemClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region ) : System

Constructs AmazonElasticFileSystemClient with AWS Access Key ID and AWS Secret Key

BeginCreateFileSystem ( CreateFileSystemRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the CreateFileSystem operation.

BeginCreateMountTarget ( CreateMountTargetRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the CreateMountTarget operation.

BeginCreateTags ( CreateTagsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the CreateTags operation.

BeginDeleteFileSystem ( DeleteFileSystemRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DeleteFileSystem operation.

BeginDeleteMountTarget ( DeleteMountTargetRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DeleteMountTarget operation.

BeginDeleteTags ( DeleteTagsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DeleteTags operation.

BeginDescribeFileSystems ( DescribeFileSystemsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeFileSystems operation.

BeginDescribeMountTargetSecurityGroups ( DescribeMountTargetSecurityGroupsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeMountTargetSecurityGroups operation.

BeginDescribeMountTargets ( DescribeMountTargetsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeMountTargets operation.

BeginDescribeTags ( DescribeTagsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeTags operation.

BeginModifyMountTargetSecurityGroups ( ModifyMountTargetSecurityGroupsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the ModifyMountTargetSecurityGroups operation.

CreateFileSystem ( CreateFileSystemRequest request ) : CreateFileSystemResponse

Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's AWS account with the specified creation token, this operation does the following:

  • Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state creating.

  • Returns with the description of the created file system.

Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system.

For basic use cases, you can use a randomly generated UUID for the creation token.

The idempotent operation allows you to retry a CreateFileSystem call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists error.

The CreateFileSystem call returns while the file system's lifecycle state is still creating. You can check the file system creation status by calling the DescribeFileSystems operation, which among other things returns the file system state.

This operation also takes an optional PerformanceMode parameter that you choose for your file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput 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.

After the file system is fully created, Amazon EFS sets its lifecycle state to available, at which point you can create one or more mount targets for the file system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in your VPC via the mount target. For more information, see Amazon EFS: How it Works.

This operation requires permissions for the elasticfilesystem:CreateFileSystem action.

CreateFileSystem ( string creationToken ) : CreateFileSystemResponse

Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's AWS account with the specified creation token, this operation does the following:

  • Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state creating.

  • Returns with the description of the created file system.

Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system.

For basic use cases, you can use a randomly generated UUID for the creation token.

The idempotent operation allows you to retry a CreateFileSystem call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists error.

The CreateFileSystem call returns while the file system's lifecycle state is still creating. You can check the file system creation status by calling the DescribeFileSystems operation, which among other things returns the file system state.

This operation also takes an optional PerformanceMode parameter that you choose for your file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput 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.

After the file system is fully created, Amazon EFS sets its lifecycle state to available, at which point you can create one or more mount targets for the file system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in your VPC via the mount target. For more information, see Amazon EFS: How it Works.

This operation requires permissions for the elasticfilesystem:CreateFileSystem action.

CreateFileSystemAsync ( CreateFileSystemRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the CreateFileSystem operation.

CreateFileSystemAsync ( string creationToken, System cancellationToken = default(CancellationToken) ) : Task

Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's AWS account with the specified creation token, this operation does the following:

  • Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state creating.

  • Returns with the description of the created file system.

Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system.

For basic use cases, you can use a randomly generated UUID for the creation token.

The idempotent operation allows you to retry a CreateFileSystem call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists error.

The CreateFileSystem call returns while the file system's lifecycle state is still creating. You can check the file system creation status by calling the DescribeFileSystems operation, which among other things returns the file system state.

This operation also takes an optional PerformanceMode parameter that you choose for your file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput 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.

After the file system is fully created, Amazon EFS sets its lifecycle state to available, at which point you can create one or more mount targets for the file system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in your VPC via the mount target. For more information, see Amazon EFS: How it Works.

This operation requires permissions for the elasticfilesystem:CreateFileSystem action.

CreateMountTarget ( CreateMountTargetRequest request ) : CreateMountTargetResponse

Creates a mount target for a file system. You can then mount the file system on EC2 instances via the mount target.

You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system. For more information, see Amazon EFS: How it Works.

In the request, you also specify a file system ID for which you are creating the mount target and the file system's lifecycle state must be available. For more information, see DescribeFileSystems.

In the request, you also provide a subnet ID, which determines the following:

  • VPC in which Amazon EFS creates the mount target

  • Availability Zone in which Amazon EFS creates the mount target

  • IP address range from which Amazon EFS selects the IP address of the mount target (if you don't specify an IP address in the request)

After creating the mount target, Amazon EFS returns a response that includes, a MountTargetId and an IpAddress. You use this IP address when mounting the file system in an EC2 instance. You can also use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file system via the mount target can resolve the mount target's DNS name to its IP address. For more information, see How it Works: Implementation Overview.

Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the subnet specified in the request to add another mount target must meet the following requirements:

  • Must belong to the same VPC as the subnets of the existing mount targets

  • Must not be in the same Availability Zone as any of the subnets of the existing mount targets

If the request satisfies the requirements, Amazon EFS does the following:

  • Creates a new mount target in the specified subnet.

  • Also creates a new network interface in the subnet as follows:

    • If the request provides an IpAddress, Amazon EFS assigns that IP address to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet (in the same way that the Amazon EC2 CreateNetworkInterface call does when a request does not specify a primary private IP address).

    • If the request provides SecurityGroups, this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC.

    • Assigns the description Mount target fsmt-id for file system fs-id where fsmt-id is the mount target ID, and fs-id is the FileSystemId.

    • Sets the requesterManaged property of the network interface to true, and the requesterId value to EFS.

    Each Amazon EFS mount target has one corresponding requestor-managed EC2 network interface. After the network interface is created, Amazon EFS sets the NetworkInterfaceId field in the mount target's description to the network interface ID, and the IpAddress field to its address. If network interface creation fails, the entire CreateMountTarget operation fails.

The CreateMountTarget call returns only after creating the network interface, but while the mount target state is still creating. You can check the mount target creation status by calling the DescribeFileSystems operation, which among other things returns the mount target state.

We recommend you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, see Amazon EFS. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario. If the Availability Zone in which your mount target is created goes down, then you won't be able to access your file system through that mount target.

This operation requires permissions for the following action on the file system:

  • elasticfilesystem:CreateMountTarget

This operation also requires permissions for the following Amazon EC2 actions:

  • ec2:DescribeSubnets

  • ec2:DescribeNetworkInterfaces

  • ec2:CreateNetworkInterface

CreateMountTargetAsync ( CreateMountTargetRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the CreateMountTarget operation.

CreateTags ( CreateTagsRequest request ) : CreateTagsResponse

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.

CreateTagsAsync ( CreateTagsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the CreateTags operation.

DeleteFileSystem ( DeleteFileSystemRequest request ) : DeleteFileSystemResponse

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.

DeleteFileSystem ( string fileSystemId ) : DeleteFileSystemResponse

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.

DeleteFileSystemAsync ( DeleteFileSystemRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DeleteFileSystem operation.

DeleteFileSystemAsync ( string fileSystemId, System cancellationToken = default(CancellationToken) ) : Task

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.

DeleteMountTarget ( DeleteMountTargetRequest request ) : DeleteMountTargetResponse

Deletes the specified mount target.

This operation forcibly breaks any mounts of the file system via the mount target that is being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes may be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC via another mount target.

This operation requires permissions for the following action on the file system:

  • elasticfilesystem:DeleteMountTarget

The DeleteMountTarget call returns while the mount target state is still deleting. You can check the mount target deletion by calling the DescribeMountTargets operation, which returns a list of mount target descriptions for the given file system.

The operation also requires permissions for the following Amazon EC2 action on the mount target's network interface:

  • ec2:DeleteNetworkInterface

DeleteMountTarget ( string mountTargetId ) : DeleteMountTargetResponse

Deletes the specified mount target.

This operation forcibly breaks any mounts of the file system via the mount target that is being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes may be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC via another mount target.

This operation requires permissions for the following action on the file system:

  • elasticfilesystem:DeleteMountTarget

The DeleteMountTarget call returns while the mount target state is still deleting. You can check the mount target deletion by calling the DescribeMountTargets operation, which returns a list of mount target descriptions for the given file system.

The operation also requires permissions for the following Amazon EC2 action on the mount target's network interface:

  • ec2:DeleteNetworkInterface

DeleteMountTargetAsync ( DeleteMountTargetRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DeleteMountTarget operation.

DeleteMountTargetAsync ( string mountTargetId, System cancellationToken = default(CancellationToken) ) : Task

Deletes the specified mount target.

This operation forcibly breaks any mounts of the file system via the mount target that is being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes may be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC via another mount target.

This operation requires permissions for the following action on the file system:

  • elasticfilesystem:DeleteMountTarget

The DeleteMountTarget call returns while the mount target state is still deleting. You can check the mount target deletion by calling the DescribeMountTargets operation, which returns a list of mount target descriptions for the given file system.

The operation also requires permissions for the following Amazon EC2 action on the mount target's network interface:

  • ec2:DeleteNetworkInterface

DeleteTags ( DeleteTagsRequest request ) : DeleteTagsResponse

Deletes the specified tags from a file system. If the DeleteTags request includes a tag key that does not exist, Amazon EFS ignores it and doesn't cause an error. For more information about tags and related restrictions, see Tag Restrictions in the AWS Billing and Cost Management User Guide.

This operation requires permissions for the elasticfilesystem:DeleteTags action.

DeleteTagsAsync ( DeleteTagsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DeleteTags operation.

DescribeFileSystems ( DescribeFileSystemsRequest request ) : DescribeFileSystemsResponse

Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided. Otherwise, it returns descriptions of all file systems owned by the caller's AWS account in the AWS Region of the endpoint that you're calling.

When retrieving all file system descriptions, you can optionally specify the MaxItems parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon EFS returns a NextMarker, an opaque token, in the response. In this case, you should send a subsequent request with the Marker request parameter set to the value of NextMarker.

To retrieve a list of your file system descriptions, this operation is used in an iterative process, where DescribeFileSystems is called first without the Marker and then the operation continues to call it with the Marker parameter set to the value of the NextMarker from the previous response until the response has no NextMarker.

The implementation may return fewer than MaxItems file system descriptions while still including a NextMarker value.

The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multi-call iteration is unspecified.

This operation requires permissions for the elasticfilesystem:DescribeFileSystems action.

DescribeFileSystemsAsync ( DescribeFileSystemsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeFileSystems operation.

DescribeMountTargetSecurityGroups ( DescribeMountTargetSecurityGroupsRequest request ) : DescribeMountTargetSecurityGroupsResponse

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.

DescribeMountTargetSecurityGroups ( string mountTargetId ) : DescribeMountTargetSecurityGroupsResponse

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.

DescribeMountTargetSecurityGroupsAsync ( DescribeMountTargetSecurityGroupsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeMountTargetSecurityGroups operation.

DescribeMountTargetSecurityGroupsAsync ( string mountTargetId, System cancellationToken = default(CancellationToken) ) : Task

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.

DescribeMountTargets ( DescribeMountTargetsRequest request ) : Amazon.ElasticFileSystem.Model.DescribeMountTargetsResponse

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.

DescribeMountTargets ( string fileSystemId ) : Amazon.ElasticFileSystem.Model.DescribeMountTargetsResponse

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.

DescribeMountTargetsAsync ( DescribeMountTargetsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeMountTargets operation.

DescribeMountTargetsAsync ( string fileSystemId, System cancellationToken = default(CancellationToken) ) : Task

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.

DescribeTags ( DescribeTagsRequest request ) : Amazon.ElasticFileSystem.Model.DescribeTagsResponse

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

This operation requires permissions for the elasticfilesystem:DescribeTags action.

DescribeTags ( string fileSystemId ) : Amazon.ElasticFileSystem.Model.DescribeTagsResponse

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

This operation requires permissions for the elasticfilesystem:DescribeTags action.

DescribeTagsAsync ( DescribeTagsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeTags operation.

DescribeTagsAsync ( string fileSystemId, System cancellationToken = default(CancellationToken) ) : Task

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

This operation requires permissions for the elasticfilesystem:DescribeTags action.

EndCreateFileSystem ( IAsyncResult asyncResult ) : CreateFileSystemResponse

Finishes the asynchronous execution of the CreateFileSystem operation.

EndCreateMountTarget ( IAsyncResult asyncResult ) : CreateMountTargetResponse

Finishes the asynchronous execution of the CreateMountTarget operation.

EndCreateTags ( IAsyncResult asyncResult ) : CreateTagsResponse

Finishes the asynchronous execution of the CreateTags operation.

EndDeleteFileSystem ( IAsyncResult asyncResult ) : DeleteFileSystemResponse

Finishes the asynchronous execution of the DeleteFileSystem operation.

EndDeleteMountTarget ( IAsyncResult asyncResult ) : DeleteMountTargetResponse

Finishes the asynchronous execution of the DeleteMountTarget operation.

EndDeleteTags ( IAsyncResult asyncResult ) : DeleteTagsResponse

Finishes the asynchronous execution of the DeleteTags operation.

EndDescribeFileSystems ( IAsyncResult asyncResult ) : DescribeFileSystemsResponse

Finishes the asynchronous execution of the DescribeFileSystems operation.

EndDescribeMountTargetSecurityGroups ( IAsyncResult asyncResult ) : DescribeMountTargetSecurityGroupsResponse

Finishes the asynchronous execution of the DescribeMountTargetSecurityGroups operation.

EndDescribeMountTargets ( IAsyncResult asyncResult ) : Amazon.ElasticFileSystem.Model.DescribeMountTargetsResponse

Finishes the asynchronous execution of the DescribeMountTargets operation.

EndDescribeTags ( IAsyncResult asyncResult ) : Amazon.ElasticFileSystem.Model.DescribeTagsResponse

Finishes the asynchronous execution of the DescribeTags operation.

EndModifyMountTargetSecurityGroups ( IAsyncResult asyncResult ) : ModifyMountTargetSecurityGroupsResponse

Finishes the asynchronous execution of the ModifyMountTargetSecurityGroups operation.

ModifyMountTargetSecurityGroups ( ModifyMountTargetSecurityGroupsRequest request ) : ModifyMountTargetSecurityGroupsResponse

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.

ModifyMountTargetSecurityGroupsAsync ( ModifyMountTargetSecurityGroupsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the ModifyMountTargetSecurityGroups operation.

Protected Methods

Method Description
CreateSigner ( ) : AbstractAWSSigner

Creates the signer for the service.

CustomizeRuntimePipeline ( RuntimePipeline pipeline ) : void

Customize the pipeline

Dispose ( bool disposing ) : void

Disposes the service client.

Method Details

AmazonElasticFileSystemClient() public method

Constructs AmazonElasticFileSystemClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>
public AmazonElasticFileSystemClient ( ) : System
return System

AmazonElasticFileSystemClient() public method

Constructs AmazonElasticFileSystemClient with AWS Credentials
public AmazonElasticFileSystemClient ( AWSCredentials credentials ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
return System

AmazonElasticFileSystemClient() public method

Constructs AmazonElasticFileSystemClient with AWS Credentials and an AmazonElasticFileSystemClient Configuration object.
public AmazonElasticFileSystemClient ( AWSCredentials credentials, AmazonElasticFileSystemConfig clientConfig ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
clientConfig AmazonElasticFileSystemConfig The AmazonElasticFileSystemClient Configuration Object
return System

AmazonElasticFileSystemClient() public method

Constructs AmazonElasticFileSystemClient with AWS Credentials
public AmazonElasticFileSystemClient ( AWSCredentials credentials, RegionEndpoint region ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
region RegionEndpoint The region to connect.
return System

AmazonElasticFileSystemClient() public method

Constructs AmazonElasticFileSystemClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>
public AmazonElasticFileSystemClient ( AmazonElasticFileSystemConfig config ) : System
config AmazonElasticFileSystemConfig The AmazonElasticFileSystemClient Configuration Object
return System

AmazonElasticFileSystemClient() public method

Constructs AmazonElasticFileSystemClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>
public AmazonElasticFileSystemClient ( RegionEndpoint region ) : System
region RegionEndpoint The region to connect.
return System

AmazonElasticFileSystemClient() public method

Constructs AmazonElasticFileSystemClient with AWS Access Key ID and AWS Secret Key
public AmazonElasticFileSystemClient ( string awsAccessKeyId, string awsSecretAccessKey ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
return System

AmazonElasticFileSystemClient() public method

Constructs AmazonElasticFileSystemClient with AWS Access Key ID, AWS Secret Key and an AmazonElasticFileSystemClient Configuration object.
public AmazonElasticFileSystemClient ( string awsAccessKeyId, string awsSecretAccessKey, AmazonElasticFileSystemConfig clientConfig ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
clientConfig AmazonElasticFileSystemConfig The AmazonElasticFileSystemClient Configuration Object
return System

AmazonElasticFileSystemClient() public method

Constructs AmazonElasticFileSystemClient with AWS Access Key ID and AWS Secret Key
public AmazonElasticFileSystemClient ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
region RegionEndpoint The region to connect.
return System

AmazonElasticFileSystemClient() public method

Constructs AmazonElasticFileSystemClient with AWS Access Key ID and AWS Secret Key
public AmazonElasticFileSystemClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
return System

AmazonElasticFileSystemClient() public method

Constructs AmazonElasticFileSystemClient with AWS Access Key ID, AWS Secret Key and an AmazonElasticFileSystemClient Configuration object.
public AmazonElasticFileSystemClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonElasticFileSystemConfig clientConfig ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
clientConfig AmazonElasticFileSystemConfig The AmazonElasticFileSystemClient Configuration Object
return System

AmazonElasticFileSystemClient() public method

Constructs AmazonElasticFileSystemClient with AWS Access Key ID and AWS Secret Key
public AmazonElasticFileSystemClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
region RegionEndpoint The region to connect.
return System

BeginCreateFileSystem() public method

Initiates the asynchronous execution of the CreateFileSystem operation.
public BeginCreateFileSystem ( CreateFileSystemRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.ElasticFileSystem.Model.CreateFileSystemRequest Container for the necessary parameters to execute the CreateFileSystem operation on AmazonElasticFileSystemClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginCreateMountTarget() public method

Initiates the asynchronous execution of the CreateMountTarget operation.
public BeginCreateMountTarget ( CreateMountTargetRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.ElasticFileSystem.Model.CreateMountTargetRequest Container for the necessary parameters to execute the CreateMountTarget operation on AmazonElasticFileSystemClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginCreateTags() public method

Initiates the asynchronous execution of the CreateTags operation.
public BeginCreateTags ( CreateTagsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.ElasticFileSystem.Model.CreateTagsRequest Container for the necessary parameters to execute the CreateTags operation on AmazonElasticFileSystemClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDeleteFileSystem() public method

Initiates the asynchronous execution of the DeleteFileSystem operation.
public BeginDeleteFileSystem ( DeleteFileSystemRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.ElasticFileSystem.Model.DeleteFileSystemRequest Container for the necessary parameters to execute the DeleteFileSystem operation on AmazonElasticFileSystemClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDeleteMountTarget() public method

Initiates the asynchronous execution of the DeleteMountTarget operation.
public BeginDeleteMountTarget ( DeleteMountTargetRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.ElasticFileSystem.Model.DeleteMountTargetRequest Container for the necessary parameters to execute the DeleteMountTarget operation on AmazonElasticFileSystemClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDeleteTags() public method

Initiates the asynchronous execution of the DeleteTags operation.
public BeginDeleteTags ( DeleteTagsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.ElasticFileSystem.Model.DeleteTagsRequest Container for the necessary parameters to execute the DeleteTags operation on AmazonElasticFileSystemClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDescribeFileSystems() public method

Initiates the asynchronous execution of the DescribeFileSystems operation.
public BeginDescribeFileSystems ( DescribeFileSystemsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.ElasticFileSystem.Model.DescribeFileSystemsRequest Container for the necessary parameters to execute the DescribeFileSystems operation on AmazonElasticFileSystemClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDescribeMountTargetSecurityGroups() public method

Initiates the asynchronous execution of the DescribeMountTargetSecurityGroups operation.
public BeginDescribeMountTargetSecurityGroups ( DescribeMountTargetSecurityGroupsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.ElasticFileSystem.Model.DescribeMountTargetSecurityGroupsRequest Container for the necessary parameters to execute the DescribeMountTargetSecurityGroups operation on AmazonElasticFileSystemClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDescribeMountTargets() public method

Initiates the asynchronous execution of the DescribeMountTargets operation.
public BeginDescribeMountTargets ( DescribeMountTargetsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.ElasticFileSystem.Model.DescribeMountTargetsRequest Container for the necessary parameters to execute the DescribeMountTargets operation on AmazonElasticFileSystemClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDescribeTags() public method

Initiates the asynchronous execution of the DescribeTags operation.
public BeginDescribeTags ( DescribeTagsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.ElasticFileSystem.Model.DescribeTagsRequest Container for the necessary parameters to execute the DescribeTags operation on AmazonElasticFileSystemClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginModifyMountTargetSecurityGroups() public method

Initiates the asynchronous execution of the ModifyMountTargetSecurityGroups operation.
public BeginModifyMountTargetSecurityGroups ( ModifyMountTargetSecurityGroupsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.ElasticFileSystem.Model.ModifyMountTargetSecurityGroupsRequest Container for the necessary parameters to execute the ModifyMountTargetSecurityGroups operation on AmazonElasticFileSystemClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

CreateFileSystem() public method

Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's AWS account with the specified creation token, this operation does the following:
  • Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state creating.

  • Returns with the description of the created file system.

Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system.

For basic use cases, you can use a randomly generated UUID for the creation token.

The idempotent operation allows you to retry a CreateFileSystem call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists error.

The CreateFileSystem call returns while the file system's lifecycle state is still creating. You can check the file system creation status by calling the DescribeFileSystems operation, which among other things returns the file system state.

This operation also takes an optional PerformanceMode parameter that you choose for your file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput 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.

After the file system is fully created, Amazon EFS sets its lifecycle state to available, at which point you can create one or more mount targets for the file system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in your VPC via the mount target. For more information, see Amazon EFS: How it Works.

This operation requires permissions for the elasticfilesystem:CreateFileSystem action.

/// Returned if the request is malformed or contains an error such as an invalid parameter /// value or a missing required parameter. /// /// Returned if the file system you are trying to create already exists, with the creation /// token you provided. /// /// Returned if the AWS account has already created maximum number of file systems allowed /// per account. /// /// Returned if an error occurred on the server side. ///
public CreateFileSystem ( CreateFileSystemRequest request ) : CreateFileSystemResponse
request Amazon.ElasticFileSystem.Model.CreateFileSystemRequest Container for the necessary parameters to execute the CreateFileSystem service method.
return Amazon.ElasticFileSystem.Model.CreateFileSystemResponse

CreateFileSystem() public method

Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's AWS account with the specified creation token, this operation does the following:
  • Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state creating.

  • Returns with the description of the created file system.

Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system.

For basic use cases, you can use a randomly generated UUID for the creation token.

The idempotent operation allows you to retry a CreateFileSystem call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists error.

The CreateFileSystem call returns while the file system's lifecycle state is still creating. You can check the file system creation status by calling the DescribeFileSystems operation, which among other things returns the file system state.

This operation also takes an optional PerformanceMode parameter that you choose for your file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput 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.

After the file system is fully created, Amazon EFS sets its lifecycle state to available, at which point you can create one or more mount targets for the file system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in your VPC via the mount target. For more information, see Amazon EFS: How it Works.

This operation requires permissions for the elasticfilesystem:CreateFileSystem action.

/// Returned if the request is malformed or contains an error such as an invalid parameter /// value or a missing required parameter. /// /// Returned if the file system you are trying to create already exists, with the creation /// token you provided. /// /// Returned if the AWS account has already created maximum number of file systems allowed /// per account. /// /// Returned if an error occurred on the server side. ///
public CreateFileSystem ( string creationToken ) : CreateFileSystemResponse
creationToken string String of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.
return Amazon.ElasticFileSystem.Model.CreateFileSystemResponse

CreateFileSystemAsync() public method

Initiates the asynchronous execution of the CreateFileSystem operation.
public CreateFileSystemAsync ( CreateFileSystemRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.ElasticFileSystem.Model.CreateFileSystemRequest Container for the necessary parameters to execute the CreateFileSystem operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

CreateFileSystemAsync() public method

Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's AWS account with the specified creation token, this operation does the following:
  • Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state creating.

  • Returns with the description of the created file system.

Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system.

For basic use cases, you can use a randomly generated UUID for the creation token.

The idempotent operation allows you to retry a CreateFileSystem call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists error.

The CreateFileSystem call returns while the file system's lifecycle state is still creating. You can check the file system creation status by calling the DescribeFileSystems operation, which among other things returns the file system state.

This operation also takes an optional PerformanceMode parameter that you choose for your file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput 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.

After the file system is fully created, Amazon EFS sets its lifecycle state to available, at which point you can create one or more mount targets for the file system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in your VPC via the mount target. For more information, see Amazon EFS: How it Works.

This operation requires permissions for the elasticfilesystem:CreateFileSystem action.

/// Returned if the request is malformed or contains an error such as an invalid parameter /// value or a missing required parameter. /// /// Returned if the file system you are trying to create already exists, with the creation /// token you provided. /// /// Returned if the AWS account has already created maximum number of file systems allowed /// per account. /// /// Returned if an error occurred on the server side. ///
public CreateFileSystemAsync ( string creationToken, System cancellationToken = default(CancellationToken) ) : Task
creationToken string String of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

CreateMountTarget() public method

Creates a mount target for a file system. You can then mount the file system on EC2 instances via the mount target.

You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system. For more information, see Amazon EFS: How it Works.

In the request, you also specify a file system ID for which you are creating the mount target and the file system's lifecycle state must be available. For more information, see DescribeFileSystems.

In the request, you also provide a subnet ID, which determines the following:

  • VPC in which Amazon EFS creates the mount target

  • Availability Zone in which Amazon EFS creates the mount target

  • IP address range from which Amazon EFS selects the IP address of the mount target (if you don't specify an IP address in the request)

After creating the mount target, Amazon EFS returns a response that includes, a MountTargetId and an IpAddress. You use this IP address when mounting the file system in an EC2 instance. You can also use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file system via the mount target can resolve the mount target's DNS name to its IP address. For more information, see How it Works: Implementation Overview.

Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the subnet specified in the request to add another mount target must meet the following requirements:

  • Must belong to the same VPC as the subnets of the existing mount targets

  • Must not be in the same Availability Zone as any of the subnets of the existing mount targets

If the request satisfies the requirements, Amazon EFS does the following:

  • Creates a new mount target in the specified subnet.

  • Also creates a new network interface in the subnet as follows:

    • If the request provides an IpAddress, Amazon EFS assigns that IP address to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet (in the same way that the Amazon EC2 CreateNetworkInterface call does when a request does not specify a primary private IP address).

    • If the request provides SecurityGroups, this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC.

    • Assigns the description Mount target fsmt-id for file system fs-id where fsmt-id is the mount target ID, and fs-id is the FileSystemId.

    • Sets the requesterManaged property of the network interface to true, and the requesterId value to EFS.

    Each Amazon EFS mount target has one corresponding requestor-managed EC2 network interface. After the network interface is created, Amazon EFS sets the NetworkInterfaceId field in the mount target's description to the network interface ID, and the IpAddress field to its address. If network interface creation fails, the entire CreateMountTarget operation fails.

The CreateMountTarget call returns only after creating the network interface, but while the mount target state is still creating. You can check the mount target creation status by calling the DescribeFileSystems operation, which among other things returns the mount target state.

We recommend you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, see Amazon EFS. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario. If the Availability Zone in which your mount target is created goes down, then you won't be able to access your file system through that mount target.

This operation requires permissions for the following action on the file system:

  • elasticfilesystem:CreateMountTarget

This operation also requires permissions for the following Amazon EC2 actions:

  • ec2:DescribeSubnets

  • ec2:DescribeNetworkInterfaces

  • ec2:CreateNetworkInterface

/// Returned if the request is malformed or contains an error such as an invalid parameter /// value or a missing required parameter. /// /// Returned if the specified FileSystemId does not exist in the requester's /// AWS account. /// /// Returned if the file system's life cycle state is not "created". /// /// Returned if an error occurred on the server side. /// /// Returned if the request specified an IpAddress that is already in use /// in the subnet. /// /// Returned if the mount target would violate one of the specified restrictions based /// on the file system's existing mount targets. /// /// The calling account has reached the ENI limit for the specific AWS region. Client /// should try to delete some ENIs or get its account limit raised. For more information, /// see Amazon /// VPC Limits in the Amazon Virtual Private Cloud User Guide (see the Network interfaces /// per VPC entry in the table). /// /// Returned if IpAddress was not specified in the request and there are /// no free IP addresses in the subnet. /// /// Returned if the size of SecurityGroups specified in the request is greater /// than five. /// /// Returned if one of the specified security groups does not exist in the subnet's VPC. /// /// Returned if there is no subnet with ID SubnetId provided in the request. /// /// ///
public CreateMountTarget ( CreateMountTargetRequest request ) : CreateMountTargetResponse
request Amazon.ElasticFileSystem.Model.CreateMountTargetRequest Container for the necessary parameters to execute the CreateMountTarget service method.
return Amazon.ElasticFileSystem.Model.CreateMountTargetResponse

CreateMountTargetAsync() public method

Initiates the asynchronous execution of the CreateMountTarget operation.
public CreateMountTargetAsync ( CreateMountTargetRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.ElasticFileSystem.Model.CreateMountTargetRequest Container for the necessary parameters to execute the CreateMountTarget operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

CreateSigner() protected method

Creates the signer for the service.
protected CreateSigner ( ) : AbstractAWSSigner
return Amazon.Runtime.Internal.Auth.AbstractAWSSigner

CreateTags() public method

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.

/// Returned if the request is malformed or contains an error such as an invalid parameter /// value or a missing required parameter. /// /// Returned if the specified FileSystemId does not exist in the requester's /// AWS account. /// /// Returned if an error occurred on the server side. ///
public CreateTags ( CreateTagsRequest request ) : CreateTagsResponse
request Amazon.ElasticFileSystem.Model.CreateTagsRequest Container for the necessary parameters to execute the CreateTags service method.
return CreateTagsResponse

CreateTagsAsync() public method

Initiates the asynchronous execution of the CreateTags operation.
public CreateTagsAsync ( CreateTagsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.ElasticFileSystem.Model.CreateTagsRequest Container for the necessary parameters to execute the CreateTags operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

CustomizeRuntimePipeline() protected method

Customize the pipeline
protected CustomizeRuntimePipeline ( RuntimePipeline pipeline ) : void
pipeline RuntimePipeline
return void

DeleteFileSystem() public method

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.

/// Returned if the request is malformed or contains an error such as an invalid parameter /// value or a missing required parameter. /// /// Returned if a file system has mount targets. /// /// Returned if the specified FileSystemId does not exist in the requester's /// AWS account. /// /// Returned if an error occurred on the server side. ///
public DeleteFileSystem ( DeleteFileSystemRequest request ) : DeleteFileSystemResponse
request Amazon.ElasticFileSystem.Model.DeleteFileSystemRequest Container for the necessary parameters to execute the DeleteFileSystem service method.
return DeleteFileSystemResponse

DeleteFileSystem() public method

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.

/// Returned if the request is malformed or contains an error such as an invalid parameter /// value or a missing required parameter. /// /// Returned if a file system has mount targets. /// /// Returned if the specified FileSystemId does not exist in the requester's /// AWS account. /// /// Returned if an error occurred on the server side. ///
public DeleteFileSystem ( string fileSystemId ) : DeleteFileSystemResponse
fileSystemId string ID of the file system you want to delete.
return DeleteFileSystemResponse

DeleteFileSystemAsync() public method

Initiates the asynchronous execution of the DeleteFileSystem operation.
public DeleteFileSystemAsync ( DeleteFileSystemRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.ElasticFileSystem.Model.DeleteFileSystemRequest Container for the necessary parameters to execute the DeleteFileSystem operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteFileSystemAsync() public method

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.

/// Returned if the request is malformed or contains an error such as an invalid parameter /// value or a missing required parameter. /// /// Returned if a file system has mount targets. /// /// Returned if the specified FileSystemId does not exist in the requester's /// AWS account. /// /// Returned if an error occurred on the server side. ///
public DeleteFileSystemAsync ( string fileSystemId, System cancellationToken = default(CancellationToken) ) : Task
fileSystemId string ID of the file system you want to delete.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteMountTarget() public method

Deletes the specified mount target.

This operation forcibly breaks any mounts of the file system via the mount target that is being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes may be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC via another mount target.

This operation requires permissions for the following action on the file system:

  • elasticfilesystem:DeleteMountTarget

The DeleteMountTarget call returns while the mount target state is still deleting. You can check the mount target deletion by calling the DescribeMountTargets operation, which returns a list of mount target descriptions for the given file system.

The operation also requires permissions for the following Amazon EC2 action on the mount target's network interface:

  • ec2:DeleteNetworkInterface

/// Returned if the request is malformed or contains an error such as an invalid parameter /// value or a missing required parameter. /// /// The service timed out trying to fulfill the request, and the client should try the /// call again. /// /// Returned if an error occurred on the server side. /// /// Returned if there is no mount target with the specified ID found in the caller's account. ///
public DeleteMountTarget ( DeleteMountTargetRequest request ) : DeleteMountTargetResponse
request Amazon.ElasticFileSystem.Model.DeleteMountTargetRequest Container for the necessary parameters to execute the DeleteMountTarget service method.
return DeleteMountTargetResponse

DeleteMountTarget() public method

Deletes the specified mount target.

This operation forcibly breaks any mounts of the file system via the mount target that is being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes may be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC via another mount target.

This operation requires permissions for the following action on the file system:

  • elasticfilesystem:DeleteMountTarget

The DeleteMountTarget call returns while the mount target state is still deleting. You can check the mount target deletion by calling the DescribeMountTargets operation, which returns a list of mount target descriptions for the given file system.

The operation also requires permissions for the following Amazon EC2 action on the mount target's network interface:

  • ec2:DeleteNetworkInterface

/// Returned if the request is malformed or contains an error such as an invalid parameter /// value or a missing required parameter. /// /// The service timed out trying to fulfill the request, and the client should try the /// call again. /// /// Returned if an error occurred on the server side. /// /// Returned if there is no mount target with the specified ID found in the caller's account. ///
public DeleteMountTarget ( string mountTargetId ) : DeleteMountTargetResponse
mountTargetId string ID of the mount target to delete (String).
return DeleteMountTargetResponse

DeleteMountTargetAsync() public method

Initiates the asynchronous execution of the DeleteMountTarget operation.
public DeleteMountTargetAsync ( DeleteMountTargetRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.ElasticFileSystem.Model.DeleteMountTargetRequest Container for the necessary parameters to execute the DeleteMountTarget operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteMountTargetAsync() public method

Deletes the specified mount target.

This operation forcibly breaks any mounts of the file system via the mount target that is being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes may be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC via another mount target.

This operation requires permissions for the following action on the file system:

  • elasticfilesystem:DeleteMountTarget

The DeleteMountTarget call returns while the mount target state is still deleting. You can check the mount target deletion by calling the DescribeMountTargets operation, which returns a list of mount target descriptions for the given file system.

The operation also requires permissions for the following Amazon EC2 action on the mount target's network interface:

  • ec2:DeleteNetworkInterface

/// Returned if the request is malformed or contains an error such as an invalid parameter /// value or a missing required parameter. /// /// The service timed out trying to fulfill the request, and the client should try the /// call again. /// /// Returned if an error occurred on the server side. /// /// Returned if there is no mount target with the specified ID found in the caller's account. ///
public DeleteMountTargetAsync ( string mountTargetId, System cancellationToken = default(CancellationToken) ) : Task
mountTargetId string ID of the mount target to delete (String).
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteTags() public method

Deletes the specified tags from a file system. If the DeleteTags request includes a tag key that does not exist, Amazon EFS ignores it and doesn't cause an error. For more information about tags and related restrictions, see Tag Restrictions in the AWS Billing and Cost Management User Guide.

This operation requires permissions for the elasticfilesystem:DeleteTags action.

/// Returned if the request is malformed or contains an error such as an invalid parameter /// value or a missing required parameter. /// /// Returned if the specified FileSystemId does not exist in the requester's /// AWS account. /// /// Returned if an error occurred on the server side. ///
public DeleteTags ( DeleteTagsRequest request ) : DeleteTagsResponse
request Amazon.ElasticFileSystem.Model.DeleteTagsRequest Container for the necessary parameters to execute the DeleteTags service method.
return DeleteTagsResponse

DeleteTagsAsync() public method

Initiates the asynchronous execution of the DeleteTags operation.
public DeleteTagsAsync ( DeleteTagsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.ElasticFileSystem.Model.DeleteTagsRequest Container for the necessary parameters to execute the DeleteTags operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeFileSystems() public method

Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided. Otherwise, it returns descriptions of all file systems owned by the caller's AWS account in the AWS Region of the endpoint that you're calling.

When retrieving all file system descriptions, you can optionally specify the MaxItems parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon EFS returns a NextMarker, an opaque token, in the response. In this case, you should send a subsequent request with the Marker request parameter set to the value of NextMarker.

To retrieve a list of your file system descriptions, this operation is used in an iterative process, where DescribeFileSystems is called first without the Marker and then the operation continues to call it with the Marker parameter set to the value of the NextMarker from the previous response until the response has no NextMarker.

The implementation may return fewer than MaxItems file system descriptions while still including a NextMarker value.

The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multi-call iteration is unspecified.

This operation requires permissions for the elasticfilesystem:DescribeFileSystems action.

/// Returned if the request is malformed or contains an error such as an invalid parameter /// value or a missing required parameter. /// /// Returned if the specified FileSystemId does not exist in the requester's /// AWS account. /// /// Returned if an error occurred on the server side. ///
public DescribeFileSystems ( DescribeFileSystemsRequest request ) : DescribeFileSystemsResponse
request Amazon.ElasticFileSystem.Model.DescribeFileSystemsRequest Container for the necessary parameters to execute the DescribeFileSystems service method.
return Amazon.ElasticFileSystem.Model.DescribeFileSystemsResponse

DescribeFileSystemsAsync() public method

Initiates the asynchronous execution of the DescribeFileSystems operation.
public DescribeFileSystemsAsync ( DescribeFileSystemsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.ElasticFileSystem.Model.DescribeFileSystemsRequest Container for the necessary parameters to execute the DescribeFileSystems operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeMountTargetSecurityGroups() public method

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.

/// Returned if the request is malformed or contains an error such as an invalid parameter /// value or a missing required parameter. /// /// Returned if the mount target is not in the correct state for the operation. /// /// Returned if an error occurred on the server side. /// /// Returned if there is no mount target with the specified ID found in the caller's account. ///
public DescribeMountTargetSecurityGroups ( DescribeMountTargetSecurityGroupsRequest request ) : DescribeMountTargetSecurityGroupsResponse
request Amazon.ElasticFileSystem.Model.DescribeMountTargetSecurityGroupsRequest Container for the necessary parameters to execute the DescribeMountTargetSecurityGroups service method.
return Amazon.ElasticFileSystem.Model.DescribeMountTargetSecurityGroupsResponse

DescribeMountTargetSecurityGroups() public method

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.

/// Returned if the request is malformed or contains an error such as an invalid parameter /// value or a missing required parameter. /// /// Returned if the mount target is not in the correct state for the operation. /// /// Returned if an error occurred on the server side. /// /// Returned if there is no mount target with the specified ID found in the caller's account. ///
public DescribeMountTargetSecurityGroups ( string mountTargetId ) : DescribeMountTargetSecurityGroupsResponse
mountTargetId string ID of the mount target whose security groups you want to retrieve.
return Amazon.ElasticFileSystem.Model.DescribeMountTargetSecurityGroupsResponse

DescribeMountTargetSecurityGroupsAsync() public method

Initiates the asynchronous execution of the DescribeMountTargetSecurityGroups operation.
public DescribeMountTargetSecurityGroupsAsync ( DescribeMountTargetSecurityGroupsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.ElasticFileSystem.Model.DescribeMountTargetSecurityGroupsRequest Container for the necessary parameters to execute the DescribeMountTargetSecurityGroups operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeMountTargetSecurityGroupsAsync() public method

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.

/// Returned if the request is malformed or contains an error such as an invalid parameter /// value or a missing required parameter. /// /// Returned if the mount target is not in the correct state for the operation. /// /// Returned if an error occurred on the server side. /// /// Returned if there is no mount target with the specified ID found in the caller's account. ///
public DescribeMountTargetSecurityGroupsAsync ( string mountTargetId, System cancellationToken = default(CancellationToken) ) : Task
mountTargetId string ID of the mount target whose security groups you want to retrieve.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeMountTargets() public method

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.

/// Returned if the request is malformed or contains an error such as an invalid parameter /// value or a missing required parameter. /// /// Returned if the specified FileSystemId does not exist in the requester's /// AWS account. /// /// Returned if an error occurred on the server side. /// /// Returned if there is no mount target with the specified ID found in the caller's account. ///
public DescribeMountTargets ( DescribeMountTargetsRequest request ) : Amazon.ElasticFileSystem.Model.DescribeMountTargetsResponse
request Amazon.ElasticFileSystem.Model.DescribeMountTargetsRequest Container for the necessary parameters to execute the DescribeMountTargets service method.
return Amazon.ElasticFileSystem.Model.DescribeMountTargetsResponse

DescribeMountTargets() public method

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.

/// Returned if the request is malformed or contains an error such as an invalid parameter /// value or a missing required parameter. /// /// Returned if the specified FileSystemId does not exist in the requester's /// AWS account. /// /// Returned if an error occurred on the server side. /// /// Returned if there is no mount target with the specified ID found in the caller's account. ///
public DescribeMountTargets ( string fileSystemId ) : Amazon.ElasticFileSystem.Model.DescribeMountTargetsResponse
fileSystemId string (Optional) ID of the file system whose mount targets you want to list (String). It must be included in your request if MountTargetId is not included.
return Amazon.ElasticFileSystem.Model.DescribeMountTargetsResponse

DescribeMountTargetsAsync() public method

Initiates the asynchronous execution of the DescribeMountTargets operation.
public DescribeMountTargetsAsync ( DescribeMountTargetsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.ElasticFileSystem.Model.DescribeMountTargetsRequest Container for the necessary parameters to execute the DescribeMountTargets operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeMountTargetsAsync() public method

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.

/// Returned if the request is malformed or contains an error such as an invalid parameter /// value or a missing required parameter. /// /// Returned if the specified FileSystemId does not exist in the requester's /// AWS account. /// /// Returned if an error occurred on the server side. /// /// Returned if there is no mount target with the specified ID found in the caller's account. ///
public DescribeMountTargetsAsync ( string fileSystemId, System cancellationToken = default(CancellationToken) ) : Task
fileSystemId string (Optional) ID of the file system whose mount targets you want to list (String). It must be included in your request if MountTargetId is not included.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeTags() public method

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

This operation requires permissions for the elasticfilesystem:DescribeTags action.

/// Returned if the request is malformed or contains an error such as an invalid parameter /// value or a missing required parameter. /// /// Returned if the specified FileSystemId does not exist in the requester's /// AWS account. /// /// Returned if an error occurred on the server side. ///
public DescribeTags ( DescribeTagsRequest request ) : Amazon.ElasticFileSystem.Model.DescribeTagsResponse
request Amazon.ElasticFileSystem.Model.DescribeTagsRequest Container for the necessary parameters to execute the DescribeTags service method.
return Amazon.ElasticFileSystem.Model.DescribeTagsResponse

DescribeTags() public method

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

This operation requires permissions for the elasticfilesystem:DescribeTags action.

/// Returned if the request is malformed or contains an error such as an invalid parameter /// value or a missing required parameter. /// /// Returned if the specified FileSystemId does not exist in the requester's /// AWS account. /// /// Returned if an error occurred on the server side. ///
public DescribeTags ( string fileSystemId ) : Amazon.ElasticFileSystem.Model.DescribeTagsResponse
fileSystemId string ID of the file system whose tag set you want to retrieve.
return Amazon.ElasticFileSystem.Model.DescribeTagsResponse

DescribeTagsAsync() public method

Initiates the asynchronous execution of the DescribeTags operation.
public DescribeTagsAsync ( DescribeTagsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.ElasticFileSystem.Model.DescribeTagsRequest Container for the necessary parameters to execute the DescribeTags operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeTagsAsync() public method

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

This operation requires permissions for the elasticfilesystem:DescribeTags action.

/// Returned if the request is malformed or contains an error such as an invalid parameter /// value or a missing required parameter. /// /// Returned if the specified FileSystemId does not exist in the requester's /// AWS account. /// /// Returned if an error occurred on the server side. ///
public DescribeTagsAsync ( string fileSystemId, System cancellationToken = default(CancellationToken) ) : Task
fileSystemId string ID of the file system whose tag set you want to retrieve.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

Dispose() protected method

Disposes the service client.
protected Dispose ( bool disposing ) : void
disposing bool
return void

EndCreateFileSystem() public method

Finishes the asynchronous execution of the CreateFileSystem operation.
public EndCreateFileSystem ( IAsyncResult asyncResult ) : CreateFileSystemResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginCreateFileSystem.
return Amazon.ElasticFileSystem.Model.CreateFileSystemResponse

EndCreateMountTarget() public method

Finishes the asynchronous execution of the CreateMountTarget operation.
public EndCreateMountTarget ( IAsyncResult asyncResult ) : CreateMountTargetResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginCreateMountTarget.
return Amazon.ElasticFileSystem.Model.CreateMountTargetResponse

EndCreateTags() public method

Finishes the asynchronous execution of the CreateTags operation.
public EndCreateTags ( IAsyncResult asyncResult ) : CreateTagsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginCreateTags.
return CreateTagsResponse

EndDeleteFileSystem() public method

Finishes the asynchronous execution of the DeleteFileSystem operation.
public EndDeleteFileSystem ( IAsyncResult asyncResult ) : DeleteFileSystemResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDeleteFileSystem.
return DeleteFileSystemResponse

EndDeleteMountTarget() public method

Finishes the asynchronous execution of the DeleteMountTarget operation.
public EndDeleteMountTarget ( IAsyncResult asyncResult ) : DeleteMountTargetResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDeleteMountTarget.
return DeleteMountTargetResponse

EndDeleteTags() public method

Finishes the asynchronous execution of the DeleteTags operation.
public EndDeleteTags ( IAsyncResult asyncResult ) : DeleteTagsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDeleteTags.
return DeleteTagsResponse

EndDescribeFileSystems() public method

Finishes the asynchronous execution of the DescribeFileSystems operation.
public EndDescribeFileSystems ( IAsyncResult asyncResult ) : DescribeFileSystemsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeFileSystems.
return Amazon.ElasticFileSystem.Model.DescribeFileSystemsResponse

EndDescribeMountTargetSecurityGroups() public method

Finishes the asynchronous execution of the DescribeMountTargetSecurityGroups operation.
public EndDescribeMountTargetSecurityGroups ( IAsyncResult asyncResult ) : DescribeMountTargetSecurityGroupsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeMountTargetSecurityGroups.
return Amazon.ElasticFileSystem.Model.DescribeMountTargetSecurityGroupsResponse

EndDescribeMountTargets() public method

Finishes the asynchronous execution of the DescribeMountTargets operation.
public EndDescribeMountTargets ( IAsyncResult asyncResult ) : Amazon.ElasticFileSystem.Model.DescribeMountTargetsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeMountTargets.
return Amazon.ElasticFileSystem.Model.DescribeMountTargetsResponse

EndDescribeTags() public method

Finishes the asynchronous execution of the DescribeTags operation.
public EndDescribeTags ( IAsyncResult asyncResult ) : Amazon.ElasticFileSystem.Model.DescribeTagsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeTags.
return Amazon.ElasticFileSystem.Model.DescribeTagsResponse

EndModifyMountTargetSecurityGroups() public method

Finishes the asynchronous execution of the ModifyMountTargetSecurityGroups operation.
public EndModifyMountTargetSecurityGroups ( IAsyncResult asyncResult ) : ModifyMountTargetSecurityGroupsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginModifyMountTargetSecurityGroups.
return ModifyMountTargetSecurityGroupsResponse

ModifyMountTargetSecurityGroups() public method

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.

/// Returned if the request is malformed or contains an error such as an invalid parameter /// value or a missing required parameter. /// /// Returned if the mount target is not in the correct state for the operation. /// /// Returned if an error occurred on the server side. /// /// Returned if there is no mount target with the specified ID found in the caller's account. /// /// Returned if the size of SecurityGroups specified in the request is greater /// than five. /// /// Returned if one of the specified security groups does not exist in the subnet's VPC. ///
public ModifyMountTargetSecurityGroups ( ModifyMountTargetSecurityGroupsRequest request ) : ModifyMountTargetSecurityGroupsResponse
request Amazon.ElasticFileSystem.Model.ModifyMountTargetSecurityGroupsRequest Container for the necessary parameters to execute the ModifyMountTargetSecurityGroups service method.
return ModifyMountTargetSecurityGroupsResponse

ModifyMountTargetSecurityGroupsAsync() public method

Initiates the asynchronous execution of the ModifyMountTargetSecurityGroups operation.
public ModifyMountTargetSecurityGroupsAsync ( ModifyMountTargetSecurityGroupsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.ElasticFileSystem.Model.ModifyMountTargetSecurityGroupsRequest Container for the necessary parameters to execute the ModifyMountTargetSecurityGroups operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task