Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.FSx.CreateFileSystemFromBackup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

Creating a Request

data CreateFileSystemFromBackup Source #

The request object for the CreateFileSystemFromBackup operation.

See: newCreateFileSystemFromBackup smart constructor.

Constructors

CreateFileSystemFromBackup'

Fields

clientRequestToken :: Maybe Text
A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
fileSystemTypeVersion :: Maybe Text
Sets the version for the Amazon FSx for Lustre file system that you're creating from a backup. Valid values are 2.10 and 2.12.
You don't need to specify FileSystemTypeVersion because it will be applied using the backup's FileSystemTypeVersion setting. If you choose to specify FileSystemTypeVersion when creating from backup, the value must match the backup's FileSystemTypeVersion setting.
kmsKeyId :: Maybe Text
lustreConfiguration :: Maybe CreateFileSystemLustreConfiguration
openZFSConfiguration :: Maybe CreateFileSystemOpenZFSConfiguration
The OpenZFS configuration for the file system that's being created.
securityGroupIds :: Maybe [Text]
A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups apply to all network interfaces. This value isn't returned in later DescribeFileSystem requests.
storageCapacity :: Maybe Natural
Sets the storage capacity of the OpenZFS file system that you're creating from a backup, in gibibytes (GiB). Valid values are from 64 GiB up to 524,288 GiB (512 TiB). However, the value that you specify must be equal to or greater than the backup's storage capacity value. If you don't use the StorageCapacity parameter, the default is the backup's StorageCapacity value.
If used to create a file system other than OpenZFS, you must provide a value that matches the backup's StorageCapacity value. If you provide any other value, Amazon FSx responds with a 400 Bad Request.
storageType :: Maybe StorageType
Sets the storage type for the Windows or OpenZFS file system that you're creating from a backup. Valid values are SSD and HDD.
- Set to SSD to use solid state drive storage. SSD is supported on all Windows and OpenZFS deployment types.
- Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 FSx for Windows File Server file system deployment types.
The default value is SSD.
HDD and SSD storage types have different minimum storage capacity requirements. A restored file system's storage capacity is tied to the file system that was backed up. You can create a file system that uses HDD storage from a backup of a file system that used SSD storage if the original SSD file system had a storage capacity of at least 2000 GiB.
tags :: Maybe (NonEmpty Tag)
The tags to be applied to the file system at file system creation. The key value of the Name tag appears in the console as the file system name.
windowsConfiguration :: Maybe CreateFileSystemWindowsConfiguration
The configuration for this Microsoft Windows file system.
backupId :: Text
subnetIds :: [Text]
Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1 file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID property.
Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system deployment types, Lustre file systems, and OpenZFS file systems provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.

Instances

Instances details

ToJSON CreateFileSystemFromBackup Source #
Instance details Defined in Amazonka.FSx.CreateFileSystemFromBackup Methods toJSON :: CreateFileSystemFromBackup -> Value # toEncoding :: CreateFileSystemFromBackup -> Encoding # toJSONList :: [CreateFileSystemFromBackup] -> Value # toEncodingList :: [CreateFileSystemFromBackup] -> Encoding #
ToHeaders CreateFileSystemFromBackup Source #
Instance details Defined in Amazonka.FSx.CreateFileSystemFromBackup Methods toHeaders :: CreateFileSystemFromBackup -> [Header] #
ToPath CreateFileSystemFromBackup Source #
Instance details Defined in Amazonka.FSx.CreateFileSystemFromBackup Methods toPath :: CreateFileSystemFromBackup -> ByteString #
ToQuery CreateFileSystemFromBackup Source #
Instance details Defined in Amazonka.FSx.CreateFileSystemFromBackup Methods toQuery :: CreateFileSystemFromBackup -> QueryString #
AWSRequest CreateFileSystemFromBackup Source #
Instance details Defined in Amazonka.FSx.CreateFileSystemFromBackup Associated Types type AWSResponse CreateFileSystemFromBackup # Methods request :: (Service -> Service) -> CreateFileSystemFromBackup -> Request CreateFileSystemFromBackup # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateFileSystemFromBackup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateFileSystemFromBackup))) #
Generic CreateFileSystemFromBackup Source #
Instance details Defined in Amazonka.FSx.CreateFileSystemFromBackup Associated Types type Rep CreateFileSystemFromBackup :: Type -> Type # Methods from :: CreateFileSystemFromBackup -> Rep CreateFileSystemFromBackup x # to :: Rep CreateFileSystemFromBackup x -> CreateFileSystemFromBackup #
Show CreateFileSystemFromBackup Source #
Instance details Defined in Amazonka.FSx.CreateFileSystemFromBackup Methods showsPrec :: Int -> CreateFileSystemFromBackup -> ShowS # show :: CreateFileSystemFromBackup -> String # showList :: [CreateFileSystemFromBackup] -> ShowS #
NFData CreateFileSystemFromBackup Source #
Instance details Defined in Amazonka.FSx.CreateFileSystemFromBackup Methods rnf :: CreateFileSystemFromBackup -> () #
Eq CreateFileSystemFromBackup Source #
Instance details Defined in Amazonka.FSx.CreateFileSystemFromBackup Methods (==) :: CreateFileSystemFromBackup -> CreateFileSystemFromBackup -> Bool # (/=) :: CreateFileSystemFromBackup -> CreateFileSystemFromBackup -> Bool #
Hashable CreateFileSystemFromBackup Source #
Instance details Defined in Amazonka.FSx.CreateFileSystemFromBackup Methods hashWithSalt :: Int -> CreateFileSystemFromBackup -> Int # hash :: CreateFileSystemFromBackup -> Int #
type AWSResponse CreateFileSystemFromBackup Source #
Instance details Defined in Amazonka.FSx.CreateFileSystemFromBackup type AWSResponse CreateFileSystemFromBackup = CreateFileSystemFromBackupResponse
type Rep CreateFileSystemFromBackup Source #
Instance details Defined in Amazonka.FSx.CreateFileSystemFromBackup type Rep CreateFileSystemFromBackup = D1 ('MetaData "CreateFileSystemFromBackup" "Amazonka.FSx.CreateFileSystemFromBackup" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "CreateFileSystemFromBackup'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "fileSystemTypeVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "lustreConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CreateFileSystemLustreConfiguration)) :: (S1 ('MetaSel ('Just "openZFSConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CreateFileSystemOpenZFSConfiguration)) :: S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :: ((S1 ('MetaSel ('Just "storageCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "storageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StorageType)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))))) :: (S1 ('MetaSel ('Just "windowsConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CreateFileSystemWindowsConfiguration)) :: (S1 ('MetaSel ('Just "backupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))))

newCreateFileSystemFromBackup Source #

Arguments

:: Text	`CreateFileSystemFromBackup`
-> CreateFileSystemFromBackup

Create a value of CreateFileSystemFromBackup with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientRequestToken:CreateFileSystemFromBackup', createFileSystemFromBackup_clientRequestToken - A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

CreateFileSystemFromBackup, createFileSystemFromBackup_fileSystemTypeVersion - Sets the version for the Amazon FSx for Lustre file system that you're creating from a backup. Valid values are 2.10 and 2.12.

You don't need to specify FileSystemTypeVersion because it will be applied using the backup's FileSystemTypeVersion setting. If you choose to specify FileSystemTypeVersion when creating from backup, the value must match the backup's FileSystemTypeVersion setting.

CreateFileSystemFromBackup, createFileSystemFromBackup_kmsKeyId - Undocumented member.

CreateFileSystemFromBackup, createFileSystemFromBackup_lustreConfiguration - Undocumented member.

CreateFileSystemFromBackup, createFileSystemFromBackup_openZFSConfiguration - The OpenZFS configuration for the file system that's being created.

$sel:securityGroupIds:CreateFileSystemFromBackup', createFileSystemFromBackup_securityGroupIds - A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups apply to all network interfaces. This value isn't returned in later DescribeFileSystem requests.

CreateFileSystemFromBackup, createFileSystemFromBackup_storageCapacity - Sets the storage capacity of the OpenZFS file system that you're creating from a backup, in gibibytes (GiB). Valid values are from 64 GiB up to 524,288 GiB (512 TiB). However, the value that you specify must be equal to or greater than the backup's storage capacity value. If you don't use the StorageCapacity parameter, the default is the backup's StorageCapacity value.

If used to create a file system other than OpenZFS, you must provide a value that matches the backup's StorageCapacity value. If you provide any other value, Amazon FSx responds with a 400 Bad Request.

CreateFileSystemFromBackup, createFileSystemFromBackup_storageType - Sets the storage type for the Windows or OpenZFS file system that you're creating from a backup. Valid values are SSD and HDD.

Set to SSD to use solid state drive storage. SSD is supported on all Windows and OpenZFS deployment types.
Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 FSx for Windows File Server file system deployment types.

The default value is SSD.

HDD and SSD storage types have different minimum storage capacity requirements. A restored file system's storage capacity is tied to the file system that was backed up. You can create a file system that uses HDD storage from a backup of a file system that used SSD storage if the original SSD file system had a storage capacity of at least 2000 GiB.

CreateFileSystemFromBackup, createFileSystemFromBackup_tags - The tags to be applied to the file system at file system creation. The key value of the Name tag appears in the console as the file system name.

CreateFileSystemFromBackup, createFileSystemFromBackup_windowsConfiguration - The configuration for this Microsoft Windows file system.

CreateFileSystemFromBackup, createFileSystemFromBackup_backupId - Undocumented member.

CreateFileSystemFromBackup, createFileSystemFromBackup_subnetIds - Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1 file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID property.

Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system deployment types, Lustre file systems, and OpenZFS file systems provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.

Request Lenses

createFileSystemFromBackup_clientRequestToken :: Lens' CreateFileSystemFromBackup (Maybe Text) Source #

A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

createFileSystemFromBackup_fileSystemTypeVersion :: Lens' CreateFileSystemFromBackup (Maybe Text) Source #

Sets the version for the Amazon FSx for Lustre file system that you're creating from a backup. Valid values are 2.10 and 2.12.

You don't need to specify FileSystemTypeVersion because it will be applied using the backup's FileSystemTypeVersion setting. If you choose to specify FileSystemTypeVersion when creating from backup, the value must match the backup's FileSystemTypeVersion setting.

createFileSystemFromBackup_kmsKeyId :: Lens' CreateFileSystemFromBackup (Maybe Text) Source #

Undocumented member.

createFileSystemFromBackup_lustreConfiguration :: Lens' CreateFileSystemFromBackup (Maybe CreateFileSystemLustreConfiguration) Source #

Undocumented member.

createFileSystemFromBackup_openZFSConfiguration :: Lens' CreateFileSystemFromBackup (Maybe CreateFileSystemOpenZFSConfiguration) Source #

The OpenZFS configuration for the file system that's being created.

createFileSystemFromBackup_securityGroupIds :: Lens' CreateFileSystemFromBackup (Maybe [Text]) Source #

A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups apply to all network interfaces. This value isn't returned in later DescribeFileSystem requests.

createFileSystemFromBackup_storageCapacity :: Lens' CreateFileSystemFromBackup (Maybe Natural) Source #

Sets the storage capacity of the OpenZFS file system that you're creating from a backup, in gibibytes (GiB). Valid values are from 64 GiB up to 524,288 GiB (512 TiB). However, the value that you specify must be equal to or greater than the backup's storage capacity value. If you don't use the StorageCapacity parameter, the default is the backup's StorageCapacity value.

If used to create a file system other than OpenZFS, you must provide a value that matches the backup's StorageCapacity value. If you provide any other value, Amazon FSx responds with a 400 Bad Request.

createFileSystemFromBackup_storageType :: Lens' CreateFileSystemFromBackup (Maybe StorageType) Source #

Sets the storage type for the Windows or OpenZFS file system that you're creating from a backup. Valid values are SSD and HDD.

Set to SSD to use solid state drive storage. SSD is supported on all Windows and OpenZFS deployment types.
Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 FSx for Windows File Server file system deployment types.

The default value is SSD.

HDD and SSD storage types have different minimum storage capacity requirements. A restored file system's storage capacity is tied to the file system that was backed up. You can create a file system that uses HDD storage from a backup of a file system that used SSD storage if the original SSD file system had a storage capacity of at least 2000 GiB.

createFileSystemFromBackup_tags :: Lens' CreateFileSystemFromBackup (Maybe (NonEmpty Tag)) Source #

The tags to be applied to the file system at file system creation. The key value of the Name tag appears in the console as the file system name.

createFileSystemFromBackup_windowsConfiguration :: Lens' CreateFileSystemFromBackup (Maybe CreateFileSystemWindowsConfiguration) Source #

The configuration for this Microsoft Windows file system.

createFileSystemFromBackup_backupId :: Lens' CreateFileSystemFromBackup Text Source #

Undocumented member.

createFileSystemFromBackup_subnetIds :: Lens' CreateFileSystemFromBackup [Text] Source #

Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1 file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID property.

Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system deployment types, Lustre file systems, and OpenZFS file systems provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.

Destructuring the Response

data CreateFileSystemFromBackupResponse Source #

The response object for the CreateFileSystemFromBackup operation.

See: newCreateFileSystemFromBackupResponse smart constructor.

Constructors

CreateFileSystemFromBackupResponse'
Fields fileSystem :: Maybe FileSystem A description of the file system. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateFileSystemFromBackupResponse Source #
Instance details Defined in Amazonka.FSx.CreateFileSystemFromBackup Associated Types type Rep CreateFileSystemFromBackupResponse :: Type -> Type # Methods from :: CreateFileSystemFromBackupResponse -> Rep CreateFileSystemFromBackupResponse x # to :: Rep CreateFileSystemFromBackupResponse x -> CreateFileSystemFromBackupResponse #
Read CreateFileSystemFromBackupResponse Source #
Instance details Defined in Amazonka.FSx.CreateFileSystemFromBackup Methods readsPrec :: Int -> ReadS CreateFileSystemFromBackupResponse # readList :: ReadS [CreateFileSystemFromBackupResponse] # readPrec :: ReadPrec CreateFileSystemFromBackupResponse # readListPrec :: ReadPrec [CreateFileSystemFromBackupResponse] #
Show CreateFileSystemFromBackupResponse Source #
Instance details Defined in Amazonka.FSx.CreateFileSystemFromBackup Methods showsPrec :: Int -> CreateFileSystemFromBackupResponse -> ShowS # show :: CreateFileSystemFromBackupResponse -> String # showList :: [CreateFileSystemFromBackupResponse] -> ShowS #
NFData CreateFileSystemFromBackupResponse Source #
Instance details Defined in Amazonka.FSx.CreateFileSystemFromBackup Methods rnf :: CreateFileSystemFromBackupResponse -> () #
Eq CreateFileSystemFromBackupResponse Source #
Instance details Defined in Amazonka.FSx.CreateFileSystemFromBackup Methods (==) :: CreateFileSystemFromBackupResponse -> CreateFileSystemFromBackupResponse -> Bool # (/=) :: CreateFileSystemFromBackupResponse -> CreateFileSystemFromBackupResponse -> Bool #
type Rep CreateFileSystemFromBackupResponse Source #
Instance details Defined in Amazonka.FSx.CreateFileSystemFromBackup type Rep CreateFileSystemFromBackupResponse = D1 ('MetaData "CreateFileSystemFromBackupResponse" "Amazonka.FSx.CreateFileSystemFromBackup" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "CreateFileSystemFromBackupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fileSystem") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FileSystem)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateFileSystemFromBackupResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateFileSystemFromBackupResponse'`
-> CreateFileSystemFromBackupResponse

Create a value of CreateFileSystemFromBackupResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateFileSystemFromBackupResponse, createFileSystemFromBackupResponse_fileSystem - A description of the file system.

$sel:httpStatus:CreateFileSystemFromBackupResponse', createFileSystemFromBackupResponse_httpStatus - The response's http status code.

Response Lenses

createFileSystemFromBackupResponse_fileSystem :: Lens' CreateFileSystemFromBackupResponse (Maybe FileSystem) Source #

A description of the file system.

createFileSystemFromBackupResponse_httpStatus :: Lens' CreateFileSystemFromBackupResponse Int Source #

The response's http status code.