AWS Tools for Windows PowerShell
Command 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.

Synopsis

Calls the Amazon FSx CreateFileSystemFromBackup API operation.

Syntax

New-FSXFileSystemFromBackup
-BackupId <String>
-OpenZFSConfiguration_AutomaticBackupRetentionDay <Int32>
-ClientRequestToken <String>
-OpenZFSConfiguration_CopyTagsToBackup <Boolean>
-RootVolumeConfiguration_CopyTagsToSnapshot <Boolean>
-OpenZFSConfiguration_CopyTagsToVolume <Boolean>
-OpenZFSConfiguration_DailyAutomaticBackupStartTime <String>
-RootVolumeConfiguration_DataCompressionType <OpenZFSDataCompressionType>
-OpenZFSConfiguration_DeploymentType <OpenZFSDeploymentType>
-OpenZFSConfiguration_EndpointIpAddressRange <String>
-OpenZFSConfiguration_EndpointIpv6AddressRange <String>
-FileSystemTypeVersion <String>
-DiskIopsConfiguration_Iops <Int64>
-KmsKeyId <String>
-LustreConfiguration <CreateFileSystemLustreConfiguration>
-DiskIopsConfiguration_Mode <DiskIopsConfigurationMode>
-NetworkType <NetworkType>
-RootVolumeConfiguration_NfsExport <OpenZFSNfsExport[]>
-OpenZFSConfiguration_PreferredSubnetId <String>
-RootVolumeConfiguration_ReadOnly <Boolean>
-RootVolumeConfiguration_RecordSizeKiB <Int32>
-OpenZFSConfiguration_RouteTableId <String[]>
-SecurityGroupId <String[]>
-ReadCacheConfiguration_SizeGiB <Int32>
-ReadCacheConfiguration_SizingMode <OpenZFSReadCacheSizingMode>
-StorageCapacity <Int32>
-StorageType <StorageType>
-SubnetId <String[]>
-Tag <Tag[]>
-OpenZFSConfiguration_ThroughputCapacity <Int32>
-RootVolumeConfiguration_UserAndGroupQuota <OpenZFSUserOrGroupQuota[]>
-OpenZFSConfiguration_WeeklyMaintenanceStartTime <String>
-WindowsConfiguration <CreateFileSystemWindowsConfiguration>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonFSxConfig>

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.

Parameters

-BackupId <String>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ClientConfig <AmazonFSxConfig>
Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientRequestToken <String>
A string of up to 63 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DiskIopsConfiguration_Iops <Int64>
The total number of SSD IOPS provisioned for the file system.The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOpenZFSConfiguration_DiskIopsConfiguration_Iops
-DiskIopsConfiguration_Mode <DiskIopsConfigurationMode>
Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOpenZFSConfiguration_DiskIopsConfiguration_Mode
-FileSystemTypeVersion <String>
Sets the version for the Amazon FSx for Lustre file system that you're creating from a backup. Valid values are 2.10, 2.12, and 2.15.You can enter a Lustre version that is newer than the backup's FileSystemTypeVersion setting. If you don't enter a newer Lustre version, it defaults to the backup's setting.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KmsKeyId <String>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LustreConfiguration <CreateFileSystemLustreConfiguration>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkType <NetworkType>
Sets the network type for the Amazon FSx for OpenZFS file system that you're creating from a backup.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OpenZFSConfiguration_AutomaticBackupRetentionDay <Int32>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOpenZFSConfiguration_AutomaticBackupRetentionDays
-OpenZFSConfiguration_CopyTagsToBackup <Boolean>
A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOpenZFSConfiguration_CopyTagsToBackups
-OpenZFSConfiguration_CopyTagsToVolume <Boolean>
A Boolean value indicating whether tags for the file system should be copied to volumes. This value defaults to false. If it's set to true, all tags for the file system are copied to volumes where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to volumes. If you specify one or more tags when creating the volume, no tags are copied from the file system, regardless of this value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOpenZFSConfiguration_CopyTagsToVolumes
-OpenZFSConfiguration_DailyAutomaticBackupStartTime <String>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OpenZFSConfiguration_DeploymentType <OpenZFSDeploymentType>
Specifies the file system deployment type. Valid values are the following:
  • MULTI_AZ_1- Creates file systems with high availability and durability by replicating your data and supporting failover across multiple Availability Zones in the same Amazon Web Services Region.
  • SINGLE_AZ_HA_2- Creates file systems with high availability and throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache by deploying a primary and standby file system within the same Availability Zone.
  • SINGLE_AZ_HA_1- Creates file systems with high availability and throughput capacities of 64 - 4,096 MB/s by deploying a primary and standby file system within the same Availability Zone.
  • SINGLE_AZ_2- Creates file systems with throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache that automatically recover within a single Availability Zone.
  • SINGLE_AZ_1- Creates file systems with throughput capacities of 64 - 4,096 MBs that automatically recover within a single Availability Zone.
For a list of which Amazon Web Services Regions each deployment type is available in, see Deployment type availability. For more information on the differences in performance between deployment types, see File system performance in the Amazon FSx for OpenZFS User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OpenZFSConfiguration_EndpointIpAddressRange <String>
(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables, as long as they don't overlap with any subnet.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OpenZFSConfiguration_EndpointIpv6AddressRange <String>
(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /118 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables, as long as they don't overlap with any subnet.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OpenZFSConfiguration_PreferredSubnetId <String>
Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OpenZFSConfiguration_RouteTableId <String[]>
(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOpenZFSConfiguration_RouteTableIds
-OpenZFSConfiguration_ThroughputCapacity <Int32>
Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps). Valid values depend on the DeploymentType that you choose, as follows:
  • For MULTI_AZ_1 and SINGLE_AZ_2, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MBps.
  • For SINGLE_AZ_1, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MBps.
You pay for additional throughput capacity that you provision.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OpenZFSConfiguration_WeeklyMaintenanceStartTime <String>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the BackupId parameter. The -PassThru parameter is deprecated, use -Select '^BackupId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReadCacheConfiguration_SizeGiB <Int32>
Required if SizingMode is set to USER_PROVISIONED. Specifies the size of the file system's SSD read cache, in gibibytes (GiB).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOpenZFSConfiguration_ReadCacheConfiguration_SizeGiB
-ReadCacheConfiguration_SizingMode <OpenZFSReadCacheSizingMode>
Specifies how the provisioned SSD read cache is sized, as follows:
  • Set to NO_CACHE if you do not want to use an SSD read cache with your Intelligent-Tiering file system.
  • Set to USER_PROVISIONED to specify the exact size of your SSD read cache.
  • Set to PROPORTIONAL_TO_THROUGHPUT_CAPACITY to have your SSD read cache automatically sized based on your throughput capacity.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOpenZFSConfiguration_ReadCacheConfiguration_SizingMode
-RootVolumeConfiguration_CopyTagsToSnapshot <Boolean>
A Boolean value indicating whether tags for the volume should be copied to snapshots of the volume. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOpenZFSConfiguration_RootVolumeConfiguration_CopyTagsToSnapshots
-RootVolumeConfiguration_DataCompressionType <OpenZFSDataCompressionType>
Specifies the method used to compress the data on the volume. The compression type is NONE by default.
  • NONE - Doesn't compress the data on the volume. NONE is the default.
  • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
  • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOpenZFSConfiguration_RootVolumeConfiguration_DataCompressionType
-RootVolumeConfiguration_NfsExport <OpenZFSNfsExport[]>
The configuration object for mounting a file system.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOpenZFSConfiguration_RootVolumeConfiguration_NfsExports
-RootVolumeConfiguration_ReadOnly <Boolean>
A Boolean value indicating whether the volume is read-only. Setting this value to true can be useful after you have completed changes to a volume and no longer want changes to occur.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOpenZFSConfiguration_RootVolumeConfiguration_ReadOnly
-RootVolumeConfiguration_RecordSizeKiB <Int32>
Specifies the record size of an OpenZFS root volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on setting a custom record size, see Tips for maximizing performance in the Amazon FSx for OpenZFS User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOpenZFSConfiguration_RootVolumeConfiguration_RecordSizeKiB
-RootVolumeConfiguration_UserAndGroupQuota <OpenZFSUserOrGroupQuota[]>
An object specifying how much storage users or groups can use on the volume.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOpenZFSConfiguration_RootVolumeConfiguration_UserAndGroupQuotas
-SecurityGroupId <String[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSecurityGroupIds
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'FileSystem'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.CreateFileSystemFromBackupResponse). Specifying the name of a property of type Amazon.FSx.Model.CreateFileSystemFromBackupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageCapacity <Int32>
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 an HTTP status code 400 Bad Request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageType <StorageType>
Sets the storage type for the Windows, OpenZFS, or Lustre file system that you're creating from a backup. Valid values are SSD, HDD, and INTELLIGENT_TIERING.
  • 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.
  • Set to INTELLIGENT_TIERING to use fully elastic, intelligently-tiered storage. Intelligent-Tiering is only available for OpenZFS file systems with the Multi-AZ deployment type and for Lustre file systems with the Persistent_2 deployment type.
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SubnetId <String[]>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSubnetIds
-Tag <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-WindowsConfiguration <CreateFileSystemWindowsConfiguration>
The configuration for this Microsoft Windows file system.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.FSx.Model.FileSystem or Amazon.FSx.Model.CreateFileSystemFromBackupResponse
This cmdlet returns an Amazon.FSx.Model.FileSystem object. The service call response (type Amazon.FSx.Model.CreateFileSystemFromBackupResponse) can be returned by specifying '-Select *'.

Examples

Example 1

New-FSXFileSystemFromBackup -BackupId $backupID -Tag @{Key="tag:Name";Value="from-manual-backup"} -SubnetId $SubnetID -SecurityGroupId $SG_ID -WindowsConfiguration @{ThroughputCapacity=8;ActiveDirectoryId=$DirectoryID}

CreationTime         : 8/8/2019 12:59:58 PM
DNSName              : fs-012ff34e56789120.ktmsad.local
FailureDetails       :
FileSystemId         : fs-012ff34e56789120
FileSystemType       : WINDOWS
KmsKeyId             : arn:aws:kms:eu-west-1:123456789012:key/f1af23c4-5b67-1bde-a2f3-e4567c8a9321
Lifecycle            : CREATING
LustreConfiguration  :
NetworkInterfaceIds  : {}
OwnerId              : 933303704102
ResourceARN          : arn:aws:fsx:eu-west-1:123456789012:file-system/fs-012ff34e56789120
StorageCapacity      : 300
SubnetIds            : {subnet-fa1ae23c}
Tags                 : {tag:Name}
VpcId                : vpc-12cf3b4f
WindowsConfiguration : Amazon.FSx.Model.WindowsFileSystemConfiguration
This exmaple creates new Amazon FSx file system from an existing Amazon FSx for Windows File Server backup.
Amazon FSx for Windows File Server User Guide
Amazon FSx for Lustre User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z