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.GetFSXBackupCmdlet"> <summary> Returns the description of specific Amazon FSx for Windows File Server backups, if a <code>BackupIds</code> value is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS 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 <code>NextToken</code> from the last response. </para><para> This action 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 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 backups returned in the response of one <code>DescribeBackups</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.GetFSXBackupCmdlet.BackupId"> <summary> <para> <para>(Optional) IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXBackupCmdlet.Filter"> <summary> <para> <para>(Optional) Filters structure. Supported names are file-system-id and backup-type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.GetFSXBackupCmdlet.MaxResult"> <summary> <para> <para>(Optional) Maximum number of backups 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.GetFSXBackupCmdlet.NextToken"> <summary> <para> <para>(Optional) Opaque pagination token returned from a previous <code>DescribeBackups</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.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.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 AWS account in the AWS 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 action 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 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 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>(Optional) 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>(Optional) 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>(Optional) Opaque pagination token returned from a previous <code>DescribeFileSystems</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.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.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>(Optional) 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>(Optional) 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.NewFSXBackupCmdlet"> <summary> Creates a backup of an existing Amazon FSx for Windows File Server file system. Creating regular backups for your file system is a best practice that complements the replication that Amazon FSx for Windows File Server performs for your file system. It also enables you to restore from user modification of data. <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 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>CreateFileSystem</code> operation returns while the backup's lifecycle state is still <code>CREATING</code>. You can check the file system creation status by calling the <a>DescribeBackups</a> operation, which returns the backup state along with other information. </para><note></note> </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 AWS Command Line Interface (AWS CLI) or an AWS 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>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.</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.NewFSXFileSystemCmdlet"> <summary> Creates a new, empty Amazon FSx file system. <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 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 success 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>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.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 AWS Command Line Interface (AWS CLI) or an AWS SDK.</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.</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.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>The storage capacity of the file system being created.</para><para>For Windows file systems, valid values are 32 GiB - 65,536 GiB.</para><para>For Lustre file systems, valid values are 1,200, 2,400, 3,600, then continuing in increments of 3600 GiB.</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 <code>MULTI_AZ_1</code> file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standy file server. You specify one of these subnets as the preferred subnet using the <code>WindowsConfiguration > PreferredSubnetID</code> property.</para><para>For Windows <code>SINGLE_AZ_1</code> file system deployment types and Lustre 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.NewFSXFileSystemCmdlet.Tag"> <summary> <para> <para>The tags to apply to the file system 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.WindowsConfiguration"> <summary> <para> <para>The Microsoft Windows configuration for the file system being created. This value is required if <code>FileSystemType</code> is set to <code>WINDOWS</code>.</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 file system from an existing Amazon FSx for Windows File Server 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 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 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 success 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>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.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>(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 AWS Command Line Interface (AWS CLI) or an AWS SDK.</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 describe requests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.NewFSXFileSystemFromBackupCmdlet.SubnetId"> <summary> <para> <para>A list of IDs for the subnets that the file system will be accessible from. Currently, you can specify only one subnet. The file server is also 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.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.RemoveFSXBackupCmdlet"> <summary> Deletes an Amazon FSx for Windows File Server backup, deleting its contents. After deletion, the backup no longer exists, and its data is gone. <para> The <code>DeleteBackup</code> call returns instantly. The backup will not 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 you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXBackupCmdlet.ClientRequestToken"> <summary> <para> <para>(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is automatically filled on your behalf when using the AWS 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.RemoveFSXFileSystemCmdlet"> <summary> Deletes a file system, deleting its contents. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups will also be deleted. <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 is not subject to the file system's retention policy, and must be manually deleted. </para><para> The <code>DeleteFileSystem</code> action returns while the file system has the <code>DELETING</code> status. You can check the file system deletion status by calling the <a>DescribeFileSystems</a> action, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the <a>DescribeFileSystems</a> returns a <code>FileSystemNotFound</code> error. </para><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>(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is automatically filled on your behalf when using the AWS CLI or SDK.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.RemoveFSXFileSystemCmdlet.FileSystemId"> <summary> <para> <para>The ID of the file system you want to delete.</para> </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.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.UpdateFSXFileSystemCmdlet"> <summary> Updates a file system configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXFileSystemCmdlet.ClientRequestToken"> <summary> <para> <para>(Optional) 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 AWS Command Line Interface (AWS CLI) or an AWS SDK.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FSX.UpdateFSXFileSystemCmdlet.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.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.WindowsConfiguration"> <summary> <para> <para>The configuration update for this Microsoft Windows file system. The only supported options are for backup and maintenance and for self-managed Active Directory configuration.</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> </members> </doc> |