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) |
Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-DiskIopsConfiguration_Iops <Int64>
The total number of SSD IOPS provisioned for the file system.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | OpenZFSConfiguration_DiskIopsConfiguration_Iops |
Specifies whether the number of IOPS for the file system is using the system default (AUTOMATIC
) or was provisioned by the customer (USER_PROVISIONED
).
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | OpenZFSConfiguration_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
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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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) |
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) |
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_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) |
Aliases | OpenZFSConfiguration_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) |
Aliases | OpenZFSConfiguration_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) |
Aliases | OpenZFSConfiguration_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) |
Specifies the file system deployment type. Single AZ deployment types are configured for redundancy within a single Availability Zone in an Amazon Web Services Region . Valid values are the following:
SINGLE_AZ_1
- (Default) Creates file systems with throughput capacities of 64 - 4,096 MB/s. Single_AZ_1
is available in all Amazon Web Services Regions where Amazon FSx for OpenZFS is available, except US West (Oregon).SINGLE_AZ_2
- Creates file systems with throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache. Single_AZ_2
is available only in the US East (N. Virginia), US East (Ohio), US West (Oregon), and Europe (Ireland) Amazon Web Services Regions.
For more information, see:
Deployment type availability and
File system performance in the
Amazon FSx for OpenZFS User Guide.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-OpenZFSConfiguration_ThroughputCapacity <
Int32>
Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MB/s). Valid values depend on the DeploymentType you choose, as follows:
- For
SINGLE_AZ_1
, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s. - For
SINGLE_AZ_2
, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MB/s.
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) |
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) |
-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) |
Aliases | OpenZFSConfiguration_RootVolumeConfiguration_CopyTagsToSnapshots |
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) |
Aliases | OpenZFSConfiguration_RootVolumeConfiguration_DataCompressionType |
The configuration object for mounting a file system.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | OpenZFSConfiguration_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) |
Aliases | OpenZFSConfiguration_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) |
Aliases | OpenZFSConfiguration_RootVolumeConfiguration_RecordSizeKiB |
An object specifying how much storage users or groups can use on the volume.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | OpenZFSConfiguration_RootVolumeConfiguration_UserAndGroupQuotas |
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) |
Aliases | SecurityGroupIds |
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) |
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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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) |
Aliases | SubnetIds |
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) |
Aliases | Tags |
The configuration for this Microsoft Windows file system.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |