AWS.Tools.FSx.dll-Help.xml
|
<helpItems schema="maml"><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Register-FSXFileSystemAlias</name><description><para>Calls the Amazon FSx AssociateFileSystemAliases API operation.</para></description><verb>Register</verb><noun>FSXFileSystemAlias</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Use this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows File Server file system. A file system can have a maximum of 50 DNS aliases associated with it at any one time. If you try to associate a DNS alias that is already associated with the file system, FSx takes no action on that alias in the request. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html">Working with DNS Aliases</a> and <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/walkthrough05-file-system-custom-CNAME.html">Walkthrough 5: Using DNS aliases to access your file system</a>, including additional steps you must take to be able to access your file system using a DNS alias.
The system response shows the DNS aliases that Amazon FSx is attempting to associate with the file system. Use the API operation to monitor the status of the aliases Amazon FSx is associating with the file system. </para></description><syntax><syntaxItem><name>Register-FSXFileSystemAlias</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>FileSystemId</name><description><para>Specifies the file system with which you want to associate one or more DNS aliases. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Alias</name><description><para>An array of one or more DNS alias names to associate with the file system. The alias name has to comply with the following formatting requirements: - Formatted as a fully-qualified domain name (FQDN), <i><c>hostname.domain</c></i>, for example, <c>accounting.corp.example.com</c>. - Can contain alphanumeric characters and the hyphen (-). - Cannot start or end with a hyphen. - Can start with a numeric. For DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Aliases'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.AssociateFileSystemAliasesResponse). Specifying the name of a property of type Amazon.FSx.Model.AssociateFileSystemAliasesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the FileSystemId parameter. The -PassThru parameter is deprecated, use -Select '^FileSystemId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Alias</name><description><para>An array of one or more DNS alias names to associate with the file system. The alias name has to comply with the following formatting requirements: - Formatted as a fully-qualified domain name (FQDN), <i><c>hostname.domain</c></i>, for example, <c>accounting.corp.example.com</c>. - Can contain alphanumeric characters and the hyphen (-). - Cannot start or end with a hyphen. - Can start with a numeric. For DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>FileSystemId</name><description><para>Specifies the file system with which you want to associate one or more DNS aliases. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the FileSystemId parameter. The -PassThru parameter is deprecated, use -Select '^FileSystemId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Aliases'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.AssociateFileSystemAliasesResponse). Specifying the name of a property of type Amazon.FSx.Model.AssociateFileSystemAliasesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.Alias or Amazon.FSx.Model.AssociateFileSystemAliasesResponse</name><uri /><description /></type><description><para>This cmdlet returns a collection of Amazon.FSx.Model.Alias objects. The service call response (type Amazon.FSx.Model.AssociateFileSystemAliasesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Register-FSXFileSystemAlias.html&tocid=Register-FSXFileSystemAlias</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Start-FSXMisconfiguredStateRecovery</name><description><para>Calls the Amazon FSx StartMisconfiguredStateRecovery API operation.</para></description><verb>Start</verb><noun>FSXMisconfiguredStateRecovery</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>After performing steps to repair the Active Directory configuration of an FSx for Windows File Server file system, use this action to initiate the process of Amazon FSx attempting to reconnect to the file system. </para></description><syntax><syntaxItem><name>Start-FSXMisconfiguredStateRecovery</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>FileSystemId</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.StartMisconfiguredStateRecoveryResponse). Specifying the name of a property of type Amazon.FSx.Model.StartMisconfiguredStateRecoveryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the FileSystemId parameter. The -PassThru parameter is deprecated, use -Select '^FileSystemId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>FileSystemId</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the FileSystemId parameter. The -PassThru parameter is deprecated, use -Select '^FileSystemId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.StartMisconfiguredStateRecoveryResponse). Specifying the name of a property of type Amazon.FSx.Model.StartMisconfiguredStateRecoveryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.FileSystem or Amazon.FSx.Model.StartMisconfiguredStateRecoveryResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.FSx.Model.FileSystem object. The service call response (type Amazon.FSx.Model.StartMisconfiguredStateRecoveryResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Start-FSXMisconfiguredStateRecovery.html&tocid=Start-FSXMisconfiguredStateRecovery</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Get-FSXDataRepositoryAssociation</name><description><para>Calls the Amazon FSx DescribeDataRepositoryAssociations API operation.</para></description><verb>Get</verb><noun>FSXDataRepositoryAssociation</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository associations, if one or more <c>AssociationIds</c> values are provided in the request, or if filters are used in the request. Data repository associations are supported on Amazon File Cache resources and all FSx for Lustre 2.12 and 2,15 file systems, excluding <c>scratch_1</c> deployment type. You can use filters to narrow the response to include just data repository associations for specific file systems (use the <c>file-system-id</c> filter with the ID of the file system) or caches (use the <c>file-cache-id</c> filter with the ID of the cache), or data repository associations for a specific repository type (use the <c>data-repository-type</c> filter with a value of <c>S3</c> or <c>NFS</c>). If you don&#39;t use filters, the response returns all data repository associations owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you&#39;re calling. When retrieving all data repository associations, you can paginate the response by using the optional <c>MaxResults</c> parameter to limit the number of data repository associations returned in a response. If more data repository associations remain, a <c>NextToken</c> value is returned in the response. In this case, send a later request with the <c>NextToken</c> request parameter set to the value of <c>NextToken</c> from the last response. <br /><br />This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </para></description><syntax><syntaxItem><name>Get-FSXDataRepositoryAssociation</name><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AssociationId</name><description><para>IDs of the data repository associations whose descriptions you want to retrieve (String). </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Filter</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Filter[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaxResult</name><description><para>The maximum number of resources to return in the response. This value must be an integer greater than zero. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NextToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Associations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DescribeDataRepositoryAssociationsResponse). Specifying the name of a property of type Amazon.FSx.Model.DescribeDataRepositoryAssociationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NoAutoIteration</name><description><para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AssociationId</name><description><para>IDs of the data repository associations whose descriptions you want to retrieve (String). </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Filter</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Filter[]</parameterValue><type><name>Amazon.FSx.Model.Filter[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaxResult</name><description><para>The maximum number of resources to return in the response. This value must be an integer greater than zero. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NextToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NoAutoIteration</name><description><para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Associations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DescribeDataRepositoryAssociationsResponse). Specifying the name of a property of type Amazon.FSx.Model.DescribeDataRepositoryAssociationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.DataRepositoryAssociation or Amazon.FSx.Model.DescribeDataRepositoryAssociationsResponse</name><uri /><description /></type><description><para>This cmdlet returns a collection of Amazon.FSx.Model.DataRepositoryAssociation objects. The service call response (type Amazon.FSx.Model.DescribeDataRepositoryAssociationsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-FSXDataRepositoryAssociation.html&tocid=Get-FSXDataRepositoryAssociation</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>New-FSXBackup</name><description><para>Calls the Amazon FSx CreateBackup API operation.</para></description><verb>New</verb><noun>FSXBackup</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Creates a backup of an existing Amazon FSx for Windows File Server file system, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system. We recommend creating regular backups so that you can restore a file system or volume from a backup if an issue arises with the original file system or volume. For Amazon FSx for Lustre file systems, you can create a backup only for file systems that have the following configuration: - A Persistent deployment type - Are <i>not</i> linked to a data repository For more information about backups, see the following: - For Amazon FSx for Lustre, see <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html">Working with FSx for Lustre backups</a>. - For Amazon FSx for Windows, see <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/using-backups.html">Working with FSx for Windows backups</a>. - For Amazon FSx for NetApp ONTAP, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/using-backups.html">Working with FSx for NetApp ONTAP backups</a>. - For Amazon FSx for OpenZFS, see <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/using-backups.html">Working with FSx for OpenZFS backups</a>. If a backup with the specified client request token exists and the parameters match, this operation returns the description of the existing backup. If a backup with the specified client request token exists and the parameters don&#39;t match, this operation returns <c>IncompatibleParameterError</c>. If a backup with the specified client request token doesn&#39;t exist, <c>CreateBackup</c> does the following: - Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of <c>CREATING</c>. - Returns the description of the backup. By using the idempotent operation, you can retry a <c>CreateBackup</c> operation without the risk of creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear whether a backup was created. If you use the same client request token and the initial call created a backup, the operation returns a successful result because all the parameters are the same. The <c>CreateBackup</c> operation returns while the backup&#39;s lifecycle state is still <c>CREATING</c>. You can check the backup creation status by calling the <a href="https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeBackups.html">DescribeBackups</a> operation, which returns the backup state along with other information. </para></description><syntax><syntaxItem><name>New-FSXBackup</name><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>FileSystemId</name><description><para>The ID of the file system to back up. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>(Optional) 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Tag</name><description><para>(Optional) The tags to apply to the backup at backup creation. The key value of the <c>Name</c> tag appears in the console as the backup name. If you have set <c>CopyTagsToBackups</c> to <c>true</c>, and you specify one or more tags using the <c>CreateBackup</c> operation, no existing file system tags are copied from the file system to the backup. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>VolumeId</name><description><para>(Optional) The ID of the FSx for ONTAP volume to back up. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Backup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.CreateBackupResponse). Specifying the name of a property of type Amazon.FSx.Model.CreateBackupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the FileSystemId parameter. The -PassThru parameter is deprecated, use -Select '^FileSystemId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>(Optional) 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>FileSystemId</name><description><para>The ID of the file system to back up. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the FileSystemId parameter. The -PassThru parameter is deprecated, use -Select '^FileSystemId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Backup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.CreateBackupResponse). Specifying the name of a property of type Amazon.FSx.Model.CreateBackupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Tag</name><description><para>(Optional) The tags to apply to the backup at backup creation. The key value of the <c>Name</c> tag appears in the console as the backup name. If you have set <c>CopyTagsToBackups</c> to <c>true</c>, and you specify one or more tags using the <c>CreateBackup</c> operation, no existing file system tags are copied from the file system to the backup. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue><type><name>Amazon.FSx.Model.Tag[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>VolumeId</name><description><para>(Optional) The ID of the FSx for ONTAP volume to back up. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.Backup or Amazon.FSx.Model.CreateBackupResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.FSx.Model.Backup object. The service call response (type Amazon.FSx.Model.CreateBackupResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=New-FSXBackup.html&tocid=New-FSXBackup</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks><examples><example><title>-------------------------- EXAMPLE 1 --------------------------</title><code>New-FSXBackup -FileSystemId fs-0b1fac2345623456ba BackupId : backup-0b1fac2345623456ba CreationTime : 6/14/2019 5:37:17 PM FailureDetails : FileSystem : Amazon.FSx.Model.FileSystem KmsKeyId : arn:aws:kms:eu-west-1:123456789012:key/f1af23c4-1b23-1bde-a1f3-e1234c5af678 Lifecycle : CREATING ProgressPercent : 0 ResourceARN : arn:aws:fsx:eu-west-1:123456789012:backup/backup-0b1fac2345623456ba Tags : {} Type : USER_INITIATED</code><remarks><para>Description</para><para>-----------</para><para>This example creates a back up of the given file system.</para><para /><para /></remarks></example></examples></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Add-FSXResourceTag</name><description><para>Calls the Amazon FSx TagResource API operation.</para></description><verb>Add</verb><noun>FSXResourceTag</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Tags an Amazon FSx resource. </para></description><syntax><syntaxItem><name>Add-FSXResourceTag</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>ResourceARN</name><description><para>The Amazon Resource Name (ARN) of the Amazon FSx resource that you want to tag. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Tag</name><description><para>A list of tags for the resource. If a tag with a given key already exists, the value is replaced by the one specified in this parameter. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the ResourceARN parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARN' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the ResourceARN parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARN' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>ResourceARN</name><description><para>The Amazon Resource Name (ARN) of the Amazon FSx resource that you want to tag. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Tag</name><description><para>A list of tags for the resource. If a tag with a given key already exists, the value is replaced by the one specified in this parameter. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue><type><name>Amazon.FSx.Model.Tag[]</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>None or Amazon.FSx.Model.TagResourceResponse</name><uri /><description /></type><description><para>This cmdlet does not generate any output.The service response (type Amazon.FSx.Model.TagResourceResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Add-FSXResourceTag.html&tocid=Add-FSXResourceTag</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks><examples><example><title>-------------------------- EXAMPLE 1 --------------------------</title><code>Add-FSXResourceTag -ResourceARN "arn:aws:fsx:eu-west-1:123456789012:file-system/fs-01cd23bc4bdf5678a" -Tag @{Key="Users";Value="Test"} -PassThru arn:aws:fsx:eu-west-1:123456789012:file-system/fs-01cd23bc4bdf5678a</code><remarks><para>Description</para><para>-----------</para><para>This example adds tags to the given resource.</para><para /><para /></remarks></example></examples></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Update-FSXFileSystem</name><description><para>Calls the Amazon FSx UpdateFileSystem API operation.</para></description><verb>Update</verb><noun>FSXFileSystem</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request. For FSx for Windows File Server file systems, you can update the following properties: - <c>AuditLogConfiguration</c> - <c>AutomaticBackupRetentionDays</c> - <c>DailyAutomaticBackupStartTime</c> - <c>SelfManagedActiveDirectoryConfiguration</c> - <c>StorageCapacity</c> - <c>StorageType</c> - <c>ThroughputCapacity</c> - <c>DiskIopsConfiguration</c> - <c>WeeklyMaintenanceStartTime</c> For FSx for Lustre file systems, you can update the following properties: - <c>AutoImportPolicy</c> - <c>AutomaticBackupRetentionDays</c> - <c>DailyAutomaticBackupStartTime</c> - <c>DataCompressionType</c> - <c>LogConfiguration</c> - <c>LustreRootSquashConfiguration</c> - <c>MetadataConfiguration</c> - <c>PerUnitStorageThroughput</c> - <c>StorageCapacity</c> - <c>WeeklyMaintenanceStartTime</c> For FSx for ONTAP file systems, you can update the following properties: - <c>AddRouteTableIds</c> - <c>AutomaticBackupRetentionDays</c> - <c>DailyAutomaticBackupStartTime</c> - <c>DiskIopsConfiguration</c> - <c>FsxAdminPassword</c> - <c>HAPairs</c> - <c>RemoveRouteTableIds</c> - <c>StorageCapacity</c> - <c>ThroughputCapacity</c> - <c>ThroughputCapacityPerHAPair</c> - <c>WeeklyMaintenanceStartTime</c> For FSx for OpenZFS file systems, you can update the following properties: - <c>AddRouteTableIds</c> - <c>AutomaticBackupRetentionDays</c> - <c>CopyTagsToBackups</c> - <c>CopyTagsToVolumes</c> - <c>DailyAutomaticBackupStartTime</c> - <c>DiskIopsConfiguration</c> - <c>RemoveRouteTableIds</c> - <c>StorageCapacity</c> - <c>ThroughputCapacity</c> - <c>WeeklyMaintenanceStartTime</c> </para></description><syntax><syntaxItem><name>Update-FSXFileSystem</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>FileSystemId</name><description><para>The ID of the file system that you are updating. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_AddRouteTableId</name><description><para>(Multi-AZ only) A list of IDs of new virtual private cloud (VPC) route tables to associate (add) with your Amazon FSx for NetApp ONTAP file system. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_AddRouteTableId</name><description><para>(Multi-AZ only) A list of IDs of new virtual private cloud (VPC) route tables to associate (add) with your Amazon FSx for OpenZFS file system. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_AutomaticBackupRetentionDay</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_AutomaticBackupRetentionDay</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent updates. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_CopyTagsToBackup</name><description><para>A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to <c>false</c>. If it's set to <c>true</c>, 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 <c>true</c> 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. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_CopyTagsToVolume</name><description><para>A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to <c>false</c>. If it's set to <c>true</c>, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is <c>true</c> 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. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_DailyAutomaticBackupStartTime</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_DailyAutomaticBackupStartTime</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_FsxAdminPassword</name><description><para>Update the password for the <c>fsxadmin</c> user by entering a new password. You use the <c>fsxadmin</c> user to access the NetApp ONTAP CLI and REST API to manage your file system resources. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-resources-ontap-apps.html">Managing resources using NetApp Applicaton</a>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_HAPair</name><description><para>Use to update the number of high-availability (HA) pairs for a second-generation single-AZ file system. If you increase the number of HA pairs for your file system, you must specify proportional increases for <c>StorageCapacity</c>, <c>Iops</c>, and <c>ThroughputCapacity</c>. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/administering-file-systems.html#HA-pairs">High-availability (HA) pairs</a> in the FSx for ONTAP user guide. Block storage protocol support (iSCSI and NVMe over TCP) is disabled on file systems with more than 6 HA pairs. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/supported-fsx-clients.html#using-block-storage">Using block storage protocols</a>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_DiskIopsConfiguration_Iops</name><description><para>The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of <c>HAPairs</c> and <c>StorageCapacity</c>. The minimum value is calculated as <c>StorageCapacity</c> * 3 * <c>HAPairs</c> (3 IOPS per GB of <c>StorageCapacity</c>). The maximum value is calculated as 200,000 * <c>HAPairs</c>. Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of <c>Iops</c> is outside of the minimum or maximum values. </para></description><parameterValue required="true" variableLength="false">System.Int64</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_DiskIopsConfiguration_Iops</name><description><para>The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of <c>HAPairs</c> and <c>StorageCapacity</c>. The minimum value is calculated as <c>StorageCapacity</c> * 3 * <c>HAPairs</c> (3 IOPS per GB of <c>StorageCapacity</c>). The maximum value is calculated as 200,000 * <c>HAPairs</c>. Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of <c>Iops</c> is outside of the minimum or maximum values. </para></description><parameterValue required="true" variableLength="false">System.Int64</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>LustreConfiguration</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.UpdateFileSystemLustreConfiguration</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_DiskIopsConfiguration_Mode</name><description><para>Specifies whether the file system is using the <c>AUTOMATIC</c> setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a <c>USER_PROVISIONED</c> value. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.DiskIopsConfigurationMode</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_DiskIopsConfiguration_Mode</name><description><para>Specifies whether the file system is using the <c>AUTOMATIC</c> setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a <c>USER_PROVISIONED</c> value. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.DiskIopsConfigurationMode</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_RemoveRouteTableId</name><description><para>(Multi-AZ only) A list of IDs of existing virtual private cloud (VPC) route tables to disassociate (remove) from your Amazon FSx for NetApp ONTAP file system. You can use the API operation to retrieve the list of VPC route table IDs for a file system. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_RemoveRouteTableId</name><description><para>(Multi-AZ only) A list of IDs of existing virtual private cloud (VPC) route tables to disassociate (remove) from your Amazon FSx for OpenZFS file system. You can use the API operation to retrieve the list of VPC route table IDs for a file system. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>StorageCapacity</name><description><para>Use this parameter to increase the storage capacity of an FSx for Windows File Server, FSx for Lustre, FSx for OpenZFS, or FSx for ONTAP file system. Specifies the storage capacity target value, in GiB, to increase the storage capacity for the file system that you're updating. You can't make a storage capacity increase request if there is an existing storage capacity increase request in progress. For Lustre file systems, the storage capacity target value can be the following: - For <c>SCRATCH_2</c>, <c>PERSISTENT_1</c>, and <c>PERSISTENT_2 SSD</c> deployment types, valid values are in multiples of 2400 GiB. The value must be greater than the current storage capacity. - For <c>PERSISTENT HDD</c> file systems, valid values are multiples of 6000 GiB for 12-MBps throughput per TiB file systems and multiples of 1800 GiB for 40-MBps throughput per TiB file systems. The values must be greater than the current storage capacity. - For <c>SCRATCH_1</c> file systems, you can't increase the storage capacity. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html">Managing storage and throughput capacity</a> in the <i>FSx for Lustre User Guide</i>. For FSx for OpenZFS file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-storage-capacity.html">Managing storage capacity</a> in the <i>FSx for OpenZFS User Guide</i>. For Windows file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. To increase storage capacity, the file system must have at least 16 MBps of throughput capacity. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html">Managing storage capacity</a> in the <i>Amazon FSxfor Windows File Server User Guide</i>. For ONTAP file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-storage-capacity.html">Managing storage capacity and provisioned IOPS</a> in the <i>Amazon FSx for NetApp ONTAP User Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>StorageType</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.StorageType</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_ThroughputCapacity</name><description><para>Enter a new value to change the amount of throughput capacity for the file system in megabytes per second (MBps). For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-throughput-capacity.html">Managing throughput capacity</a> in the FSx for ONTAP User Guide. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: - The value of <c>ThroughputCapacity</c> and <c>ThroughputCapacityPerHAPair</c> are not the same value. - The value of <c>ThroughputCapacity</c> when divided by the value of <c>HAPairs</c> is outside of the valid range for <c>ThroughputCapacity</c>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_ThroughputCapacity</name><description><para>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 <c>MULTI_AZ_1</c> and <c>SINGLE_AZ_2</c>, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MB/s. - For <c>SINGLE_AZ_1</c>, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_ThroughputCapacityPerHAPair</name><description><para>Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system. This field and <c>ThroughputCapacity</c> cannot be defined in the same API call, but one is required. This field and <c>ThroughputCapacity</c> are the same for file systems with one HA pair. - For <c>SINGLE_AZ_1</c> and <c>MULTI_AZ_1</c> file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps. - For <c>SINGLE_AZ_2</c>, valid values are 1536, 3072, or 6144 MBps. - For <c>MULTI_AZ_2</c>, valid values are 384, 768, 1536, 3072, or 6144 MBps. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: - The value of <c>ThroughputCapacity</c> and <c>ThroughputCapacityPerHAPair</c> are not the same value for file systems with one HA pair. - The value of deployment type is <c>SINGLE_AZ_2</c> and <c>ThroughputCapacity</c> / <c>ThroughputCapacityPerHAPair</c> is not a valid HA pair (a value between 1 and 12). - The value of <c>ThroughputCapacityPerHAPair</c> is not a valid value. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_WeeklyMaintenanceStartTime</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_WeeklyMaintenanceStartTime</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>WindowsConfiguration</name><description><para>The configuration updates for an Amazon FSx for Windows File Server file system. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.UpdateFileSystemWindowsConfiguration</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.UpdateFileSystemResponse). Specifying the name of a property of type Amazon.FSx.Model.UpdateFileSystemResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the FileSystemId parameter. The -PassThru parameter is deprecated, use -Select '^FileSystemId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent updates. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>FileSystemId</name><description><para>The ID of the file system that you are updating. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>LustreConfiguration</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.UpdateFileSystemLustreConfiguration</parameterValue><type><name>Amazon.FSx.Model.UpdateFileSystemLustreConfiguration</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_AddRouteTableId</name><description><para>(Multi-AZ only) A list of IDs of new virtual private cloud (VPC) route tables to associate (add) with your Amazon FSx for NetApp ONTAP file system. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_AutomaticBackupRetentionDay</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_DailyAutomaticBackupStartTime</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_DiskIopsConfiguration_Iops</name><description><para>The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of <c>HAPairs</c> and <c>StorageCapacity</c>. The minimum value is calculated as <c>StorageCapacity</c> * 3 * <c>HAPairs</c> (3 IOPS per GB of <c>StorageCapacity</c>). The maximum value is calculated as 200,000 * <c>HAPairs</c>. Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of <c>Iops</c> is outside of the minimum or maximum values. </para></description><parameterValue required="true" variableLength="false">System.Int64</parameterValue><type><name>System.Int64</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_DiskIopsConfiguration_Mode</name><description><para>Specifies whether the file system is using the <c>AUTOMATIC</c> setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a <c>USER_PROVISIONED</c> value. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.DiskIopsConfigurationMode</parameterValue><type><name>Amazon.FSx.DiskIopsConfigurationMode</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_FsxAdminPassword</name><description><para>Update the password for the <c>fsxadmin</c> user by entering a new password. You use the <c>fsxadmin</c> user to access the NetApp ONTAP CLI and REST API to manage your file system resources. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-resources-ontap-apps.html">Managing resources using NetApp Applicaton</a>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_HAPair</name><description><para>Use to update the number of high-availability (HA) pairs for a second-generation single-AZ file system. If you increase the number of HA pairs for your file system, you must specify proportional increases for <c>StorageCapacity</c>, <c>Iops</c>, and <c>ThroughputCapacity</c>. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/administering-file-systems.html#HA-pairs">High-availability (HA) pairs</a> in the FSx for ONTAP user guide. Block storage protocol support (iSCSI and NVMe over TCP) is disabled on file systems with more than 6 HA pairs. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/supported-fsx-clients.html#using-block-storage">Using block storage protocols</a>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_RemoveRouteTableId</name><description><para>(Multi-AZ only) A list of IDs of existing virtual private cloud (VPC) route tables to disassociate (remove) from your Amazon FSx for NetApp ONTAP file system. You can use the API operation to retrieve the list of VPC route table IDs for a file system. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_ThroughputCapacity</name><description><para>Enter a new value to change the amount of throughput capacity for the file system in megabytes per second (MBps). For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-throughput-capacity.html">Managing throughput capacity</a> in the FSx for ONTAP User Guide. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: - The value of <c>ThroughputCapacity</c> and <c>ThroughputCapacityPerHAPair</c> are not the same value. - The value of <c>ThroughputCapacity</c> when divided by the value of <c>HAPairs</c> is outside of the valid range for <c>ThroughputCapacity</c>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_ThroughputCapacityPerHAPair</name><description><para>Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system. This field and <c>ThroughputCapacity</c> cannot be defined in the same API call, but one is required. This field and <c>ThroughputCapacity</c> are the same for file systems with one HA pair. - For <c>SINGLE_AZ_1</c> and <c>MULTI_AZ_1</c> file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps. - For <c>SINGLE_AZ_2</c>, valid values are 1536, 3072, or 6144 MBps. - For <c>MULTI_AZ_2</c>, valid values are 384, 768, 1536, 3072, or 6144 MBps. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: - The value of <c>ThroughputCapacity</c> and <c>ThroughputCapacityPerHAPair</c> are not the same value for file systems with one HA pair. - The value of deployment type is <c>SINGLE_AZ_2</c> and <c>ThroughputCapacity</c> / <c>ThroughputCapacityPerHAPair</c> is not a valid HA pair (a value between 1 and 12). - The value of <c>ThroughputCapacityPerHAPair</c> is not a valid value. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_WeeklyMaintenanceStartTime</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_AddRouteTableId</name><description><para>(Multi-AZ only) A list of IDs of new virtual private cloud (VPC) route tables to associate (add) with your Amazon FSx for OpenZFS file system. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_AutomaticBackupRetentionDay</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_CopyTagsToBackup</name><description><para>A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to <c>false</c>. If it's set to <c>true</c>, 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 <c>true</c> 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. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_CopyTagsToVolume</name><description><para>A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to <c>false</c>. If it's set to <c>true</c>, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is <c>true</c> 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. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_DailyAutomaticBackupStartTime</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_DiskIopsConfiguration_Iops</name><description><para>The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of <c>HAPairs</c> and <c>StorageCapacity</c>. The minimum value is calculated as <c>StorageCapacity</c> * 3 * <c>HAPairs</c> (3 IOPS per GB of <c>StorageCapacity</c>). The maximum value is calculated as 200,000 * <c>HAPairs</c>. Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of <c>Iops</c> is outside of the minimum or maximum values. </para></description><parameterValue required="true" variableLength="false">System.Int64</parameterValue><type><name>System.Int64</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_DiskIopsConfiguration_Mode</name><description><para>Specifies whether the file system is using the <c>AUTOMATIC</c> setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a <c>USER_PROVISIONED</c> value. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.DiskIopsConfigurationMode</parameterValue><type><name>Amazon.FSx.DiskIopsConfigurationMode</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_RemoveRouteTableId</name><description><para>(Multi-AZ only) A list of IDs of existing virtual private cloud (VPC) route tables to disassociate (remove) from your Amazon FSx for OpenZFS file system. You can use the API operation to retrieve the list of VPC route table IDs for a file system. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_ThroughputCapacity</name><description><para>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 <c>MULTI_AZ_1</c> and <c>SINGLE_AZ_2</c>, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MB/s. - For <c>SINGLE_AZ_1</c>, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_WeeklyMaintenanceStartTime</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the FileSystemId parameter. The -PassThru parameter is deprecated, use -Select '^FileSystemId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.UpdateFileSystemResponse). Specifying the name of a property of type Amazon.FSx.Model.UpdateFileSystemResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>StorageCapacity</name><description><para>Use this parameter to increase the storage capacity of an FSx for Windows File Server, FSx for Lustre, FSx for OpenZFS, or FSx for ONTAP file system. Specifies the storage capacity target value, in GiB, to increase the storage capacity for the file system that you're updating. You can't make a storage capacity increase request if there is an existing storage capacity increase request in progress. For Lustre file systems, the storage capacity target value can be the following: - For <c>SCRATCH_2</c>, <c>PERSISTENT_1</c>, and <c>PERSISTENT_2 SSD</c> deployment types, valid values are in multiples of 2400 GiB. The value must be greater than the current storage capacity. - For <c>PERSISTENT HDD</c> file systems, valid values are multiples of 6000 GiB for 12-MBps throughput per TiB file systems and multiples of 1800 GiB for 40-MBps throughput per TiB file systems. The values must be greater than the current storage capacity. - For <c>SCRATCH_1</c> file systems, you can't increase the storage capacity. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html">Managing storage and throughput capacity</a> in the <i>FSx for Lustre User Guide</i>. For FSx for OpenZFS file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-storage-capacity.html">Managing storage capacity</a> in the <i>FSx for OpenZFS User Guide</i>. For Windows file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. To increase storage capacity, the file system must have at least 16 MBps of throughput capacity. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html">Managing storage capacity</a> in the <i>Amazon FSxfor Windows File Server User Guide</i>. For ONTAP file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-storage-capacity.html">Managing storage capacity and provisioned IOPS</a> in the <i>Amazon FSx for NetApp ONTAP User Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>StorageType</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.StorageType</parameterValue><type><name>Amazon.FSx.StorageType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>WindowsConfiguration</name><description><para>The configuration updates for an Amazon FSx for Windows File Server file system. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.UpdateFileSystemWindowsConfiguration</parameterValue><type><name>Amazon.FSx.Model.UpdateFileSystemWindowsConfiguration</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.FileSystem or Amazon.FSx.Model.UpdateFileSystemResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.FSx.Model.FileSystem object. The service call response (type Amazon.FSx.Model.UpdateFileSystemResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-FSXFileSystem.html&tocid=Update-FSXFileSystem</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks><examples><example><title>-------------------------- EXAMPLE 1 --------------------------</title><code>$UpdateFSXWinConfig = [Amazon.FSx.Model.UpdateFileSystemWindowsConfiguration]::new() $UpdateFSXWinConfig.AutomaticBackupRetentionDays = 35 Update-FSXFileSystem -FileSystemId $FSX.FileSystemId -WindowsConfiguration $UpdateFSXWinConfig CreationTime : 1/17/2019 9:55:30 AM DNSName : fs-01cd23bc4bdf5678a.ktmsad.local FailureDetails : FileSystemId : fs-01cd23bc4bdf5678a FileSystemType : WINDOWS KmsKeyId : arn:aws:kms:eu-west-1:123456789012:key/f1af23c4-1b23-1bde-a1f2-e1234c5af678 Lifecycle : AVAILABLE LustreConfiguration : NetworkInterfaceIds : {eni-01cd23bc4bdf5678a} OwnerId : 933303704102 ResourceARN : arn:aws:fsx:eu-west-1:933303704102:file-system/fs-07cd45bc6bdf2674a StorageCapacity : 300 SubnetIds : {subnet-1d234567} Tags : {FSx-Service} VpcId : vpc-23cf4b5f WindowsConfiguration : Amazon.FSx.Model.WindowsFileSystemConfiguration</code><remarks><para>Description</para><para>-----------</para><para>This example updates the FSX file system automatic backup retention days via UpdateFileSystemWindowsConfiguration.</para><para /><para /></remarks></example></examples></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Remove-FSXResourceTag</name><description><para>Calls the Amazon FSx UntagResource API operation.</para></description><verb>Remove</verb><noun>FSXResourceTag</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>This action removes a tag from an Amazon FSx resource. </para></description><syntax><syntaxItem><name>Remove-FSXResourceTag</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>ResourceARN</name><description><para>The ARN of the Amazon FSx resource to untag. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>TagKey</name><description><para>A list of keys of tags on the resource to untag. In case the tag key doesn't exist, the call will still succeed to be idempotent. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the ResourceARN parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARN' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the ResourceARN parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARN' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>ResourceARN</name><description><para>The ARN of the Amazon FSx resource to untag. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>TagKey</name><description><para>A list of keys of tags on the resource to untag. In case the tag key doesn't exist, the call will still succeed to be idempotent. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>None or Amazon.FSx.Model.UntagResourceResponse</name><uri /><description /></type><description><para>This cmdlet does not generate any output.The service response (type Amazon.FSx.Model.UntagResourceResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-FSXResourceTag.html&tocid=Remove-FSXResourceTag</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks><examples><example><title>-------------------------- EXAMPLE 1 --------------------------</title><code>Remove-FSXResourceTag -ResourceARN $FSX.ResourceARN -TagKey Users Confirm Are you sure you want to perform this action? Performing the operation "Remove-FSXResourceTag (UntagResource)" on target "arn:aws:fsx:eu-west-1:933303704102:file-system/fs-07cd45bc6bdf2674a". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y</code><remarks><para>Description</para><para>-----------</para><para>This example removes the resource tag for the given FSX file system resource ARN.</para><para /><para /></remarks></example></examples></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Get-FSXResourceTagList</name><description><para>Calls the Amazon FSx ListTagsForResource API operation.</para></description><verb>Get</verb><noun>FSXResourceTagList</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Lists tags for Amazon FSx resources. When retrieving all tags, you can optionally specify the <c>MaxResults</c> parameter to limit the number of tags in a response. If more tags remain, Amazon FSx returns a <c>NextToken</c> value in the response. In this case, send a later request with the <c>NextToken</c> request parameter set to the value of <c>NextToken</c> from the last response. This action is used in an iterative process to retrieve a list of your tags. <c>ListTagsForResource</c> is called first without a <c>NextToken</c>value. Then the action continues to be called with the <c>NextToken</c> parameter set to the value of the last <c>NextToken</c> value until a response has no <c>NextToken</c>. When using this action, keep the following in mind: - The implementation might return fewer than <c>MaxResults</c> file system descriptions while still including a <c>NextToken</c> value. - The order of tags returned in the response of one <c>ListTagsForResource</c> call and the order of tags returned across the responses of a multi-call iteration is unspecified. <br /><br />This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </para></description><syntax><syntaxItem><name>Get-FSXResourceTagList</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>ResourceARN</name><description><para>The ARN of the Amazon FSx resource that will have its tags listed. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaxResult</name><description><para>Maximum number of tags to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the <c>MaxResults</c> parameter specified in the request and the service's internal maximum number of items per page. <br /><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br />In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br />Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NextToken</name><description><para>Opaque pagination token returned from a previous <c>ListTagsForResource</c> operation (String). If a token present, the action continues the list from where the returning call left off. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.FSx.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the ResourceARN parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARN' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NoAutoIteration</name><description><para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaxResult</name><description><para>Maximum number of tags to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the <c>MaxResults</c> parameter specified in the request and the service's internal maximum number of items per page. <br /><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br />In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br />Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NextToken</name><description><para>Opaque pagination token returned from a previous <c>ListTagsForResource</c> operation (String). If a token present, the action continues the list from where the returning call left off. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NoAutoIteration</name><description><para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the ResourceARN parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARN' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>ResourceARN</name><description><para>The ARN of the Amazon FSx resource that will have its tags listed. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.FSx.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.Tag or Amazon.FSx.Model.ListTagsForResourceResponse</name><uri /><description /></type><description><para>This cmdlet returns a collection of Amazon.FSx.Model.Tag objects. The service call response (type Amazon.FSx.Model.ListTagsForResourceResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-FSXResourceTagList.html&tocid=Get-FSXResourceTagList</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks><examples><example><title>-------------------------- EXAMPLE 1 --------------------------</title><code>Get-FSXResourceTagList -ResourceARN $fsx.ResourceARN Key Value --- ----- FSx-Service Windows Users Dev</code><remarks><para>Description</para><para>-----------</para><para>This example lists tags for provided resource arn.</para><para /><para /></remarks></example></examples></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Clear-FSXFileSystemNfsV3Lock</name><description><para>Calls the Amazon FSx ReleaseFileSystemNfsV3Locks API operation.</para></description><verb>Clear</verb><noun>FSXFileSystemNfsV3Lock</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Releases the file system lock from an Amazon FSx for OpenZFS file system. </para></description><syntax><syntaxItem><name>Clear-FSXFileSystemNfsV3Lock</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>FileSystemId</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.ReleaseFileSystemNfsV3LocksResponse). Specifying the name of a property of type Amazon.FSx.Model.ReleaseFileSystemNfsV3LocksResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the FileSystemId parameter. The -PassThru parameter is deprecated, use -Select '^FileSystemId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>FileSystemId</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the FileSystemId parameter. The -PassThru parameter is deprecated, use -Select '^FileSystemId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.ReleaseFileSystemNfsV3LocksResponse). Specifying the name of a property of type Amazon.FSx.Model.ReleaseFileSystemNfsV3LocksResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.FileSystem or Amazon.FSx.Model.ReleaseFileSystemNfsV3LocksResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.FSx.Model.FileSystem object. The service call response (type Amazon.FSx.Model.ReleaseFileSystemNfsV3LocksResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Clear-FSXFileSystemNfsV3Lock.html&tocid=Clear-FSXFileSystemNfsV3Lock</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Get-FSXSharedVpcConfiguration</name><description><para>Calls the Amazon FSx DescribeSharedVpcConfiguration API operation.</para></description><verb>Get</verb><noun>FSXSharedVpcConfiguration</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Indicates whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud (VPC) owner. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/creating-file-systems.html#fsxn-vpc-shared-subnets">Creating FSx for ONTAP file systems in shared subnets</a>. </para></description><syntax><syntaxItem><name>Get-FSXSharedVpcConfiguration</name><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'EnableFsxRouteTableUpdatesFromParticipantAccounts'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DescribeSharedVpcConfigurationResponse). Specifying the name of a property of type Amazon.FSx.Model.DescribeSharedVpcConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'EnableFsxRouteTableUpdatesFromParticipantAccounts'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DescribeSharedVpcConfigurationResponse). Specifying the name of a property of type Amazon.FSx.Model.DescribeSharedVpcConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>System.String or Amazon.FSx.Model.DescribeSharedVpcConfigurationResponse</name><uri /><description /></type><description><para>This cmdlet returns a System.String object. The service call response (type Amazon.FSx.Model.DescribeSharedVpcConfigurationResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-FSXSharedVpcConfiguration.html&tocid=Get-FSXSharedVpcConfiguration</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Get-FSXDataRepositoryTask</name><description><para>Calls the Amazon FSx DescribeDataRepositoryTasks API operation.</para></description><verb>Get</verb><noun>FSXDataRepositoryTask</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository tasks, if one or more <c>TaskIds</c> values are provided in the request, or if filters are used in the request. You can use filters to narrow the response to include just tasks for specific file systems or caches, or tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you&#39;re calling. When retrieving all tasks, you can paginate the response by using the optional <c>MaxResults</c> parameter to limit the number of tasks returned in a response. If more tasks remain, a <c>NextToken</c> value is returned in the response. In this case, send a later request with the <c>NextToken</c> request parameter set to the value of <c>NextToken</c> from the last response. <br /><br />This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </para></description><syntax><syntaxItem><name>Get-FSXDataRepositoryTask</name><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Filter</name><description><para>(Optional) You can use filters to narrow the <c>DescribeDataRepositoryTasks</c> response to include just tasks for specific file systems, or tasks in a specific lifecycle state. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.DataRepositoryTaskFilter[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>TaskId</name><description><para>(Optional) IDs of the tasks whose descriptions you want to retrieve (String). </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaxResult</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. <br /><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br />In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br />Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NextToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'DataRepositoryTasks'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DescribeDataRepositoryTasksResponse). Specifying the name of a property of type Amazon.FSx.Model.DescribeDataRepositoryTasksResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NoAutoIteration</name><description><para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Filter</name><description><para>(Optional) You can use filters to narrow the <c>DescribeDataRepositoryTasks</c> response to include just tasks for specific file systems, or tasks in a specific lifecycle state. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.DataRepositoryTaskFilter[]</parameterValue><type><name>Amazon.FSx.Model.DataRepositoryTaskFilter[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaxResult</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. <br /><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br />In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br />Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NextToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NoAutoIteration</name><description><para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'DataRepositoryTasks'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DescribeDataRepositoryTasksResponse). Specifying the name of a property of type Amazon.FSx.Model.DescribeDataRepositoryTasksResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>TaskId</name><description><para>(Optional) IDs of the tasks whose descriptions you want to retrieve (String). </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.DataRepositoryTask or Amazon.FSx.Model.DescribeDataRepositoryTasksResponse</name><uri /><description /></type><description><para>This cmdlet returns a collection of Amazon.FSx.Model.DataRepositoryTask objects. The service call response (type Amazon.FSx.Model.DescribeDataRepositoryTasksResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-FSXDataRepositoryTask.html&tocid=Get-FSXDataRepositoryTask</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Stop-FSXDataRepositoryTask</name><description><para>Calls the Amazon FSx CancelDataRepositoryTask API operation.</para></description><verb>Stop</verb><noun>FSXDataRepositoryTask</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the <c>PENDING</c> or <c>EXECUTING</c> state. When you cancel am export task, Amazon FSx does the following. - Any files that FSx has already exported are not reverted. - FSx continues to export any files that are in-flight when the cancel operation is received. - FSx does not export any files that have not yet been exported. For a release task, Amazon FSx will stop releasing files upon cancellation. Any files that have already been released will remain in the released state. </para></description><syntax><syntaxItem><name>Stop-FSXDataRepositoryTask</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>TaskId</name><description><para>Specifies the data repository task to cancel. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.CancelDataRepositoryTaskResponse). Specifying the name of a property of type Amazon.FSx.Model.CancelDataRepositoryTaskResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the TaskId parameter. The -PassThru parameter is deprecated, use -Select '^TaskId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the TaskId parameter. The -PassThru parameter is deprecated, use -Select '^TaskId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.CancelDataRepositoryTaskResponse). Specifying the name of a property of type Amazon.FSx.Model.CancelDataRepositoryTaskResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>TaskId</name><description><para>Specifies the data repository task to cancel. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.CancelDataRepositoryTaskResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.FSx.Model.CancelDataRepositoryTaskResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Stop-FSXDataRepositoryTask.html&tocid=Stop-FSXDataRepositoryTask</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Remove-FSXBackup</name><description><para>Calls the Amazon FSx DeleteBackup API operation.</para></description><verb>Remove</verb><noun>FSXBackup</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Deletes an Amazon FSx backup. After deletion, the backup no longer exists, and its data is gone. The <c>DeleteBackup</c> call returns instantly. The backup won&#39;t show up in later <c>DescribeBackups</c> calls. <important><para> The data in a deleted backup is also deleted and can't be recovered by any means. </para></important> </para></description><syntax><syntaxItem><name>Remove-FSXBackup</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>BackupId</name><description><para>The ID of the backup that you want to delete. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This parameter is automatically filled on your behalf when using the CLI or SDK. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DeleteBackupResponse). Specifying the name of a property of type Amazon.FSx.Model.DeleteBackupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>BackupId</name><description><para>The ID of the backup that you want to delete. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This parameter is automatically filled on your behalf when using the CLI or SDK. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DeleteBackupResponse). Specifying the name of a property of type Amazon.FSx.Model.DeleteBackupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.DeleteBackupResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.FSx.Model.DeleteBackupResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-FSXBackup.html&tocid=Remove-FSXBackup</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks><examples><example><title>-------------------------- EXAMPLE 1 --------------------------</title><code>Remove-FSXBackup -BackupId $backupID Confirm Are you sure you want to perform this action? Performing the operation "Remove-FSXBackup (DeleteBackup)" on target "backup-0bbca1e2345678e12". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y BackupId Lifecycle -------- --------- backup-0bbca1e2345678e12 DELETED</code><remarks><para>Description</para><para>-----------</para><para>This example removes the given backup-id.</para><para /><para /></remarks></example></examples></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Update-FSXSharedVpcConfiguration</name><description><para>Calls the Amazon FSx UpdateSharedVpcConfiguration API operation.</para></description><verb>Update</verb><noun>FSXSharedVpcConfiguration</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Configures whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud (VPC) owner. For more information, see the <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/maz-shared-vpc.html">Amazon FSx for NetApp ONTAP User Guide</a>. We strongly recommend that participant-created Multi-AZ file systems in the shared VPC are deleted before you disable this feature. Once the feature is disabled, these file systems will enter a <c>MISCONFIGURED</c> state and behave like Single-AZ file systems. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/maz-shared-vpc.html#disabling-maz-vpc-sharing">Important considerations before disabling shared VPC support for Multi-AZ file systems</a>. </para></description><syntax><syntaxItem><name>Update-FSXSharedVpcConfiguration</name><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EnableFsxRouteTableUpdatesFromParticipantAccount</name><description><para>Specifies whether participant accounts can create FSx for ONTAP Multi-AZ file systems in shared subnets. Set to <c>true</c> to enable or <c>false</c> to disable. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'EnableFsxRouteTableUpdatesFromParticipantAccounts'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.UpdateSharedVpcConfigurationResponse). Specifying the name of a property of type Amazon.FSx.Model.UpdateSharedVpcConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EnableFsxRouteTableUpdatesFromParticipantAccount</name><description><para>Specifies whether participant accounts can create FSx for ONTAP Multi-AZ file systems in shared subnets. Set to <c>true</c> to enable or <c>false</c> to disable. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'EnableFsxRouteTableUpdatesFromParticipantAccounts'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.UpdateSharedVpcConfigurationResponse). Specifying the name of a property of type Amazon.FSx.Model.UpdateSharedVpcConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>System.String or Amazon.FSx.Model.UpdateSharedVpcConfigurationResponse</name><uri /><description /></type><description><para>This cmdlet returns a System.String object. The service call response (type Amazon.FSx.Model.UpdateSharedVpcConfigurationResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-FSXSharedVpcConfiguration.html&tocid=Update-FSXSharedVpcConfiguration</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Remove-FSXSnapshot</name><description><para>Calls the Amazon FSx DeleteSnapshot API operation.</para></description><verb>Remove</verb><noun>FSXSnapshot</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Deletes an Amazon FSx for OpenZFS snapshot. After deletion, the snapshot no longer exists, and its data is gone. Deleting a snapshot doesn&#39;t affect snapshots stored in a file system backup. The <c>DeleteSnapshot</c> operation returns instantly. The snapshot appears with the lifecycle status of <c>DELETING</c> until the deletion is complete. </para></description><syntax><syntaxItem><name>Remove-FSXSnapshot</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>SnapshotId</name><description><para>The ID of the snapshot that you want to delete. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DeleteSnapshotResponse). Specifying the name of a property of type Amazon.FSx.Model.DeleteSnapshotResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the SnapshotId parameter. The -PassThru parameter is deprecated, use -Select '^SnapshotId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the SnapshotId parameter. The -PassThru parameter is deprecated, use -Select '^SnapshotId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DeleteSnapshotResponse). Specifying the name of a property of type Amazon.FSx.Model.DeleteSnapshotResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>SnapshotId</name><description><para>The ID of the snapshot that you want to delete. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.DeleteSnapshotResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.FSx.Model.DeleteSnapshotResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-FSXSnapshot.html&tocid=Remove-FSXSnapshot</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>New-FSXFileSystemFromBackup</name><description><para>Calls the Amazon FSx CreateFileSystemFromBackup API operation.</para></description><verb>New</verb><noun>FSXFileSystemFromBackup</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>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&#39;t match, this call returns <c>IncompatibleParameterError</c>. If a file system with the specified client request token doesn&#39;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 <c>CREATING</c>. - 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 <c>CreateFileSystemFromBackup</c> 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 <c>CreateFileSystemFromBackup</c> call returns while the file system&#39;s lifecycle state is still <c>CREATING</c>. You can check the file-system creation status by calling the <a href="https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileSystems.html"> DescribeFileSystems</a> operation, which returns the file system state along with other information. </para></description><syntax><syntaxItem><name>New-FSXFileSystemFromBackup</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>BackupId</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_AutomaticBackupRetentionDay</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_CopyTagsToBackup</name><description><para>A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to <c>false</c>. If it's set to <c>true</c>, 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 <c>true</c>, 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. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RootVolumeConfiguration_CopyTagsToSnapshot</name><description><para>A Boolean value indicating whether tags for the volume should be copied to snapshots of the volume. This value defaults to <c>false</c>. If it's set to <c>true</c>, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is <c>true</c> 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. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_CopyTagsToVolume</name><description><para>A Boolean value indicating whether tags for the file system should be copied to volumes. This value defaults to <c>false</c>. If it's set to <c>true</c>, all tags for the file system are copied to volumes where the user doesn't specify tags. If this value is <c>true</c>, 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. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_DailyAutomaticBackupStartTime</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RootVolumeConfiguration_DataCompressionType</name><description><para>Specifies the method used to compress the data on the volume. The compression type is <c>NONE</c> by default. - <c>NONE</c> - Doesn't compress the data on the volume. <c>NONE</c> is the default. - <c>ZSTD</c> - 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. - <c>LZ4</c> - 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. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.OpenZFSDataCompressionType</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_DeploymentType</name><description><para>Specifies the file system deployment type. Valid values are the following: - <c>MULTI_AZ_1</c>- 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. - <c>SINGLE_AZ_HA_2</c>- 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. - <c>SINGLE_AZ_HA_1</c>- 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. - <c>SINGLE_AZ_2</c>- 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. - <c>SINGLE_AZ_1</c>- 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 <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/availability-durability.html#available-aws-regions">Deployment type availability</a>. For more information on the differences in performance between deployment types, see <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#zfs-fs-performance">File system performance</a> in the <i>Amazon FSx for OpenZFS User Guide</i>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.OpenZFSDeploymentType</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_EndpointIpAddressRange</name><description><para>(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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>FileSystemTypeVersion</name><description><para>Sets the version for the Amazon FSx for Lustre file system that you're creating from a backup. Valid values are <c>2.10</c>, <c>2.12</c>, and <c>2.15</c>. You don't need to specify <c>FileSystemTypeVersion</c> because it will be applied using the backup's <c>FileSystemTypeVersion</c> setting. If you choose to specify <c>FileSystemTypeVersion</c> when creating from backup, the value must match the backup's <c>FileSystemTypeVersion</c> setting. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DiskIopsConfiguration_Iops</name><description><para>The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of <c>HAPairs</c> and <c>StorageCapacity</c>. The minimum value is calculated as <c>StorageCapacity</c> * 3 * <c>HAPairs</c> (3 IOPS per GB of <c>StorageCapacity</c>). The maximum value is calculated as 200,000 * <c>HAPairs</c>. Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of <c>Iops</c> is outside of the minimum or maximum values. </para></description><parameterValue required="true" variableLength="false">System.Int64</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>KmsKeyId</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>LustreConfiguration</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.CreateFileSystemLustreConfiguration</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DiskIopsConfiguration_Mode</name><description><para>Specifies whether the file system is using the <c>AUTOMATIC</c> setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a <c>USER_PROVISIONED</c> value. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.DiskIopsConfigurationMode</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RootVolumeConfiguration_NfsExport</name><description><para>The configuration object for mounting a file system. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.OpenZFSNfsExport[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_PreferredSubnetId</name><description><para>Required when <c>DeploymentType</c> is set to <c>MULTI_AZ_1</c>. This specifies the subnet in which you want the preferred file server to be located. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RootVolumeConfiguration_ReadOnly</name><description><para>A Boolean value indicating whether the volume is read-only. Setting this value to <c>true</c> can be useful after you have completed changes to a volume and no longer want changes to occur. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RootVolumeConfiguration_RecordSizeKiB</name><description><para>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 <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs"> Tips for maximizing performance</a> in the <i>Amazon FSx for OpenZFS User Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_RouteTableId</name><description><para>(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. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecurityGroupId</name><description><para>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 <c>DescribeFileSystem</c> requests. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>StorageCapacity</name><description><para>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 <c>StorageCapacity</c> parameter, the default is the backup's <c>StorageCapacity</c> value. If used to create a file system other than OpenZFS, you must provide a value that matches the backup's <c>StorageCapacity</c> value. If you provide any other value, Amazon FSx responds with with an HTTP status code 400 Bad Request. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>StorageType</name><description><para>Sets the storage type for the Windows or OpenZFS file system that you're creating from a backup. Valid values are <c>SSD</c> and <c>HDD</c>. - Set to <c>SSD</c> to use solid state drive storage. SSD is supported on all Windows and OpenZFS deployment types. - Set to <c>HDD</c> to use hard disk drive storage. HDD is supported on <c>SINGLE_AZ_2</c> and <c>MULTI_AZ_1</c> FSx for Windows File Server file system deployment types. The default value is <c>SSD</c>. 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. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.StorageType</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SubnetId</name><description><para>Specifies the IDs of the subnets that the file system will be accessible from. For Windows <c>MULTI_AZ_1</c> 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 <c>WindowsConfiguration > PreferredSubnetID</c> property. Windows <c>SINGLE_AZ_1</c> and <c>SINGLE_AZ_2</c> 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. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Tag</name><description><para>The tags to be applied to the file system at file system creation. The key value of the <c>Name</c> tag appears in the console as the file system name. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_ThroughputCapacity</name><description><para>Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps). Valid values depend on the DeploymentType you choose, as follows: - For <c>MULTI_AZ_1</c> and <c>SINGLE_AZ_2</c>, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MBps. - For <c>SINGLE_AZ_1</c>, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MBps. You pay for additional throughput capacity that you provision. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RootVolumeConfiguration_UserAndGroupQuota</name><description><para>An object specifying how much storage users or groups can use on the volume. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.OpenZFSUserOrGroupQuota[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_WeeklyMaintenanceStartTime</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>WindowsConfiguration</name><description><para>The configuration for this Microsoft Windows file system. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.CreateFileSystemWindowsConfiguration</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>BackupId</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DiskIopsConfiguration_Iops</name><description><para>The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of <c>HAPairs</c> and <c>StorageCapacity</c>. The minimum value is calculated as <c>StorageCapacity</c> * 3 * <c>HAPairs</c> (3 IOPS per GB of <c>StorageCapacity</c>). The maximum value is calculated as 200,000 * <c>HAPairs</c>. Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of <c>Iops</c> is outside of the minimum or maximum values. </para></description><parameterValue required="true" variableLength="false">System.Int64</parameterValue><type><name>System.Int64</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DiskIopsConfiguration_Mode</name><description><para>Specifies whether the file system is using the <c>AUTOMATIC</c> setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a <c>USER_PROVISIONED</c> value. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.DiskIopsConfigurationMode</parameterValue><type><name>Amazon.FSx.DiskIopsConfigurationMode</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>FileSystemTypeVersion</name><description><para>Sets the version for the Amazon FSx for Lustre file system that you're creating from a backup. Valid values are <c>2.10</c>, <c>2.12</c>, and <c>2.15</c>. You don't need to specify <c>FileSystemTypeVersion</c> because it will be applied using the backup's <c>FileSystemTypeVersion</c> setting. If you choose to specify <c>FileSystemTypeVersion</c> when creating from backup, the value must match the backup's <c>FileSystemTypeVersion</c> setting. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>KmsKeyId</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>LustreConfiguration</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.CreateFileSystemLustreConfiguration</parameterValue><type><name>Amazon.FSx.Model.CreateFileSystemLustreConfiguration</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_AutomaticBackupRetentionDay</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_CopyTagsToBackup</name><description><para>A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to <c>false</c>. If it's set to <c>true</c>, 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 <c>true</c>, 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. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_CopyTagsToVolume</name><description><para>A Boolean value indicating whether tags for the file system should be copied to volumes. This value defaults to <c>false</c>. If it's set to <c>true</c>, all tags for the file system are copied to volumes where the user doesn't specify tags. If this value is <c>true</c>, 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. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_DailyAutomaticBackupStartTime</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_DeploymentType</name><description><para>Specifies the file system deployment type. Valid values are the following: - <c>MULTI_AZ_1</c>- 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. - <c>SINGLE_AZ_HA_2</c>- 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. - <c>SINGLE_AZ_HA_1</c>- 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. - <c>SINGLE_AZ_2</c>- 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. - <c>SINGLE_AZ_1</c>- 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 <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/availability-durability.html#available-aws-regions">Deployment type availability</a>. For more information on the differences in performance between deployment types, see <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#zfs-fs-performance">File system performance</a> in the <i>Amazon FSx for OpenZFS User Guide</i>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.OpenZFSDeploymentType</parameterValue><type><name>Amazon.FSx.OpenZFSDeploymentType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_EndpointIpAddressRange</name><description><para>(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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_PreferredSubnetId</name><description><para>Required when <c>DeploymentType</c> is set to <c>MULTI_AZ_1</c>. This specifies the subnet in which you want the preferred file server to be located. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_RouteTableId</name><description><para>(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. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_ThroughputCapacity</name><description><para>Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps). Valid values depend on the DeploymentType you choose, as follows: - For <c>MULTI_AZ_1</c> and <c>SINGLE_AZ_2</c>, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MBps. - For <c>SINGLE_AZ_1</c>, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MBps. You pay for additional throughput capacity that you provision. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_WeeklyMaintenanceStartTime</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RootVolumeConfiguration_CopyTagsToSnapshot</name><description><para>A Boolean value indicating whether tags for the volume should be copied to snapshots of the volume. This value defaults to <c>false</c>. If it's set to <c>true</c>, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is <c>true</c> 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. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RootVolumeConfiguration_DataCompressionType</name><description><para>Specifies the method used to compress the data on the volume. The compression type is <c>NONE</c> by default. - <c>NONE</c> - Doesn't compress the data on the volume. <c>NONE</c> is the default. - <c>ZSTD</c> - 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. - <c>LZ4</c> - 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. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.OpenZFSDataCompressionType</parameterValue><type><name>Amazon.FSx.OpenZFSDataCompressionType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RootVolumeConfiguration_NfsExport</name><description><para>The configuration object for mounting a file system. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.OpenZFSNfsExport[]</parameterValue><type><name>Amazon.FSx.Model.OpenZFSNfsExport[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RootVolumeConfiguration_ReadOnly</name><description><para>A Boolean value indicating whether the volume is read-only. Setting this value to <c>true</c> can be useful after you have completed changes to a volume and no longer want changes to occur. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RootVolumeConfiguration_RecordSizeKiB</name><description><para>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 <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs"> Tips for maximizing performance</a> in the <i>Amazon FSx for OpenZFS User Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RootVolumeConfiguration_UserAndGroupQuota</name><description><para>An object specifying how much storage users or groups can use on the volume. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.OpenZFSUserOrGroupQuota[]</parameterValue><type><name>Amazon.FSx.Model.OpenZFSUserOrGroupQuota[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecurityGroupId</name><description><para>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 <c>DescribeFileSystem</c> requests. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>StorageCapacity</name><description><para>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 <c>StorageCapacity</c> parameter, the default is the backup's <c>StorageCapacity</c> value. If used to create a file system other than OpenZFS, you must provide a value that matches the backup's <c>StorageCapacity</c> value. If you provide any other value, Amazon FSx responds with with an HTTP status code 400 Bad Request. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>StorageType</name><description><para>Sets the storage type for the Windows or OpenZFS file system that you're creating from a backup. Valid values are <c>SSD</c> and <c>HDD</c>. - Set to <c>SSD</c> to use solid state drive storage. SSD is supported on all Windows and OpenZFS deployment types. - Set to <c>HDD</c> to use hard disk drive storage. HDD is supported on <c>SINGLE_AZ_2</c> and <c>MULTI_AZ_1</c> FSx for Windows File Server file system deployment types. The default value is <c>SSD</c>. 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. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.StorageType</parameterValue><type><name>Amazon.FSx.StorageType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SubnetId</name><description><para>Specifies the IDs of the subnets that the file system will be accessible from. For Windows <c>MULTI_AZ_1</c> 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 <c>WindowsConfiguration > PreferredSubnetID</c> property. Windows <c>SINGLE_AZ_1</c> and <c>SINGLE_AZ_2</c> 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. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Tag</name><description><para>The tags to be applied to the file system at file system creation. The key value of the <c>Name</c> tag appears in the console as the file system name. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue><type><name>Amazon.FSx.Model.Tag[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>WindowsConfiguration</name><description><para>The configuration for this Microsoft Windows file system. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.CreateFileSystemWindowsConfiguration</parameterValue><type><name>Amazon.FSx.Model.CreateFileSystemWindowsConfiguration</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.FileSystem or Amazon.FSx.Model.CreateFileSystemFromBackupResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.FSx.Model.FileSystem object. The service call response (type Amazon.FSx.Model.CreateFileSystemFromBackupResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=New-FSXFileSystemFromBackup.html&tocid=New-FSXFileSystemFromBackup</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks><examples><example><title>-------------------------- EXAMPLE 1 --------------------------</title><code>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</code><remarks><para>Description</para><para>-----------</para><para>This exmaple creates new Amazon FSx file system from an existing Amazon FSx for Windows File Server backup.</para><para /><para /></remarks></example></examples></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>New-FSXDataRepositoryAssociation</name><description><para>Calls the Amazon FSx CreateDataRepositoryAssociation API operation.</para></description><verb>New</verb><noun>FSXDataRepositoryAssociation</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Creates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding <c>scratch_1</c> deployment type. Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/create-dra-linked-data-repo.html">Linking your file system to an S3 bucket</a>. <c>CreateDataRepositoryAssociation</c> isn&#39;t supported on Amazon File Cache resources. To create a DRA on Amazon File Cache, use the <c>CreateFileCache</c> operation. </para></description><syntax><syntaxItem><name>New-FSXDataRepositoryAssociation</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>FileSystemId</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>BatchImportMetaDataOnCreate</name><description><para>Set to <c>true</c> to run an import data repository task to import metadata from the data repository to the file system after the data repository association is created. Default is <c>false</c>. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DataRepositoryPath</name><description><para>The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format <c>s3://myBucket/myPrefix/</c>. This path specifies where in the S3 data repository files will be imported from or exported to. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AutoExportPolicy_Event</name><description><para>The <c>AutoExportPolicy</c> can have the following event values: - <c>NEW</c> - New files and directories are automatically exported to the data repository as they are added to the file system. - <c>CHANGED</c> - Changes to files and directories on the file system are automatically exported to the data repository. - <c>DELETED</c> - Files and directories are automatically deleted on the data repository when they are deleted on the file system. You can define any combination of event types for your <c>AutoExportPolicy</c>. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AutoImportPolicy_Event</name><description><para>The <c>AutoImportPolicy</c> can have the following event values: - <c>NEW</c> - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not currently exist in the FSx file system. - <c>CHANGED</c> - Amazon FSx automatically updates file metadata and invalidates existing file content on the file system as files change in the data repository. - <c>DELETED</c> - Amazon FSx automatically deletes files on the file system as corresponding files are deleted in the data repository. You can define any combination of event types for your <c>AutoImportPolicy</c>. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>FileSystemPath</name><description><para>A path on the file system that points to a high-level directory (such as <c>/ns1/</c>) or subdirectory (such as <c>/ns1/subdir/</c>) that will be mapped 1-1 with <c>DataRepositoryPath</c>. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path <c>/ns1/</c>, then you cannot link another data repository with file system path <c>/ns1/ns2</c>. This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory. If you specify only a forward slash (<c>/</c>) as the file system path, you can link only one data repository to the file system. You can only specify "/" as the file system path for the first data repository associated with a file system. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ImportedFileChunkSize</name><description><para>For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system. The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Tag</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Association'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.CreateDataRepositoryAssociationResponse). Specifying the name of a property of type Amazon.FSx.Model.CreateDataRepositoryAssociationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the FileSystemId parameter. The -PassThru parameter is deprecated, use -Select '^FileSystemId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AutoExportPolicy_Event</name><description><para>The <c>AutoExportPolicy</c> can have the following event values: - <c>NEW</c> - New files and directories are automatically exported to the data repository as they are added to the file system. - <c>CHANGED</c> - Changes to files and directories on the file system are automatically exported to the data repository. - <c>DELETED</c> - Files and directories are automatically deleted on the data repository when they are deleted on the file system. You can define any combination of event types for your <c>AutoExportPolicy</c>. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AutoImportPolicy_Event</name><description><para>The <c>AutoImportPolicy</c> can have the following event values: - <c>NEW</c> - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not currently exist in the FSx file system. - <c>CHANGED</c> - Amazon FSx automatically updates file metadata and invalidates existing file content on the file system as files change in the data repository. - <c>DELETED</c> - Amazon FSx automatically deletes files on the file system as corresponding files are deleted in the data repository. You can define any combination of event types for your <c>AutoImportPolicy</c>. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>BatchImportMetaDataOnCreate</name><description><para>Set to <c>true</c> to run an import data repository task to import metadata from the data repository to the file system after the data repository association is created. Default is <c>false</c>. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DataRepositoryPath</name><description><para>The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format <c>s3://myBucket/myPrefix/</c>. This path specifies where in the S3 data repository files will be imported from or exported to. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>FileSystemId</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>FileSystemPath</name><description><para>A path on the file system that points to a high-level directory (such as <c>/ns1/</c>) or subdirectory (such as <c>/ns1/subdir/</c>) that will be mapped 1-1 with <c>DataRepositoryPath</c>. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path <c>/ns1/</c>, then you cannot link another data repository with file system path <c>/ns1/ns2</c>. This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory. If you specify only a forward slash (<c>/</c>) as the file system path, you can link only one data repository to the file system. You can only specify "/" as the file system path for the first data repository associated with a file system. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ImportedFileChunkSize</name><description><para>For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system. The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the FileSystemId parameter. The -PassThru parameter is deprecated, use -Select '^FileSystemId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Association'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.CreateDataRepositoryAssociationResponse). Specifying the name of a property of type Amazon.FSx.Model.CreateDataRepositoryAssociationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Tag</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue><type><name>Amazon.FSx.Model.Tag[]</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.DataRepositoryAssociation or Amazon.FSx.Model.CreateDataRepositoryAssociationResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.FSx.Model.DataRepositoryAssociation object. The service call response (type Amazon.FSx.Model.CreateDataRepositoryAssociationResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=New-FSXDataRepositoryAssociation.html&tocid=New-FSXDataRepositoryAssociation</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Get-FSXFileCach</name><description><para>Calls the Amazon FSx DescribeFileCaches API operation.</para></description><verb>Get</verb><noun>FSXFileCach</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Returns the description of a specific Amazon File Cache resource, if a <c>FileCacheIds</c> value is provided for that cache. Otherwise, it returns descriptions of all caches owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you&#39;re calling. When retrieving all cache descriptions, you can optionally specify the <c>MaxResults</c> parameter to limit the number of descriptions in a response. If more cache descriptions remain, the operation returns a <c>NextToken</c> value in the response. In this case, send a later request with the <c>NextToken</c> request parameter set to the value of <c>NextToken</c> from the last response. This operation is used in an iterative process to retrieve a list of your cache descriptions. <c>DescribeFileCaches</c> is called first without a <c>NextToken</c>value. Then the operation continues to be called with the <c>NextToken</c> parameter set to the value of the last <c>NextToken</c> value until a response has no <c>NextToken</c>. When using this operation, keep the following in mind: - The implementation might return fewer than <c>MaxResults</c> cache descriptions while still including a <c>NextToken</c> value. - The order of caches returned in the response of one <c>DescribeFileCaches</c> call and the order of caches returned across the responses of a multicall iteration is unspecified. <br /><br />This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </para></description><syntax><syntaxItem><name>Get-FSXFileCach</name><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>FileCacheId</name><description><para>IDs of the caches whose descriptions you want to retrieve (String). </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaxResult</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NextToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'FileCaches'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DescribeFileCachesResponse). Specifying the name of a property of type Amazon.FSx.Model.DescribeFileCachesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NoAutoIteration</name><description><para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>FileCacheId</name><description><para>IDs of the caches whose descriptions you want to retrieve (String). </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaxResult</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NextToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NoAutoIteration</name><description><para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'FileCaches'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DescribeFileCachesResponse). Specifying the name of a property of type Amazon.FSx.Model.DescribeFileCachesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.FileCache or Amazon.FSx.Model.DescribeFileCachesResponse</name><uri /><description /></type><description><para>This cmdlet returns a collection of Amazon.FSx.Model.FileCache objects. The service call response (type Amazon.FSx.Model.DescribeFileCachesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-FSXFileCach.html&tocid=Get-FSXFileCach</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Get-FSXSnapshot</name><description><para>Calls the Amazon FSx DescribeSnapshots API operation.</para></description><verb>Get</verb><noun>FSXSnapshot</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Returns the description of specific Amazon FSx for OpenZFS snapshots, if a <c>SnapshotIds</c> value is provided. Otherwise, this operation returns all snapshots owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you&#39;re calling. When retrieving all snapshots, you can optionally specify the <c>MaxResults</c> parameter to limit the number of snapshots in a response. If more backups remain, Amazon FSx returns a <c>NextToken</c> value in the response. In this case, send a later request with the <c>NextToken</c> request parameter set to the value of <c>NextToken</c> from the last response. Use this operation in an iterative process to retrieve a list of your snapshots. <c>DescribeSnapshots</c> is called first without a <c>NextToken</c> value. Then the operation continues to be called with the <c>NextToken</c> parameter set to the value of the last <c>NextToken</c> value until a response has no <c>NextToken</c> value. When using this operation, keep the following in mind: - The operation might return fewer than the <c>MaxResults</c> value of snapshot descriptions while still including a <c>NextToken</c> value. - The order of snapshots returned in the response of one <c>DescribeSnapshots</c> call and the order of backups returned across the responses of a multi-call iteration is unspecified. <br /><br />This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </para></description><syntax><syntaxItem><name>Get-FSXSnapshot</name><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Filter</name><description><para>The filters structure. The supported names are <c>file-system-id</c> or <c>volume-id</c>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.SnapshotFilter[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>IncludeShared</name><description><para>Set to <c>false</c> (default) if you want to only see the snapshots owned by your Amazon Web Services account. Set to <c>true</c> if you want to see the snapshots in your account and the ones shared with you from another account. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SnapshotId</name><description><para>The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a <c>SnapshotNotFound</c> error occurs. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaxResult</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NextToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Snapshots'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DescribeSnapshotsResponse). Specifying the name of a property of type Amazon.FSx.Model.DescribeSnapshotsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NoAutoIteration</name><description><para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Filter</name><description><para>The filters structure. The supported names are <c>file-system-id</c> or <c>volume-id</c>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.SnapshotFilter[]</parameterValue><type><name>Amazon.FSx.Model.SnapshotFilter[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>IncludeShared</name><description><para>Set to <c>false</c> (default) if you want to only see the snapshots owned by your Amazon Web Services account. Set to <c>true</c> if you want to see the snapshots in your account and the ones shared with you from another account. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaxResult</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NextToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NoAutoIteration</name><description><para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Snapshots'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DescribeSnapshotsResponse). Specifying the name of a property of type Amazon.FSx.Model.DescribeSnapshotsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SnapshotId</name><description><para>The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a <c>SnapshotNotFound</c> error occurs. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.Snapshot or Amazon.FSx.Model.DescribeSnapshotsResponse</name><uri /><description /></type><description><para>This cmdlet returns a collection of Amazon.FSx.Model.Snapshot objects. The service call response (type Amazon.FSx.Model.DescribeSnapshotsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-FSXSnapshot.html&tocid=Get-FSXSnapshot</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Remove-FSXDataRepositoryAssociation</name><description><para>Calls the Amazon FSx DeleteDataRepositoryAssociation API operation.</para></description><verb>Remove</verb><noun>FSXDataRepositoryAssociation</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Deletes a data repository association on an Amazon FSx for Lustre file system. Deleting the data repository association unlinks the file system from the Amazon S3 bucket. When deleting a data repository association, you have the option of deleting the data in the file system that corresponds to the data repository association. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding <c>scratch_1</c> deployment type. </para></description><syntax><syntaxItem><name>Remove-FSXDataRepositoryAssociation</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>AssociationId</name><description><para>The ID of the data repository association that you want to delete. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DeleteDataInFileSystem</name><description><para>Set to <c>true</c> to delete the data in the file system that corresponds to the data repository association. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DeleteDataRepositoryAssociationResponse). Specifying the name of a property of type Amazon.FSx.Model.DeleteDataRepositoryAssociationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the AssociationId parameter. The -PassThru parameter is deprecated, use -Select '^AssociationId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>AssociationId</name><description><para>The ID of the data repository association that you want to delete. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DeleteDataInFileSystem</name><description><para>Set to <c>true</c> to delete the data in the file system that corresponds to the data repository association. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the AssociationId parameter. The -PassThru parameter is deprecated, use -Select '^AssociationId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DeleteDataRepositoryAssociationResponse). Specifying the name of a property of type Amazon.FSx.Model.DeleteDataRepositoryAssociationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.DeleteDataRepositoryAssociationResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.FSx.Model.DeleteDataRepositoryAssociationResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-FSXDataRepositoryAssociation.html&tocid=Remove-FSXDataRepositoryAssociation</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Unregister-FSXFileSystemAlias</name><description><para>Calls the Amazon FSx DisassociateFileSystemAliases API operation.</para></description><verb>Unregister</verb><noun>FSXFileSystemAlias</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Use this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases from an Amazon FSx for Windows File Server file system. If you attempt to disassociate a DNS alias that is not associated with the file system, Amazon FSx responds with an HTTP status code 400 (Bad Request). For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html">Working with DNS Aliases</a>. The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. Use the API operation to monitor the status of the aliases Amazon FSx is disassociating with the file system. </para></description><syntax><syntaxItem><name>Unregister-FSXFileSystemAlias</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>FileSystemId</name><description><para>Specifies the file system from which to disassociate the DNS aliases. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Alias</name><description><para>An array of one or more DNS alias names to disassociate, or remove, from the file system. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Aliases'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DisassociateFileSystemAliasesResponse). Specifying the name of a property of type Amazon.FSx.Model.DisassociateFileSystemAliasesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the FileSystemId parameter. The -PassThru parameter is deprecated, use -Select '^FileSystemId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Alias</name><description><para>An array of one or more DNS alias names to disassociate, or remove, from the file system. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>FileSystemId</name><description><para>Specifies the file system from which to disassociate the DNS aliases. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the FileSystemId parameter. The -PassThru parameter is deprecated, use -Select '^FileSystemId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Aliases'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DisassociateFileSystemAliasesResponse). Specifying the name of a property of type Amazon.FSx.Model.DisassociateFileSystemAliasesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.Alias or Amazon.FSx.Model.DisassociateFileSystemAliasesResponse</name><uri /><description /></type><description><para>This cmdlet returns a collection of Amazon.FSx.Model.Alias objects. The service call response (type Amazon.FSx.Model.DisassociateFileSystemAliasesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Unregister-FSXFileSystemAlias.html&tocid=Unregister-FSXFileSystemAlias</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Remove-FSXStorageVirtualMachine</name><description><para>Calls the Amazon FSx DeleteStorageVirtualMachine API operation.</para></description><verb>Remove</verb><noun>FSXStorageVirtualMachine</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM). Prior to deleting an SVM, you must delete all non-root volumes in the SVM, otherwise the operation will fail. </para></description><syntax><syntaxItem><name>Remove-FSXStorageVirtualMachine</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>StorageVirtualMachineId</name><description><para>The ID of the SVM that you want to delete. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DeleteStorageVirtualMachineResponse). Specifying the name of a property of type Amazon.FSx.Model.DeleteStorageVirtualMachineResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the StorageVirtualMachineId parameter. The -PassThru parameter is deprecated, use -Select '^StorageVirtualMachineId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the StorageVirtualMachineId parameter. The -PassThru parameter is deprecated, use -Select '^StorageVirtualMachineId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DeleteStorageVirtualMachineResponse). Specifying the name of a property of type Amazon.FSx.Model.DeleteStorageVirtualMachineResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>StorageVirtualMachineId</name><description><para>The ID of the SVM that you want to delete. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.DeleteStorageVirtualMachineResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.FSx.Model.DeleteStorageVirtualMachineResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-FSXStorageVirtualMachine.html&tocid=Remove-FSXStorageVirtualMachine</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Get-FSXFileSystem</name><description><para>Calls the Amazon FSx DescribeFileSystems API operation.</para></description><verb>Get</verb><noun>FSXFileSystem</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Returns the description of specific Amazon FSx file systems, if a <c>FileSystemIds</c> value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you&#39;re calling. When retrieving all file system descriptions, you can optionally specify the <c>MaxResults</c> parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a <c>NextToken</c> value in the response. In this case, send a later request with the <c>NextToken</c> request parameter set to the value of <c>NextToken</c> from the last response. This operation is used in an iterative process to retrieve a list of your file system descriptions. <c>DescribeFileSystems</c> is called first without a <c>NextToken</c>value. Then the operation continues to be called with the <c>NextToken</c> parameter set to the value of the last <c>NextToken</c> value until a response has no <c>NextToken</c>. When using this operation, keep the following in mind: - The implementation might return fewer than <c>MaxResults</c> file system descriptions while still including a <c>NextToken</c> value. - The order of file systems returned in the response of one <c>DescribeFileSystems</c> call and the order of file systems returned across the responses of a multicall iteration is unspecified. <br /><br />This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </para></description><syntax><syntaxItem><name>Get-FSXFileSystem</name><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>FileSystemId</name><description><para>IDs of the file systems whose descriptions you want to retrieve (String). </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaxResult</name><description><para>Maximum number of file systems to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the <c>MaxResults</c> parameter specified in the request and the service's internal maximum number of items per page. <br /><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br />In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br />Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NextToken</name><description><para>Opaque pagination token returned from a previous <c>DescribeFileSystems</c> operation (String). If a token present, the operation continues the list from where the returning call left off. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'FileSystems'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DescribeFileSystemsResponse). Specifying the name of a property of type Amazon.FSx.Model.DescribeFileSystemsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NoAutoIteration</name><description><para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>FileSystemId</name><description><para>IDs of the file systems whose descriptions you want to retrieve (String). </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaxResult</name><description><para>Maximum number of file systems to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the <c>MaxResults</c> parameter specified in the request and the service's internal maximum number of items per page. <br /><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br />In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br />Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NextToken</name><description><para>Opaque pagination token returned from a previous <c>DescribeFileSystems</c> operation (String). If a token present, the operation continues the list from where the returning call left off. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NoAutoIteration</name><description><para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'FileSystems'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DescribeFileSystemsResponse). Specifying the name of a property of type Amazon.FSx.Model.DescribeFileSystemsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.FileSystem or Amazon.FSx.Model.DescribeFileSystemsResponse</name><uri /><description /></type><description><para>This cmdlet returns a collection of Amazon.FSx.Model.FileSystem objects. The service call response (type Amazon.FSx.Model.DescribeFileSystemsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-FSXFileSystem.html&tocid=Get-FSXFileSystem</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks><examples><example><title>-------------------------- EXAMPLE 1 --------------------------</title><code>Get-FSXFileSystem -FileSystemId fs-01cd23bc4bdf5678a CreationTime : 1/17/2019 9:55:30 AM DNSName : fs-01cd23bc4bdf5678a.ktmsad.local FailureDetails : FileSystemId : fs-01cd23bc4bdf5678a FileSystemType : WINDOWS KmsKeyId : arn:aws:kms:eu-west-1:123456789012:key/f1af23c4-5b67-8bde-a9f0-e1234c5af678 Lifecycle : AVAILABLE LustreConfiguration : NetworkInterfaceIds : {eni-07d1dda1322b7e209} OwnerId : 123456789012 ResourceARN : arn:aws:fsx:eu-west-1:123456789012:file-system/fs-01cd23bc4bdf5678a StorageCapacity : 300 SubnetIds : {subnet-7d123456} Tags : {FSx-Service} VpcId : vpc-41cf2b3f WindowsConfiguration : Amazon.FSx.Model.WindowsFileSystemConfiguration</code><remarks><para>Description</para><para>-----------</para><para>This example returns the description of given filesystemId.</para><para /><para /></remarks></example></examples></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Get-FSXStorageVirtualMachine</name><description><para>Calls the Amazon FSx DescribeStorageVirtualMachines API operation.</para></description><verb>Get</verb><noun>FSXStorageVirtualMachine</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).<br /><br />This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </para></description><syntax><syntaxItem><name>Get-FSXStorageVirtualMachine</name><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Filter</name><description><para>Enter a filter name:value pair to view a select set of SVMs. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.StorageVirtualMachineFilter[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>StorageVirtualMachineId</name><description><para>Enter the ID of one or more SVMs that you want to view. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaxResult</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NextToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'StorageVirtualMachines'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DescribeStorageVirtualMachinesResponse). Specifying the name of a property of type Amazon.FSx.Model.DescribeStorageVirtualMachinesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NoAutoIteration</name><description><para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Filter</name><description><para>Enter a filter name:value pair to view a select set of SVMs. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.StorageVirtualMachineFilter[]</parameterValue><type><name>Amazon.FSx.Model.StorageVirtualMachineFilter[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaxResult</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NextToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NoAutoIteration</name><description><para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'StorageVirtualMachines'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DescribeStorageVirtualMachinesResponse). Specifying the name of a property of type Amazon.FSx.Model.DescribeStorageVirtualMachinesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>StorageVirtualMachineId</name><description><para>Enter the ID of one or more SVMs that you want to view. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.StorageVirtualMachine or Amazon.FSx.Model.DescribeStorageVirtualMachinesResponse</name><uri /><description /></type><description><para>This cmdlet returns a collection of Amazon.FSx.Model.StorageVirtualMachine objects. The service call response (type Amazon.FSx.Model.DescribeStorageVirtualMachinesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-FSXStorageVirtualMachine.html&tocid=Get-FSXStorageVirtualMachine</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Update-FSXSnapshot</name><description><para>Calls the Amazon FSx UpdateSnapshot API operation.</para></description><verb>Update</verb><noun>FSXSnapshot</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Updates the name of an Amazon FSx for OpenZFS snapshot. </para></description><syntax><syntaxItem><name>Update-FSXSnapshot</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>SnapshotId</name><description><para>The ID of the snapshot that you want to update, in the format <c>fsvolsnap-0123456789abcdef0</c>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Name</name><description><para>The name of the snapshot to update. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Snapshot'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.UpdateSnapshotResponse). Specifying the name of a property of type Amazon.FSx.Model.UpdateSnapshotResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the SnapshotId parameter. The -PassThru parameter is deprecated, use -Select '^SnapshotId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Name</name><description><para>The name of the snapshot to update. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the SnapshotId parameter. The -PassThru parameter is deprecated, use -Select '^SnapshotId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Snapshot'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.UpdateSnapshotResponse). Specifying the name of a property of type Amazon.FSx.Model.UpdateSnapshotResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>SnapshotId</name><description><para>The ID of the snapshot that you want to update, in the format <c>fsvolsnap-0123456789abcdef0</c>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.Snapshot or Amazon.FSx.Model.UpdateSnapshotResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.FSx.Model.Snapshot object. The service call response (type Amazon.FSx.Model.UpdateSnapshotResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-FSXSnapshot.html&tocid=Update-FSXSnapshot</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>New-FSXSnapshot</name><description><para>Calls the Amazon FSx CreateSnapshot API operation.</para></description><verb>New</verb><noun>FSXSnapshot</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Creates a snapshot of an existing Amazon FSx for OpenZFS volume. With snapshots, you can easily undo file changes and compare file versions by restoring the volume to a previous version. If a snapshot with the specified client request token exists, and the parameters match, this operation returns the description of the existing snapshot. If a snapshot with the specified client request token exists, and the parameters don&#39;t match, this operation returns <c>IncompatibleParameterError</c>. If a snapshot with the specified client request token doesn&#39;t exist, <c>CreateSnapshot</c> does the following: - Creates a new OpenZFS snapshot with an assigned ID, and an initial lifecycle state of <c>CREATING</c>. - Returns the description of the snapshot. By using the idempotent operation, you can retry a <c>CreateSnapshot</c> operation without the risk of creating an extra snapshot. This approach can be useful when an initial call fails in a way that makes it unclear whether a snapshot was created. If you use the same client request token and the initial call created a snapshot, the operation returns a successful result because all the parameters are the same. The <c>CreateSnapshot</c> operation returns while the snapshot&#39;s lifecycle state is still <c>CREATING</c>. You can check the snapshot creation status by calling the <a href="https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeSnapshots.html">DescribeSnapshots</a> operation, which returns the snapshot state along with other information. </para></description><syntax><syntaxItem><name>New-FSXSnapshot</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>VolumeId</name><description><para>The ID of the volume that you are taking a snapshot of. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Name</name><description><para>The name of the snapshot. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Tag</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Snapshot'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.CreateSnapshotResponse). Specifying the name of a property of type Amazon.FSx.Model.CreateSnapshotResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the VolumeId parameter. The -PassThru parameter is deprecated, use -Select '^VolumeId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Name</name><description><para>The name of the snapshot. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the VolumeId parameter. The -PassThru parameter is deprecated, use -Select '^VolumeId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Snapshot'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.CreateSnapshotResponse). Specifying the name of a property of type Amazon.FSx.Model.CreateSnapshotResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Tag</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue><type><name>Amazon.FSx.Model.Tag[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>VolumeId</name><description><para>The ID of the volume that you are taking a snapshot of. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.Snapshot or Amazon.FSx.Model.CreateSnapshotResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.FSx.Model.Snapshot object. The service call response (type Amazon.FSx.Model.CreateSnapshotResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=New-FSXSnapshot.html&tocid=New-FSXSnapshot</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Remove-FSXFileCache</name><description><para>Calls the Amazon FSx DeleteFileCache API operation.</para></description><verb>Remove</verb><noun>FSXFileCache</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Deletes an Amazon File Cache resource. After deletion, the cache no longer exists, and its data is gone. The <c>DeleteFileCache</c> operation returns while the cache has the <c>DELETING</c> status. You can check the cache deletion status by calling the <a href="https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileCaches.html">DescribeFileCaches</a> operation, which returns a list of caches in your account. If you pass the cache ID for a deleted cache, the <c>DescribeFileCaches</c> operation returns a <c>FileCacheNotFound</c> error. <important><para> The data in a deleted cache is also deleted and can't be recovered by any means. </para></important> </para></description><syntax><syntaxItem><name>Remove-FSXFileCache</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>FileCacheId</name><description><para>The ID of the cache that's being deleted. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DeleteFileCacheResponse). Specifying the name of a property of type Amazon.FSx.Model.DeleteFileCacheResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the FileCacheId parameter. The -PassThru parameter is deprecated, use -Select '^FileCacheId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>FileCacheId</name><description><para>The ID of the cache that's being deleted. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the FileCacheId parameter. The -PassThru parameter is deprecated, use -Select '^FileCacheId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DeleteFileCacheResponse). Specifying the name of a property of type Amazon.FSx.Model.DeleteFileCacheResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.DeleteFileCacheResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.FSx.Model.DeleteFileCacheResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-FSXFileCache.html&tocid=Remove-FSXFileCache</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Get-FSXFileSystemAlias</name><description><para>Calls the Amazon FSx DescribeFileSystemAliases API operation.</para></description><verb>Get</verb><noun>FSXFileSystemAlias</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system. A history of all DNS aliases that have been associated with and disassociated from the file system is available in the list of <a>AdministrativeAction</a> provided in the <a>DescribeFileSystems</a> operation response.<br /><br />This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </para></description><syntax><syntaxItem><name>Get-FSXFileSystemAlias</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>FileSystemId</name><description><para>The ID of the file system to return the associated DNS aliases for (String). </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaxResult</name><description><para>Maximum number of DNS aliases to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the <c>MaxResults</c> parameter specified in the request and the service's internal maximum number of items per page. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NextToken</name><description><para>Opaque pagination token returned from a previous <c>DescribeFileSystemAliases</c> operation (String). If a token is included in the request, the action continues the list from where the previous returning call left off. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Aliases'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DescribeFileSystemAliasesResponse). Specifying the name of a property of type Amazon.FSx.Model.DescribeFileSystemAliasesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the FileSystemId parameter. The -PassThru parameter is deprecated, use -Select '^FileSystemId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NoAutoIteration</name><description><para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>FileSystemId</name><description><para>The ID of the file system to return the associated DNS aliases for (String). </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaxResult</name><description><para>Maximum number of DNS aliases to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the <c>MaxResults</c> parameter specified in the request and the service's internal maximum number of items per page. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NextToken</name><description><para>Opaque pagination token returned from a previous <c>DescribeFileSystemAliases</c> operation (String). If a token is included in the request, the action continues the list from where the previous returning call left off. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NoAutoIteration</name><description><para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the FileSystemId parameter. The -PassThru parameter is deprecated, use -Select '^FileSystemId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Aliases'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DescribeFileSystemAliasesResponse). Specifying the name of a property of type Amazon.FSx.Model.DescribeFileSystemAliasesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.Alias or Amazon.FSx.Model.DescribeFileSystemAliasesResponse</name><uri /><description /></type><description><para>This cmdlet returns a collection of Amazon.FSx.Model.Alias objects. The service call response (type Amazon.FSx.Model.DescribeFileSystemAliasesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-FSXFileSystemAlias.html&tocid=Get-FSXFileSystemAlias</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>New-FSXDataRepositoryTask</name><description><para>Calls the Amazon FSx CreateDataRepositoryTask API operation.</para></description><verb>New</verb><noun>FSXDataRepositoryTask</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Creates an Amazon FSx for Lustre data repository task. A <c>CreateDataRepositoryTask</c> operation will fail if a data repository is not linked to the FSx file system. You use import and export data repository tasks to perform bulk operations between your FSx for Lustre file system and its linked data repositories. An example of a data repository task is exporting any data and metadata changes, including POSIX metadata, to files, directories, and symbolic links (symlinks) from your FSx file system to a linked data repository. You use release data repository tasks to release data from your file system for files that are exported to S3. The metadata of released files remains on the file system so users or applications can still access released files by reading the files again, which will restore data from Amazon S3 to the FSx for Lustre file system. To learn more about data repository tasks, see <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-repository-tasks.html">Data Repository Tasks</a>. To learn more about linking a data repository to your file system, see <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/create-dra-linked-data-repo.html">Linking your file system to an S3 bucket</a>. </para></description><syntax><syntaxItem><name>New-FSXDataRepositoryTask</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>FileSystemId</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>CapacityToRelease</name><description><para>Specifies the amount of data to release, in GiB, by an Amazon File Cache <c>AUTO_RELEASE_DATA</c> task that automatically releases files from the cache. </para></description><parameterValue required="true" variableLength="false">System.Int64</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Report_Enabled</name><description><para>Set <c>Enabled</c> to <c>True</c> to generate a <c>CompletionReport</c> when the task completes. If set to <c>true</c>, then you need to provide a report <c>Scope</c>, <c>Path</c>, and <c>Format</c>. Set <c>Enabled</c> to <c>False</c> if you do not want a <c>CompletionReport</c> generated when the task completes. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Report_Format</name><description><para>Required if <c>Enabled</c> is set to <c>true</c>. Specifies the format of the <c>CompletionReport</c>. <c>REPORT_CSV_20191124</c> is the only format currently supported. When <c>Format</c> is set to <c>REPORT_CSV_20191124</c>, the <c>CompletionReport</c> is provided in CSV format, and is delivered to <c>{path}/task-{id}/failures.csv</c>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.ReportFormat</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Report_Path</name><description><para>Required if <c>Enabled</c> is set to <c>true</c>. Specifies the location of the report on the file system's linked S3 data repository. An absolute path that defines where the completion report will be stored in the destination location. The <c>Path</c> you provide must be located within the file system’s ExportPath. An example <c>Path</c> value is "s3://myBucket/myExportPath/optionalPrefix". The report provides the following information for each file in the report: FilePath, FileStatus, and ErrorCode. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Path</name><description><para>A list of paths for the data repository task to use when the task is processed. If a path that you provide isn't valid, the task fails. If you don't provide paths, the default behavior is to export all files to S3 (for export tasks), import all files from S3 (for import tasks), or release all exported files that meet the last accessed time criteria (for release tasks). - For export tasks, the list contains paths on the FSx for Lustre file system from which the files are exported to the Amazon S3 bucket. The default path is the file system root directory. The paths you provide need to be relative to the mount point of the file system. If the mount point is <c>/mnt/fsx</c> and <c>/mnt/fsx/path1</c> is a directory or file on the file system you want to export, then the path to provide is <c>path1</c>. - For import tasks, the list contains paths in the Amazon S3 bucket from which POSIX metadata changes are imported to the FSx for Lustre file system. The path can be an S3 bucket or prefix in the format <c>s3://myBucket/myPrefix</c> (where <c>myPrefix</c> is optional). - For release tasks, the list contains directory or file paths on the FSx for Lustre file system from which to release exported files. If a directory is specified, files within the directory are released. If a file path is specified, only that file is released. To release all exported files in the file system, specify a forward slash (/) as the path. A file must also meet the last accessed time criteria specified in for the file to be released. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Report_Scope</name><description><para>Required if <c>Enabled</c> is set to <c>true</c>. Specifies the scope of the <c>CompletionReport</c>; <c>FAILED_FILES_ONLY</c> is the only scope currently supported. When <c>Scope</c> is set to <c>FAILED_FILES_ONLY</c>, the <c>CompletionReport</c> only contains information about files that the data repository task failed to process. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.ReportScope</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Tag</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Type</name><description><para>Specifies the type of data repository task to create. - <c>EXPORT_TO_REPOSITORY</c> tasks export from your Amazon FSx for Lustre file system to a linked data repository. - <c>IMPORT_METADATA_FROM_REPOSITORY</c> tasks import metadata changes from a linked S3 bucket to your Amazon FSx for Lustre file system. - <c>RELEASE_DATA_FROM_FILESYSTEM</c> tasks release files in your Amazon FSx for Lustre file system that have been exported to a linked S3 bucket and that meet your specified release criteria. - <c>AUTO_RELEASE_DATA</c> tasks automatically release files from an Amazon File Cache resource. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.DataRepositoryTaskType</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DurationSinceLastAccess_Unit</name><description><para>The unit of time used by the <c>Value</c> parameter to determine if a file can be released, based on when it was last accessed. <c>DAYS</c> is the only supported value. This is a required parameter. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Unit</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DurationSinceLastAccess_Value</name><description><para>An integer that represents the minimum amount of time (in days) since a file was last accessed in the file system. Only exported files with a <c>MAX(atime, ctime, mtime)</c> timestamp that is more than this amount of time in the past (relative to the task create time) will be released. The default of <c>Value</c> is <c>0</c>. This is a required parameter. If an exported file meets the last accessed time criteria, its file or directory path must also be specified in the <c>Paths</c> parameter of the operation in order for the file to be released. </para></description><parameterValue required="true" variableLength="false">System.Int64</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'DataRepositoryTask'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.CreateDataRepositoryTaskResponse). Specifying the name of a property of type Amazon.FSx.Model.CreateDataRepositoryTaskResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the FileSystemId parameter. The -PassThru parameter is deprecated, use -Select '^FileSystemId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>CapacityToRelease</name><description><para>Specifies the amount of data to release, in GiB, by an Amazon File Cache <c>AUTO_RELEASE_DATA</c> task that automatically releases files from the cache. </para></description><parameterValue required="true" variableLength="false">System.Int64</parameterValue><type><name>System.Int64</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DurationSinceLastAccess_Unit</name><description><para>The unit of time used by the <c>Value</c> parameter to determine if a file can be released, based on when it was last accessed. <c>DAYS</c> is the only supported value. This is a required parameter. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Unit</parameterValue><type><name>Amazon.FSx.Unit</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DurationSinceLastAccess_Value</name><description><para>An integer that represents the minimum amount of time (in days) since a file was last accessed in the file system. Only exported files with a <c>MAX(atime, ctime, mtime)</c> timestamp that is more than this amount of time in the past (relative to the task create time) will be released. The default of <c>Value</c> is <c>0</c>. This is a required parameter. If an exported file meets the last accessed time criteria, its file or directory path must also be specified in the <c>Paths</c> parameter of the operation in order for the file to be released. </para></description><parameterValue required="true" variableLength="false">System.Int64</parameterValue><type><name>System.Int64</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>FileSystemId</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the FileSystemId parameter. The -PassThru parameter is deprecated, use -Select '^FileSystemId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Path</name><description><para>A list of paths for the data repository task to use when the task is processed. If a path that you provide isn't valid, the task fails. If you don't provide paths, the default behavior is to export all files to S3 (for export tasks), import all files from S3 (for import tasks), or release all exported files that meet the last accessed time criteria (for release tasks). - For export tasks, the list contains paths on the FSx for Lustre file system from which the files are exported to the Amazon S3 bucket. The default path is the file system root directory. The paths you provide need to be relative to the mount point of the file system. If the mount point is <c>/mnt/fsx</c> and <c>/mnt/fsx/path1</c> is a directory or file on the file system you want to export, then the path to provide is <c>path1</c>. - For import tasks, the list contains paths in the Amazon S3 bucket from which POSIX metadata changes are imported to the FSx for Lustre file system. The path can be an S3 bucket or prefix in the format <c>s3://myBucket/myPrefix</c> (where <c>myPrefix</c> is optional). - For release tasks, the list contains directory or file paths on the FSx for Lustre file system from which to release exported files. If a directory is specified, files within the directory are released. If a file path is specified, only that file is released. To release all exported files in the file system, specify a forward slash (/) as the path. A file must also meet the last accessed time criteria specified in for the file to be released. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Report_Enabled</name><description><para>Set <c>Enabled</c> to <c>True</c> to generate a <c>CompletionReport</c> when the task completes. If set to <c>true</c>, then you need to provide a report <c>Scope</c>, <c>Path</c>, and <c>Format</c>. Set <c>Enabled</c> to <c>False</c> if you do not want a <c>CompletionReport</c> generated when the task completes. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Report_Format</name><description><para>Required if <c>Enabled</c> is set to <c>true</c>. Specifies the format of the <c>CompletionReport</c>. <c>REPORT_CSV_20191124</c> is the only format currently supported. When <c>Format</c> is set to <c>REPORT_CSV_20191124</c>, the <c>CompletionReport</c> is provided in CSV format, and is delivered to <c>{path}/task-{id}/failures.csv</c>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.ReportFormat</parameterValue><type><name>Amazon.FSx.ReportFormat</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Report_Path</name><description><para>Required if <c>Enabled</c> is set to <c>true</c>. Specifies the location of the report on the file system's linked S3 data repository. An absolute path that defines where the completion report will be stored in the destination location. The <c>Path</c> you provide must be located within the file system’s ExportPath. An example <c>Path</c> value is "s3://myBucket/myExportPath/optionalPrefix". The report provides the following information for each file in the report: FilePath, FileStatus, and ErrorCode. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Report_Scope</name><description><para>Required if <c>Enabled</c> is set to <c>true</c>. Specifies the scope of the <c>CompletionReport</c>; <c>FAILED_FILES_ONLY</c> is the only scope currently supported. When <c>Scope</c> is set to <c>FAILED_FILES_ONLY</c>, the <c>CompletionReport</c> only contains information about files that the data repository task failed to process. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.ReportScope</parameterValue><type><name>Amazon.FSx.ReportScope</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'DataRepositoryTask'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.CreateDataRepositoryTaskResponse). Specifying the name of a property of type Amazon.FSx.Model.CreateDataRepositoryTaskResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Tag</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue><type><name>Amazon.FSx.Model.Tag[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Type</name><description><para>Specifies the type of data repository task to create. - <c>EXPORT_TO_REPOSITORY</c> tasks export from your Amazon FSx for Lustre file system to a linked data repository. - <c>IMPORT_METADATA_FROM_REPOSITORY</c> tasks import metadata changes from a linked S3 bucket to your Amazon FSx for Lustre file system. - <c>RELEASE_DATA_FROM_FILESYSTEM</c> tasks release files in your Amazon FSx for Lustre file system that have been exported to a linked S3 bucket and that meet your specified release criteria. - <c>AUTO_RELEASE_DATA</c> tasks automatically release files from an Amazon File Cache resource. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.DataRepositoryTaskType</parameterValue><type><name>Amazon.FSx.DataRepositoryTaskType</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.DataRepositoryTask or Amazon.FSx.Model.CreateDataRepositoryTaskResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.FSx.Model.DataRepositoryTask object. The service call response (type Amazon.FSx.Model.CreateDataRepositoryTaskResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=New-FSXDataRepositoryTask.html&tocid=New-FSXDataRepositoryTask</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Get-FSXVolume</name><description><para>Calls the Amazon FSx DescribeVolumes API operation.</para></description><verb>Get</verb><noun>FSXVolume</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.<br /><br />This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </para></description><syntax><syntaxItem><name>Get-FSXVolume</name><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Filter</name><description><para>Enter a filter <c>Name</c> and <c>Values</c> pair to view a select set of volumes. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.VolumeFilter[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>VolumeId</name><description><para>The IDs of the volumes whose descriptions you want to retrieve. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaxResult</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NextToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Volumes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DescribeVolumesResponse). Specifying the name of a property of type Amazon.FSx.Model.DescribeVolumesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NoAutoIteration</name><description><para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Filter</name><description><para>Enter a filter <c>Name</c> and <c>Values</c> pair to view a select set of volumes. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.VolumeFilter[]</parameterValue><type><name>Amazon.FSx.Model.VolumeFilter[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaxResult</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NextToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NoAutoIteration</name><description><para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Volumes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DescribeVolumesResponse). Specifying the name of a property of type Amazon.FSx.Model.DescribeVolumesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>VolumeId</name><description><para>The IDs of the volumes whose descriptions you want to retrieve. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.Volume or Amazon.FSx.Model.DescribeVolumesResponse</name><uri /><description /></type><description><para>This cmdlet returns a collection of Amazon.FSx.Model.Volume objects. The service call response (type Amazon.FSx.Model.DescribeVolumesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-FSXVolume.html&tocid=Get-FSXVolume</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Copy-FSXBackup</name><description><para>Calls the Amazon FSx CopyBackup API operation.</para></description><verb>Copy</verb><noun>FSXBackup</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy). You can have up to five backup copy requests in progress to a single destination Region per account. You can use cross-Region backup copies for cross-Region disaster recovery. You can periodically take backups and copy them to another Region so that in the event of a disaster in the primary Region, you can restore from backup and recover availability quickly in the other Region. You can make cross-Region copies only within your Amazon Web Services partition. A partition is a grouping of Regions. Amazon Web Services currently has three partitions: <c>aws</c> (Standard Regions), <c>aws-cn</c> (China Regions), and <c>aws-us-gov</c> (Amazon Web Services GovCloud [US] Regions). You can also use backup copies to clone your file dataset to another Region or within the same Region. You can use the <c>SourceRegion</c> parameter to specify the Amazon Web Services Region from which the backup will be copied. For example, if you make the call from the <c>us-west-1</c> Region and want to copy a backup from the <c>us-east-2</c> Region, you specify <c>us-east-2</c> in the <c>SourceRegion</c> parameter to make a cross-Region copy. If you don&#39;t specify a Region, the backup copy is created in the same Region where the request is sent from (in-Region copy). For more information about creating backup copies, see <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/using-backups.html#copy-backups"> Copying backups</a> in the <i>Amazon FSx for Windows User Guide</i>, <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html#copy-backups">Copying backups</a> in the <i>Amazon FSx for Lustre User Guide</i>, and <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/using-backups.html#copy-backups">Copying backups</a> in the <i>Amazon FSx for OpenZFS User Guide</i>. </para></description><syntax><syntaxItem><name>Copy-FSXBackup</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>SourceBackupId</name><description><para>The ID of the source backup. Specifies the ID of the backup that's being copied. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>CopyTag</name><description><para>A Boolean flag indicating whether tags from the source backup should be copied to the backup copy. This value defaults to <c>false</c>. If you set <c>CopyTags</c> to <c>true</c> and the source backup has existing tags, you can use the <c>Tags</c> parameter to create new tags, provided that the sum of the source backup tags and the new tags doesn't exceed 50. Both sets of tags are merged. If there are tag conflicts (for example, two tags with the same key but different values), the tags created with the <c>Tags</c> parameter take precedence. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>KmsKeyId</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SourceRegion</name><description><para>The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the backup is being copied. The source and destination Regions must be in the same Amazon Web Services partition. If you don't specify a Region, <c>SourceRegion</c> defaults to the Region where the request is sent from (in-Region copy). </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Tag</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Backup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.CopyBackupResponse). Specifying the name of a property of type Amazon.FSx.Model.CopyBackupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the SourceBackupId parameter. The -PassThru parameter is deprecated, use -Select '^SourceBackupId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>CopyTag</name><description><para>A Boolean flag indicating whether tags from the source backup should be copied to the backup copy. This value defaults to <c>false</c>. If you set <c>CopyTags</c> to <c>true</c> and the source backup has existing tags, you can use the <c>Tags</c> parameter to create new tags, provided that the sum of the source backup tags and the new tags doesn't exceed 50. Both sets of tags are merged. If there are tag conflicts (for example, two tags with the same key but different values), the tags created with the <c>Tags</c> parameter take precedence. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>KmsKeyId</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the SourceBackupId parameter. The -PassThru parameter is deprecated, use -Select '^SourceBackupId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Backup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.CopyBackupResponse). Specifying the name of a property of type Amazon.FSx.Model.CopyBackupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>SourceBackupId</name><description><para>The ID of the source backup. Specifies the ID of the backup that's being copied. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SourceRegion</name><description><para>The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the backup is being copied. The source and destination Regions must be in the same Amazon Web Services partition. If you don't specify a Region, <c>SourceRegion</c> defaults to the Region where the request is sent from (in-Region copy). </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Tag</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue><type><name>Amazon.FSx.Model.Tag[]</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.Backup or Amazon.FSx.Model.CopyBackupResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.FSx.Model.Backup object. The service call response (type Amazon.FSx.Model.CopyBackupResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Copy-FSXBackup.html&tocid=Copy-FSXBackup</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Update-FSXDataRepositoryAssociation</name><description><para>Calls the Amazon FSx UpdateDataRepositoryAssociation API operation.</para></description><verb>Update</verb><noun>FSXDataRepositoryAssociation</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Updates the configuration of an existing data repository association on an Amazon FSx for Lustre file system. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding <c>scratch_1</c> deployment type. </para></description><syntax><syntaxItem><name>Update-FSXDataRepositoryAssociation</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>AssociationId</name><description><para>The ID of the data repository association that you are updating. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AutoExportPolicy_Event</name><description><para>The <c>AutoExportPolicy</c> can have the following event values: - <c>NEW</c> - New files and directories are automatically exported to the data repository as they are added to the file system. - <c>CHANGED</c> - Changes to files and directories on the file system are automatically exported to the data repository. - <c>DELETED</c> - Files and directories are automatically deleted on the data repository when they are deleted on the file system. You can define any combination of event types for your <c>AutoExportPolicy</c>. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AutoImportPolicy_Event</name><description><para>The <c>AutoImportPolicy</c> can have the following event values: - <c>NEW</c> - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not currently exist in the FSx file system. - <c>CHANGED</c> - Amazon FSx automatically updates file metadata and invalidates existing file content on the file system as files change in the data repository. - <c>DELETED</c> - Amazon FSx automatically deletes files on the file system as corresponding files are deleted in the data repository. You can define any combination of event types for your <c>AutoImportPolicy</c>. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ImportedFileChunkSize</name><description><para>For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system. The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Association'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.UpdateDataRepositoryAssociationResponse). Specifying the name of a property of type Amazon.FSx.Model.UpdateDataRepositoryAssociationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the AssociationId parameter. The -PassThru parameter is deprecated, use -Select '^AssociationId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>AssociationId</name><description><para>The ID of the data repository association that you are updating. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AutoExportPolicy_Event</name><description><para>The <c>AutoExportPolicy</c> can have the following event values: - <c>NEW</c> - New files and directories are automatically exported to the data repository as they are added to the file system. - <c>CHANGED</c> - Changes to files and directories on the file system are automatically exported to the data repository. - <c>DELETED</c> - Files and directories are automatically deleted on the data repository when they are deleted on the file system. You can define any combination of event types for your <c>AutoExportPolicy</c>. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AutoImportPolicy_Event</name><description><para>The <c>AutoImportPolicy</c> can have the following event values: - <c>NEW</c> - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not currently exist in the FSx file system. - <c>CHANGED</c> - Amazon FSx automatically updates file metadata and invalidates existing file content on the file system as files change in the data repository. - <c>DELETED</c> - Amazon FSx automatically deletes files on the file system as corresponding files are deleted in the data repository. You can define any combination of event types for your <c>AutoImportPolicy</c>. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ImportedFileChunkSize</name><description><para>For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system. The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the AssociationId parameter. The -PassThru parameter is deprecated, use -Select '^AssociationId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Association'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.UpdateDataRepositoryAssociationResponse). Specifying the name of a property of type Amazon.FSx.Model.UpdateDataRepositoryAssociationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.DataRepositoryAssociation or Amazon.FSx.Model.UpdateDataRepositoryAssociationResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.FSx.Model.DataRepositoryAssociation object. The service call response (type Amazon.FSx.Model.UpdateDataRepositoryAssociationResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-FSXDataRepositoryAssociation.html&tocid=Update-FSXDataRepositoryAssociation</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Remove-FSXVolume</name><description><para>Calls the Amazon FSx DeleteVolume API operation.</para></description><verb>Remove</verb><noun>FSXVolume</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume. </para></description><syntax><syntaxItem><name>Remove-FSXVolume</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>VolumeId</name><description><para>The ID of the volume that you are deleting. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_BypassSnaplockEnterpriseRetention</name><description><para>Setting this to <c>true</c> allows a SnapLock administrator to delete an FSx for ONTAP SnapLock Enterprise volume with unexpired write once, read many (WORM) files. The IAM permission <c>fsx:BypassSnaplockEnterpriseRetention</c> is also required to delete SnapLock Enterprise volumes with unexpired WORM files. The default value is <c>false</c>. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-delete-volume.html"> Deleting a SnapLock volume</a>. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_FinalBackupTag</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_Option</name><description><para>To delete the volume's child volumes, snapshots, and clones, use the string <c>DELETE_CHILD_VOLUMES_AND_SNAPSHOTS</c>. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_SkipFinalBackup</name><description><para>Set to true if you want to skip taking a final backup of the volume you are deleting. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DeleteVolumeResponse). Specifying the name of a property of type Amazon.FSx.Model.DeleteVolumeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the VolumeId parameter. The -PassThru parameter is deprecated, use -Select '^VolumeId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_BypassSnaplockEnterpriseRetention</name><description><para>Setting this to <c>true</c> allows a SnapLock administrator to delete an FSx for ONTAP SnapLock Enterprise volume with unexpired write once, read many (WORM) files. The IAM permission <c>fsx:BypassSnaplockEnterpriseRetention</c> is also required to delete SnapLock Enterprise volumes with unexpired WORM files. The default value is <c>false</c>. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-delete-volume.html"> Deleting a SnapLock volume</a>. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_FinalBackupTag</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue><type><name>Amazon.FSx.Model.Tag[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_SkipFinalBackup</name><description><para>Set to true if you want to skip taking a final backup of the volume you are deleting. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_Option</name><description><para>To delete the volume's child volumes, snapshots, and clones, use the string <c>DELETE_CHILD_VOLUMES_AND_SNAPSHOTS</c>. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the VolumeId parameter. The -PassThru parameter is deprecated, use -Select '^VolumeId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DeleteVolumeResponse). Specifying the name of a property of type Amazon.FSx.Model.DeleteVolumeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>VolumeId</name><description><para>The ID of the volume that you are deleting. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.DeleteVolumeResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.FSx.Model.DeleteVolumeResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-FSXVolume.html&tocid=Remove-FSXVolume</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Copy-FSXSnapshotAndUpdateVolume</name><description><para>Calls the Amazon FSx CopySnapshotAndUpdateVolume API operation.</para></description><verb>Copy</verb><noun>FSXSnapshotAndUpdateVolume</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Updates an existing volume by using a snapshot from another Amazon FSx for OpenZFS file system. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/on-demand-replication.html">on-demand data replication</a> in the Amazon FSx for OpenZFS User Guide. </para></description><syntax><syntaxItem><name>Copy-FSXSnapshotAndUpdateVolume</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>VolumeId</name><description><para>Specifies the ID of the volume that you are copying the snapshot to. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>CopyStrategy</name><description><para>Specifies the strategy to use when copying data from a snapshot to the volume. - <c>FULL_COPY</c> - Copies all data from the snapshot to the volume. - <c>INCREMENTAL_COPY</c> - Copies only the snapshot data that's changed since the previous replication. <c>CLONE</c> isn't a valid copy strategy option for the <c>CopySnapshotAndUpdateVolume</c> operation. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.OpenZFSCopyStrategy</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Option</name><description><para>Confirms that you want to delete data on the destination volume that wasn’t there during the previous snapshot replication. Your replication will fail if you don’t include an option for a specific type of data and that data is on your destination. For example, if you don’t include <c>DELETE_INTERMEDIATE_SNAPSHOTS</c> and there are intermediate snapshots on the destination, you can’t copy the snapshot. - <c>DELETE_INTERMEDIATE_SNAPSHOTS</c> - Deletes snapshots on the destination volume that aren’t on the source volume. - <c>DELETE_CLONED_VOLUMES</c> - Deletes snapshot clones on the destination volume that aren't on the source volume. - <c>DELETE_INTERMEDIATE_DATA</c> - Overwrites snapshots on the destination volume that don’t match the source snapshot that you’re copying. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SourceSnapshotARN</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.CopySnapshotAndUpdateVolumeResponse). Specifying the name of a property of type Amazon.FSx.Model.CopySnapshotAndUpdateVolumeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the VolumeId parameter. The -PassThru parameter is deprecated, use -Select '^VolumeId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>CopyStrategy</name><description><para>Specifies the strategy to use when copying data from a snapshot to the volume. - <c>FULL_COPY</c> - Copies all data from the snapshot to the volume. - <c>INCREMENTAL_COPY</c> - Copies only the snapshot data that's changed since the previous replication. <c>CLONE</c> isn't a valid copy strategy option for the <c>CopySnapshotAndUpdateVolume</c> operation. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.OpenZFSCopyStrategy</parameterValue><type><name>Amazon.FSx.OpenZFSCopyStrategy</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Option</name><description><para>Confirms that you want to delete data on the destination volume that wasn’t there during the previous snapshot replication. Your replication will fail if you don’t include an option for a specific type of data and that data is on your destination. For example, if you don’t include <c>DELETE_INTERMEDIATE_SNAPSHOTS</c> and there are intermediate snapshots on the destination, you can’t copy the snapshot. - <c>DELETE_INTERMEDIATE_SNAPSHOTS</c> - Deletes snapshots on the destination volume that aren’t on the source volume. - <c>DELETE_CLONED_VOLUMES</c> - Deletes snapshot clones on the destination volume that aren't on the source volume. - <c>DELETE_INTERMEDIATE_DATA</c> - Overwrites snapshots on the destination volume that don’t match the source snapshot that you’re copying. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the VolumeId parameter. The -PassThru parameter is deprecated, use -Select '^VolumeId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.CopySnapshotAndUpdateVolumeResponse). Specifying the name of a property of type Amazon.FSx.Model.CopySnapshotAndUpdateVolumeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SourceSnapshotARN</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>VolumeId</name><description><para>Specifies the ID of the volume that you are copying the snapshot to. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.CopySnapshotAndUpdateVolumeResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.FSx.Model.CopySnapshotAndUpdateVolumeResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Copy-FSXSnapshotAndUpdateVolume.html&tocid=Copy-FSXSnapshotAndUpdateVolume</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>New-FSXStorageVirtualMachine</name><description><para>Calls the Amazon FSx CreateStorageVirtualMachine API operation.</para></description><verb>New</verb><noun>FSXStorageVirtualMachine</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system. </para></description><syntax><syntaxItem><name>New-FSXStorageVirtualMachine</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>Name</name><description><para>The name of the SVM. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SelfManagedActiveDirectoryConfiguration_DnsIp</name><description><para>A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SelfManagedActiveDirectoryConfiguration_DomainName</name><description><para>The fully qualified domain name of the self-managed AD directory, such as <c>corp.example.com</c>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SelfManagedActiveDirectoryConfiguration_FileSystemAdministratorsGroup</name><description><para>(Optional) The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that you specify must already exist in your domain. If you don't provide one, your AD domain's Domain Admins group is used. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>FileSystemId</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ActiveDirectoryConfiguration_NetBiosName</name><description><para>The NetBIOS name of the Active Directory computer object that will be created for your SVM. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SelfManagedActiveDirectoryConfiguration_OrganizationalUnitDistinguishedName</name><description><para>(Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory. Amazon FSx only accepts OU as the direct parent of the file system. An example is <c>OU=FSx,DC=yourdomain,DC=corp,DC=com</c>. To learn more, see <a href="https://tools.ietf.org/html/rfc2253">RFC 2253</a>. If none is provided, the FSx file system is created in the default location of your self-managed AD directory. <important><para>Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating.</para></important> </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SelfManagedActiveDirectoryConfiguration_Password</name><description><para>The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RootVolumeSecurityStyle</name><description><para>The security style of the root volume of the SVM. Specify one of the following values: - <c>UNIX</c> 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. - <c>NTFS</c> if the file system is managed by a Microsoft Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Microsoft Windows user as the service account. - <c>MIXED</c> This is an advanced setting. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-security-style.html">Volume security style</a> in the Amazon FSx for NetApp ONTAP User Guide. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.StorageVirtualMachineRootVolumeSecurityStyle</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SvmAdminPassword</name><description><para>The password to use when managing the SVM using the NetApp ONTAP CLI or REST API. If you do not specify a password, you can still use the file system's <c>fsxadmin</c> user to manage the SVM. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Tag</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SelfManagedActiveDirectoryConfiguration_UserName</name><description><para>The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. This account must have the permission to join computers to the domain in the organizational unit provided in <c>OrganizationalUnitDistinguishedName</c>, or in the default location of your AD domain. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'StorageVirtualMachine'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.CreateStorageVirtualMachineResponse). Specifying the name of a property of type Amazon.FSx.Model.CreateStorageVirtualMachineResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ActiveDirectoryConfiguration_NetBiosName</name><description><para>The NetBIOS name of the Active Directory computer object that will be created for your SVM. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>FileSystemId</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>Name</name><description><para>The name of the SVM. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RootVolumeSecurityStyle</name><description><para>The security style of the root volume of the SVM. Specify one of the following values: - <c>UNIX</c> 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. - <c>NTFS</c> if the file system is managed by a Microsoft Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Microsoft Windows user as the service account. - <c>MIXED</c> This is an advanced setting. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-security-style.html">Volume security style</a> in the Amazon FSx for NetApp ONTAP User Guide. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.StorageVirtualMachineRootVolumeSecurityStyle</parameterValue><type><name>Amazon.FSx.StorageVirtualMachineRootVolumeSecurityStyle</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'StorageVirtualMachine'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.CreateStorageVirtualMachineResponse). Specifying the name of a property of type Amazon.FSx.Model.CreateStorageVirtualMachineResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SelfManagedActiveDirectoryConfiguration_DnsIp</name><description><para>A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SelfManagedActiveDirectoryConfiguration_DomainName</name><description><para>The fully qualified domain name of the self-managed AD directory, such as <c>corp.example.com</c>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SelfManagedActiveDirectoryConfiguration_FileSystemAdministratorsGroup</name><description><para>(Optional) The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that you specify must already exist in your domain. If you don't provide one, your AD domain's Domain Admins group is used. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SelfManagedActiveDirectoryConfiguration_OrganizationalUnitDistinguishedName</name><description><para>(Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory. Amazon FSx only accepts OU as the direct parent of the file system. An example is <c>OU=FSx,DC=yourdomain,DC=corp,DC=com</c>. To learn more, see <a href="https://tools.ietf.org/html/rfc2253">RFC 2253</a>. If none is provided, the FSx file system is created in the default location of your self-managed AD directory. <important><para>Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating.</para></important> </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SelfManagedActiveDirectoryConfiguration_Password</name><description><para>The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SelfManagedActiveDirectoryConfiguration_UserName</name><description><para>The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. This account must have the permission to join computers to the domain in the organizational unit provided in <c>OrganizationalUnitDistinguishedName</c>, or in the default location of your AD domain. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SvmAdminPassword</name><description><para>The password to use when managing the SVM using the NetApp ONTAP CLI or REST API. If you do not specify a password, you can still use the file system's <c>fsxadmin</c> user to manage the SVM. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Tag</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue><type><name>Amazon.FSx.Model.Tag[]</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.StorageVirtualMachine or Amazon.FSx.Model.CreateStorageVirtualMachineResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.FSx.Model.StorageVirtualMachine object. The service call response (type Amazon.FSx.Model.CreateStorageVirtualMachineResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=New-FSXStorageVirtualMachine.html&tocid=New-FSXStorageVirtualMachine</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Update-FSXStorageVirtualMachine</name><description><para>Calls the Amazon FSx UpdateStorageVirtualMachine API operation.</para></description><verb>Update</verb><noun>FSXStorageVirtualMachine</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Updates an FSx for ONTAP storage virtual machine (SVM). </para></description><syntax><syntaxItem><name>Update-FSXStorageVirtualMachine</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>StorageVirtualMachineId</name><description><para>The ID of the SVM that you want to update, in the format <c>svm-0123456789abcdef0</c>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SelfManagedActiveDirectoryConfiguration_DnsIp</name><description><para>A list of up to three DNS server or domain controller IP addresses in your self-managed Active Directory domain. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SelfManagedActiveDirectoryConfiguration_DomainName</name><description><para>Specifies an updated fully qualified domain name of your self-managed Active Directory configuration. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SelfManagedActiveDirectoryConfiguration_FileSystemAdministratorsGroup</name><description><para>For FSx for ONTAP file systems only - Specifies the updated name of the self-managed Active Directory domain group whose members are granted administrative privileges for the Amazon FSx resource. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ActiveDirectoryConfiguration_NetBiosName</name><description><para>Specifies an updated NetBIOS name of the AD computer object <c>NetBiosName</c> to which an SVM is joined. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SelfManagedActiveDirectoryConfiguration_OrganizationalUnitDistinguishedName</name><description><para>Specifies an updated fully qualified distinguished name of the organization unit within your self-managed Active Directory. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SelfManagedActiveDirectoryConfiguration_Password</name><description><para>Specifies the updated password for the service account on your self-managed Active Directory domain. Amazon FSx uses this account to join to your self-managed Active Directory domain. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SvmAdminPassword</name><description><para>Specifies a new SvmAdminPassword. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SelfManagedActiveDirectoryConfiguration_UserName</name><description><para>Specifies the updated user name for the service account on your self-managed Active Directory domain. Amazon FSx uses this account to join to your self-managed Active Directory domain. This account must have the permissions required to join computers to the domain in the organizational unit provided in <c>OrganizationalUnitDistinguishedName</c>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'StorageVirtualMachine'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.UpdateStorageVirtualMachineResponse). Specifying the name of a property of type Amazon.FSx.Model.UpdateStorageVirtualMachineResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the StorageVirtualMachineId parameter. The -PassThru parameter is deprecated, use -Select '^StorageVirtualMachineId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ActiveDirectoryConfiguration_NetBiosName</name><description><para>Specifies an updated NetBIOS name of the AD computer object <c>NetBiosName</c> to which an SVM is joined. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the StorageVirtualMachineId parameter. The -PassThru parameter is deprecated, use -Select '^StorageVirtualMachineId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'StorageVirtualMachine'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.UpdateStorageVirtualMachineResponse). Specifying the name of a property of type Amazon.FSx.Model.UpdateStorageVirtualMachineResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SelfManagedActiveDirectoryConfiguration_DnsIp</name><description><para>A list of up to three DNS server or domain controller IP addresses in your self-managed Active Directory domain. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SelfManagedActiveDirectoryConfiguration_DomainName</name><description><para>Specifies an updated fully qualified domain name of your self-managed Active Directory configuration. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SelfManagedActiveDirectoryConfiguration_FileSystemAdministratorsGroup</name><description><para>For FSx for ONTAP file systems only - Specifies the updated name of the self-managed Active Directory domain group whose members are granted administrative privileges for the Amazon FSx resource. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SelfManagedActiveDirectoryConfiguration_OrganizationalUnitDistinguishedName</name><description><para>Specifies an updated fully qualified distinguished name of the organization unit within your self-managed Active Directory. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SelfManagedActiveDirectoryConfiguration_Password</name><description><para>Specifies the updated password for the service account on your self-managed Active Directory domain. Amazon FSx uses this account to join to your self-managed Active Directory domain. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SelfManagedActiveDirectoryConfiguration_UserName</name><description><para>Specifies the updated user name for the service account on your self-managed Active Directory domain. Amazon FSx uses this account to join to your self-managed Active Directory domain. This account must have the permissions required to join computers to the domain in the organizational unit provided in <c>OrganizationalUnitDistinguishedName</c>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>StorageVirtualMachineId</name><description><para>The ID of the SVM that you want to update, in the format <c>svm-0123456789abcdef0</c>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SvmAdminPassword</name><description><para>Specifies a new SvmAdminPassword. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.StorageVirtualMachine or Amazon.FSx.Model.UpdateStorageVirtualMachineResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.FSx.Model.StorageVirtualMachine object. The service call response (type Amazon.FSx.Model.UpdateStorageVirtualMachineResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-FSXStorageVirtualMachine.html&tocid=Update-FSXStorageVirtualMachine</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Update-FSXFileCache</name><description><para>Calls the Amazon FSx UpdateFileCache API operation.</para></description><verb>Update</verb><noun>FSXFileCache</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Updates the configuration of an existing Amazon File Cache resource. You can update multiple properties in a single request. </para></description><syntax><syntaxItem><name>Update-FSXFileCache</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>FileCacheId</name><description><para>The ID of the cache that you are updating. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>LustreConfiguration_WeeklyMaintenanceStartTime</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'FileCache'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.UpdateFileCacheResponse). Specifying the name of a property of type Amazon.FSx.Model.UpdateFileCacheResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the FileCacheId parameter. The -PassThru parameter is deprecated, use -Select '^FileCacheId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>FileCacheId</name><description><para>The ID of the cache that you are updating. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>LustreConfiguration_WeeklyMaintenanceStartTime</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the FileCacheId parameter. The -PassThru parameter is deprecated, use -Select '^FileCacheId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'FileCache'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.UpdateFileCacheResponse). Specifying the name of a property of type Amazon.FSx.Model.UpdateFileCacheResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.FileCache or Amazon.FSx.Model.UpdateFileCacheResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.FSx.Model.FileCache object. The service call response (type Amazon.FSx.Model.UpdateFileCacheResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-FSXFileCache.html&tocid=Update-FSXFileCache</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Remove-FSXFileSystem</name><description><para>Calls the Amazon FSx DeleteFileSystem API operation.</para></description><verb>Remove</verb><noun>FSXFileSystem</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Deletes a file system. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups and snapshots are also deleted. To delete an Amazon FSx for NetApp ONTAP file system, first delete all the volumes and storage virtual machines (SVMs) on the file system. Then provide a <c>FileSystemId</c> value to the <c>DeleteFileSystem</c> operation. By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup isn&#39;t subject to the file system&#39;s retention policy, and must be manually deleted. To delete an Amazon FSx for Lustre file system, first <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/unmounting-fs.html">unmount</a> it from every connected Amazon EC2 instance, then provide a <c>FileSystemId</c> value to the <c>DeleteFileSystem</c> operation. By default, Amazon FSx will not take a final backup when the <c>DeleteFileSystem</c> operation is invoked. On file systems not linked to an Amazon S3 bucket, set <c>SkipFinalBackup</c> to <c>false</c> to take a final backup of the file system you are deleting. Backups cannot be enabled on S3-linked file systems. To ensure all of your data is written back to S3 before deleting your file system, you can either monitor for the <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/monitoring-cloudwatch.html#auto-import-export-metrics">AgeOfOldestQueuedMessage</a> metric to be zero (if using automatic export) or you can run an <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/export-data-repo-task-dra.html">export data repository task</a>. If you have automatic export enabled and want to use an export data repository task, you have to disable automatic export before executing the export data repository task. The <c>DeleteFileSystem</c> operation returns while the file system has the <c>DELETING</c> status. You can check the file system deletion status by calling the <a href="https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileSystems.html">DescribeFileSystems</a> operation, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the <c>DescribeFileSystems</c> operation returns a <c>FileSystemNotFound</c> error. If a data repository task is in a <c>PENDING</c> or <c>EXECUTING</c> state, deleting an Amazon FSx for Lustre file system will fail with an HTTP status code 400 (Bad Request). <important><para> The data in a deleted file system is also deleted and can't be recovered by any means. </para></important> </para></description><syntax><syntaxItem><name>Remove-FSXFileSystem</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>FileSystemId</name><description><para>The ID of the file system that you want to delete. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This token is automatically filled on your behalf when using the Command Line Interface (CLI) or an Amazon Web Services SDK. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>LustreConfiguration_FinalBackupTag</name><description><para>Use if <c>SkipFinalBackup</c> is set to <c>false</c>, and you want to apply an array of tags to the final backup. If you have set the file system property <c>CopyTagsToBackups</c> to true, and you specify one or more <c>FinalBackupTags</c> when deleting a file system, Amazon FSx will not copy any existing file system tags to the backup. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_FinalBackupTag</name><description><para>A list of tags to apply to the file system's final backup. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>WindowsConfiguration_FinalBackupTag</name><description><para>A set of tags for your final backup. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_Option</name><description><para>To delete a file system if there are child volumes present below the root volume, use the string <c>DELETE_CHILD_VOLUMES_AND_SNAPSHOTS</c>. If your file system has child volumes and you don't use this option, the delete request will fail. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>LustreConfiguration_SkipFinalBackup</name><description><para>Set <c>SkipFinalBackup</c> to false if you want to take a final backup of the file system you are deleting. By default, Amazon FSx will not take a final backup on your behalf when the <c>DeleteFileSystem</c> operation is invoked. (Default = true) The <c>fsx:CreateBackup</c> permission is required if you set <c>SkipFinalBackup</c> to <c>false</c> in order to delete the file system and take a final backup. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_SkipFinalBackup</name><description><para>By default, Amazon FSx for OpenZFS takes a final backup on your behalf when the <c>DeleteFileSystem</c> operation is invoked. Doing this helps protect you from data loss, and we highly recommend taking the final backup. If you want to skip taking a final backup, set this value to <c>true</c>. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>WindowsConfiguration_SkipFinalBackup</name><description><para>By default, Amazon FSx for Windows takes a final backup on your behalf when the <c>DeleteFileSystem</c> operation is invoked. Doing this helps protect you from data loss, and we highly recommend taking the final backup. If you want to skip this backup, use this flag to do so. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DeleteFileSystemResponse). Specifying the name of a property of type Amazon.FSx.Model.DeleteFileSystemResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the FileSystemId parameter. The -PassThru parameter is deprecated, use -Select '^FileSystemId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This token is automatically filled on your behalf when using the Command Line Interface (CLI) or an Amazon Web Services SDK. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>FileSystemId</name><description><para>The ID of the file system that you want to delete. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>LustreConfiguration_FinalBackupTag</name><description><para>Use if <c>SkipFinalBackup</c> is set to <c>false</c>, and you want to apply an array of tags to the final backup. If you have set the file system property <c>CopyTagsToBackups</c> to true, and you specify one or more <c>FinalBackupTags</c> when deleting a file system, Amazon FSx will not copy any existing file system tags to the backup. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue><type><name>Amazon.FSx.Model.Tag[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>LustreConfiguration_SkipFinalBackup</name><description><para>Set <c>SkipFinalBackup</c> to false if you want to take a final backup of the file system you are deleting. By default, Amazon FSx will not take a final backup on your behalf when the <c>DeleteFileSystem</c> operation is invoked. (Default = true) The <c>fsx:CreateBackup</c> permission is required if you set <c>SkipFinalBackup</c> to <c>false</c> in order to delete the file system and take a final backup. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_FinalBackupTag</name><description><para>A list of tags to apply to the file system's final backup. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue><type><name>Amazon.FSx.Model.Tag[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_Option</name><description><para>To delete a file system if there are child volumes present below the root volume, use the string <c>DELETE_CHILD_VOLUMES_AND_SNAPSHOTS</c>. If your file system has child volumes and you don't use this option, the delete request will fail. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_SkipFinalBackup</name><description><para>By default, Amazon FSx for OpenZFS takes a final backup on your behalf when the <c>DeleteFileSystem</c> operation is invoked. Doing this helps protect you from data loss, and we highly recommend taking the final backup. If you want to skip taking a final backup, set this value to <c>true</c>. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the FileSystemId parameter. The -PassThru parameter is deprecated, use -Select '^FileSystemId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DeleteFileSystemResponse). Specifying the name of a property of type Amazon.FSx.Model.DeleteFileSystemResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>WindowsConfiguration_FinalBackupTag</name><description><para>A set of tags for your final backup. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue><type><name>Amazon.FSx.Model.Tag[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>WindowsConfiguration_SkipFinalBackup</name><description><para>By default, Amazon FSx for Windows takes a final backup on your behalf when the <c>DeleteFileSystem</c> operation is invoked. Doing this helps protect you from data loss, and we highly recommend taking the final backup. If you want to skip this backup, use this flag to do so. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.DeleteFileSystemResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.FSx.Model.DeleteFileSystemResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-FSXFileSystem.html&tocid=Remove-FSXFileSystem</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks><examples><example><title>-------------------------- EXAMPLE 1 --------------------------</title><code>Remove-FSXFileSystem -FileSystemId fs-012ff34e567890120 Confirm Are you sure you want to perform this action? Performing the operation "Remove-FSXFileSystem (DeleteFileSystem)" on target "fs-012ff34e567890120". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y FileSystemId Lifecycle WindowsResponse ------------ --------- --------------- fs-012ff34e567890120 DELETING Amazon.FSx.Model.DeleteFileSystemWindowsResponse</code><remarks><para>Description</para><para>-----------</para><para>This example removes the given FSX file system ID.</para><para /><para /></remarks></example></examples></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>New-FSXFileCache</name><description><para>Calls the Amazon FSx CreateFileCache API operation.</para></description><verb>New</verb><noun>FSXFileCache</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Creates a new Amazon File Cache resource. You can use this operation with a client request token in the request that Amazon File Cache uses to ensure idempotent creation. If a cache with the specified client request token exists and the parameters match, <c>CreateFileCache</c> returns the description of the existing cache. If a cache with the specified client request token exists and the parameters don&#39;t match, this call returns <c>IncompatibleParameterError</c>. If a file cache with the specified client request token doesn&#39;t exist, <c>CreateFileCache</c> does the following: - Creates a new, empty Amazon File Cache resourcewith an assigned ID, and an initial lifecycle state of <c>CREATING</c>. - Returns the description of the cache in JSON format. The <c>CreateFileCache</c> call returns while the cache&#39;s lifecycle state is still <c>CREATING</c>. You can check the cache creation status by calling the <a href="https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileCaches.html">DescribeFileCaches</a> operation, which returns the cache state along with other information. </para></description><syntax><syntaxItem><name>New-FSXFileCache</name><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK. By using the idempotent operation, you can retry a <c>CreateFileCache</c> operation without the risk of creating an extra cache. This approach can be useful when an initial call fails in a way that makes it unclear whether a cache 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 cache, the client receives success as long as the parameters are the same. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>CopyTagsToDataRepositoryAssociation</name><description><para>A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DataRepositoryAssociation</name><description><para>A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol. The DRA configurations must meet the following requirements: - All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time. - An NFS DRA must link to an NFS file system that supports the NFSv3 protocol. DRA automatic import and automatic export is not supported. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.FileCacheDataRepositoryAssociation[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>LustreConfiguration_DeploymentType</name><description><para>Specifies the cache deployment type, which must be <c>CACHE_1</c>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.FileCacheLustreDeploymentType</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>FileCacheType</name><description><para>The type of cache that you're creating, which must be <c>LUSTRE</c>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.FileCacheType</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>FileCacheTypeVersion</name><description><para>Sets the Lustre version for the cache that you're creating, which must be <c>2.12</c>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>KmsKeyId</name><description><para>Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a <c>KmsKeyId</c> isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html">Encrypt</a> in the <i>Key Management Service API Reference</i>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>LustreConfiguration_PerUnitStorageThroughput</name><description><para>Provisions the amount of read and write throughput for each 1 tebibyte (TiB) of cache storage capacity, in MB/s/TiB. The only supported value is <c>1000</c>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecurityGroupId</name><description><para>A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access. This list isn't returned in later requests to describe the cache. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MetadataConfiguration_StorageCapacity</name><description><para>The storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is <c>2400</c> GiB. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>StorageCapacity</name><description><para>The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SubnetId</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Tag</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>LustreConfiguration_WeeklyMaintenanceStartTime</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'FileCache'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.CreateFileCacheResponse). Specifying the name of a property of type Amazon.FSx.Model.CreateFileCacheResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK. By using the idempotent operation, you can retry a <c>CreateFileCache</c> operation without the risk of creating an extra cache. This approach can be useful when an initial call fails in a way that makes it unclear whether a cache 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 cache, the client receives success as long as the parameters are the same. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>CopyTagsToDataRepositoryAssociation</name><description><para>A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DataRepositoryAssociation</name><description><para>A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol. The DRA configurations must meet the following requirements: - All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time. - An NFS DRA must link to an NFS file system that supports the NFSv3 protocol. DRA automatic import and automatic export is not supported. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.FileCacheDataRepositoryAssociation[]</parameterValue><type><name>Amazon.FSx.Model.FileCacheDataRepositoryAssociation[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>FileCacheType</name><description><para>The type of cache that you're creating, which must be <c>LUSTRE</c>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.FileCacheType</parameterValue><type><name>Amazon.FSx.FileCacheType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>FileCacheTypeVersion</name><description><para>Sets the Lustre version for the cache that you're creating, which must be <c>2.12</c>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>KmsKeyId</name><description><para>Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a <c>KmsKeyId</c> isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html">Encrypt</a> in the <i>Key Management Service API Reference</i>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>LustreConfiguration_DeploymentType</name><description><para>Specifies the cache deployment type, which must be <c>CACHE_1</c>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.FileCacheLustreDeploymentType</parameterValue><type><name>Amazon.FSx.FileCacheLustreDeploymentType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>LustreConfiguration_PerUnitStorageThroughput</name><description><para>Provisions the amount of read and write throughput for each 1 tebibyte (TiB) of cache storage capacity, in MB/s/TiB. The only supported value is <c>1000</c>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>LustreConfiguration_WeeklyMaintenanceStartTime</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MetadataConfiguration_StorageCapacity</name><description><para>The storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is <c>2400</c> GiB. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecurityGroupId</name><description><para>A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access. This list isn't returned in later requests to describe the cache. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'FileCache'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.CreateFileCacheResponse). Specifying the name of a property of type Amazon.FSx.Model.CreateFileCacheResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>StorageCapacity</name><description><para>The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SubnetId</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Tag</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue><type><name>Amazon.FSx.Model.Tag[]</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.FileCacheCreating or Amazon.FSx.Model.CreateFileCacheResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.FSx.Model.FileCacheCreating object. The service call response (type Amazon.FSx.Model.CreateFileCacheResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=New-FSXFileCache.html&tocid=New-FSXFileCache</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Restore-FSXVolumeFromSnapshot</name><description><para>Calls the Amazon FSx RestoreVolumeFromSnapshot API operation.</para></description><verb>Restore</verb><noun>FSXVolumeFromSnapshot</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot. </para></description><syntax><syntaxItem><name>Restore-FSXVolumeFromSnapshot</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>SnapshotId</name><description><para>The ID of the source snapshot. Specifies the snapshot that you are restoring from. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Option</name><description><para>The settings used when restoring the specified volume from snapshot. - <c>DELETE_INTERMEDIATE_SNAPSHOTS</c> - Deletes snapshots between the current state and the specified snapshot. If there are intermediate snapshots and this option isn't used, <c>RestoreVolumeFromSnapshot</c> fails. - <c>DELETE_CLONED_VOLUMES</c> - Deletes any dependent clone volumes created from intermediate snapshots. If there are any dependent clone volumes and this option isn't used, <c>RestoreVolumeFromSnapshot</c> fails. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>VolumeId</name><description><para>The ID of the volume that you are restoring. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.RestoreVolumeFromSnapshotResponse). Specifying the name of a property of type Amazon.FSx.Model.RestoreVolumeFromSnapshotResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the SnapshotId parameter. The -PassThru parameter is deprecated, use -Select '^SnapshotId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Option</name><description><para>The settings used when restoring the specified volume from snapshot. - <c>DELETE_INTERMEDIATE_SNAPSHOTS</c> - Deletes snapshots between the current state and the specified snapshot. If there are intermediate snapshots and this option isn't used, <c>RestoreVolumeFromSnapshot</c> fails. - <c>DELETE_CLONED_VOLUMES</c> - Deletes any dependent clone volumes created from intermediate snapshots. If there are any dependent clone volumes and this option isn't used, <c>RestoreVolumeFromSnapshot</c> fails. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the SnapshotId parameter. The -PassThru parameter is deprecated, use -Select '^SnapshotId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.RestoreVolumeFromSnapshotResponse). Specifying the name of a property of type Amazon.FSx.Model.RestoreVolumeFromSnapshotResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>SnapshotId</name><description><para>The ID of the source snapshot. Specifies the snapshot that you are restoring from. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>VolumeId</name><description><para>The ID of the volume that you are restoring. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.RestoreVolumeFromSnapshotResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.FSx.Model.RestoreVolumeFromSnapshotResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Restore-FSXVolumeFromSnapshot.html&tocid=Restore-FSXVolumeFromSnapshot</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Get-FSXBackup</name><description><para>Calls the Amazon FSx DescribeBackups API operation.</para></description><verb>Get</verb><noun>FSXBackup</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Returns the description of a specific Amazon FSx backup, if a <c>BackupIds</c> value is provided for that backup. Otherwise, it returns all backups owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you&#39;re calling. When retrieving all backups, you can optionally specify the <c>MaxResults</c> parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a <c>NextToken</c> value in the response. In this case, send a later request with the <c>NextToken</c> request parameter set to the value of the <c>NextToken</c> value from the last response. This operation is used in an iterative process to retrieve a list of your backups. <c>DescribeBackups</c> is called first without a <c>NextToken</c> value. Then the operation continues to be called with the <c>NextToken</c> parameter set to the value of the last <c>NextToken</c> value until a response has no <c>NextToken</c> value. When using this operation, keep the following in mind: - The operation might return fewer than the <c>MaxResults</c> value of backup descriptions while still including a <c>NextToken</c> value. - The order of the backups returned in the response of one <c>DescribeBackups</c> call and the order of the backups returned across the responses of a multi-call iteration is unspecified. <br /><br />This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </para></description><syntax><syntaxItem><name>Get-FSXBackup</name><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>BackupId</name><description><para>The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a <c>BackupNotFound</c> error occurs. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Filter</name><description><para>The filters structure. The supported names are <c>file-system-id</c>, <c>backup-type</c>, <c>file-system-type</c>, and <c>volume-id</c>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Filter[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaxResult</name><description><para>Maximum number of backups to return in the response. This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the <c>MaxResults</c> parameter specified in the request and the service's internal maximum number of items per page. <br /><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br />In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br />Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NextToken</name><description><para>An opaque pagination token returned from a previous <c>DescribeBackups</c> operation. If a token is present, the operation continues the list from where the returning call left off. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Backups'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DescribeBackupsResponse). Specifying the name of a property of type Amazon.FSx.Model.DescribeBackupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NoAutoIteration</name><description><para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>BackupId</name><description><para>The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a <c>BackupNotFound</c> error occurs. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Filter</name><description><para>The filters structure. The supported names are <c>file-system-id</c>, <c>backup-type</c>, <c>file-system-type</c>, and <c>volume-id</c>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Filter[]</parameterValue><type><name>Amazon.FSx.Model.Filter[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaxResult</name><description><para>Maximum number of backups to return in the response. This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the <c>MaxResults</c> parameter specified in the request and the service's internal maximum number of items per page. <br /><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br />In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br />Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NextToken</name><description><para>An opaque pagination token returned from a previous <c>DescribeBackups</c> operation. If a token is present, the operation continues the list from where the returning call left off. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NoAutoIteration</name><description><para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Backups'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.DescribeBackupsResponse). Specifying the name of a property of type Amazon.FSx.Model.DescribeBackupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.Backup or Amazon.FSx.Model.DescribeBackupsResponse</name><uri /><description /></type><description><para>This cmdlet returns a collection of Amazon.FSx.Model.Backup objects. The service call response (type Amazon.FSx.Model.DescribeBackupsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-FSXBackup.html&tocid=Get-FSXBackup</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks><examples><example><title>-------------------------- EXAMPLE 1 --------------------------</title><code>Get-FSXBackup -Filter @{Name="file-system-id";Values=$fsx.FileSystemId} | Where-Object CreationTime -gt (Get-Date).AddDays(-1) BackupId : backup-01dac234e56782bcc CreationTime : 6/14/2019 3:35:14 AM FailureDetails : FileSystem : Amazon.FSx.Model.FileSystem KmsKeyId : arn:aws:kms:eu-west-1:123456789012:key/f1af23c4-1b23-1bde-a1f1-e1234c5af123 Lifecycle : AVAILABLE ProgressPercent : 100 ResourceARN : arn:aws:fsx:eu-west-1:123456789012:backup/backup-01dac234e56782bcc Tags : {} Type : AUTOMATIC</code><remarks><para>Description</para><para>-----------</para><para>This example fetches backups created since yesterday for the given file system id.</para><para /><para /></remarks></example></examples></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Update-FSXVolume</name><description><para>Calls the Amazon FSx UpdateVolume API operation.</para></description><verb>Update</verb><noun>FSXVolume</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Updates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume. </para></description><syntax><syntaxItem><name>Update-FSXVolume</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>VolumeId</name><description><para>The ID of the volume that you want to update, in the format <c>fsvol-0123456789abcdef0</c>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SnaplockConfiguration_AuditLogVolume</name><description><para>Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is <c>false</c>. If you set <c>AuditLogVolume</c> to <c>true</c>, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/how-snaplock-works.html#snaplock-audit-log-volume"> SnapLock audit log volumes</a>. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>TieringPolicy_CoolingPeriod</name><description><para>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 <c>AUTO</c> and <c>SNAPSHOT_ONLY</c> tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for <c>AUTO</c> and 2 days for <c>SNAPSHOT_ONLY</c>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_CopyTagsToBackup</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_DataCompressionType</name><description><para>Specifies the method used to compress the data on the volume. The compression type is <c>NONE</c> by default. - <c>NONE</c> - Doesn't compress the data on the volume. <c>NONE</c> is the default. - <c>ZSTD</c> - 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. - <c>LZ4</c> - 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. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.OpenZFSDataCompressionType</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_JunctionPath</name><description><para>Specifies the location in the SVM's namespace where the volume is mounted. The <c>JunctionPath</c> must have a leading forward slash, such as <c>/vol3</c>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Name</name><description><para>The name of the OpenZFS volume. OpenZFS root volumes are automatically named <c>FSX</c>. Child volume names must be unique among their parent volume's children. The name of the volume is part of the mount string for the OpenZFS volume. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>TieringPolicy_Name</name><description><para>Specifies the tiering policy used to transition data. Default value is <c>SNAPSHOT_ONLY</c>. - <c>SNAPSHOT_ONLY</c> - moves cold snapshots to the capacity pool storage tier. - <c>AUTO</c> - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns. - <c>ALL</c> - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier. - <c>NONE</c> - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.TieringPolicyName</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_NfsExport</name><description><para>The configuration object for mounting a Network File System (NFS) file system. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.OpenZFSNfsExport[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SnaplockConfiguration_PrivilegedDelete</name><description><para>Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. <c>PERMANENTLY_DISABLED</c> is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is <c>DISABLED</c>. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html#privileged-delete">Privileged delete</a>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.PrivilegedDelete</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_ReadOnly</name><description><para>A Boolean value indicating whether the volume is read-only. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_RecordSizeKiB</name><description><para>Specifies the record size of an OpenZFS 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 when to set a custom record size, see <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs"> Tips for maximizing performance</a> in the <i>Amazon FSx for OpenZFS User Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_SecurityStyle</name><description><para>The security style for the volume, which can be <c>UNIX</c>, <c>NTFS</c>, or <c>MIXED</c>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.SecurityStyle</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_SizeInByte</name><description><para>The configured size of the volume, in bytes. </para></description><parameterValue required="true" variableLength="false">System.Int64</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_SizeInMegabyte</name><description><para>Specifies the size of the volume in megabytes. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_SnapshotPolicy</name><description><para>Specifies the snapshot policy for the volume. There are three built-in snapshot policies: - <c>default</c>: 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. - <c>default-1weekly</c>: This policy is the same as the <c>default</c> policy except that it only retains one snapshot from the weekly schedule. - <c>none</c>: 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 <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snapshots-ontap.html#snapshot-policies">Snapshot policies</a> in the <i>Amazon FSx for NetApp ONTAP User Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_StorageCapacityQuotaGiB</name><description><para>The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume. You can specify a value of <c>-1</c> to unset a volume's storage capacity quota. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_StorageCapacityReservationGiB</name><description><para>The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved. You can specify a value of <c>-1</c> to unset a volume's storage capacity reservation. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_StorageEfficiencyEnabled</name><description><para>Default is <c>false</c>. Set to true to enable the deduplication, compression, and compaction storage efficiency features on the volume. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AutocommitPeriod_Type</name><description><para>Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to <c>NONE</c> disables autocommit. The default value is <c>NONE</c>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AutocommitPeriodType</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DefaultRetention_Type</name><description><para>Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to <c>INFINITE</c>, the files are retained forever. If you set it to <c>UNSPECIFIED</c>, the files are retained until you set an explicit retention period. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.RetentionPeriodType</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaximumRetention_Type</name><description><para>Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to <c>INFINITE</c>, the files are retained forever. If you set it to <c>UNSPECIFIED</c>, the files are retained until you set an explicit retention period. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.RetentionPeriodType</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MinimumRetention_Type</name><description><para>Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to <c>INFINITE</c>, the files are retained forever. If you set it to <c>UNSPECIFIED</c>, the files are retained until you set an explicit retention period. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.RetentionPeriodType</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_UserAndGroupQuota</name><description><para>An object specifying how much storage users or groups can use on the volume. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.OpenZFSUserOrGroupQuota[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AutocommitPeriod_Value</name><description><para>Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid: - <c>Minutes</c>: 5 - 65,535 - <c>Hours</c>: 1 - 65,535 - <c>Days</c>: 1 - 3,650 - <c>Months</c>: 1 - 120 - <c>Years</c>: 1 - 10 </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DefaultRetention_Value</name><description><para>Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for <c>INFINITE</c> or <c>UNSPECIFIED</c>. For all other options, the following ranges are valid: - <c>Seconds</c>: 0 - 65,535 - <c>Minutes</c>: 0 - 65,535 - <c>Hours</c>: 0 - 24 - <c>Days</c>: 0 - 365 - <c>Months</c>: 0 - 12 - <c>Years</c>: 0 - 100 </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaximumRetention_Value</name><description><para>Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for <c>INFINITE</c> or <c>UNSPECIFIED</c>. For all other options, the following ranges are valid: - <c>Seconds</c>: 0 - 65,535 - <c>Minutes</c>: 0 - 65,535 - <c>Hours</c>: 0 - 24 - <c>Days</c>: 0 - 365 - <c>Months</c>: 0 - 12 - <c>Years</c>: 0 - 100 </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MinimumRetention_Value</name><description><para>Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for <c>INFINITE</c> or <c>UNSPECIFIED</c>. For all other options, the following ranges are valid: - <c>Seconds</c>: 0 - 65,535 - <c>Minutes</c>: 0 - 65,535 - <c>Hours</c>: 0 - 24 - <c>Days</c>: 0 - 365 - <c>Months</c>: 0 - 12 - <c>Years</c>: 0 - 100 </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SnaplockConfiguration_VolumeAppendModeEnabled</name><description><para>Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is <c>false</c>. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-append">Volume-append mode</a>. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.UpdateVolumeResponse). Specifying the name of a property of type Amazon.FSx.Model.UpdateVolumeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the VolumeId parameter. The -PassThru parameter is deprecated, use -Select '^VolumeId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AutocommitPeriod_Type</name><description><para>Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to <c>NONE</c> disables autocommit. The default value is <c>NONE</c>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AutocommitPeriodType</parameterValue><type><name>Amazon.FSx.AutocommitPeriodType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AutocommitPeriod_Value</name><description><para>Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid: - <c>Minutes</c>: 5 - 65,535 - <c>Hours</c>: 1 - 65,535 - <c>Days</c>: 1 - 3,650 - <c>Months</c>: 1 - 120 - <c>Years</c>: 1 - 10 </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DefaultRetention_Type</name><description><para>Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to <c>INFINITE</c>, the files are retained forever. If you set it to <c>UNSPECIFIED</c>, the files are retained until you set an explicit retention period. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.RetentionPeriodType</parameterValue><type><name>Amazon.FSx.RetentionPeriodType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DefaultRetention_Value</name><description><para>Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for <c>INFINITE</c> or <c>UNSPECIFIED</c>. For all other options, the following ranges are valid: - <c>Seconds</c>: 0 - 65,535 - <c>Minutes</c>: 0 - 65,535 - <c>Hours</c>: 0 - 24 - <c>Days</c>: 0 - 365 - <c>Months</c>: 0 - 12 - <c>Years</c>: 0 - 100 </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaximumRetention_Type</name><description><para>Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to <c>INFINITE</c>, the files are retained forever. If you set it to <c>UNSPECIFIED</c>, the files are retained until you set an explicit retention period. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.RetentionPeriodType</parameterValue><type><name>Amazon.FSx.RetentionPeriodType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaximumRetention_Value</name><description><para>Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for <c>INFINITE</c> or <c>UNSPECIFIED</c>. For all other options, the following ranges are valid: - <c>Seconds</c>: 0 - 65,535 - <c>Minutes</c>: 0 - 65,535 - <c>Hours</c>: 0 - 24 - <c>Days</c>: 0 - 365 - <c>Months</c>: 0 - 12 - <c>Years</c>: 0 - 100 </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MinimumRetention_Type</name><description><para>Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to <c>INFINITE</c>, the files are retained forever. If you set it to <c>UNSPECIFIED</c>, the files are retained until you set an explicit retention period. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.RetentionPeriodType</parameterValue><type><name>Amazon.FSx.RetentionPeriodType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MinimumRetention_Value</name><description><para>Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for <c>INFINITE</c> or <c>UNSPECIFIED</c>. For all other options, the following ranges are valid: - <c>Seconds</c>: 0 - 65,535 - <c>Minutes</c>: 0 - 65,535 - <c>Hours</c>: 0 - 24 - <c>Days</c>: 0 - 365 - <c>Months</c>: 0 - 12 - <c>Years</c>: 0 - 100 </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Name</name><description><para>The name of the OpenZFS volume. OpenZFS root volumes are automatically named <c>FSX</c>. Child volume names must be unique among their parent volume's children. The name of the volume is part of the mount string for the OpenZFS volume. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_CopyTagsToBackup</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_JunctionPath</name><description><para>Specifies the location in the SVM's namespace where the volume is mounted. The <c>JunctionPath</c> must have a leading forward slash, such as <c>/vol3</c>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_SecurityStyle</name><description><para>The security style for the volume, which can be <c>UNIX</c>, <c>NTFS</c>, or <c>MIXED</c>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.SecurityStyle</parameterValue><type><name>Amazon.FSx.SecurityStyle</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_SizeInByte</name><description><para>The configured size of the volume, in bytes. </para></description><parameterValue required="true" variableLength="false">System.Int64</parameterValue><type><name>System.Int64</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_SizeInMegabyte</name><description><para>Specifies the size of the volume in megabytes. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_SnapshotPolicy</name><description><para>Specifies the snapshot policy for the volume. There are three built-in snapshot policies: - <c>default</c>: 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. - <c>default-1weekly</c>: This policy is the same as the <c>default</c> policy except that it only retains one snapshot from the weekly schedule. - <c>none</c>: 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 <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snapshots-ontap.html#snapshot-policies">Snapshot policies</a> in the <i>Amazon FSx for NetApp ONTAP User Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_StorageEfficiencyEnabled</name><description><para>Default is <c>false</c>. Set to true to enable the deduplication, compression, and compaction storage efficiency features on the volume. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_DataCompressionType</name><description><para>Specifies the method used to compress the data on the volume. The compression type is <c>NONE</c> by default. - <c>NONE</c> - Doesn't compress the data on the volume. <c>NONE</c> is the default. - <c>ZSTD</c> - 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. - <c>LZ4</c> - 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. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.OpenZFSDataCompressionType</parameterValue><type><name>Amazon.FSx.OpenZFSDataCompressionType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_NfsExport</name><description><para>The configuration object for mounting a Network File System (NFS) file system. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.OpenZFSNfsExport[]</parameterValue><type><name>Amazon.FSx.Model.OpenZFSNfsExport[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_ReadOnly</name><description><para>A Boolean value indicating whether the volume is read-only. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_RecordSizeKiB</name><description><para>Specifies the record size of an OpenZFS 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 when to set a custom record size, see <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs"> Tips for maximizing performance</a> in the <i>Amazon FSx for OpenZFS User Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_StorageCapacityQuotaGiB</name><description><para>The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume. You can specify a value of <c>-1</c> to unset a volume's storage capacity quota. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_StorageCapacityReservationGiB</name><description><para>The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved. You can specify a value of <c>-1</c> to unset a volume's storage capacity reservation. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_UserAndGroupQuota</name><description><para>An object specifying how much storage users or groups can use on the volume. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.OpenZFSUserOrGroupQuota[]</parameterValue><type><name>Amazon.FSx.Model.OpenZFSUserOrGroupQuota[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the VolumeId parameter. The -PassThru parameter is deprecated, use -Select '^VolumeId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.UpdateVolumeResponse). Specifying the name of a property of type Amazon.FSx.Model.UpdateVolumeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SnaplockConfiguration_AuditLogVolume</name><description><para>Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is <c>false</c>. If you set <c>AuditLogVolume</c> to <c>true</c>, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/how-snaplock-works.html#snaplock-audit-log-volume"> SnapLock audit log volumes</a>. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SnaplockConfiguration_PrivilegedDelete</name><description><para>Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. <c>PERMANENTLY_DISABLED</c> is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is <c>DISABLED</c>. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html#privileged-delete">Privileged delete</a>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.PrivilegedDelete</parameterValue><type><name>Amazon.FSx.PrivilegedDelete</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SnaplockConfiguration_VolumeAppendModeEnabled</name><description><para>Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is <c>false</c>. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-append">Volume-append mode</a>. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>TieringPolicy_CoolingPeriod</name><description><para>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 <c>AUTO</c> and <c>SNAPSHOT_ONLY</c> tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for <c>AUTO</c> and 2 days for <c>SNAPSHOT_ONLY</c>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>TieringPolicy_Name</name><description><para>Specifies the tiering policy used to transition data. Default value is <c>SNAPSHOT_ONLY</c>. - <c>SNAPSHOT_ONLY</c> - moves cold snapshots to the capacity pool storage tier. - <c>AUTO</c> - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns. - <c>ALL</c> - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier. - <c>NONE</c> - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.TieringPolicyName</parameterValue><type><name>Amazon.FSx.TieringPolicyName</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>VolumeId</name><description><para>The ID of the volume that you want to update, in the format <c>fsvol-0123456789abcdef0</c>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.Volume or Amazon.FSx.Model.UpdateVolumeResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.FSx.Model.Volume object. The service call response (type Amazon.FSx.Model.UpdateVolumeResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-FSXVolume.html&tocid=Update-FSXVolume</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>New-FSXVolume</name><description><para>Calls the Amazon FSx CreateVolume API operation.</para></description><verb>New</verb><noun>FSXVolume</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume. </para></description><syntax><syntaxItem><name>New-FSXVolume</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>Name</name><description><para>Specifies the name of the volume that you're creating. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AggregateConfiguration_Aggregate</name><description><para>Used to specify the names of aggregates on which the volume will be created. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SnaplockConfiguration_AuditLogVolume</name><description><para>Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is <c>false</c>. If you set <c>AuditLogVolume</c> to <c>true</c>, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/how-snaplock-works.html#snaplock-audit-log-volume"> SnapLock audit log volumes</a>. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AggregateConfiguration_ConstituentsPerAggregate</name><description><para>Used to explicitly set the number of constituents within the FlexGroup per storage aggregate. This field is optional when creating a FlexGroup volume. If unspecified, the default value will be 8. This field cannot be provided when creating a FlexVol volume. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>TieringPolicy_CoolingPeriod</name><description><para>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 <c>AUTO</c> and <c>SNAPSHOT_ONLY</c> tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for <c>AUTO</c> and 2 days for <c>SNAPSHOT_ONLY</c>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OriginSnapshot_CopyStrategy</name><description><para>Specifies the strategy used when copying data from the snapshot to the new volume. - <c>CLONE</c> - 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. - <c>FULL_COPY</c> - Copies all data from the snapshot to the new volume. Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system. The <c>INCREMENTAL_COPY</c> option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/APIReference/API_CopySnapshotAndUpdateVolume.html">CopySnapshotAndUpdateVolume</a>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.OpenZFSCopyStrategy</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_CopyTagsToBackup</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_CopyTagsToSnapshot</name><description><para>A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to <c>false</c>. If it's set to <c>true</c>, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is <c>true</c>, 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. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_DataCompressionType</name><description><para>Specifies the method used to compress the data on the volume. The compression type is <c>NONE</c> by default. - <c>NONE</c> - Doesn't compress the data on the volume. <c>NONE</c> is the default. - <c>ZSTD</c> - 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. - <c>LZ4</c> - 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 <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs"> Tips for maximizing performance</a> File system and volume settings in the <i>Amazon FSx for OpenZFS User Guide</i>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.OpenZFSDataCompressionType</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_JunctionPath</name><description><para>Specifies the location in the SVM's namespace where the volume is mounted. This parameter is required. The <c>JunctionPath</c> must have a leading forward slash, such as <c>/vol3</c>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>TieringPolicy_Name</name><description><para>Specifies the tiering policy used to transition data. Default value is <c>SNAPSHOT_ONLY</c>. - <c>SNAPSHOT_ONLY</c> - moves cold snapshots to the capacity pool storage tier. - <c>AUTO</c> - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns. - <c>ALL</c> - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier. - <c>NONE</c> - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.TieringPolicyName</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_NfsExport</name><description><para>The configuration object for mounting a Network File System (NFS) file system. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.OpenZFSNfsExport[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_OntapVolumeType</name><description><para>Specifies the type of volume you are creating. Valid values are the following: - <c>RW</c> specifies a read/write volume. <c>RW</c> is the default. - <c>DP</c> specifies a data-protection volume. A <c>DP</c> volume is read-only and can be used as the destination of a NetApp SnapMirror relationship. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-types">Volume types</a> in the Amazon FSx for NetApp ONTAP User Guide. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.InputOntapVolumeType</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_ParentVolumeId</name><description><para>The ID of the volume to use as the parent volume of the volume that you are creating. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SnaplockConfiguration_PrivilegedDelete</name><description><para>Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete WORM files even if they have active retention periods. <c>PERMANENTLY_DISABLED</c> is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is <c>DISABLED</c>. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html#privileged-delete">Privileged delete</a>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.PrivilegedDelete</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_ReadOnly</name><description><para>A Boolean value indicating whether the volume is read-only. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_RecordSizeKiB</name><description><para>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 <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#record-size-performance"> ZFS Record size</a> in the <i>Amazon FSx for OpenZFS User Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_SecurityStyle</name><description><para>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. Specify one of the following values: - <c>UNIX</c> 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. - <c>NTFS</c> 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. - <c>MIXED</c> This is an advanced setting. For more information, see the topic <a href="https://docs.netapp.com/us-en/ontap/nfs-admin/security-styles-their-effects-concept.html">What the security styles and their effects are</a> in the NetApp Documentation Center. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-security-style">Volume security style</a> in the FSx for ONTAP User Guide. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.SecurityStyle</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_SizeInByte</name><description><para>Specifies the configured size of the volume, in bytes. </para></description><parameterValue required="true" variableLength="false">System.Int64</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SnaplockConfiguration_SnaplockType</name><description><para>Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes: - <c>COMPLIANCE</c>: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-compliance.html">SnapLock Compliance</a>. - <c>ENTERPRISE</c>: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html">SnapLock Enterprise</a>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.SnaplockType</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OriginSnapshot_SnapshotARN</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_SnapshotPolicy</name><description><para>Specifies the snapshot policy for the volume. There are three built-in snapshot policies: - <c>default</c>: 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. - <c>default-1weekly</c>: This policy is the same as the <c>default</c> policy except that it only retains one snapshot from the weekly schedule. - <c>none</c>: 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 <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snapshots-ontap.html#snapshot-policies">Snapshot policies</a> in the Amazon FSx for NetApp ONTAP User Guide. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_StorageCapacityQuotaGiB</name><description><para>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 <c>StorageCapacityReservationGiB</c>. To <i>not</i> specify a storage capacity quota, set this to <c>-1</c>. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties">Volume properties</a> in the <i>Amazon FSx for OpenZFS User Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_StorageCapacityReservationGiB</name><description><para>Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. Setting <c>StorageCapacityReservationGiB</c> 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 <i>not</i> specify a storage capacity reservation, set this to <c>0</c> or <c>-1</c>. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties">Volume properties</a> in the <i>Amazon FSx for OpenZFS User Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_StorageEfficiencyEnabled</name><description><para>Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them. <c>StorageEfficiencyEnabled</c> is required when creating a <c>RW</c> volume (<c>OntapVolumeType</c> set to <c>RW</c>). </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_StorageVirtualMachineId</name><description><para>Specifies the ONTAP SVM in which to create the volume. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Tag</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AutocommitPeriod_Type</name><description><para>Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to <c>NONE</c> disables autocommit. The default value is <c>NONE</c>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AutocommitPeriodType</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DefaultRetention_Type</name><description><para>Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to <c>INFINITE</c>, the files are retained forever. If you set it to <c>UNSPECIFIED</c>, the files are retained until you set an explicit retention period. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.RetentionPeriodType</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaximumRetention_Type</name><description><para>Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to <c>INFINITE</c>, the files are retained forever. If you set it to <c>UNSPECIFIED</c>, the files are retained until you set an explicit retention period. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.RetentionPeriodType</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MinimumRetention_Type</name><description><para>Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to <c>INFINITE</c>, the files are retained forever. If you set it to <c>UNSPECIFIED</c>, the files are retained until you set an explicit retention period. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.RetentionPeriodType</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_UserAndGroupQuota</name><description><para>Configures how much storage users and groups can use on the volume. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.OpenZFSUserOrGroupQuota[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AutocommitPeriod_Value</name><description><para>Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid: - <c>Minutes</c>: 5 - 65,535 - <c>Hours</c>: 1 - 65,535 - <c>Days</c>: 1 - 3,650 - <c>Months</c>: 1 - 120 - <c>Years</c>: 1 - 10 </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DefaultRetention_Value</name><description><para>Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for <c>INFINITE</c> or <c>UNSPECIFIED</c>. For all other options, the following ranges are valid: - <c>Seconds</c>: 0 - 65,535 - <c>Minutes</c>: 0 - 65,535 - <c>Hours</c>: 0 - 24 - <c>Days</c>: 0 - 365 - <c>Months</c>: 0 - 12 - <c>Years</c>: 0 - 100 </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaximumRetention_Value</name><description><para>Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for <c>INFINITE</c> or <c>UNSPECIFIED</c>. For all other options, the following ranges are valid: - <c>Seconds</c>: 0 - 65,535 - <c>Minutes</c>: 0 - 65,535 - <c>Hours</c>: 0 - 24 - <c>Days</c>: 0 - 365 - <c>Months</c>: 0 - 12 - <c>Years</c>: 0 - 100 </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MinimumRetention_Value</name><description><para>Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for <c>INFINITE</c> or <c>UNSPECIFIED</c>. For all other options, the following ranges are valid: - <c>Seconds</c>: 0 - 65,535 - <c>Minutes</c>: 0 - 65,535 - <c>Hours</c>: 0 - 24 - <c>Days</c>: 0 - 365 - <c>Months</c>: 0 - 12 - <c>Years</c>: 0 - 100 </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SnaplockConfiguration_VolumeAppendModeEnabled</name><description><para>Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is <c>false</c>. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-append">Volume-append mode</a>. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_VolumeStyle</name><description><para>Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, FlexVol and FlexGroup volumes. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-styles">Volume styles</a> in the Amazon FSx for NetApp ONTAP User Guide. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.VolumeStyle</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>VolumeType</name><description><para>Specifies the type of volume to create; <c>ONTAP</c> and <c>OPENZFS</c> are the only valid volume types. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.VolumeType</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_SizeInMegabyte</name><description><para>Use <c>SizeInBytes</c> instead. Specifies the size of the volume, in megabytes (MB), that you are creating. This parameter is deprecated. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AggregateConfiguration_Aggregate</name><description><para>Used to specify the names of aggregates on which the volume will be created. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AggregateConfiguration_ConstituentsPerAggregate</name><description><para>Used to explicitly set the number of constituents within the FlexGroup per storage aggregate. This field is optional when creating a FlexGroup volume. If unspecified, the default value will be 8. This field cannot be provided when creating a FlexVol volume. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AutocommitPeriod_Type</name><description><para>Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to <c>NONE</c> disables autocommit. The default value is <c>NONE</c>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AutocommitPeriodType</parameterValue><type><name>Amazon.FSx.AutocommitPeriodType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AutocommitPeriod_Value</name><description><para>Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid: - <c>Minutes</c>: 5 - 65,535 - <c>Hours</c>: 1 - 65,535 - <c>Days</c>: 1 - 3,650 - <c>Months</c>: 1 - 120 - <c>Years</c>: 1 - 10 </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DefaultRetention_Type</name><description><para>Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to <c>INFINITE</c>, the files are retained forever. If you set it to <c>UNSPECIFIED</c>, the files are retained until you set an explicit retention period. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.RetentionPeriodType</parameterValue><type><name>Amazon.FSx.RetentionPeriodType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DefaultRetention_Value</name><description><para>Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for <c>INFINITE</c> or <c>UNSPECIFIED</c>. For all other options, the following ranges are valid: - <c>Seconds</c>: 0 - 65,535 - <c>Minutes</c>: 0 - 65,535 - <c>Hours</c>: 0 - 24 - <c>Days</c>: 0 - 365 - <c>Months</c>: 0 - 12 - <c>Years</c>: 0 - 100 </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaximumRetention_Type</name><description><para>Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to <c>INFINITE</c>, the files are retained forever. If you set it to <c>UNSPECIFIED</c>, the files are retained until you set an explicit retention period. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.RetentionPeriodType</parameterValue><type><name>Amazon.FSx.RetentionPeriodType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaximumRetention_Value</name><description><para>Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for <c>INFINITE</c> or <c>UNSPECIFIED</c>. For all other options, the following ranges are valid: - <c>Seconds</c>: 0 - 65,535 - <c>Minutes</c>: 0 - 65,535 - <c>Hours</c>: 0 - 24 - <c>Days</c>: 0 - 365 - <c>Months</c>: 0 - 12 - <c>Years</c>: 0 - 100 </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MinimumRetention_Type</name><description><para>Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to <c>INFINITE</c>, the files are retained forever. If you set it to <c>UNSPECIFIED</c>, the files are retained until you set an explicit retention period. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.RetentionPeriodType</parameterValue><type><name>Amazon.FSx.RetentionPeriodType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MinimumRetention_Value</name><description><para>Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for <c>INFINITE</c> or <c>UNSPECIFIED</c>. For all other options, the following ranges are valid: - <c>Seconds</c>: 0 - 65,535 - <c>Minutes</c>: 0 - 65,535 - <c>Hours</c>: 0 - 24 - <c>Days</c>: 0 - 365 - <c>Months</c>: 0 - 12 - <c>Years</c>: 0 - 100 </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>Name</name><description><para>Specifies the name of the volume that you're creating. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_CopyTagsToBackup</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_JunctionPath</name><description><para>Specifies the location in the SVM's namespace where the volume is mounted. This parameter is required. The <c>JunctionPath</c> must have a leading forward slash, such as <c>/vol3</c>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_OntapVolumeType</name><description><para>Specifies the type of volume you are creating. Valid values are the following: - <c>RW</c> specifies a read/write volume. <c>RW</c> is the default. - <c>DP</c> specifies a data-protection volume. A <c>DP</c> volume is read-only and can be used as the destination of a NetApp SnapMirror relationship. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-types">Volume types</a> in the Amazon FSx for NetApp ONTAP User Guide. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.InputOntapVolumeType</parameterValue><type><name>Amazon.FSx.InputOntapVolumeType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_SecurityStyle</name><description><para>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. Specify one of the following values: - <c>UNIX</c> 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. - <c>NTFS</c> 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. - <c>MIXED</c> This is an advanced setting. For more information, see the topic <a href="https://docs.netapp.com/us-en/ontap/nfs-admin/security-styles-their-effects-concept.html">What the security styles and their effects are</a> in the NetApp Documentation Center. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-security-style">Volume security style</a> in the FSx for ONTAP User Guide. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.SecurityStyle</parameterValue><type><name>Amazon.FSx.SecurityStyle</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_SizeInByte</name><description><para>Specifies the configured size of the volume, in bytes. </para></description><parameterValue required="true" variableLength="false">System.Int64</parameterValue><type><name>System.Int64</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_SizeInMegabyte</name><description><para>Use <c>SizeInBytes</c> instead. Specifies the size of the volume, in megabytes (MB), that you are creating. This parameter is deprecated. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_SnapshotPolicy</name><description><para>Specifies the snapshot policy for the volume. There are three built-in snapshot policies: - <c>default</c>: 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. - <c>default-1weekly</c>: This policy is the same as the <c>default</c> policy except that it only retains one snapshot from the weekly schedule. - <c>none</c>: 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 <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snapshots-ontap.html#snapshot-policies">Snapshot policies</a> in the Amazon FSx for NetApp ONTAP User Guide. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_StorageEfficiencyEnabled</name><description><para>Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them. <c>StorageEfficiencyEnabled</c> is required when creating a <c>RW</c> volume (<c>OntapVolumeType</c> set to <c>RW</c>). </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_StorageVirtualMachineId</name><description><para>Specifies the ONTAP SVM in which to create the volume. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_VolumeStyle</name><description><para>Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, FlexVol and FlexGroup volumes. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-styles">Volume styles</a> in the Amazon FSx for NetApp ONTAP User Guide. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.VolumeStyle</parameterValue><type><name>Amazon.FSx.VolumeStyle</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_CopyTagsToSnapshot</name><description><para>A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to <c>false</c>. If it's set to <c>true</c>, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is <c>true</c>, 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. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_DataCompressionType</name><description><para>Specifies the method used to compress the data on the volume. The compression type is <c>NONE</c> by default. - <c>NONE</c> - Doesn't compress the data on the volume. <c>NONE</c> is the default. - <c>ZSTD</c> - 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. - <c>LZ4</c> - 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 <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs"> Tips for maximizing performance</a> File system and volume settings in the <i>Amazon FSx for OpenZFS User Guide</i>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.OpenZFSDataCompressionType</parameterValue><type><name>Amazon.FSx.OpenZFSDataCompressionType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_NfsExport</name><description><para>The configuration object for mounting a Network File System (NFS) file system. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.OpenZFSNfsExport[]</parameterValue><type><name>Amazon.FSx.Model.OpenZFSNfsExport[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_ParentVolumeId</name><description><para>The ID of the volume to use as the parent volume of the volume that you are creating. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_ReadOnly</name><description><para>A Boolean value indicating whether the volume is read-only. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_RecordSizeKiB</name><description><para>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 <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#record-size-performance"> ZFS Record size</a> in the <i>Amazon FSx for OpenZFS User Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_StorageCapacityQuotaGiB</name><description><para>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 <c>StorageCapacityReservationGiB</c>. To <i>not</i> specify a storage capacity quota, set this to <c>-1</c>. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties">Volume properties</a> in the <i>Amazon FSx for OpenZFS User Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_StorageCapacityReservationGiB</name><description><para>Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. Setting <c>StorageCapacityReservationGiB</c> 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 <i>not</i> specify a storage capacity reservation, set this to <c>0</c> or <c>-1</c>. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties">Volume properties</a> in the <i>Amazon FSx for OpenZFS User Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_UserAndGroupQuota</name><description><para>Configures how much storage users and groups can use on the volume. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.OpenZFSUserOrGroupQuota[]</parameterValue><type><name>Amazon.FSx.Model.OpenZFSUserOrGroupQuota[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OriginSnapshot_CopyStrategy</name><description><para>Specifies the strategy used when copying data from the snapshot to the new volume. - <c>CLONE</c> - 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. - <c>FULL_COPY</c> - Copies all data from the snapshot to the new volume. Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system. The <c>INCREMENTAL_COPY</c> option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/APIReference/API_CopySnapshotAndUpdateVolume.html">CopySnapshotAndUpdateVolume</a>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.OpenZFSCopyStrategy</parameterValue><type><name>Amazon.FSx.OpenZFSCopyStrategy</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OriginSnapshot_SnapshotARN</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SnaplockConfiguration_AuditLogVolume</name><description><para>Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is <c>false</c>. If you set <c>AuditLogVolume</c> to <c>true</c>, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/how-snaplock-works.html#snaplock-audit-log-volume"> SnapLock audit log volumes</a>. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SnaplockConfiguration_PrivilegedDelete</name><description><para>Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete WORM files even if they have active retention periods. <c>PERMANENTLY_DISABLED</c> is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is <c>DISABLED</c>. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html#privileged-delete">Privileged delete</a>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.PrivilegedDelete</parameterValue><type><name>Amazon.FSx.PrivilegedDelete</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SnaplockConfiguration_SnaplockType</name><description><para>Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes: - <c>COMPLIANCE</c>: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-compliance.html">SnapLock Compliance</a>. - <c>ENTERPRISE</c>: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html">SnapLock Enterprise</a>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.SnaplockType</parameterValue><type><name>Amazon.FSx.SnaplockType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SnaplockConfiguration_VolumeAppendModeEnabled</name><description><para>Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is <c>false</c>. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-append">Volume-append mode</a>. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Tag</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue><type><name>Amazon.FSx.Model.Tag[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>TieringPolicy_CoolingPeriod</name><description><para>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 <c>AUTO</c> and <c>SNAPSHOT_ONLY</c> tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for <c>AUTO</c> and 2 days for <c>SNAPSHOT_ONLY</c>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>TieringPolicy_Name</name><description><para>Specifies the tiering policy used to transition data. Default value is <c>SNAPSHOT_ONLY</c>. - <c>SNAPSHOT_ONLY</c> - moves cold snapshots to the capacity pool storage tier. - <c>AUTO</c> - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns. - <c>ALL</c> - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier. - <c>NONE</c> - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.TieringPolicyName</parameterValue><type><name>Amazon.FSx.TieringPolicyName</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>VolumeType</name><description><para>Specifies the type of volume to create; <c>ONTAP</c> and <c>OPENZFS</c> are the only valid volume types. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.VolumeType</parameterValue><type><name>Amazon.FSx.VolumeType</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.Volume or Amazon.FSx.Model.CreateVolumeResponse</name><uri /><description /></type><description><para>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.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=New-FSXVolume.html&tocid=New-FSXVolume</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>New-FSXFileSystem</name><description><para>Calls the Amazon FSx CreateFileSystem API operation.</para></description><verb>New</verb><noun>FSXFileSystem</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Creates a new, empty Amazon FSx file system. You can create the following supported Amazon FSx file systems using the <c>CreateFileSystem</c> API operation: - Amazon FSx for Lustre - Amazon FSx for NetApp ONTAP - Amazon FSx for OpenZFS - Amazon FSx for Windows File Server This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a <c>CreateFileSystem</c> operation 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 success as long as the parameters are the same. If a file system with the specified client request token exists and the parameters match, <c>CreateFileSystem</c> returns the description of the existing file system. If a file system with the specified client request token exists and the parameters don&#39;t match, this call returns <c>IncompatibleParameterError</c>. If a file system with the specified client request token doesn&#39;t exist, <c>CreateFileSystem</c> does the following: - Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of <c>CREATING</c>. - Returns the description of the file system in JSON format. The <c>CreateFileSystem</c> call returns while the file system&#39;s lifecycle state is still <c>CREATING</c>. You can check the file-system creation status by calling the <a href="https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileSystems.html">DescribeFileSystems</a> operation, which returns the file system state along with other information. </para></description><syntax><syntaxItem><name>New-FSXFileSystem</name><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_AutomaticBackupRetentionDay</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_AutomaticBackupRetentionDay</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_CopyTagsToBackup</name><description><para>A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to <c>false</c>. If it's set to <c>true</c>, 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 <c>true</c>, 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. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RootVolumeConfiguration_CopyTagsToSnapshot</name><description><para>A Boolean value indicating whether tags for the volume should be copied to snapshots of the volume. This value defaults to <c>false</c>. If it's set to <c>true</c>, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is <c>true</c> 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. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_CopyTagsToVolume</name><description><para>A Boolean value indicating whether tags for the file system should be copied to volumes. This value defaults to <c>false</c>. If it's set to <c>true</c>, all tags for the file system are copied to volumes where the user doesn't specify tags. If this value is <c>true</c>, 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. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_DailyAutomaticBackupStartTime</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_DailyAutomaticBackupStartTime</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RootVolumeConfiguration_DataCompressionType</name><description><para>Specifies the method used to compress the data on the volume. The compression type is <c>NONE</c> by default. - <c>NONE</c> - Doesn't compress the data on the volume. <c>NONE</c> is the default. - <c>ZSTD</c> - 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. - <c>LZ4</c> - 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. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.OpenZFSDataCompressionType</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_DeploymentType</name><description><para>Specifies the FSx for ONTAP file system deployment type to use in creating the file system. - <c>MULTI_AZ_1</c> - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system. - <c>MULTI_AZ_2</c> - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system. - <c>SINGLE_AZ_1</c> - A file system configured for Single-AZ redundancy. This is a first-generation FSx for ONTAP file system. - <c>SINGLE_AZ_2</c> - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second-generation FSx for ONTAP file system. For information about the use cases for Multi-AZ and Single-AZ deployments, refer to <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-AZ.html">Choosing a file system deployment type</a>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.OntapDeploymentType</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_DeploymentType</name><description><para>Specifies the file system deployment type. Valid values are the following: - <c>MULTI_AZ_1</c>- 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. - <c>SINGLE_AZ_HA_2</c>- 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. - <c>SINGLE_AZ_HA_1</c>- 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. - <c>SINGLE_AZ_2</c>- 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. - <c>SINGLE_AZ_1</c>- 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 <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/availability-durability.html#available-aws-regions">Deployment type availability</a>. For more information on the differences in performance between deployment types, see <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#zfs-fs-performance">File system performance</a> in the <i>Amazon FSx for OpenZFS User Guide</i>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.OpenZFSDeploymentType</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_EndpointIpAddressRange</name><description><para>(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, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_EndpointIpAddressRange</name><description><para>(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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>FileSystemType</name><description><para>The type of Amazon FSx file system to create. Valid values are <c>WINDOWS</c>, <c>LUSTRE</c>, <c>ONTAP</c>, and <c>OPENZFS</c>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.FileSystemType</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>FileSystemTypeVersion</name><description><para>For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating. Valid values are <c>2.10</c>, <c>2.12</c>, and <c>2.15</c>: - <c>2.10</c> is supported by the Scratch and Persistent_1 Lustre deployment types. - <c>2.12</c> is supported by all Lustre deployment types, except for <c>PERSISTENT_2</c> with a metadata configuration mode. - <c>2.15</c> is supported by all Lustre deployment types and is recommended for all new file systems. Default value is <c>2.10</c>, except for the following deployments: - Default value is <c>2.12</c> when <c>DeploymentType</c> is set to <c>PERSISTENT_2</c> without a metadata configuration mode. - Default value is <c>2.15</c> when <c>DeploymentType</c> is set to <c>PERSISTENT_2</c> with a metadata configuration mode. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_FsxAdminPassword</name><description><para>The ONTAP administrative password for the <c>fsxadmin</c> user with which you administer your file system using the NetApp ONTAP CLI and REST API. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_HAPair</name><description><para>Specifies how many high-availability (HA) pairs of file servers will power your file system. First-generation file systems are powered by 1 HA pair. Second-generation multi-AZ file systems are powered by 1 HA pair. Second generation single-AZ file systems are powered by up to 12 HA pairs. The default value is 1. The value of this property affects the values of <c>StorageCapacity</c>, <c>Iops</c>, and <c>ThroughputCapacity</c>. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/administering-file-systems.html#HA-pairs">High-availability (HA) pairs</a> in the FSx for ONTAP user guide. Block storage protocol support (iSCSI and NVMe over TCP) is disabled on file systems with more than 6 HA pairs. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/supported-fsx-clients.html#using-block-storage">Using block storage protocols</a>. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: - The value of <c>HAPairs</c> is less than 1 or greater than 12. - The value of <c>HAPairs</c> is greater than 1 and the value of <c>DeploymentType</c> is <c>SINGLE_AZ_1</c>, <c>MULTI_AZ_1</c>, or <c>MULTI_AZ_2</c>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_DiskIopsConfiguration_Iops</name><description><para>The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of <c>HAPairs</c> and <c>StorageCapacity</c>. The minimum value is calculated as <c>StorageCapacity</c> * 3 * <c>HAPairs</c> (3 IOPS per GB of <c>StorageCapacity</c>). The maximum value is calculated as 200,000 * <c>HAPairs</c>. Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of <c>Iops</c> is outside of the minimum or maximum values. </para></description><parameterValue required="true" variableLength="false">System.Int64</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_DiskIopsConfiguration_Iops</name><description><para>The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of <c>HAPairs</c> and <c>StorageCapacity</c>. The minimum value is calculated as <c>StorageCapacity</c> * 3 * <c>HAPairs</c> (3 IOPS per GB of <c>StorageCapacity</c>). The maximum value is calculated as 200,000 * <c>HAPairs</c>. Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of <c>Iops</c> is outside of the minimum or maximum values. </para></description><parameterValue required="true" variableLength="false">System.Int64</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>KmsKeyId</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>LustreConfiguration</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.CreateFileSystemLustreConfiguration</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_DiskIopsConfiguration_Mode</name><description><para>Specifies whether the file system is using the <c>AUTOMATIC</c> setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a <c>USER_PROVISIONED</c> value. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.DiskIopsConfigurationMode</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_DiskIopsConfiguration_Mode</name><description><para>Specifies whether the file system is using the <c>AUTOMATIC</c> setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a <c>USER_PROVISIONED</c> value. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.DiskIopsConfigurationMode</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RootVolumeConfiguration_NfsExport</name><description><para>The configuration object for mounting a file system. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.OpenZFSNfsExport[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_PreferredSubnetId</name><description><para>Required when <c>DeploymentType</c> is set to <c>MULTI_AZ_1</c> or <c>MULTI_AZ_2</c>. This specifies the subnet in which you want the preferred file server to be located. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_PreferredSubnetId</name><description><para>Required when <c>DeploymentType</c> is set to <c>MULTI_AZ_1</c>. This specifies the subnet in which you want the preferred file server to be located. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RootVolumeConfiguration_ReadOnly</name><description><para>A Boolean value indicating whether the volume is read-only. Setting this value to <c>true</c> can be useful after you have completed changes to a volume and no longer want changes to occur. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RootVolumeConfiguration_RecordSizeKiB</name><description><para>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 <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs"> Tips for maximizing performance</a> in the <i>Amazon FSx for OpenZFS User Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_RouteTableId</name><description><para>(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. Amazon FSx manages these route tables for Multi-AZ file systems using tag-based authentication. These route tables are tagged with <c>Key: AmazonFSx; Value: ManagedByAmazonFSx</c>. When creating FSx for ONTAP Multi-AZ file systems using CloudFormation we recommend that you add the <c>Key: AmazonFSx; Value: ManagedByAmazonFSx</c> tag manually. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_RouteTableId</name><description><para>(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. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecurityGroupId</name><description><para>A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system. <important><para>You must specify a security group if you are creating a Multi-AZ FSx for ONTAP file system in a VPC subnet that has been shared with you.</para></important> </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>StorageCapacity</name><description><para>Sets the storage capacity of the file system that you're creating, in gibibytes (GiB). <b>FSx for Lustre file systems</b> - The amount of storage capacity that you can configure depends on the value that you set for <c>StorageType</c> and the Lustre <c>DeploymentType</c>, as follows: - For <c>SCRATCH_2</c>, <c>PERSISTENT_2</c>, and <c>PERSISTENT_1</c> deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB. - For <c>PERSISTENT_1</c> HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems. - For <c>SCRATCH_1</c> deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB. <b>FSx for ONTAP file systems</b> - The amount of storage capacity that you can configure depends on the value of the <c>HAPairs</c> property. The minimum value is calculated as 1,024 * <c>HAPairs</c> and the maximum is calculated as 524,288 * <c>HAPairs</c>. <b>FSx for OpenZFS file systems</b> - The amount of storage capacity that you can configure is from 64 GiB up to 524,288 GiB (512 TiB). <b>FSx for Windows File Server file systems</b> - The amount of storage capacity that you can configure depends on the value that you set for <c>StorageType</c> as follows: - For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB). - For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB). </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>StorageType</name><description><para>Sets the storage type for the file system that you're creating. Valid values are <c>SSD</c> and <c>HDD</c>. - Set to <c>SSD</c> to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types. - Set to <c>HDD</c> to use hard disk drive storage. HDD is supported on <c>SINGLE_AZ_2</c> and <c>MULTI_AZ_1</c> Windows file system deployment types, and on <c>PERSISTENT_1</c> Lustre file system deployment types. Default value is <c>SSD</c>. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/optimize-fsx-costs.html#storage-type-options"> Storage type options</a> in the <i>FSx for Windows File Server User Guide</i> and <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/what-is.html#storage-options">Multiple storage options</a> in the <i>FSx for Lustre User Guide</i>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.StorageType</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SubnetId</name><description><para>Specifies the IDs of the subnets that the file system will be accessible from. For Windows and ONTAP <c>MULTI_AZ_1</c> 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 <c>WindowsConfiguration > PreferredSubnetID</c> or <c>OntapConfiguration > PreferredSubnetID</c> properties. For more information about Multi-AZ file system configuration, see <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html"> Availability and durability: Single-AZ and Multi-AZ file systems</a> in the <i>Amazon FSx for Windows User Guide</i> and <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-multiAZ.html"> Availability and durability</a> in the <i>Amazon FSx for ONTAP User Guide</i>. For Windows <c>SINGLE_AZ_1</c> and <c>SINGLE_AZ_2</c> and all Lustre deployment types, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Tag</name><description><para>The tags to apply to the file system that's being created. The key value of the <c>Name</c> tag appears in the console as the file system name. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_ThroughputCapacity</name><description><para>Sets the throughput capacity for the file system that you're creating in megabytes per second (MBps). For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-throughput-capacity.html">Managing throughput capacity</a> in the FSx for ONTAP User Guide. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: - The value of <c>ThroughputCapacity</c> and <c>ThroughputCapacityPerHAPair</c> are not the same value. - The value of <c>ThroughputCapacity</c> when divided by the value of <c>HAPairs</c> is outside of the valid range for <c>ThroughputCapacity</c>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_ThroughputCapacity</name><description><para>Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps). Valid values depend on the DeploymentType you choose, as follows: - For <c>MULTI_AZ_1</c> and <c>SINGLE_AZ_2</c>, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MBps. - For <c>SINGLE_AZ_1</c>, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MBps. You pay for additional throughput capacity that you provision. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_ThroughputCapacityPerHAPair</name><description><para>Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system. You can define either the <c>ThroughputCapacityPerHAPair</c> or the <c>ThroughputCapacity</c> when creating a file system, but not both. This field and <c>ThroughputCapacity</c> are the same for file systems powered by one HA pair. - For <c>SINGLE_AZ_1</c> and <c>MULTI_AZ_1</c> file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps. - For <c>SINGLE_AZ_2</c>, valid values are 1536, 3072, or 6144 MBps. - For <c>MULTI_AZ_2</c>, valid values are 384, 768, 1536, 3072, or 6144 MBps. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: - The value of <c>ThroughputCapacity</c> and <c>ThroughputCapacityPerHAPair</c> are not the same value for file systems with one HA pair. - The value of deployment type is <c>SINGLE_AZ_2</c> and <c>ThroughputCapacity</c> / <c>ThroughputCapacityPerHAPair</c> is not a valid HA pair (a value between 1 and 12). - The value of <c>ThroughputCapacityPerHAPair</c> is not a valid value. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RootVolumeConfiguration_UserAndGroupQuota</name><description><para>An object specifying how much storage users or groups can use on the volume. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.OpenZFSUserOrGroupQuota[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_WeeklyMaintenanceStartTime</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_WeeklyMaintenanceStartTime</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>WindowsConfiguration</name><description><para>The Microsoft Windows configuration for the file system that's being created. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.CreateFileSystemWindowsConfiguration</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.CreateFileSystemResponse). Specifying the name of a property of type Amazon.FSx.Model.CreateFileSystemResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>FileSystemType</name><description><para>The type of Amazon FSx file system to create. Valid values are <c>WINDOWS</c>, <c>LUSTRE</c>, <c>ONTAP</c>, and <c>OPENZFS</c>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.FileSystemType</parameterValue><type><name>Amazon.FSx.FileSystemType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>FileSystemTypeVersion</name><description><para>For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating. Valid values are <c>2.10</c>, <c>2.12</c>, and <c>2.15</c>: - <c>2.10</c> is supported by the Scratch and Persistent_1 Lustre deployment types. - <c>2.12</c> is supported by all Lustre deployment types, except for <c>PERSISTENT_2</c> with a metadata configuration mode. - <c>2.15</c> is supported by all Lustre deployment types and is recommended for all new file systems. Default value is <c>2.10</c>, except for the following deployments: - Default value is <c>2.12</c> when <c>DeploymentType</c> is set to <c>PERSISTENT_2</c> without a metadata configuration mode. - Default value is <c>2.15</c> when <c>DeploymentType</c> is set to <c>PERSISTENT_2</c> with a metadata configuration mode. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>KmsKeyId</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>LustreConfiguration</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.CreateFileSystemLustreConfiguration</parameterValue><type><name>Amazon.FSx.Model.CreateFileSystemLustreConfiguration</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_AutomaticBackupRetentionDay</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_DailyAutomaticBackupStartTime</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_DeploymentType</name><description><para>Specifies the FSx for ONTAP file system deployment type to use in creating the file system. - <c>MULTI_AZ_1</c> - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system. - <c>MULTI_AZ_2</c> - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system. - <c>SINGLE_AZ_1</c> - A file system configured for Single-AZ redundancy. This is a first-generation FSx for ONTAP file system. - <c>SINGLE_AZ_2</c> - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second-generation FSx for ONTAP file system. For information about the use cases for Multi-AZ and Single-AZ deployments, refer to <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-AZ.html">Choosing a file system deployment type</a>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.OntapDeploymentType</parameterValue><type><name>Amazon.FSx.OntapDeploymentType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_DiskIopsConfiguration_Iops</name><description><para>The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of <c>HAPairs</c> and <c>StorageCapacity</c>. The minimum value is calculated as <c>StorageCapacity</c> * 3 * <c>HAPairs</c> (3 IOPS per GB of <c>StorageCapacity</c>). The maximum value is calculated as 200,000 * <c>HAPairs</c>. Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of <c>Iops</c> is outside of the minimum or maximum values. </para></description><parameterValue required="true" variableLength="false">System.Int64</parameterValue><type><name>System.Int64</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_DiskIopsConfiguration_Mode</name><description><para>Specifies whether the file system is using the <c>AUTOMATIC</c> setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a <c>USER_PROVISIONED</c> value. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.DiskIopsConfigurationMode</parameterValue><type><name>Amazon.FSx.DiskIopsConfigurationMode</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_EndpointIpAddressRange</name><description><para>(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, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_FsxAdminPassword</name><description><para>The ONTAP administrative password for the <c>fsxadmin</c> user with which you administer your file system using the NetApp ONTAP CLI and REST API. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_HAPair</name><description><para>Specifies how many high-availability (HA) pairs of file servers will power your file system. First-generation file systems are powered by 1 HA pair. Second-generation multi-AZ file systems are powered by 1 HA pair. Second generation single-AZ file systems are powered by up to 12 HA pairs. The default value is 1. The value of this property affects the values of <c>StorageCapacity</c>, <c>Iops</c>, and <c>ThroughputCapacity</c>. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/administering-file-systems.html#HA-pairs">High-availability (HA) pairs</a> in the FSx for ONTAP user guide. Block storage protocol support (iSCSI and NVMe over TCP) is disabled on file systems with more than 6 HA pairs. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/supported-fsx-clients.html#using-block-storage">Using block storage protocols</a>. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: - The value of <c>HAPairs</c> is less than 1 or greater than 12. - The value of <c>HAPairs</c> is greater than 1 and the value of <c>DeploymentType</c> is <c>SINGLE_AZ_1</c>, <c>MULTI_AZ_1</c>, or <c>MULTI_AZ_2</c>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_PreferredSubnetId</name><description><para>Required when <c>DeploymentType</c> is set to <c>MULTI_AZ_1</c> or <c>MULTI_AZ_2</c>. This specifies the subnet in which you want the preferred file server to be located. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_RouteTableId</name><description><para>(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. Amazon FSx manages these route tables for Multi-AZ file systems using tag-based authentication. These route tables are tagged with <c>Key: AmazonFSx; Value: ManagedByAmazonFSx</c>. When creating FSx for ONTAP Multi-AZ file systems using CloudFormation we recommend that you add the <c>Key: AmazonFSx; Value: ManagedByAmazonFSx</c> tag manually. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_ThroughputCapacity</name><description><para>Sets the throughput capacity for the file system that you're creating in megabytes per second (MBps). For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-throughput-capacity.html">Managing throughput capacity</a> in the FSx for ONTAP User Guide. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: - The value of <c>ThroughputCapacity</c> and <c>ThroughputCapacityPerHAPair</c> are not the same value. - The value of <c>ThroughputCapacity</c> when divided by the value of <c>HAPairs</c> is outside of the valid range for <c>ThroughputCapacity</c>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_ThroughputCapacityPerHAPair</name><description><para>Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system. You can define either the <c>ThroughputCapacityPerHAPair</c> or the <c>ThroughputCapacity</c> when creating a file system, but not both. This field and <c>ThroughputCapacity</c> are the same for file systems powered by one HA pair. - For <c>SINGLE_AZ_1</c> and <c>MULTI_AZ_1</c> file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps. - For <c>SINGLE_AZ_2</c>, valid values are 1536, 3072, or 6144 MBps. - For <c>MULTI_AZ_2</c>, valid values are 384, 768, 1536, 3072, or 6144 MBps. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: - The value of <c>ThroughputCapacity</c> and <c>ThroughputCapacityPerHAPair</c> are not the same value for file systems with one HA pair. - The value of deployment type is <c>SINGLE_AZ_2</c> and <c>ThroughputCapacity</c> / <c>ThroughputCapacityPerHAPair</c> is not a valid HA pair (a value between 1 and 12). - The value of <c>ThroughputCapacityPerHAPair</c> is not a valid value. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_WeeklyMaintenanceStartTime</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_AutomaticBackupRetentionDay</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_CopyTagsToBackup</name><description><para>A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to <c>false</c>. If it's set to <c>true</c>, 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 <c>true</c>, 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. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_CopyTagsToVolume</name><description><para>A Boolean value indicating whether tags for the file system should be copied to volumes. This value defaults to <c>false</c>. If it's set to <c>true</c>, all tags for the file system are copied to volumes where the user doesn't specify tags. If this value is <c>true</c>, 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. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_DailyAutomaticBackupStartTime</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_DeploymentType</name><description><para>Specifies the file system deployment type. Valid values are the following: - <c>MULTI_AZ_1</c>- 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. - <c>SINGLE_AZ_HA_2</c>- 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. - <c>SINGLE_AZ_HA_1</c>- 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. - <c>SINGLE_AZ_2</c>- 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. - <c>SINGLE_AZ_1</c>- 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 <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/availability-durability.html#available-aws-regions">Deployment type availability</a>. For more information on the differences in performance between deployment types, see <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#zfs-fs-performance">File system performance</a> in the <i>Amazon FSx for OpenZFS User Guide</i>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.OpenZFSDeploymentType</parameterValue><type><name>Amazon.FSx.OpenZFSDeploymentType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_DiskIopsConfiguration_Iops</name><description><para>The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of <c>HAPairs</c> and <c>StorageCapacity</c>. The minimum value is calculated as <c>StorageCapacity</c> * 3 * <c>HAPairs</c> (3 IOPS per GB of <c>StorageCapacity</c>). The maximum value is calculated as 200,000 * <c>HAPairs</c>. Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of <c>Iops</c> is outside of the minimum or maximum values. </para></description><parameterValue required="true" variableLength="false">System.Int64</parameterValue><type><name>System.Int64</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_DiskIopsConfiguration_Mode</name><description><para>Specifies whether the file system is using the <c>AUTOMATIC</c> setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a <c>USER_PROVISIONED</c> value. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.DiskIopsConfigurationMode</parameterValue><type><name>Amazon.FSx.DiskIopsConfigurationMode</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_EndpointIpAddressRange</name><description><para>(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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_PreferredSubnetId</name><description><para>Required when <c>DeploymentType</c> is set to <c>MULTI_AZ_1</c>. This specifies the subnet in which you want the preferred file server to be located. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_RouteTableId</name><description><para>(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. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_ThroughputCapacity</name><description><para>Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps). Valid values depend on the DeploymentType you choose, as follows: - For <c>MULTI_AZ_1</c> and <c>SINGLE_AZ_2</c>, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MBps. - For <c>SINGLE_AZ_1</c>, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MBps. You pay for additional throughput capacity that you provision. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenZFSConfiguration_WeeklyMaintenanceStartTime</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RootVolumeConfiguration_CopyTagsToSnapshot</name><description><para>A Boolean value indicating whether tags for the volume should be copied to snapshots of the volume. This value defaults to <c>false</c>. If it's set to <c>true</c>, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is <c>true</c> 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. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RootVolumeConfiguration_DataCompressionType</name><description><para>Specifies the method used to compress the data on the volume. The compression type is <c>NONE</c> by default. - <c>NONE</c> - Doesn't compress the data on the volume. <c>NONE</c> is the default. - <c>ZSTD</c> - 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. - <c>LZ4</c> - 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. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.OpenZFSDataCompressionType</parameterValue><type><name>Amazon.FSx.OpenZFSDataCompressionType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RootVolumeConfiguration_NfsExport</name><description><para>The configuration object for mounting a file system. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.OpenZFSNfsExport[]</parameterValue><type><name>Amazon.FSx.Model.OpenZFSNfsExport[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RootVolumeConfiguration_ReadOnly</name><description><para>A Boolean value indicating whether the volume is read-only. Setting this value to <c>true</c> can be useful after you have completed changes to a volume and no longer want changes to occur. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RootVolumeConfiguration_RecordSizeKiB</name><description><para>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 <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs"> Tips for maximizing performance</a> in the <i>Amazon FSx for OpenZFS User Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RootVolumeConfiguration_UserAndGroupQuota</name><description><para>An object specifying how much storage users or groups can use on the volume. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.OpenZFSUserOrGroupQuota[]</parameterValue><type><name>Amazon.FSx.Model.OpenZFSUserOrGroupQuota[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecurityGroupId</name><description><para>A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system. <important><para>You must specify a security group if you are creating a Multi-AZ FSx for ONTAP file system in a VPC subnet that has been shared with you.</para></important> </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.CreateFileSystemResponse). Specifying the name of a property of type Amazon.FSx.Model.CreateFileSystemResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>StorageCapacity</name><description><para>Sets the storage capacity of the file system that you're creating, in gibibytes (GiB). <b>FSx for Lustre file systems</b> - The amount of storage capacity that you can configure depends on the value that you set for <c>StorageType</c> and the Lustre <c>DeploymentType</c>, as follows: - For <c>SCRATCH_2</c>, <c>PERSISTENT_2</c>, and <c>PERSISTENT_1</c> deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB. - For <c>PERSISTENT_1</c> HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems. - For <c>SCRATCH_1</c> deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB. <b>FSx for ONTAP file systems</b> - The amount of storage capacity that you can configure depends on the value of the <c>HAPairs</c> property. The minimum value is calculated as 1,024 * <c>HAPairs</c> and the maximum is calculated as 524,288 * <c>HAPairs</c>. <b>FSx for OpenZFS file systems</b> - The amount of storage capacity that you can configure is from 64 GiB up to 524,288 GiB (512 TiB). <b>FSx for Windows File Server file systems</b> - The amount of storage capacity that you can configure depends on the value that you set for <c>StorageType</c> as follows: - For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB). - For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB). </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>StorageType</name><description><para>Sets the storage type for the file system that you're creating. Valid values are <c>SSD</c> and <c>HDD</c>. - Set to <c>SSD</c> to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types. - Set to <c>HDD</c> to use hard disk drive storage. HDD is supported on <c>SINGLE_AZ_2</c> and <c>MULTI_AZ_1</c> Windows file system deployment types, and on <c>PERSISTENT_1</c> Lustre file system deployment types. Default value is <c>SSD</c>. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/optimize-fsx-costs.html#storage-type-options"> Storage type options</a> in the <i>FSx for Windows File Server User Guide</i> and <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/what-is.html#storage-options">Multiple storage options</a> in the <i>FSx for Lustre User Guide</i>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.StorageType</parameterValue><type><name>Amazon.FSx.StorageType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SubnetId</name><description><para>Specifies the IDs of the subnets that the file system will be accessible from. For Windows and ONTAP <c>MULTI_AZ_1</c> 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 <c>WindowsConfiguration > PreferredSubnetID</c> or <c>OntapConfiguration > PreferredSubnetID</c> properties. For more information about Multi-AZ file system configuration, see <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html"> Availability and durability: Single-AZ and Multi-AZ file systems</a> in the <i>Amazon FSx for Windows User Guide</i> and <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-multiAZ.html"> Availability and durability</a> in the <i>Amazon FSx for ONTAP User Guide</i>. For Windows <c>SINGLE_AZ_1</c> and <c>SINGLE_AZ_2</c> and all Lustre deployment types, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Tag</name><description><para>The tags to apply to the file system that's being created. The key value of the <c>Name</c> tag appears in the console as the file system name. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue><type><name>Amazon.FSx.Model.Tag[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>WindowsConfiguration</name><description><para>The Microsoft Windows configuration for the file system that's being created. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.CreateFileSystemWindowsConfiguration</parameterValue><type><name>Amazon.FSx.Model.CreateFileSystemWindowsConfiguration</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.FileSystem or Amazon.FSx.Model.CreateFileSystemResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.FSx.Model.FileSystem object. The service call response (type Amazon.FSx.Model.CreateFileSystemResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=New-FSXFileSystem.html&tocid=New-FSXFileSystem</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks><examples><example><title>-------------------------- EXAMPLE 1 --------------------------</title><code>New-FSXFileSystem -FileSystemType WINDOWS -StorageCapacity 300 -SubnetId subnet-1a2b3c4d5e6f -WindowsConfiguration @{ThroughputCapacity=8;ActiveDirectoryId='d-1a2b3c4d'} CreationTime : 12/10/2018 6:06:59 PM DNSName : fs-abcdef01234567890.example.com FailureDetails : FileSystemId : fs-abcdef01234567890 FileSystemType : WINDOWS KmsKeyId : arn:aws:kms:us-west-2:123456789012:key/a1234567-252c-45e9-afaa-123456789abc Lifecycle : CREATING LustreConfiguration : NetworkInterfaceIds : {} OwnerId : 123456789012 ResourceARN : arn:aws:fsx:us-west-2:123456789012:file-system/fs-abcdef01234567890 StorageCapacity : 300 SubnetIds : {subnet-1a2b3c4d5e6f} Tags : {} VpcId : vpc-1a2b3c4d5e6f WindowsConfiguration : Amazon.FSx.Model.WindowsFileSystemConfiguration</code><remarks><para>Description</para><para>-----------</para><para>This example creates a new 300GB Windows file system, permitting access from the specified subnet, that supports throughput up to 8 megabytes per second. The new file system is automatically joined to the specified Microsoft Active Directory.</para><para /><para /></remarks></example></examples></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>New-FSXVolumeFromBackup</name><description><para>Calls the Amazon FSx CreateVolumeFromBackup API operation.</para></description><verb>New</verb><noun>FSXVolumeFromBackup</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup. </para></description><syntax><syntaxItem><name>New-FSXVolumeFromBackup</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>Name</name><description><para>The name of the new volume you're creating. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AggregateConfiguration_Aggregate</name><description><para>Used to specify the names of aggregates on which the volume will be created. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SnaplockConfiguration_AuditLogVolume</name><description><para>Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is <c>false</c>. If you set <c>AuditLogVolume</c> to <c>true</c>, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/how-snaplock-works.html#snaplock-audit-log-volume"> SnapLock audit log volumes</a>. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>BackupId</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AggregateConfiguration_ConstituentsPerAggregate</name><description><para>Used to explicitly set the number of constituents within the FlexGroup per storage aggregate. This field is optional when creating a FlexGroup volume. If unspecified, the default value will be 8. This field cannot be provided when creating a FlexVol volume. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>TieringPolicy_CoolingPeriod</name><description><para>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 <c>AUTO</c> and <c>SNAPSHOT_ONLY</c> tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for <c>AUTO</c> and 2 days for <c>SNAPSHOT_ONLY</c>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_CopyTagsToBackup</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_JunctionPath</name><description><para>Specifies the location in the SVM's namespace where the volume is mounted. This parameter is required. The <c>JunctionPath</c> must have a leading forward slash, such as <c>/vol3</c>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>TieringPolicy_Name</name><description><para>Specifies the tiering policy used to transition data. Default value is <c>SNAPSHOT_ONLY</c>. - <c>SNAPSHOT_ONLY</c> - moves cold snapshots to the capacity pool storage tier. - <c>AUTO</c> - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns. - <c>ALL</c> - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier. - <c>NONE</c> - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.TieringPolicyName</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_OntapVolumeType</name><description><para>Specifies the type of volume you are creating. Valid values are the following: - <c>RW</c> specifies a read/write volume. <c>RW</c> is the default. - <c>DP</c> specifies a data-protection volume. A <c>DP</c> volume is read-only and can be used as the destination of a NetApp SnapMirror relationship. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-types">Volume types</a> in the Amazon FSx for NetApp ONTAP User Guide. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.InputOntapVolumeType</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SnaplockConfiguration_PrivilegedDelete</name><description><para>Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete WORM files even if they have active retention periods. <c>PERMANENTLY_DISABLED</c> is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is <c>DISABLED</c>. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html#privileged-delete">Privileged delete</a>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.PrivilegedDelete</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_SecurityStyle</name><description><para>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. Specify one of the following values: - <c>UNIX</c> 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. - <c>NTFS</c> 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. - <c>MIXED</c> This is an advanced setting. For more information, see the topic <a href="https://docs.netapp.com/us-en/ontap/nfs-admin/security-styles-their-effects-concept.html">What the security styles and their effects are</a> in the NetApp Documentation Center. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-security-style">Volume security style</a> in the FSx for ONTAP User Guide. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.SecurityStyle</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_SizeInByte</name><description><para>Specifies the configured size of the volume, in bytes. </para></description><parameterValue required="true" variableLength="false">System.Int64</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SnaplockConfiguration_SnaplockType</name><description><para>Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes: - <c>COMPLIANCE</c>: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-compliance.html">SnapLock Compliance</a>. - <c>ENTERPRISE</c>: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html">SnapLock Enterprise</a>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.SnaplockType</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_SnapshotPolicy</name><description><para>Specifies the snapshot policy for the volume. There are three built-in snapshot policies: - <c>default</c>: 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. - <c>default-1weekly</c>: This policy is the same as the <c>default</c> policy except that it only retains one snapshot from the weekly schedule. - <c>none</c>: 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 <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snapshots-ontap.html#snapshot-policies">Snapshot policies</a> in the Amazon FSx for NetApp ONTAP User Guide. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_StorageEfficiencyEnabled</name><description><para>Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them. <c>StorageEfficiencyEnabled</c> is required when creating a <c>RW</c> volume (<c>OntapVolumeType</c> set to <c>RW</c>). </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_StorageVirtualMachineId</name><description><para>Specifies the ONTAP SVM in which to create the volume. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Tag</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AutocommitPeriod_Type</name><description><para>Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to <c>NONE</c> disables autocommit. The default value is <c>NONE</c>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AutocommitPeriodType</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DefaultRetention_Type</name><description><para>Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to <c>INFINITE</c>, the files are retained forever. If you set it to <c>UNSPECIFIED</c>, the files are retained until you set an explicit retention period. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.RetentionPeriodType</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaximumRetention_Type</name><description><para>Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to <c>INFINITE</c>, the files are retained forever. If you set it to <c>UNSPECIFIED</c>, the files are retained until you set an explicit retention period. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.RetentionPeriodType</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MinimumRetention_Type</name><description><para>Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to <c>INFINITE</c>, the files are retained forever. If you set it to <c>UNSPECIFIED</c>, the files are retained until you set an explicit retention period. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.RetentionPeriodType</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AutocommitPeriod_Value</name><description><para>Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid: - <c>Minutes</c>: 5 - 65,535 - <c>Hours</c>: 1 - 65,535 - <c>Days</c>: 1 - 3,650 - <c>Months</c>: 1 - 120 - <c>Years</c>: 1 - 10 </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DefaultRetention_Value</name><description><para>Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for <c>INFINITE</c> or <c>UNSPECIFIED</c>. For all other options, the following ranges are valid: - <c>Seconds</c>: 0 - 65,535 - <c>Minutes</c>: 0 - 65,535 - <c>Hours</c>: 0 - 24 - <c>Days</c>: 0 - 365 - <c>Months</c>: 0 - 12 - <c>Years</c>: 0 - 100 </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaximumRetention_Value</name><description><para>Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for <c>INFINITE</c> or <c>UNSPECIFIED</c>. For all other options, the following ranges are valid: - <c>Seconds</c>: 0 - 65,535 - <c>Minutes</c>: 0 - 65,535 - <c>Hours</c>: 0 - 24 - <c>Days</c>: 0 - 365 - <c>Months</c>: 0 - 12 - <c>Years</c>: 0 - 100 </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MinimumRetention_Value</name><description><para>Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for <c>INFINITE</c> or <c>UNSPECIFIED</c>. For all other options, the following ranges are valid: - <c>Seconds</c>: 0 - 65,535 - <c>Minutes</c>: 0 - 65,535 - <c>Hours</c>: 0 - 24 - <c>Days</c>: 0 - 365 - <c>Months</c>: 0 - 12 - <c>Years</c>: 0 - 100 </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SnaplockConfiguration_VolumeAppendModeEnabled</name><description><para>Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is <c>false</c>. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-append">Volume-append mode</a>. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_VolumeStyle</name><description><para>Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, FlexVol and FlexGroup volumes. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-styles">Volume styles</a> in the Amazon FSx for NetApp ONTAP User Guide. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.VolumeStyle</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_SizeInMegabyte</name><description><para>Use <c>SizeInBytes</c> instead. Specifies the size of the volume, in megabytes (MB), that you are creating. This parameter is deprecated. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.CreateVolumeFromBackupResponse). Specifying the name of a property of type Amazon.FSx.Model.CreateVolumeFromBackupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AggregateConfiguration_Aggregate</name><description><para>Used to specify the names of aggregates on which the volume will be created. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AggregateConfiguration_ConstituentsPerAggregate</name><description><para>Used to explicitly set the number of constituents within the FlexGroup per storage aggregate. This field is optional when creating a FlexGroup volume. If unspecified, the default value will be 8. This field cannot be provided when creating a FlexVol volume. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AutocommitPeriod_Type</name><description><para>Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to <c>NONE</c> disables autocommit. The default value is <c>NONE</c>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AutocommitPeriodType</parameterValue><type><name>Amazon.FSx.AutocommitPeriodType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AutocommitPeriod_Value</name><description><para>Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid: - <c>Minutes</c>: 5 - 65,535 - <c>Hours</c>: 1 - 65,535 - <c>Days</c>: 1 - 3,650 - <c>Months</c>: 1 - 120 - <c>Years</c>: 1 - 10 </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>BackupId</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientConfig</name><description><para>Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.AmazonFSxConfig</parameterValue><type><name>Amazon.FSx.AmazonFSxConfig</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ClientRequestToken</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DefaultRetention_Type</name><description><para>Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to <c>INFINITE</c>, the files are retained forever. If you set it to <c>UNSPECIFIED</c>, the files are retained until you set an explicit retention period. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.RetentionPeriodType</parameterValue><type><name>Amazon.FSx.RetentionPeriodType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DefaultRetention_Value</name><description><para>Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for <c>INFINITE</c> or <c>UNSPECIFIED</c>. For all other options, the following ranges are valid: - <c>Seconds</c>: 0 - 65,535 - <c>Minutes</c>: 0 - 65,535 - <c>Hours</c>: 0 - 24 - <c>Days</c>: 0 - 365 - <c>Months</c>: 0 - 12 - <c>Years</c>: 0 - 100 </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> 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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaximumRetention_Type</name><description><para>Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to <c>INFINITE</c>, the files are retained forever. If you set it to <c>UNSPECIFIED</c>, the files are retained until you set an explicit retention period. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.RetentionPeriodType</parameterValue><type><name>Amazon.FSx.RetentionPeriodType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaximumRetention_Value</name><description><para>Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for <c>INFINITE</c> or <c>UNSPECIFIED</c>. For all other options, the following ranges are valid: - <c>Seconds</c>: 0 - 65,535 - <c>Minutes</c>: 0 - 65,535 - <c>Hours</c>: 0 - 24 - <c>Days</c>: 0 - 365 - <c>Months</c>: 0 - 12 - <c>Years</c>: 0 - 100 </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MinimumRetention_Type</name><description><para>Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to <c>INFINITE</c>, the files are retained forever. If you set it to <c>UNSPECIFIED</c>, the files are retained until you set an explicit retention period. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.RetentionPeriodType</parameterValue><type><name>Amazon.FSx.RetentionPeriodType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MinimumRetention_Value</name><description><para>Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for <c>INFINITE</c> or <c>UNSPECIFIED</c>. For all other options, the following ranges are valid: - <c>Seconds</c>: 0 - 65,535 - <c>Minutes</c>: 0 - 65,535 - <c>Hours</c>: 0 - 24 - <c>Days</c>: 0 - 365 - <c>Months</c>: 0 - 12 - <c>Years</c>: 0 - 100 </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>Name</name><description><para>The name of the new volume you're creating. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_CopyTagsToBackup</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_JunctionPath</name><description><para>Specifies the location in the SVM's namespace where the volume is mounted. This parameter is required. The <c>JunctionPath</c> must have a leading forward slash, such as <c>/vol3</c>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_OntapVolumeType</name><description><para>Specifies the type of volume you are creating. Valid values are the following: - <c>RW</c> specifies a read/write volume. <c>RW</c> is the default. - <c>DP</c> specifies a data-protection volume. A <c>DP</c> volume is read-only and can be used as the destination of a NetApp SnapMirror relationship. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-types">Volume types</a> in the Amazon FSx for NetApp ONTAP User Guide. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.InputOntapVolumeType</parameterValue><type><name>Amazon.FSx.InputOntapVolumeType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_SecurityStyle</name><description><para>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. Specify one of the following values: - <c>UNIX</c> 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. - <c>NTFS</c> 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. - <c>MIXED</c> This is an advanced setting. For more information, see the topic <a href="https://docs.netapp.com/us-en/ontap/nfs-admin/security-styles-their-effects-concept.html">What the security styles and their effects are</a> in the NetApp Documentation Center. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-security-style">Volume security style</a> in the FSx for ONTAP User Guide. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.SecurityStyle</parameterValue><type><name>Amazon.FSx.SecurityStyle</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_SizeInByte</name><description><para>Specifies the configured size of the volume, in bytes. </para></description><parameterValue required="true" variableLength="false">System.Int64</parameterValue><type><name>System.Int64</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_SizeInMegabyte</name><description><para>Use <c>SizeInBytes</c> instead. Specifies the size of the volume, in megabytes (MB), that you are creating. This parameter is deprecated. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_SnapshotPolicy</name><description><para>Specifies the snapshot policy for the volume. There are three built-in snapshot policies: - <c>default</c>: 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. - <c>default-1weekly</c>: This policy is the same as the <c>default</c> policy except that it only retains one snapshot from the weekly schedule. - <c>none</c>: 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 <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snapshots-ontap.html#snapshot-policies">Snapshot policies</a> in the Amazon FSx for NetApp ONTAP User Guide. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_StorageEfficiencyEnabled</name><description><para>Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them. <c>StorageEfficiencyEnabled</c> is required when creating a <c>RW</c> volume (<c>OntapVolumeType</c> set to <c>RW</c>). </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_StorageVirtualMachineId</name><description><para>Specifies the ONTAP SVM in which to create the volume. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OntapConfiguration_VolumeStyle</name><description><para>Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, FlexVol and FlexGroup volumes. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-styles">Volume styles</a> in the Amazon FSx for NetApp ONTAP User Guide. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.VolumeStyle</parameterValue><type><name>Amazon.FSx.VolumeStyle</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.CreateVolumeFromBackupResponse). Specifying the name of a property of type Amazon.FSx.Model.CreateVolumeFromBackupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SnaplockConfiguration_AuditLogVolume</name><description><para>Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is <c>false</c>. If you set <c>AuditLogVolume</c> to <c>true</c>, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/how-snaplock-works.html#snaplock-audit-log-volume"> SnapLock audit log volumes</a>. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SnaplockConfiguration_PrivilegedDelete</name><description><para>Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete WORM files even if they have active retention periods. <c>PERMANENTLY_DISABLED</c> is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is <c>DISABLED</c>. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html#privileged-delete">Privileged delete</a>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.PrivilegedDelete</parameterValue><type><name>Amazon.FSx.PrivilegedDelete</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SnaplockConfiguration_SnaplockType</name><description><para>Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes: - <c>COMPLIANCE</c>: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-compliance.html">SnapLock Compliance</a>. - <c>ENTERPRISE</c>: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html">SnapLock Enterprise</a>. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.SnaplockType</parameterValue><type><name>Amazon.FSx.SnaplockType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SnaplockConfiguration_VolumeAppendModeEnabled</name><description><para>Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is <c>false</c>. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-append">Volume-append mode</a>. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Tag</name><description><para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.Model.Tag[]</parameterValue><type><name>Amazon.FSx.Model.Tag[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>TieringPolicy_CoolingPeriod</name><description><para>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 <c>AUTO</c> and <c>SNAPSHOT_ONLY</c> tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for <c>AUTO</c> and 2 days for <c>SNAPSHOT_ONLY</c>. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>TieringPolicy_Name</name><description><para>Specifies the tiering policy used to transition data. Default value is <c>SNAPSHOT_ONLY</c>. - <c>SNAPSHOT_ONLY</c> - moves cold snapshots to the capacity pool storage tier. - <c>AUTO</c> - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns. - <c>ALL</c> - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier. - <c>NONE</c> - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier. </para></description><parameterValue required="true" variableLength="false">Amazon.FSx.TieringPolicyName</parameterValue><type><name>Amazon.FSx.TieringPolicyName</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.FSx.Model.Volume or Amazon.FSx.Model.CreateVolumeFromBackupResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.FSx.Model.Volume object. The service call response (type Amazon.FSx.Model.CreateVolumeFromBackupResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=New-FSXVolumeFromBackup.html&tocid=New-FSXVolumeFromBackup</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Amazon FSx for Windows File Server User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/WindowsGuide/</uri></navigationLink><navigationLink><linkText>Amazon FSx for Lustre User Guide:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/LustreGuide/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/fsx/latest/APIReference/</uri></navigationLink></relatedLinks></command></helpItems> |