AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup.

If a file system with the specified client request token exists and the parameters match, this operation returns the description of the file system. If a file system with the specified client request token exists but the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, this operation does the following:

Parameters like the Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings.

By using the idempotent operation, you can retry a CreateFileSystemFromBackup call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives a success message as long as the parameters are the same.

The CreateFileSystemFromBackup 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 returns the file system state along with other information.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.7.2 or higher.

Namespace: Amazon.FSx
Assembly: AWSSDK.FSx.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<CreateFileSystemFromBackupResponse> CreateFileSystemFromBackupAsync(
         CreateFileSystemFromBackupRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.FSx.Model.CreateFileSystemFromBackupRequest

Container for the necessary parameters to execute the CreateFileSystemFromBackup service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the CreateFileSystemFromBackup service method, as returned by FSx.

Exceptions

ExceptionCondition
ActiveDirectoryErrorException An Active Directory error.
BackupNotFoundException No Amazon FSx backups were found based upon the supplied parameters.
BadRequestException A generic error indicating a failure with a client request.
IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
InternalServerErrorException A generic error indicating a server-side failure.
InvalidNetworkSettingsException One or more network settings specified in the request are invalid.
InvalidPerUnitStorageThroughputException An invalid value for PerUnitStorageThroughput was provided. Please create your file system again, using a valid value.
MissingFileSystemConfigurationException A file system configuration is required for this operation.
ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer

See Also