AWS.Tools.FSx.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.FSx</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.FSX.AddFSXResourceTagCmdlet"> <summary> Tags an Amazon FSx resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.AddFSXResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon FSx resource that you want to tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.AddFSXResourceTagCmdlet.Tag"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.AddFSXResourceTagCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.AddFSXResourceTagCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.AddFSXResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.ClearFSXFileSystemNfsV3LockCmdlet"> <summary> Releases the file system lock from an Amazon FSx for OpenZFS file system. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.ClearFSXFileSystemNfsV3LockCmdlet.ClientRequestToken"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.ClearFSXFileSystemNfsV3LockCmdlet.FileSystemId"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.ClearFSXFileSystemNfsV3LockCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.ClearFSXFileSystemNfsV3LockCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.ClearFSXFileSystemNfsV3LockCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.CopyFSXBackupCmdlet"> <summary> 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. <para> 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: <code>aws</code> (Standard Regions), <code>aws-cn</code> (China Regions), and <code>aws-us-gov</code> (Amazon Web Services GovCloud [US] Regions). </para><para> You can also use backup copies to clone your file dataset to another Region or within the same Region. </para><para> You can use the <code>SourceRegion</code> parameter to specify the Amazon Web Services Region from which the backup will be copied. For example, if you make the call from the <code>us-west-1</code> Region and want to copy a backup from the <code>us-east-2</code> Region, you specify <code>us-east-2</code> in the <code>SourceRegion</code> parameter to make a cross-Region copy. If you don't specify a Region, the backup copy is created in the same Region where the request is sent from (in-Region copy). </para><para> 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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.CopyFSXBackupCmdlet.ClientRequestToken"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.CopyFSXBackupCmdlet.CopyTag"> <summary> <para> <para>A Boolean flag indicating whether tags from the source backup should be copied to the backup copy. This value defaults to <code>false</code>.</para><para>If you set <code>CopyTags</code> to <code>true</code> and the source backup has existing tags, you can use the <code>Tags</code> 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 <code>Tags</code> parameter take precedence.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.CopyFSXBackupCmdlet.KmsKeyId"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.CopyFSXBackupCmdlet.SourceBackupId"> <summary> <para> <para>The ID of the source backup. Specifies the ID of the backup that's being copied.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.CopyFSXBackupCmdlet.SourceRegion"> <summary> <para> <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, <code>SourceRegion</code> defaults to the Region where the request is sent from (in-Region copy).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.CopyFSXBackupCmdlet.Tag"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.CopyFSXBackupCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.CopyFSXBackupCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.CopyFSXBackupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.GetFSXBackupCmdlet"> <summary> Returns the description of a specific Amazon FSx backup, if a <code>BackupIds</code> 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're calling. <para> When retrieving all backups, you can optionally specify the <code>MaxResults</code> parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a <code>NextToken</code> value in the response. In this case, send a later request with the <code>NextToken</code> request parameter set to the value of the <code>NextToken</code> value from the last response. </para><para> This operation is used in an iterative process to retrieve a list of your backups. <code>DescribeBackups</code> is called first without a <code>NextToken</code> value. Then the operation continues to be called with the <code>NextToken</code> parameter set to the value of the last <code>NextToken</code> value until a response has no <code>NextToken</code> value. </para><para> When using this operation, keep the following in mind: </para><ul><li><para> The operation might return fewer than the <code>MaxResults</code> value of backup descriptions while still including a <code>NextToken</code> value. </para></li><li><para> The order of the backups returned in the response of one <code>DescribeBackups</code> call and the order of the backups returned across the responses of a multi-call iteration is unspecified. </para></li></ul><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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXBackupCmdlet.BackupId"> <summary> <para> <para>The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a <code>BackupNotFound</code> error occurs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXBackupCmdlet.Filter"> <summary> <para> <para>The filters structure. The supported names are <code>file-system-id</code>, <code>backup-type</code>, <code>file-system-type</code>, and <code>volume-id</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXBackupCmdlet.MaxResult"> <summary> <para> <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 <code>MaxResults</code> parameter specified in the request and the service's internal maximum number of items per page.</para> </para> <para> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXBackupCmdlet.NextToken"> <summary> <para> <para>An opaque pagination token returned from a previous <code>DescribeBackups</code> operation. If a token is present, the operation continues the list from where the returning call left off.</para> </para> <para> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXBackupCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXBackupCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.GetFSXDataRepositoryAssociationCmdlet"> <summary> Returns the description of specific Amazon FSx for Lustre data repository associations, if one or more <code>AssociationIds</code> values are provided in the request, or if filters are used in the request. Data repository associations are supported only for file systems with the <code>Persistent_2</code> deployment type. <para> You can use filters to narrow the response to include just data repository associations for specific file systems (use the <code>file-system-id</code> filter with the ID of the file system) or data repository associations for a specific repository type (use the <code>data-repository-type</code> filter with a value of <code>S3</code>). If you don'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're calling. </para><para> When retrieving all data repository associations, you can paginate the response by using the optional <code>MaxResults</code> parameter to limit the number of data repository associations returned in a response. If more data repository associations remain, Amazon FSx returns a <code>NextToken</code> value in the response. In this case, send a later request with the <code>NextToken</code> request parameter set to the value of <code>NextToken</code> from the last response. </para><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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXDataRepositoryAssociationCmdlet.AssociationId"> <summary> <para> <para>IDs of the data repository associations whose descriptions you want to retrieve (String).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXDataRepositoryAssociationCmdlet.Filter"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXDataRepositoryAssociationCmdlet.MaxResult"> <summary> <para> <para>The maximum number of resources to return in the response. This value must be an integer greater than zero.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXDataRepositoryAssociationCmdlet.NextToken"> <summary> <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> <para> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXDataRepositoryAssociationCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXDataRepositoryAssociationCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.GetFSXDataRepositoryTaskCmdlet"> <summary> Returns the description of specific Amazon FSx for Lustre data repository tasks, if one or more <code>TaskIds</code> 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 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're calling. <para> When retrieving all tasks, you can paginate the response by using the optional <code>MaxResults</code> parameter to limit the number of tasks returned in a response. If more tasks remain, Amazon FSx returns a <code>NextToken</code> value in the response. In this case, send a later request with the <code>NextToken</code> request parameter set to the value of <code>NextToken</code> from the last response. </para><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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXDataRepositoryTaskCmdlet.Filter"> <summary> <para> <para>(Optional) You can use filters to narrow the <code>DescribeDataRepositoryTasks</code> response to include just tasks for specific file systems, or tasks in a specific lifecycle state.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXDataRepositoryTaskCmdlet.TaskId"> <summary> <para> <para>(Optional) IDs of the tasks whose descriptions you want to retrieve (String).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXDataRepositoryTaskCmdlet.MaxResult"> <summary> <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> <para> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXDataRepositoryTaskCmdlet.NextToken"> <summary> <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> <para> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXDataRepositoryTaskCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXDataRepositoryTaskCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.GetFSXFileSystemCmdlet"> <summary> Returns the description of specific Amazon FSx file systems, if a <code>FileSystemIds</code> 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're calling. <para> When retrieving all file system descriptions, you can optionally specify the <code>MaxResults</code> parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a <code>NextToken</code> value in the response. In this case, send a later request with the <code>NextToken</code> request parameter set to the value of <code>NextToken</code> from the last response. </para><para> This operation is used in an iterative process to retrieve a list of your file system descriptions. <code>DescribeFileSystems</code> is called first without a <code>NextToken</code>value. Then the operation continues to be called with the <code>NextToken</code> parameter set to the value of the last <code>NextToken</code> value until a response has no <code>NextToken</code>. </para><para> When using this operation, keep the following in mind: </para><ul><li><para> The implementation might return fewer than <code>MaxResults</code> file system descriptions while still including a <code>NextToken</code> value. </para></li><li><para> The order of file systems returned in the response of one <code>DescribeFileSystems</code> call and the order of file systems returned across the responses of a multicall iteration is unspecified. </para></li></ul><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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXFileSystemCmdlet.FileSystemId"> <summary> <para> <para>IDs of the file systems whose descriptions you want to retrieve (String).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXFileSystemCmdlet.MaxResult"> <summary> <para> <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 <code>MaxResults</code> parameter specified in the request and the service's internal maximum number of items per page.</para> </para> <para> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXFileSystemCmdlet.NextToken"> <summary> <para> <para>Opaque pagination token returned from a previous <code>DescribeFileSystems</code> operation (String). If a token present, the operation continues the list from where the returning call left off.</para> </para> <para> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXFileSystemCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXFileSystemCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.GetFSXFileSystemAliasCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXFileSystemAliasCmdlet.ClientRequestToken"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXFileSystemAliasCmdlet.FileSystemId"> <summary> <para> <para>The ID of the file system to return the associated DNS aliases for (String).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXFileSystemAliasCmdlet.MaxResult"> <summary> <para> <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 <code>MaxResults</code> parameter specified in the request and the service's internal maximum number of items per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXFileSystemAliasCmdlet.NextToken"> <summary> <para> <para>Opaque pagination token returned from a previous <code>DescribeFileSystemAliases</code> operation (String). If a token is included in the request, the action continues the list from where the previous returning call left off.</para> </para> <para> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXFileSystemAliasCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXFileSystemAliasCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXFileSystemAliasCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.GetFSXResourceTagListCmdlet"> <summary> Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server. <para> When retrieving all tags, you can optionally specify the <code>MaxResults</code> parameter to limit the number of tags in a response. If more tags remain, Amazon FSx returns a <code>NextToken</code> value in the response. In this case, send a later request with the <code>NextToken</code> request parameter set to the value of <code>NextToken</code> from the last response. </para><para> This action is used in an iterative process to retrieve a list of your tags. <code>ListTagsForResource</code> is called first without a <code>NextToken</code>value. Then the action continues to be called with the <code>NextToken</code> parameter set to the value of the last <code>NextToken</code> value until a response has no <code>NextToken</code>. </para><para> When using this action, keep the following in mind: </para><ul><li><para> The implementation might return fewer than <code>MaxResults</code> file system descriptions while still including a <code>NextToken</code> value. </para></li><li><para> The order of tags returned in the response of one <code>ListTagsForResource</code> call and the order of tags returned across the responses of a multi-call iteration is unspecified. </para></li></ul><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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXResourceTagListCmdlet.ResourceARN"> <summary> <para> <para>The ARN of the Amazon FSx resource that will have its tags listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXResourceTagListCmdlet.MaxResult"> <summary> <para> <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 <code>MaxResults</code> parameter specified in the request and the service's internal maximum number of items per page.</para> </para> <para> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXResourceTagListCmdlet.NextToken"> <summary> <para> <para>Opaque pagination token returned from a previous <code>ListTagsForResource</code> operation (String). If a token present, the action continues the list from where the returning call left off.</para> </para> <para> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXResourceTagListCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXResourceTagListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXResourceTagListCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.GetFSXSnapshotCmdlet"> <summary> Returns the description of specific Amazon FSx snapshots, if a <code>SnapshotIds</code> 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're calling. <para> When retrieving all snapshots, you can optionally specify the <code>MaxResults</code> parameter to limit the number of snapshots in a response. If more backups remain, Amazon FSx returns a <code>NextToken</code> value in the response. In this case, send a later request with the <code>NextToken</code> request parameter set to the value of <code>NextToken</code> from the last response. </para><para> Use this operation in an iterative process to retrieve a list of your snapshots. <code>DescribeSnapshots</code> is called first without a <code>NextToken</code> value. Then the operation continues to be called with the <code>NextToken</code> parameter set to the value of the last <code>NextToken</code> value until a response has no <code>NextToken</code> value. </para><para> When using this operation, keep the following in mind: </para><ul><li><para> The operation might return fewer than the <code>MaxResults</code> value of snapshot descriptions while still including a <code>NextToken</code> value. </para></li><li><para> The order of snapshots returned in the response of one <code>DescribeSnapshots</code> call and the order of backups returned across the responses of a multi-call iteration is unspecified. </para></li></ul><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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXSnapshotCmdlet.Filter"> <summary> <para> <para>The filters structure. The supported names are <code>file-system-id</code> or <code>volume-id</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXSnapshotCmdlet.SnapshotId"> <summary> <para> <para>The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a <code>SnapshotNotFound</code> error occurs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXSnapshotCmdlet.MaxResult"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXSnapshotCmdlet.NextToken"> <summary> <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> <para> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXSnapshotCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXSnapshotCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.GetFSXStorageVirtualMachineCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXStorageVirtualMachineCmdlet.Filter"> <summary> <para> <para>Enter a filter name:value pair to view a select set of SVMs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXStorageVirtualMachineCmdlet.StorageVirtualMachineId"> <summary> <para> <para>Enter the ID of one or more SVMs that you want to view.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXStorageVirtualMachineCmdlet.MaxResult"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXStorageVirtualMachineCmdlet.NextToken"> <summary> <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> <para> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXStorageVirtualMachineCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXStorageVirtualMachineCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.GetFSXVolumeCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXVolumeCmdlet.Filter"> <summary> <para> <para>Enter a filter <code>Name</code> and <code>Values</code> pair to view a select set of volumes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXVolumeCmdlet.VolumeId"> <summary> <para> <para>The IDs of the volumes whose descriptions you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXVolumeCmdlet.MaxResult"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXVolumeCmdlet.NextToken"> <summary> <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> <para> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXVolumeCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXVolumeCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.NewFSXBackupCmdlet"> <summary> 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. <para> For Amazon FSx for Lustre file systems, you can create a backup only for file systems that have the following configuration: </para><ul><li><para> A Persistent deployment type </para></li><li><para> Are <i>not</i> linked to a data repository </para></li></ul><para> For more information about backups, see the following: </para><ul><li><para> 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>. </para></li><li><para> 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>. </para></li><li><para> 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>. </para></li><li><para> 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>. </para></li></ul><para> 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't match, this operation returns <code>IncompatibleParameterError</code>. If a backup with the specified client request token doesn't exist, <code>CreateBackup</code> does the following: </para><ul><li><para> Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of <code>CREATING</code>. </para></li><li><para> Returns the description of the backup. </para></li></ul><para> By using the idempotent operation, you can retry a <code>CreateBackup</code> 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. </para><para> The <code>CreateBackup</code> operation returns while the backup's lifecycle state is still <code>CREATING</code>. 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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXBackupCmdlet.ClientRequestToken"> <summary> <para> <para>(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXBackupCmdlet.FileSystemId"> <summary> <para> <para>The ID of the file system to back up.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXBackupCmdlet.Tag"> <summary> <para> <para>(Optional) The tags to apply to the backup at backup creation. The key value of the <code>Name</code> tag appears in the console as the backup name. If you have set <code>CopyTagsToBackups</code> to <code>true</code>, and you specify one or more tags using the <code>CreateBackup</code> operation, no existing file system tags are copied from the file system to the backup.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXBackupCmdlet.VolumeId"> <summary> <para> <para>(Optional) The ID of the FSx for ONTAP volume to back up.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXBackupCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXBackupCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXBackupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.NewFSXDataRepositoryAssociationCmdlet"> <summary> 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 only for file systems with the <code>Persistent_2</code> deployment type. <para> 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>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXDataRepositoryAssociationCmdlet.BatchImportMetaDataOnCreate"> <summary> <para> <para>Set to <code>true</code> 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 <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXDataRepositoryAssociationCmdlet.ClientRequestToken"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXDataRepositoryAssociationCmdlet.DataRepositoryPath"> <summary> <para> <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 <code>s3://myBucket/myPrefix/</code>. This path specifies where in the S3 data repository files will be imported from or exported to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXDataRepositoryAssociationCmdlet.AutoExportPolicy_Event"> <summary> <para> <para>The <code>AutoExportPolicy</code> can have the following event values:</para><ul><li><para><code>NEW</code> - Amazon FSx automatically exports new files and directories to the data repository as they are added to the file system.</para></li><li><para><code>CHANGED</code> - Amazon FSx automatically exports changes to files and directories on the file system to the data repository.</para></li><li><para><code>DELETED</code> - Files and directories are automatically deleted on the data repository when they are deleted on the file system.</para></li></ul><para>You can define any combination of event types for your <code>AutoExportPolicy</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXDataRepositoryAssociationCmdlet.AutoImportPolicy_Event"> <summary> <para> <para>The <code>AutoImportPolicy</code> can have the following event values:</para><ul><li><para><code>NEW</code> - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not currently exist in the FSx file system.</para></li><li><para><code>CHANGED</code> - Amazon FSx automatically updates file metadata and invalidates existing file content on the file system as files change in the data repository.</para></li><li><para><code>DELETED</code> - Amazon FSx automatically deletes files on the file system as corresponding files are deleted in the data repository.</para></li></ul><para>You can define any combination of event types for your <code>AutoImportPolicy</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXDataRepositoryAssociationCmdlet.FileSystemId"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXDataRepositoryAssociationCmdlet.FileSystemPath"> <summary> <para> <para>A path on the file system that points to a high-level directory (such as <code>/ns1/</code>) or subdirectory (such as <code>/ns1/subdir/</code>) that will be mapped 1-1 with <code>DataRepositoryPath</code>. 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 <code>/ns1/</code>, then you cannot link another data repository with file system path <code>/ns1/ns2</code>.</para><para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXDataRepositoryAssociationCmdlet.ImportedFileChunkSize"> <summary> <para> <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.</para><para>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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXDataRepositoryAssociationCmdlet.Tag"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXDataRepositoryAssociationCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXDataRepositoryAssociationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXDataRepositoryAssociationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.NewFSXDataRepositoryTaskCmdlet"> <summary> Creates an Amazon FSx for Lustre data repository task. You use data repository tasks to perform bulk operations between your Amazon FSx 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. A <code>CreateDataRepositoryTask</code> operation will fail if a data repository is not linked to the FSx 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>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXDataRepositoryTaskCmdlet.ClientRequestToken"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXDataRepositoryTaskCmdlet.Report_Enabled"> <summary> <para> <para>Set <code>Enabled</code> to <code>True</code> to generate a <code>CompletionReport</code> when the task completes. If set to <code>true</code>, then you need to provide a report <code>Scope</code>, <code>Path</code>, and <code>Format</code>. Set <code>Enabled</code> to <code>False</code> if you do not want a <code>CompletionReport</code> generated when the task completes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXDataRepositoryTaskCmdlet.FileSystemId"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXDataRepositoryTaskCmdlet.Report_Format"> <summary> <para> <para>Required if <code>Enabled</code> is set to <code>true</code>. Specifies the format of the <code>CompletionReport</code>. <code>REPORT_CSV_20191124</code> is the only format currently supported. When <code>Format</code> is set to <code>REPORT_CSV_20191124</code>, the <code>CompletionReport</code> is provided in CSV format, and is delivered to <code>{path}/task-{id}/failures.csv</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXDataRepositoryTaskCmdlet.Report_Path"> <summary> <para> <para>Required if <code>Enabled</code> is set to <code>true</code>. 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 <code>Path</code> you provide must be located within the file system’s ExportPath. An example <code>Path</code> value is "s3://myBucket/myExportPath/optionalPrefix". The report provides the following information for each file in the report: FilePath, FileStatus, and ErrorCode. To learn more about a file system's <code>ExportPath</code>, see . </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXDataRepositoryTaskCmdlet.Path"> <summary> <para> <para>(Optional) The path or paths on the Amazon FSx file system to use when the data repository task is processed. 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 <code>/mnt/fsx</code> and <code>/mnt/fsx/path1</code> is a directory or file on the file system you want to export, then the path to provide is <code>path1</code>. If a path that you provide isn't valid, the task fails.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXDataRepositoryTaskCmdlet.Report_Scope"> <summary> <para> <para>Required if <code>Enabled</code> is set to <code>true</code>. Specifies the scope of the <code>CompletionReport</code>; <code>FAILED_FILES_ONLY</code> is the only scope currently supported. When <code>Scope</code> is set to <code>FAILED_FILES_ONLY</code>, the <code>CompletionReport</code> only contains information about files that the data repository task failed to process.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXDataRepositoryTaskCmdlet.Tag"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXDataRepositoryTaskCmdlet.Type"> <summary> <para> <para>Specifies the type of data repository task to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXDataRepositoryTaskCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXDataRepositoryTaskCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXDataRepositoryTaskCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet"> <summary> Creates a new, empty Amazon FSx file system. You can create the following supported Amazon FSx file systems using the <code>CreateFileSystem</code> API operation: <ul><li><para> Amazon FSx for Lustre </para></li><li><para> Amazon FSx for NetApp ONTAP </para></li><li><para> Amazon FSx for Windows File Server </para></li></ul><para> 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 <code>CreateFileSystem</code> 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. </para><para> If a file system with the specified client request token exists and the parameters match, <code>CreateFileSystem</code> returns the description of the existing file system. If a file system with the specified client request token exists and the parameters don't match, this call returns <code>IncompatibleParameterError</code>. If a file system with the specified client request token doesn't exist, <code>CreateFileSystem</code> does the following: </para><ul><li><para> Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of <code>CREATING</code>. </para></li><li><para> Returns the description of the file system. </para></li></ul><para> 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 <code>CreateFileSystem</code> 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 a success message as long as the parameters are the same. </para><note><para> The <code>CreateFileSystem</code> call returns while the file system's lifecycle state is still <code>CREATING</code>. 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></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.OntapConfiguration_AutomaticBackupRetentionDay"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.OpenZFSConfiguration_AutomaticBackupRetentionDay"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.ClientRequestToken"> <summary> <para> <para>A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.OpenZFSConfiguration_CopyTagsToBackup"> <summary> <para> <para>A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to <code>false</code>. If it's set to <code>true</code>, 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 <code>true</code>, 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.RootVolumeConfiguration_CopyTagsToSnapshot"> <summary> <para> <para>A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to <code>false</code>. If it's set to <code>true</code>, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is <code>true</code> 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.OpenZFSConfiguration_CopyTagsToVolume"> <summary> <para> <para>A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to <code>false</code>. If it's set to <code>true</code>, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is <code>true</code>, 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.OntapConfiguration_DailyAutomaticBackupStartTime"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.OpenZFSConfiguration_DailyAutomaticBackupStartTime"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.RootVolumeConfiguration_DataCompressionType"> <summary> <para> <para>Specifies the method used to compress the data on the volume. Unless the compression type is specified, volumes inherit the <code>DataCompressionType</code> value of their parent volume.</para><ul><li><para><code>NONE</code> - Doesn't compress the data on the volume.</para></li><li><para><code>ZSTD</code> - Compresses the data in the volume using the ZStandard (ZSTD) compression algorithm. This algorithm reduces the amount of space used on your volume and has very little impact on compute resources.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.OntapConfiguration_DeploymentType"> <summary> <para> <para>Specifies the FSx for ONTAP file system deployment type to use in creating the file system. <code>MULTI_AZ_1</code> is the supported ONTAP deployment type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.OpenZFSConfiguration_DeploymentType"> <summary> <para> <para>Specifies the file system deployment type. Amazon FSx for OpenZFS supports <code>SINGLE_AZ_1</code>. <code>SINGLE_AZ_1</code> is a file system configured for a single Availability Zone (AZ) of redundancy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.OntapConfiguration_EndpointIpAddressRange"> <summary> <para> <para>Specifies the IP address range in which the endpoints to access your file system will be created. By default, Amazon FSx selects an unused IP address range for you from the 198.19.* range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.FileSystemType"> <summary> <para> <para>The type of Amazon FSx file system to create. Valid values are <code>WINDOWS</code>, <code>LUSTRE</code>, <code>ONTAP</code>, and <code>OPENZFS</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.FileSystemTypeVersion"> <summary> <para> <para>(Optional) For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating. Valid values are <code>2.10</code> and <code>2.12</code>:</para><ul><li><para>2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.</para></li><li><para>2.12 is supported by all Lustre deployment types. <code>2.12</code> is required when setting FSx for Lustre <code>DeploymentType</code> to <code>PERSISTENT_2</code>.</para></li></ul><para>Default value = <code>2.10</code>, except when <code>DeploymentType</code> is set to <code>PERSISTENT_2</code>, then the default is <code>2.12</code>.</para><note><para>If you set <code>FileSystemTypeVersion</code> to <code>2.10</code> for a <code>PERSISTENT_2</code> Lustre deployment type, the <code>CreateFileSystem</code> operation fails.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.OntapConfiguration_FsxAdminPassword"> <summary> <para> <para>The ONTAP administrative password for the <code>fsxadmin</code> user with which you administer your file system using the NetApp ONTAP CLI and REST API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.OntapConfiguration_DiskIopsConfiguration_Iops"> <summary> <para> <para>The total number of SSD IOPS provisioned for the file system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.OpenZFSConfiguration_DiskIopsConfiguration_Iops"> <summary> <para> <para>The total number of SSD IOPS provisioned for the file system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.KmsKeyId"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.LustreConfiguration"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.OntapConfiguration_DiskIopsConfiguration_Mode"> <summary> <para> <para>Specifies whether the number of IOPS for the file system is using the system default (<code>AUTOMATIC</code>) or was provisioned by the customer (<code>USER_PROVISIONED</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.OpenZFSConfiguration_DiskIopsConfiguration_Mode"> <summary> <para> <para>Specifies whether the number of IOPS for the file system is using the system default (<code>AUTOMATIC</code>) or was provisioned by the customer (<code>USER_PROVISIONED</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.RootVolumeConfiguration_NfsExport"> <summary> <para> <para>The configuration object for mounting a file system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.OntapConfiguration_PreferredSubnetId"> <summary> <para> <para>Required when <code>DeploymentType</code> is set to <code>MULTI_AZ_1</code>. This specifies the subnet in which you want the preferred file server to be located.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.RootVolumeConfiguration_ReadOnly"> <summary> <para> <para>A Boolean value indicating whether the volume is read-only. Setting this value to <code>true</code> can be useful after you have completed changes to a volume and no longer want changes to occur. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.OntapConfiguration_RouteTableId"> <summary> <para> <para>Specifies the virtual private cloud (VPC) route tables in which your file system's endpoints will be created. You should specify all 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.SecurityGroupId"> <summary> <para> <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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.StorageCapacity"> <summary> <para> <para>Sets the storage capacity of the file system that you're creating, in gibibytes (GiB).</para><para><b>FSx for Lustre file systems</b> - The amount of storage capacity that you can configure depends on the value that you set for <code>StorageType</code> and the Lustre <code>DeploymentType</code>, as follows:</para><ul><li><para>For <code>SCRATCH_2</code>, <code>PERSISTENT_2</code> and <code>PERSISTENT_1</code> deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.</para></li><li><para>For <code>PERSISTENT_1</code> 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.</para></li><li><para>For <code>SCRATCH_1</code> deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB.</para></li></ul><para><b>FSx for ONTAP file systems</b> - The amount of storage capacity that you can configure is from 1024 GiB up to 196,608 GiB (192 TiB).</para><para><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).</para><para><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 <code>StorageType</code> as follows:</para><ul><li><para>For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).</para></li><li><para>For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.StorageType"> <summary> <para> <para>Sets the storage type for the file system that you're creating. Valid values are <code>SSD</code> and <code>HDD</code>.</para><ul><li><para>Set to <code>SSD</code> to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types.</para></li><li><para>Set to <code>HDD</code> to use hard disk drive storage. HDD is supported on <code>SINGLE_AZ_2</code> and <code>MULTI_AZ_1</code> Windows file system deployment types, and on <code>PERSISTENT</code> Lustre file system deployment types. </para></li></ul><para>Default value is <code>SSD</code>. 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.SubnetId"> <summary> <para> <para>Specifies the IDs of the subnets that the file system will be accessible from. For Windows and ONTAP <code>MULTI_AZ_1</code> 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 <code>WindowsConfiguration > PreferredSubnetID</code> or <code>OntapConfiguration > PreferredSubnetID</code> 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>.</para><para>For Windows <code>SINGLE_AZ_1</code> and <code>SINGLE_AZ_2</code> and all Lustre deployment types, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.Tag"> <summary> <para> <para>The tags to apply to the file system that's being created. The key value of the <code>Name</code> tag appears in the console as the file system name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.OntapConfiguration_ThroughputCapacity"> <summary> <para> <para>Sets the throughput capacity for the file system that you're creating. Valid values are 512, 1024, and 2048 MBps.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.OpenZFSConfiguration_ThroughputCapacity"> <summary> <para> <para>Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MB/s). Valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s. You pay for additional throughput capacity that you provision.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.RootVolumeConfiguration_UserAndGroupQuota"> <summary> <para> <para>An object specifying how much storage users or groups can use on the volume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.OntapConfiguration_WeeklyMaintenanceStartTime"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.OpenZFSConfiguration_WeeklyMaintenanceStartTime"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.WindowsConfiguration"> <summary> <para> <para>The Microsoft Windows configuration for the file system that's being created. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemFromBackupCmdlet"> <summary> 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. <para> 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 client request token with the specified by the file system exists and the parameters don't match, this call returns <code>IncompatibleParameterError</code>. If a file system with the specified client request token doesn't exist, this operation does the following: </para><ul><li><para> Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of <code>CREATING</code>. </para></li><li><para> Returns the description of the file system. </para></li></ul><para> 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. </para><para> By using the idempotent operation, you can retry a <code>CreateFileSystemFromBackup</code> 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. </para><note><para> The <code>CreateFileSystemFromBackup</code> call returns while the file system's lifecycle state is still <code>CREATING</code>. 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></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemFromBackupCmdlet.OpenZFSConfiguration_AutomaticBackupRetentionDay"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemFromBackupCmdlet.BackupId"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemFromBackupCmdlet.ClientRequestToken"> <summary> <para> <para>A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemFromBackupCmdlet.OpenZFSConfiguration_CopyTagsToBackup"> <summary> <para> <para>A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to <code>false</code>. If it's set to <code>true</code>, 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 <code>true</code>, 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemFromBackupCmdlet.RootVolumeConfiguration_CopyTagsToSnapshot"> <summary> <para> <para>A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to <code>false</code>. If it's set to <code>true</code>, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is <code>true</code> 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemFromBackupCmdlet.OpenZFSConfiguration_CopyTagsToVolume"> <summary> <para> <para>A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to <code>false</code>. If it's set to <code>true</code>, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is <code>true</code>, 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemFromBackupCmdlet.OpenZFSConfiguration_DailyAutomaticBackupStartTime"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemFromBackupCmdlet.RootVolumeConfiguration_DataCompressionType"> <summary> <para> <para>Specifies the method used to compress the data on the volume. Unless the compression type is specified, volumes inherit the <code>DataCompressionType</code> value of their parent volume.</para><ul><li><para><code>NONE</code> - Doesn't compress the data on the volume.</para></li><li><para><code>ZSTD</code> - Compresses the data in the volume using the ZStandard (ZSTD) compression algorithm. This algorithm reduces the amount of space used on your volume and has very little impact on compute resources.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemFromBackupCmdlet.OpenZFSConfiguration_DeploymentType"> <summary> <para> <para>Specifies the file system deployment type. Amazon FSx for OpenZFS supports <code>SINGLE_AZ_1</code>. <code>SINGLE_AZ_1</code> is a file system configured for a single Availability Zone (AZ) of redundancy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemFromBackupCmdlet.FileSystemTypeVersion"> <summary> <para> <para>Sets the version for the Amazon FSx for Lustre file system that you're creating from a backup. Valid values are <code>2.10</code> and <code>2.12</code>.</para><para>You don't need to specify <code>FileSystemTypeVersion</code> because it will be applied using the backup's <code>FileSystemTypeVersion</code> setting. If you choose to specify <code>FileSystemTypeVersion</code> when creating from backup, the value must match the backup's <code>FileSystemTypeVersion</code> setting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemFromBackupCmdlet.DiskIopsConfiguration_Iops"> <summary> <para> <para>The total number of SSD IOPS provisioned for the file system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemFromBackupCmdlet.KmsKeyId"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemFromBackupCmdlet.LustreConfiguration"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemFromBackupCmdlet.DiskIopsConfiguration_Mode"> <summary> <para> <para>Specifies whether the number of IOPS for the file system is using the system default (<code>AUTOMATIC</code>) or was provisioned by the customer (<code>USER_PROVISIONED</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemFromBackupCmdlet.RootVolumeConfiguration_NfsExport"> <summary> <para> <para>The configuration object for mounting a file system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemFromBackupCmdlet.RootVolumeConfiguration_ReadOnly"> <summary> <para> <para>A Boolean value indicating whether the volume is read-only. Setting this value to <code>true</code> can be useful after you have completed changes to a volume and no longer want changes to occur. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemFromBackupCmdlet.SecurityGroupId"> <summary> <para> <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 <code>DescribeFileSystem</code> requests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemFromBackupCmdlet.StorageType"> <summary> <para> <para>Sets the storage type for the Windows or OpenZFS file system that you're creating from a backup. Valid values are <code>SSD</code> and <code>HDD</code>.</para><ul><li><para>Set to <code>SSD</code> to use solid state drive storage. SSD is supported on all Windows and OpenZFS deployment types.</para></li><li><para>Set to <code>HDD</code> to use hard disk drive storage. HDD is supported on <code>SINGLE_AZ_2</code> and <code>MULTI_AZ_1</code> FSx for Windows File Server file system deployment types.</para></li></ul><para> The default value is <code>SSD</code>. </para><note><para>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></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemFromBackupCmdlet.SubnetId"> <summary> <para> <para>Specifies the IDs of the subnets that the file system will be accessible from. For Windows <code>MULTI_AZ_1</code> 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 <code>WindowsConfiguration > PreferredSubnetID</code> property.</para><para>Windows <code>SINGLE_AZ_1</code> and <code>SINGLE_AZ_2</code> 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemFromBackupCmdlet.Tag"> <summary> <para> <para>The tags to be applied to the file system at file system creation. The key value of the <code>Name</code> tag appears in the console as the file system name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemFromBackupCmdlet.OpenZFSConfiguration_ThroughputCapacity"> <summary> <para> <para>Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MB/s). Valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s. You pay for additional throughput capacity that you provision.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemFromBackupCmdlet.RootVolumeConfiguration_UserAndGroupQuota"> <summary> <para> <para>An object specifying how much storage users or groups can use on the volume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemFromBackupCmdlet.OpenZFSConfiguration_WeeklyMaintenanceStartTime"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemFromBackupCmdlet.WindowsConfiguration"> <summary> <para> <para>The configuration for this Microsoft Windows file system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemFromBackupCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemFromBackupCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemFromBackupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.NewFSXSnapshotCmdlet"> <summary> Creates a snapshot of an existing Amazon FSx for OpenZFS file system. With snapshots, you can easily undo file changes and compare file versions by restoring the volume to a previous version. <para> 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't match, this operation returns <code>IncompatibleParameterError</code>. If a snapshot with the specified client request token doesn't exist, <code>CreateSnapshot</code> does the following: </para><ul><li><para> Creates a new OpenZFS snapshot with an assigned ID, and an initial lifecycle state of <code>CREATING</code>. </para></li><li><para> Returns the description of the snapshot. </para></li></ul><para> By using the idempotent operation, you can retry a <code>CreateSnapshot</code> 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. </para><para> The <code>CreateSnapshot</code> operation returns while the snapshot's lifecycle state is still <code>CREATING</code>. 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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXSnapshotCmdlet.ClientRequestToken"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXSnapshotCmdlet.Name"> <summary> <para> <para>The name of the snapshot. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXSnapshotCmdlet.Tag"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXSnapshotCmdlet.VolumeId"> <summary> <para> <para>The ID of the volume that you are taking a snapshot of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXSnapshotCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXSnapshotCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXSnapshotCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.NewFSXStorageVirtualMachineCmdlet"> <summary> Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXStorageVirtualMachineCmdlet.ClientRequestToken"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXStorageVirtualMachineCmdlet.SelfManagedActiveDirectoryConfiguration_DnsIp"> <summary> <para> <para>A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXStorageVirtualMachineCmdlet.SelfManagedActiveDirectoryConfiguration_DomainName"> <summary> <para> <para>The fully qualified domain name of the self-managed AD directory, such as <code>corp.example.com</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXStorageVirtualMachineCmdlet.SelfManagedActiveDirectoryConfiguration_FileSystemAdministratorsGroup"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXStorageVirtualMachineCmdlet.FileSystemId"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXStorageVirtualMachineCmdlet.Name"> <summary> <para> <para>The name of the SVM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXStorageVirtualMachineCmdlet.ActiveDirectoryConfiguration_NetBiosName"> <summary> <para> <para>The NetBIOS name of the Active Directory computer object that will be created for your SVM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXStorageVirtualMachineCmdlet.SelfManagedActiveDirectoryConfiguration_OrganizationalUnitDistinguishedName"> <summary> <para> <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 <code>OU=FSx,DC=yourdomain,DC=corp,DC=com</code>. 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. </para><important><para>Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXStorageVirtualMachineCmdlet.SelfManagedActiveDirectoryConfiguration_Password"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXStorageVirtualMachineCmdlet.RootVolumeSecurityStyle"> <summary> <para> <para>The security style of the root volume of the SVM. Specify one of the following values:</para><ul><li><para><code>UNIX</code> 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.</para></li><li><para><code>NTFS</code> 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.</para></li><li><para><code>MIXED</code> if the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXStorageVirtualMachineCmdlet.SvmAdminPassword"> <summary> <para> <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 <code>fsxadmin</code> user to manage the SVM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXStorageVirtualMachineCmdlet.Tag"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXStorageVirtualMachineCmdlet.SelfManagedActiveDirectoryConfiguration_UserName"> <summary> <para> <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 <code>OrganizationalUnitDistinguishedName</code>, or in the default location of your AD domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXStorageVirtualMachineCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXStorageVirtualMachineCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXStorageVirtualMachineCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeCmdlet"> <summary> Creates an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS storage volume. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeCmdlet.ClientRequestToken"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeCmdlet.TieringPolicy_CoolingPeriod"> <summary> <para> <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 <code>AUTO</code> and <code>SNAPSHOT_ONLY</code> tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for <code>AUTO</code> and 2 days for <code>SNAPSHOT_ONLY</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeCmdlet.OriginSnapshot_CopyStrategy"> <summary> <para> <para>The strategy used when copying data from the snapshot to the new volume. </para><ul><li><para><code>CLONE</code> - 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. </para></li><li><para><code>FULL_COPY</code> - Copies all data from the snapshot to the new volume. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeCmdlet.OpenZFSConfiguration_CopyTagsToSnapshot"> <summary> <para> <para>A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to <code>false</code>. If it's set to <code>true</code>, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is <code>true</code>, 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeCmdlet.OpenZFSConfiguration_DataCompressionType"> <summary> <para> <para>Specifies the method used to compress the data on the volume. Unless the compression type is specified, volumes inherit the <code>DataCompressionType</code> value of their parent volume.</para><ul><li><para><code>NONE</code> - Doesn't compress the data on the volume.</para></li><li><para><code>ZSTD</code> - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. This algorithm reduces the amount of space used on your volume and has very little impact on compute resources.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeCmdlet.OntapConfiguration_JunctionPath"> <summary> <para> <para>Specifies the location in the SVM's namespace where the volume is mounted. The <code>JunctionPath</code> must have a leading forward slash, such as <code>/vol3</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeCmdlet.Name"> <summary> <para> <para>Specifies the name of the volume that you're creating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeCmdlet.TieringPolicy_Name"> <summary> <para> <para>Specifies the tiering policy used to transition data. Default value is <code>SNAPSHOT_ONLY</code>.</para><ul><li><para><code>SNAPSHOT_ONLY</code> - moves cold snapshots to the capacity pool storage tier.</para></li><li><para><code>AUTO</code> - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.</para></li><li><para><code>ALL</code> - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.</para></li><li><para><code>NONE</code> - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeCmdlet.OpenZFSConfiguration_NfsExport"> <summary> <para> <para>The configuration object for mounting a Network File System (NFS) file system. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeCmdlet.OpenZFSConfiguration_ParentVolumeId"> <summary> <para> <para>The ID of the volume to use as the parent volume. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeCmdlet.OpenZFSConfiguration_ReadOnly"> <summary> <para> <para>A Boolean value indicating whether the volume is read-only. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeCmdlet.OntapConfiguration_SecurityStyle"> <summary> <para> <para>The security style for the volume. Specify one of the following values:</para><ul><li><para><code>UNIX</code> 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. <code>UNIX</code> is the default.</para></li><li><para><code>NTFS</code> 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.</para></li><li><para><code>MIXED</code> if the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeCmdlet.OntapConfiguration_SizeInMegabyte"> <summary> <para> <para>Specifies the size of the volume, in megabytes (MB), that you are creating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeCmdlet.OriginSnapshot_SnapshotARN"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeCmdlet.OpenZFSConfiguration_StorageCapacityQuotaGiB"> <summary> <para> <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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeCmdlet.OpenZFSConfiguration_StorageCapacityReservationGiB"> <summary> <para> <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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeCmdlet.OntapConfiguration_StorageEfficiencyEnabled"> <summary> <para> <para>Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeCmdlet.OntapConfiguration_StorageVirtualMachineId"> <summary> <para> <para>Specifies the ONTAP SVM in which to create the volume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeCmdlet.Tag"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeCmdlet.OpenZFSConfiguration_UserAndGroupQuota"> <summary> <para> <para>An object specifying how much storage users or groups can use on the volume. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeCmdlet.VolumeType"> <summary> <para> <para>Specifies the type of volume to create; <code>ONTAP</code> and <code>OPENZFS</code> are the only valid volume types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeFromBackupCmdlet"> <summary> Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeFromBackupCmdlet.BackupId"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeFromBackupCmdlet.ClientRequestToken"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeFromBackupCmdlet.TieringPolicy_CoolingPeriod"> <summary> <para> <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 <code>AUTO</code> and <code>SNAPSHOT_ONLY</code> tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for <code>AUTO</code> and 2 days for <code>SNAPSHOT_ONLY</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeFromBackupCmdlet.OntapConfiguration_JunctionPath"> <summary> <para> <para>Specifies the location in the SVM's namespace where the volume is mounted. The <code>JunctionPath</code> must have a leading forward slash, such as <code>/vol3</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeFromBackupCmdlet.Name"> <summary> <para> <para>The name of the new volume you're creating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeFromBackupCmdlet.TieringPolicy_Name"> <summary> <para> <para>Specifies the tiering policy used to transition data. Default value is <code>SNAPSHOT_ONLY</code>.</para><ul><li><para><code>SNAPSHOT_ONLY</code> - moves cold snapshots to the capacity pool storage tier.</para></li><li><para><code>AUTO</code> - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.</para></li><li><para><code>ALL</code> - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.</para></li><li><para><code>NONE</code> - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeFromBackupCmdlet.OntapConfiguration_SecurityStyle"> <summary> <para> <para>The security style for the volume. Specify one of the following values:</para><ul><li><para><code>UNIX</code> 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. <code>UNIX</code> is the default.</para></li><li><para><code>NTFS</code> 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.</para></li><li><para><code>MIXED</code> if the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeFromBackupCmdlet.OntapConfiguration_SizeInMegabyte"> <summary> <para> <para>Specifies the size of the volume, in megabytes (MB), that you are creating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeFromBackupCmdlet.OntapConfiguration_StorageEfficiencyEnabled"> <summary> <para> <para>Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeFromBackupCmdlet.OntapConfiguration_StorageVirtualMachineId"> <summary> <para> <para>Specifies the ONTAP SVM in which to create the volume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeFromBackupCmdlet.Tag"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeFromBackupCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeFromBackupCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXVolumeFromBackupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.RegisterFSXFileSystemAliasCmdlet"> <summary> 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. <para> 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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RegisterFSXFileSystemAliasCmdlet.Alias"> <summary> <para> <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:</para><ul><li><para>Formatted as a fully-qualified domain name (FQDN), <i><code>hostname.domain</code></i>, for example, <code>accounting.corp.example.com</code>.</para></li><li><para>Can contain alphanumeric characters and the hyphen (-).</para></li><li><para>Cannot start or end with a hyphen.</para></li><li><para>Can start with a numeric.</para></li></ul><para>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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RegisterFSXFileSystemAliasCmdlet.ClientRequestToken"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RegisterFSXFileSystemAliasCmdlet.FileSystemId"> <summary> <para> <para>Specifies the file system with which you want to associate one or more DNS aliases.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RegisterFSXFileSystemAliasCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RegisterFSXFileSystemAliasCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RegisterFSXFileSystemAliasCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXBackupCmdlet"> <summary> Deletes an Amazon FSx backup. After deletion, the backup no longer exists, and its data is gone. <para> The <code>DeleteBackup</code> call returns instantly. The backup won't show up in later <code>DescribeBackups</code> calls. </para><important><para> The data in a deleted backup is also deleted and can't be recovered by any means. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXBackupCmdlet.BackupId"> <summary> <para> <para>The ID of the backup that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXBackupCmdlet.ClientRequestToken"> <summary> <para> <para>A string of up to 64 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXBackupCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXBackupCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXBackupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXDataRepositoryAssociationCmdlet"> <summary> 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 only for file systems with the <code>Persistent_2</code> deployment type. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXDataRepositoryAssociationCmdlet.AssociationId"> <summary> <para> <para>The ID of the data repository association that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXDataRepositoryAssociationCmdlet.ClientRequestToken"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXDataRepositoryAssociationCmdlet.DeleteDataInFileSystem"> <summary> <para> <para>Set to <code>true</code> to delete the data in the file system that corresponds to the data repository association.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXDataRepositoryAssociationCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXDataRepositoryAssociationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXDataRepositoryAssociationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXFileSystemCmdlet"> <summary> 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. <para> 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 <code>FileSystemId</code> value to the <code>DeleFileSystem</code> operation. </para><para> 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't subject to the file system's retention policy, and must be manually deleted. </para><para> The <code>DeleteFileSystem</code> operation returns while the file system has the <code>DELETING</code> 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 <code>DescribeFileSystems</code> operation returns a <code>FileSystemNotFound</code> error. </para><note><para> If a data repository task is in a <code>PENDING</code> or <code>EXECUTING</code> state, deleting an Amazon FSx for Lustre file system will fail with an HTTP status code 400 (Bad Request). </para></note><important><para> The data in a deleted file system is also deleted and can't be recovered by any means. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXFileSystemCmdlet.ClientRequestToken"> <summary> <para> <para>A string of up to 64 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXFileSystemCmdlet.FileSystemId"> <summary> <para> <para>The ID of the file system that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXFileSystemCmdlet.LustreConfiguration_FinalBackupTag"> <summary> <para> <para>Use if <code>SkipFinalBackup</code> is set to <code>false</code>, and you want to apply an array of tags to the final backup. If you have set the file system property <code>CopyTagsToBackups</code> to true, and you specify one or more <code>FinalBackupTags</code> when deleting a file system, Amazon FSx will not copy any existing file system tags to the backup.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXFileSystemCmdlet.OpenZFSConfiguration_FinalBackupTag"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXFileSystemCmdlet.WindowsConfiguration_FinalBackupTag"> <summary> <para> <para>A set of tags for your final backup.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXFileSystemCmdlet.LustreConfiguration_SkipFinalBackup"> <summary> <para> <para>Set <code>SkipFinalBackup</code> 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 <code>DeleteFileSystem</code> operation is invoked. (Default = true)</para><note><para>The <code>fsx:CreateBackup</code> permission is required if you set <code>SkipFinalBackup</code> to <code>false</code> in order to delete the file system and take a final backup.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXFileSystemCmdlet.OpenZFSConfiguration_SkipFinalBackup"> <summary> <para> <para>By default, Amazon FSx for OpenZFS takes a final backup on your behalf when the <code>DeleteFileSystem</code> 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 value to do so. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXFileSystemCmdlet.WindowsConfiguration_SkipFinalBackup"> <summary> <para> <para>By default, Amazon FSx for Windows takes a final backup on your behalf when the <code>DeleteFileSystem</code> 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXFileSystemCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXFileSystemCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXFileSystemCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXResourceTagCmdlet"> <summary> This action removes a tag from an Amazon FSx resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The ARN of the Amazon FSx resource to untag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXResourceTagCmdlet.TagKey"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXResourceTagCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXResourceTagCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXSnapshotCmdlet"> <summary> Deletes the Amazon FSx snapshot. After deletion, the snapshot no longer exists, and its data is gone. Deleting a snapshot doesn't affect snapshots stored in a file system backup. <para> The <code>DeleteSnapshot</code> operation returns instantly. The snapshot appears with the lifecycle status of <code>DELETING</code> until the deletion is complete. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXSnapshotCmdlet.ClientRequestToken"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXSnapshotCmdlet.SnapshotId"> <summary> <para> <para>The ID of the snapshot that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXSnapshotCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXSnapshotCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXSnapshotCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXStorageVirtualMachineCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXStorageVirtualMachineCmdlet.ClientRequestToken"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXStorageVirtualMachineCmdlet.StorageVirtualMachineId"> <summary> <para> <para>The ID of the SVM that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXStorageVirtualMachineCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXStorageVirtualMachineCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXStorageVirtualMachineCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXVolumeCmdlet"> <summary> Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXVolumeCmdlet.ClientRequestToken"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXVolumeCmdlet.OntapConfiguration_FinalBackupTag"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXVolumeCmdlet.OpenZFSConfiguration_Option"> <summary> <para> <para>To delete the volume's children and snapshots, use the string <code>DELETE_CHILD_VOLUMES_AND_SNAPSHOTS</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXVolumeCmdlet.OntapConfiguration_SkipFinalBackup"> <summary> <para> <para>Set to true if you want to skip taking a final backup of the volume you are deleting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXVolumeCmdlet.VolumeId"> <summary> <para> <para>The ID of the volume that you are deleting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXVolumeCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXVolumeCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXVolumeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.RestoreFSXVolumeFromSnapshotCmdlet"> <summary> Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RestoreFSXVolumeFromSnapshotCmdlet.ClientRequestToken"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RestoreFSXVolumeFromSnapshotCmdlet.Option"> <summary> <para> <para>The settings used when restoring the specified volume from snapshot. </para><ul><li><para><code>DELETE_INTERMEDIATE_SNAPSHOTS</code> - Deletes snapshots between the current state and the specified snapshot. If there are intermediate snapshots and this option isn't used, <code>RestoreVolumeFromSnapshot</code> fails.</para></li><li><para><code>DELETE_CLONED_VOLUMES</code> - Deletes any volumes cloned from this volume. If there are any cloned volumes and this option isn't used, <code>RestoreVolumeFromSnapshot</code> fails.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RestoreFSXVolumeFromSnapshotCmdlet.SnapshotId"> <summary> <para> <para>The ID of the source snapshot. Specifies the snapshot that you are restoring from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RestoreFSXVolumeFromSnapshotCmdlet.VolumeId"> <summary> <para> <para>The ID of the volume that you are restoring.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RestoreFSXVolumeFromSnapshotCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RestoreFSXVolumeFromSnapshotCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RestoreFSXVolumeFromSnapshotCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.StopFSXDataRepositoryTaskCmdlet"> <summary> Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the <code>PENDING</code> or <code>EXECUTING</code> state. When you cancel a task, Amazon FSx does the following. <ul><li><para> Any files that FSx has already exported are not reverted. </para></li><li><para> FSx continues to export any files that are "in-flight" when the cancel operation is received. </para></li><li><para> FSx does not export any files that have not yet been exported. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.StopFSXDataRepositoryTaskCmdlet.TaskId"> <summary> <para> <para>Specifies the data repository task to cancel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.StopFSXDataRepositoryTaskCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.StopFSXDataRepositoryTaskCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.StopFSXDataRepositoryTaskCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.UnregisterFSXFileSystemAliasCmdlet"> <summary> 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 a 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>. <para> 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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UnregisterFSXFileSystemAliasCmdlet.Alias"> <summary> <para> <para>An array of one or more DNS alias names to disassociate, or remove, from the file system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UnregisterFSXFileSystemAliasCmdlet.ClientRequestToken"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UnregisterFSXFileSystemAliasCmdlet.FileSystemId"> <summary> <para> <para>Specifies the file system from which to disassociate the DNS aliases.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UnregisterFSXFileSystemAliasCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UnregisterFSXFileSystemAliasCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UnregisterFSXFileSystemAliasCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXDataRepositoryAssociationCmdlet"> <summary> Updates the configuration of an existing data repository association on an Amazon FSx for Lustre file system. Data repository associations are supported only for file systems with the <code>Persistent_2</code> deployment type. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXDataRepositoryAssociationCmdlet.AssociationId"> <summary> <para> <para>The ID of the data repository association that you are updating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXDataRepositoryAssociationCmdlet.ClientRequestToken"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXDataRepositoryAssociationCmdlet.AutoExportPolicy_Event"> <summary> <para> <para>The <code>AutoExportPolicy</code> can have the following event values:</para><ul><li><para><code>NEW</code> - Amazon FSx automatically exports new files and directories to the data repository as they are added to the file system.</para></li><li><para><code>CHANGED</code> - Amazon FSx automatically exports changes to files and directories on the file system to the data repository.</para></li><li><para><code>DELETED</code> - Files and directories are automatically deleted on the data repository when they are deleted on the file system.</para></li></ul><para>You can define any combination of event types for your <code>AutoExportPolicy</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXDataRepositoryAssociationCmdlet.AutoImportPolicy_Event"> <summary> <para> <para>The <code>AutoImportPolicy</code> can have the following event values:</para><ul><li><para><code>NEW</code> - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not currently exist in the FSx file system.</para></li><li><para><code>CHANGED</code> - Amazon FSx automatically updates file metadata and invalidates existing file content on the file system as files change in the data repository.</para></li><li><para><code>DELETED</code> - Amazon FSx automatically deletes files on the file system as corresponding files are deleted in the data repository.</para></li></ul><para>You can define any combination of event types for your <code>AutoImportPolicy</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXDataRepositoryAssociationCmdlet.ImportedFileChunkSize"> <summary> <para> <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.</para><para>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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXDataRepositoryAssociationCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXDataRepositoryAssociationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXDataRepositoryAssociationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXFileSystemCmdlet"> <summary> Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request. <para> For Amazon FSx for Windows File Server file systems, you can update the following properties: </para><ul><li><para><code>AuditLogConfiguration</code></para></li><li><para><code>AutomaticBackupRetentionDays</code></para></li><li><para><code>DailyAutomaticBackupStartTime</code></para></li><li><para><code>SelfManagedActiveDirectoryConfiguration</code></para></li><li><para><code>StorageCapacity</code></para></li><li><para><code>ThroughputCapacity</code></para></li><li><para><code>WeeklyMaintenanceStartTime</code></para></li></ul><para> For FSx for Lustre file systems, you can update the following properties: </para><ul><li><para><code>AutoImportPolicy</code></para></li><li><para><code>AutomaticBackupRetentionDays</code></para></li><li><para><code>DailyAutomaticBackupStartTime</code></para></li><li><para><code>DataCompressionType</code></para></li><li><para><code>StorageCapacity</code></para></li><li><para><code>WeeklyMaintenanceStartTime</code></para></li></ul><para> For FSx for ONTAP file systems, you can update the following properties: </para><ul><li><para><code>AutomaticBackupRetentionDays</code></para></li><li><para><code>DailyAutomaticBackupStartTime</code></para></li><li><para><code>FsxAdminPassword</code></para></li><li><para><code>WeeklyMaintenanceStartTime</code></para></li></ul><para> For the Amazon FSx for OpenZFS file systems, you can update the following properties: </para><ul><li><para><code>AutomaticBackupRetentionDays</code></para></li><li><para><code>CopyTagsToBackups</code></para></li><li><para><code>CopyTagsToVolumes</code></para></li><li><para><code>DailyAutomaticBackupStartTime</code></para></li><li><para><code>DiskIopsConfiguration</code></para></li><li><para><code>ThroughputCapacity</code></para></li><li><para><code>WeeklyMaintenanceStartTime</code></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXFileSystemCmdlet.OntapConfiguration_AutomaticBackupRetentionDay"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXFileSystemCmdlet.OpenZFSConfiguration_AutomaticBackupRetentionDay"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXFileSystemCmdlet.ClientRequestToken"> <summary> <para> <para>A string of up to 64 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXFileSystemCmdlet.OpenZFSConfiguration_CopyTagsToBackup"> <summary> <para> <para>A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to <code>false</code>. If it's set to <code>true</code>, 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 <code>true</code> 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXFileSystemCmdlet.OpenZFSConfiguration_CopyTagsToVolume"> <summary> <para> <para>A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to <code>false</code>. If it's set to <code>true</code>, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is <code>true</code> 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXFileSystemCmdlet.OntapConfiguration_DailyAutomaticBackupStartTime"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXFileSystemCmdlet.OpenZFSConfiguration_DailyAutomaticBackupStartTime"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXFileSystemCmdlet.FileSystemId"> <summary> <para> <para>The ID of the file system that you are updating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXFileSystemCmdlet.OntapConfiguration_FsxAdminPassword"> <summary> <para> <para>The ONTAP administrative password for the <code>fsxadmin</code> user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXFileSystemCmdlet.DiskIopsConfiguration_Iops"> <summary> <para> <para>The total number of SSD IOPS provisioned for the file system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXFileSystemCmdlet.LustreConfiguration"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXFileSystemCmdlet.DiskIopsConfiguration_Mode"> <summary> <para> <para>Specifies whether the number of IOPS for the file system is using the system default (<code>AUTOMATIC</code>) or was provisioned by the customer (<code>USER_PROVISIONED</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXFileSystemCmdlet.StorageCapacity"> <summary> <para> <para>Use this parameter to increase the storage capacity of an Amazon FSx for Windows File Server or Amazon FSx for Lustre file system. Specifies the storage capacity target value, in GiB, to increase the storage capacity for the file system that you're updating. </para><note><para>You can't make a storage capacity increase request if there is an existing storage capacity increase request in progress.</para></note><para>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.</para><para>For Lustre file systems, the storage capacity target value can be the following:</para><ul><li><para>For <code>SCRATCH_2</code> and <code>PERSISTENT_1 SSD</code> deployment types, valid values are in multiples of 2400 GiB. The value must be greater than the current storage capacity.</para></li><li><para>For <code>PERSISTENT HDD</code> 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.</para></li><li><para>For <code>SCRATCH_1</code> file systems, you can't increase the storage capacity.</para></li></ul><para>For OpenZFS file systems, the input/output operations per second (IOPS) automatically scale with increases to the storage capacity if IOPS is configured for automatic scaling. If the storage capacity increase would result in less than 3 IOPS per GiB of storage, this operation returns an error. </para><para>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 FSx for Windows File Server User Guide</i>, <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html">Managing storage and throughput capacity</a> in the <i>Amazon FSx for Lustre User Guide</i>, and <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-storage-capacity.html">Managing storage capacity</a> in the <i>Amazon FSx for OpenZFS User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXFileSystemCmdlet.OpenZFSConfiguration_ThroughputCapacity"> <summary> <para> <para>The throughput of an Amazon FSx file system, measured in megabytes per second (MBps), in 2 to the nth increments, between 2^3 (8) and 2^11 (2048). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXFileSystemCmdlet.OntapConfiguration_WeeklyMaintenanceStartTime"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXFileSystemCmdlet.OpenZFSConfiguration_WeeklyMaintenanceStartTime"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXFileSystemCmdlet.WindowsConfiguration"> <summary> <para> <para>The configuration updates for an Amazon FSx for Windows File Server file system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXFileSystemCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXFileSystemCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXFileSystemCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXSnapshotCmdlet"> <summary> Updates the name of a snapshot. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXSnapshotCmdlet.ClientRequestToken"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXSnapshotCmdlet.Name"> <summary> <para> <para>The name of the snapshot to update. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXSnapshotCmdlet.SnapshotId"> <summary> <para> <para>The ID of the snapshot that you want to update, in the format <code>fsvolsnap-0123456789abcdef0</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXSnapshotCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXSnapshotCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXSnapshotCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXStorageVirtualMachineCmdlet"> <summary> Updates an Amazon FSx for ONTAP storage virtual machine (SVM). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXStorageVirtualMachineCmdlet.ClientRequestToken"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXStorageVirtualMachineCmdlet.SelfManagedActiveDirectoryConfiguration_DnsIp"> <summary> <para> <para>A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXStorageVirtualMachineCmdlet.SelfManagedActiveDirectoryConfiguration_Password"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXStorageVirtualMachineCmdlet.StorageVirtualMachineId"> <summary> <para> <para>The ID of the SVM that you want to update, in the format <code>svm-0123456789abcdef0</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXStorageVirtualMachineCmdlet.SvmAdminPassword"> <summary> <para> <para>Enter a new SvmAdminPassword if you are updating it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXStorageVirtualMachineCmdlet.SelfManagedActiveDirectoryConfiguration_UserName"> <summary> <para> <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 <code>OrganizationalUnitDistinguishedName</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXStorageVirtualMachineCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXStorageVirtualMachineCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXStorageVirtualMachineCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXVolumeCmdlet"> <summary> Updates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXVolumeCmdlet.ClientRequestToken"> <summary> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXVolumeCmdlet.TieringPolicy_CoolingPeriod"> <summary> <para> <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 <code>AUTO</code> and <code>SNAPSHOT_ONLY</code> tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for <code>AUTO</code> and 2 days for <code>SNAPSHOT_ONLY</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXVolumeCmdlet.OpenZFSConfiguration_DataCompressionType"> <summary> <para> <para>Specifies the method used to compress the data on the volume. Unless the compression type is specified, volumes inherit the <code>DataCompressionType</code> value of their parent volume.</para><ul><li><para><code>NONE</code> - Doesn't compress the data on the volume.</para></li><li><para><code>ZSTD</code> - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. This algorithm reduces the amount of space used on your volume and has very little impact on compute resources.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXVolumeCmdlet.OntapConfiguration_JunctionPath"> <summary> <para> <para>Specifies the location in the SVM's namespace where the volume is mounted. The <code>JunctionPath</code> must have a leading forward slash, such as <code>/vol3</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXVolumeCmdlet.Name"> <summary> <para> <para>The name of the OpenZFS volume. OpenZFS root volumes are automatically named <code>FSX</code>. 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXVolumeCmdlet.TieringPolicy_Name"> <summary> <para> <para>Specifies the tiering policy used to transition data. Default value is <code>SNAPSHOT_ONLY</code>.</para><ul><li><para><code>SNAPSHOT_ONLY</code> - moves cold snapshots to the capacity pool storage tier.</para></li><li><para><code>AUTO</code> - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.</para></li><li><para><code>ALL</code> - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.</para></li><li><para><code>NONE</code> - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXVolumeCmdlet.OpenZFSConfiguration_NfsExport"> <summary> <para> <para>The configuration object for mounting a Network File System (NFS) file system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXVolumeCmdlet.OpenZFSConfiguration_ReadOnly"> <summary> <para> <para>A Boolean value indicating whether the volume is read-only.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXVolumeCmdlet.OntapConfiguration_SecurityStyle"> <summary> <para> <para>The security style for the volume, which can be <code>UNIX</code>. <code>NTFS</code>, or <code>MIXED</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXVolumeCmdlet.OntapConfiguration_SizeInMegabyte"> <summary> <para> <para>Specifies the size of the volume in megabytes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXVolumeCmdlet.OpenZFSConfiguration_StorageCapacityQuotaGiB"> <summary> <para> <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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXVolumeCmdlet.OpenZFSConfiguration_StorageCapacityReservationGiB"> <summary> <para> <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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXVolumeCmdlet.OntapConfiguration_StorageEfficiencyEnabled"> <summary> <para> <para>Default is <code>false</code>. Set to true to enable the deduplication, compression, and compaction storage efficiency features on the volume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXVolumeCmdlet.OpenZFSConfiguration_UserAndGroupQuota"> <summary> <para> <para>An object specifying how much storage users or groups can use on the volume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXVolumeCmdlet.VolumeId"> <summary> <para> <para>The ID of the volume that you want to update, in the format <code>fsvol-0123456789abcdef0</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXVolumeCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXVolumeCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXVolumeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |