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 CreateVolume API operation.

Syntax

New-FSXVolume
-Name <String>
-ClientRequestToken <String>
-TieringPolicy_CoolingPeriod <Int32>
-OriginSnapshot_CopyStrategy <OpenZFSCopyStrategy>
-OntapConfiguration_CopyTagsToBackup <Boolean>
-OpenZFSConfiguration_CopyTagsToSnapshot <Boolean>
-OpenZFSConfiguration_DataCompressionType <OpenZFSDataCompressionType>
-OntapConfiguration_JunctionPath <String>
-TieringPolicy_Name <TieringPolicyName>
-OpenZFSConfiguration_NfsExport <OpenZFSNfsExport[]>
-OntapConfiguration_OntapVolumeType <InputOntapVolumeType>
-OpenZFSConfiguration_ParentVolumeId <String>
-OpenZFSConfiguration_ReadOnly <Boolean>
-OpenZFSConfiguration_RecordSizeKiB <Int32>
-OntapConfiguration_SecurityStyle <SecurityStyle>
-OntapConfiguration_SizeInMegabyte <Int32>
-OriginSnapshot_SnapshotARN <String>
-OntapConfiguration_SnapshotPolicy <String>
-OpenZFSConfiguration_StorageCapacityQuotaGiB <Int32>
-OpenZFSConfiguration_StorageCapacityReservationGiB <Int32>
-OntapConfiguration_StorageEfficiencyEnabled <Boolean>
-OntapConfiguration_StorageVirtualMachineId <String>
-Tag <Tag[]>
-OpenZFSConfiguration_UserAndGroupQuota <OpenZFSUserOrGroupQuota[]>
-VolumeType <VolumeType>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonFSxConfig>

Description

Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.

Parameters

-ClientConfig <AmazonFSxConfig>
Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientRequestToken <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)
-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)
-Name <String>
Specifies the name of the volume that you're creating.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-OntapConfiguration_CopyTagsToBackup <Boolean>
A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume 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 volume, regardless of this value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOntapConfiguration_CopyTagsToBackups
-OntapConfiguration_JunctionPath <String>
Specifies the location in the SVM's namespace where the volume is mounted. The JunctionPath must have a leading forward slash, such as /vol3.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OntapConfiguration_OntapVolumeType <InputOntapVolumeType>
Specifies the type of volume you are creating. Valid values are the following:
  • RW specifies a read/write volume. RW is the default.
  • DP specifies a data-protection volume. A DP volume is read-only and can be used as the destination of a NetApp SnapMirror relationship.
For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OntapConfiguration_SecurityStyle <SecurityStyle>
Specifies the security style for the volume. If a volume's security style is not specified, it is automatically set to the root volume's security style. The security style determines the type of permissions that FSx for ONTAP uses to control data access. For more information, see Volume security style in the Amazon FSx for NetApp ONTAP User Guide. Specify one of the following values:
  • UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.
  • NTFS if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.
  • MIXED if the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OntapConfiguration_SizeInMegabyte <Int32>
Specifies the size of the volume, in megabytes (MB), that you are creating.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOntapConfiguration_SizeInMegabytes
-OntapConfiguration_SnapshotPolicy <String>
Specifies the snapshot policy for the volume. There are three built-in snapshot policies:
  • default: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.
  • default-1weekly: This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.
  • none: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.
You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OntapConfiguration_StorageEfficiencyEnabled <Boolean>
Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OntapConfiguration_StorageVirtualMachineId <String>
Specifies the ONTAP SVM in which to create the volume.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OpenZFSConfiguration_CopyTagsToSnapshot <Boolean>
A Boolean value indicating whether tags for the volume should be copied to snapshots. 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_CopyTagsToSnapshots
-OpenZFSConfiguration_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. ZSTD compression provides a higher level of data compression and higher read throughput performance than LZ4 compression.
  • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. LZ4 compression provides a lower level of compression and higher write throughput performance than ZSTD compression.
For more information about volume compression types and the performance of your Amazon FSx for OpenZFS file system, see Tips for maximizing performance File system and volume settings in the Amazon FSx for OpenZFS User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OpenZFSConfiguration_NfsExport <OpenZFSNfsExport[]>
The configuration object for mounting a Network File System (NFS) file system.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOpenZFSConfiguration_NfsExports
-OpenZFSConfiguration_ParentVolumeId <String>
The ID of the volume to use as the parent volume of the volume that you are creating.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OpenZFSConfiguration_ReadOnly <Boolean>
A Boolean value indicating whether the volume is read-only.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OpenZFSConfiguration_RecordSizeKiB <Int32>
Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. We recommend using the default setting for the majority of use cases. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads (small record size) or media streaming workloads (large record size). For additional guidance on when to set a custom record size, see ZFS Record size in the Amazon FSx for OpenZFS User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OpenZFSConfiguration_StorageCapacityQuotaGiB <Int32>
Sets the maximum storage size in gibibytes (GiB) for the volume. You can specify a quota that is larger than the storage on the parent volume. A volume quota limits the amount of storage that the volume can consume to the configured amount, but does not guarantee the space will be available on the parent volume. To guarantee quota space, you must also set StorageCapacityReservationGiB. To not specify a storage capacity quota, set this to -1. For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OpenZFSConfiguration_StorageCapacityReservationGiB <Int32>
Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. Setting StorageCapacityReservationGiB guarantees that the specified amount of storage space on the parent volume will always be available for the volume. You can't reserve more storage than the parent volume has. To not specify a storage capacity reservation, set this to 0 or -1. For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OpenZFSConfiguration_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_UserAndGroupQuotas
-OriginSnapshot_CopyStrategy <OpenZFSCopyStrategy>
The strategy used when copying data from the snapshot to the new volume.
  • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.
  • FULL_COPY - Copies all data from the snapshot to the new volume.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOpenZFSConfiguration_OriginSnapshot_CopyStrategy
-OriginSnapshot_SnapshotARN <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)
AliasesOpenZFSConfiguration_OriginSnapshot_SnapshotARN
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Volume'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.CreateVolumeResponse). Specifying the name of a property of type Amazon.FSx.Model.CreateVolumeResponse 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)
-Tag <Tag[]>
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)
AliasesTags
-TieringPolicy_CoolingPeriod <Int32>
Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOntapConfiguration_TieringPolicy_CoolingPeriod
-TieringPolicy_Name <TieringPolicyName>
Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY.
  • SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.
  • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
  • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
  • NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOntapConfiguration_TieringPolicy_Name
-VolumeType <VolumeType>
Specifies the type of volume to create; ONTAP and OPENZFS are the only valid volume types.
Required?True
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.Volume or Amazon.FSx.Model.CreateVolumeResponse
This cmdlet returns an Amazon.FSx.Model.Volume object. The service call response (type Amazon.FSx.Model.CreateVolumeResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
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