IAmazonFSx.CreateFileSystemFromBackup Method (CreateFileSystemFromBackupRequest)

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:

Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the file system.

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:

For .NET Core this operation is only available in asynchronous form. Please refer to CreateFileSystemFromBackupAsync.

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

Syntax

public abstract CreateFileSystemFromBackupResponse CreateFileSystemFromBackup(
         CreateFileSystemFromBackupRequest request
)

Parameters

request: Type: Amazon.FSx.Model.CreateFileSystemFromBackupRequest

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

Return Value

Type: CreateFileSystemFromBackupResponse

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

Exceptions

Exception	Condition
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.

Examples

This operation creates a new file system from backup.

To create a new file system from backup


var client = new AmazonFSxClient();
var response = client.CreateFileSystemFromBackup(new CreateFileSystemFromBackupRequest 
{
    BackupId = "backup-03e3c82e0183b7b6b",
    ClientRequestToken = "f4c94ed7-238d-4c46-93db-48cd62ec33b7",
    SecurityGroupIds = new List<string> {
        "sg-edcd9784"
    },
    SubnetIds = new List<string> {
        "subnet-1234abcd"
    },
    Tags = new List<Tag> {
        new Tag {
            Key = "Name",
            Value = "MyFileSystem"
        }
    },
    WindowsConfiguration = new CreateFileSystemWindowsConfiguration { ThroughputCapacity = 8 }
});

FileSystem fileSystem = response.FileSystem;

Version Information

.NET Framework:
Supported in: 4.7.2 and newer

IAmazonFSx.CreateFileSystemFromBackup (CreateFileSystemFromBackupRequest)

Method